Вы должны использовать HIDL для описания всех флагов сборки, используемых для условной компиляции платформы. Соответствующие флаги сборки должны быть сгруппированы и включены в один файл .hal
. Использование HIDL для указания элементов конфигурации дает следующие преимущества:
- Версии (чтобы добавить новые элементы конфигурации, поставщики/OEM должны явно расширить HAL)
- Хорошо документировано
- Контроль доступа с помощью SELinux
- Проверка работоспособности элементов конфигурации с помощью Vendor Test Suite (проверка диапазона, проверка взаимозависимости между элементами и т. д.)
- Автоматически генерируемые API как на C++, так и на Java.
Определите флаги сборки, используемые платформой.
Начните с определения конфигураций сборки, используемых для условной компиляции платформы, затем откажитесь от устаревших конфигураций, чтобы уменьшить набор. Например, для surfaceflinger
указан следующий набор флагов сборки:
-
TARGET_USES_HWC2
-
TARGET_BOARD_PLATFORM
-
TARGET_DISABLE_TRIPLE_BUFFERING
-
TARGET_FORCE_HWC_FOR_VIRTUAL_DISPLAYS
-
NUM_FRAMEBUFFER_SURFACE_BUFFERS
-
TARGET_RUNNING_WITHOUT_SYNC_FRAMEWORK
-
VSYNC_EVENT_PHASE_OFFSET_NS
-
SF_VSYNC_EVENT_PHASE_OFFSET_NS
-
PRESENT_TIME_OFFSET_FROM_VSYNC_NS
-
MAX_VIRTUAL_DISPLAY_DIMENSION
Создайте интерфейс HAL
Конфигурации сборки для подсистемы доступны через интерфейс HAL, в то время как интерфейсы для предоставления значений конфигурации сгруппированы в пакете HAL android.hardware.configstore
(в настоящее время в версии 1.0). Например, чтобы создать файл интерфейса HAL для surfaceflinger
, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
package android.hardware.configstore@1.0; interface ISurfaceFlingerConfigs { // TO-BE-FILLED-BELOW };
После создания файла .hal
запустите hardware/interfaces/update-makefiles.sh
, чтобы добавить новый файл .hal
в файлы Android.bp
и Android.mk
.
Добавить функции для флагов сборки
Для каждого флага сборки добавьте в интерфейс новую функцию. Например, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { disableTripleBuffering() generates(OptionalBool ret); forceHwcForVirtualDisplays() generates(OptionalBool ret); enum NumBuffers: uint8_t { USE_DEFAULT = 0, TWO = 2, THREE = 3, }; numFramebufferSurfaceBuffers() generates(NumBuffers ret); runWithoutSyncFramework() generates(OptionalBool ret); vsyncEventPhaseOffsetNs generates (OptionalUInt64 ret); presentTimeOffsetFromSyncNs generates (OptionalUInt64 ret); maxVirtualDisplayDimension() generates(OptionalInt32 ret); };
При добавлении функции:
- Будьте кратки с именами. Избегайте преобразования имен переменных make-файла в имена функций и имейте в виду, что префиксы
TARGET_
иBOARD_
больше не нужны. - Добавьте комментарии. Помогите разработчикам понять назначение элемента конфигурации, как он меняет поведение платформы, допустимые значения и другую соответствующую информацию.
Типы возвращаемых функций могут быть Optional[Bool|String|Int32|UInt32|Int64|UInt64]
. Типы определяются в types.hal
в том же каталоге и оборачивают примитивные значения полем, которое указывает, указано ли значение в HAL; в противном случае используется значение по умолчанию.
struct OptionalString { bool specified; string value; };
При необходимости определите перечисление, которое лучше всего представляет тип элемента конфигурации, и используйте это перечисление в качестве возвращаемого типа. В приведенном выше примере перечисление NumBuffers
определено для ограничения количества допустимых значений. При определении таких пользовательских типов данных добавьте поле или значение перечисления (например, USE_DEFAULT
) для обозначения того, указано или не указано значение HAL.
Не обязательно, чтобы один флаг сборки стал отдельной функцией в HIDL. Владельцы модулей также могут объединить тесно связанные флаги сборки в структуру и иметь функцию, которая возвращает эту структуру (это может уменьшить количество вызовов функций).
Например, опция для агрегирования двух флагов сборки в одну структуру в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { // other functions here struct SyncConfigs { OptionalInt64 vsyncEventPhaseoffsetNs; OptionalInt64 presentTimeoffsetFromSyncNs; }; getSyncConfigs() generates (SyncConfigs ret); // other functions here };
Альтернативы одной функции HAL
В качестве альтернативы использованию одной функции HAL для всех флагов сборки интерфейс HAL также предоставляет простые функции, такие как getBoolean(string key)
и getInteger(string key)
. Фактические пары key=value
хранятся в отдельных файлах, а служба HAL предоставляет значения путем чтения/анализа этих файлов.
Хотя этот подход легко определить, он не включает в себя преимущества, предоставляемые HIDL (принудительное управление версиями, простота документирования, контроль доступа), и поэтому не рекомендуется.
Одиночный и множественный интерфейсы
Конструкция интерфейса HAL для элементов конфигурации предлагает два варианта:
- Единый интерфейс, охватывающий все элементы конфигурации
- Несколько интерфейсов, каждый из которых охватывает набор связанных элементов конфигурации.
Единый интерфейс проще, но он может стать недоступным, поскольку в один файл добавляется больше элементов конфигурации. Кроме того, управление доступом не является детальным, поэтому процесс, которому предоставлен доступ к интерфейсу, может читать все элементы конфигурации (доступ к частичному набору элементов конфигурации не может быть предоставлен). Альтернативно, если доступ не предоставлен, элементы конфигурации не могут быть прочитаны.
Из-за этих проблем Android использует несколько интерфейсов с одним интерфейсом HAL для группы связанных элементов конфигурации. Например, ISurfaceflingerConfigs
для элементов конфигурации, связанных с surfaceflinger
, и IBluetoothConfigs
для элементов конфигурации, связанных с Bluetooth.
Вы должны использовать HIDL для описания всех флагов сборки, используемых для условной компиляции платформы. Соответствующие флаги сборки должны быть сгруппированы и включены в один файл .hal
. Использование HIDL для указания элементов конфигурации дает следующие преимущества:
- Версии (чтобы добавить новые элементы конфигурации, поставщики/OEM должны явно расширить HAL)
- Хорошо документировано
- Контроль доступа с помощью SELinux
- Проверка работоспособности элементов конфигурации с помощью Vendor Test Suite (проверка диапазона, проверка взаимозависимости между элементами и т. д.)
- Автоматически генерируемые API как на C++, так и на Java.
Определите флаги сборки, используемые платформой.
Начните с определения конфигураций сборки, используемых для условной компиляции платформы, затем откажитесь от устаревших конфигураций, чтобы уменьшить набор. Например, для surfaceflinger
указан следующий набор флагов сборки:
-
TARGET_USES_HWC2
-
TARGET_BOARD_PLATFORM
-
TARGET_DISABLE_TRIPLE_BUFFERING
-
TARGET_FORCE_HWC_FOR_VIRTUAL_DISPLAYS
-
NUM_FRAMEBUFFER_SURFACE_BUFFERS
-
TARGET_RUNNING_WITHOUT_SYNC_FRAMEWORK
-
VSYNC_EVENT_PHASE_OFFSET_NS
-
SF_VSYNC_EVENT_PHASE_OFFSET_NS
-
PRESENT_TIME_OFFSET_FROM_VSYNC_NS
-
MAX_VIRTUAL_DISPLAY_DIMENSION
Создайте интерфейс HAL
Доступ к конфигурациям сборки подсистемы осуществляется через интерфейс HAL, а интерфейсы для задания значений конфигурации сгруппированы в пакете HAL android.hardware.configstore
(в настоящее время версия 1.0). Например, чтобы создать файл интерфейса HAL для surfaceflinger
, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
package android.hardware.configstore@1.0; interface ISurfaceFlingerConfigs { // TO-BE-FILLED-BELOW };
После создания файла .hal
запустите hardware/interfaces/update-makefiles.sh
, чтобы добавить новый файл .hal
в файлы Android.bp
и Android.mk
.
Добавить функции для флагов сборки
Для каждого флага сборки добавьте в интерфейс новую функцию. Например, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { disableTripleBuffering() generates(OptionalBool ret); forceHwcForVirtualDisplays() generates(OptionalBool ret); enum NumBuffers: uint8_t { USE_DEFAULT = 0, TWO = 2, THREE = 3, }; numFramebufferSurfaceBuffers() generates(NumBuffers ret); runWithoutSyncFramework() generates(OptionalBool ret); vsyncEventPhaseOffsetNs generates (OptionalUInt64 ret); presentTimeOffsetFromSyncNs generates (OptionalUInt64 ret); maxVirtualDisplayDimension() generates(OptionalInt32 ret); };
При добавлении функции:
- Будьте кратки с именами. Избегайте преобразования имен переменных make-файла в имена функций и имейте в виду, что префиксы
TARGET_
иBOARD_
больше не нужны. - Добавьте комментарии. Помогите разработчикам понять назначение элемента конфигурации, как он меняет поведение платформы, допустимые значения и другую соответствующую информацию.
Типы возвращаемых функций могут быть Optional[Bool|String|Int32|UInt32|Int64|UInt64]
. Типы определяются в types.hal
в том же каталоге и оборачивают примитивные значения полем, которое указывает, указано ли значение в HAL; в противном случае используется значение по умолчанию.
struct OptionalString { bool specified; string value; };
При необходимости определите перечисление, которое лучше всего представляет тип элемента конфигурации, и используйте это перечисление в качестве возвращаемого типа. В приведенном выше примере перечисление NumBuffers
определено для ограничения количества допустимых значений. При определении таких пользовательских типов данных добавьте поле или значение перечисления (например, USE_DEFAULT
) для обозначения того, указано или не указано значение HAL.
Не обязательно, чтобы один флаг сборки стал отдельной функцией в HIDL. Владельцы модулей также могут объединить тесно связанные флаги сборки в структуру и иметь функцию, которая возвращает эту структуру (это может уменьшить количество вызовов функций).
Например, вариант объединения двух флагов сборки в одну структуру в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { // other functions here struct SyncConfigs { OptionalInt64 vsyncEventPhaseoffsetNs; OptionalInt64 presentTimeoffsetFromSyncNs; }; getSyncConfigs() generates (SyncConfigs ret); // other functions here };
Альтернативы одной функции HAL
В качестве альтернативы использованию одной функции HAL для всех флагов сборки интерфейс HAL также предоставляет простые функции, такие как getBoolean(string key)
и getInteger(string key)
. Фактические пары key=value
хранятся в отдельных файлах, а служба HAL предоставляет значения путем чтения/анализа этих файлов.
Хотя этот подход легко определить, он не включает в себя преимущества, предоставляемые HIDL (принудительное управление версиями, простота документирования, контроль доступа), и поэтому не рекомендуется.
Одиночный и множественный интерфейсы
Конструкция интерфейса HAL для элементов конфигурации предлагает два варианта:
- Единый интерфейс, охватывающий все элементы конфигурации
- Несколько интерфейсов, каждый из которых охватывает набор связанных элементов конфигурации.
Единый интерфейс проще, но он может стать недоступным, поскольку в один файл добавляется больше элементов конфигурации. Кроме того, управление доступом не является детальным, поэтому процесс, которому предоставлен доступ к интерфейсу, может читать все элементы конфигурации (доступ к частичному набору элементов конфигурации не может быть предоставлен). Альтернативно, если доступ не предоставлен, элементы конфигурации не могут быть прочитаны.
Из-за этих проблем Android использует несколько интерфейсов с одним интерфейсом HAL для группы связанных элементов конфигурации. Например, ISurfaceflingerConfigs
для элементов конфигурации, связанных с surfaceflinger
, и IBluetoothConfigs
для элементов конфигурации, связанных с Bluetooth.
Вы должны использовать HIDL для описания всех флагов сборки, используемых для условной компиляции платформы. Соответствующие флаги сборки должны быть сгруппированы и включены в один файл .hal
. Использование HIDL для указания элементов конфигурации дает следующие преимущества:
- Версии (чтобы добавить новые элементы конфигурации, поставщики/OEM должны явно расширить HAL)
- Хорошо документировано
- Контроль доступа с помощью SELinux
- Проверка работоспособности элементов конфигурации с помощью Vendor Test Suite (проверка диапазона, проверка взаимозависимости между элементами и т. д.)
- Автоматически генерируемые API как на C++, так и на Java.
Определите флаги сборки, используемые платформой.
Начните с определения конфигураций сборки, используемых для условной компиляции платформы, затем откажитесь от устаревших конфигураций, чтобы уменьшить набор. Например, для surfaceflinger
указан следующий набор флагов сборки:
-
TARGET_USES_HWC2
-
TARGET_BOARD_PLATFORM
-
TARGET_DISABLE_TRIPLE_BUFFERING
-
TARGET_FORCE_HWC_FOR_VIRTUAL_DISPLAYS
-
NUM_FRAMEBUFFER_SURFACE_BUFFERS
-
TARGET_RUNNING_WITHOUT_SYNC_FRAMEWORK
-
VSYNC_EVENT_PHASE_OFFSET_NS
-
SF_VSYNC_EVENT_PHASE_OFFSET_NS
-
PRESENT_TIME_OFFSET_FROM_VSYNC_NS
-
MAX_VIRTUAL_DISPLAY_DIMENSION
Создайте интерфейс HAL
Доступ к конфигурациям сборки подсистемы осуществляется через интерфейс HAL, а интерфейсы для задания значений конфигурации сгруппированы в пакете HAL android.hardware.configstore
(в настоящее время версия 1.0). Например, чтобы создать файл интерфейса HAL для surfaceflinger
, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
package android.hardware.configstore@1.0; interface ISurfaceFlingerConfigs { // TO-BE-FILLED-BELOW };
После создания файла .hal
запустите hardware/interfaces/update-makefiles.sh
, чтобы добавить новый файл .hal
в файлы Android.bp
и Android.mk
.
Добавить функции для флагов сборки
Для каждого флага сборки добавьте в интерфейс новую функцию. Например, в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { disableTripleBuffering() generates(OptionalBool ret); forceHwcForVirtualDisplays() generates(OptionalBool ret); enum NumBuffers: uint8_t { USE_DEFAULT = 0, TWO = 2, THREE = 3, }; numFramebufferSurfaceBuffers() generates(NumBuffers ret); runWithoutSyncFramework() generates(OptionalBool ret); vsyncEventPhaseOffsetNs generates (OptionalUInt64 ret); presentTimeOffsetFromSyncNs generates (OptionalUInt64 ret); maxVirtualDisplayDimension() generates(OptionalInt32 ret); };
При добавлении функции:
- Будьте кратки с именами. Избегайте преобразования имен переменных make-файла в имена функций и имейте в виду, что префиксы
TARGET_
иBOARD_
больше не нужны. - Добавьте комментарии. Помогите разработчикам понять назначение элемента конфигурации, как он меняет поведение платформы, допустимые значения и другую соответствующую информацию.
Типы возвращаемых функций могут быть Optional[Bool|String|Int32|UInt32|Int64|UInt64]
. Типы определяются в types.hal
в том же каталоге и оборачивают примитивные значения полем, которое указывает, указано ли значение в HAL; в противном случае используется значение по умолчанию.
struct OptionalString { bool specified; string value; };
При необходимости определите перечисление, которое лучше всего представляет тип элемента конфигурации, и используйте это перечисление в качестве возвращаемого типа. В приведенном выше примере перечисление NumBuffers
определено для ограничения количества допустимых значений. При определении таких пользовательских типов данных добавьте поле или значение перечисления (например, USE_DEFAULT
) для обозначения того, указано или не указано значение HAL.
Не обязательно, чтобы один флаг сборки стал отдельной функцией в HIDL. Владельцы модулей также могут объединить тесно связанные флаги сборки в структуру и иметь функцию, которая возвращает эту структуру (это может уменьшить количество вызовов функций).
Например, вариант объединения двух флагов сборки в одну структуру в hardware/interfaces/configstore/1.0/ISurfaceFlingerConfigs.hal
:
interface ISurfaceFlingerConfigs { // other functions here struct SyncConfigs { OptionalInt64 vsyncEventPhaseoffsetNs; OptionalInt64 presentTimeoffsetFromSyncNs; }; getSyncConfigs() generates (SyncConfigs ret); // other functions here };
Альтернативы одной функции HAL
В качестве альтернативы использованию одной функции HAL для всех флагов сборки интерфейс HAL также предоставляет простые функции, такие как getBoolean(string key)
и getInteger(string key)
. Фактические пары key=value
хранятся в отдельных файлах, а служба HAL предоставляет значения путем чтения/анализа этих файлов.
Хотя этот подход легко определить, он не включает в себя преимущества, предоставляемые HIDL (принудительное управление версиями, простота документирования, контроль доступа), и поэтому не рекомендуется.
Одиночный и множественный интерфейсы
Конструкция интерфейса HAL для элементов конфигурации предлагает два варианта:
- Единый интерфейс, охватывающий все элементы конфигурации
- Несколько интерфейсов, каждый из которых охватывает набор связанных элементов конфигурации.
Единый интерфейс проще, но он может стать недоступным, поскольку в один файл добавляется больше элементов конфигурации. Кроме того, управление доступом не является детальным, поэтому процесс, которому предоставлен доступ к интерфейсу, может читать все элементы конфигурации (доступ к частичному набору элементов конфигурации не может быть предоставлен). Альтернативно, если доступ не предоставлен, элементы конфигурации не могут быть прочитаны.
Из-за этих проблем Android использует несколько интерфейсов с одним интерфейсом HAL для группы связанных элементов конфигурации. Например, ISurfaceflingerConfigs
для элементов конфигурации surfaceflinger
и IBluetoothConfigs
для элементов конфигурации, связанных с Bluetooth.