Dodatkowe materiały

W tych materiałach znajdziesz szczegółowe informacje o lokalizacjach kodu, narzędziach, testowaniu i licencjonowaniu.

Lokalizacja kodu, do której można wysłać zapytanie

Kod obiektu interfejsu dostawcy, który można zapytać, trafia do system/libvintf.

Ręczne tworzenie plików manifestu i tablic zgodności może być trudne. Aby wygenerować szablon pliku manifestu lub matrycy zgodności, możesz użyć tych narzędzi:

LSHAL

LSHAL to narzędzie po stronie urządzenia, które zawiera listę wszystkich zarejestrowanych interfejsów HAL (hwservicemanager) oraz wszystkich dostępnych implementacji przepuszczania (np. android.hardware.foo@1.0-impl.so) na urządzeniu. Może też generować plik manifestu urządzenia na podstawie listy:

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

Uwaga:

  1. Jeśli pakiet jest zarejestrowany w funkcji hwservicemanager i jest znaleziony jako przepuszczający HAL, parametr <transport> ma wartość hwbinder.
  2. W pliku manifestu nie ma zapisanej wersji SELinux. Zalecamy, aby element był wstrzykiwany przez assemble_vintf, jak opisano poniżej.
  3. Wygenerowany plik manifestu HAL może być niedokładny. Aby naprawić niespójności między plikiem manifestu urządzenia a tym, co vendor.img faktycznie udostępnia, wymagana jest ingerencja człowieka.

ASSEMBLE_VINTF

assemble_vintf to narzędzie po stronie hosta, które:

  1. Weryfikuje, czy matryca zgodności lub plik manifestu jest prawidłowy.
  2. Wstrzykuje zmienne do plików manifestu lub tabeli zgodności dostępnych w czasie kompilacji i generuje nowy plik, który należy zainstalować na urządzeniu.
  3. Sprawdzanie zgodności wygenerowanego pliku z jego podwójnym plikiem.
  4. Jeśli podany jest plik manifestu, opcjonalnie generuje się szablonową tabelę zgodności zgodną z tym plikiem.

Przykład: generowanie macierzy zgodności urządzeń na podstawie pliku manifestu platformy.

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

Pamiętaj, że wszystkie wartości HAL są ustawione na optional="true".

Przykład: wygeneruj szkieletową tablicę zgodności frameworka na podstawie pliku manifestu urządzenia

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

Pamiętaj, że wszystkie wartości HAL są ustawione na optional="true".

Przykład: generowanie plików XML manifestu urządzenia na podstawie zmiennych

W czasie kompilacji, jeśli w pliku device/manufacturer/device_name/BoardConfig.mk zdefiniowano te zmienne:

# 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

Następnie do generowania plików XML pliku manifestu urządzenia wykonuje się te polecenia (w systemie kompilacji, zmodyfikowane tak, aby pominąć szczegóły implementacji):

# 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

W czasie wykonywania obiekt VINTF łączy manifesty dostawców i manifesty ODM w jeden manifest urządzenia. Więcej informacji znajdziesz w pliku manifestu urządzenia.

Przykład: generowanie plików XML macierzy zgodności urządzeń na podstawie zmiennych

W czasie kompilacji, jeśli w pliku device/manufacturer/device_name/BoardConfig.mk zdefiniowano te zmienne:

# 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

Następnie do generowania plików XML macierzy zgodności urządzeń wykonuje się te polecenia (w systemie kompilacji, zmodyfikowane tak, aby pominąć szczegóły implementacji):

# 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

W czasie wykonywania obiekt VINTF używa macierzy zgodności dostawcy jako macierzy zgodności urządzenia. Szczegółowe informacje znajdziesz w tabeli zgodności urządzeń.

Przykład: generowanie plików XML manifestu frameworku na podstawie zmiennych

W zasadzie device/manufacturer/device_name/BoardConfig.mk możesz zdefiniować te zmienne:

# 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

Aby wygenerować pliki XML manifestu frameworku, wykonuje się te polecenia (w systemie kompilacji, zmodyfikowane tak, aby pominąć szczegóły implementacji):

# 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

W czasie wykonywania obiekt VINTF łączy manifest systemu, fragmenty manifestu systemu, manifest produktu i fragmenty manifestu produktu jako manifest frameworku. Szczegółowe informacje znajdziesz w pliku manifestu Framework.

Przykład: generowanie plików XML macierzy zgodności systemu na podstawie zmiennych

W pliku device/manufacturer/device_name/BoardConfig.mk można zdefiniować te zmienne, aby określić FCM usługi i FCM systemu na urządzeniu:

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 musi być zainstalowany z modułami Soong. Produkt FCM może być też zainstalowany za pomocą modułów Soong. Jeśli używasz tej metody, nie definiuj DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE. Ponadto z modułami Soong można zainstalować wiele wersji FCM produktu i FCM systemu system_ext. Zdefiniuj te elementy:

  • Zdefiniuj moduł w device/manufacturer/device_name/Android.bp. Na przykład (zamień system_ext na produkt w przypadku produktu 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",
    ],
}
  • Zainstaluj moduł w device/manufacturer/device_name/device.mk. Przykład: 
    PRODUCT_PACKAGES += system_ext_compatibility_matrix.xml

Aby wygenerować pliki XML macierzy zgodności frameworka, należy wykonać te polecenia (w systemie kompilacji, zmodyfikowane tak, aby pominąć szczegóły implementacji):

# 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

W czasie wykonywania obiekt VINTF łączy podzbiór matryc zgodności systemu i matryc zgodności produktu jako matrycę zgodności frameworku. Więcej informacji znajdziesz w tabeli zgodności Framework.

Przykład: generowanie pliku manifestu dostawcy na podstawie fragmentów

W czasie kompilacji można połączyć wiele fragmentów pliku manifestu dostawcy. Przykład:

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

Następnie assemble_vintf dodaje do pliku manifestu dostawcy interfejs IR HAL, jeśli parametr BOARD_ENABLE_IR jest zdefiniowany, i pomija go, jeśli nie jest zdefiniowany.BOARD_ENABLE_IR Aby wygenerować plik manifestu dostawcy, wykonaj te polecenia (zmodyfikowane, aby pominąć szczegóły implementacji):

# 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

Szczegółowe informacje znajdziesz w następujących artykułach:

assemble_vintf --help

Testowanie

Projekt platform/system/libvintf używa GTest do serializacji, deserializacji i sprawdzania zgodności.

Licencjonowanie

  • tinyxml2 (external/tinyxml2) do serializacji/deserializacji obiektu do/z XML. Licencja podobna do BSD.
  • libselinux (external/selinux/libselinux) do pobierania wersji policydb. Domena publiczna.
  • libz (zewnętrzny/zlib) do rozpakowywania pliku /proc/config.gz. Licencja podobna do BSD.
  • Projekt libvintf używa licencji Apache 2.0 (z odpowiednimi plikami MODULE_LICENSE_APACHE2 i NOTICE).