Mbed OS Reference
Loading...
Searching...
No Matches
kvstore_config_t Struct Reference

This structure represent a KVStore partition configuration. More...

#include <KVMap.h>

Data Fields

KVStorekvstore_main_instance
 A Pointer to main instance of the KVStore partition. More...
 
KVStoreinternal_store
 A pointer Internal store of the KVStore partition. More...
 
KVStoreexternal_store
 A pointer external store of the KVStore partition. More...
 
BlockDeviceinternal_bd
 A pointer Internal FlashIAP BlockDevice of the KVStore partition. More...
 
BlockDeviceexternal_bd
 A pointer external BlockDevice of the KVStore partition. More...
 
FileSystemexternal_fs
 A pointer external FileSystem of the KVStore partition. More...
 
uint32_t flags_mask
 This is a flag masking value for the KVStore global API. More...
 

Detailed Description

This structure represent a KVStore partition configuration.

Definition at line 32 of file KVMap.h.

Field Documentation

◆ kvstore_main_instance

KVStore* kvstore_main_instance

A Pointer to main instance of the KVStore partition.

This is also the instance KVStore global API should work with. This must not be NULL in a working partition configuration.

Definition at line 38 of file KVMap.h.

◆ internal_store

KVStore* internal_store

A pointer Internal store of the KVStore partition.

If no rollback protection is required the pointer may be NULL.

Definition at line 43 of file KVMap.h.

◆ external_store

KVStore* external_store

A pointer external store of the KVStore partition.

The pointer can be NULL if external store has been omitted

Definition at line 48 of file KVMap.h.

◆ internal_bd

BlockDevice* internal_bd

A pointer Internal FlashIAP BlockDevice of the KVStore partition.

The pointer can be NULL if internal store has been omitted

Definition at line 53 of file KVMap.h.

◆ external_bd

BlockDevice* external_bd

A pointer external BlockDevice of the KVStore partition.

The pointer can be NULL if external store has been omitted

Definition at line 58 of file KVMap.h.

◆ external_fs

FileSystem* external_fs

A pointer external FileSystem of the KVStore partition.

The pointer can be NULL if FileSystemStore has not been configured.

Definition at line 63 of file KVMap.h.

◆ flags_mask

uint32_t flags_mask

This is a flag masking value for the KVStore global API.

The Global API will mask the input flags base on this value to prevent errors in case the user choose an different security level.

Definition at line 69 of file KVMap.h.