منابع اضافی

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

مکان کد قابل استعلام

کد شئ واسط فروشنده قابل پرسش به 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. اگر یک فایل مانیفست داده شود، به صورت اختیاری یک ماتریس سازگاری 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

system_ext FCM باید با ماژول های Soong نصب شود. محصول FCM ممکن است با ماژول های Soong نیز نصب شود. در صورت استفاده از این روش، DEVICE_PRODUCT_COMPATIBILITY_MATRIX_FILE را تعریف نکنید. علاوه بر این، چندین نسخه FCM محصول و نسخه های system_ext FCM ممکن است با ماژول های Soong نصب شوند. زیر را تعریف کنید:

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