歡迎來到Linux教程網
Linux教程網
Linux教程網
Linux教程網
您现在的位置: Linux教程網 >> UnixLinux >  >> Linux基礎 >> Linux技術

Linux 字符設備驅動開發基礎(四)—— ioctl() 函數解析

解析完 open、close、read、write 四個函數後,終於到我們的 ioctl() 函數了
一、 什麼是ioctl
ioctl是設備驅動程序中對設備的I/O通道進行管理的函數。所謂對I/O通道進行管理,就是對設備的一些特性進行控制,例如串口的傳輸波特率、馬達的轉速等等。下面是其源代碼定義:
函數名: ioctl
功 能: 控制I/O設備
用 法: int ioctl(int handle, int cmd,[int *argdx, int argcx]);
參數:fd是用戶程序打開設備時使用open函數返回的文件標示符,cmd是用戶程序對設備的控制命令,後面是一些補充參數,一般最多一個,這個參數的有無和cmd的意義相關。
include/asm/ioctl.h中定義的宏的注釋:
[cpp] view
plain copy





#define _IOC_NRBITS 8 //序數(number)字段的字位寬度,8bits
#define _IOC_TYPEBITS 8 //幻數(type)字段的字位寬度,8bits
#define _IOC_SIZEBITS 14 //大小(size)字段的字位寬度,14bits
#define _IOC_DIRBITS 2 //方向(direction)字段的字位寬度,2bits
#define _IOC_NRMASK ((1 << _IOC_NRBITS)-1) //序數字段的掩碼,0x000000FF
#define _IOC_TYPEMASK ((1 << _IOC_TYPEBITS)-1) //幻數字段的掩碼,0x000000FF
#define _IOC_SIZEMASK ((1 << _IOC_SIZEBITS)-1) //大小字段的掩碼,0x00003FFF
#define _IOC_DIRMASK ((1 << _IOC_DIRBITS)-1) //方向字段的掩碼,0x00000003
#define _IOC_NRSHIFT 0 //序數字段在整個字段中的位移,0
#define _IOC_TYPESHIFT (_IOC_NRSHIFT+_IOC_NRBITS) //幻數字段的位移,8
#define _IOC_SIZESHIFT (_IOC_TYPESHIFT+_IOC_TYPEBITS) //大小字段的位移,16
#define _IOC_DIRSHIFT (_IOC_SIZESHIFT+_IOC_SIZEBITS) //方向字段的位移,30
#define _IOC_NONE 0U //沒有數據傳輸
#define _IOC_WRITE 1U //向設備寫入數據,驅動程序必須從用戶空間讀入數據
#define _IOC_READ 2U //從設備中讀取數據,驅動程序必須向用戶空間寫入數據
#define _IOC(dir,type,nr,size) \
(((dir) << _IOC_DIRSHIFT) | \
((type) << _IOC_TYPESHIFT) | \
((nr) << _IOC_NRSHIFT) | \
((size) << _IOC_SIZESHIFT))
//構造無參數的命令編號
#define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0)
//構造從驅動程序中讀取數據的命令編號
#define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),sizeof(size))
//用於向驅動程序寫入數據命令
#define _IOW(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
//用於雙向傳輸
#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
//從命令參數中解析出數據方向,即寫進還是讀出
#define _IOC_DIR(nr) (((nr) >> _IOC_DIRSHIFT) & _IOC_DIRMASK)
//從命令參數中解析出幻數type
#define _IOC_TYPE(nr) (((nr) >> _IOC_TYPESHIFT) & _IOC_TYPEMASK)
//從命令參數中解析出序數number
#define _IOC_NR(nr) (((nr) >> _IOC_NRSHIFT) & _IOC_NRMASK)
//從命令參數中解析出用戶數據大小
#define _IOC_SIZE(nr) (((nr) >> _IOC_SIZESHIFT) & _IOC_SIZEMASK)
#define IOC_IN (_IOC_WRITE << _IOC_DIRSHIFT)
#define IOC_OUT (_IOC_READ << _IOC_DIRSHIFT)
#define IOC_INOUT ((_IOC_WRITE|_IOC_READ) << _IOC_DIRSHIFT)
#define IOCSIZE_MASK (_IOC_SIZEMASK << _IOC_SIZESHIFT)
#define IOCSIZE_SHIFT (_IOC_SIZESHIFT)
二、ioctl的必要性
如果不用ioctl的話,也可以實現對設備I/O通道的控制。例如,我們可以在驅動程序中實現write的時候檢查一下是否有特殊約定的數據流通過,如果有的話,那麼後面就跟著控制命令(一般在socket編程中常常這樣做)。但是如果這樣做的話,會導致代碼分工不明,程序結構混亂,程序員自己也會頭昏眼花的。所以,我們就使用ioctl來實現控制的功能。要記住,用戶程序所作的只是通過命令碼(cmd)告訴驅動程序它想做什麼,至於怎麼解釋這些命令和怎麼實現這些命令,這都是驅動程序要做的事情
三、 ioctl如何實現
在驅動程序中實現的ioctl函數體內,實際上是有一個switch{case}結構,每一個case對應一個命令碼,做出一些相應的操作。怎麼實現這些操作,這是每一個程序員自己的事情。因為設備都是特定的,這裡也沒法說。關鍵在於怎樣組織命令碼,因為在ioctl中命令碼是唯一聯系用戶程序命令和驅動程序支持的途徑。
命令碼的組織是有一些講究的,因為我們一定要做到命令和設備是一一對應的,這樣才不會將正確的命令發給錯誤的設備,或者是把錯誤的命令發給正確的設備,或者是把錯誤的命令發給錯誤的設備。這些錯誤都會導致不可預料的事情發生,而當程序員發現了這些奇怪的事情的時候,再來調試程序查找錯誤,那將是非常困難的事情。所以在Linux核心中是這樣定義一個命令碼的:
| 設備類型 | 序列號 | 方向 |數據尺寸|
|-------------|----------|-------|------------|
| 8 bit | 8 bit | 2 bit | 8~14 bit |
|-------------|----------|-------|-------------|
這樣一來,一個命令就變成了一個整數形式的命令碼;但是命令碼非常的不直觀,所以Linux Kernel中提供了一些宏。這些宏可根據便於理解的字符串生成命令碼,或者是從命令碼得到一些用戶可以理解的字符串以標明這個命令對應的設備類型、設備序列號、數據傳送方向和數據傳輸尺寸。
比如上面展現的:
[cpp] view
plain copy





//構造無參數的命令編號
#define _IO(type,nr) _IOC(_IOC_NONE,(type),(nr),0)
//構造從驅動程序中讀取數據的命令編號
#define _IOR(type,nr,size) _IOC(_IOC_READ,(type),(nr),sizeof(size))
//用於向驅動程序寫入數據命令
#define _IOW(type,nr,size) _IOC(_IOC_WRITE,(type),(nr),sizeof(size))
//用於雙向傳輸
#define _IOWR(type,nr,size) _IOC(_IOC_READ|_IOC_WRITE,(type),(nr),sizeof(size))
我們在前面PWM驅動程序中也定義了命令宏:
[cpp] view
plain copy





#define MAGIC_NUMBER 'k'
#define BEEP_ON _IO(MAGIC_NUMBER ,0)
#define BEEP_OFF _IO(MAGIC_NUMBER ,1)
#define BEEP_FREQ _IO(MAGIC_NUMBER ,2)
這裡必須要提一下的,就是"幻數"MAGIC_NUMBER, "幻數"是一個字母,數據長度也是8,用一個特定的字母來標明設備類型,這和用一個數字是一樣的,只是更加利於記憶和理解。
四、 cmd參數如何得出
這裡確實要說一說,cmd參數在用戶程序端由一些宏根據設備類型、序列號、傳送方向、數據尺寸等生成,這個整數通過系統調用傳遞到內核中的驅動程序,再由驅動程序使用解碼宏從這個整數中得到設備的類型、序列號、傳送方向、數據尺寸等信息,然後通過switch{case}結構進行相應的操作。
實例時刻,當然只是部分代碼:
[cpp] view
plain copy





#define MAGIC_NUMBER 'k'
#define BEEP_ON _IO(MAGIC_NUMBER ,0)
#define BEEP_OFF _IO(MAGIC_NUMBER ,1)
#define BEEP_FREQ _IO(MAGIC_NUMBER ,2)
#define BEPP_IN_FREQ 100000
static void beep_freq(unsigned long arg)
{
writel(BEPP_IN_FREQ/arg, timer_base +TCNTB0 );
writel(BEPP_IN_FREQ/(2*arg), timer_base +TCMPB0 );
}
static long beep_ioctl(struct file *filep, unsigned int cmd, unsigned long arg)
{
switch(cmd)
{
case BEEP_ON:
fs4412_beep_on();
break;
case BEEP_OFF:
fs4412_beep_off();
break;
case BEEP_FREQ:
beep_freq( arg );
break;
default :
return -EINVAL;
}
}
測試代碼如下:
[cpp] view
plain copy





#include <sys/types.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <stdio.h>
#include <sys/ioctl.h>
#define MAGIC_NUMBER 'k'
#define BEEP_ON _IO(MAGIC_NUMBER ,0)
#define BEEP_OFF _IO(MAGIC_NUMBER ,1)
#define BEEP_FREQ _IO(MAGIC_NUMBER ,2)
main()
{
int fd;
fd = open("/dev/beep",O_RDWR);
if(fd<0)
{
perror("open fail \n");
return ;
}
ioctl(fd,BEEP_ON);
sleep(6);
ioctl(fd,BEEP_OFF);
close(fd);
}
Copyright © Linux教程網 All Rights Reserved