本文档演示了如何构建驱动程序,并重点介绍了定义软件包、组件和驱动程序的最佳实践。
概念
驱动程序是一种组件,因此在继续深入之前,请务必了解如何构建组件。
驱动程序软件包 GN 模板
驱动程序作者应使用驱动程序专用 GN 模板。Fuchsia 定义了以下 GN 模板来定义驱动程序组件和驱动程序软件包:
以下是一个包含一个驱动程序组件的假设软件包:
import("//build/drivers.gni")
driver_bind_rules("bind") {
rules = "meta/driver.bind"
bind_output = "my-driver.bindbc"
}
fuchsia_cc_driver("driver") {
output_name = "my-driver"
sources = [ "my_driver.cc" ]
}
fuchsia_driver_component("component") {
component_name = "my-driver"
deps = [
":driver",
":bind",
]
}
fuchsia_driver_package("my_package") {
deps = [ ":component" ]
}
请注意以下详细信息:
* fuchsia_driver_component()
模板声明了该组件。
它依赖于驱动程序共享库 (fuchsia_cc_driver()
) 以及驱动程序的绑定规则 (driver_bind_rules()
)。
* fuchsia_driver_component()
会自动为驱动程序生成组件清单。我们将在后面的部分中了解其具体形式。
* 组件名称和软件包名称均派生自其目标名称。
在上面的示例中,这些名称组合在一起形成了用于启动组件的网址:fuchsia-pkg://fuchsia.com/my_package#meta/my_driver.cm
。
自动生成的组件清单是什么样的?
使用 fuchsia_driver_component
模板时,系统会自动为驱动程序生成组件清单。对于上述示例,代码如下
{
program: {
runner: 'driver',
binary: driver/my_driver.so,
bind: meta/bind/my_driver_bind.bindbc
}
}
请注意以下详细信息:
* binary
字段指向驱动程序共享库。
* bind
字段指向驱动程序的绑定规则文件。
我可以添加自己的组件清单吗?
没问题!如需编写自己的组件清单,只需将其作为文件添加到项目中,然后更新 fuchsia_driver_component
以指向该文件即可:
fuchsia_driver_component("component") {
component_name = "my-driver"
manifest = "meta/my-own-manifest.cml
deps = [
":driver",
":bind",
]
}
在 build 中添加驱动程序。
为了将驱动程序添加到 build 中,您需要将其放入两个特殊位置。
第一种是 //build/drivers/all_drivers_list.txt
。如果您不这样做,系统会显示构建错误来提醒您。all_drivers_list.txt
文件应包含 fuchsia 代码库中包含的所有驱动程序标签。此列表会及时更新,以便驱动程序框架团队确保所有驱动程序都继续获得支持和更新。
如果您的驱动程序只能针对 x64 构建,请将其添加到:
//build/drivers/all_drivers_lists_x64.txt
如果您的驱动程序只能针对 arm64 进行构建,请将其添加到:
//build/drivers/all_drivers_lists_arm64.txt
第二个地点是://bundles:drivers-build-only
。如果您忘记在此处添加驱动程序,也会出现构建错误。如需添加到此列表,您应确保将驱动程序组件添加到来源位置的本地驱动程序组。
例如,对于在 //src/ui/input/drivers
下添加的新驱动程序,您需要向 //src/ui/input:drivers
添加条目。
对于 drivers-build-only
目标,您需要确保添加的是 fuchsia_driver_components()
目标的路径,而不是直接指向 fuchsia_cc_driver()
目标。
在设备上添加驱动程序
如果您想在实际设备上添加驱动程序,有两种方法可供选择:您可以将驱动程序添加到 bootfs 中,也可以将其作为基本软件包添加。
在 bootfs 中添加驱动程序
您可以将驱动程序添加到 bootfs 中,具体取决于产品、开发板,或者仅考虑本地环境。您需要将 fuchsia_driver_component
目标的路径添加到以下三个位置之一:
- product:
//products
中相应.gni
文件中的product_bootfs_labels
- 白板:
//boards
中相关.gni
文件中的board_bootfs_labels
- 本地:
fx args
中的board_bootfs_labels
在基本软件包中添加驱动程序
您可以在基本软件包中添加驱动程序,具体取决于产品、开发板或本地环境。您需要将 fuchsia_package
目标的路径添加到以下三个位置之一:
- product:
//products
中相应.gni
文件中的product_driver_package_labels
- 板级:
//boards
中相应.gni
文件中的board_driver_package_labels
- 本地:
fx args
中的base_driver_package_labels