منابع تکمیلی

منابع زیر جزئیاتی درباره مکان‌های کد، ابزارها، آزمایش، و صدور پروانه ارائه می‌دهند.

مکان کد پُرسمان‌پذیر

کد شیء واسط فروشنده قابل‌پرسمان به 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" تنظیم شده‌اند.

مثال: تولید فایل‌های زبان نشانه‌گذاری توسعه‌پذیر مانیفست دستگاه از متغیرها

در زمان ساخت، اگر متغیرهای زیر در 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

‫FCM مربوط به system_ext باید با واحدهای Soong نصب شود. محصول FCM ممکن است با واحدهای Soong نیز نصب شود؛ اگر از این روش استفاده می‌شود، DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE را تعریف نکنید. علاوه‌براین، نسخه‌های FCM محصول و نسخه‌های FCM system_ext متعددی ممکن است با واحدهای Soong نصب شوند. موارد زیر را تعریف کنید:

  • واحدی را در device/manufacturer/device_name/Android.bp تعریف کنید. برای مثال (جایگزین کردن system_ext با product برای 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 را به مانیفست فروشنده اضافه می‌کند و اگر 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) برای سریال‌سازی/سریال‌زدایی شیء به/از زبان نشانه‌گذاری توسعه‌پذیر. پروانه BSD-like.
  • libselinux (external/selinux/libselinux) برای دریافت نسخه policydb. پروانه دامنه عمومی.
  • ‫libz (خارجی/zlib) برای ازفشرده‌سازی /proc/config.gz. پروانه مشابه BSD.
  • پروژه libvintf از پروانه Apache 2.0 (با فایل‌های MODULE_LICENSE_APACHE2 و NOTICE مناسب) استفاده می‌کند.