3. IOCTL 命令定义规范

在 VxWorks 字符设备驱动中，IOCTL 命令是一个 32 位的无符号整数，其内部被划分为多个位域，分别编码命令的方向、类型、序号和大小。遵循统一的命令码结构，可以避免设备驱动之间的命令冲突，并让内核能够自动校验用户空间与内核空间之间的数据拷贝方向与缓冲区长度。

3.1 命令码组成结构

VxWorks 沿用了 Linux 内核的 IOCTL 命令码编码方式，将 32 位划分为 4 个位域，从高位到低位依次为：

3.2 方向位（DIR）

方向位占用 bit 31 和 bit 30，表示 IOCTL 调用过程中用户空间与内核空间之间的数据流动方向。VxWorks 定义了 4 种方向常量：

3.3 类型位（TYPE）

类型位占用 bit 29 – 24，共 6 位，用于标识命令所属的设备驱动类型。通常使用一个 ASCII 字符（如 'M'、'S'、'U'）作为幻数，确保不同驱动之间的命令码不会重叠。

• 唯一性：每个设备驱动应在项目范围内选择一个唯一的 TYPE 幻数，并在头文件中通过 #define 声明。
• 取值范围：0 – 63（6 位），常用 0x00 – 0xFF 中的 ASCII 可打印字符，便于调试时识别。
• 示例：

/* 设备类型幻数定义 */
#define MY_DEV_TYPE  'M'   /* 0x4D */
#define SENSOR_TYPE  'S'   /* 0x53 */
#define UART_TYPE    'U'   /* 0x55 */

3.4 序号位（NR）

序号位占用 bit 23 – 16，共 8 位，用于在同一 TYPE 下区分不同的 IOCTL 命令。每个设备驱动可以定义最多 256 个命令（0 – 255）。

• 顺序递增：建议从 0 开始顺序定义，便于维护和代码审查。
• 保留值：0 通常保留为无效命令或测试命令。
• 示例：

/* 同一设备类型下的命令序号 */
#define MY_DEV_GET_STATUS  _IOR(MY_DEV_TYPE, 1, struct dev_status)
#define MY_DEV_SET_CONFIG  _IOW(MY_DEV_TYPE, 2, struct dev_config)
#define MY_DEV_RESET       _IO(MY_DEV_TYPE, 3)
#define MY_DEV_RW_REG      _IOWR(MY_DEV_TYPE, 4, struct reg_access)

3.5 大小位（SIZE）

大小位占用 bit 15 – 0，共 16 位，表示与 IOCTL 命令关联的用户数据缓冲区的大小（以字节为单位）。

• 自动校验：VxWorks 内核在 ioctl() 入口处会检查用户传入的 arg 参数大小是否与 SIZE 字段匹配，若不匹配则返回 EINVAL。
• 无数据命令：对于 _IO() 构造的命令，SIZE 固定为 0。
• 结构体大小：对于 _IOR()、_IOW()、_IOWR()，SIZE 应设置为对应结构体的 sizeof 值。

/* 示例：定义带数据缓冲区的命令 */
struct my_dev_config {
    int  baud_rate;
    int  data_bits;
    int  stop_bits;
};

/* SIZE 自动设置为 sizeof(struct my_dev_config) */
#define MY_DEV_SET_BAUD  _IOW(MY_DEV_TYPE, 5, struct my_dev_config)

3.6 命令码构造与分解宏

VxWorks 在 ioLib.h 中提供了一套完整的宏，用于构造和分解 IOCTL 命令码：

/* 完整示例：构造与分解 */
#include <ioLib.h>

#define MY_DEV_TYPE  'M'

/* 构造命令 */
#define CMD_GET_STATUS  _IOR(MY_DEV_TYPE, 1, struct dev_status)
#define CMD_SET_CONFIG  _IOW(MY_DEV_TYPE, 2, struct dev_config)

/* 在驱动中分解命令 */
STATUS myDevIoctl
    (
    MY_DEV *pDev,
    int     cmd,
    void   *arg
    )
    {
    int dir  = _IOC_DIR(cmd);
    int type = _IOC_TYPE(cmd);
    int nr   = _IOC_NR(cmd);
    int size = _IOC_SIZE(cmd);

    /* 校验类型 */
    if (type != MY_DEV_TYPE)
        return ERROR;

    switch (nr)
        {
        case 1:  /* CMD_GET_STATUS */
            if (dir != _IOC_READ)
                return ERROR;
            /* ... */
            break;
        case 2:  /* CMD_SET_CONFIG */
            if (dir != _IOC_WRITE)
                return ERROR;
            /* ... */
            break;
        default:
            return ERROR;
        }
    return OK;
    }