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