nvram_device-Strukturreferenz
#include < nvram.h >
Datenfelder | |
| Struktur hw_device_t | gemeinsam |
| 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_tauthorization_value_size) |
| nvram_result_t (* | delete_space )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_tauthorization_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_tauthorization_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_tauthorization_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_tauthorization_value_size) |
| nvram_result_t (* | enable_read_lock )(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_tauthorization_value_size) |
detaillierte Beschreibung
Felddokumentation
| struct hw_device_t common |
Allgemeine Methoden des nvram_device . Dies muss das erste Mitglied von nvram_device sein, da Benutzer dieser Struktur in Kontexten, in denen bekannt ist, dass hw_device_t auf ein nvram_device verweist, einen hw_device_t auf einen nvram_device- Zeiger umwandeln.
| 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_tauthorization_value_size) |
Erstellt einen neuen Bereich mit dem angegebenen Index, der angegebenen Größe, den angegebenen Steuerelementen und dem angegebenen Autorisierungswert.
device – Die nvram_device- Instanz. index – Ein Index für den neuen Bereich. Der Index kann ein beliebiger 32-Bit-Wert sein, darf jedoch nicht bereits einem vorhandenen Bereich zugewiesen sein. size_in_bytes – Die Anzahl der Bytes, die für den Speicherplatz reserviert werden sollen. control_list – Ein Array von Steuerelementen, die für den Bereich erzwungen werden sollen. list_size – Die Anzahl der Elemente in |control_list|. Authorization_value – Wenn |control_list| Enthält NV_CONTROL_READ_AUTHORIZATION und/oder NV_CONTROL_WRITE_AUTHORIZATION, dann stellt dieser Parameter den Autorisierungswert für diese Richtlinien bereit (wenn beide Steuerelemente festgelegt sind, gilt dieser Wert für beide). Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|.
| nvram_result_t (* delete_space)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_tauthorization_value_size) |
Löscht ein Leerzeichen.
device – Die nvram_device- Instanz. index – Der Space-Index. Authorization_value – Wenn der Bereich über die Richtlinie NV_CONTROL_WRITE_AUTHORIZATION verfügt, stellt dieser Parameter den Autorisierungswert bereit. Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|.
| nvram_result_t (*disable_create)(const struct nvram_device *device) |
Deaktiviert jede weitere Erstellung von Leerzeichen bis zum nächsten vollständigen Zurücksetzen des Geräts (wie beim Zurücksetzen auf die Werkseinstellungen, nicht beim Neustart). Nachfolgende Aufrufe von NV_CreateSpace sollten NV_RESULT_OPERATION_DISABLED zurückgeben.
device – Die nvram_device- Instanz.
| nvram_result_t (* enable_read_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_tauthorization_value_size) |
Aktiviert eine Lesesperre für den angegebenen Speicherplatz gemäß seiner Richtlinie. Wenn für den Speicherplatz NV_CONTROL_BOOT_READ_LOCK nicht festgelegt ist, hat diese Funktion keine Auswirkung und gibt möglicherweise einen Fehler zurück.
device – Die nvram_device- Instanz. index – Der Space-Index. Authorization_value – Wenn der Bereich über die Richtlinie NV_CONTROL_READ_AUTHORIZATION verfügt, stellt dieser Parameter den Autorisierungswert bereit. (Beachten Sie, dass für die Lesesperre kein Schreibzugriff erforderlich ist. Eine Lesesperre ist immer flüchtig.) Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|.
| nvram_result_t (* enable_write_lock)(const struct nvram_device *device, uint32_t index, const uint8_t *authorization_value, uint32_tauthorization_value_size) |
Aktiviert eine Schreibsperre für den angegebenen Speicherplatz gemäß seiner Richtlinie. Wenn für den Speicherplatz NV_CONTROL_PERSISTENT_WRITE_LOCK oder NV_CONTROL_BOOT_WRITE_LOCK nicht festgelegt ist, hat diese Funktion keine Auswirkung und gibt möglicherweise einen Fehler zurück.
device – Die nvram_device- Instanz. index – Der Space-Index. Authorization_value – Wenn der Bereich über die Richtlinie NV_CONTROL_WRITE_AUTHORIZATION verfügt, stellt dieser Parameter den Autorisierungswert bereit. Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|.
| nvram_result_t (* get_available_size_in_bytes)(const struct nvram_device *device, uint64_t *available_size) |
Gibt die nicht zugewiesene Anzahl der im NVRAM verfügbaren Bytes aus. Wenn eine Implementierung die verfügbare Größe nicht kennt, kann sie eine Schätzung oder die Gesamtgröße bereitstellen.
device – Die nvram_device- Instanz. available_size – Empfängt die Ausgabe. Kann nicht Null sein.
| nvram_result_t (* get_max_space_size_in_bytes)(const struct nvram_device *device, uint64_t *max_space_size) |
Gibt die maximale Anzahl von Bytes aus, die einem einzelnen Leerzeichen zugewiesen werden können. Dieser beträgt immer mindestens 32. Wenn eine Implementierung die maximale Größe nicht begrenzt, kann sie die Gesamtgröße bereitstellen.
device – Die nvram_device- Instanz. max_space_size – Empfängt die Ausgabe. Kann nicht Null sein.
| nvram_result_t (* get_max_spaces)(const struct nvram_device *device, uint32_t *num_spaces) |
Gibt die maximale Gesamtzahl der Leerzeichen aus, die zugewiesen werden können. Dies ist immer mindestens 8. Gibt NV_UNLIMITED_SPACES aus, wenn eine beliebige Anzahl von Leerzeichen unterstützt wird (nur auf verfügbare NVRAM-Bytes beschränkt).
device – Die nvram_device- Instanz. num_spaces – Empfängt die Ausgabe. Kann nicht Null sein.
| 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) |
Gibt die Liste der Steuerelemente aus, die einem bestimmten Bereich zugeordnet sind.
device – Die nvram_device- Instanz. index – Der Space-Index. max_list_size – Die Anzahl der Elemente in der |control_list| Array. control_list – Empfängt die Liste der Steuerelemente bis zur angegebenen |max_list_size|. Kann NULL sein, wenn |max_list_size| ist 0. list_size – Empfängt die Anzahl der in |control_list| gefüllten Elemente oder die Anzahl der verfügbaren Elemente, wenn |control_list| ist 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) |
Gibt eine Liste der erstellten Space-Indizes aus. Wenn |max_list_size| ist 0, nur |list_size| ist besiedelt.
device – Die nvram_device- Instanz. max_list_size – Die Anzahl der Elemente in der |space_index_list| Array. space_index_list – Empfängt die Liste der erstellten Spaces bis zur angegebenen |max_list_size|. Kann NULL sein, wenn |max_list_size| ist 0. list_size – Empfängt die Anzahl der in |space_index_list| gefüllten Elemente oder die Anzahl der verfügbaren Elemente, wenn |space_index_list| ist Null.
| nvram_result_t (* get_space_size)(const struct nvram_device *device, uint32_t index, uint64_t *size) |
Gibt die Größe eines bestimmten Speicherplatzes in Bytes aus.
device – Die nvram_device- Instanz. index – Der Space-Index. size – Empfängt die Ausgabe. Kann nicht Null sein.
| nvram_result_t (* get_total_size_in_bytes)(const struct nvram_device *device, uint64_t *total_size) |
Gibt die Gesamtzahl der im NVRAM verfügbaren Bytes aus. Dies wird immer mindestens 2048 sein. Wenn eine Implementierung die Gesamtgröße nicht kennt, kann sie eine Schätzung oder 2048 bereitstellen.
device – Die nvram_device- Instanz. total_size – Empfängt die Ausgabe. Kann nicht Null sein.
| nvram_result_t (* is_space_locked)(const struct nvram_device *device, uint32_t index, int *write_lock_enabled, int *read_lock_enabled) |
Gibt aus, ob Sperren für den angegebenen Bereich aktiviert sind. Wenn eine Sperre aktiviert ist, ist der Vorgang deaktiviert und jeder Versuch, diesen Vorgang auszuführen, führt zu NV_RESULT_OPERATION_DISABLED.
device – Die nvram_device- Instanz. index – Der Space-Index. write_lock_enabled – Wird auf einen Wert ungleich Null gesetzt, wenn Schreibvorgänge derzeit deaktiviert sind. read_lock_enabled – Wird auf einen Wert ungleich Null gesetzt, wenn Lesevorgänge derzeit deaktiviert sind.
| 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_tauthorization_value_size, uint8_t *buffer, uint64_t *bytes_read) |
Liest den Inhalt eines Leerzeichens. Wenn der Speicherplatz noch nie beschrieben wurde, sind alle gelesenen Bytes 0x00.
device – Die nvram_device- Instanz. index – Der Space-Index. num_bytes_to_read – Die Anzahl der zu lesenden Bytes; |Puffer| muss groß genug sein, um so viele Bytes aufzunehmen. Ist dieser größer als die Größe des Spaces, wird der gesamte Space gelesen. Ist dieser kleiner als die Größe des Space, werden die ersten Bytes im Space gelesen. Authorization_value – Wenn der Bereich über die Richtlinie NV_CONTROL_READ_AUTHORIZATION verfügt, stellt dieser Parameter den Autorisierungswert bereit. Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|. Puffer – Empfängt die aus dem Speicherplatz gelesenen Daten. Muss mindestens |num_bytes_to_read| sein Bytes groß. bytes_read – Die Anzahl der gelesenen Bytes. Wenn NV_RESULT_SUCCESS zurückgegeben wird, wird dies auf den kleineren Wert von |num_bytes_to_read| gesetzt oder die Größe des Raumes.
| 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_tauthorization_value_size) |
Schreibt den Inhalt eines Leerzeichens. Wenn der Speicherplatz mit NV_CONTROL_WRITE_EXTEND konfiguriert ist, werden die Eingabedaten verwendet, um die aktuellen Daten zu erweitern.
device – Die nvram_device- Instanz. index – Der Space-Index. Puffer – Die zu schreibenden Daten. buffer_size – Die Anzahl der Bytes in |buffer|. Ist dieser kleiner als die Größe des Speicherplatzes, werden die restlichen Bytes auf 0x00 gesetzt. Wenn dies größer als die Größe des Speicherplatzes ist, wird NV_RESULT_INVALID_PARAMETER zurückgegeben. Authorization_value – Wenn der Bereich über die Richtlinie NV_CONTROL_WRITE_AUTHORIZATION verfügt, stellt dieser Parameter den Autorisierungswert bereit. Andernfalls wird dieser Wert ignoriert und kann NULL sein. Authorization_value_size – Die Anzahl der Bytes in |authorization_value|.
Die Dokumentation für diese Struktur wurde aus der folgenden Datei generiert:
- hardware/libhardware/include/hardware/ nvram.h