Pengaturan

Modul ini mencakup abstraksi platform untuk penyimpanan pengaturan non-volatile.

Ringkasan

Pencacahan
`anonymous enum { OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001, OT_SETTINGS_KEY_PENDING_DATASET = 0x0002, OT_SETTINGS_KEY_NETWORK_INFO = 0x0003, OT_SETTINGS_KEY_PARENT_INFO = 0x0004, OT_SETTINGS_KEY_CHILD_INFO = 0x0005, OT_SETTINGS_KEY_RESERVED = 0x0006, OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007, OT_SETTINGS_KEY_DAD_INFO = 0x0008, OT_SETTINGS_KEY_OMR_PREFIX = 0x0009, OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a, OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b }`	enum Pencacahan ini menentukan kunci pengaturan.

Pencacahan

anonymous enum {
 OT_SETTINGS_KEY_ACTIVE_DATASET = 0x0001,
 OT_SETTINGS_KEY_PENDING_DATASET = 0x0002,
 OT_SETTINGS_KEY_NETWORK_INFO = 0x0003,
 OT_SETTINGS_KEY_PARENT_INFO = 0x0004,
 OT_SETTINGS_KEY_CHILD_INFO = 0x0005,
 OT_SETTINGS_KEY_RESERVED = 0x0006,
 OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY = 0x0007,
 OT_SETTINGS_KEY_DAD_INFO = 0x0008,
 OT_SETTINGS_KEY_OMR_PREFIX = 0x0009,
 OT_SETTINGS_KEY_ON_LINK_PREFIX = 0x000a,
 OT_SETTINGS_KEY_SRP_ECDSA_KEY = 0x000b
 }

enum

Pencacahan ini menentukan kunci pengaturan.

Fungsi
`otPlatSettingsAdd ( otInstance aInstance, uint16_t aKey, const uint8_t aValue, uint16_t aValueLength)`	`otError` 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)`	`otError` Menghapus pengaturan dari penyimpanan pengaturan.
`otPlatSettingsGet ( otInstance aInstance, uint16_t aKey, int aIndex, uint8_t aValue, uint16_t *aValueLength)`	`otError` 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)`	`otError` 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 .

Properti
`OT_SETTINGS_KEY_ACTIVE_DATASET`	Set Data Operasional Aktif.
`OT_SETTINGS_KEY_CHILD_INFO`	Informasi anak.
`OT_SETTINGS_KEY_DAD_INFO`	Informasi Duplikat Alamat Deteksi (DAD).
`OT_SETTINGS_KEY_NETWORK_INFO`	Informasi jaringan utas.
`OT_SETTINGS_KEY_OMR_PREFIX`	Awalan Off-mesh routable (OMR).
`OT_SETTINGS_KEY_ON_LINK_PREFIX`	Awalan pada tautan untuk tautan infrastruktur.
`OT_SETTINGS_KEY_PARENT_INFO`	Informasi orang tua.
`OT_SETTINGS_KEY_PENDING_DATASET`	Set Data Operasional Tertunda.
`OT_SETTINGS_KEY_RESERVED`	Dicadangkan (sebelumnya mulai otomatis).
`OT_SETTINGS_KEY_SLAAC_IID_SECRET_KEY`	Kunci SLAAC untuk menghasilkan IID yang buram secara semantik.
`OT_SETTINGS_KEY_SRP_ECDSA_KEY`	Pasangan kunci publik / pribadi ECDSA klien SRP.

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

`[in] aInstance`	Struktur instance OpenThread.
`[in] aKey`	Kunci yang terkait dengan pengaturan untuk diubah.
`[in] aValue`	Sebuah penunjuk ke mana nilai baru dari pengaturan harus dibaca. HARUS TIDAK NIHIL jika aValueLength bukan nol.
`[in] aValueLength`	Panjang data yang ditunjukkan oleh aValue. Mungkin nol.

Kembalikan Nilai

`OT_ERROR_NONE`	Pengaturan yang diberikan telah ditambahkan atau dipentaskan untuk ditambahkan.
`OT_ERROR_NOT_IMPLEMENTED`	Fungsi ini tidak diimplementasikan pada platform ini.
`OT_ERROR_NO_BUFS`	Tidak ada ruang tersisa untuk menyimpan pengaturan yang diberikan.

otPlatSettingsDeinit

void otPlatSettingsDeinit(
  otInstance *aInstance
)

Melakukan de-inisialisasi apa pun untuk subsistem pengaturan, jika perlu.

Detail

Parameter

[in] aInstance

Struktur instance OpenThread.

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

`[in] aInstance`	Struktur instance OpenThread.
`[in] aKey`	Kunci yang terkait dengan pengaturan yang diminta.
`[in] aIndex`	Indeks nilai yang akan dihapus. Jika disetel ke -1, semua nilai untuk aKey ini akan dihapus.

Kembalikan Nilai

`OT_ERROR_NONE`	Kunci dan indeks yang diberikan berhasil ditemukan dan dihapus.
`OT_ERROR_NOT_FOUND`	Kunci atau indeks yang diberikan tidak ditemukan di penyimpanan pengaturan.
`OT_ERROR_NOT_IMPLEMENTED`	Fungsi ini tidak diimplementasikan pada platform ini.

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

`[in] aInstance`	Struktur instance OpenThread.
`[in] aKey`	Kunci yang terkait dengan pengaturan yang diminta.
`[in] aIndex`	Indeks item tertentu yang akan didapat.
`[out] aValue`	Sebuah penunjuk ke tempat nilai pengaturan harus ditulis. Dapat disetel ke NULL jika hanya menguji keberadaan atau panjang setelan.
`[in,out] aValueLength`	Penunjuk ke panjang nilai. Saat dipanggil, penunjuk ini harus mengarah ke bilangan bulat yang berisi ukuran nilai maksimum yang dapat ditulis ke aValue. Sebagai gantinya, panjang pengaturan yang sebenarnya ditulis. Ini mungkin disetel ke NULL jika melakukan pemeriksaan kehadiran.

Kembalikan Nilai

`OT_ERROR_NONE`	Setelan yang diberikan berhasil ditemukan dan diambil.
`OT_ERROR_NOT_FOUND`	Pengaturan yang diberikan tidak ditemukan di penyimpanan pengaturan.
`OT_ERROR_NOT_IMPLEMENTED`	Fungsi ini tidak diimplementasikan pada platform ini.

otPlatSettingsInit

void otPlatSettingsInit(
  otInstance *aInstance
)

Melakukan inisialisasi apa pun untuk subsistem pengaturan, jika perlu.

Detail

Parameter

[in] aInstance

Struktur instance OpenThread.

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

`[in] aInstance`	Struktur instance OpenThread.
`[in] aKey`	Kunci yang terkait dengan pengaturan untuk diubah.
`[in] aValue`	Sebuah penunjuk ke mana nilai baru dari pengaturan harus dibaca. HARUS TIDAK NIHIL jika aValueLength bukan nol.
`[in] aValueLength`	Panjang data yang ditunjukkan oleh aValue. Mungkin nol.

Kembalikan Nilai

`OT_ERROR_NONE`	Pengaturan yang diberikan diubah atau dipentaskan.
`OT_ERROR_NOT_IMPLEMENTED`	Fungsi ini tidak diimplementasikan pada platform ini.
`OT_ERROR_NO_BUFS`	Tidak ada ruang tersisa untuk menyimpan pengaturan yang diberikan.

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

`[in] aInstance`	Struktur instance OpenThread.
`[in] aKeys`	Penunjuk ke larik yang berisi daftar kunci kritis.
`[in] aKeysLength`	Jumlah entri dalam larik `aKeys` .

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

[in] aInstance

Struktur instance OpenThread.