ioctl-number.txt 13 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
Ioctl Numbers
19 October 1999
Michael Elizabeth Chastain
<mec@shout.net>

If you are adding new ioctl's to the kernel, you should use the _IO
macros defined in <linux/ioctl.h>:

    _IO    an ioctl with no parameters
    _IOW   an ioctl with write parameters (copy_from_user)
    _IOR   an ioctl with read parameters  (copy_to_user)
    _IOWR  an ioctl with both write and read parameters.

'Write' and 'read' are from the user's point of view, just like the
system calls 'write' and 'read'.  For example, a SET_FOO ioctl would
be _IOW, although the kernel would actually read data from user space;
a GET_FOO ioctl would be _IOR, although the kernel would actually write
data to user space.

The first argument to _IO, _IOW, _IOR, or _IOWR is an identifying letter
or number from the table below.  Because of the large number of drivers,
many drivers share a partial letter with other drivers.

If you are writing a driver for a new device and need a letter, pick an
unused block with enough room for expansion: 32 to 256 ioctl commands.
You can register the block by patching this file and submitting the
patch to Linus Torvalds.  Or you can e-mail me at <mec@shout.net> and
I'll register one for you.

The second argument to _IO, _IOW, _IOR, or _IOWR is a sequence number
to distinguish ioctls from each other.  The third argument to _IOW,
_IOR, or _IOWR is the type of the data going into the kernel or coming
out of the kernel (e.g.  'int' or 'struct foo').  NOTE!  Do NOT use
sizeof(arg) as the third argument as this results in your ioctl thinking
it passes an argument of type size_t.

Some devices use their major number as the identifier; this is OK, as
long as it is unique.  Some devices are irregular and don't follow any
convention at all.

Following this convention is good because:

(1) Keeping the ioctl's globally unique helps error checking:
    if a program calls an ioctl on the wrong device, it will get an
    error rather than some unexpected behaviour.

(2) The 'strace' build procedure automatically finds ioctl numbers
    defined with _IO, _IOW, _IOR, or _IOWR.

(3) 'strace' can decode numbers back into useful names when the
    numbers are unique.

(4) People looking for ioctls can grep for them more easily when
    this convention is used to define the ioctl numbers.

(5) When following the convention, the driver code can use generic
    code to copy the parameters between user and kernel space.

59 60 61
This table lists ioctls visible from user land for Linux/x86.  It contains
most drivers up to 2.6.31, but I know I am missing some.  There has been
no attempt to list non-X86 architectures or ioctls from drivers/staging/.
Linus Torvalds's avatar
Linus Torvalds committed
62

63
Code  Seq#(hex)	Include File		Comments
Linus Torvalds's avatar
Linus Torvalds committed
64 65 66 67 68 69 70
========================================================
0x00	00-1F	linux/fs.h		conflict!
0x00	00-1F	scsi/scsi_ioctl.h	conflict!
0x00	00-1F	linux/fb.h		conflict!
0x00	00-1F	linux/wavefront.h	conflict!
0x02	all	linux/fd.h
0x03	all	linux/hdreg.h
71
0x04	D2-DC	linux/umsdos_fs.h	Dead since 2.6.11, but don't reuse these.
Linus Torvalds's avatar
Linus Torvalds committed
72
0x06	all	linux/lp.h
73 74
0x09	all	linux/raid/md_u.h
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
Linus Torvalds's avatar
Linus Torvalds committed
77 78
0x12	all	linux/fs.h
		linux/blkpg.h
79
0x1b	all	InfiniBand Subsystem	<http://infiniband.sourceforge.net/>
Linus Torvalds's avatar
Linus Torvalds committed
80 81 82
0x20	all	drivers/cdrom/cm206.h
0x22	all	scsi/sg.h
'#'	00-3F	IEEE 1394 Subsystem	Block for the entire subsystem
83
'$'	00-0F	linux/perf_counter.h, linux/perf_event.h
84 85 86
'%'	00-0F	include/uapi/linux/stm.h
					System Trace Module subsystem
					<mailto:alexander.shishkin@linux.intel.com>
87
'&'	00-07	drivers/firewire/nosy-user.h
Linus Torvalds's avatar
Linus Torvalds committed
88 89
'1'	00-1F	<linux/timepps.h>	PPS kit from Ulrich Windl
					<ftp://ftp.de.kernel.org/pub/linux/daemons/ntp/PPS/>
90 91 92 93
'2'	01-04	linux/i2o.h
'3'	00-0F	drivers/s390/char/raw3270.h	conflict!
'3'	00-1F	linux/suspend_ioctls.h	conflict!
		and kernel/power/user.c
Linus Torvalds's avatar
Linus Torvalds committed
94 95
'8'	all				SNP8023 advanced NIC card
					<mailto:mcr@solidum.com>
Alex Williamson's avatar
Alex Williamson committed
96
';'	64-7F	linux/vfio.h
97 98 99 100 101 102 103 104
'@'	00-0F	linux/radeonfb.h	conflict!
'@'	00-0F	drivers/video/aty/aty128fb.c	conflict!
'A'	00-1F	linux/apm_bios.h	conflict!
'A'	00-0F	linux/agpgart.h		conflict!
		and drivers/char/agp/compat_ioctl.h
'A'	00-7F	sound/asound.h		conflict!
'B'	00-1F	linux/cciss_ioctl.h	conflict!
'B'	00-0F	include/linux/pmu.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
105 106
'B'	C0-FF				advanced bbus
					<mailto:maassen@uni-freiburg.de>
107 108 109
'C'	all	linux/soundcard.h	conflict!
'C'	01-2F	linux/capi.h		conflict!
'C'	F0-FF	drivers/net/wan/cosa.h	conflict!
110
'D'	all	arch/s390/include/asm/dasd.h
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128
'D'	40-5F	drivers/scsi/dpt/dtpi_ioctl.h
'D'	05	drivers/scsi/pmcraid.h
'E'	all	linux/input.h		conflict!
'E'	00-0F	xen/evtchn.h		conflict!
'F'	all	linux/fb.h		conflict!
'F'	01-02	drivers/scsi/pmcraid.h	conflict!
'F'	20	drivers/video/fsl-diu-fb.h	conflict!
'F'	20	drivers/video/intelfb/intelfb.h	conflict!
'F'	20	linux/ivtvfb.h		conflict!
'F'	20	linux/matroxfb.h	conflict!
'F'	20	drivers/video/aty/atyfb_base.c	conflict!
'F'	00-0F	video/da8xx-fb.h	conflict!
'F'	80-8F	linux/arcfb.h		conflict!
'F'	DD	video/sstfb.h		conflict!
'G'	00-3F	drivers/misc/sgi-gru/grulib.h	conflict!
'G'	00-0F	linux/gigaset_dev.h	conflict!
'H'	00-7F	linux/hiddev.h		conflict!
'H'	00-0F	linux/hidraw.h		conflict!
129
'H'	01	linux/mei.h		conflict!
130 131
'H'	02	linux/mei.h		conflict!
'H'	03	linux/mei.h		conflict!
132 133 134 135 136 137 138 139 140
'H'	00-0F	sound/asound.h		conflict!
'H'	20-40	sound/asound_fm.h	conflict!
'H'	80-8F	sound/sfnt_info.h	conflict!
'H'	10-8F	sound/emu10k1.h		conflict!
'H'	10-1F	sound/sb16_csp.h	conflict!
'H'	10-1F	sound/hda_hwdep.h	conflict!
'H'	40-4F	sound/hdspm.h		conflict!
'H'	40-4F	sound/hdsp.h		conflict!
'H'	90	sound/usb/usx2y/usb_stream.h
141
'H'	A0	uapi/linux/usb/cdc-wdm.h
142 143 144 145
'H'	C0-F0	net/bluetooth/hci.h	conflict!
'H'	C0-DF	net/bluetooth/hidp/hidp.h	conflict!
'H'	C0-DF	net/bluetooth/cmtp/cmtp.h	conflict!
'H'	C0-DF	net/bluetooth/bnep/bnep.h	conflict!
146
'H'	F1	linux/hid-roccat.h	<mailto:erazor_de@users.sourceforge.net>
Clemens Ladisch's avatar
Clemens Ladisch committed
147
'H'	F8-FA	sound/firewire.h
148 149 150
'I'	all	linux/isdn.h		conflict!
'I'	00-0F	drivers/isdn/divert/isdn_divert.h	conflict!
'I'	40-4F	linux/mISDNif.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
151 152
'J'	00-1F	drivers/scsi/gdth_ioctl.h
'K'	all	linux/kd.h
153 154
'L'	00-1F	linux/loop.h		conflict!
'L'	10-1F	drivers/scsi/mpt2sas/mpt2sas_ctl.h	conflict!
155
'L'	20-2F	linux/lightnvm.h
Linus Torvalds's avatar
Linus Torvalds committed
156 157
'L'	E0-FF	linux/ppdd.h		encrypted disk device driver
					<http://linux01.gwdg.de/~alatham/ppdd.html>
158 159 160 161 162
'M'	all	linux/soundcard.h	conflict!
'M'	01-16	mtd/mtd-abi.h		conflict!
		and drivers/mtd/mtdchar.c
'M'	01-03	drivers/scsi/megaraid/megaraid_sas.h
'M'	00-0F	drivers/video/fsl-diu-fb.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
163
'N'	00-1F	drivers/usb/scanner.h
Matthew Wilcox's avatar
Matthew Wilcox committed
164
'N'	40-7F	drivers/block/nvme.c
165 166 167 168
'O'     00-06   mtd/ubi-user.h		UBI
'P'	all	linux/soundcard.h	conflict!
'P'	60-6F	sound/sscape_ioctl.h	conflict!
'P'	00-0F	drivers/usb/class/usblp.c	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
169
'Q'	all	linux/soundcard.h
170 171 172
'R'	00-1F	linux/random.h		conflict!
'R'	01	linux/rfkill.h		conflict!
'R'	C0-DF	net/bluetooth/rfcomm.h
Linus Torvalds's avatar
Linus Torvalds committed
173 174 175
'S'	all	linux/cdrom.h		conflict!
'S'	80-81	scsi/scsi_ioctl.h	conflict!
'S'	82-FF	scsi/scsi.h		conflict!
176
'S'	00-7F	sound/asequencer.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
177
'T'	all	linux/soundcard.h	conflict!
178
'T'	00-AF	sound/asound.h		conflict!
179
'T'	all	arch/x86/include/asm/ioctls.h	conflict!
180 181 182 183 184 185 186 187 188 189 190
'T'	C0-DF	linux/if_tun.h		conflict!
'U'	all	sound/asound.h		conflict!
'U'	00-CF	linux/uinput.h		conflict!
'U'	00-EF	linux/usbdevice_fs.h
'U'	C0-CF	drivers/bluetooth/hci_uart.h
'V'	all	linux/vt.h		conflict!
'V'	all	linux/videodev2.h	conflict!
'V'	C0	linux/ivtvfb.h		conflict!
'V'	C0	linux/ivtv.h		conflict!
'V'	C0	media/davinci/vpfe_capture.h	conflict!
'V'	C0	media/si4713.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
191
'W'	00-1F	linux/watchdog.h	conflict!
192
'W'	00-1F	linux/wanrouter.h	conflict!		(pre 3.9)
193 194 195 196 197 198 199
'W'	00-3F	sound/asound.h		conflict!
'X'	all	fs/xfs/xfs_fs.h		conflict!
		and fs/xfs/linux-2.6/xfs_ioctl32.h
		and include/linux/falloc.h
		and linux/fs.h
'X'	all	fs/ocfs2/ocfs_fs.h	conflict!
'X'	01	linux/pktcdvd.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
200
'Y'	all	linux/cyclades.h
201 202
'Z'	14-15	drivers/message/fusion/mptctl.h
'['	00-07	linux/usb/tmc.h		USB Test and Measurement Devices
203
					<mailto:gregkh@linuxfoundation.org>
204
'a'	all	linux/atm*.h, linux/sonet.h	ATM on linux
205
					<http://lrcwww.epfl.ch/>
206
'a'	00-0F	drivers/crypto/qat/qat_common/adf_cfg_common.h	conflict! qat driver
207
'b'	00-FF				conflict! bit3 vme host bridge
Linus Torvalds's avatar
Linus Torvalds committed
208
					<mailto:natalia@nikhefk.nikhef.nl>
209
'c'	all	linux/cm4000_cs.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
210 211
'c'	00-7F	linux/comstats.h	conflict!
'c'	00-7F	linux/coda.h		conflict!
212 213 214
'c'	00-1F	linux/chio.h		conflict!
'c'	80-9F	arch/s390/include/asm/chsc.h	conflict!
'c'	A0-AF   arch/x86/include/asm/msr.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
215
'd'	00-FF	linux/char/drm/drm/h	conflict!
216
'd'	02-40	pcmcia/ds.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
217 218
'd'	F0-FF	linux/digi1.h
'e'	all	linux/digi1.h		conflict!
219 220 221 222 223 224 225 226 227 228
'e'	00-1F	drivers/net/irda/irtty-sir.h	conflict!
'f'	00-1F	linux/ext2_fs.h		conflict!
'f'	00-1F	linux/ext3_fs.h		conflict!
'f'	00-0F	fs/jfs/jfs_dinode.h	conflict!
'f'	00-0F	fs/ext4/ext4.h		conflict!
'f'	00-0F	linux/fs.h		conflict!
'f'	00-0F	fs/ocfs2/ocfs2_fs.h	conflict!
'g'	00-0F	linux/usb/gadgetfs.h
'g'	20-2F	linux/usb/g_printer.h
'h'	00-7F				conflict! Charon filesystem
Linus Torvalds's avatar
Linus Torvalds committed
229
					<mailto:zapman@interlan.net>
230
'h'	00-1F	linux/hpet.h		conflict!
231
'h'	80-8F	fs/hfsplus/ioctl.c
232 233 234
'i'	00-3F	linux/i2o-dev.h		conflict!
'i'	0B-1F	linux/ipmi.h		conflict!
'i'	80-8F	linux/i8k.h
Linus Torvalds's avatar
Linus Torvalds committed
235
'j'	00-3F	linux/joystick.h
236 237
'k'	00-0F	linux/spi/spidev.h	conflict!
'k'	00-05	video/kyro.h		conflict!
238
'k'	10-17	linux/hsi/hsi_char.h	HSI character device
Linus Torvalds's avatar
Linus Torvalds committed
239
'l'	00-3F	linux/tcfs_fs.h		transparent cryptographic file system
240
					<http://web.archive.org/web/*/http://mikonos.dia.unisa.it/tcfs>
Linus Torvalds's avatar
Linus Torvalds committed
241
'l'	40-7F	linux/udf_fs_i.h	in development:
242
					<http://sourceforge.net/projects/linux-udf/>
243
'm'	00-09	linux/mmtimer.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
244 245 246
'm'	all	linux/mtio.h		conflict!
'm'	all	linux/soundcard.h	conflict!
'm'	all	linux/synclink.h	conflict!
247 248
'm'	00-19	drivers/message/fusion/mptctl.h	conflict!
'm'	00	drivers/scsi/megaraid/megaraid_ioctl.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
249
'm'	00-1F	net/irda/irmod.h	conflict!
250
'n'	00-7F	linux/ncp_fs.h and fs/ncpfs/ioctl.c
251
'n'	80-8F	linux/nilfs2_fs.h	NILFS2
252
'n'	E0-FF	linux/matroxfb.h	matroxfb
Tao Ma's avatar
Tao Ma committed
253
'o'	00-1F	fs/ocfs2/ocfs2_fs.h	OCFS2
254 255 256
'o'     00-03   mtd/ubi-user.h		conflict! (OCFS2 and UBI overlaps)
'o'     40-41   mtd/ubi-user.h		UBI
'o'     01-A1   linux/dvb/*.h		DVB
257
'p'	00-0F	linux/phantom.h		conflict! (OpenHaptics needs this)
258
'p'	00-1F	linux/rtc.h		conflict!
259
'p'	00-3F	linux/mc146818rtc.h	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
260
'p'	40-7F	linux/nvram.h
261
'p'	80-9F	linux/ppdev.h		user-space parport
Linus Torvalds's avatar
Linus Torvalds committed
262
					<mailto:tim@cyberelk.net>
263
'p'	A1-A5	linux/pps.h		LinuxPPS
264
					<mailto:giometti@linux.it>
Linus Torvalds's avatar
Linus Torvalds committed
265
'q'	00-1F	linux/serio.h
266
'q'	80-FF	linux/telephony.h	Internet PhoneJACK, Internet LineJACK
267
		linux/ixjuser.h		<http://web.archive.org/web/*/http://www.quicknet.net>
268
'r'	00-1F	linux/msdos_fs.h and fs/fat/dir.c
Linus Torvalds's avatar
Linus Torvalds committed
269
's'	all	linux/cdk.h
270
't'	00-7F	linux/ppp-ioctl.h
Linus Torvalds's avatar
Linus Torvalds committed
271
't'	80-8F	linux/isdn_ppp.h
272
't'	90-91	linux/toshiba.h		toshiba and toshiba_acpi SMM
273
'u'	00-1F	linux/smb_fs.h		gone
274
'u'	20-3F	linux/uvcvideo.h	USB video class host driver
275 276 277 278
'v'	00-1F	linux/ext2_fs.h		conflict!
'v'	00-1F	linux/fs.h		conflict!
'v'	00-0F	linux/sonypi.h		conflict!
'v'	C0-FF	linux/meye.h		conflict!
Linus Torvalds's avatar
Linus Torvalds committed
279 280 281
'w'	all				CERN SCI driver
'y'	00-1F				packet based user level communications
					<mailto:zapman@interlan.net>
282
'z'	00-3F				CAN bus card	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
283
					<mailto:hdstich@connectu.ulm.circular.de>
284
'z'	40-7F				CAN bus card	conflict!
Linus Torvalds's avatar
Linus Torvalds committed
285
					<mailto:oe@port.de>
286
'z'	10-4F	drivers/s390/crypto/zcrypt_api.h	conflict!
287
'|'	00-7F	linux/media.h
Linus Torvalds's avatar
Linus Torvalds committed
288
0x80	00-1F	linux/fb.h
289
0x89	00-06	arch/x86/include/asm/sockios.h
Linus Torvalds's avatar
Linus Torvalds committed
290 291
0x89	0B-DF	linux/sockios.h
0x89	E0-EF	linux/sockios.h		SIOCPROTOPRIVATE range
292
0x89	E0-EF	linux/dn.h		PROTOPRIVATE range
Linus Torvalds's avatar
Linus Torvalds committed
293 294 295
0x89	F0-FF	linux/sockios.h		SIOCDEVPRIVATE range
0x8B	all	linux/wireless.h
0x8C	00-3F				WiNRADiO driver
296
					<http://www.winradio.com.au/>
Linus Torvalds's avatar
Linus Torvalds committed
297
0x90	00	drivers/cdrom/sbpcd.h
298
0x92	00-0F	drivers/usb/mon/mon_bin.c
Linus Torvalds's avatar
Linus Torvalds committed
299
0x93	60-7F	linux/auto_fs.h
300
0x94	all	fs/btrfs/ioctl.h
301
0x97	00-7F	fs/ceph/ioctl.h		Ceph file system
Linus Torvalds's avatar
Linus Torvalds committed
302 303 304 305
0x99	00-0F				537-Addinboard driver
					<mailto:buk@buks.ipn.de>
0xA0	all	linux/sdp/sdp.h		Industrial Device Project
					<mailto:kenji@bitgate.com>
306
0xA2	00-0F	arch/tile/include/asm/hardwall.h
Linus Torvalds's avatar
Linus Torvalds committed
307 308 309
0xA3	80-8F	Port ACL		in development:
					<mailto:tlewis@mindspring.com>
0xA3	90-9F	linux/dtlk.h
Andrea Arcangeli's avatar
Andrea Arcangeli committed
310
0xAA	00-3F	linux/uapi/linux/userfaultfd.h
Linus Torvalds's avatar
Linus Torvalds committed
311 312 313
0xAB	00-1F	linux/nbd.h
0xAC	00-1F	linux/raw.h
0xAD	00	Netfilter device	in development:
314
					<mailto:rusty@rustcorp.com.au>
Avi Kivity's avatar
Avi Kivity committed
315
0xAE	all	linux/kvm.h		Kernel-based Virtual Machine
316
					<mailto:kvm@vger.kernel.org>
317
0xAF	00-1F	linux/fsl_hypervisor.h	Freescale hypervisor
Linus Torvalds's avatar
Linus Torvalds committed
318 319 320
0xB0	all	RATIO devices		in development:
					<mailto:vgo@ratio.de>
0xB1	00-1F	PPPoX			<mailto:mostrows@styx.uwaterloo.ca>
321
0xB3	00	linux/mmc/ioctl.h
322
0xB4	00-0F	linux/gpio.h		<mailto:linux-gpio@vger.kernel.org>
323
0xC0	00-0F	linux/usb/iowarrior.h
324
0xCA	00-0F	uapi/misc/cxl.h
325
0xCA	80-8F	uapi/scsi/cxlflash_ioctl.h
Linus Torvalds's avatar
Linus Torvalds committed
326 327
0xCB	00-1F	CBM serial IEC bus	in development:
					<mailto:michael.klein@puffin.lb.shuttle.de>
328 329 330
0xCD	01	linux/reiserfs_fs.h
0xCF	02	fs/cifs/ioctl.c
0xDB	00-0F	drivers/char/mwave/mwavepub.h
Linus Torvalds's avatar
Linus Torvalds committed
331 332
0xDD	00-3F	ZFCP device driver	see drivers/s390/scsi/
					<mailto:aherrman@de.ibm.com>
Miklos Szeredi's avatar
Miklos Szeredi committed
333
0xE5	00-3F	linux/fuse.h
334
0xEC	00-01	drivers/platform/chrome/cros_ec_dev.h	ChromeOS EC driver
335
0xF3	00-3F	drivers/usb/misc/sisusbvga/sisusb.h	sisfb (in development)
Linus Torvalds's avatar
Linus Torvalds committed
336
					<mailto:thomas@winischhofer.net>
337 338
0xF4	00-1F	video/mbxfb.h		mbxfb
					<mailto:raph@8d.com>
339 340
0xF6	all	LTTng			Linux Trace Toolkit Next Generation
					<mailto:mathieu.desnoyers@efficios.com>
341
0xFD	all	linux/dm-ioctl.h