drivers\base\sys.c
小结：
从sysdev_shutdown函数的实现，我们可以大概的分析一下驱动的层次模式如下：
1、最顶层的是system_subsys，所有的cls都挂载在他的链表中
2、每一个cls有一个驱动链表，这个驱动链表又可以按sysdev进行一个分组，但是分组只是为了管理方便，驱动还是挂载在cls下的。
3、分组虽然只是管理，但是驱动的一些函数执行，比如shutdown，resume等，是需要匹配对应的组的，所以在suspend失败的时候，进行恢复操作还要重新遍历组。
关于system_subsys和device_subsys(core.c中操作的对象)的关系，在最后一个函数：system_bus_init中点了出来：
system_subsys.kobj.parent = &devices_subsys.kobj;
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
函数列表：
decl_subsys(system, &ktype_sysdev_class, NULL)
声明了一个子系统system_subsys作为类的父节点
在core.c中，我们已经声明了一个device_subsys子系统作为device的父节点
int sysdev_class_register(struct sysdev_class * cls)
类的注册，将类cls挂载到system_subsys父节点下，cls->kobj->kset关联为了system_subsys
后面跟着的是unregister函数，其实现就是将cls->kset脱出
int sysdev_driver_register(struct sysdev_class *cls, struct sysdev_driver *drv)
将驱动drv注册到类cls中，实际就是挂载链表drv->entry到cls->drivers下，并执行drv->add函数
int sysdev_register(struct sys_device * sysdev)
注册系统设备，实际就是设置kobj的名字，然后注册kobj，最后执行cls中所有驱动的add函数
void sysdev_shutdown(void)
int sysdev_suspend(pm_message_t state)
int sysdev_resume(void)
设备的掉电函数，挂起函数，恢复函数，这三个函数的结构层次是类似的，从这些函数里我们也可以分析出驱动模型的层次。
int __init system_bus_init(void)
总线的初始化，这个函数虽然只有两行代码，却很核心的说明了system_subsys和device_subsys的关系：system_subsys是device_subsys的子设备
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
extern struct kset devices_subsys; //这个结构体的定义在core.c的宏中
//根据成员获取结构体
#define to_sysdev(k) container_of(k, struct sys_device, kobj)
#define to_sysdev_attr(a) container_of(a, struct sysdev_attribute, attr)
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
struct sys_device {
u32 id;
struct sysdev_class * cls;
struct kobject kobj;
};
//调用attr的显示函数
static ssize_t sysdev_show(
struct kobject *kobj,
struct attribute *attr,
char *buffer)
{
struct sys_device *sysdev = to_sysdev(kobj); //根据obj获取系统设备
struct sysdev_attribute *sysdev_attr = to_sysdev_attr(attr);
if (sysdev_attr->show)
return sysdev_attr->show(sysdev, buffer);
return -EIO;
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//调用attr的store函数
static ssize_t sysdev_store(
struct kobject *kobj,
struct attribute *attr,
const char *buffer,
size_t count)
{
struct sys_device * sysdev = to_sysdev(kobj);
struct sysdev_attribute * sysdev_attr = to_sysdev_attr(attr);
if (sysdev_attr->store)
return sysdev_attr->store(sysdev, buffer, count);
return -EIO;
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
static struct sysfs_ops sysfs_ops = {
.show = sysdev_show,
.store = sysdev_store,
};
//这个type是给sysdev注册时用的
static struct kobj_type ktype_sysdev = {
.sysfs_ops = &sysfs_ops,
};
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//创建/删除属性文件
int sysdev_create_file(struct sys_device * s, struct sysdev_attribute * a)
{
return sysfs_create_file(&s->kobj, &a->attr);
}
void sysdev_remove_file(struct sys_device * s, struct sysdev_attribute * a)
{
sysfs_remove_file(&s->kobj, &a->attr);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
struct sysdev_class {
struct list_head drivers;
int (*shutdown)(struct sys_device *);
int (*suspend)(struct sys_device *, pm_message_t state);
int (*resume)(struct sys_device *);
struct kset kset;
};
//根据成员获取类和类属性
#define to_sysdev_class(k) container_of(k, struct sysdev_class, kset.kobj)
#define to_sysdev_class_attr(a) container_of(a, struct sysdev_class_attribute, attr)
//调用class_attr的show和store函数
static ssize_t sysdev_class_show(struct kobject *kobj, struct attribute *attr,
char *buffer)
static ssize_t sysdev_class_store(struct kobject *kobj, struct attribute *attr,
const char *buffer, size_t count)
//设置默认的结构体
static struct sysfs_ops sysfs_class_ops = {
.show = sysdev_class_show,
.store = sysdev_class_store,
};
static struct kobj_type ktype_sysdev_class = {
.sysfs_ops = &sysfs_class_ops,
};
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//创建class的属性文件
int sysdev_class_create_file(struct sysdev_class *c,
struct sysdev_class_attribute *a)
{
return sysfs_create_file(&c->kset.kobj, &a->attr);
}
void sysdev_class_remove_file(struct sysdev_class *c,
struct sysdev_class_attribute *a)
{
sysfs_remove_file(&c->kset.kobj, &a->attr);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//定义system_subsys结构体(系统子系统)
//之前在core.c中定义的是device_subsys结构体（设备子系统）
//从下面那个注册函数可见，system_subsys是类的父节点
static decl_subsys(system, &ktype_sysdev_class, NULL);
struct kset system_subsys = { \
.kobj = { .k_name = __stringify(system) }, \
.ktype = &ktype_sysdev_class, \
.uevent_ops =NULL, \
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//注册系统设备类，父设备为system_subsys
//其实所谓的注册/卸载操作，就是将kobj关联进链表中
int sysdev_class_register(struct sysdev_class * cls)
{
INIT_LIST_HEAD(&cls->drivers); //驱动链表挂空
cls->kset.kobj.parent = &system_subsys.kobj; //设置父节点
cls->kset.kobj.kset = &system_subsys; //设置宿主
return kset_register(&cls->kset); //注册kset，将kset->kobj关联到subsys链表中
}
void sysdev_class_unregister(struct sysdev_class * cls)
{
kset_unregister(&cls->kset);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
static DEFINE_MUTEX(sysdev_drivers_lock); //定义一个互斥锁
//驱动的注册
//实际就是挂载drv->entry到cls->drivers链表中，并执行drv->add函数
int sysdev_driver_register(
struct sysdev_class *cls, //类
struct sysdev_driver *drv) //驱动
{
int err = 0;
mutex_lock(&sysdev_drivers_lock); //锁
//类不为空，引用一个计数说明要注册一个驱动进去
if (cls && kset_get(&cls->kset)) {
//将驱动入口drv->entry关联到cls的驱动链表中
list_add_tail(&drv->entry, &cls->drivers);
//驱动的add函数存在，则依次执行这个函数将驱动add进cls中的每一个成员中。
if (drv->add) {
struct sys_device *dev;
list_for_each_entry(dev, &cls->kset.list, kobj.entry)
drv->add(dev);
}
} else { //类为空，出错
err = -EINVAL;
printk(KERN_ERR "%s: invalid device class\n", __FUNCTION__);
WARN_ON(1);
}
mutex_unlock(&sysdev_drivers_lock); //解
return err;
}
//驱动的卸载函数
void sysdev_driver_unregister(
struct sysdev_class * cls,
struct sysdev_driver * drv)
{
mutex_lock(&sysdev_drivers_lock);
list_del_init(&drv->entry); //驱动链表挂空
//如果类存在
if (cls) {
//执行驱动的remove函数
if (drv->remove) {
struct sys_device *dev;
list_for_each_entry(dev, &cls->kset.list, kobj.entry)
drv->remove(dev);
}
//释放类的一个引用
kset_put(&cls->kset);
}
mutex_unlock(&sysdev_drivers_lock);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
struct sys_device {
u32 id;
struct sysdev_class * cls;
struct kobject kobj;
};
//注册一个系统设备，这个函数调用的地方很少
//操作：设置kobj的名字，注册kobj，执行驱动中的add函数
int sysdev_register(struct sys_device * sysdev)
{
int error;
struct sysdev_class * cls = sysdev->cls;
//没有关联类
if (!cls)
return -EINVAL;
sysdev->kobj.kset = &cls->kset; //关联KSET
//关联ktype操作
sysdev->kobj.ktype = &ktype_sysdev;
//设置kobj的名字
error = kobject_set_name(&sysdev->kobj, "%s%d",
kobject_name(&cls->kset.kobj), sysdev->id);
if (error)
return error;
//注册kobj
error = kobject_register(&sysdev->kobj);
if (!error) {
struct sysdev_driver * drv;
mutex_lock(&sysdev_drivers_lock);
//执行驱动的add函数
list_for_each_entry(drv, &cls->drivers, entry) {
if (drv->add)
drv->add(sysdev);
}
mutex_unlock(&sysdev_drivers_lock);
}
return error;
}
我们先看一个调用：
int __init s3c2440_init(void)
{
//无关代码
return sysdev_register(&s3c2440_sysdev);
}
static struct sys_device s3c2440_sysdev = {
.cls = &s3c2440_sysclass,
};
struct sysdev_class s3c2440_sysclass = {
set_kset_name("s3c2440-core"),
.suspend = s3c244x_suspend,
.resume = s3c244x_resume
};
#define set_kset_name(str) .kset = { .kobj = { .k_name = str } }
最后将这个调用套上刚才的函数实现，就可以加深理解了。
//反注册，实际就是依次调用sysdev->cls->drivers的remove函数，然后反注册kobj
void sysdev_unregister(struct sys_device * sysdev)
{
struct sysdev_driver * drv;
mutex_lock(&sysdev_drivers_lock);
list_for_each_entry(drv, &sysdev->cls->drivers, entry) {
if (drv->remove)
drv->remove(sysdev);
}
mutex_unlock(&sysdev_drivers_lock);
kobject_unregister(&sysdev->kobj);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//系统设备关机
//从这个函数中执行shutdown函数的顺序，我们可以分析一下驱动的挂载模型：
//最顶层的是system_subsys，所有的cls都挂载在他的链表中
//每一个cls有一个驱动链表，这个驱动链表又可以按sysdev进行一个分组，但是分组只是为了管理方便，驱动还是挂载在cls下的。
//这个函数实际的操作就是遍历system_subsys.list下所有的cls，执行里面的shutdown函数
void sysdev_shutdown(void)
{
struct sysdev_class * cls;
mutex_lock(&sysdev_drivers_lock);
//从系统子系统中取出每一个cls类
list_for_each_entry_reverse(cls, &system_subsys.list, kset.kobj.entry) {
struct sys_device * sysdev;
//从cls类中取出每一个sysdev系统设备
list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
struct sysdev_driver * drv;
//从cls的驱动链表中取出每一个驱动，执行shutdown函数
list_for_each_entry(drv, &cls->drivers, entry) {
if (drv->shutdown)
drv->shutdown(sysdev);
}
//执行类的shutdown函数
if (cls->shutdown)
cls->shutdown(sysdev);
}
}
mutex_unlock(&sysdev_drivers_lock);
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//系统设备的恢复
//实际是先执行类的resume，在依次执行类的驱动链表的resume
static void __sysdev_resume(struct sys_device *dev)
{
struct sysdev_class *cls = dev->cls;
struct sysdev_driver *drv;
//先执行类的rusume函数
if (cls->resume)
cls->resume(dev);
//再依次执行驱动链表中的resume函数
list_for_each_entry(drv, &cls->drivers, entry) {
if (drv->resume)
drv->resume(dev);
}
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
typedef struct pm_message {
int event;
} pm_message_t;
//系统设备的挂起函数，参数无意义
int sysdev_suspend(pm_message_t state)
{
struct sysdev_class * cls;
struct sys_device *sysdev, *err_dev;
struct sysdev_driver *drv, *err_drv;
int ret;
//同shutdown一样，按顺序执行suspend函数
list_for_each_entry_reverse(cls, &system_subsys.list, kset.kobj.entry) {
list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
//执行类的驱动链表中每一个驱动的suspend挂起函数
list_for_each_entry(drv, &cls->drivers, entry) {
if (drv->suspend) {
ret = drv->suspend(sysdev, state);
if (ret)
goto aux_driver;
}
}
//执行类的挂起函数
if (cls->suspend) {
ret = cls->suspend(sysdev, state);
if (ret)
goto cls_driver;
}
}
}
//每一个挂起都顺利完成
return 0;
//类挂起失败
cls_driver:
drv = NULL;
//类链表中某个驱动挂起失败，drv指向失败的驱动
aux_driver:
//resume之前挂起的本组驱动
list_for_each_entry(err_drv, &cls->drivers, entry) {
if (err_drv == drv)
break;
if (err_drv->resume)
err_drv->resume(sysdev);
}
//resume当前类之前挂起的其他组系统设备
list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
if (err_dev == sysdev)
break;
__sysdev_resume(err_dev);
}
/* resume other classes */
list_for_each_entry_continue(cls, &system_subsys.list,
kset.kobj.entry) {
list_for_each_entry(err_dev, &cls->kset.list, kobj.entry) {
pr_debug(" %s\n", kobject_name(&err_dev->kobj));
__sysdev_resume(err_dev);
}
}
return ret;
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//恢复操作，这个实际在suspend的时候已经接触过了
int sysdev_resume(void)
{
struct sysdev_class * cls;
list_for_each_entry(cls, &system_subsys.list, kset.kobj.entry) {
struct sys_device * sysdev;
list_for_each_entry(sysdev, &cls->kset.list, kobj.entry) {
__sysdev_resume(sysdev);
}
}
return 0;
}
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
//系统总线的初始化
int __init system_bus_init(void)
{
//系统子系统的父设备是驱动子系统
system_subsys.kobj.parent = &devices_subsys.kobj;
return subsystem_register(&system_subsys); //子系统注册
}