Google 致力于为黑人社区推动种族平等。查看具体举措

其他资源

以下资源详细介绍了代码位置、工具、测试和许可信息。

可查询的代码位置

可查询的供应商接口对象的代码位于 system/libvintf(请参阅可查询的 API)。

手写清单文件和兼容性矩阵可能很难。您可以使用以下工具来生成样板清单/兼容性矩阵,从其入手。

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 对象会将系统清单、系统清单 Fragment、产品清单和产品清单 Fragment 结合为框架清单。如需了解详情,请参阅框架清单

示例:从变量生成框架兼容性矩阵 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 中定义模块。例如(针对产品 FCM,将 system_ext 替换为产品):
    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_IRassemble_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 或从 XML 反序列化对象。类似于 BSD 的许可证。
  • libselinux (external/selinux/libselinux) 用于获取 policydb 版本。公共网域许可证。
  • libz (external/zlib) 用于解压缩 /proc/config.gz。类似于 BSD 的许可证。
  • libvintf 项目使用 Apache 2.0 许可证(具有适当的 MODULE_LICENSE_APACHE2 和 NOTICE 文件)。