Documentation/translations/zh_TW/process/submitting-drivers.rst

   1 .. SPDX-License-Identifier: GPL-2.0
   2
   3 .. _tw_submittingdrivers:
   4
   5 .. include:: ../disclaimer-zh_TW.rst
   6
   7 :Original: :ref:`Documentation/process/submitting-drivers.rst
   8            <submittingdrivers>`
   9
  10 如果想評論或更新本文的內容，請直接聯繫原文檔的維護者。如果你使用英文
  11 交流有困難的話，也可以向中文版維護者求助。如果本翻譯更新不及時或者翻
  12 譯存在問題，請聯繫中文版維護者::
  13
  14         中文版維護者： 李陽  Li Yang <leoyang.li@nxp.com>
  15         中文版翻譯者： 李陽  Li Yang <leoyang.li@nxp.com>
  16         中文版校譯者： 陳琦 Maggie Chen <chenqi@beyondsoft.com>
  17                        王聰 Wang Cong <xiyou.wangcong@gmail.com>
  18                        張巍 Zhang Wei <wezhang@outlook.com>
  19                        胡皓文 Hu Haowen <src.res@email.cn>
  20
  21 如何向 Linux 內核提交驅動程序
  22 =============================
  23
  24 這篇文檔將會解釋如何向不同的內核源碼樹提交設備驅動程序。請注意，如果你感
  25 興趣的是顯卡驅動程序，你也許應該訪問 XFree86 項目(https://www.xfree86.org/)
  26 和／或 X.org 項目 (https://x.org)。
  27
  28 另請參閱 Documentation/translations/zh_TW/process/submitting-patches.rst 文檔。
  29
  30
  31 分配設備號
  32 ----------
  33
  34 塊設備和字符設備的主設備號與從設備號是由 Linux 命名編號分配權威 LANANA（
  35 現在是 Torben Mathiasen）負責分配。申請的網址是 https://www.lanana.org/。
  36 即使不準備提交到主流內核的設備驅動也需要在這裡分配設備號。有關詳細信息，
  37 請參閱 Documentation/admin-guide/devices.rst。
  38
  39 如果你使用的不是已經分配的設備號，那麼當你提交設備驅動的時候，它將會被強
  40 制分配一個新的設備號，即便這個設備號和你之前發給客戶的截然不同。
  41
  42 設備驅動的提交對象
  43 ------------------
  44
  45 Linux 2.0:
  46         此內核源碼樹不接受新的驅動程序。
  47
  48 Linux 2.2:
  49         此內核源碼樹不接受新的驅動程序。
  50
  51 Linux 2.4:
  52         如果所屬的代碼領域在內核的 MAINTAINERS 文件中列有一個總維護者，
  53         那麼請將驅動程序提交給他。如果此維護者沒有回應或者你找不到恰當的
  54         維護者，那麼請聯繫 Willy Tarreau <w@1wt.eu>。
  55
  56 Linux 2.6:
  57         除了遵循和 2.4 版內核同樣的規則外，你還需要在 linux-kernel 郵件
  58         列表上跟蹤最新的 API 變化。向 Linux 2.6 內核提交驅動的頂級聯繫人
  59         是 Andrew Morton <akpm@linux-foundation.org>。
  60
  61 決定設備驅動能否被接受的條件
  62 ----------------------------
  63
  64 許可：               代碼必須使用 GNU 通用公開許可證 (GPL) 提交給 Linux，但是
  65                 我們並不要求 GPL 是唯一的許可。你或許會希望同時使用多種
  66                 許可證發布，如果希望驅動程序可以被其他開源社區（比如BSD）
  67                 使用。請參考 include/linux/module.h 文件中所列出的可被
  68                 接受共存的許可。
  69
  70 版權：               版權所有者必須同意使用 GPL 許可。最好提交者和版權所有者
  71                 是相同個人或實體。否則，必需列出授權使用 GPL 的版權所有
  72                 人或實體，以備驗證之需。
  73
  74 接口：               如果你的驅動程序使用現成的接口並且和其他同類的驅動程序行
  75                 爲相似，而不是去發明無謂的新接口，那麼它將會更容易被接受。
  76                 如果你需要一個 Linux 和 NT 的通用驅動接口，那麼請在用
  77                 戶空間實現它。
  78
  79 代碼：               請使用 Documentation/process/coding-style.rst 中所描述的 Linux 代碼風
  80                 格。如果你的某些代碼段（例如那些與 Windows 驅動程序包共
  81                 享的代碼段）需要使用其他格式，而你卻只希望維護一份代碼，
  82                 那麼請將它們很好地區分出來，並且註明原因。
  83
  84 可移植性： 請注意，指針並不永遠是 32 位的，不是所有的計算機都使用小
  85                 尾模式 (little endian) 存儲數據，不是所有的人都擁有浮點
  86                 單元，不要隨便在你的驅動程序里嵌入 x86 彙編指令。只能在
  87                 x86 上運行的驅動程序一般是不受歡迎的。雖然你可能只有 x86
  88                 硬體，很難測試驅動程序在其他平台上是否可用，但是確保代碼
  89                 可以被輕鬆地移植卻是很簡單的。
  90
  91 清晰度：    做到所有人都能修補這個驅動程序將會很有好處，因爲這樣你將
  92                 會直接收到修復的補丁而不是 bug 報告。如果你提交一個試圖
  93                 隱藏硬體工作機理的驅動程序，那麼它將會被扔進廢紙簍。
  94
  95 電源管理： 因爲 Linux 正在被很多行動裝置和桌面系統使用，所以你的驅
  96                 動程序也很有可能被使用在這些設備上。它應該支持最基本的電
  97                 源管理，即在需要的情況下實現系統級休眠和喚醒要用到的
  98                 .suspend 和 .resume 函數。你應該檢查你的驅動程序是否能正
  99                 確地處理休眠與喚醒，如果實在無法確認，請至少把 .suspend
 100                 函數定義成返回 -ENOSYS（功能未實現）錯誤。你還應該嘗試確
 101                 保你的驅動在什麼都不乾的情況下將耗電降到最低。要獲得驅動
 102                 程序測試的指導，請參閱
 103                 Documentation/power/drivers-testing.rst。有關驅動程序電
 104                 源管理問題相對全面的概述，請參閱
 105                 Documentation/driver-api/pm/devices.rst。
 106
 107 管理：               如果一個驅動程序的作者還在進行有效的維護，那麼通常除了那
 108                 些明顯正確且不需要任何檢查的補丁以外，其他所有的補丁都會
 109                 被轉發給作者。如果你希望成爲驅動程序的聯繫人和更新者，最
 110                 好在代碼注釋中寫明並且在 MAINTAINERS 文件中加入這個驅動
 111                 程序的條目。
 112
 113 不影響設備驅動能否被接受的條件
 114 ------------------------------
 115
 116 供應商：    由硬體供應商來維護驅動程序通常是一件好事。不過，如果源碼
 117                 樹里已經有其他人提供了可穩定工作的驅動程序，那麼請不要期
 118                 望「我是供應商」會成爲內核改用你的驅動程序的理由。理想的情
 119                 況是：供應商與現有驅動程序的作者合作，構建一個統一完美的
 120                 驅動程序。
 121
 122 作者：               驅動程序是由大的 Linux 公司研發還是由你個人編寫，並不影
 123                 響其是否能被內核接受。沒有人對內核源碼樹享有特權。只要你
 124                 充分了解內核社區，你就會發現這一點。
 125
 126
 127 資源列表
 128 --------
 129
 130 Linux 內核主源碼樹：
 131         ftp.??.kernel.org:/pub/linux/kernel/...
 132         ?? == 你的國家代碼，例如 "cn"、"us"、"uk"、"fr" 等等
 133
 134 Linux 內核郵件列表：
 135         linux-kernel@vger.kernel.org
 136         [可通過向majordomo@vger.kernel.org發郵件來訂閱]
 137
 138 Linux 設備驅動程序，第三版（探討 2.6.10 版內核）：
 139         https://lwn.net/Kernel/LDD3/ （免費版）
 140
 141 LWN.net:
 142         每周內核開發活動摘要 - https://lwn.net/
 143
 144         2.6 版中 API 的變更：
 145
 146                 https://lwn.net/Articles/2.6-kernel-api/
 147
 148         將舊版內核的驅動程序移植到 2.6 版：
 149
 150                 https://lwn.net/Articles/driver-porting/
 151
 152 內核新手(KernelNewbies):
 153         爲新的內核開發者提供文檔和幫助
 154         https://kernelnewbies.org/
 155
 156 Linux USB項目：
 157         http://www.linux-usb.org/
 158
 159 寫內核驅動的「不要」（Arjan van de Ven著）:
 160         http://www.fenrus.org/how-to-not-write-a-device-driver-paper.pdf
 161
 162 內核清潔工 (Kernel Janitor):
 163         https://kernelnewbies.org/KernelJanitors
 164