linux驱动开发笔记_ioctl函数

1.相关概念

ioctl 是设备驱动程序中设备控制接口函数。某些设备除了打开、关闭、读出和写入功能外，可能还有其它的功能，比如说设置串口波特率、设置马达的转速等等。

1.用户空间函数

#include <sys/ioctl.h> 
int ioctl (int fd,  unsigned int cmd, ...)

参数	描述
fd	打开文件描述符
cmd	交互协议，设备驱动将根据cmd执行相应的操作
…	可变参数arg，依赖cmd中指定的长度以及类型

ioctl()函数执行成功之后则会返回0；失败的话就会返回 -1；

2.驱动程序函数

	long (*unlocked_ioctl) (struct file *, unsigned int, unsigned long);
	long (*compat_ioctl) (struct file *, unsigned int, unsigned long);

unlocked_ioctl，顾名思义，应该在无大内核锁（BKL）的情况下调用；
compat 全称 compatible（兼容的），主要目的是为 64 位系统提供 32 位 ioctl 的兼容方法，也是在无大内核锁的情况下调用。

其中第二个参数是 cmd 从用户空间无改变的传过来的，第三个参数是传过来的用户空间的可寻址地址；

3. ioctl中的cmd（交互协议）

交互协议，就是用户空间和驱动程序之间达成的一致性协议。需要完成什么功能都在这个协议中得到包含。cmd是一个32位的数据，其中不同的位置代表了不同的段。

在内核当中，有对于生成ioctl命令相关的宏，可以很方便直接生成cmd：

#define _IOC(dir,type,nr,size) \
    (((dir)  << _IOC_DIRSHIFT) | \
     ((type) << _IOC_TYPESHIFT) | \
     ((nr)   << _IOC_NRSHIFT) | \
     ((size) << _IOC_SIZESHIFT))

#define _IOC_NRSHIFT	0
#define _IOC_TYPESHIFT	(_IOC_NRSHIFT+_IOC_NRBITS)
#define _IOC_SIZESHIFT	(_IOC_TYPESHIFT+_IOC_TYPEBITS)
#define _IOC_DIRSHIFT	(_IOC_SIZESHIFT+_IOC_SIZEBITS)

#define _IOC_NRBITS	8
#define _IOC_TYPEBITS	8
# define _IOC_SIZEBITS	14

1.dir(direction), ioctl命令的访问模式。定义数据的传输方向。可以为 _IOC_NONE 、 _IOC_READ、 _IOC_WRITE、 _IOC_READ|_IOC_WRITE。分别代表了无数据、读数据、写数据、读写数据。读写是从用户空间来看的，写是往驱动写，读是往用户读。
2.type(device type),设备类型，有些地方叫做 幻数 。可以为任意的char类型的字符。比如说设置为 ’a‘ ， ‘b’ , ’ D’等等。主要作用是使 ioctl 命令有唯一的设备标识；
3. nr(number),命令编号/序数，占据 8 bit，可以为任意 unsigned char 型数据，取值范围 0~255，如果定义了多个 ioctl 命令，通常从 0 开始编号递增；
4. size涉及到 ioctl 函数 第三个参数 arg ，占据 13bit 或者 14bit（体系相关，arm 架构一般为 14 位），指定了 arg 的数据类型及长度，如果在驱动的 ioctl 实现中不检查，通常可以忽略该参数；

为了更加方便的使用，在上述宏定义的基础上又衍生出了更加方便的ioctl命令：

#define _IO(type,nr)        _IOC(_IOC_NONE,(type),(nr),0)
#define _IOR(type,nr,size)  _IOC(_IOC_READ,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOW(type,nr,size)  _IOC(_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))
#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),(_IOC_TYPECHECK(size)))

_IO： 定义不带参数的 ioctl 命令
_IOW： 定义带写参数的 ioctl 命令（copy_from_user）
_IOR： 定义带读参数的ioctl命令（copy_to_user）
_IOWR： 定义带读写参数的 ioctl 命令

在内核驱动代码中，还提供了分离出不同的段的宏定义接口，供内核的驱动代码使用。

#define _IOC_DIR(nr)        (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
#define _IOC_TYPE(nr)       (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
#define _IOC_NR(nr)         (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
#define _IOC_SIZE(nr)       (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)

比如：
if( _IOC_TYPE(cmd) != ‘c’) 判断是否设备种类正确
if( _IOC_NR(cmd) > 2) 判断命令的数值是不是大于2
if( _IOC_DIR(cmd) & _IOC_READ) 判断该命令是否为可读命令

4.ioctl例子分析

这个例子用ioctl来实现内核空间和用户空间的数据交互。

1.定义用户程序和驱动程序共同定义的协商文件ioctl_menu.h。

#ifndef __IOCTL_MENU_
#define __IOCTL_MENU_

#include <linux/ioctl.h>    // 内核空间

/*定义设备类型*/
#define IOC_MAGIC  'c'

/* 初始化设备*/
#define IOCINIT  _IO(IOC_MAGIC, 0)   

/* 写寄存器  */
#define IOCWREG  _IOW(IOC_MAGIC, 1, int)

/* 读寄存器 */
#define IOCRREG  _IOR(IOC_MAGIC, 2, int)

#define IOC_MAXNR  2

#endif

该文件中定义了三个操作方式： 初始化、读出数据、写入数据。

2.设备驱动程序代码

#