منابع اضافی

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

مکان کد قابل پرس و جو

کد مربوط به شیء رابط فروشنده‌ی قابل پرس‌وجو به system/libvintf می‌رود.

فایل‌های مانیفست دست‌نویس و ماتریس‌های سازگاری می‌توانند دشوار باشند. از ابزارهای زیر برای تولید یک ماتریس مانیفست/سازگاری تکراری برای شروع استفاده کنید.

لشال

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 در واقع ارائه می‌دهد، توجه انسانی لازم است.

مونتاژ_VINTF

assemble_vintf یک ابزار سمت میزبان است که:

  1. اعتبار ماتریس سازگاری یا فایل مانیفست را تأیید می‌کند.
  2. متغیرها را به ماتریس‌های manifests/compatibility موجود در زمان ساخت تزریق می‌کند و یک فایل جدید تولید می‌کند که باید روی دستگاه نصب شود.
  3. سازگاری بین فایل تولید شده و فایل دوتایی آن را بررسی می‌کند.
  4. اگر یک فایل مانیفست داده شود، به صورت اختیاری یک ماتریس سازگاری boilerplate تولید می‌کند که با فایل مانیفست سازگار است.

مثال: ایجاد ماتریس سازگاری دستگاه از فایل مانیفست فریم‌ورک 

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

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 برای 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

سپس، assemble_vintf در صورت تعریف BOARD_ENABLE_IR ، 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 مناسب) استفاده می‌کند.