什么是IOCTL
IOCTL是设备驱动程序中对设备的I/O通道进行管理的函数。所谓的I/O通道管理即设备参数读写、设备状态读、以及控制设备。
例如:控制串口传输的波特率、马达的转速等等。
功能:控制I/O设备 ,提供了一种获得设备信息和向设备发送控制参数的手段。用于向设备发控制和配置命令 ,有些命令需要控制参数,这些数据是不能用read / write 读写的,称为Out-of-band数据。也就是说,read / write 读写的数据是in-band数据,是I/O操作的主体,而ioctl 命令传送的是控制信息,其中的数据是辅助的数据。
IOCTL参数命令
long (*unlocked_ioctl)(struct file *filp, unsigned int cmd, unsigned long arg)
struct file *filp
由fd得到的file结构体
unsigned int cmd
命令码,设备驱动定义的,区分具体工作的编号
unsigned long arg
输入/出参数(可能是值,也可能是地址;如果要输出,必须是地址)
命令码的格式(即cmd的格式)
|type|nr|dir|size|
设备类型 | 序列号 | 方向 | 数据尺寸 |
---|---|---|---|
8bit | 8bit | 2bit | 13/14bit |
type:类型
nr:命令编号
dir:方向,读/写
size:参数大小
如何得到上面的命令码呢?
内核定义了 _IO() _OR() _IOW() _IOWR()几个宏命令来帮助生成命令,这几个宏如下:
函数定义在:/linux/asm/ioctl.h
_IO(type,nr) 定制控制命令码
_IOR(type,nr,size ) 定制读参数命令
_IOW(type,nr,size ) 定制写参数命令
_IOWR(type,nr,size ) 定制读写参数命令
还可以通过命令来提取相对应的参数
IOC_DIR(cmd) 提取读写方向
IOC_TYPE(cmd) 提取类型
IOC_NR(cmd) 提取命令码编号
IOC_SIZE(cmd) 提取读写参数的大小
工程实例
头文件
#ifndef MYCMD_H
#define MYCMD_H
#include <asm/ioctl.h>
#define CMDT 'A'
#define KARGL 36
struct karg{
int kval;
char kbuf[KARGL];
};
#define CMDOFF _IO(CMDT,0)
#define CMDON _IO(CMDT,1)
#define CMDR _IOR(CMDT,2,struct karg)
#define CMDW _IOW(CMDT,3,struct karg)
#endif
内核模块代码
#include <linux/init.h>
#include <linux/module.h>
#include <linux/kernel.h>
#include <linux/cdev.h>
#include <linux/fs.h>
#include <linux/errno.h>
#include <asm/current.h>
#include <linux/sched.h>
#include <linux/uaccess.h>
#include <linux/device.h>
static struct class *cls = NULL;
#include "mycmd.h"
static int major = 0;
static int minor = 0;
const int count = 6;
#define DEVNAME "demo"
static struct cdev *demop = NULL;
#define KMAX 1024
static int counter = 0;
static char kbuf[KMAX];
//打开设备
static int demo_open(struct inode *inode, struct file *filp)
{
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
//get major and minor from inode
printk(KERN_INFO "(major=%d, minor=%d), %s : %s : %d\n",
imajor(inode), iminor(inode), __FILE__, __func__, __LINE__);
memset(kbuf, 0, KMAX);
counter = 0;
return 0;
}
//关闭设备
static int demo_release(struct inode *inode, struct file *filp)
{
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
//get major and minor from inode
printk(KERN_INFO "(major=%d, minor=%d), %s : %s : %d\n",
imajor(inode), iminor(inode), __FILE__, __func__, __LINE__);
return 0;
}
//读设备
//ssize_t read(int fd, void *buf, size_t count)
static ssize_t demo_read(struct file *filp, char __user *buf, size_t size, loff_t *offset)
{
struct inode *inode = filp->f_path.dentry->d_inode;
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
//get major and minor from inode
printk(KERN_INFO "(major=%d, minor=%d), %s : %s : %d\n",
imajor(inode), iminor(inode), __FILE__, __func__, __LINE__);
if(counter < size){
size = counter;
}
if(copy_to_user(buf, kbuf, size)){
return -EAGAIN;
}
counter = 0;
return size;
}
//写设备
static ssize_t demo_write(struct file *filp, const char __user *buf, size_t size, loff_t *offset)
{
struct inode *inode = filp->f_path.dentry->d_inode;
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
//get major and minor from inode
printk(KERN_INFO "(major=%d, minor=%d), %s : %s : %d\n",
imajor(inode), iminor(inode), __FILE__, __func__, __LINE__);
if(size > KMAX){
return -ENOMEM;
}
if(copy_from_user(kbuf, buf, size)){
return -EAGAIN;
}
counter = size;
return counter;
}
/*
* read/write param
* read status
* contrl device
*/
static long demo_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
{
static struct karg karg = {
.kval = 0,
.kbuf = {0},
};
struct karg *usrarg;
switch(cmd){
case CMDON:
printk(KERN_INFO "CMDON: %s : %s : %d\n", __FILE__, __func__, __LINE__);
break;
case CMDOFF:
printk(KERN_INFO "CMDOFF: %s : %s : %d\n", __FILE__, __func__, __LINE__);
break;
case CMDR:
printk(KERN_INFO "CMDR: %s : %s : %d\n", __FILE__, __func__, __LINE__);
if(_IOC_SIZE(cmd) != sizeof(karg)){
return -EINVAL;
}
usrarg = (struct karg *)arg;
if(copy_to_user(usrarg, &karg, sizeof(karg))){
return -EAGAIN;
}
printk(KERN_INFO "CMDR: %s : %s : %d ---done.\n", __FILE__, __func__, __LINE__);
break;
case CMDW:
printk(KERN_INFO "CMDW: %s : %s : %d\n", __FILE__, __func__, __LINE__);
if(_IOC_SIZE(cmd) != sizeof(karg)){
return -EINVAL;
}
usrarg = (struct karg *)arg;
if(copy_from_user(&karg, usrarg, sizeof(karg))){
return -EAGAIN;
}
printk(KERN_INFO "CMDW: %d : %s\n", karg.kval, karg.kbuf);
break;
default:
;
};
return 0;
}
static struct file_operations fops = {
.owner = THIS_MODULE,
.open = demo_open,
.release= demo_release,
.read = demo_read,
.write = demo_write,
.unlocked_ioctl = demo_ioctl,
};
static int __init demo_init(void)
{
dev_t devnum;
int ret, i;
struct device *devp = NULL;
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
//1. alloc cdev obj
demop = cdev_alloc();
if(NULL == demop){
return -ENOMEM;
}
//2. init cdev obj
cdev_init(demop, &fops);
ret = alloc_chrdev_region(&devnum, minor, count, DEVNAME);
if(ret){
goto ERR_STEP;
}
major = MAJOR(devnum);
//3. register cdev obj
ret = cdev_add(demop, devnum, count);
if(ret){
goto ERR_STEP1;
}
cls = class_create(THIS_MODULE, DEVNAME);
if(IS_ERR(cls)){
ret = PTR_ERR(cls);
goto ERR_STEP1;
}
for(i = minor; i < (count+minor); i++){
devp = device_create(cls, NULL, MKDEV(major, i), NULL, "%s%d", DEVNAME, i);
if(IS_ERR(devp)){
ret = PTR_ERR(devp);
goto ERR_STEP2;
}
}
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d - ok.\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
return 0;
ERR_STEP2:
for(--i; i >= minor; i--){
device_destroy(cls, MKDEV(major, i));
}
class_destroy(cls);
ERR_STEP1:
unregister_chrdev_region(devnum, count);
ERR_STEP:
cdev_del(demop);
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d - fail.\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
return ret;
}
static void __exit demo_exit(void)
{
int i;
//get command and pid
printk(KERN_INFO "(%s:pid=%d), %s : %s : %d - leave.\n",
current->comm, current->pid, __FILE__, __func__, __LINE__);
for(i=minor; i < (count+minor); i++){
device_destroy(cls, MKDEV(major, i));
}
class_destroy(cls);
unregister_chrdev_region(MKDEV(major, minor), count);
cdev_del(demop);
}
module_init(demo_init);
module_exit(demo_exit);
MODULE_LICENSE("GPL");
MODULE_AUTHOR("Farsight");
MODULE_DESCRIPTION("Demo for kernel module");
用户层代码
#include <stdio.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include "mycmd.h"
int main(int num, char *argv[])
{
if(2 != num){
printf("Usage: %s /dev/devfile\n", argv[0]);
return -1;
}
int fd = open(argv[1], O_RDWR);
if(0 > fd){
perror("open");
return -1;
}
struct karg arg = {
.kval = 12345678,
.kbuf = "hello world",
};
if(0 > ioctl(fd, CMDON)){
perror("ioctl-CMDON");
return -1;
}
if(0 > ioctl(fd, CMDOFF)){
perror("ioctl-CMDOFF");
return -1;
}
if(0 > ioctl(fd, CMDW, (unsigned long)&arg)){
perror("ioctl-CMDW");
return -1;
}
struct karg rarg;
if(0 > ioctl(fd, CMDR, (unsigned long)&rarg)){
perror("ioctl-CMDR");
return -1;
}
printf("rd: %d, %s\n", rarg.kval, rarg.kbuf);
close(fd);
return 0;
}