ioctl設備控制及例子

ioctl功能-----大部分驅動程序除了需要具備讀寫設備的能力外，還需要具備對硬件的控制能力。例如，要求設備報告錯誤信息，改變波特率，這些操作常常通過ioctl方法來實現。

用戶使用方法-----

在用戶空間，使用ioctl系統調用來控制設備，原型如下：

int ioctl(int fd,unsigned long cmd,......)

原型中的點表示這是一個可選的參數，存在與否依賴於控制命令是否涉及到與設備的數據交互。

驅動ioctl方法----

驅動方法有和用戶空間版本不同的原型。

int (*ioctl) (struct inode *,struct file *filp,unsigned int cmd,unsigned long arg)

cmd參數從用戶空間傳下來，可選的參數arg以一個unsigned long形式傳遞，不管它是一個整數或一個指針。如果cmd命令不涉及數據傳輸，則第三個參數arg的值無任何意義。

ioctl實現--------

1---定義命令

在編寫ioctl代碼前，首先需要定義命令。爲了防止對錯誤的設備使用正確的命令，命令號應該是在系統範圍內是唯一的。ioctl命令編碼被劃分爲幾個位段，include/asm/ioctl.h中定義了這些位字段：類型，序號，傳送方向，參數的大小。

Documentation/ioctl-number.txt文件中羅列了在內核中已經使用了的類型。

Type---（幻數）類型，表明哪個設備的命令，在參考了ioctl-number.txt之後選出，8位寬。

Number----序號，表明設備命令中的第幾個，8位寬。

Direction---數據傳送的方向，可能的值是_IOC_NONE(沒有數據傳輸)，_IOC_READ,_IOC_WRITE.。數據傳送方向是從應用程序的觀點來看待的，讀意思是從設備讀。

Size---用戶數據的大小。

內核提供了下列宏來幫助定義命令----

_IO(type，nr)--------沒有參數傳遞

_IOR(type,nr,datatype)------從驅動中讀數據

_IOW(type,nr,datatype)------寫數據到驅動

_IOWR(type,nr,datatype)------雙向傳送，type和number成員作爲參數被傳遞。

定義命令範烈-----

#define MEM_IOC_MAGIC 'm'-------定義類型

#define MEM_IOCSET _IOW(MEM_IOC_MAGIC,0，int)

#define MEM_IOCGQSET _IOR(MEM_IOC_MAGIC,1,int)

2---實現命令

1--返回值

ioctl函數的實現通常是根據命令執行的一個switch語句。但是，當命令號不能匹配任何一個設備所支持的命令時，通常返回-EINVAL（”非法參數“）

2--參數使用

如果是一個整數，可以直接使用。如果是指針，我們必須確保這個用戶地址是有效的，因此使用前需進行正確的檢查。

不需要檢測--

copy_from_user

copy_to_user

get_user

put_user

需要檢測----

__get_user

__put_user

使用以下函數實現參數檢查--

int access_ok(

int type,VERIFY_READ/VERIFY_WRITE用來表明是讀用戶內存還是寫用戶內存。

const void *addr,參數要操作的用戶內存地址。

unsigned long size--是操作的長度，如果ioctl需要從用戶空間讀一個整數，哪個size參數等於sizeof(int)

access_ok返回一個布爾值：1是成功（存取沒有問題）0是失敗，如果函數返回失敗，則ioctl應當返回-EFAULT。

)

參數檢查實例----

if(_IOC_DIR(cmd)&_IOC_READ)

err=!access_ok(VERIFY_WRITE,(void__user *)arg,_IOC_SIZE(cmd));

else if(_IOC_DIR(cmd)&_IOC_WRITE)

err=!access_ok(VERIFY_READ,(void__user *)arg,_IOC_SIZE(cmd));

if(err)

return -EFAULT;

從設備中讀，就需要把數據寫到用戶空間，故對應VERIFY_WRITE

3--命令操作

switch(cmd)

{

case MEM_IOCSQUANTUM:

retval=__get_user(scull_quantum,(int *)arg);

break;

case MEM_IOCGQUANTUM:

retval=__put_user(scull_quantum,(int *)arg);

break;

default:

return -EINVAL;

}

例子

memdev.h

#ifndef _MEMDEV_H_
#define _MEMDEV_H_

#include <linux/ioctl.h>

#ifndef MEMDEV_MAJOR
#define MEMDEV_MAJOR 0   /*預設的mem的主設備號*/
#endif

#ifndef MEMDEV_NR_DEVS
#define MEMDEV_NR_DEVS 2    /*設備數*/
#endif

#ifndef MEMDEV_SIZE
#define MEMDEV_SIZE 4096
#endif

/*mem設備描述結構體*/
struct mem_dev                                     
{                                                        
  char *data;                      
  unsigned long size;       
};

/* 定義幻數 */
#define MEMDEV_IOC_MAGIC  'k'

/* 定義命令 */
#define MEMDEV_IOCPRINT   _IO(MEMDEV_IOC_MAGIC, 1)
#define MEMDEV_IOCGETDATA _IOR(MEMDEV_IOC_MAGIC, 2, int)
#define MEMDEV_IOCSETDATA _IOW(MEMDEV_IOC_MAGIC, 3, int)

#define MEMDEV_IOC_MAXNR 3

#endif /* _MEMDEV_H_ */

memdev.c

#include <linux/module.h>
#include <linux/types.h>
#include <linux/fs.h>
#include <linux/errno.h>
#include <linux/mm.h>
#include <linux/sched.h>
#include <linux/init.h>
#include <linux/cdev.h>
#include <asm/io.h>
#include <asm/system.h>
#include <asm/uaccess.h>

#include "memdev.h"

static int mem_major = MEMDEV_MAJOR;

module_param(mem_major, int, S_IRUGO);

struct mem_dev *mem_devp; /*設備結構體指針*/

struct cdev cdev; 

/*文件打開函數*/
int mem_open(struct inode *inode, struct file *filp)
{
    struct mem_dev *dev;
    
    /*獲取次設備號*/
    int num = MINOR(inode->i_rdev);

    if (num >= MEMDEV_NR_DEVS) 
            return -ENODEV;
    dev = &mem_devp[num];
    
    /*將設備描述結構指針賦值給文件私有數據指針*/
    filp->private_data = dev;
    
    return 0; 
}

/*文件釋放函數*/
int mem_release(struct inode *inode, struct file *filp)
{
  return 0;
}

/*IO操作*/
int memdev_ioctl(struct inode *inode, struct file *filp,
                 unsigned int cmd, unsigned long arg)
{

    int err = 0;
    int ret = 0;
    int ioarg = 0;
    
    /* 檢測命令的有效性 */
    if (_IOC_TYPE(cmd) != MEMDEV_IOC_MAGIC) 
        return -EINVAL;
    if (_IOC_NR(cmd) > MEMDEV_IOC_MAXNR) 
        return -EINVAL;

    /* 根據命令類型，檢測參數空間是否可以訪問 */
    if (_IOC_DIR(cmd) & _IOC_READ)
        err = !access_ok(VERIFY_WRITE, (void *)arg, _IOC_SIZE(cmd));
    else if (_IOC_DIR(cmd) & _IOC_WRITE)
        err = !access_ok(VERIFY_READ, (void *)arg, _IOC_SIZE(cmd));
    if (err) 
        return -EFAULT;

    /* 根據命令，執行相應的操作 */
    switch(cmd) {

      /* 打印當前設備信息 */
      case MEMDEV_IOCPRINT:
      	printk("<--- CMD MEMDEV_IOCPRINT Done--->\n\n");
        break;
      
      /* 獲取參數 */
      case MEMDEV_IOCGETDATA: 
        ioarg = 1101;
        ret = __put_user(ioarg, (int *)arg);
        break;
      
      /* 設置參數 */
      case MEMDEV_IOCSETDATA: 
        ret = __get_user(ioarg, (int *)arg);
        printk("<--- In Kernel MEMDEV_IOCSETDATA ioarg = %d --->\n\n",ioarg);
        break;

      default:  
        return -EINVAL;
    }
    return ret;

}

/*文件操作結構體*/
static const struct file_operations mem_fops =
{
  .owner = THIS_MODULE,
  .open = mem_open,
  .release = mem_release,
  .ioctl = memdev_ioctl,
};

/*設備驅動模塊加載函數*/
static int memdev_init(void)
{
  int result;
  int i;

  dev_t devno = MKDEV(mem_major, 0);

  /* 靜態申請設備號*/
  if (mem_major)
    result = register_chrdev_region(devno, 2, "memdev");
  else  /* 動態分配設備號 */
  {
    result = alloc_chrdev_region(&devno, 0, 2, "memdev");
    mem_major = MAJOR(devno);
  }  
  
  if (result < 0)
    return result;

  /*初始化cdev結構*/
  cdev_init(&cdev, &mem_fops);
  cdev.owner = THIS_MODULE;
  cdev.ops = &mem_fops;
  
  /* 註冊字符設備 */
  cdev_add(&cdev, MKDEV(mem_major, 0), MEMDEV_NR_DEVS);
   
  /* 爲設備描述結構分配內存*/
  mem_devp = kmalloc(MEMDEV_NR_DEVS * sizeof(struct mem_dev), GFP_KERNEL);
  if (!mem_devp)    /*申請失敗*/
  {
    result =  - ENOMEM;
    goto fail_malloc;
  }
  memset(mem_devp, 0, sizeof(struct mem_dev));
  
  /*爲設備分配內存*/
  for (i=0; i < MEMDEV_NR_DEVS; i++) 
  {
        mem_devp[i].size = MEMDEV_SIZE;
        mem_devp[i].data = kmalloc(MEMDEV_SIZE, GFP_KERNEL);
        memset(mem_devp[i].data, 0, MEMDEV_SIZE);
  }
    
  return 0;

  fail_malloc: 
  unregister_chrdev_region(devno, 1);
  
  return result;
}

/*模塊卸載函數*/
static void memdev_exit(void)
{
  cdev_del(&cdev);   /*註銷設備*/
  kfree(mem_devp);     /*釋放設備結構體內存*/
  unregister_chrdev_region(MKDEV(mem_major, 0), 2); /*釋放設備號*/
}

MODULE_AUTHOR("David Xie");
MODULE_LICENSE("GPL");

module_init(memdev_init);
module_exit(memdev_exit);

Makefile

ifneq ($(KERNELRELEASE),)

obj-m := memdev.o

else
	
KDIR := /home/guoqian/4-3-1/linux-2.6.29
all:
	make -C $(KDIR) M=$(PWD) modules ARCH=arm CROSS_COMPILE=arm-linux-
clean:
	rm -f *.ko *.o *.mod.o *.mod.c *.symvers  modul*

endif

測試程序app-ioctl.c

#include <stdio.h>
#include<sys/types.h>
#include<sys/stat.h>
#include<fcntl.h>

#include "memdev.h"  /* 包含命令定義 */

int main()
{
	int fd = 0;
	int cmd;
	int arg = 0;
	char Buf[4096];
	
	
	/*打開設備文件*/
	fd = open("/dev/memdev0",O_RDWR);
	if (fd < 0)
	{
		printf("Open Dev Mem0 Error!\n");
		return -1;
	}
	
	/* 調用命令MEMDEV_IOCPRINT */
	printf("<--- Call MEMDEV_IOCPRINT --->\n");
	cmd = MEMDEV_IOCPRINT;
	if (ioctl(fd, cmd, &arg) < 0)
        {
        	printf("Call cmd MEMDEV_IOCPRINT fail\n");
        	return -1;
	}
	
	
	/* 調用命令MEMDEV_IOCSETDATA */
	printf("<--- Call MEMDEV_IOCSETDATA --->\n");
	cmd = MEMDEV_IOCSETDATA;
	arg = 2007;
	if (ioctl(fd, cmd, &arg) < 0)
        {
        	printf("Call cmd MEMDEV_IOCSETDATA fail\n");
        	return -1;
	}

	
	/* 調用命令MEMDEV_IOCGETDATA */
	printf("<--- Call MEMDEV_IOCGETDATA --->\n");
	cmd = MEMDEV_IOCGETDATA;
	if (ioctl(fd, cmd, &arg) < 0)
        {
        	printf("Call cmd MEMDEV_IOCGETDATA fail\n");
        	return -1;
	}
	printf("<--- In User Space MEMDEV_IOCGETDATA Get Data is %d --->\n\n",arg);	
	
	close(fd);
	return 0;	
}

ioctl設備控制及例子

Linux內核地址空間分佈和進程地址空間

ioctl設備控制及例子

Poll方法

Linux進程地址空間

進程地址空間與虛擬存儲空間的理解

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結