Outros recursos

Os recursos a seguir fornecem detalhes sobre locais, ferramentas, testes e licenciamento de código.

Local do código pesquisável

O código do objeto de interface do fornecedor pesquisável vai para system/libvintf.

Escrever arquivos de manifesto e matrizes de compatibilidade pode ser difícil. Use as ferramentas a seguir para gerar uma matriz de compatibilidade/modelo de manifesto inicial.

LSHAL

O LSHAL é uma ferramenta do dispositivo que lista todos os HALs registrados para hwservicemanager e todas as implementações de passagem disponíveis (por exemplo, android.hardware.foo@1.0-impl.so) no dispositivo. Ele também pode gerar um arquivo de manifesto do dispositivo com base na lista:

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

Observe o seguinte:

  1. Se um pacote for registrado em hwservicemanager e encontrado como um HAL de passagem, <transport> será definido como hwbinder.
  2. Nenhuma versão do SELinux é gravada no manifesto. É recomendável que o elemento seja injetado por assemble_vintf, conforme explicado abaixo.
  3. O arquivo de manifesto HAL gerado pode estar impreciso. É necessária a atenção humana para corrigir inconsistências entre o manifesto do dispositivo e o que vendor.img realmente fornece.

ASSEMBLE_VINTF

O assemble_vintf é uma ferramenta do host que:

  1. Verifica se uma matriz de compatibilidade ou um arquivo de manifesto é válido.
  2. Injeta variáveis em matrizes de compatibilidade/manifestos disponíveis no momento do build e gera um novo arquivo que precisa ser instalado no dispositivo.
  3. Verifica a compatibilidade entre o arquivo gerado e o arquivo duplo.
  4. Se um arquivo de manifesto for fornecido, opcionalmente gera uma matriz de compatibilidade padrão compatível com o arquivo de manifesto.

Exemplo:gerar uma matriz de compatibilidade de dispositivos a partir de um arquivo de manifesto de framework

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

Todos os HALs são definidos como optional="true".

Exemplo:gerar uma matriz de compatibilidade de framework esquelético a partir de um arquivo de manifesto do dispositivo

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

Todos os HALs são definidos como optional="true".

Exemplo:gerar arquivos XML de manifesto do dispositivo usando variáveis

No momento do build, se as seguintes variáveis forem definidas em 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

Em seguida, os comandos a seguir são executados (no sistema de build, modificados para omitir detalhes de implementação) para gerar arquivos XML de manifesto do dispositivo:

# 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

No momento da execução, o objeto VINTF combina manifestos do fornecedor e manifestos do ODM como o manifesto do dispositivo. Consulte o manifesto do dispositivo para mais detalhes.

Exemplo:gerar arquivos XML de matriz de compatibilidade de dispositivos usando variáveis

No momento do build, se as seguintes variáveis forem definidas em 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

Em seguida, os comandos abaixo são executados (no sistema de build, modificados para omitir detalhes de implementação) para gerar arquivos XML de matriz de compatibilidade de dispositivos:

# 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

No momento da execução, o objeto VINTF usa a matriz de compatibilidade do fornecedor como a matriz de compatibilidade do dispositivo. Consulte a Matriz de compatibilidade de dispositivos para mais detalhes.

Exemplo:gerar arquivos XML de manifesto de framework usando variáveis

As variáveis a seguir podem ser definidas em 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

Os comandos abaixo são executados (no sistema de build, modificados para omitir detalhes de implementação) para gerar arquivos XML de manifesto de framework:

# 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

No momento da execução, o objeto VINTF combina o manifesto do sistema, os fragmentos do manifesto do sistema, o manifesto do produto e os fragmentos do manifesto do produto como o manifesto do framework. Consulte o manifesto do framework para mais detalhes.

Exemplo:gerar arquivos XML de matriz de compatibilidade do framework usando variáveis

As variáveis a seguir podem ser definidas em device/manufacturer/device_name/BoardConfig.mk para definir o FCM do produto e o FCM do sistema específico do dispositivo:

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

O FCM system_ext precisa ser instalado com os módulos Soong. O FCM do produto também pode ser instalado com módulos Soong. Não defina DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE se esse método for usado. Além disso, várias versões do FCM do produto e do system_ext podem ser instaladas com módulos Soong. Defina o seguinte:

  • Defina um módulo em device/manufacturer/device_name/Android.bp. Por exemplo, substitua system_ext por produto para FCM do produto: 
    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",
    ],
}
  • Instale o módulo em device/manufacturer/device_name/device.mk. Exemplo: 
    PRODUCT_PACKAGES += system_ext_compatibility_matrix.xml

Os comandos a seguir são executados (no sistema de build, modificados para omitir detalhes de implementação) para gerar arquivos XML de matriz de compatibilidade do framework:

# 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

No momento da execução, o objeto VINTF combina um subconjunto de matrizes de compatibilidade do sistema e de compatibilidade do produto como a matriz de compatibilidade do framework. Consulte a matriz de compatibilidade do framework para mais detalhes.

Exemplo:gerar o manifesto do fornecedor a partir de fragmentos

Vários fragmentos de manifesto do fornecedor podem ser agrupados no momento da criação. Exemplo:

<!-- 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

Em seguida, assemble_vintf adiciona o HAL de infravermelho ao manifesto do fornecedor se BOARD_ENABLE_IR for definido e o omite se BOARD_ENABLE_IR não for definido. Os comandos a seguir (modificados para omitir detalhes de implementação) são executados para gerar o manifesto do fornecedor:

# 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

Para obter informações, consulte:

assemble_vintf --help

Teste

O projeto platform/system/libvintf usa o GTest para a serialização, desserialização e verificação de compatibilidade.

Licenciamento

  • tinyxml2 (external/tinyxml2) para serializar/desserializar o objeto para/de XML. Licença semelhante à BSD.
  • libselinux (external/selinux/libselinux) para receber a versão da policydb. Licença de domínio público.
  • libz (external/zlib) para descompactar /proc/config.gz. Licença semelhante à BSD.
  • O projeto libvintf usa a licença Apache 2.0 (com os arquivos MODULE_LICENSE_APACHE2 e NOTICE apropriados).