淺談按鍵驅(qū)動(dòng)的編寫和設(shè)備樹的修改

引言

隨著深度學(xué)習(xí)和5G的應(yīng)用，對FPGA的功能要求越來越多。因此近幾年FPGA大廠紛紛將自己的器件集成了更多的內(nèi)核，比如賽靈思的zynq系列就集成了arm，GPU，PCIE，射頻處理模塊等等，用于滿足各種各樣的需求。出身FPGA的工程師們也必須擁抱這些變化，不僅僅要精通FPGA開發(fā)，還需要了解其他方面的知識。比如基于zynq的開發(fā)者，就需要了解arm，linux驅(qū)動(dòng)以及l(fā)inux系統(tǒng)。做深度學(xué)習(xí)加速的還需要了解深度學(xué)習(xí)網(wǎng)絡(luò)以及網(wǎng)絡(luò)壓縮等知識。學(xué)習(xí)這些知識會讓你的眼界更加開闊，會站得高看得遠(yuǎn)，在開始一項(xiàng)任務(wù)的時(shí)候不再是盲人摸象，而是高瞻遠(yuǎn)矚，把握全局。

這是我介紹linux系統(tǒng)和驅(qū)動(dòng)的第4篇文章，如有不恰當(dāng)?shù)牡胤綒g迎指正，因?yàn)楸救艘彩翘幱趯W(xué)習(xí)入門階段。三人行，必有我?guī)熝?。討論的多了，問題也就清晰了。這一篇主要介紹按鍵驅(qū)動(dòng)的編寫，了解中斷的處理過程，以及設(shè)備樹的修改。

1. vivado工程搭建

工程搭建很簡單，就是配置完zynq核的外設(shè)后，增加一個(gè)axi_gpio模塊，作為外部按鍵的接口。雖然按鍵并不是直接連接到arm的IO上，但是axi_gpio也被映射到zynq系統(tǒng)的內(nèi)存空間中，linux驅(qū)動(dòng)通過讀寫key對應(yīng)的映射內(nèi)存來控制和檢測。要檢測到key被按下我們必須開啟中斷，因此axi_gpio模塊設(shè)置如下圖。Address editor是gpio的對應(yīng)的內(nèi)存空間。Zynq已經(jīng)為不同外設(shè)類型分配了可選的內(nèi)存映射，通常工程建立完后，由軟件工具自行分配就好了。如果一些外設(shè)內(nèi)存有沖突，是無法生成hdf的。

配置完成后，進(jìn)行管腳約束，然后綜合實(shí)現(xiàn)，生成bit文件。再導(dǎo)出hdf文件，打開SDK來生成fsbl，u-boot還使用前幾篇介紹驅(qū)動(dòng)中的u-boot。U-boot通常不會因?yàn)轵?qū)動(dòng)的新增而修改。但是由于增加了key按鍵，我們需要去設(shè)備樹中修改對應(yīng)的配置。

具體如何修改設(shè)備樹，可以到linux驅(qū)動(dòng)文件夾Documentation/devicetree中去尋找對應(yīng)的外設(shè)文件，其中有設(shè)備樹修改的介紹。Gpio的修改可以到gpio文件夾下的gpio-zynq.txt查看。其基本形式為：

         gpio@e000a000 { #gpio-cells = <2>;
                   compatible = "xlnx,zynq-gpio-1.0";
                   clocks = <&clkc 42>;
                   gpio-controller;
                   interrupt-parent = <&intc>;
                   interrupts = <0 20 4>;
                   interrupt-controller;
                   #interrupt-cells = <2>;
                   reg = <0xe000a000 0x1000>; };

其中compatible主要是用于linux驅(qū)動(dòng)去匹配設(shè)備樹中相應(yīng)的節(jié)點(diǎn)，后面我們會介紹，這個(gè)名字和那一塊程序有關(guān)。主要是配置中斷，其中interrupts-cell指定了interrupts有多少個(gè)屬性。Interrupts的第一個(gè)屬性是中斷類型，第二個(gè)是中斷號，最后一個(gè)表示觸發(fā)類型：高電平觸發(fā)、低電平觸發(fā)、上升沿觸發(fā)和下降沿觸發(fā)四種類型。Interrupt-parent是中斷所屬的中斷控制器。我們在SDK中產(chǎn)生了設(shè)備樹，我們看到按鍵的相應(yīng)節(jié)點(diǎn)位于amba_pl節(jié)點(diǎn)下，其中amba_pl是PL端的總線節(jié)點(diǎn)，而amba是PS端的總線節(jié)點(diǎn)，修改pl.dtsi中的gpio內(nèi)容：

我們改了compitable的內(nèi)容，同時(shí)要關(guān)注inerrupts，xlnx,all-inputs，xlnx,gpio-width這些屬性。Gpio-width是寬度，all-inputs是表示為輸入。

設(shè)備樹修改完后就可以編譯設(shè)備樹文件，然后用fsbl，u-boot，設(shè)備樹來制作boot.bin了。放到SD卡，啟動(dòng)linux系統(tǒng)。接下來進(jìn)入關(guān)鍵環(huán)節(jié)，key驅(qū)動(dòng)的編寫。

2. 按鍵驅(qū)動(dòng)代碼剖析

對于一個(gè)剛剛?cè)腴T的人來說，其實(shí)了解了驅(qū)動(dòng)的基本框架就好了。每個(gè)驅(qū)動(dòng)都按照它的框架進(jìn)行編寫和修改。能理解驅(qū)動(dòng)的各個(gè)模塊功能，在驅(qū)動(dòng)調(diào)試或者編寫中就能有的放矢。一個(gè)簡單的驅(qū)動(dòng)的構(gòu)成也很復(fù)雜，代碼也很多，篇幅有限，我只介紹主要部分。

1）platform框架

Platform是一種虛擬的平臺，提供了驅(qū)動(dòng)和具體硬件交互的接口。Platform_device類似于虛擬的總線，IIC，LCD，GPIO等外設(shè)都可以看做platform_device，通過它可以遍歷所有的總線設(shè)備，而對應(yīng)的驅(qū)動(dòng)就是platform_driver?；玖鞒淌牵合茸詐latform_device，再注冊platform_driver，然后匹配設(shè)備和驅(qū)動(dòng)，最后注冊整個(gè)驅(qū)動(dòng)。

在linux3以前的版本，需要定義platform_device結(jié)構(gòu)體，然后通過platform_device_register函數(shù)來注冊設(shè)備。但是linux3.0以后出現(xiàn)了設(shè)備樹，內(nèi)核函數(shù)of_platform_default_populate_init會在內(nèi)核啟動(dòng)后遍歷設(shè)備樹，自動(dòng)注冊每個(gè)節(jié)點(diǎn)對應(yīng)的設(shè)備。因此只需要修改設(shè)備樹參數(shù)就行了。首先看這個(gè)結(jié)構(gòu)體：

static const struct of_device_id key_of_match[] __devinitdata={
         {.compatible="xlnx,gpio-keys",},
         {/*end of list*/},
};

這實(shí)際上定義了設(shè)備的匹配號，compatible就是在設(shè)備樹節(jié)點(diǎn)axi-gpio中對應(yīng)的節(jié)點(diǎn)匹配名稱。我們只要讓compitable和設(shè)備樹中對應(yīng)節(jié)點(diǎn)的值匹配上就可以將節(jié)點(diǎn)對應(yīng)的設(shè)備注冊到總線上了。

platform_driver用于對設(shè)備的搜索和配置，主要就是去解析設(shè)備樹，根據(jù)設(shè)備樹中節(jié)點(diǎn)信息來填充設(shè)備結(jié)構(gòu)體對應(yīng)信息或者直接對設(shè)備完成配置。

static struct platform_driver key_driver={
         .driver={
                   .name=DRIVER_NAME,
                   .owner=THIS_MODULE,
                   .of_match_table=key_of_match,
         },
         .probe=key_probe,
         .remove=key_remove,
};

我們主要關(guān)注其三個(gè)變量，of_match_table就是of_device_id結(jié)構(gòu)體定義的，用來匹配節(jié)點(diǎn)。Probe函數(shù)用來解析節(jié)點(diǎn)，配置設(shè)備。Remove主要是釋放在probe中使用的資源等。

編寫key驅(qū)動(dòng)主要就是去填充probe和remove兩個(gè)函數(shù)。

來看probe函數(shù)是如何查找到設(shè)備的一些屬性的，比如我們要確定key鍵的數(shù)量，那么我們可以這樣來做：

         if(of_property_read_u32(node, "xlnx,gpio-width", &width)){
                   printk(KERN_ERR "get the gpio-width
");
         }

通過匹配“xlnx,gpio-width”來獲得key的位寬，這個(gè)屬性就在設(shè)備中定義的。

如果我們要操作key，需要獲得key設(shè)備的內(nèi)存映射空間，這個(gè)可以通過函數(shù)platform_get_resource函數(shù)來完成。

mem=platform_get_resource(pdev, IORESOURCE_MEM, 0);
         if(!mem){
                   printk(KERN_ERR "get memory resource
");
                   return -ENODEV;
         }

第一個(gè)參數(shù)pdev是platform_device結(jié)構(gòu)體，在進(jìn)入probe函數(shù)之前就已經(jīng)被注冊了，其指向的就是key對應(yīng)的設(shè)備。第二個(gè)參數(shù)是類型，主要有IORESOURCE_MEM, IORESOURCE_IRQ等。最后一個(gè)參數(shù)是號碼，指示platform_device結(jié)構(gòu)體中不同的資源類型，即IORESOURCE類型。

以上獲得的mem就是在設(shè)備樹中由reg指定的內(nèi)存映射：

reg = <0x41210000 0x10000>;

中斷的獲得可以通過函數(shù)：

       r_irq=irq_of_parse_and_map(node, 0);
         if(!r_irq){
                   printk(KERN_ERR "get interrupt
");
         }

其中device_node就是設(shè)備節(jié)點(diǎn)，在platform_device注冊的時(shí)候，含有該節(jié)點(diǎn)，所以可以通過該結(jié)構(gòu)體獲得。第二個(gè)參數(shù)表示一個(gè)設(shè)備樹節(jié)點(diǎn)有多個(gè)中斷時(shí)的索引。

通過設(shè)備樹獲得了硬件信息后，我們將其填充到key_device中，key_device定義如下：

struct key_dev{
         struct cdev dev;
         struct work_struct work;                 
         int irq;
         int major;
         unsigned long start_addr;
         unsigned long size;
         void __iomem *baseaddr;
         int width;
         int inout;
         int key_prs;
        
};

其中irq為中斷號，cdev是字符設(shè)備結(jié)構(gòu)體，因?yàn)閗ey等屬于字符設(shè)備。填充如下：
lp->start_addr=mem->start;

         lp->size=mem->end-mem->start;
         lp->irq=r_irq;
         lp->width=width;

2）中斷處理

在platform中我們談到了對中斷號的獲取，那么取得了中斷號之后如何來檢測中斷事件呢？中斷處理過程可以被分成兩部分：頂半部和底半步。頂半部主要處理硬件上比較緊急的事物，比如檢測中斷，底半部用于處理中斷產(chǎn)生之后需要進(jìn)行的事務(wù)處理。在底半部處理過程中不會耽誤檢測下一個(gè)中斷。這兩個(gè)部分不是絕對的，也可以只有一個(gè)部分。

驅(qū)動(dòng)中首先需要定義一個(gè)中斷函數(shù)，用于中斷產(chǎn)生后進(jìn)行的操作。然后申請中斷，實(shí)現(xiàn)函數(shù)：

err=request_irq(k_dev->irq,key_interrupt, IRQF_SHARED|IRQF_TRIGGER_RISING, DRIVER_NAME, k_dev);

第一個(gè)是中斷號，第二個(gè)為中斷處理函數(shù)，第三個(gè)參數(shù)為中斷產(chǎn)生類型，上升沿下降沿一類，第四個(gè)為名字，可以命名中斷，最后一個(gè)是設(shè)備結(jié)構(gòu)體。

釋放中斷就通過free_irq(unsigned int irq, void *dev_id)來完成。

實(shí)現(xiàn)中斷底半部處理機(jī)制主要有tasklet，工作隊(duì)列，軟中斷和線程化irq。中斷機(jī)制較為復(fù)雜，任何一種機(jī)制都可以讓你竭盡腦汁。入門者還是循序漸進(jìn)，所以我也只用了一種簡單的方法。類似鎖機(jī)制，我們定義一個(gè)事件：

static DECLARE_WAIT_QUEUE_HEAD(press_queue);

然后在中斷函數(shù)中喚醒這個(gè)事件，在其他函數(shù)中可以通過等待這個(gè)事件來進(jìn)行中斷處理。我們的中斷函數(shù)為：

static irqreturn_t key_interrupt(int irq, void *dev_id){
         struct key_dev *dev=dev_id;
         dev->key_prs++;
         printk(KERN_INFO "interruptted
");
         wake_up_interruptible(&press_queue);
         return IRQ_HANDLED;
 
}

而等待該事件放在key_read函數(shù)中：

ssize_t key_read(struct file *filp, char __user *buf, size_t count, loff_t *fops)
{
         int err;
         struct key_dev *dev=filp->private_data;        
         wait_event_interruptible(press_queue, event_press);
         event_press=0;
         err=copy_to_user(buf, &dev->key_prs, count);
         return err ? -EFAULT : 0;
}

3）文件結(jié)構(gòu)

Linux一切皆文件，任何驅(qū)動(dòng)最終都被封裝為一個(gè)文件，用戶空間通過讀寫文件來操作驅(qū)動(dòng)。文件操作包括打開，關(guān)閉，讀和寫等。我們不做具體介紹，簡單列出文件結(jié)構(gòu)體為：

struct file_operations key_fops={
         .owner=THIS_MODULE,
         .open=key_open,
         .read=key_read,
         .release=key_close,
};

總結(jié)

對以上進(jìn)行總結(jié)就是：

1） 首先進(jìn)行設(shè)備樹節(jié)點(diǎn)屬性修改；

2） 填充platform框架下的probe，remove等函數(shù)，并定義of_device_id和platform_driver結(jié)構(gòu)體；

3） 申請中斷，釋放中斷，編寫中斷函數(shù)等；

4） 填充文件結(jié)構(gòu)，編寫open，close，read等函數(shù)；