14.8. 處理固件

14.8.?處理固件

作為一個(gè)驅(qū)動(dòng)作者, 你可能發(fā)現(xiàn)你面對(duì)一個(gè)設(shè)備必須在它能支持工作前下載固件到它里面. 硬件市場(chǎng)的許多地方的競(jìng)爭(zhēng)是如此得強(qiáng)烈, 以至于甚至一點(diǎn)用作設(shè)備控制固件的 EEPROM 的成本制造商都不愿意花費(fèi). 因此固件發(fā)布在隨硬件一起的一張 CD 上, 并且操作系統(tǒng)負(fù)責(zé)傳送固件到設(shè)備自身.

你可能想解決固件問(wèn)題使用這樣的一個(gè)聲明:

static char my_firmware[] = { 0x34, 0x78, 0xa4, ... }; 

但是, 這個(gè)方法幾乎肯定是一個(gè)錯(cuò)誤. 將固件編碼到一個(gè)驅(qū)動(dòng)擴(kuò)大了驅(qū)動(dòng)的代碼, 使固件升級(jí)困難, 并且非?？赡墚a(chǎn)生許可問(wèn)題. 供應(yīng)商不可能已經(jīng)發(fā)布固件映象在 GPL 之下, 因此和 GPL-許可的代碼混合常常是一個(gè)錯(cuò)誤. 為此, 包含內(nèi)嵌固件的驅(qū)動(dòng)不可能被接受到主流內(nèi)核或者被 Linux 發(fā)布者包含.

14.8.1.?內(nèi)核固件接口

正確的方法是當(dāng)你需要它時(shí)從用戶(hù)空間獲取它. 但是, 請(qǐng)抵制試圖從內(nèi)核空間直接打開(kāi)包含固件的文件的誘惑; 那是一個(gè)易出錯(cuò)的操作, 并且它安放了策略(以一個(gè)文件名的形式)到內(nèi)核. 相反, 正確的方法時(shí)使用固件接口, 它就是為此而創(chuàng)建的:

#include <linux/firmware.h>
int request_firmware(const struct firmware **fw, char *name, 
 struct device *device); 

調(diào)用 request_firmware 要求用戶(hù)空間定位并提供一個(gè)固件映象給內(nèi)核; 我們一會(huì)兒看它如何工作的細(xì)節(jié). name 應(yīng)當(dāng)標(biāo)識(shí)需要的固件; 正常的用法是供應(yīng)者提供的固件文件名. 某些象 my_firmware.bin 的名子是典型的. 如果固件被成功加載, 返回值是 0(負(fù)責(zé)常用的錯(cuò)誤碼被返回), 并且 fw 參數(shù)指向一個(gè)這些結(jié)構(gòu):

struct firmware {
 size_t size;
 u8 *data; 
}; 

那個(gè)結(jié)構(gòu)包含實(shí)際的固件, 它現(xiàn)在可被下載到設(shè)備中. 小心這個(gè)固件是來(lái)自用戶(hù)空間的未被檢查的數(shù)據(jù); 你應(yīng)當(dāng)在發(fā)送它到硬件之前運(yùn)用任何并且所有的你能夠想到的檢查來(lái)說(shuō)服你自己它是正確的固件映象. 設(shè)備固件常常包含標(biāo)識(shí)串, 校驗(yàn)和, 等等; 在信任數(shù)據(jù)前全部檢查它們.

在你已經(jīng)發(fā)送固件到設(shè)備前, 你應(yīng)當(dāng)釋放 in-kernel 結(jié)構(gòu), 使用:

void release_firmware(struct firmware *fw); 

因?yàn)?request_firmware 請(qǐng)求用戶(hù)空間來(lái)幫忙, 它保證在返回前睡眠. 如果你的驅(qū)動(dòng)當(dāng)它必須請(qǐng)求固件時(shí)不在睡眠的位置, 異步的替代方法可能要使用:

int request_firmware_nowait(struct module *module,
 char *name, struct device *device, void *context,
 void (*cont)(const struct firmware *fw, void *context)); 

這里額外的參數(shù)是 moudle( 它將一直是 THIS_MODULE), context (一個(gè)固件子系統(tǒng)不使用的私有數(shù)據(jù)指針), 和 cont. 如果都進(jìn)行順利, request_firmware_nowait 開(kāi)始固件加載過(guò)程并且返回 0. 在將來(lái)某個(gè)時(shí)間, cont 將用加載的結(jié)果被調(diào)用. 如果由于某些原因固件加載失敗, fw 是 NULL.

14.8.2.?它如何工作

固件子系統(tǒng)使用 sysfs 和熱插拔機(jī)制. 當(dāng)調(diào)用 request_firmware, 一個(gè)新目錄在 /sys/class/firmware 下使用你的驅(qū)動(dòng)的名子被創(chuàng)建. 那個(gè)目錄包含 3 個(gè)屬性:

loading
這個(gè)屬性應(yīng)當(dāng)被加載固件的用戶(hù)空間進(jìn)程設(shè)置為 1. 當(dāng)加載進(jìn)程完成, 它應(yīng)當(dāng)設(shè)為 0. 寫(xiě)一個(gè)值 -1 到 loading 會(huì)中止固件加載進(jìn)程.

data
data 是一個(gè)二進(jìn)制的接收固件數(shù)據(jù)自身的屬性. 在設(shè)置 loading 后, 用戶(hù)空間進(jìn)程應(yīng)當(dāng)寫(xiě)固件到這個(gè)屬性.

device
這個(gè)屬性是一個(gè)符號(hào)連接到 /sys/devices 下面的被關(guān)聯(lián)入口項(xiàng).

一旦創(chuàng)建了 sysfs 入口項(xiàng), 內(nèi)核為你的設(shè)備產(chǎn)生一個(gè)熱插拔事件. 傳遞給熱插拔處理者的環(huán)境包括一個(gè)變量 FIRMWARE, 它被設(shè)置為提供給 request_firmware 的名子. 這個(gè)處理者應(yīng)當(dāng)定位固件文件, 并且拷貝它到內(nèi)核使用提供的屬性. 如果這個(gè)文件無(wú)法找到, 處理者應(yīng)當(dāng)設(shè)置 loading 屬性為 -1.

如果一個(gè)固件請(qǐng)求在 10 秒內(nèi)沒(méi)有被服務(wù), 內(nèi)核就放棄并返回一個(gè)失敗狀態(tài)給驅(qū)動(dòng). 超時(shí)周期可通過(guò) sysfs 屬性 /sys/class/firmware/timeout 屬性改變.

使用 request_firmware 接口允許你隨你的驅(qū)動(dòng)發(fā)布設(shè)備固件. 當(dāng)正確地集成到熱插拔機(jī)制, 固件加載子系統(tǒng)允許設(shè)備簡(jiǎn)化工作"在盒子之外" 顯然這是處理問(wèn)題的最好方法.

但是, 請(qǐng)?jiān)试S我們提出多一條警告: 設(shè)備固件沒(méi)有制造商的許可不應(yīng)當(dāng)發(fā)布. 許多制造商會(huì)同意在合理的條款下許可它們的固件, 如果客氣地請(qǐng)求; 一些其他的可能不何在. 無(wú)論如何, 在沒(méi)有許可時(shí)拷貝和發(fā)布它們的固件是對(duì)版權(quán)法的破壞并且招致麻煩.