14.5. 類

14.5.?類

我們?cè)诒菊轮幸疾熳詈蟮脑O(shè)備模型概念是類.一個(gè)類是一個(gè)設(shè)備的高級(jí)視圖, 它抽象出低級(jí)的實(shí)現(xiàn)細(xì)節(jié). 驅(qū)動(dòng)可以見(jiàn)到一個(gè)SCSI 磁盤或者一個(gè) ATA 磁盤, 在類的級(jí)別, 它們都是磁盤. 類允許用戶空間基于它們做什么來(lái)使用設(shè)備, 而不是它們?nèi)绾伪贿B接或者它們?nèi)绾喂ぷ?

幾乎所有的類都在 sysfs 中在 /sys/class 下出現(xiàn). 因此, 例如, 所有的網(wǎng)絡(luò)接口可在 /sys/class/net 下發(fā)現(xiàn), 不管接口類型. 輸入設(shè)備可在 /sys/class/input 下, 以及串行設(shè)備在 /sys/class/tty. 一個(gè)例外是塊設(shè)備, 由于歷史的原因在 /sys/block.

類成員關(guān)系常常由高級(jí)的代碼處理, 不必要驅(qū)動(dòng)的明確的支持. 當(dāng) sbull 驅(qū)動(dòng)( 見(jiàn) 16 章) 創(chuàng)建一個(gè)虛擬磁盤設(shè)備, 它自動(dòng)出現(xiàn)在 /sys/block. snull 網(wǎng)絡(luò)驅(qū)動(dòng)(見(jiàn) 17 章)沒(méi)有做任何特殊事情給它的接口在 /sys/class/net 中出現(xiàn). 將有多次, 但是, 當(dāng)驅(qū)動(dòng)結(jié)束直接處理類.

在許多情況, 類子系統(tǒng)是最好的輸出信息到用戶空間的方法. 當(dāng)一個(gè)子系統(tǒng)創(chuàng)建一個(gè)類, 它完全擁有這個(gè)類, 因此沒(méi)有必要擔(dān)心哪個(gè)模塊擁有那里發(fā)現(xiàn)的屬性. 它也用極少的時(shí)間徘徊于更加面向硬件的 sysfs 部分來(lái)了解, 它不是一個(gè)直接瀏覽的好地方. 用戶會(huì)更加高興地在 /sys/class/some-widget 中發(fā)現(xiàn)信息, 而不是, /sys/device/pci0000:00/0000:00:10.0/usb2/2-0:1.0.

驅(qū)動(dòng)核心輸出 2 個(gè)清晰的接口來(lái)管理類. class_simple 函數(shù)設(shè)計(jì)來(lái)盡可能容易地添加新類到系統(tǒng). 它們的主要目的, 常常, 是暴露包含設(shè)備號(hào)的屬性來(lái)使能設(shè)備節(jié)點(diǎn)的自動(dòng)創(chuàng)建. 常用的類接口更加復(fù)雜但是同時(shí)提供更多特性. 我們從簡(jiǎn)單版本開始.

14.5.1.?class_simple 接口

class_simple 接口意圖是易于使用, 以至于沒(méi)人會(huì)抱怨沒(méi)有暴露至少一個(gè)包含設(shè)備的被分配的號(hào)的屬性. 使用這個(gè)接口只不過(guò)是一對(duì)函數(shù)調(diào)用, 沒(méi)有通常的和 Linux 設(shè)備模型關(guān)聯(lián)的樣板.

第一步是創(chuàng)建類自身. 使用一個(gè)對(duì) class_simple_create 的調(diào)用來(lái)完成:

struct class_simple *class_simple_create(struct module *owner, char *name);

這個(gè)函數(shù)使用給定的名子創(chuàng)建一個(gè)類. 這個(gè)操作可能失敗, 當(dāng)然, 因此在繼續(xù)之前返回值應(yīng)當(dāng)一直被檢查( 使用 IS_ERR, 在第 1 章的"指針和錯(cuò)誤值"一節(jié)中描述過(guò)).

一個(gè)簡(jiǎn)單的類可被銷毀, 使用:

void class_simple_destroy(struct class_simple *cs); 

創(chuàng)建一個(gè)簡(jiǎn)單類的真實(shí)目的是添加設(shè)備給它; 這個(gè)任務(wù)使用:

struct class_device *class_simple_device_add(struct class_simple *cs, dev_t devnum, struct device *device, const char *fmt, ...); 

這里, cs 是之前創(chuàng)建的簡(jiǎn)單類, devnum 是分配的設(shè)備號(hào), device 是代表這個(gè)設(shè)備的 struct device, 其他的參數(shù)是一個(gè) printk-風(fēng)格 的格式串和參數(shù)來(lái)創(chuàng)建設(shè)備名子. 這個(gè)調(diào)用添加一項(xiàng)到類, 包含一個(gè)屬性, dev, 含有設(shè)備號(hào). 如果設(shè)備參數(shù)是非 NULL, 一個(gè)符號(hào)連接( 稱為 device )指向在 /sys/devices 下的設(shè)備的入口.

可能添加其他的屬性到設(shè)備入口. 它只是使用 class_device_create_file, 我們?cè)谙乱还?jié)和完整類子系統(tǒng)所剩下的內(nèi)容討論.

當(dāng)設(shè)備進(jìn)出時(shí)類產(chǎn)生熱插拔事件. 如果你的驅(qū)動(dòng)需要添加變量到環(huán)境中給用戶空間事件處理者, 可以建立一個(gè)熱插拔回調(diào), 使用:

int class_simple_set_hotplug(struct class_simple *cs,
 int (*hotplug)(struct class_device *dev,
 char **envp, int num_envp,
 char *buffer, int buffer_size)); 

當(dāng)你的設(shè)備離開時(shí), 類入口應(yīng)當(dāng)被去除, 使用:

void class_simple_device_remove(dev_t dev); 

注意, 由 class_simple_device_add 返回的 class_device 結(jié)構(gòu)這里不需要; 設(shè)備號(hào)(它當(dāng)然應(yīng)當(dāng)是唯一的)足夠了.

14.5.2.?完整的類接口

class_simple 接口滿足許多需要, 但是有時(shí)需要更多靈活性. 下面的討論描述如何使用完整的類機(jī)制, class_simple 正是基于此. 它是簡(jiǎn)短的: 類函數(shù)和結(jié)構(gòu)遵循設(shè)備模型其他部分相同的模式, 因此這里沒(méi)有什么真正是新的.

14.5.2.1.?管理類

一個(gè)類由一個(gè) struct class 的實(shí)例來(lái)定義:

struct class {
 char *name;
 struct class_attribute *class_attrs;
 struct class_device_attribute *class_dev_attrs;
 int (*hotplug)(struct class_device *dev, char **envp,
 int num_envp, char *buffer, int buffer_size);
 void (*release)(struct class_device *dev);
 void (*class_release)(struct class *class);
 /* Some fields omitted */
};

每個(gè)類需要一個(gè)唯一的名子, 它是這個(gè)類如何在 /sys/class 中出現(xiàn). 當(dāng)這個(gè)類被注冊(cè), 由 class_attrs 所指向的數(shù)組中列出的所有屬性被創(chuàng)建. 還有一套缺省屬性給每個(gè)添加到類中的設(shè)備; class_dev_attrs 指向它們. 有通常的熱插拔函數(shù)來(lái)添加變量到環(huán)境中, 當(dāng)事件產(chǎn)生時(shí). 還有 2 個(gè)釋放方法: release 在無(wú)論何時(shí)從類中去除一個(gè)設(shè)備時(shí)被調(diào)用, 而 class_release 在類自己被釋放時(shí)調(diào)用.

注冊(cè)函數(shù)是:

int class_register(struct class *cls);
void class_unregister(struct class *cls);

使用屬性的接口不應(yīng)當(dāng)在這點(diǎn)嚇人:

struct class_attribute {
 struct attribute attr;
 ssize_t (*show)(struct class *cls, char *buf);
 ssize_t (*store)(struct class *cls, const char *buf, size_t count); 
}; 
CLASS_ATTR(name, mode, show, store); 
int class_create_file(struct class *cls, const struct class_attribute *attr);
void class_remove_file(struct class *cls, const struct class_attribute *attr);

14.5.2.2.?類設(shè)備

一個(gè)類的真正目的是作為一個(gè)是該類成員的設(shè)備的容器. 一個(gè)成員由 struct class_device 來(lái)表示:

struct class_device {
struct kobject kobj;
struct class *class;
struct device *dev;
void *class_data;
char class_id[BUS_ID_SIZE];

 };

class_id 成員持有設(shè)備名子, 如同它在 sysfs 中的一樣. class 指針應(yīng)當(dāng)指向持有這個(gè)設(shè)備的類, 并且 dev 應(yīng)當(dāng)指向關(guān)聯(lián)的設(shè)備結(jié)構(gòu). 設(shè)置 dev 是可選的; 如果它是非 NULL, 它用來(lái)創(chuàng)建一個(gè)符號(hào)連接從類入口到對(duì)應(yīng)的在 /sys/devices 下的入口, 使得易于在用戶空間找到設(shè)備入口. 類可以使用 class_data 來(lái)持有一個(gè)私有指針.

通常的注冊(cè)函數(shù)已經(jīng)被提供:

int class_device_register(struct class_device *cd);
void class_device_unregister(struct class_device *cd);

類設(shè)備接口也允許重命名一個(gè)已經(jīng)注冊(cè)的入口:

int class_device_rename(struct class_device *cd, char *new_name); 

類設(shè)備入口有屬性:

struct class_device_attribute {
 struct attribute attr;
 ssize_t (*show)(struct class_device *cls, char *buf);
 ssize_t (*store)(struct class_device *cls, const char *buf,
 size_t count);
};

CLASS_DEVICE_ATTR(name, mode, show, store); 
int class_device_create_file(struct class_device *cls, const struct class_device_attribute *attr);
void class_device_remove_file(struct class_device *cls, const struct class_device_attribute *attr);

一個(gè)缺省的屬性集合, 在類的 class_dev_attrs 成員, 被創(chuàng)建當(dāng)類設(shè)備被注冊(cè)時(shí); class_device_create_file 可用來(lái)創(chuàng)建額外的屬性. 屬性還可以被加入到由 class_simple 接口創(chuàng)建的類設(shè)備.

14.5.2.3.?類接口

類子系統(tǒng)有一個(gè)額外的在 Linux 設(shè)備模型其他部分找不到的概念. 這個(gè)機(jī)制稱為一個(gè)接口, 但是它是, 也許, 最好作為一種觸發(fā)機(jī)制可用來(lái)在設(shè)備進(jìn)入或離開類時(shí)得到通知.

一個(gè)接口被表示, 使用:

struct class_interface {
 struct class *class;
 int (*add) (struct class_device *cd);
 void (*remove) (struct class_device *cd); 
}; 

接口可被注冊(cè)或注銷, 使用:

int class_interface_register(struct class_interface *intf);
void class_interface_unregister(struct class_interface *intf);

一個(gè)接口的功能是簡(jiǎn)單明了的. 無(wú)論何時(shí)一個(gè)類設(shè)備被加入到在 class_interface 結(jié)構(gòu)中指定的類時(shí), 接口的 add 函數(shù)被調(diào)用. 這個(gè)函數(shù)可進(jìn)行任何額外的這個(gè)設(shè)備需要的設(shè)置; 這個(gè)設(shè)置常常采取增加更多屬性的形式, 但是其他的應(yīng)用都可能. 當(dāng)設(shè)備被從類中去除, remove 方法被調(diào)用來(lái)進(jìn)行任何需要的清理.

可注冊(cè)多個(gè)接口給一個(gè)類.