lib/libsysdecode/sysdecode_ioctlname.3

   1 .\"
   2 .\" Copyright (c) 2015 John Baldwin <jhb@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd October 17, 2016
  29 .Dt sysdecode_ioctlname 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_ioctlname
  33 .Nd lookup name of device control command
  34 .Sh LIBRARY
  35 .Lb libsysdecode
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In stdbool.h
  39 .In sysdecode.h
  40 .Ft const char *
  41 .Fn sysdecode_ioctlname "unsigned long request"
  42 .Sh DESCRIPTION
  43 The
  44 .Fn sysdecode_ioctlname
  45 function returns the name of a device control request identified by
  46 .Fa request .
  47 A table of names is generated during the build of the
  48 .Nm sysdecode
  49 library from system headers that maps device control request values to
  50 the name of the corresponding C macro.
  51 .Sh RETURN VALUES
  52 The
  53 .Fn sysdecode_ioctlname
  54 function returns the name of a device control request if
  55 .Fa request
  56 is a known value;
  57 otherwise
  58 .Dv NULL .
  59 .Sh SEE ALSO
  60 .Xr sysdecode 3