Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: ioctl-number.txt: convert it to ReST format
The conversion itself is simple: add a markup for the
title of this file and add markups for both tables.
Yet, the big table here with IOCTL numbers is badly formatted:
on several lines, the "Include File" column has some values that
are bigger than the reserved space there.
Also, on several places, a comment was misplaced at the "Include
File" space.
So, most of the work here is to actually ensure that each field
will be properly fixed.
Also worth to mention that some URLs have the asterisk character
on it. Well, Sphinx has an issue with asterisks in the middle
of an string. As this is URL, use the alternate format: %2A.
As a side effect of this patch, it is now a lot easier to see that
some reserved ioctl numbers are missing the include files
where it is supposed to be used.
PS.: While this is part of a subdir, I opted to convert this
single file alone, as this file has a potential of conflicts,
as most subsystem maintainers touch it.
Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
+367
-355
+363
Documentation/ioctl/ioctl-number.rst
+363
Documentation/ioctl/ioctl-number.rst
···
1
+
:orphan:
2
+
3
+
=============
4
+
Ioctl Numbers
5
+
=============
6
+
7
+
19 October 1999
8
+
9
+
Michael Elizabeth Chastain
10
+
<mec@shout.net>
11
+
12
+
If you are adding new ioctl's to the kernel, you should use the _IO
13
+
macros defined in <linux/ioctl.h>:
14
+
15
+
====== == ============================================
16
+
_IO an ioctl with no parameters
17
+
_IOW an ioctl with write parameters (copy_from_user)
18
+
_IOR an ioctl with read parameters (copy_to_user)
19
+
_IOWR an ioctl with both write and read parameters.
20
+
====== == ============================================
21
+
22
+
'Write' and 'read' are from the user's point of view, just like the
23
+
system calls 'write' and 'read'. For example, a SET_FOO ioctl would
24
+
be _IOW, although the kernel would actually read data from user space;
25
+
a GET_FOO ioctl would be _IOR, although the kernel would actually write
26
+
data to user space.
27
+
28
+
The first argument to _IO, _IOW, _IOR, or _IOWR is an identifying letter
29
+
or number from the table below. Because of the large number of drivers,
30
+
many drivers share a partial letter with other drivers.
31
+
32
+
If you are writing a driver for a new device and need a letter, pick an
33
+
unused block with enough room for expansion: 32 to 256 ioctl commands.
34
+
You can register the block by patching this file and submitting the
35
+
patch to Linus Torvalds. Or you can e-mail me at <mec@shout.net> and
36
+
I'll register one for you.
37
+
38
+
The second argument to _IO, _IOW, _IOR, or _IOWR is a sequence number
39
+
to distinguish ioctls from each other. The third argument to _IOW,
40
+
_IOR, or _IOWR is the type of the data going into the kernel or coming
41
+
out of the kernel (e.g. 'int' or 'struct foo'). NOTE! Do NOT use
42
+
sizeof(arg) as the third argument as this results in your ioctl thinking
43
+
it passes an argument of type size_t.
44
+
45
+
Some devices use their major number as the identifier; this is OK, as
46
+
long as it is unique. Some devices are irregular and don't follow any
47
+
convention at all.
48
+
49
+
Following this convention is good because:
50
+
51
+
(1) Keeping the ioctl's globally unique helps error checking:
52
+
if a program calls an ioctl on the wrong device, it will get an
53
+
error rather than some unexpected behaviour.
54
+
55
+
(2) The 'strace' build procedure automatically finds ioctl numbers
56
+
defined with _IO, _IOW, _IOR, or _IOWR.
57
+
58
+
(3) 'strace' can decode numbers back into useful names when the
59
+
numbers are unique.
60
+
61
+
(4) People looking for ioctls can grep for them more easily when
62
+
this convention is used to define the ioctl numbers.
63
+
64
+
(5) When following the convention, the driver code can use generic
65
+
code to copy the parameters between user and kernel space.
66
+
67
+
This table lists ioctls visible from user land for Linux/x86. It contains
68
+
most drivers up to 2.6.31, but I know I am missing some. There has been
69
+
no attempt to list non-X86 architectures or ioctls from drivers/staging/.
70
+
71
+
==== ===== ======================================================= ================================================================
72
+
Code Seq# Include File Comments
73
+
(hex)
74
+
==== ===== ======================================================= ================================================================
75
+
0x00 00-1F linux/fs.h conflict!
76
+
0x00 00-1F scsi/scsi_ioctl.h conflict!
77
+
0x00 00-1F linux/fb.h conflict!
78
+
0x00 00-1F linux/wavefront.h conflict!
79
+
0x02 all linux/fd.h
80
+
0x03 all linux/hdreg.h
81
+
0x04 D2-DC linux/umsdos_fs.h Dead since 2.6.11, but don't reuse these.
82
+
0x06 all linux/lp.h
83
+
0x09 all linux/raid/md_u.h
84
+
0x10 00-0F drivers/char/s390/vmcp.h
85
+
0x10 10-1F arch/s390/include/uapi/sclp_ctl.h
86
+
0x10 20-2F arch/s390/include/uapi/asm/hypfs.h
87
+
0x12 all linux/fs.h
88
+
linux/blkpg.h
89
+
0x1b all InfiniBand Subsystem
90
+
<http://infiniband.sourceforge.net/>
91
+
0x20 all drivers/cdrom/cm206.h
92
+
0x22 all scsi/sg.h
93
+
'!' 00-1F uapi/linux/seccomp.h
94
+
'#' 00-3F IEEE 1394 Subsystem
95
+
Block for the entire subsystem
96
+
'$' 00-0F linux/perf_counter.h, linux/perf_event.h
97
+
'%' 00-0F include/uapi/linux/stm.h System Trace Module subsystem
98
+
<mailto:alexander.shishkin@linux.intel.com>
99
+
'&' 00-07 drivers/firewire/nosy-user.h
100
+
'1' 00-1F linux/timepps.h PPS kit from Ulrich Windl
101
+
<ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
102
+
'2' 01-04 linux/i2o.h
103
+
'3' 00-0F drivers/s390/char/raw3270.h conflict!
104
+
'3' 00-1F linux/suspend_ioctls.h, conflict!
105
+
kernel/power/user.c
106
+
'8' all SNP8023 advanced NIC card
107
+
<mailto:mcr@solidum.com>
108
+
';' 64-7F linux/vfio.h
109
+
'@' 00-0F linux/radeonfb.h conflict!
110
+
'@' 00-0F drivers/video/aty/aty128fb.c conflict!
111
+
'A' 00-1F linux/apm_bios.h conflict!
112
+
'A' 00-0F linux/agpgart.h, conflict!
113
+
drivers/char/agp/compat_ioctl.h
114
+
'A' 00-7F sound/asound.h conflict!
115
+
'B' 00-1F linux/cciss_ioctl.h conflict!
116
+
'B' 00-0F include/linux/pmu.h conflict!
117
+
'B' C0-FF advanced bbus <mailto:maassen@uni-freiburg.de>
118
+
'C' all linux/soundcard.h conflict!
119
+
'C' 01-2F linux/capi.h conflict!
120
+
'C' F0-FF drivers/net/wan/cosa.h conflict!
121
+
'D' all arch/s390/include/asm/dasd.h
122
+
'D' 40-5F drivers/scsi/dpt/dtpi_ioctl.h
123
+
'D' 05 drivers/scsi/pmcraid.h
124
+
'E' all linux/input.h conflict!
125
+
'E' 00-0F xen/evtchn.h conflict!
126
+
'F' all linux/fb.h conflict!
127
+
'F' 01-02 drivers/scsi/pmcraid.h conflict!
128
+
'F' 20 drivers/video/fsl-diu-fb.h conflict!
129
+
'F' 20 drivers/video/intelfb/intelfb.h conflict!
130
+
'F' 20 linux/ivtvfb.h conflict!
131
+
'F' 20 linux/matroxfb.h conflict!
132
+
'F' 20 drivers/video/aty/atyfb_base.c conflict!
133
+
'F' 00-0F video/da8xx-fb.h conflict!
134
+
'F' 80-8F linux/arcfb.h conflict!
135
+
'F' DD video/sstfb.h conflict!
136
+
'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict!
137
+
'G' 00-0F linux/gigaset_dev.h conflict!
138
+
'H' 00-7F linux/hiddev.h conflict!
139
+
'H' 00-0F linux/hidraw.h conflict!
140
+
'H' 01 linux/mei.h conflict!
141
+
'H' 02 linux/mei.h conflict!
142
+
'H' 03 linux/mei.h conflict!
143
+
'H' 00-0F sound/asound.h conflict!
144
+
'H' 20-40 sound/asound_fm.h conflict!
145
+
'H' 80-8F sound/sfnt_info.h conflict!
146
+
'H' 10-8F sound/emu10k1.h conflict!
147
+
'H' 10-1F sound/sb16_csp.h conflict!
148
+
'H' 10-1F sound/hda_hwdep.h conflict!
149
+
'H' 40-4F sound/hdspm.h conflict!
150
+
'H' 40-4F sound/hdsp.h conflict!
151
+
'H' 90 sound/usb/usx2y/usb_stream.h
152
+
'H' A0 uapi/linux/usb/cdc-wdm.h
153
+
'H' C0-F0 net/bluetooth/hci.h conflict!
154
+
'H' C0-DF net/bluetooth/hidp/hidp.h conflict!
155
+
'H' C0-DF net/bluetooth/cmtp/cmtp.h conflict!
156
+
'H' C0-DF net/bluetooth/bnep/bnep.h conflict!
157
+
'H' F1 linux/hid-roccat.h <mailto:erazor_de@users.sourceforge.net>
158
+
'H' F8-FA sound/firewire.h
159
+
'I' all linux/isdn.h conflict!
160
+
'I' 00-0F drivers/isdn/divert/isdn_divert.h conflict!
161
+
'I' 40-4F linux/mISDNif.h conflict!
162
+
'J' 00-1F drivers/scsi/gdth_ioctl.h
163
+
'K' all linux/kd.h
164
+
'L' 00-1F linux/loop.h conflict!
165
+
'L' 10-1F drivers/scsi/mpt3sas/mpt3sas_ctl.h conflict!
166
+
'L' 20-2F linux/lightnvm.h
167
+
'L' E0-FF linux/ppdd.h encrypted disk device driver
168
+
<http://linux01.gwdg.de/~alatham/ppdd.html>
169
+
'M' all linux/soundcard.h conflict!
170
+
'M' 01-16 mtd/mtd-abi.h conflict!
171
+
and drivers/mtd/mtdchar.c
172
+
'M' 01-03 drivers/scsi/megaraid/megaraid_sas.h
173
+
'M' 00-0F drivers/video/fsl-diu-fb.h conflict!
174
+
'N' 00-1F drivers/usb/scanner.h
175
+
'N' 40-7F drivers/block/nvme.c
176
+
'O' 00-06 mtd/ubi-user.h UBI
177
+
'P' all linux/soundcard.h conflict!
178
+
'P' 60-6F sound/sscape_ioctl.h conflict!
179
+
'P' 00-0F drivers/usb/class/usblp.c conflict!
180
+
'P' 01-09 drivers/misc/pci_endpoint_test.c conflict!
181
+
'Q' all linux/soundcard.h
182
+
'R' 00-1F linux/random.h conflict!
183
+
'R' 01 linux/rfkill.h conflict!
184
+
'R' C0-DF net/bluetooth/rfcomm.h
185
+
'S' all linux/cdrom.h conflict!
186
+
'S' 80-81 scsi/scsi_ioctl.h conflict!
187
+
'S' 82-FF scsi/scsi.h conflict!
188
+
'S' 00-7F sound/asequencer.h conflict!
189
+
'T' all linux/soundcard.h conflict!
190
+
'T' 00-AF sound/asound.h conflict!
191
+
'T' all arch/x86/include/asm/ioctls.h conflict!
192
+
'T' C0-DF linux/if_tun.h conflict!
193
+
'U' all sound/asound.h conflict!
194
+
'U' 00-CF linux/uinput.h conflict!
195
+
'U' 00-EF linux/usbdevice_fs.h
196
+
'U' C0-CF drivers/bluetooth/hci_uart.h
197
+
'V' all linux/vt.h conflict!
198
+
'V' all linux/videodev2.h conflict!
199
+
'V' C0 linux/ivtvfb.h conflict!
200
+
'V' C0 linux/ivtv.h conflict!
201
+
'V' C0 media/davinci/vpfe_capture.h conflict!
202
+
'V' C0 media/si4713.h conflict!
203
+
'W' 00-1F linux/watchdog.h conflict!
204
+
'W' 00-1F linux/wanrouter.h conflict! (pre 3.9)
205
+
'W' 00-3F sound/asound.h conflict!
206
+
'W' 40-5F drivers/pci/switch/switchtec.c
207
+
'X' all fs/xfs/xfs_fs.h, conflict!
208
+
fs/xfs/linux-2.6/xfs_ioctl32.h,
209
+
include/linux/falloc.h,
210
+
linux/fs.h,
211
+
'X' all fs/ocfs2/ocfs_fs.h conflict!
212
+
'X' 01 linux/pktcdvd.h conflict!
213
+
'Y' all linux/cyclades.h
214
+
'Z' 14-15 drivers/message/fusion/mptctl.h
215
+
'[' 00-3F linux/usb/tmc.h USB Test and Measurement Devices
216
+
<mailto:gregkh@linuxfoundation.org>
217
+
'a' all linux/atm*.h, linux/sonet.h ATM on linux
218
+
<http://lrcwww.epfl.ch/>
219
+
'a' 00-0F drivers/crypto/qat/qat_common/adf_cfg_common.h conflict! qat driver
220
+
'b' 00-FF conflict! bit3 vme host bridge
221
+
<mailto:natalia@nikhefk.nikhef.nl>
222
+
'c' all linux/cm4000_cs.h conflict!
223
+
'c' 00-7F linux/comstats.h conflict!
224
+
'c' 00-7F linux/coda.h conflict!
225
+
'c' 00-1F linux/chio.h conflict!
226
+
'c' 80-9F arch/s390/include/asm/chsc.h conflict!
227
+
'c' A0-AF arch/x86/include/asm/msr.h conflict!
228
+
'd' 00-FF linux/char/drm/drm.h conflict!
229
+
'd' 02-40 pcmcia/ds.h conflict!
230
+
'd' F0-FF linux/digi1.h
231
+
'e' all linux/digi1.h conflict!
232
+
'f' 00-1F linux/ext2_fs.h conflict!
233
+
'f' 00-1F linux/ext3_fs.h conflict!
234
+
'f' 00-0F fs/jfs/jfs_dinode.h conflict!
235
+
'f' 00-0F fs/ext4/ext4.h conflict!
236
+
'f' 00-0F linux/fs.h conflict!
237
+
'f' 00-0F fs/ocfs2/ocfs2_fs.h conflict!
238
+
'g' 00-0F linux/usb/gadgetfs.h
239
+
'g' 20-2F linux/usb/g_printer.h
240
+
'h' 00-7F conflict! Charon filesystem
241
+
<mailto:zapman@interlan.net>
242
+
'h' 00-1F linux/hpet.h conflict!
243
+
'h' 80-8F fs/hfsplus/ioctl.c
244
+
'i' 00-3F linux/i2o-dev.h conflict!
245
+
'i' 0B-1F linux/ipmi.h conflict!
246
+
'i' 80-8F linux/i8k.h
247
+
'j' 00-3F linux/joystick.h
248
+
'k' 00-0F linux/spi/spidev.h conflict!
249
+
'k' 00-05 video/kyro.h conflict!
250
+
'k' 10-17 linux/hsi/hsi_char.h HSI character device
251
+
'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system
252
+
<http://web.archive.org/web/%2A/http://mikonos.dia.unisa.it/tcfs>
253
+
'l' 40-7F linux/udf_fs_i.h in development:
254
+
<http://sourceforge.net/projects/linux-udf/>
255
+
'm' 00-09 linux/mmtimer.h conflict!
256
+
'm' all linux/mtio.h conflict!
257
+
'm' all linux/soundcard.h conflict!
258
+
'm' all linux/synclink.h conflict!
259
+
'm' 00-19 drivers/message/fusion/mptctl.h conflict!
260
+
'm' 00 drivers/scsi/megaraid/megaraid_ioctl.h conflict!
261
+
'n' 00-7F linux/ncp_fs.h and fs/ncpfs/ioctl.c
262
+
'n' 80-8F uapi/linux/nilfs2_api.h NILFS2
263
+
'n' E0-FF linux/matroxfb.h matroxfb
264
+
'o' 00-1F fs/ocfs2/ocfs2_fs.h OCFS2
265
+
'o' 00-03 mtd/ubi-user.h conflict! (OCFS2 and UBI overlaps)
266
+
'o' 40-41 mtd/ubi-user.h UBI
267
+
'o' 01-A1 `linux/dvb/*.h` DVB
268
+
'p' 00-0F linux/phantom.h conflict! (OpenHaptics needs this)
269
+
'p' 00-1F linux/rtc.h conflict!
270
+
'p' 00-3F linux/mc146818rtc.h conflict!
271
+
'p' 40-7F linux/nvram.h
272
+
'p' 80-9F linux/ppdev.h user-space parport
273
+
<mailto:tim@cyberelk.net>
274
+
'p' A1-A5 linux/pps.h LinuxPPS
275
+
<mailto:giometti@linux.it>
276
+
'q' 00-1F linux/serio.h
277
+
'q' 80-FF linux/telephony.h Internet PhoneJACK, Internet LineJACK
278
+
linux/ixjuser.h <http://web.archive.org/web/%2A/http://www.quicknet.net>
279
+
'r' 00-1F linux/msdos_fs.h and fs/fat/dir.c
280
+
's' all linux/cdk.h
281
+
't' 00-7F linux/ppp-ioctl.h
282
+
't' 80-8F linux/isdn_ppp.h
283
+
't' 90-91 linux/toshiba.h toshiba and toshiba_acpi SMM
284
+
'u' 00-1F linux/smb_fs.h gone
285
+
'u' 20-3F linux/uvcvideo.h USB video class host driver
286
+
'u' 40-4f linux/udmabuf.h userspace dma-buf misc device
287
+
'v' 00-1F linux/ext2_fs.h conflict!
288
+
'v' 00-1F linux/fs.h conflict!
289
+
'v' 00-0F linux/sonypi.h conflict!
290
+
'v' 00-0F media/v4l2-subdev.h conflict!
291
+
'v' C0-FF linux/meye.h conflict!
292
+
'w' all CERN SCI driver
293
+
'y' 00-1F packet based user level communications
294
+
<mailto:zapman@interlan.net>
295
+
'z' 00-3F CAN bus card conflict!
296
+
<mailto:hdstich@connectu.ulm.circular.de>
297
+
'z' 40-7F CAN bus card conflict!
298
+
<mailto:oe@port.de>
299
+
'z' 10-4F drivers/s390/crypto/zcrypt_api.h conflict!
300
+
'|' 00-7F linux/media.h
301
+
0x80 00-1F linux/fb.h
302
+
0x89 00-06 arch/x86/include/asm/sockios.h
303
+
0x89 0B-DF linux/sockios.h
304
+
0x89 E0-EF linux/sockios.h SIOCPROTOPRIVATE range
305
+
0x89 E0-EF linux/dn.h PROTOPRIVATE range
306
+
0x89 F0-FF linux/sockios.h SIOCDEVPRIVATE range
307
+
0x8B all linux/wireless.h
308
+
0x8C 00-3F WiNRADiO driver
309
+
<http://www.winradio.com.au/>
310
+
0x90 00 drivers/cdrom/sbpcd.h
311
+
0x92 00-0F drivers/usb/mon/mon_bin.c
312
+
0x93 60-7F linux/auto_fs.h
313
+
0x94 all fs/btrfs/ioctl.h Btrfs filesystem
314
+
and linux/fs.h some lifted to vfs/generic
315
+
0x97 00-7F fs/ceph/ioctl.h Ceph file system
316
+
0x99 00-0F 537-Addinboard driver
317
+
<mailto:buk@buks.ipn.de>
318
+
0xA0 all linux/sdp/sdp.h Industrial Device Project
319
+
<mailto:kenji@bitgate.com>
320
+
0xA1 0 linux/vtpm_proxy.h TPM Emulator Proxy Driver
321
+
0xA3 80-8F Port ACL in development:
322
+
<mailto:tlewis@mindspring.com>
323
+
0xA3 90-9F linux/dtlk.h
324
+
0xA4 00-1F uapi/linux/tee.h Generic TEE subsystem
325
+
0xAA 00-3F linux/uapi/linux/userfaultfd.h
326
+
0xAB 00-1F linux/nbd.h
327
+
0xAC 00-1F linux/raw.h
328
+
0xAD 00 Netfilter device in development:
329
+
<mailto:rusty@rustcorp.com.au>
330
+
0xAE all linux/kvm.h Kernel-based Virtual Machine
331
+
<mailto:kvm@vger.kernel.org>
332
+
0xAF 00-1F linux/fsl_hypervisor.h Freescale hypervisor
333
+
0xB0 all RATIO devices in development:
334
+
<mailto:vgo@ratio.de>
335
+
0xB1 00-1F PPPoX
336
+
<mailto:mostrows@styx.uwaterloo.ca>
337
+
0xB3 00 linux/mmc/ioctl.h
338
+
0xB4 00-0F linux/gpio.h <mailto:linux-gpio@vger.kernel.org>
339
+
0xB5 00-0F uapi/linux/rpmsg.h <mailto:linux-remoteproc@vger.kernel.org>
340
+
0xB6 all linux/fpga-dfl.h
341
+
0xC0 00-0F linux/usb/iowarrior.h
342
+
0xCA 00-0F uapi/misc/cxl.h
343
+
0xCA 10-2F uapi/misc/ocxl.h
344
+
0xCA 80-BF uapi/scsi/cxlflash_ioctl.h
345
+
0xCB 00-1F CBM serial IEC bus in development:
346
+
<mailto:michael.klein@puffin.lb.shuttle.de>
347
+
0xCC 00-0F drivers/misc/ibmvmc.h pseries VMC driver
348
+
0xCD 01 linux/reiserfs_fs.h
349
+
0xCF 02 fs/cifs/ioctl.c
350
+
0xDB 00-0F drivers/char/mwave/mwavepub.h
351
+
0xDD 00-3F ZFCP device driver see drivers/s390/scsi/
352
+
<mailto:aherrman@de.ibm.com>
353
+
0xE5 00-3F linux/fuse.h
354
+
0xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver
355
+
0xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development)
356
+
<mailto:thomas@winischhofer.net>
357
+
0xF4 00-1F video/mbxfb.h mbxfb
358
+
<mailto:raph@8d.com>
359
+
0xF6 all LTTng Linux Trace Toolkit Next Generation
360
+
<mailto:mathieu.desnoyers@efficios.com>
361
+
0xFD all linux/dm-ioctl.h
362
+
0xFE all linux/isst_if.h
363
+
==== ===== ======================================================= ================================================================
-351
Documentation/ioctl/ioctl-number.txt
-351
Documentation/ioctl/ioctl-number.txt
···
1
-
Ioctl Numbers
2
-
19 October 1999
3
-
Michael Elizabeth Chastain
4
-
<mec@shout.net>
5
-
6
-
If you are adding new ioctl's to the kernel, you should use the _IO
7
-
macros defined in <linux/ioctl.h>:
8
-
9
-
_IO an ioctl with no parameters
10
-
_IOW an ioctl with write parameters (copy_from_user)
11
-
_IOR an ioctl with read parameters (copy_to_user)
12
-
_IOWR an ioctl with both write and read parameters.
13
-
14
-
'Write' and 'read' are from the user's point of view, just like the
15
-
system calls 'write' and 'read'. For example, a SET_FOO ioctl would
16
-
be _IOW, although the kernel would actually read data from user space;
17
-
a GET_FOO ioctl would be _IOR, although the kernel would actually write
18
-
data to user space.
19
-
20
-
The first argument to _IO, _IOW, _IOR, or _IOWR is an identifying letter
21
-
or number from the table below. Because of the large number of drivers,
22
-
many drivers share a partial letter with other drivers.
23
-
24
-
If you are writing a driver for a new device and need a letter, pick an
25
-
unused block with enough room for expansion: 32 to 256 ioctl commands.
26
-
You can register the block by patching this file and submitting the
27
-
patch to Linus Torvalds. Or you can e-mail me at <mec@shout.net> and
28
-
I'll register one for you.
29
-
30
-
The second argument to _IO, _IOW, _IOR, or _IOWR is a sequence number
31
-
to distinguish ioctls from each other. The third argument to _IOW,
32
-
_IOR, or _IOWR is the type of the data going into the kernel or coming
33
-
out of the kernel (e.g. 'int' or 'struct foo'). NOTE! Do NOT use
34
-
sizeof(arg) as the third argument as this results in your ioctl thinking
35
-
it passes an argument of type size_t.
36
-
37
-
Some devices use their major number as the identifier; this is OK, as
38
-
long as it is unique. Some devices are irregular and don't follow any
39
-
convention at all.
40
-
41
-
Following this convention is good because:
42
-
43
-
(1) Keeping the ioctl's globally unique helps error checking:
44
-
if a program calls an ioctl on the wrong device, it will get an
45
-
error rather than some unexpected behaviour.
46
-
47
-
(2) The 'strace' build procedure automatically finds ioctl numbers
48
-
defined with _IO, _IOW, _IOR, or _IOWR.
49
-
50
-
(3) 'strace' can decode numbers back into useful names when the
51
-
numbers are unique.
52
-
53
-
(4) People looking for ioctls can grep for them more easily when
54
-
this convention is used to define the ioctl numbers.
55
-
56
-
(5) When following the convention, the driver code can use generic
57
-
code to copy the parameters between user and kernel space.
58
-
59
-
This table lists ioctls visible from user land for Linux/x86. It contains
60
-
most drivers up to 2.6.31, but I know I am missing some. There has been
61
-
no attempt to list non-X86 architectures or ioctls from drivers/staging/.
62
-
63
-
Code Seq#(hex) Include File Comments
64
-
========================================================
65
-
0x00 00-1F linux/fs.h conflict!
66
-
0x00 00-1F scsi/scsi_ioctl.h conflict!
67
-
0x00 00-1F linux/fb.h conflict!
68
-
0x00 00-1F linux/wavefront.h conflict!
69
-
0x02 all linux/fd.h
70
-
0x03 all linux/hdreg.h
71
-
0x04 D2-DC linux/umsdos_fs.h Dead since 2.6.11, but don't reuse these.
72
-
0x06 all linux/lp.h
73
-
0x09 all linux/raid/md_u.h
74
-
0x10 00-0F drivers/char/s390/vmcp.h
75
-
0x10 10-1F arch/s390/include/uapi/sclp_ctl.h
76
-
0x10 20-2F arch/s390/include/uapi/asm/hypfs.h
77
-
0x12 all linux/fs.h
78
-
linux/blkpg.h
79
-
0x1b all InfiniBand Subsystem <http://infiniband.sourceforge.net/>
80
-
0x20 all drivers/cdrom/cm206.h
81
-
0x22 all scsi/sg.h
82
-
'!' 00-1F uapi/linux/seccomp.h
83
-
'#' 00-3F IEEE 1394 Subsystem Block for the entire subsystem
84
-
'$' 00-0F linux/perf_counter.h, linux/perf_event.h
85
-
'%' 00-0F include/uapi/linux/stm.h
86
-
System Trace Module subsystem
87
-
<mailto:alexander.shishkin@linux.intel.com>
88
-
'&' 00-07 drivers/firewire/nosy-user.h
89
-
'1' 00-1F <linux/timepps.h> PPS kit from Ulrich Windl
90
-
<ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
91
-
'2' 01-04 linux/i2o.h
92
-
'3' 00-0F drivers/s390/char/raw3270.h conflict!
93
-
'3' 00-1F linux/suspend_ioctls.h conflict!
94
-
and kernel/power/user.c
95
-
'8' all SNP8023 advanced NIC card
96
-
<mailto:mcr@solidum.com>
97
-
';' 64-7F linux/vfio.h
98
-
'@' 00-0F linux/radeonfb.h conflict!
99
-
'@' 00-0F drivers/video/aty/aty128fb.c conflict!
100
-
'A' 00-1F linux/apm_bios.h conflict!
101
-
'A' 00-0F linux/agpgart.h conflict!
102
-
and drivers/char/agp/compat_ioctl.h
103
-
'A' 00-7F sound/asound.h conflict!
104
-
'B' 00-1F linux/cciss_ioctl.h conflict!
105
-
'B' 00-0F include/linux/pmu.h conflict!
106
-
'B' C0-FF advanced bbus
107
-
<mailto:maassen@uni-freiburg.de>
108
-
'C' all linux/soundcard.h conflict!
109
-
'C' 01-2F linux/capi.h conflict!
110
-
'C' F0-FF drivers/net/wan/cosa.h conflict!
111
-
'D' all arch/s390/include/asm/dasd.h
112
-
'D' 40-5F drivers/scsi/dpt/dtpi_ioctl.h
113
-
'D' 05 drivers/scsi/pmcraid.h
114
-
'E' all linux/input.h conflict!
115
-
'E' 00-0F xen/evtchn.h conflict!
116
-
'F' all linux/fb.h conflict!
117
-
'F' 01-02 drivers/scsi/pmcraid.h conflict!
118
-
'F' 20 drivers/video/fsl-diu-fb.h conflict!
119
-
'F' 20 drivers/video/intelfb/intelfb.h conflict!
120
-
'F' 20 linux/ivtvfb.h conflict!
121
-
'F' 20 linux/matroxfb.h conflict!
122
-
'F' 20 drivers/video/aty/atyfb_base.c conflict!
123
-
'F' 00-0F video/da8xx-fb.h conflict!
124
-
'F' 80-8F linux/arcfb.h conflict!
125
-
'F' DD video/sstfb.h conflict!
126
-
'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict!
127
-
'G' 00-0F linux/gigaset_dev.h conflict!
128
-
'H' 00-7F linux/hiddev.h conflict!
129
-
'H' 00-0F linux/hidraw.h conflict!
130
-
'H' 01 linux/mei.h conflict!
131
-
'H' 02 linux/mei.h conflict!
132
-
'H' 03 linux/mei.h conflict!
133
-
'H' 00-0F sound/asound.h conflict!
134
-
'H' 20-40 sound/asound_fm.h conflict!
135
-
'H' 80-8F sound/sfnt_info.h conflict!
136
-
'H' 10-8F sound/emu10k1.h conflict!
137
-
'H' 10-1F sound/sb16_csp.h conflict!
138
-
'H' 10-1F sound/hda_hwdep.h conflict!
139
-
'H' 40-4F sound/hdspm.h conflict!
140
-
'H' 40-4F sound/hdsp.h conflict!
141
-
'H' 90 sound/usb/usx2y/usb_stream.h
142
-
'H' A0 uapi/linux/usb/cdc-wdm.h
143
-
'H' C0-F0 net/bluetooth/hci.h conflict!
144
-
'H' C0-DF net/bluetooth/hidp/hidp.h conflict!
145
-
'H' C0-DF net/bluetooth/cmtp/cmtp.h conflict!
146
-
'H' C0-DF net/bluetooth/bnep/bnep.h conflict!
147
-
'H' F1 linux/hid-roccat.h <mailto:erazor_de@users.sourceforge.net>
148
-
'H' F8-FA sound/firewire.h
149
-
'I' all linux/isdn.h conflict!
150
-
'I' 00-0F drivers/isdn/divert/isdn_divert.h conflict!
151
-
'I' 40-4F linux/mISDNif.h conflict!
152
-
'J' 00-1F drivers/scsi/gdth_ioctl.h
153
-
'K' all linux/kd.h
154
-
'L' 00-1F linux/loop.h conflict!
155
-
'L' 10-1F drivers/scsi/mpt3sas/mpt3sas_ctl.h conflict!
156
-
'L' 20-2F linux/lightnvm.h
157
-
'L' E0-FF linux/ppdd.h encrypted disk device driver
158
-
<http://linux01.gwdg.de/~alatham/ppdd.html>
159
-
'M' all linux/soundcard.h conflict!
160
-
'M' 01-16 mtd/mtd-abi.h conflict!
161
-
and drivers/mtd/mtdchar.c
162
-
'M' 01-03 drivers/scsi/megaraid/megaraid_sas.h
163
-
'M' 00-0F drivers/video/fsl-diu-fb.h conflict!
164
-
'N' 00-1F drivers/usb/scanner.h
165
-
'N' 40-7F drivers/block/nvme.c
166
-
'O' 00-06 mtd/ubi-user.h UBI
167
-
'P' all linux/soundcard.h conflict!
168
-
'P' 60-6F sound/sscape_ioctl.h conflict!
169
-
'P' 00-0F drivers/usb/class/usblp.c conflict!
170
-
'P' 01-09 drivers/misc/pci_endpoint_test.c conflict!
171
-
'Q' all linux/soundcard.h
172
-
'R' 00-1F linux/random.h conflict!
173
-
'R' 01 linux/rfkill.h conflict!
174
-
'R' C0-DF net/bluetooth/rfcomm.h
175
-
'S' all linux/cdrom.h conflict!
176
-
'S' 80-81 scsi/scsi_ioctl.h conflict!
177
-
'S' 82-FF scsi/scsi.h conflict!
178
-
'S' 00-7F sound/asequencer.h conflict!
179
-
'T' all linux/soundcard.h conflict!
180
-
'T' 00-AF sound/asound.h conflict!
181
-
'T' all arch/x86/include/asm/ioctls.h conflict!
182
-
'T' C0-DF linux/if_tun.h conflict!
183
-
'U' all sound/asound.h conflict!
184
-
'U' 00-CF linux/uinput.h conflict!
185
-
'U' 00-EF linux/usbdevice_fs.h
186
-
'U' C0-CF drivers/bluetooth/hci_uart.h
187
-
'V' all linux/vt.h conflict!
188
-
'V' all linux/videodev2.h conflict!
189
-
'V' C0 linux/ivtvfb.h conflict!
190
-
'V' C0 linux/ivtv.h conflict!
191
-
'V' C0 media/davinci/vpfe_capture.h conflict!
192
-
'V' C0 media/si4713.h conflict!
193
-
'W' 00-1F linux/watchdog.h conflict!
194
-
'W' 00-1F linux/wanrouter.h conflict! (pre 3.9)
195
-
'W' 00-3F sound/asound.h conflict!
196
-
'W' 40-5F drivers/pci/switch/switchtec.c
197
-
'X' all fs/xfs/xfs_fs.h conflict!
198
-
and fs/xfs/linux-2.6/xfs_ioctl32.h
199
-
and include/linux/falloc.h
200
-
and linux/fs.h
201
-
'X' all fs/ocfs2/ocfs_fs.h conflict!
202
-
'X' 01 linux/pktcdvd.h conflict!
203
-
'Y' all linux/cyclades.h
204
-
'Z' 14-15 drivers/message/fusion/mptctl.h
205
-
'[' 00-3F linux/usb/tmc.h USB Test and Measurement Devices
206
-
<mailto:gregkh@linuxfoundation.org>
207
-
'a' all linux/atm*.h, linux/sonet.h ATM on linux
208
-
<http://lrcwww.epfl.ch/>
209
-
'a' 00-0F drivers/crypto/qat/qat_common/adf_cfg_common.h conflict! qat driver
210
-
'b' 00-FF conflict! bit3 vme host bridge
211
-
<mailto:natalia@nikhefk.nikhef.nl>
212
-
'c' all linux/cm4000_cs.h conflict!
213
-
'c' 00-7F linux/comstats.h conflict!
214
-
'c' 00-7F linux/coda.h conflict!
215
-
'c' 00-1F linux/chio.h conflict!
216
-
'c' 80-9F arch/s390/include/asm/chsc.h conflict!
217
-
'c' A0-AF arch/x86/include/asm/msr.h conflict!
218
-
'd' 00-FF linux/char/drm/drm.h conflict!
219
-
'd' 02-40 pcmcia/ds.h conflict!
220
-
'd' F0-FF linux/digi1.h
221
-
'e' all linux/digi1.h conflict!
222
-
'f' 00-1F linux/ext2_fs.h conflict!
223
-
'f' 00-1F linux/ext3_fs.h conflict!
224
-
'f' 00-0F fs/jfs/jfs_dinode.h conflict!
225
-
'f' 00-0F fs/ext4/ext4.h conflict!
226
-
'f' 00-0F linux/fs.h conflict!
227
-
'f' 00-0F fs/ocfs2/ocfs2_fs.h conflict!
228
-
'g' 00-0F linux/usb/gadgetfs.h
229
-
'g' 20-2F linux/usb/g_printer.h
230
-
'h' 00-7F conflict! Charon filesystem
231
-
<mailto:zapman@interlan.net>
232
-
'h' 00-1F linux/hpet.h conflict!
233
-
'h' 80-8F fs/hfsplus/ioctl.c
234
-
'i' 00-3F linux/i2o-dev.h conflict!
235
-
'i' 0B-1F linux/ipmi.h conflict!
236
-
'i' 80-8F linux/i8k.h
237
-
'j' 00-3F linux/joystick.h
238
-
'k' 00-0F linux/spi/spidev.h conflict!
239
-
'k' 00-05 video/kyro.h conflict!
240
-
'k' 10-17 linux/hsi/hsi_char.h HSI character device
241
-
'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system
242
-
<http://web.archive.org/web/*/http://mikonos.dia.unisa.it/tcfs>
243
-
'l' 40-7F linux/udf_fs_i.h in development:
244
-
<http://sourceforge.net/projects/linux-udf/>
245
-
'm' 00-09 linux/mmtimer.h conflict!
246
-
'm' all linux/mtio.h conflict!
247
-
'm' all linux/soundcard.h conflict!
248
-
'm' all linux/synclink.h conflict!
249
-
'm' 00-19 drivers/message/fusion/mptctl.h conflict!
250
-
'm' 00 drivers/scsi/megaraid/megaraid_ioctl.h conflict!
251
-
'n' 00-7F linux/ncp_fs.h and fs/ncpfs/ioctl.c
252
-
'n' 80-8F uapi/linux/nilfs2_api.h NILFS2
253
-
'n' E0-FF linux/matroxfb.h matroxfb
254
-
'o' 00-1F fs/ocfs2/ocfs2_fs.h OCFS2
255
-
'o' 00-03 mtd/ubi-user.h conflict! (OCFS2 and UBI overlaps)
256
-
'o' 40-41 mtd/ubi-user.h UBI
257
-
'o' 01-A1 linux/dvb/*.h DVB
258
-
'p' 00-0F linux/phantom.h conflict! (OpenHaptics needs this)
259
-
'p' 00-1F linux/rtc.h conflict!
260
-
'p' 00-3F linux/mc146818rtc.h conflict!
261
-
'p' 40-7F linux/nvram.h
262
-
'p' 80-9F linux/ppdev.h user-space parport
263
-
<mailto:tim@cyberelk.net>
264
-
'p' A1-A5 linux/pps.h LinuxPPS
265
-
<mailto:giometti@linux.it>
266
-
'q' 00-1F linux/serio.h
267
-
'q' 80-FF linux/telephony.h Internet PhoneJACK, Internet LineJACK
268
-
linux/ixjuser.h <http://web.archive.org/web/*/http://www.quicknet.net>
269
-
'r' 00-1F linux/msdos_fs.h and fs/fat/dir.c
270
-
's' all linux/cdk.h
271
-
't' 00-7F linux/ppp-ioctl.h
272
-
't' 80-8F linux/isdn_ppp.h
273
-
't' 90-91 linux/toshiba.h toshiba and toshiba_acpi SMM
274
-
'u' 00-1F linux/smb_fs.h gone
275
-
'u' 20-3F linux/uvcvideo.h USB video class host driver
276
-
'u' 40-4f linux/udmabuf.h userspace dma-buf misc device
277
-
'v' 00-1F linux/ext2_fs.h conflict!
278
-
'v' 00-1F linux/fs.h conflict!
279
-
'v' 00-0F linux/sonypi.h conflict!
280
-
'v' 00-0F media/v4l2-subdev.h conflict!
281
-
'v' C0-FF linux/meye.h conflict!
282
-
'w' all CERN SCI driver
283
-
'y' 00-1F packet based user level communications
284
-
<mailto:zapman@interlan.net>
285
-
'z' 00-3F CAN bus card conflict!
286
-
<mailto:hdstich@connectu.ulm.circular.de>
287
-
'z' 40-7F CAN bus card conflict!
288
-
<mailto:oe@port.de>
289
-
'z' 10-4F drivers/s390/crypto/zcrypt_api.h conflict!
290
-
'|' 00-7F linux/media.h
291
-
0x80 00-1F linux/fb.h
292
-
0x89 00-06 arch/x86/include/asm/sockios.h
293
-
0x89 0B-DF linux/sockios.h
294
-
0x89 E0-EF linux/sockios.h SIOCPROTOPRIVATE range
295
-
0x89 E0-EF linux/dn.h PROTOPRIVATE range
296
-
0x89 F0-FF linux/sockios.h SIOCDEVPRIVATE range
297
-
0x8B all linux/wireless.h
298
-
0x8C 00-3F WiNRADiO driver
299
-
<http://www.winradio.com.au/>
300
-
0x90 00 drivers/cdrom/sbpcd.h
301
-
0x92 00-0F drivers/usb/mon/mon_bin.c
302
-
0x93 60-7F linux/auto_fs.h
303
-
0x94 all fs/btrfs/ioctl.h Btrfs filesystem
304
-
and linux/fs.h some lifted to vfs/generic
305
-
0x97 00-7F fs/ceph/ioctl.h Ceph file system
306
-
0x99 00-0F 537-Addinboard driver
307
-
<mailto:buk@buks.ipn.de>
308
-
0xA0 all linux/sdp/sdp.h Industrial Device Project
309
-
<mailto:kenji@bitgate.com>
310
-
0xA1 0 linux/vtpm_proxy.h TPM Emulator Proxy Driver
311
-
0xA3 80-8F Port ACL in development:
312
-
<mailto:tlewis@mindspring.com>
313
-
0xA3 90-9F linux/dtlk.h
314
-
0xA4 00-1F uapi/linux/tee.h Generic TEE subsystem
315
-
0xAA 00-3F linux/uapi/linux/userfaultfd.h
316
-
0xAB 00-1F linux/nbd.h
317
-
0xAC 00-1F linux/raw.h
318
-
0xAD 00 Netfilter device in development:
319
-
<mailto:rusty@rustcorp.com.au>
320
-
0xAE all linux/kvm.h Kernel-based Virtual Machine
321
-
<mailto:kvm@vger.kernel.org>
322
-
0xAF 00-1F linux/fsl_hypervisor.h Freescale hypervisor
323
-
0xB0 all RATIO devices in development:
324
-
<mailto:vgo@ratio.de>
325
-
0xB1 00-1F PPPoX <mailto:mostrows@styx.uwaterloo.ca>
326
-
0xB3 00 linux/mmc/ioctl.h
327
-
0xB4 00-0F linux/gpio.h <mailto:linux-gpio@vger.kernel.org>
328
-
0xB5 00-0F uapi/linux/rpmsg.h <mailto:linux-remoteproc@vger.kernel.org>
329
-
0xB6 all linux/fpga-dfl.h
330
-
0xC0 00-0F linux/usb/iowarrior.h
331
-
0xCA 00-0F uapi/misc/cxl.h
332
-
0xCA 10-2F uapi/misc/ocxl.h
333
-
0xCA 80-BF uapi/scsi/cxlflash_ioctl.h
334
-
0xCB 00-1F CBM serial IEC bus in development:
335
-
<mailto:michael.klein@puffin.lb.shuttle.de>
336
-
0xCC 00-0F drivers/misc/ibmvmc.h pseries VMC driver
337
-
0xCD 01 linux/reiserfs_fs.h
338
-
0xCF 02 fs/cifs/ioctl.c
339
-
0xDB 00-0F drivers/char/mwave/mwavepub.h
340
-
0xDD 00-3F ZFCP device driver see drivers/s390/scsi/
341
-
<mailto:aherrman@de.ibm.com>
342
-
0xE5 00-3F linux/fuse.h
343
-
0xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver
344
-
0xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development)
345
-
<mailto:thomas@winischhofer.net>
346
-
0xF4 00-1F video/mbxfb.h mbxfb
347
-
<mailto:raph@8d.com>
348
-
0xF6 all LTTng Linux Trace Toolkit Next Generation
349
-
<mailto:mathieu.desnoyers@efficios.com>
350
-
0xFD all linux/dm-ioctl.h
351
-
0xFE all linux/isst_if.h
+1
-1
Documentation/process/submit-checklist.rst
+1
-1
Documentation/process/submit-checklist.rst
···
107
107
and why.
108
108
109
109
26) If any ioctl's are added by the patch, then also update
110
-
``Documentation/ioctl/ioctl-number.txt``.
110
+
``Documentation/ioctl/ioctl-number.rst``.
111
111
112
112
27) If your modified source code depends on or uses any of the kernel
113
113
APIs or features that are related to the following ``Kconfig`` symbols,
+1
-1
Documentation/translations/it_IT/process/submit-checklist.rst
+1
-1
Documentation/translations/it_IT/process/submit-checklist.rst
···
117
117
sorgenti che ne spieghi la logica: cosa fanno e perché.
118
118
119
119
25) Se la patch aggiunge nuove chiamate ioctl, allora aggiornate
120
-
``Documentation/ioctl/ioctl-number.txt``.
120
+
``Documentation/ioctl/ioctl-number.rst``.
121
121
122
122
26) Se il codice che avete modificato dipende o usa una qualsiasi interfaccia o
123
123
funzionalità del kernel che è associata a uno dei seguenti simboli
+1
-1
Documentation/translations/zh_CN/process/submit-checklist.rst
+1
-1
Documentation/translations/zh_CN/process/submit-checklist.rst
···
97
97
24) 所有内存屏障例如 ``barrier()``, ``rmb()``, ``wmb()`` 都需要源代码中的注
98
98
释来解释它们正在执行的操作及其原因的逻辑。
99
99
100
-
25) 如果补丁添加了任何ioctl，那么也要更新 ``Documentation/ioctl/ioctl-number.txt``
100
+
25) 如果补丁添加了任何ioctl，那么也要更新 ``Documentation/ioctl/ioctl-number.rst``
101
101
102
102
26) 如果修改后的源代码依赖或使用与以下 ``Kconfig`` 符号相关的任何内核API或
103
103
功能，则在禁用相关 ``Kconfig`` 符号和/或 ``=m`` （如果该选项可用）的情况
+1
-1
include/uapi/rdma/rdma_user_ioctl_cmds.h
+1
-1
include/uapi/rdma/rdma_user_ioctl_cmds.h