stm class: Introduce an abstraction for System Trace Module devices
[linux-2.6-block.git] / Documentation / ioctl / ioctl-number.txt
CommitLineData
1da177e4
LT
1Ioctl Numbers
219 October 1999
3Michael Elizabeth Chastain
4<mec@shout.net>
5
6If you are adding new ioctl's to the kernel, you should use the _IO
7macros 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
15system calls 'write' and 'read'. For example, a SET_FOO ioctl would
16be _IOW, although the kernel would actually read data from user space;
17a GET_FOO ioctl would be _IOR, although the kernel would actually write
18data to user space.
19
20The first argument to _IO, _IOW, _IOR, or _IOWR is an identifying letter
21or number from the table below. Because of the large number of drivers,
22many drivers share a partial letter with other drivers.
23
24If you are writing a driver for a new device and need a letter, pick an
25unused block with enough room for expansion: 32 to 256 ioctl commands.
26You can register the block by patching this file and submitting the
27patch to Linus Torvalds. Or you can e-mail me at <mec@shout.net> and
28I'll register one for you.
29
30The second argument to _IO, _IOW, _IOR, or _IOWR is a sequence number
31to 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
33out of the kernel (e.g. 'int' or 'struct foo'). NOTE! Do NOT use
34sizeof(arg) as the third argument as this results in your ioctl thinking
35it passes an argument of type size_t.
36
37Some devices use their major number as the identifier; this is OK, as
38long as it is unique. Some devices are irregular and don't follow any
39convention at all.
40
41Following 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
cb5a8b2c
RD
59This table lists ioctls visible from user land for Linux/x86. It contains
60most drivers up to 2.6.31, but I know I am missing some. There has been
61no attempt to list non-X86 architectures or ioctls from drivers/staging/.
1da177e4 62
cb5a8b2c 63Code Seq#(hex) Include File Comments
1da177e4
LT
64========================================================
650x00 00-1F linux/fs.h conflict!
660x00 00-1F scsi/scsi_ioctl.h conflict!
670x00 00-1F linux/fb.h conflict!
680x00 00-1F linux/wavefront.h conflict!
690x02 all linux/fd.h
700x03 all linux/hdreg.h
d5298802 710x04 D2-DC linux/umsdos_fs.h Dead since 2.6.11, but don't reuse these.
1da177e4 720x06 all linux/lp.h
cb5a8b2c
RD
730x09 all linux/raid/md_u.h
740x10 00-0F drivers/char/s390/vmcp.h
d475f942 750x10 10-1F arch/s390/include/uapi/sclp_ctl.h
07be0382 760x10 20-2F arch/s390/include/uapi/asm/hypfs.h
1da177e4
LT
770x12 all linux/fs.h
78 linux/blkpg.h
0ea6e611 790x1b all InfiniBand Subsystem <http://infiniband.sourceforge.net/>
1da177e4
LT
800x20 all drivers/cdrom/cm206.h
810x22 all scsi/sg.h
82'#' 00-3F IEEE 1394 Subsystem Block for the entire subsystem
cb5a8b2c 83'$' 00-0F linux/perf_counter.h, linux/perf_event.h
7bd1d409
AS
84'%' 00-0F include/uapi/linux/stm.h
85 System Trace Module subsystem
86 <mailto:alexander.shishkin@linux.intel.com>
aed69d2b 87'&' 00-07 drivers/firewire/nosy-user.h
1da177e4
LT
88'1' 00-1F <linux/timepps.h> PPS kit from Ulrich Windl
89 <ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
cb5a8b2c
RD
90'2' 01-04 linux/i2o.h
91'3' 00-0F drivers/s390/char/raw3270.h conflict!
92'3' 00-1F linux/suspend_ioctls.h conflict!
93 and kernel/power/user.c
1da177e4
LT
94'8' all SNP8023 advanced NIC card
95 <mailto:mcr@solidum.com>
cba3345c 96';' 64-7F linux/vfio.h
cb5a8b2c
RD
97'@' 00-0F linux/radeonfb.h conflict!
98'@' 00-0F drivers/video/aty/aty128fb.c conflict!
99'A' 00-1F linux/apm_bios.h conflict!
100'A' 00-0F linux/agpgart.h conflict!
101 and drivers/char/agp/compat_ioctl.h
102'A' 00-7F sound/asound.h conflict!
103'B' 00-1F linux/cciss_ioctl.h conflict!
104'B' 00-0F include/linux/pmu.h conflict!
1da177e4
LT
105'B' C0-FF advanced bbus
106 <mailto:maassen@uni-freiburg.de>
cb5a8b2c
RD
107'C' all linux/soundcard.h conflict!
108'C' 01-2F linux/capi.h conflict!
109'C' F0-FF drivers/net/wan/cosa.h conflict!
07983f0e 110'D' all arch/s390/include/asm/dasd.h
cb5a8b2c
RD
111'D' 40-5F drivers/scsi/dpt/dtpi_ioctl.h
112'D' 05 drivers/scsi/pmcraid.h
113'E' all linux/input.h conflict!
114'E' 00-0F xen/evtchn.h conflict!
115'F' all linux/fb.h conflict!
116'F' 01-02 drivers/scsi/pmcraid.h conflict!
117'F' 20 drivers/video/fsl-diu-fb.h conflict!
118'F' 20 drivers/video/intelfb/intelfb.h conflict!
119'F' 20 linux/ivtvfb.h conflict!
120'F' 20 linux/matroxfb.h conflict!
121'F' 20 drivers/video/aty/atyfb_base.c conflict!
122'F' 00-0F video/da8xx-fb.h conflict!
123'F' 80-8F linux/arcfb.h conflict!
124'F' DD video/sstfb.h conflict!
125'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict!
126'G' 00-0F linux/gigaset_dev.h conflict!
127'H' 00-7F linux/hiddev.h conflict!
128'H' 00-0F linux/hidraw.h conflict!
4cd7a7e7 129'H' 01 linux/mei.h conflict!
3c7c8468
TW
130'H' 02 linux/mei.h conflict!
131'H' 03 linux/mei.h conflict!
cb5a8b2c
RD
132'H' 00-0F sound/asound.h conflict!
133'H' 20-40 sound/asound_fm.h conflict!
134'H' 80-8F sound/sfnt_info.h conflict!
135'H' 10-8F sound/emu10k1.h conflict!
136'H' 10-1F sound/sb16_csp.h conflict!
137'H' 10-1F sound/hda_hwdep.h conflict!
138'H' 40-4F sound/hdspm.h conflict!
139'H' 40-4F sound/hdsp.h conflict!
140'H' 90 sound/usb/usx2y/usb_stream.h
3edce1cf 141'H' A0 uapi/linux/usb/cdc-wdm.h
cb5a8b2c
RD
142'H' C0-F0 net/bluetooth/hci.h conflict!
143'H' C0-DF net/bluetooth/hidp/hidp.h conflict!
144'H' C0-DF net/bluetooth/cmtp/cmtp.h conflict!
145'H' C0-DF net/bluetooth/bnep/bnep.h conflict!
5dc0c983 146'H' F1 linux/hid-roccat.h <mailto:erazor_de@users.sourceforge.net>
82fbb4f7 147'H' F8-FA sound/firewire.h
cb5a8b2c
RD
148'I' all linux/isdn.h conflict!
149'I' 00-0F drivers/isdn/divert/isdn_divert.h conflict!
150'I' 40-4F linux/mISDNif.h conflict!
1da177e4
LT
151'J' 00-1F drivers/scsi/gdth_ioctl.h
152'K' all linux/kd.h
cb5a8b2c
RD
153'L' 00-1F linux/loop.h conflict!
154'L' 10-1F drivers/scsi/mpt2sas/mpt2sas_ctl.h conflict!
1da177e4
LT
155'L' E0-FF linux/ppdd.h encrypted disk device driver
156 <http://linux01.gwdg.de/~alatham/ppdd.html>
cb5a8b2c
RD
157'M' all linux/soundcard.h conflict!
158'M' 01-16 mtd/mtd-abi.h conflict!
159 and drivers/mtd/mtdchar.c
160'M' 01-03 drivers/scsi/megaraid/megaraid_sas.h
161'M' 00-0F drivers/video/fsl-diu-fb.h conflict!
1da177e4 162'N' 00-1F drivers/usb/scanner.h
b60503ba 163'N' 40-7F drivers/block/nvme.c
cb5a8b2c
RD
164'O' 00-06 mtd/ubi-user.h UBI
165'P' all linux/soundcard.h conflict!
166'P' 60-6F sound/sscape_ioctl.h conflict!
167'P' 00-0F drivers/usb/class/usblp.c conflict!
1da177e4 168'Q' all linux/soundcard.h
cb5a8b2c
RD
169'R' 00-1F linux/random.h conflict!
170'R' 01 linux/rfkill.h conflict!
cb5a8b2c 171'R' C0-DF net/bluetooth/rfcomm.h
1da177e4
LT
172'S' all linux/cdrom.h conflict!
173'S' 80-81 scsi/scsi_ioctl.h conflict!
174'S' 82-FF scsi/scsi.h conflict!
cb5a8b2c 175'S' 00-7F sound/asequencer.h conflict!
1da177e4 176'T' all linux/soundcard.h conflict!
cb5a8b2c 177'T' 00-AF sound/asound.h conflict!
07983f0e 178'T' all arch/x86/include/asm/ioctls.h conflict!
cb5a8b2c
RD
179'T' C0-DF linux/if_tun.h conflict!
180'U' all sound/asound.h conflict!
cb5a8b2c
RD
181'U' 00-CF linux/uinput.h conflict!
182'U' 00-EF linux/usbdevice_fs.h
183'U' C0-CF drivers/bluetooth/hci_uart.h
184'V' all linux/vt.h conflict!
185'V' all linux/videodev2.h conflict!
186'V' C0 linux/ivtvfb.h conflict!
187'V' C0 linux/ivtv.h conflict!
188'V' C0 media/davinci/vpfe_capture.h conflict!
189'V' C0 media/si4713.h conflict!
1da177e4 190'W' 00-1F linux/watchdog.h conflict!
a786a7c0 191'W' 00-1F linux/wanrouter.h conflict! (pre 3.9)
cb5a8b2c
RD
192'W' 00-3F sound/asound.h conflict!
193'X' all fs/xfs/xfs_fs.h conflict!
194 and fs/xfs/linux-2.6/xfs_ioctl32.h
195 and include/linux/falloc.h
196 and linux/fs.h
197'X' all fs/ocfs2/ocfs_fs.h conflict!
198'X' 01 linux/pktcdvd.h conflict!
1da177e4 199'Y' all linux/cyclades.h
cb5a8b2c
RD
200'Z' 14-15 drivers/message/fusion/mptctl.h
201'[' 00-07 linux/usb/tmc.h USB Test and Measurement Devices
bc5bca53 202 <mailto:gregkh@linuxfoundation.org>
cb5a8b2c 203'a' all linux/atm*.h, linux/sonet.h ATM on linux
0ea6e611 204 <http://lrcwww.epfl.ch/>
cea4001a 205'a' 00-0F drivers/crypto/qat/qat_common/adf_cfg_common.h conflict! qat driver
cb5a8b2c 206'b' 00-FF conflict! bit3 vme host bridge
1da177e4 207 <mailto:natalia@nikhefk.nikhef.nl>
cb5a8b2c 208'c' all linux/cm4000_cs.h conflict!
1da177e4
LT
209'c' 00-7F linux/comstats.h conflict!
210'c' 00-7F linux/coda.h conflict!
cb5a8b2c
RD
211'c' 00-1F linux/chio.h conflict!
212'c' 80-9F arch/s390/include/asm/chsc.h conflict!
213'c' A0-AF arch/x86/include/asm/msr.h conflict!
1da177e4 214'd' 00-FF linux/char/drm/drm/h conflict!
cb5a8b2c 215'd' 02-40 pcmcia/ds.h conflict!
1da177e4
LT
216'd' F0-FF linux/digi1.h
217'e' all linux/digi1.h conflict!
cb5a8b2c
RD
218'e' 00-1F drivers/net/irda/irtty-sir.h conflict!
219'f' 00-1F linux/ext2_fs.h conflict!
220'f' 00-1F linux/ext3_fs.h conflict!
221'f' 00-0F fs/jfs/jfs_dinode.h conflict!
222'f' 00-0F fs/ext4/ext4.h conflict!
223'f' 00-0F linux/fs.h conflict!
224'f' 00-0F fs/ocfs2/ocfs2_fs.h conflict!
225'g' 00-0F linux/usb/gadgetfs.h
226'g' 20-2F linux/usb/g_printer.h
227'h' 00-7F conflict! Charon filesystem
1da177e4 228 <mailto:zapman@interlan.net>
cb5a8b2c 229'h' 00-1F linux/hpet.h conflict!
a051f71c 230'h' 80-8F fs/hfsplus/ioctl.c
cb5a8b2c
RD
231'i' 00-3F linux/i2o-dev.h conflict!
232'i' 0B-1F linux/ipmi.h conflict!
233'i' 80-8F linux/i8k.h
1da177e4 234'j' 00-3F linux/joystick.h
cb5a8b2c
RD
235'k' 00-0F linux/spi/spidev.h conflict!
236'k' 00-05 video/kyro.h conflict!
43139a61 237'k' 10-17 linux/hsi/hsi_char.h HSI character device
1da177e4 238'l' 00-3F linux/tcfs_fs.h transparent cryptographic file system
0ea6e611 239 <http://web.archive.org/web/*/http://mikonos.dia.unisa.it/tcfs>
1da177e4 240'l' 40-7F linux/udf_fs_i.h in development:
98766fbe 241 <http://sourceforge.net/projects/linux-udf/>
cb5a8b2c 242'm' 00-09 linux/mmtimer.h conflict!
1da177e4
LT
243'm' all linux/mtio.h conflict!
244'm' all linux/soundcard.h conflict!
245'm' all linux/synclink.h conflict!
cb5a8b2c
RD
246'm' 00-19 drivers/message/fusion/mptctl.h conflict!
247'm' 00 drivers/scsi/megaraid/megaraid_ioctl.h conflict!
1da177e4 248'm' 00-1F net/irda/irmod.h conflict!
cb5a8b2c 249'n' 00-7F linux/ncp_fs.h and fs/ncpfs/ioctl.c
1392e3b3 250'n' 80-8F linux/nilfs2_fs.h NILFS2
cb5a8b2c 251'n' E0-FF linux/matroxfb.h matroxfb
7f68fc28 252'o' 00-1F fs/ocfs2/ocfs2_fs.h OCFS2
cb5a8b2c
RD
253'o' 00-03 mtd/ubi-user.h conflict! (OCFS2 and UBI overlaps)
254'o' 40-41 mtd/ubi-user.h UBI
255'o' 01-A1 linux/dvb/*.h DVB
cef2cf07 256'p' 00-0F linux/phantom.h conflict! (OpenHaptics needs this)
cb5a8b2c 257'p' 00-1F linux/rtc.h conflict!
cef2cf07 258'p' 00-3F linux/mc146818rtc.h conflict!
1da177e4 259'p' 40-7F linux/nvram.h
cb5a8b2c 260'p' 80-9F linux/ppdev.h user-space parport
1da177e4 261 <mailto:tim@cyberelk.net>
717c0336 262'p' A1-A5 linux/pps.h LinuxPPS
eae9d2ba 263 <mailto:giometti@linux.it>
1da177e4 264'q' 00-1F linux/serio.h
cb5a8b2c 265'q' 80-FF linux/telephony.h Internet PhoneJACK, Internet LineJACK
0ea6e611 266 linux/ixjuser.h <http://web.archive.org/web/*/http://www.quicknet.net>
cb5a8b2c 267'r' 00-1F linux/msdos_fs.h and fs/fat/dir.c
1da177e4 268's' all linux/cdk.h
bf7daebb 269't' 00-7F linux/ppp-ioctl.h
1da177e4 270't' 80-8F linux/isdn_ppp.h
fc5462f8 271't' 90-91 linux/toshiba.h toshiba and toshiba_acpi SMM
2116b7a4 272'u' 00-1F linux/smb_fs.h gone
5f708812 273'u' 20-3F linux/uvcvideo.h USB video class host driver
cb5a8b2c
RD
274'v' 00-1F linux/ext2_fs.h conflict!
275'v' 00-1F linux/fs.h conflict!
276'v' 00-0F linux/sonypi.h conflict!
cb5a8b2c 277'v' C0-FF linux/meye.h conflict!
1da177e4
LT
278'w' all CERN SCI driver
279'y' 00-1F packet based user level communications
280 <mailto:zapman@interlan.net>
cb5a8b2c 281'z' 00-3F CAN bus card conflict!
1da177e4 282 <mailto:hdstich@connectu.ulm.circular.de>
cb5a8b2c 283'z' 40-7F CAN bus card conflict!
1da177e4 284 <mailto:oe@port.de>
cb5a8b2c 285'z' 10-4F drivers/s390/crypto/zcrypt_api.h conflict!
474966ee 286'|' 00-7F linux/media.h
1da177e4 2870x80 00-1F linux/fb.h
07983f0e 2880x89 00-06 arch/x86/include/asm/sockios.h
1da177e4
LT
2890x89 0B-DF linux/sockios.h
2900x89 E0-EF linux/sockios.h SIOCPROTOPRIVATE range
cb5a8b2c 2910x89 E0-EF linux/dn.h PROTOPRIVATE range
1da177e4
LT
2920x89 F0-FF linux/sockios.h SIOCDEVPRIVATE range
2930x8B all linux/wireless.h
2940x8C 00-3F WiNRADiO driver
0ea6e611 295 <http://www.winradio.com.au/>
1da177e4 2960x90 00 drivers/cdrom/sbpcd.h
cb5a8b2c 2970x92 00-0F drivers/usb/mon/mon_bin.c
1da177e4 2980x93 60-7F linux/auto_fs.h
cb5a8b2c 2990x94 all fs/btrfs/ioctl.h
fc7f99cf 3000x97 00-7F fs/ceph/ioctl.h Ceph file system
1da177e4
LT
3010x99 00-0F 537-Addinboard driver
302 <mailto:buk@buks.ipn.de>
3030xA0 all linux/sdp/sdp.h Industrial Device Project
304 <mailto:kenji@bitgate.com>
ea41b1e5 3050xA2 00-0F arch/tile/include/asm/hardwall.h
1da177e4
LT
3060xA3 80-8F Port ACL in development:
307 <mailto:tlewis@mindspring.com>
3080xA3 90-9F linux/dtlk.h
1038628d 3090xAA 00-3F linux/uapi/linux/userfaultfd.h
1da177e4
LT
3100xAB 00-1F linux/nbd.h
3110xAC 00-1F linux/raw.h
3120xAD 00 Netfilter device in development:
cb5a8b2c 313 <mailto:rusty@rustcorp.com.au>
258ac8e0 3140xAE all linux/kvm.h Kernel-based Virtual Machine
0aaeb3b1 315 <mailto:kvm@vger.kernel.org>
6db71994 3160xAF 00-1F linux/fsl_hypervisor.h Freescale hypervisor
1da177e4
LT
3170xB0 all RATIO devices in development:
318 <mailto:vgo@ratio.de>
3190xB1 00-1F PPPoX <mailto:mostrows@styx.uwaterloo.ca>
cb87ea28 3200xB3 00 linux/mmc/ioctl.h
cb5a8b2c 3210xC0 00-0F linux/usb/iowarrior.h
a9282d01 3220xCA 00-0F uapi/misc/cxl.h
65be2c79 3230xCA 80-8F uapi/scsi/cxlflash_ioctl.h
1da177e4
LT
3240xCB 00-1F CBM serial IEC bus in development:
325 <mailto:michael.klein@puffin.lb.shuttle.de>
cb5a8b2c
RD
3260xCD 01 linux/reiserfs_fs.h
3270xCF 02 fs/cifs/ioctl.c
3280xDB 00-0F drivers/char/mwave/mwavepub.h
1da177e4
LT
3290xDD 00-3F ZFCP device driver see drivers/s390/scsi/
330 <mailto:aherrman@de.ibm.com>
00c570f4 3310xE5 00-3F linux/fuse.h
e7c256fb 3320xEC 00-01 drivers/platform/chrome/cros_ec_dev.h ChromeOS EC driver
cb5a8b2c 3330xF3 00-3F drivers/usb/misc/sisusbvga/sisusb.h sisfb (in development)
1da177e4 334 <mailto:thomas@winischhofer.net>
1ce4d390
RA
3350xF4 00-1F video/mbxfb.h mbxfb
336 <mailto:raph@8d.com>
14d01ff5
MD
3370xF6 all LTTng Linux Trace Toolkit Next Generation
338 <mailto:mathieu.desnoyers@efficios.com>
cb5a8b2c 3390xFD all linux/dm-ioctl.h