规范化文档并消除语法错误.

Signed-off-by: ithink.chan <chenyang@autoai.com>

Software/Development/OperatingSystem/Linux/Kernel/API/Linux_内核中_IOC,_IO,_IOR,_IOW,_IOWR宏的用法与解析.md

@@ -1,9 +1,11 @@
-# Linux 内核中 _IOC, _IO, _IOR, _IOW, _IOWR 宏的用法与解析
+# Linux 内核中 \_IOC, \_IO, \_IOR, \_IOW, \_IOWR 宏的用法与解析
 
-_IOC, _IO, _IOR, _IOW, _IOWR 是用内核驱动定义 IOCTL 码值的宏。其中 _IOC 是基础，其他宏依赖于 _IOC 进行构建。
+\_IOC, \_IO, \_IOR, \_IOW, \_IOWR 是用内核驱动定义 IOCTL 码值的宏。其中 \_IOC 是基础，其他宏依赖于 \_IOC 进行构建。
 
 ## _IOC
 
+**函数原型：**
+
 ```cpp
 #define _IOC(dir,type,nr,size) \
                    (((dir)  << _IOC_DIRSHIFT) | \
@@ -12,9 +14,24 @@ _IOC, _IO, _IOR, _IOW, _IOWR 是用内核驱动定义 IOCTL 码值的宏。其
                    ((size) << _IOC_SIZESHIFT))
 ```
 
-### dir
+**说明：**
 
-代表方向。可以为以下值：
+定义 IOCTL 命令。IOCTL 函数中可用下面宏对命令进行判断：
+
+```cpp
+// 获取 cmd 命令的读写状态
+_IOC_DIR(cmd)
+// 获取 cmd 命令的魔术
+_IOC_TYPE(cmd)
+// 获取 cmd 命令基数
+_IOC_NR(cmd)
+// 通过 cmd 命令获取传送长度
+_IOC_SIZE(cmd)
+```
+
+**参数：**
+
+dir：传输方向。可以为以下值：
 
 ```cpp
 #define _IOC_NONE   1U
@@ -22,70 +39,98 @@ _IOC, _IO, _IOR, _IOW, _IOWR 是用内核驱动定义 IOCTL 码值的宏。其
 #define _IOC_WRITE  4U
 ```
 
-下面宏用于判断传送到设备驱动程序的 cmd 命令的读写状态：
+type：也就是魔数 (magic number)，范围为 0~255 。通常，用英文字符 "A" ~ "Z" 或者 "a" ~ "z" 来表示。设备驱动程序从传递进来的命令获取魔数，然后与自身处理的魔数想比较，如果相同则处理，不同则不处理。魔数是拒绝误使用的初步辅助状态。不同的设备驱动程序最好设置不同的魔数，但并不是要求绝对，也是可以使用其他设备驱动程序已用过的魔数。
 
-```cpp
-_IOC_DIR(cmd)
-```
+nr：就是基数，用于区别各种命令。通常，从 0开始递增，相同设备驱动程序上可以重复使用该值。例如，读取和写入命令中使用了相同的基数，设备驱动程序也能分辨出来，原因在于设备驱动程序区分命令时 使用 switch ，且直接使用命令变量 cmd值。创建命令的宏生成的值由多个域组合而成，所以即使是相同的基数，也会判断为不同的命令。
 
-### type
+size：要传输数据的长度。
 
-也就是魔数 (magic number)，范围为 0~255 。通常，用英文字符 "A" ~ "Z" 或者 "a" ~ "z" 来表示。设备驱动程序从传递进来的命令获取魔数，然后与自身处理的魔数想比较，如果相同则处理，不同则不处理。魔数是拒绝误使用的初步辅助状态。设备驱动 程序可以通过：
+**返回值：**
 
-```cpp
-_IOC_TYPE(cmd)
-```
-
-来获取魔数。不同的设备驱动程序最好设置不同的魔数，但并不是要求绝对，也是可以使用其他设备驱动程序已用过的魔数。
-
-### nr
-
-就是基数，用于区别各种命令。通常，从 0开始递增，相同设备驱动程序上可以重复使用该值。例如，读取和写入命令中使用了相同的基数，设备驱动程序也能分辨出来，原因在于设备驱动程序区分命令时 使用 switch ，且直接使用命令变量 cmd值。创建命令的宏生成的值由多个域组合而成，所以即使是相同的基数，也会判断为不同的命令。设备驱动程序想要从命令中获取该基数，就使用下面的宏：
-
-```cpp
-_IOC_NR(cmd)
-```
-
-### size
-
-实际上是变量型，如 int、unsigned long 等。
-
-变量型使用 arg 变量指定传送的数据大小，但是不直接代入输入，而是代入变量或者是变量的类型，原因是在使用宏创建命令，已经包含了 sizeof() 编译命令。
-
-设备驱动程序想要从传送的命令获取相应的值，就要使用下列宏函数：
-
-```cpp
-_IOC_SIZE(cmd)
-```
+IOCTL cmd 命令。
 
 ## _IO
 
-该宏函数没有可传送的变量，只是用于传送命令，原型如下：
+**函数原型：**
 
 ```cpp
 #define _IO(type,nr)            _IOC(_IOC_NONE,(type),(nr),0)
 ```
 
+**说明：**
+
+该命令没有可传送的变量，只是用于传送命令。
+
+**参数：**
+
+同上。
+
+**返回值：**
+
+IOCTL cmd 命令。
+
 ## _IOR
 
-用于创建只读命令，原型如下：
+**函数原型：**
 
 ```cpp
 #define _IOR(type,nr,size)      _IOC(_IOC_READ,(type),(nr),sizeof(size))
 ```
 
+**说明：**
+
+用于创建只读命令。
+
+**参数：**
+
+size：要传输数据的类型，如 int、unsigned long 等。。
+
+其他，同上。
+
+**返回值：**
+
+IOCTL cmd 命令。
+
 ## _IOW
 
-用于创建只写命令，原型如下：
+**函数原型：**
 
 ```cpp
 #define _IOW(type,nr,size)      _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
 ```
 
+**说明：**
+
+用于创建只写命令。
+
+**参数：**
+
+size：要传输数据的类型，如 int、unsigned long 等。。
+
+其他，同上。
+
+**返回值：**
+
+IOCTL cmd 命令。
+
 ## _IOWR
 
-用于创建读写命令，原型如下：
+**函数原型：**
 
 ```cpp
 #define _IOWR(type,nr,size)     _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
 ```
+
+**说明：**
+
+用于创建读写命令。
+
+**参数：**
+
+size：要传输数据的类型，如 int、unsigned long 等。。
+
+其他，同上。
+
+**返回值：**
+
+IOCTL cmd 命令。