{
 "byKey": {
  "cover": [
   {"say": "大家好,歡迎回到嵌入式 Linux 課。這一章我們要親手處理 kernel:先看原始碼的結構和設定方式,再把它編譯出來,然後學寫核心模組,最後看驅動程式是怎麼跟裝置樹配對的。", "item": 0}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#1": [
   {"say": "第一步,先把 kernel 的原始碼拿到手。", "item": 0},
   {"say": "Linux kernel 的原始碼,可以到 kernel 點 org 下載穩定版的壓縮檔,也可以用 git 取得。", "item": 1},
   {"say": "另外,板子的廠商常常會提供自己的 kernel 分支,裡面有那塊板子的驅動和裝置樹,例如 Raspberry Pi 就有自己的 Linux 分支。", "item": 2},
   {"say": "原則是,能用上游,也就是 mainline 的版本,就用上游。廠商的分支改動比較多,不過硬體支援是最完整的。", "item": 2}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#2": [
   {"say": "用 git 取得的指令長這樣。", "item": 0},
   {"say": "這一行是 git clone,加上 depth 一的選項,只抓最新的那一層歷史,再用 branch 指定版本標籤,最後是穩定版原始碼庫的網址。", "item": 1},
   {"say": "提醒一下,畫面上的版本標籤只是範例,請選你要用的長期支援版本。而 depth 一這個選項,可以省下很多下載量。", "item": 2}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#3": [
   {"say": "原始碼抓下來之後,目錄非常多,我們快速認識幾個重要的。", "item": 0},
   {"say": "arch 目錄放的是各種 C P U 架構的程式碼,像 arm、arm 六十四、RISC five、X 八六。各架構的預設設定檔和裝置樹原始檔,也都在這裡面。", "item": 1},
   {"say": "drivers 是驅動程式,G P I O、I 平方 C、S P I、序列埠、記憶卡、網路,通通在這裡。", "item": 2},
   {"say": "F S 是檔案系統,像 E X T 四、squash F S、overlay F S。", "item": 3}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#4": [
   {"say": "繼續往下看。", "item": 0},
   {"say": "kernel 和 M M 這兩個目錄是核心的本體,負責排程和記憶體管理。", "item": 1},
   {"say": "net 是網路協定。", "item": 2},
   {"say": "include 放的是標頭檔。", "item": 3},
   {"say": "Documentation 是文件。裡面有一個很實用的地方,是 device tree 底下的 bindings,說明每一種裝置在裝置樹裡該寫哪些屬性。", "item": 4},
   {"say": "scripts 放的是建置用的腳本,像 menuconfig 和 D T C 都在這裡。", "item": 5}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#5": [
   {"say": "最後一個。", "item": 0},
   {"say": "最上層有一個叫 Kconfig 的檔案,它是整個設定選單的根。接下來我們就來談 Kconfig。", "item": 1}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#6": [
   {"say": "Kernel 有好幾千個可以選擇的功能。每個目錄裡的 Kconfig 檔,宣告了選項、相依關係和說明。而你的選擇,會存在根目錄一個叫做點 config 的文字檔裡。每個選項有幾種可能的值。", "item": 0},
   {"say": "等於 Y,代表編譯進 kernel 映像檔裡面,也叫 built in。", "item": 1},
   {"say": "等於 M,代表編成可以載入的模組,副檔名是點 K O。", "item": 2},
   {"say": "如果是一行井字號開頭的註解,寫著某個選項 is not set,就是沒有啟用。", "item": 3},
   {"say": "選項的值也可以是字串或數字,例如設定本地版本字串。要記得,點 config 不要手動亂改,因為相依關係很複雜,應該透過 make 的設定目標來修改。", "item": 4}
  ],
  "Kernel 原始碼結構與 Kconfig 設定#7": [
   {"say": "看一小段點 config 的內容。", "item": 0},
   {"say": "第一行,G P I O 的 sysfs 介面設成 Y,會直接編進 kernel。", "item": 1},
   {"say": "第二行,I 平方 C 的字元裝置設成 M,會編成模組。", "item": 2},
   {"say": "第三行是註解的形式,表示藍牙沒有啟用。", "item": 3}
  ],
  "編譯 Kernel 與產出檔案#1": [
   {"say": "接下來要編譯了。動手之前,先把建置需要的套件裝好。", "item": 0},
   {"say": "在 Debian 或 Ubuntu 上,通常需要安裝一些套件。", "item": 1},
   {"say": "實際上缺什麼,編譯的時候會提示你。最常見的錯誤來源,是少了 bison、flex,或是 lib S S L。", "item": 2},
   {"say": "畫面上這一行用 A P T 一次裝齊:基本的建置工具、B C、bison、flex、幾個開發用的函式庫,還有 ARM 六十四的交叉編譯器。", "item": 3}
  ],
  "編譯 Kernel 與產出檔案#2": [
   {"say": "我們以 QEMU 的 virt 機型為目標,編譯 ARM 六十四的 kernel。指令下一張會看到,先講三個重點。", "item": 0},
   {"say": "第一,先用 export 把架構和交叉編譯器前綴設成環境變數,之後每次下 make,就不用重複輸入了。", "item": 1},
   {"say": "第二,make 後面的減號 J,搭配 N proc 取得的核心數,會依照 C P U 核心數平行編譯。全部重編一次,通常要幾分鐘到幾十分鐘。", "item": 2},
   {"say": "第三,最後指定的三個目標。Image 是 ARM 六十四的 kernel 映像檔,D T B S 是所有的裝置樹,modules 是所有設成 M 的驅動。", "item": 3}
  ],
  "編譯 Kernel 與產出檔案#3": [
   {"say": "實際的步驟是這樣。", "item": 0},
   {"say": "先 C D 進到 Linux 原始碼的目錄。", "item": 1},
   {"say": "export ARCH,設成 arm 六十四。", "item": 2},
   {"say": "export CROSS COMPILE,設成 A arch 六十四的工具鏈前綴。", "item": 3},
   {"say": "執行 make defconfig,產生這個架構的預設設定。", "item": 4},
   {"say": "最後 make,平行編譯 Image、modules 和 D T B S。", "item": 5}
  ],
  "編譯 Kernel 與產出檔案#4": [
   {"say": "如果目標是三十二位元的 ARM,步驟幾乎一樣。", "item": 0},
   {"say": "ARCH 改成 arm。", "item": 1},
   {"say": "交叉編譯器的前綴,換成三十二位元、硬體浮點的那一組。", "item": 2},
   {"say": "預設設定改用 multi V 七 defconfig。", "item": 3},
   {"say": "編譯的目標,把 Image 換成 Z Image。因為三十二位元 ARM 的映像檔,是會自己解壓縮的 Z Image。", "item": 4}
  ],
  "編譯 Kernel 與產出檔案#5": [
   {"say": "編完之後,產出的檔案在哪裡呢?下一張會列出來。", "item": 0},
   {"say": "使用的方式很簡單:把 Image 和對應的 D T B,複製到開機分區,或是 T F T P 的目錄,就可以用了。", "item": 1}
  ],
  "編譯 Kernel 與產出檔案#6": [
   {"say": "我們看輸出的檔案。", "item": 0},
   {"say": "arch、arm 六十四、boot 底下的 Image,是沒有壓縮的 kernel 映像檔。", "item": 1},
   {"say": "同一個目錄的 Image 點 G Z,是壓縮過的版本。", "item": 2},
   {"say": "裝置樹在 boot 底下的 D T S 目錄,各家廠商的資料夾裡,副檔名是點 D T B。", "item": 3},
   {"say": "原始碼最上層的 V M Linux,是包含符號的 E L F 檔,除錯的時候用。它很大,不是拿來開機的。", "item": 4}
  ],
  "編譯 Kernel 與產出檔案#7": [
   {"say": "還有兩個。", "item": 0},
   {"say": "System 點 map 是符號和位址的對照表。", "item": 1},
   {"say": "如果你編的是三十二位元的 ARM,映像檔會在 arch、arm、boot 底下,名字是 Z Image。", "item": 2}
  ],
  "撰寫與載入核心模組#1": [
   {"say": "Kernel 編好了,接下來學怎麼寫核心模組。先問,為什麼要用模組?", "item": 0},
   {"say": "核心模組的副檔名是點 K O,它是可以在系統執行的時候載入和卸載的核心程式碼。", "item": 1},
   {"say": "好處是,不必重編整個 kernel 就能測試新的驅動,而且可以需要時才載入,節省記憶體。缺點是,它載入的時機比開機初期晚,而且必須和 kernel 的版本、設定嚴格匹配。", "item": 1}
  ],
  "撰寫與載入核心模組#2": [
   {"say": "我們來寫一個最小的 Hello 模組,檔名是 hello 點 C。完整的程式碼等一下會分段看,先講三個重點。", "item": 0},
   {"say": "第一,module init 和 module exit 這兩個巨集,用來註冊模組載入時、和卸載時要呼叫的函式。", "item": 1},
   {"say": "第二,P R info 是 print K 的分級包裝,訊息會輸出到核心的日誌緩衝區,要用 D mesg 才看得到。", "item": 2},
   {"say": "第三,MODULE LICENSE 這一行一定要寫,而且通常寫 G P L。如果不是 G P L 相容的授權,核心會被標記成 tainted,也沒辦法使用 G P L 專屬的符號。", "item": 3}
  ],
  "撰寫與載入核心模組#3": [
   {"say": "來看程式碼的第一段。", "item": 0},
   {"say": "開頭引入三個標頭檔,第一個是 init。", "item": 1},
   {"say": "第二個是 kernel。", "item": 2},
   {"say": "第三個是 module。寫模組幾乎都會用到這三個。", "item": 3},
   {"say": "接著是初始化函式 hello init,它前面有一個 init 的標記。", "item": 4},
   {"say": "函式的內容很單純:用 P R info 印出一行 module loaded,然後回傳零,代表成功。", "item": 5}
  ],
  "撰寫與載入核心模組#4": [
   {"say": "第二段。", "item": 0},
   {"say": "右大括號,結束初始化函式。", "item": 1},
   {"say": "接著是離開函式 hello exit,前面有 exit 的標記,而且它沒有回傳值。", "item": 2},
   {"say": "裡面同樣用 P R info 印出一行,module unloaded。", "item": 3}
  ],
  "撰寫與載入核心模組#5": [
   {"say": "第三段。", "item": 0},
   {"say": "結束離開函式。", "item": 1},
   {"say": "用 module init,把 hello init 註冊成載入時要呼叫的函式。", "item": 2},
   {"say": "用 module exit,把 hello exit 註冊成卸載時要呼叫的函式。", "item": 3},
   {"say": "然後宣告授權是 G P L。", "item": 4}
  ],
  "撰寫與載入核心模組#6": [
   {"say": "最後一段。", "item": 0},
   {"say": "MODULE AUTHOR 寫的是作者的名字。", "item": 1},
   {"say": "MODULE DESCRIPTION 是這個模組的簡短描述。這兩行是模組的說明資訊。", "item": 2}
  ],
  "撰寫與載入核心模組#7": [
   {"say": "程式寫好了,還需要一個 Makefile 來編譯。這種不放在 kernel 原始碼樹裡面的模組,叫做 out of tree 模組。Makefile 的開頭,用 O B J 減號 M 列出要編成模組的目標,再用 K DIR 指定 kernel 建置目錄的位置。", "item": 0},
   {"say": "all 這個規則的意思是:切換到 kernel 的建置目錄去執行 make,並且用 M 這個參數,告訴 kernel 的建置系統,你的模組原始碼在哪裡。", "item": 1},
   {"say": "clean 規則也是同樣的寫法,只是目標換成 clean。要特別注意,規則底下的命令行,一定要用 Tab 字元來縮排,不能用空白,這是初學者很常踩到的地方。", "item": 2}
  ],
  "驅動程式如何與裝置樹配對#1": [
   {"say": "最後一個單元,我們從模組走到真正的驅動程式。", "item": 0},
   {"say": "剛剛的 Hello 模組,只是在載入的時候印一行字。真正的驅動程式要管理硬體:它要綁定到某一個裝置、取得暫存器位址和中斷,還要提供介面給使用者空間。", "item": 1},
   {"say": "在使用裝置樹的系統裡,這個流程叫做配對與探測,英文是 match 和 probe。", "item": 1}
  ],
  "驅動程式如何與裝置樹配對#2": [
   {"say": "我們用 platform driver 的最小骨架來說明。這是一個簡化的範例,實際的 A P I 細節會隨 kernel 版本而不同,動手寫之前,請對照你所用版本的文件。先講四個重點。", "item": 0},
   {"say": "第一,O F device I D 這張表,列出這個驅動支援哪些 compatible 字串。表的最後要放一筆空的項目,當作結尾的標記。", "item": 1},
   {"say": "第二,module platform driver 這個巨集,會自動幫你產生註冊和反註冊用的 init 和 exit 函式。", "item": 2},
   {"say": "第三,kernel 解析裝置樹的時候,會替每一個狀態是 okay 的節點建立一個 platform device。如果它的 compatible 和某個驅動相符,就會呼叫那個驅動的 probe 函式。", "item": 3},
   {"say": "第四,在 probe 裡面,可以用 O F property read 系列的函式讀取節點的屬性。而 dev info 這類函式印訊息的時候,會自動加上裝置名稱當前綴。", "item": 4}
  ],
  "驅動程式如何與裝置樹配對#3": [
   {"say": "來看程式碼。", "item": 0},
   {"say": "開頭引入 module 的標頭檔。", "item": 1},
   {"say": "再引入 platform device 的標頭檔。", "item": 2},
   {"say": "還有處理裝置樹用的 O F 標頭檔。", "item": 3},
   {"say": "接著是 probe 函式,名字叫 demo probe,參數是一個指向 platform device 的指標。", "item": 4}
  ],
  "驅動程式如何與裝置樹配對#4": [
   {"say": "繼續看 probe 的內容。", "item": 0},
   {"say": "函式裡面,先從裝置樹節點讀出一個自訂的屬性,代表閃爍的毫秒數。", "item": 1},
   {"say": "然後用 dev info 把讀到的值印出來,回傳零,函式結束。", "item": 2},
   {"say": "接下來宣告配對表,也就是 O F device I D 的陣列。裡面第一筆寫 compatible 字串,第二筆是空的結尾標記。", "item": 3}
  ],
  "驅動程式如何與裝置樹配對#5": [
   {"say": "配對表結束之後。", "item": 0},
   {"say": "用右大括號加分號收尾。", "item": 1},
   {"say": "再用 MODULE DEVICE TABLE 這個巨集,把這張表匯出。", "item": 2}
  ],
  "驅動程式如何與裝置樹配對#6": [
   {"say": "然後是驅動本體。", "item": 0},
   {"say": "宣告一個 platform driver 的結構,在裡面填入 probe 函式、驅動的名稱,還有剛剛那張配對表。", "item": 1},
   {"say": "結構結束。", "item": 2},
   {"say": "最後用 module platform driver 巨集,把這個驅動註冊進去。", "item": 3}
  ],
  "驅動程式如何與裝置樹配對#7": [
   {"say": "程式的結尾,和對應的裝置樹。", "item": 0},
   {"say": "一樣要宣告授權是 G P L。", "item": 1},
   {"say": "下面是對應的裝置樹節點。它的 compatible 字串,和驅動配對表裡寫的一模一樣,所以兩邊就配對起來了。節點裡還有那個閃爍毫秒數的自訂屬性,值是五百,status 是 okay。", "item": 2},
   {"say": "提醒一下,自訂屬性建議加上廠商的前綴,避免和標準屬性衝突。正式的驅動,還需要另外寫 binding 文件。", "item": 3}
  ],
  "closing": [
   {"say": "這一章就先到這裡。你已經知道 kernel 原始碼的結構、怎麼用 Kconfig 設定和編譯、怎麼寫一個最小的核心模組,也了解驅動是靠 compatible 字串和裝置樹配對的。", "item": 0},
   {"say": "接下來,請動手做本章的練習,再完成章末小測驗,檢查自己學會了多少。我們下一章見!", "item": 1, "pause": 1}
  ]
 }
}
