更多资源

以下资源提供了有关代码位置、工具、测试和许可的详细信息。

可查询的代码位置

可查询的供应商接口对象的代码位于 system/libvintf。

手写清单文件和兼容性矩阵可能很困难。使用以下工具生成样板清单/兼容性矩阵以开始使用。

LSHAL

LSHAL 是一种设备端工具，用于列出所有注册到 hwservicemanager 的 HAL 以及设备上所有可用的直通实现（例如 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

然后，如果定义了 BOARD_ENABLE_IR，则 assemble_vintf 会将 IR HAL 添加到供应商清单，如果未定义 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。类 BSD 许可。
  • libselinux (external/selinux/libselinux) 用于获取 policydb 版本。公共领域许可。
  • libz (external/zlib) 用于解压缩 /proc/config.gz。类 BSD 许可。
  • libvintf 项目使用 Apache 2.0 许可（带有相应的 MODULE_LICENSE_APACHE2 和 NOTICE 文件）。