為驅動程式建立新的繫結程式庫

本指南會逐步說明在 Fuchsia SDK 開發環境 (使用 Bazel 建構系統)。

在 Fuchsia 驅動程式庫開發中,繫結程式庫可讓您輕鬆完成下列工作 座標:

Fuchsia SDK 包含一組繫結程式庫,可用來編寫繫結規則 吸引駕駛人注意不過,有時只使用現有的繫結程式庫。 足以為您的驅動程式庫編寫精確的建構規則。在這些情況下 您可能需要建立新的繫結程式庫,才能定義一組自訂的繫結 驅動程式庫及其目標節點的屬性。

本指南中的開發情境

新的繫結程式庫可供使用時,系統會有兩個群組, 工作上可能會對使用新的繫結程式庫 用於管理父項驅動程式,以及 是兒童驅動程式的基礎。

alt_text

圖 1:顯示父項與子項關係的節點拓撲 這種做法

圖 1 顯示具有兩個驅動程式的節點拓撲:parent-driverchild-driver。想像一下,有一群開發人員 編寫 Fuchsia 系統中內建 ACPI 裝置的驅動程式庫 (parent-driver); 有一組裝置開發人員正在為新的child-driver ACPI 裝置,目標節點為 bindlib-child

在這個情境中,會發生下列事件:

  1. 建立新的繫結程式庫:新的繫結程式庫稱為 ,藉此定義新的 ACPI 裝置的節點屬性。

  2. 讓兩個群組共用這個新的自訂繫結程式庫:

建立新的繫結程式庫

建立新的繫結程式庫,讓開發人員精確識別特定項目 並指定 Fuchsia 系統中的裝置。

如要建立新的繫結程式庫,請按照下列步驟操作:

  1. 編寫新的繫結程式庫
  2. 為新的繫結程式庫建立建構檔案

1. 編寫新的繫結程式庫

撰寫定義一組新自訂節點屬性的繫結程式庫。

新的繫結程式庫可能如下所示 (請參閱 testlibrary.bind 繫結程式庫範例lib 目錄中:

library examples.gizmo.bind;

// Include properties from other libraries
using fuchsia.acpi;

// Define new properties and values for this library
string ModelName;

enum GizmoType {
  MEM_64K,
  MEM_128K,
  MEM_256K,
};

// Extend values defined in other libraries
extend uint fuchsia.BIND_PCI_VID {
  GIZMOTRONICS = 0x314159,
};

這個新繫結程式庫的名稱定義於第一行 library fuchsia.examples.gizmo.bind;。另外也請注意 using fuchsia.acpi; 會建立 fuchsia.acpi 繫結的依附元件 。這項設定反映了實際的開發情況 這種情境通常需要使用兩種繫結程式庫:現有的程式庫 以及自訂程式庫

2. 為新的繫結程式庫建立建構檔案

為新的繫結程式庫建立建構檔案 (即 BUILD.bazel),以便 開發人員可以自動產生程式庫構件

下方的建構目標會定義新的 C++ 繫結程式庫,名為 範例繫結程式庫的 fuchsia.example.gizmo.bind BUILD.bazel 檔案:

# This is a bind library that we manually define.
fuchsia_bind_library(
    name = "examples.gizmo.bind",
    srcs = [
        "testlibrary.bind",
    ],
    visibility = ["//visibility:public"],
    deps = [
        "@fuchsia_sdk//bind/fuchsia.acpi",  # An SDK bind library.
    ],
)

# We have to create the C++ library for it manually as well.
fuchsia_bind_cc_library(
    name = "examples.gizmo.bind_cc",
    library = ":examples.gizmo.bind",
    visibility = ["//visibility:public"],
    # Has to have the C++ libraries of all the deps of the bind library.
    deps = [
        "@fuchsia_sdk//bind/fuchsia.acpi:fuchsia.acpi_cc",  # An SDK bind library's C++ lib.
    ],
)

建構 Kubernetes 物件時,系統會產生其中一個程式庫構件 fuchsia.example.gizmo.bind library 是下列 C++ 標頭檔案 (順帶一提,此範例並未包含在樣本中):

// Copyright 2022 The Fuchsia Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

// WARNING: This file is machine generated by bindc.

#ifndef BIND_FUCHSIA_EXAMPLES_GIZMO_BIND_BINDLIB_
#define BIND_FUCHSIA_EXAMPLES_GIZMO_BIND_BINDLIB_

#include <string>

#include <bind/fuchsia/acpi/cpp/bind.h>

namespace bind_fuchsia_examples_gizmo_bind {

static const std::string MODELNAME = "fuchsia.examples.gizmo.bind.ModelName";

static const std::string GIZMOTYPE = "fuchsia.examples.gizmo.bind.GizmoType";
static const std::string GIZMOTYPE_MEM_64K = "fuchsia.examples.gizmo.bind.GizmoType.MEM_64K";
static const std::string GIZMOTYPE_MEM_128K = "fuchsia.examples.gizmo.bind.GizmoType.MEM_128K";
static const std::string GIZMOTYPE_MEM_256K = "fuchsia.examples.gizmo.bind.GizmoType.MEM_256K";

static constexpr uint32_t BIND_PCI_VID_GIZMOTRONICS = 3227993;

}  // namespace bind_fuchsia_examples_gizmo_bind

#endif  // BIND_FUCHSIA_EXAMPLES_GIZMO_BIND_BINDLIB_

開發人員現在可以使用這個 C++ 標頭檔案中的節點屬性執行下列工作:

更新父項驅動程式的子節點

在 Fuchsia 中,部分驅動程式會建立子節點,讓其他驅動程式能夠繫結。可執行相關作業的驅動程式 建立子節點稱為父項驅動程式在使用新的繫結程式庫後,主要工作 更新父項驅動程式的子節點,讓其接收來自新的 繫結程式庫。

如要更新父項驅動程式的子節點,請按照下列步驟操作:

  1. 在建構檔案中新增繫結程式庫
  2. 將節點屬性指派給子節點

1. 在建構檔案中新增新的繫結程式庫

更新父項驅動程式庫的建構檔案,為新的繫結程式庫加入依附元件。

家長驅動程式的 BUILD.bazel 檔案會顯示 cc_binary 目標具備自訂繫結程式庫 fuchsia.example.gizmo.bind_cc 的依附元件:

fuchsia_cc_driver(
    name = "parent_driver",
    srcs = [
        "gizmo_server.h",
        "parent-driver.cc",
        "parent-driver.h",
    ],
    deps = [
        # This is a C++ lib from our manually created bind library.
        "//src/bind_library/lib:examples.gizmo.bind_cc",
        # This is a C++ lib from our manually created FIDL based bind library.
        "//src/bind_library/lib:examples.gizmo_bindlib_cc",
        "//src/bind_library/lib:examples.gizmo_cc",
        # This is a C++ lib from an SDK FIDL based bind library.
        "@fuchsia_sdk//fidl/fuchsia.device.fs:fuchsia.device.fs_bindlib_cc",
        "@fuchsia_sdk//pkg/driver_component_cpp",
    ],
)

請注意,依附元件前方會加上 //src/bind_library/lib (而非 @fuchsia_sdk//), 代表該函式來自範例中的本機目錄。

2. 將節點屬性指派給子節點

更新父項驅動程式庫的原始碼,以便新繫結中的特定節點屬性 再傳遞至子項節點

使用自動產生的 C++ 標頭檔案, parent-driver.cc 包含的新繫結程式庫,這個驅動程式庫現在可以讀取 從新的繫結程式庫匯入節點屬性:

#include <bind/examples/gizmo/bind/cpp/bind.h>
#include <bind/examples/gizmo/cpp/bind.h>
#include <bind/fuchsia/device/fs/cpp/bind.h>

...

properties[0] =
    fdf::MakeProperty(arena, 1 /* BIND_PROTOCOL */, bind_fuchsia_acpi::BIND_PROTOCOL_DEVICE);
properties[1] = fdf::MakeProperty(arena, bind_fuchsia_acpi::HID, "GOOG");
properties[2] = fdf::MakeProperty(arena, bind_examples_gizmo_bind::MODELNAME, "GIZMO3000");
properties[3] = fdf::MakeProperty(arena, bind_examples_gizmo_bind::GIZMOTYPE,
                                  bind_examples_gizmo_bind::GIZMOTYPE_MEM_64K);

請注意,bind_fuchsia_examples_gizmo_bind 命名空間中的部分字串變數 (請參閱自動產生的 C++ 標頭檔案) 用來初始化子節點的節點屬性。

更新子項驅動程式的繫結規則

繫結至現有驅動程式庫子節點的驅動程式稱為子項驅動程式庫。 使用新的繫結程式庫時,主要工作是更新子項驅動程式的繫結規則, 使用新繫結程式庫的節點屬性基礎目標是 精確地繫結驅動程式庫程式,確保其保證會與 Fuchsia 系統。

如要更新子項驅動程式的繫結規則,請按照下列步驟操作:

  1. 在建構檔案中新增繫結程式庫
  2. 使用新節點屬性寫入繫結規則

1. 在建構檔案中新增新的繫結程式庫

更新子項驅動程式庫的建構檔案,為新的繫結程式庫加入依附元件

子項驅動程式的 BUILD.bazel 檔案會顯示 fuchsia_driver_bytecode_bind_rules 目標具有自訂繫結程式庫的依附元件 fuchsia.example.gizmo.bind:

fuchsia_driver_bind_bytecode(
    name = "bind_bytecode",
    output = "child-driver.bindbc",
    rules = "child-driver.bind",
    deps = [
        # This bind library is one we created manually.
        "//src/bind_library/lib:examples.gizmo.bind",
        # This bind library is from a FIDL library that we created manually.
        "//src/bind_library/lib:examples.gizmo_bindlib",
        # This bind library is from an SDK FIDL library.
        "@fuchsia_sdk//fidl/fuchsia.device.fs:fuchsia.device.fs_bindlib",
    ],
)

請注意,依附元件前方會加上 //src/bind_library/lib (而非 @fuchsia_sdk//), 代表該函式來自範例中的本機目錄。

2. 使用新節點屬性寫入繫結規則

寫入 (或更新) 子項驅動程式的繫結規則,以使用新繫結程式庫中的節點屬性。

子項驅動程式的繫結規則 (child-driver.bind) 會顯示 ModelName 和自訂繫結程式庫 fuchsia.example.gizmo.bind 中的 GizmoType 屬性 以下規則可縮小驅動程式庫的目標裝置範圍:

using fuchsia.acpi;
using examples.gizmo.bind;

...

fuchsia.BIND_PROTOCOL == fuchsia.acpi.BIND_PROTOCOL.DEVICE;
fuchsia.acpi.hid == "GOOG";
examples.gizmo.bind.ModelName == "GIZMO3000";
examples.gizmo.bind.GizmoType == examples.gizmo.bind.GizmoType.MEM_64K;

如要進一步瞭解繫結規則,請參閱為驅動程式寫入繫結規則

附錄

來源與 SDK 的繫結程式庫程式碼產生差異

Bind 程式庫程式碼產生教學課程中大部分的概念和範例 轉換至 Fuchsia SDK 開發環境

不過,兩者的差異如下:

  • 無法在 SDK 中產生 Rust 目標。
  • C++ 程式庫的目標 cc_library:{target_name}_cc (而非 :{target_name}_cpp) 。
  • 您必須在以下位置新增 C++ 程式庫 fuchsia_bind_cc_library 的目標 如果 SDK 不包含繫結程式庫,請手動建立 BUILD.bazel