device_create详解

开始写Linux设备驱动程序的时候，很多时候都是利用mknod命令手动创建设备节点，实际上现在Linux内核为我们提供了一组函数，可以用来在模块加载的时候自动在/dev目录下创建相应设备节点，并在卸载模块时删除该节点。

内核中定义了struct class结构体，顾名思义，一个struct class结构体类型变量对应一个类，内核同时提供了class_create(…)函数，可以用它来创建一个类，这个类存放于sysfs下面，一旦创建好了这个类，再调用device_create(…)函数来在/dev目录下创建相应的设备节点。这样，加载模块的时候，用户空间中的udev会自动响应device_create(…)函数，去/sysfs下寻找对应的类从而创建设备节点。

此外，利用device_create_file函数可以在/sys/class/下创建对应的属性文件，从而通过对该文件的读写实现特定的数据操作。

一、 class_create
二、 device_create
三、 device_create_file
3.1 a.在驱动程序中使用 device_create_file创建属性文件
3.2 b.在用户空间读取属性
四、使用示例

一、class_create
官方说明：
/* This is a #define to keep the compiler from merging different
 * instances of the __key variable */
#define class_create(owner, name) \
({ \
static struct lock_class_key __key; \
__class_create(owner, name, &__key); \
})


/**
 * class_create - create a struct class structure
 * @owner: pointer to the module that is to "own" this struct class
 * @name: pointer to a string for the name of this class.
 * @key: the lock_class_key for this class; used by mutex lock debugging
 *
 * This is used to create a struct class pointer that can then be used
 * in calls to device_create().
 *
 * Returns &struct class pointer on success, or ERR_PTR() on error.
 *
 * Note, the pointer created here is to be destroyed when finished by
 * making a call to class_destroy().
 */
struct class *__class_create(struct module *owner, const char *name,struct lock_class_key *key)
关键的一句是：
 * This is used to create a struct class pointer that can then be used
 * in calls to device_create().
  -->这个函数用来创建一个struct class的结构体指针，这个指针可用作device_create()函数的参数。
也就是说，这个函数主要是在调用device_create()前使用，创建一个struct class类型的变量，并返回其指针。


二、device_create
官方说明：
/**
 * device_create - creates a device and registers it with sysfs
 * @class: pointer to the struct class that this device should be registered to
 * @parent: pointer to the parent struct device of this new device, if any
 * @devt: the dev_t for the char device to be added
 * @drvdata: the data to be added to the device for callbacks
 * @fmt: string for the device's name
 *
 * This function can be used by char device classes.  A struct device
 * will be created in sysfs, registered to the specified class.
 *
 * A "dev" file will be created, showing the dev_t for the device, if
 * the dev_t is not 0,0.
 * If a pointer to a parent struct device is passed in, the newly created
 * struct device will be a child of that device in sysfs.
 * The pointer to the struct device will be returned from the call.
 * Any further sysfs files that might be required can be created using this
 * pointer.
 *
 * Returns &struct device pointer on success, or ERR_PTR() on error.
 *
 * Note: the struct class passed to this function must have previously
 * been created with a call to class_create().
 */
struct device *device_create(struct class *class, struct device *parent,dev_t devt, void *drvdata, const char *fmt, ...)
首先解释一下"sysfs"：sysfs是linux2.6所提供的一种虚拟档案系统；在设备模型中，sysfs文件系统用来表示设备的结构，将设备的层次结构形象的反应到用户空间中，从而可以通过修改sysfs中的文件属性来修改设备的属性值；sysfs被挂载到根目录下的"/sys"文件夹下。


三、device_create_file
官方说明：

/**
 * device_create_file - create sysfs attribute file for device.
 * @dev: device.
 * @attr: device attribute descriptor.
 */
int device_create_file(struct device *dev,const struct device_attribute *attr)
使用这个函数时要引用 device_create所返回的device*指针，作用是在/sys/class/下创建一个属性文件，从而通过对这个属性文件进行读写就能完成对应的数据操作。
如：
a.在驱动程序中使用 device_create_file创建属性文件
static DEVICE_ATTR(val, S_IRUGO | S_IWUSR, hello_val_show, hello_val_store);  

/*读取寄存器val的值到缓冲区buf中，内部使用*/  
static ssize_t __hello_get_val(struct xxx_dev* dev, char* buf) {  
    int val = 0;          
  
    /*同步访问*/  
    if(down_interruptible(&(dev->sem))) {                  
        return -ERESTARTSYS;          
    }          
  
    val = dev->val;          
    up(&(dev->sem));          
  
    return snprintf(buf, PAGE_SIZE, "%d/n", val);  
}  
  
/*把缓冲区buf的值写到设备寄存器val中去，内部使用*/  
static ssize_t __hello_set_val(struct xxx_dev* dev, const char* buf, size_t count) {  
    int val = 0;          
  
    /*将字符串转换成数字*/          
    val = simple_strtol(buf, NULL, 10);          
  
    /*同步访问*/          
    if(down_interruptible(&(dev->sem))) {                  
        return -ERESTARTSYS;          
    }          
  
    dev->val = val;          
    up(&(dev->sem));  
  
    return count;  
}  
  
/*读取设备属性val*/  
static ssize_t hello_val_show(struct device* dev, struct device_attribute* attr, char* buf) {  
    struct xxx_dev* hdev = (struct xxx_dev*)dev_get_drvdata(dev);          
  
    return __hello_get_val(hdev, buf);  
}  
  
/*写设备属性val*/  
static ssize_t hello_val_store(struct device* dev, struct device_attribute* attr, const char* buf, size_t count) {   
    struct xxx_dev* hdev = (struct xxx_dev*)dev_get_drvdata(dev);    
      
    return __hello_set_val(hdev, buf, count);  
} 


/*模块加载方法*/  
static int __init xxx_init(void){   
    ... 
  
    /*在/sys/class/xxx/xxx目录下创建属性文件val*/  
    err = device_create_file(temp, &dev_attr_val);  
    if(err < 0) {  
        printk(KERN_ALERT"Failed to create attribute val.");                  
        goto destroy_device;  
    }
  
    ...
} 
b.在用户空间读取属性
...
read(dev->fd, val, sizeof(*val));
...
write(dev->fd, &val, sizeof(val));
...
四、使用示例
    /*在/sys/class/目录下创建设备类别目录xxx*/ 
    g_vircdev_class = class_create(THIS_MODULE, VIRCDEV_CLASS_NAME);
    if(IS_ERR(g_vircdev_class)) {  
        err = PTR_ERR(g_vircdev_class);  
        printk(KERN_ALERT "Failed to create class.\n");  
        goto CLASS_CREATE_ERR;  
    }
    
    /*在/dev/目录和/sys/class/xxx目录下分别创建设备文件xxx*/
    dev = device_create(g_vircdev_class, NULL, devt, NULL, VIRCDEV_DEVICE_NAME);
    if(IS_ERR(dev)) {  
        err = PTR_ERR(dev);  
        printk(KERN_ALERT "Failed to create device.\n");  
        goto DEVICE_CREATE_ERR;  
    }
    
    /*在/sys/class/xxx/xxx目录下创建属性文件val*/ 
    err = device_create_file(dev, attr);  
    if(err < 0) {  
        printk(KERN_ALERT"Failed to create attribute file.");                  
        goto DEVICE_CREATE_FILE_ERR;  
    }


在驱动程序中 初始化入口函数中，向内核注册一个设备后，往往要注册一个类
例如
static int __init mydriver_init(void) //驱动程序的初始化
{  
   ……
    MYDRIVER_Major = register_chrdev(0, DEVICE_NAME, &mydriver_fops); //向内核注册一个设备,返回值为注册的主设备号
    if (MYDRIVER_Major < 0)
    {
        printk(DEVICE_NAME " can't register major number\n");
        return MYDRIVER_Major;
    }
    ……
    mydriver_class = class_create(THIS_MODULE, DEVICE_NAME); //注册一个类，使mdev可以在"/dev/"目录下 面建立设备节点
    ……
    //创建一个设备节点，节点名为DEVICE_NAME
    device_create(mydriver_class, NULL, MKDEV(MYDRIVER_Major, 0), NULL, DEVICE_NAME);
    ……
}
从linux内核2.6的某个版本之后，devfs不复存在，udev成为devfs的 替代。相比devfs，udev有很多优势，在此就不罗嗦了，提醒一点，udev是应用层的东东，不要试图在内核的配置选项里找到它;加入对udev的支 持很简单，以作者所写的一个字符设备驱动为例，在驱动初始化的代码里调用class_create为该设备创建一个class，再为每个设备调用 class_device_create创建对应的设备。大致用法如下：
struct class *myclass = class_create(THIS_MODULE, “my_device_driver”);

class_device_create(myclass, NULL, MKDEV(major_num, 0), NULL, “my_device”);

class_device_create()是之前的版本，现在用的是device_create()

这样的module被加载时，udev daemon就会自动在/dev下创建my_device设备文件。

class_create()
-------------------------------------------------
linux-2.6.22/include/linux/device.h
struct class *class_create(struct module *owner, const char *name)
    class_create - create a struct class structure
    @owner: pointer to the module that is to "own" this struct class
    @name: pointer to a string for the name of this class.
在/sys/class/下创建类目录

class_device_create()
-------------------------------------------------
linux-2.6.22/include/linux/device.h
struct class_device *class_device_create(struct class        *cls,
                                         struct class_device *parent,
                                         dev_t               devt,
                                         struct device       *device,
                                         const char          *fmt, ...)
    class_device_create - creates a class device and registers it with sysfs
    @cls: pointer to the struct class that this device should be registered to.
    @parent: pointer to the parent struct class_device of this new device, if any.
    @devt: the dev_t for the char device to be added.
    @device: a pointer to a struct device that is assiociated with this class device.
    @fmt: string for the class device's name
对于没有指定dev->parent的dev都将被添加到/sys/devices/virtual/tty/ 目录下,如果指定了dev->parent,那么同时该dev->class存在,同时parent->class存在,那么该dev->name目录将被添加到parent->class所在目录下

来看看linux2.6.25内核源码,是怎么做得.
device_create(tty_class, NULL, MKDEV(TTYAUX_MAJOR, 1),"console");
==>device_register
==>device_add
==>setup_parent
==>get_device_parent
==>dev->kobj.parent= kobj("/sys/devices/virtual/tty");//所以所有的文件添加都将指向该目录
// 名在/sys/devices/virtual/目录下创建以tty_class的name为目录名的目录

        retval = kobject_add(k, parent_kobj,"%s", dev->class->name);// 将kobj添加到parent_kobj对应目录下
        if (retval< 0) {
            kobject_put(k);
            returnNULL;
        }
        
        return k;
    }
    if (parent)
        return &parent->kobj;
    return NULL;
}
#endif

==================================================================================================================
基于linux-2.6.35的class_create(),device_create解析
从linux内核2.6的某个版本之后，devfs不复存在，udev成为devfs的替代。提醒一点，udev是应用层的，不要试图在内核的配置选项里找到它;加入对udev的支持很简单，以作者所写的一个字符设备驱动为例，在驱动初始化的代码里调用class_create为该设备创建一个class，再为每个设备调用device_create创建对应的设备。大致用法如下：
struct class *myclass ；
        class_create(THIS_MODULE, “my_device_driver”);
        device_create(myclass, NULL, MKDEV(major_num, minor_num), NULL, “my_device”);
这样的module被加载时，udev daemon就会自动在/dev下创建my_device设备文件。
我们在刚开始写Linux设备驱动程序的时候，很多时候都是利用mknod命令手动创建设备节点，实际上Linux内核为我们提供了一组函数，可以用来在模块加载的时候自动在 /dev目录下创建相应设备节点，并在卸载模块时删除该节点，当然前提条件是用户空间移植了udev。


内核中定义了struct class结构体，顾名思义，一个struct class结构体类型变量对应一个类，内核同时提供了class_create(…)函数，可以用它来创建一个类，这个类存放于sysfs下面，一旦创建好了这个类，再调用device_create(…)函数来在/dev目录下创建相应的设备节点。这样，加载模块的时候，用户空间中的udev会自动响应 device_create(…)函数，去/sysfs下寻找对应的类从而创建设备节点。


注意，在2.6较早的内核版本中，device_create(…)函数名称不同，是class_device_create(…)，所以在新的内核中编译以前的模块程序有时会报错，就是因为函数名称 不同，而且里面的参数设置也有一些变化。


struct class和device_create(…) 以及device_create(…)都定义在/include/linux/device.h中，使用的时候一定要包含这个头文件，否则编译器会报错。


在2.6.35内核版本中，struct class定义在头文件include/linux/device.h中
        /*
        * device classes
        */
        struct class {
                const char *name;
                struct module *owner;
                struct class_attribute *class_attrs;
                struct device_attribute *dev_attrs;
                struct kobject *dev_kobj;
                int (*dev_uevent)(struct device *dev, struct kobj_uevent_env *env);
                char *(*devnode)(struct device *dev, mode_t *mode);
                void (*class_release)(struct class *class);
                void (*dev_release)(struct device *dev);
                int (*suspend)(struct device *dev, pm_message_t state);
                int (*resume)(struct device *dev);
                const struct kobj_ns_type_operations *ns_type;
                const void *(*namespace)(struct device *dev);
                const struct dev_pm_ops *pm;
                struct class_private *p;
                };
        class_create(…)在/drivers/base/class.c中实现： 
        /**
        * class_create - create a struct class structure
        * @owner: pointer to the module that is to "own" this struct class
        * @name: pointer to a string for the name of this class.
        ;*
        * This is used to create a struct class pointer that can then be used
        * in calls to device_create().
        *
        * Note, the pointer created here is to be destroyed when finished by
        * making a call to class_destroy().
        */
 struct class *__class_create(struct module *owner, const char *name,struct lock_class_key *key)
        {
                struct class *cls;
                 int retval;
                cls = kzalloc(sizeof(*cls), GFP_KERNEL);
                if (!cls) {
                        retval = -ENOMEM;
                         goto error;
                        }
                cls->name = name;
                cls->owner = owner;
                 cls->class_release = class_create_release;
                retval = __class_register(cls, key);
                 if (retval)
                        goto error;
                        return cls;
                error:
                        kfree(cls);
                        return ERR_PTR(retval);
        }


第一个参数指定类的所有者是哪个模块，第二个参数指定类名。


在class.c中，还定义了class_destroy(…)函数，用于在模块卸载时删除类。

device_create(…)函数在/drivers/base/core.c中实现： 
        /**
        * device_create - creates a device and registers it with sysfs
        * @class: pointer to the struct class that this device should be registered to
        * @parent: pointer to the parent struct device of this new device, if any
        * @devt: the dev_t for the char device to be added
        * @fmt: string for the device's name
        *
        * This function can be used by char device classes. A struct device
        * will be created in sysfs, registered to the specified class.
        *
        * A "dev" file will be created, showing the dev_t for the device, if
        * the dev_t is not 0,0.
        * If a pointer to a parent struct device is passed in, the newly created
        * struct device will be a child of that device in sysfs.
        * The pointer to the struct device will be returned from the call.
        * Any further sysfs files that might be required can be created using this
        * pointer.
        *
        * Note: the struct class passed to this function must have previously
        * been created with a call to class_create().
         */
struct device *device_create(struct class *class, struct device *parent, dev_t devt, void *drvdata, const char *fmt, ...)
        {
                va_list vargs;
                struct device *dev;
                va_start(vargs, fmt);
                dev = device_create_vargs(class, parent, devt, drvdata, fmt, vargs);
                 va_end(vargs);
                 return dev;
        }
第一个参数指定所要创建的设备所从属的类，第二个参数是这个设备的父设备，如果没有就指定为NULL，第三个参数是设备号，第四个参数是设备名称，第五个参数是从设备号。


下面以一个简单字符设备驱动来展示如何使用这几个函数：
        #include <linux/module.h>
        #include <linux/kernel.h>
        #include <linux/init.h>
        #include <linux/fs.h>
        #include <linux/cdev.h>
        #include <asm/uaccess.h>
        #include <linux/device.h>
        MODULE_LICENSE ("GPL");
        int hello_major = 250;
        int hello_minor = 0;
        int number_of_devices = 1;
        struct cdev cdev;
        dev_t dev = 0;
        struct file_operations hello_fops = {
                .owner = THIS_MODULE,
         };
        struct class *my_class;
        static void char_reg_setup_cdev (void)
        {
                int error, devno = MKDEV (hello_major, hello_minor);
                cdev_init (&cdev, &hello_fops);
                cdev.owner = THIS_MODULE;
                cdev.ops = &hello_fops;
                error = cdev_add (&cdev, devno , 1);
                if (error)
                        printk (KERN_NOTICE "Error %d adding char_reg_setup_cdev", error);
                /* creating your own class */
                 my_class =class_create(THIS_MODULE, "farsight_class");
                if(IS_ERR(my_class)) {
                        printk("Err: failed in creating class.\n");
                        return ;
                }
                /* register your own device in sysfs, and this will cause udevd to create corresponding device node */
                device_create(my_class,NULL, devno, NULL,"hello");
                }
        static int __init hello_2_init (void)
        {
                int result;
                dev = MKDEV (hello_major, hello_minor);
                result = register_chrdev_region (dev, number_of_devices, "test");
                if (result<0) {
                        printk (KERN_WARNING "hello: can't get major number %d\n", hello_major);
                        return result;
                }
                char_reg_setup_cdev ();
                printk (KERN_INFO "char device registered\n");
                return 0;
        }
        static void __exit hello_2_exit (void)
        {
                dev_t devno = MKDEV (hello_major, hello_minor);
                cdev_del (&cdev);
                unregister_chrdev_region (devno, number_of_devices);
                device_destroy(my_class, devno);
                class_destroy(my_class);
        }
        module_init (hello_2_init);
        module_exit (hello_2_exit);

当加载模块的时候，会在/dev/hello这个设备文件