xref: /freebsd/lib/libsysdecode/sysdecode_ioctlname.3 (revision d356ca0c3ffa363d5bfbc237b44f53b3f88fd415)
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 December 12, 2015
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.Ft conts 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