Skip to contentSkip to conversation

Document how to decode an IOCTL number

PATCH In review Chuck Ebbert 2 participants 2 messages Dec 8, 2006 Documentation

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Document how to decode an IOCTL number

Document how to decode a binary IOCTL number.

---
 Documentation/ioctl/ioctl-decoding.txt |   24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)
Documentation/ioctl/ioctl-decoding.txt new file +24 -0
@@ -0,0 +1,24 @@
+To decode a hex IOCTL code:
+
+Most architecures use this generic format, but check
+include/ARCH/ioctl.h for specifics, e.g. powerpc
+uses 3 bits to encode read/write and 13 bits for size.
+
+ bits    meaning
+ 31-30	00 - no parameters: uses _IO macro
+	10 - read: _IOR
+	01 - write: _IOW
+	11 - read/write: _IOWR
+
+ 29-16	size of arguments
+
+ 15-8	ascii character supposedly
+	unique to each driver
+
+ 7-0	function #
+
+
+ So for example 0x82187201 is a read with arg length of 0x218,
+character 'r' function 1. Grepping the source reveals this is:
+
+#define VFAT_IOCTL_READDIR_BOTH         _IOR('r', 1, struct dirent [2])
Signature · 2 lines
Chuck
"Even supernovas have their duller moments."
#1 lore raw
Quoted 6 lines · On Thu, 7 Dec 2006 23:02:04 -0500 Chuck Ebbert wrote:

Document how to decode a binary IOCTL number.

---
 Documentation/ioctl/ioctl-decoding.txt |   24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

Thanks... could this be added to Documentation/ioctl-number.txt instead? and maybe move that file into Documentation/ioctl/ ?

Quoted 18 lines
Documentation/ioctl/ioctl-decoding.txt new file +14 -0
@@ -0,0 +1,24 @@
+To decode a hex IOCTL code:
+
+Most architecures use this generic format, but check
+include/ARCH/ioctl.h for specifics, e.g. powerpc
+uses 3 bits to encode read/write and 13 bits for size.
+
+ bits    meaning
+ 31-30	00 - no parameters: uses _IO macro
+	10 - read: _IOR
+	01 - write: _IOW
+	11 - read/write: _IOWR
+
+ 29-16	size of arguments
+

Documentation/ioctl/ioctl-decoding.txt line 24

Quoted 10 lines
Documentation/ioctl/ioctl-decoding.txt new file +10 -0
+ 15-8	ascii character supposedly
+	unique to each driver
+
+ 7-0	function #
+
+
+ So for example 0x82187201 is a read with arg length of 0x218,
+character 'r' function 1. Grepping the source reveals this is:
+
+#define VFAT_IOCTL_READDIR_BOTH         _IOR('r', 1, struct dirent [2])

---
~Randy