Pengaturan
Modul ini mencakup abstraksi platform untuk penyimpanan pengaturan non-volatile.
Ringkasan
Pencacahan | |
---|---|
anonymous enum { | enum Pencacahan ini menentukan kunci pengaturan. |
Fungsi | |
---|---|
otPlatSettingsAdd ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Menambahkan nilai ke pengaturan. |
otPlatSettingsDeinit ( otInstance *aInstance) | void Melakukan de-inisialisasi apa pun untuk subsistem pengaturan, jika perlu. |
otPlatSettingsDelete ( otInstance *aInstance, uint16_t aKey, int aIndex) | Menghapus pengaturan dari penyimpanan pengaturan. |
otPlatSettingsGet ( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength) | Mengambil nilai pengaturan. |
otPlatSettingsInit ( otInstance *aInstance) | void Melakukan inisialisasi apa pun untuk subsistem pengaturan, jika perlu. |
otPlatSettingsSet ( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength) | Menetapkan atau mengganti nilai pengaturan. |
otPlatSettingsSetCriticalKeys ( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength) | void Fungsi ini mengatur kunci kritis yang harus disimpan di area aman. |
otPlatSettingsWipe ( otInstance *aInstance) | void Menghapus semua pengaturan dari penyimpanan pengaturan. |
Pencacahan
enum anonim
anonymous enum
Pencacahan ini menentukan kunci pengaturan.
Catatan: Saat menambahkan kunci pengaturan baru, jika pengaturan yang sesuai dengan kunci berisi informasi sensitif keamanan, pengembang HARUS menambahkan kunci tersebut ke array kCriticalKeys
.
Fungsi
otPlatSettingsAdd
otError otPlatSettingsAdd( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Menambahkan nilai ke pengaturan.
Fungsi ini menambahkan nilai ke pengaturan yang diidentifikasi oleh aKey, tanpa mengganti nilai yang sudah ada.
Perhatikan bahwa implementasi yang mendasari tidak diperlukan untuk mempertahankan urutan item yang terkait dengan kunci tertentu. Nilai tambah dapat ditambahkan di akhir, awal, atau bahkan di tengah-tengah. Urutan nilai yang sudah ada sebelumnya juga dapat berubah.
Memanggil fungsi ini dengan sukses dapat menyebabkan pengaturan yang tidak terkait dengan beberapa nilai untuk diurutkan ulang.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otPlatSettingsDeinit
void otPlatSettingsDeinit( otInstance *aInstance )
Melakukan de-inisialisasi apa pun untuk subsistem pengaturan, jika perlu.
Detail | |||
---|---|---|---|
Parameter |
|
otPlatSettingsDelete
otError otPlatSettingsDelete( otInstance *aInstance, uint16_t aKey, int aIndex )
Menghapus pengaturan dari penyimpanan pengaturan.
Fungsi ini menghapus nilai tertentu dari pengaturan yang diidentifikasi oleh aKey dari penyimpanan pengaturan.
Perhatikan bahwa implementasi yang mendasari tidak diperlukan untuk mempertahankan urutan item yang terkait dengan kunci tertentu.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
| ||||||
Kembalikan Nilai |
|
otPlatSettingsGet
otError otPlatSettingsGet( otInstance *aInstance, uint16_t aKey, int aIndex, uint8_t *aValue, uint16_t *aValueLength )
Mengambil nilai pengaturan.
Fungsi ini mengambil nilai pengaturan yang diidentifikasi oleh aKey dan menulisnya ke memori yang ditunjuk oleh aValue. Ini kemudian menulis panjang ke integer yang ditunjukkan oleh aValueLength. Nilai awal aValueLength adalah jumlah byte maksimum yang akan ditulis ke aValue.
Fungsi ini dapat digunakan untuk memeriksa keberadaan kunci tanpa mengambil nilai dengan menyetel aValue dan aValueLength ke NULL. Anda juga dapat memeriksa panjang pengaturan tanpa mengambilnya dengan hanya menyetel aValue ke NULL.
Perhatikan bahwa implementasi penyimpanan yang mendasari tidak diperlukan untuk mempertahankan urutan pengaturan dengan beberapa nilai. Urutan nilai tersebut MUNGKIN berubah setelah operasi tulis APA PUN ke toko.
Detail | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||||
Kembalikan Nilai |
|
otPlatSettingsInit
void otPlatSettingsInit( otInstance *aInstance )
Melakukan inisialisasi apa pun untuk subsistem pengaturan, jika perlu.
Detail | |||
---|---|---|---|
Parameter |
|
otPlatSettingsSet
otError otPlatSettingsSet( otInstance *aInstance, uint16_t aKey, const uint8_t *aValue, uint16_t aValueLength )
Menetapkan atau mengganti nilai pengaturan.
Fungsi ini menetapkan atau menggantikan nilai pengaturan yang diidentifikasi oleh aKey. Jika ada lebih dari satu nilai yang sebelumnya terkait dengan aKey, maka semuanya akan dihapus dan diganti dengan entri tunggal ini.
Memanggil fungsi ini dengan sukses dapat menyebabkan pengaturan yang tidak terkait dengan beberapa nilai untuk diurutkan ulang.
Detail | |||||||||
---|---|---|---|---|---|---|---|---|---|
Parameter |
| ||||||||
Kembalikan Nilai |
|
otPlatSettingsSetCriticalKeys
void otPlatSettingsSetCriticalKeys( otInstance *aInstance, const uint16_t *aKeys, uint16_t aKeysLength )
Fungsi ini mengatur kunci kritis yang harus disimpan di area aman.
Perhatikan bahwa memori yang ditunjukkan oleh aKeys
HARUS tidak dilepaskan sebelum aInstance
dimusnahkan.
Detail | |||||||
---|---|---|---|---|---|---|---|
Parameter |
|
otPlatSettingsWipe
void otPlatSettingsWipe( otInstance *aInstance )
Menghapus semua pengaturan dari penyimpanan pengaturan.
Fungsi ini menghapus semua pengaturan dari penyimpanan pengaturan, mengatur ulang ke kondisi awal pabrik.
Detail | |||
---|---|---|---|
Parameter |
|