nvram_device 構造体リファレンス
#include <
nvram.h
>
データ フィールド |
|
| struct hw_device_t | common |
| nvram_result_t (* | get_total_size_in_bytes )(const struct nvram_device *device, uint64_t *total_size) |
| nvram_result_t (* | get_available_size_in_bytes )(const struct nvram_device *device, uint64_t *available_size) |
| nvram_result_t (* | get_max_space_size_in_bytes )(const struct nvram_device *device, uint64_t *max_space_size) |
| nvram_result_t (* | get_max_spaces )(const struct nvram_device *device, uint32_t *num_spaces) |
| nvram_result_t (* | get_space_list )(const struct nvram_device *device, uint32_t max_list_size, uint32_t *space_index_list, uint32_t *list_size) |
| nvram_result_t (* | get_space_size )(const struct nvram_device *device, uint32_t index, uint64_t *size) |
| nvram_result_t (* | get_space_controls )(const struct nvram_device *device, uint32_t index, uint32_t max_list_size, nvram_control_t *control_list, uint32_t *list_size) |
| nvram_result_t (* | is_space_locked )(const struct nvram_device *device, uint32_t index, int *write_lock_enabled, int *read_lock_enabled) |
| nvram_result_t (* | create_space )(const struct nvram_device *device, uint32_t index, uint64_t size_in_bytes, const nvram_control_t *control_list, uint32_t list_size, const uint8_t *authorization_value, uint32_t authorization_value_size) |
| nvram_result_t (* | delete_space )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
| nvram_result_t (* | disable_create )(const struct nvram_device *device) |
| nvram_result_t (* | write_space )(const struct nvram_device *device, uint32_t index, const uint8_t *buffer, uint64_t buffer_size, const uint8_t *authorization_value, uint32_t authorization_value_size) |
| nvram_result_t (* | read_space )(const struct nvram_device *device, uint32_t index, uint64_t num_bytes_to_read, const uint8_t *authorization_value, uint32_t authorization_value_size, uint8_t *buffer, uint64_t *bytes_read) |
| nvram_result_t (* | enable_write_lock )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
| nvram_result_t (* | enable_read_lock )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
詳細な説明
フィールドのドキュメント
| struct hw_device_t common |
nvram_device の一般的なメソッド。この構造体のユーザーは、 hw_device_t が nvram_device を参照していることが判明しているコンテキストで、 hw_device_t を nvram_device ポインタにキャストするため、このメンバーは nvram_device の最初のメンバーである必要があります。
| nvram_result_t (* create_space)(const struct nvram_device *device, uint32_t index, uint64_t size_in_bytes, const nvram_control_t *control_list, uint32_t list_size, const uint8_t *authorization_value, uint32_t authorization_value_size) |
指定されたインデックス、サイズ、コントロール、認可値を使用して新しいスペースを作成します。
device - nvram_device インスタンス。index - 新しいスペースのインデックス。インデックスは任意の 32 ビット値にできますが、既存のスペースに割り当てられている値は使用できません。size_in_bytes - スペースに割り当てるバイト数。control_list - スペースに適用する制御の配列。list_size - |control_list| 内のアイテムの数。authorization_value - |control_list| に NV_CONTROL_READ_AUTHORIZATION または NV_CONTROL_WRITE_AUTHORIZATION が含まれている場合、このパラメータはこれらのポリシーの承認値を提供します（両方の制御が設定されている場合、この値は両方に適用されます）。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。
ファイル nvram.h の 187 行 に定義されています。
| nvram_result_t (* delete_space)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
スペースを削除します。
device - nvram_device インスタンス。index - スペースのインデックス。authorization_value - スペースに NV_CONTROL_WRITE_AUTHORIZATION ポリシーが設定されている場合、このパラメータは認可値を提供します。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。
| nvram_result_t (* disable_create)(const struct nvram_device *device) |
デバイスの次回の完全なリセット（再起動ではなく出荷時の設定にリセット）まで、スペースの作成を無効にします。NV_CreateSpace の呼び出しが続くと、NV_RESULT_OPERATION_DISABLED が返されます。
device - nvram_device インスタンス。
| nvram_result_t (* enable_read_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
ポリシーに従って、指定したスペースの読み取りロックを有効にします。スペースに NV_CONTROL_BOOT_READ_LOCK が設定されていない場合、この関数は効果がなく、エラーが返される可能性があります。
device - nvram_device インスタンス。index - スペースのインデックス。authorization_value - スペースに NV_CONTROL_READ_AUTHORIZATION ポリシーがある場合、このパラメータは認可値を提供します。（読み取り用にロックするために書き込みアクセス権は必要ありません。読み取りロックは常に揮発性があります）。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。
ファイル nvram.h の 317 行 に定義されています。
| nvram_result_t (* enable_write_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_t authorization_value_size) |
ポリシーに従って、指定したスペースの書き込みロックを有効にします。スペースに NV_CONTROL_PERSISTENT_WRITE_LOCK または NV_CONTROL_BOOT_WRITE_LOCK が設定されていない場合、この関数は効果がなく、エラーが返されることがあります。
device - nvram_device インスタンス。index - スペースのインデックス。authorization_value - スペースに NV_CONTROL_WRITE_AUTHORIZATION ポリシーが設定されている場合、このパラメータは認可値を提供します。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。
| nvram_result_t (* get_available_size_in_bytes)(const struct nvram_device *device, uint64_t *available_size) |
NVRAM で使用可能な未割り当てバイト数を出力します。実装で使用可能なサイズがわからない場合は、推定サイズまたは合計サイズが提供される場合があります。
device - nvram_device インスタンス。available_size - 出力を受け取ります。NULL にすることはできません。
| nvram_result_t (* get_max_space_size_in_bytes)(const struct nvram_device *device, uint64_t *max_space_size) |
単一のスペースに割り当てることができる最大バイト数を出力します。これは常に 32 以上になります。実装で最大サイズが制限されていない場合は、合計サイズが提供される場合があります。
device - nvram_device インスタンス。max_space_size - 出力を受け取ります。NULL にすることはできません。
| nvram_result_t (* get_max_spaces)(const struct nvram_device *device, uint32_t *num_spaces) |
割り当て可能なスペースの最大合計数を出力します。これは常に 8 以上になります。任意の数のスペースがサポートされている場合（使用可能な NVRAM バイト数にのみ制限あり）、NV_UNLIMITED_SPACES を出力します。
device - nvram_device インスタンス。num_spaces - 出力を受け取ります。NULL にすることはできません。
| nvram_result_t (* get_space_controls)(const struct nvram_device *device, uint32_t index, uint32_t max_list_size, nvram_control_t *control_list, uint32_t *list_size) |
指定したスペースに関連付けられているコントロールのリストを出力します。
device - nvram_device インスタンス。index - スペース インデックス。max_list_size - |control_list| 配列内のアイテム数。control_list - 指定された |max_list_size| までのコントロールのリストを受け取ります。|max_list_size| が 0 の場合、NULL になることがあります。list_size - |control_list| に入力されたアイテムの数、または |control_list| が NULL の場合に使用可能なアイテムの数を受け取ります。
| nvram_result_t (* get_space_list)(const struct nvram_device *device, uint32_t max_list_size, uint32_t *space_index_list, uint32_t *list_size) |
作成された空間インデックスのリストを出力します。|max_list_size| が 0 の場合、|list_size| のみが入力されます。
device - nvram_device インスタンス。max_list_size - |space_index_list| 配列内のアイテム数。space_index_list - 指定された |max_list_size| までの作成済みスペースのリストを受け取ります。|max_list_size| が 0 の場合、NULL になることがあります。list_size - |space_index_list| に入力されたアイテム数、または |space_index_list| が NULL の場合に使用可能なアイテム数を受け取ります。
| nvram_result_t (* get_space_size)(const struct nvram_device *device, uint32_t index, uint64_t *size) |
指定されたスペースのサイズ（バイト単位）を出力します。
device - nvram_device インスタンス。index - スペース インデックス。size - 出力を受け取ります。NULL にすることはできません。
| nvram_result_t (* get_total_size_in_bytes)(const struct nvram_device *device, uint64_t *total_size) |
NVRAM で使用可能なバイト数の合計を出力します。これは常に 2,048 以上になります。実装で合計サイズが不明な場合は、推定値または 2048 が提供される場合があります。
device - nvram_device インスタンス。total_size - 出力を受け取ります。NULL にすることはできません。
| nvram_result_t (* is_space_locked)(const struct nvram_device *device, uint32_t index, int *write_lock_enabled, int *read_lock_enabled) |
指定したスペースでロックが有効になっているかどうかを出力します。ロックが有効になっている場合、オペレーションは無効になり、そのオペレーションを実行しようとすると NV_RESULT_OPERATION_DISABLED が返されます。
device - nvram_device インスタンス。index - スペース インデックス。write_lock_enabled - 書き込みオペレーションが現在無効になっている場合にのみ、0 以外に設定されます。read_lock_enabled - 読み取りオペレーションが現在無効になっている場合にのみ、0 以外に設定されます。
| nvram_result_t (* read_space)(const struct nvram_device *device, uint32_t index, uint64_t num_bytes_to_read, const uint8_t *authorization_value, uint32_t authorization_value_size, uint8_t *buffer, uint64_t *bytes_read) |
スペースの内容を読み取ります。スペースに書き込まれたことがない場合、読み取られるバイトはすべて 0x00 になります。
device - nvram_device インスタンス。index - スペース インデックス。num_bytes_to_read - 読み取るバイト数。|buffer| は、このバイト数を保持できる大きさである必要があります。これがスペースのサイズより大きい場合、スペース全体が読み取られます。これがスペースのサイズより小さい場合は、スペースの最初のバイトが読み取られます。authorization_value - スペースに NV_CONTROL_READ_AUTHORIZATION ポリシーが設定されている場合、このパラメータは認可値を提供します。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。buffer - スペースから読み取られたデータを受け取ります。サイズは |num_bytes_to_read| バイト以上である必要があります。bytes_read - 読み取られたバイト数。NV_RESULT_SUCCESS が返された場合、これは |num_bytes_to_read| またはスペースのサイズのどちらか小さい方に設定されます。
| nvram_result_t (* write_space)(const struct nvram_device *device, uint32_t index, const uint8_t *buffer, uint64_t buffer_size, const uint8_t *authorization_value, uint32_t authorization_value_size) |
スペースの内容を書き込みます。スペースが NV_CONTROL_WRITE_EXTEND で構成されている場合、入力データを使用して現在のデータが拡張されます。
device - nvram_device インスタンス。index - スペース インデックス。buffer - 書き込むデータ。buffer_size - |buffer| のバイト数。これがスペースのサイズより小さい場合、残りのバイトは 0x00 に設定されます。これがスペースのサイズを超える場合、NV_RESULT_INVALID_PARAMETER が返されます。authorization_value - スペースに NV_CONTROL_WRITE_AUTHORIZATION ポリシーが設定されている場合、このパラメータは認可値を提供します。それ以外の場合、この値は無視され、NULL になる場合があります。authorization_value_size - |authorization_value| のバイト数。
この構造体のドキュメントは、次のファイルから生成されました。
- hardware/libhardware/include/hardware/ nvram.h