其他資源

下列資源詳細說明程式碼位置、工具、測試和授權。

可查詢的代碼位置

可查詢的供應商介面物件程式碼會前往 system/libvintf。

手寫資訊清單檔案和相容性矩陣可能很困難。使用下列工具產生樣板資訊清單/相容性矩陣，做為起點。

LSHAL

LSHAL 是裝置端工具，可列出裝置上所有已註冊的 HAL，以及所有可用的直通實作項目 (例如 hwservicemanager)。android.hardware.foo@1.0-impl.so您也可以根據清單產生裝置資訊清單檔案：

adb shell su 0 /system/bin/lshal --init-vintf

注意事項：

  1. 如果套件同時註冊至 hwservicemanager，且找到做為直通 HAL，則 <transport> 會設為 hwbinder。
  2. 資訊清單中未寫入任何 SELinux 版本。建議透過 assemble_vintf 插入元素，詳情請見下文。
  3. 產生的 HAL 資訊清單檔案可能不準確。如要修正裝置資訊清單與vendor.img實際提供的內容不一致的問題，需要人工介入。

ASSEMBLE_VINTF

assemble_vintf 是主機端工具，可執行下列操作：

  1. 驗證相容性矩陣或資訊清單檔案是否有效。
  2. 將變數插入建構時可用的資訊清單/相容性矩陣，並產生應安裝到裝置的新檔案。
  3. 檢查生成的檔案與雙重檔案是否相容。
  4. 如果提供資訊清單檔案，可選擇產生與資訊清單檔案相容的樣板相容性矩陣。

範例：從架構資訊清單檔案產生裝置相容性矩陣

assemble_vintf -m --hals-only \
    -i system/libhidl/manifest.xml \
    -o device/manufacturer/device_name/compatibility_matrix.xml

請注意，所有 HAL 都設為 optional="true"。

範例：從裝置資訊清單檔案產生架構相容性矩陣的骨架

assemble_vintf -m --hals-only \
    -i device/foo/bar/manifest.xml \
    -o path/to/place/output/compatibility_matrix.xml

請注意，所有 HAL 都設為 optional="true"。

範例：從變數產生裝置資訊清單 XML 檔案

在建構期間，如果 device/manufacturer/device_name/BoardConfig.mk 中定義了下列變數：

# Vendor manifest is named DEVICE_MANIFEST_FILE for legacy reasons.
DEVICE_MANIFEST_FILE := \
    device/manufacturer/device_name/vendor_manifest.xml
ODM_MANIFEST_FILES := \
    device/manufacturer/device_name/odm_manifest.xml
ODM_MANIFEST_SKUS := sku1 sku2
ODM_MANIFEST_SKU1_FILES := \
    device/manufacturer/device_name/odm_manifest_sku1.xml
ODM_MANIFEST_SKU2_FILES := \
    device/manufacturer/device_name/odm_manifest_sku2.xml

接著執行下列指令 (在建構系統中，經過修改以省略實作詳細資料)，產生裝置資訊清單 XML 檔案：

# vendor manifest; only when DEVICE_MANIFEST_FILE is set
BOARD_SEPOLICY_VERS=$(BOARD_SEPOLICY_VERS) assemble_vintf \
    $(addprefix,-i ,$(DEVICE_MANIFEST_FILE)) \
    -o $(TARGET_OUT_VENDOR)/etc/vintf/manifest.xml

# ODM manifests
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest.xml

# ODM manifests for each sku
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_SKU1_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest_sku1.xml
assemble_vintf \
    $(addprefix,-i ,$(ODM_MANIFEST_SKU2_FILES)) \
    -o $(TARGET_OUT_ODM)/etc/vintf/manifest_sku2.xml

在執行階段，VINTF 物件會將供應商資訊清單和 ODM 資訊清單合併為裝置資訊清單。詳情請參閱裝置資訊清單。

範例：從變數產生裝置相容性矩陣 XML 檔案

在建構期間，如果 device/manufacturer/device_name/BoardConfig.mk 中定義了下列變數：

# vendor compatibility matrix is named DEVICE_MATRIX_FILE for legacy reasons.
DEVICE_MATRIX_FILE := \
    device/manufacturer/device_name/vendor_compatibility_matrix.xml \
    device/manufacturer/device_name/vendor_compatibility_matrix_additional.xml

接著，系統會執行下列指令 (在建構系統中，經過修改以省略實作詳細資料)，產生裝置相容性矩陣 XML 檔案：

# vendor compatibility matrix; only when DEVICE_MATRIX_FILE is set
assemble_vintf \
    $(addprefix,-i ,$(DEVICE_MATRIX_FILE)) \
    -o $(TARGET_OUT_VENDOR)/etc/vintf/compatibility_matrix.xml

在執行階段，VINTF 物件會將供應商相容性矩陣做為裝置相容性矩陣。詳情請參閱「裝置相容性矩陣」。

範例：從變數產生框架資訊清單 XML 檔案

下列變數可在 device/manufacturer/device_name/BoardConfig.mk 中定義：

# Device-specific system manifest is named DEVICE_FRAMEWORK_MANIFEST_FILE for legacy reasons
DEVICE_FRAMEWORK_MANIFEST_FILE := \
    device/manufacturer/device_name/device_system_manifest.xml

# Product manifest
PRODUCT_MANIFEST_FILES := \
    device/manufacturer/device_name/product_manifest.xml

系統會執行下列指令 (在建構系統中修改，省略實作詳細資料)，產生架構資訊清單 XML 檔案：

# system manifest
assemble_vintf \
    -i system/libhidl/vintfdata/manifest.xml \
    $(addprefix,-i ,$(DEVICE_FRAMEWORK_MANIFEST_FILE)) \
    -o $(TARGET_OUT)/etc/vintf/manifest.xml

# product manifest
assemble_vintf \
    $(addprefix,-i ,$(PRODUCT_MANIFEST_FILES)) \
    -o $(TARGET_OUT_PRODUCT)/etc/vintf/manifest.xml

在執行階段，VINTF 物件會將系統資訊清單、系統資訊清單片段、產品資訊清單和產品資訊清單片段合併為架構資訊清單。詳情請參閱「架構資訊清單」。

範例：從變數產生架構相容性矩陣 XML 檔案

您可以在 device/manufacturer/device_name/BoardConfig.mk 中定義下列變數，以定義產品 FCM 和裝置專屬的系統 FCM：

DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE := \
    device/manufacturer/device_name/product_compatibility_matrix.xml
# Device-specific system compatibility matrix is named
# DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE for legacy reasons.
DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE := \
    device/manufacturer/device_name/device_system_compatibility_matrix.xml

system_ext FCM 必須與 Soong 模組一併安裝。產品 FCM 也可能與 Soong 模組一併安裝；如果使用這個方法，請勿定義 DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE。此外，Soong 模組可能會安裝多個產品 FCM 版本和 system_ext FCM 版本。定義下列項目：

  • 在 device/manufacturer/device_name/Android.bp 中定義模組。舉例來說 (將 system_ext 替換為產品 FCM 的產品)：
    vintf_compatibility_matrix {
    name: "system_ext_compatibility_matrix.xml",
    stem: "compatibility_matrix.xml",
    system_ext_specific: true,
    // product_specific: true, // for product FCM
    srcs: [
        "system_ext_compatibility_matrix.xml",
    ],
}
  • 將模組安裝至 device/manufacturer/device_name/device.mk。例如：
    PRODUCT_PACKAGES += system_ext_compatibility_matrix.xml

系統會執行下列指令 (在建構系統中，經過修改以省略實作詳細資料)，產生架構相容性矩陣 XML 檔案：

# common system compatibility matrix for each FCM version
BOARD_SEPOLICY_VERS=$(BOARD_SEPOLICY_VERS) \
POLICYVERS=$(POLICYVERS) \
BOARD_AVB_VBMETA_VERSION=$(BOARD_AVB_VBMETA_VERSION)
assemble_vintf \
    -i hardware/interfaces/compatibility_matrices/compatibility_matrix.empty.xml
    $(addprefix,-i ,$(DEVICE_FRAMEWORK_COMPATIBILITY_MATRIX_FILE)) \
    -o $(TARGET_OUT)/etc/vintf/compatibility_matrix.device.xml

# framework compatibility matrixes at each FCM version
assemble_vintf
    -i hardware/interfaces/compatibility_matrices/compatibility_matrix.{level}.xml \
    -o $(TARGET_OUT)/etc/vintf/compatibility_matrix.{level}.xml \
    --kernel=...

# product framework compatibility matrix; only when
# DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE is set or when the Soong module for
# product FCM is defined
assemble_vintf
    -i $(DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE)
    -o $(TARGET_OUT_PRODUCT)/etc/vintf/compatibility_matrix.xml

# system_ext framework compatibility matrix; only when the Soong module for
# system_ext FCM is defined
assemble_vintf
    -i <srcs for the soong module>
    -o $(TARGET_OUT_SYSTEM_EXT)/etc/vintf/compatibility_matrix.xml

在執行階段，VINTF 物件會合併部分系統相容性矩陣和產品相容性矩陣，做為架構相容性矩陣。詳情請參閱「架構相容性矩陣」。

範例： 從片段產生供應商資訊清單

在建構時間，可以將多個供應商資訊清單片段組合在一起。例如：

<!-- device/manufacturer/device_name/manifest_common.xml -->
<manifest version="1.0" type="device">
    <!-- common HALs here -->
</manifest>
 
<!-- device/manufacturer/device_name/ir.xml -->
<manifest version="1.0" type="device">
    <hal>
        <name>android.hardware.ir</name>
        <version>1.0</version>
        <!-- other fields -->
    </hal>
</manifest>
 
# device/manufacturer/device_name/BoardConfig.mk
DEVICE_MANIFEST_FILE := device/manufacturer/device_name/manifest_common.xml
ifdef BOARD_ENABLE_IR
    DEVICE_MANIFEST_FILE += device/manufacturer/device_name/ir.xml
endif

然後，如果定義了 assemble_vintf，assemble_vintf 會將 IR HAL 新增至供應商資訊清單，如果未定義 BOARD_ENABLE_IR，則會省略。BOARD_ENABLE_IR執行下列指令 (已修改，省略實作詳細資料)，即可產生供應商資訊清單：

# if BOARD_ENABLE_IR is defined
BOARD_SEPOLICY_VERS=10000.0 assemble_vintf \
    -i device/manufacturer/device_name/manifest_common.xml:device/manufacturer/device_name/ir.xml \
    -o $(TARGET_OUT_VENDOR)/manifest.xml

# if BOARD_ENABLE_IR is not defined
BOARD_SEPOLICY_VERS=10000.0 assemble_vintf \
    -i device/manufacturer/device_name/manifest_common.xml \
    -o $(TARGET_OUT_VENDOR)/manifest.xml

詳情請參閱：

assemble_vintf --help

測試

platform/system/libvintf 專案使用 GTest 進行序列化、還原序列化和相容性檢查。

授權

  • tinyxml2 (external/tinyxml2)，用於將物件序列化/還原序列化為 XML 或從 XML 序列化/還原序列化。類似 BSD 的授權。
  • libselinux (external/selinux/libselinux)，用於取得 policydb 版本。公有領域授權。
  • libz (外部/zlib) 解壓縮。/proc/config.gz類似 BSD 的授權。
  • libvintf 專案使用 Apache 2.0 授權 (附上適當的 MODULE_LICENSE_APACHE2 和 NOTICE 檔案)。