Rtos API example

Embed: (wiki syntax)

« Back to documentation index

ARM_CFSTORE_FMODE Struct Reference

ARM_CFSTORE_FMODE Struct Reference

File mode bit-field structure for specifying flags for the following operations:

  • ARM_CFSTORE_DRIVER::(*Create)(), when creating a KV.
More...

#include <configuration_store.h>

Data Fields

uint32_t continuous: 1
 If set, the key value should be stored in a continuous sequence of hardware addresses (not implemented).
uint32_t lazy_flush: 1
 If set then configuration store will defer flushing the KV changes until an optimal time.
uint32_t flush_on_close: 1
 If set then the key-value should be flushed to the backing store when the key is closed (not implemented).
uint32_t read: 1
 If set then the KV can be read.
uint32_t write: 1
 If set then the KV can be written.
uint32_t execute: 1
 If set then the KV can be executed (not implemented).
uint32_t storage_detect: 1
 If set then the call to ARM_CFSTORE_DRIVER::(*Create)() returns whether a key could be created with the required storage characteristics.
uint32_t reserved: 25
 Reserved.

Detailed Description

File mode bit-field structure for specifying flags for the following operations:

  • ARM_CFSTORE_DRIVER::(*Create)(), when creating a KV.
  • ARM_CFSTORE_DRIVER::(*Open)(), when opening a pre-existing KV.

Definition at line 220 of file configuration_store.h.


Field Documentation

uint32_t continuous

If set, the key value should be stored in a continuous sequence of hardware addresses (not implemented).

Definition at line 222 of file configuration_store.h.

uint32_t execute

If set then the KV can be executed (not implemented).

Definition at line 231 of file configuration_store.h.

uint32_t flush_on_close

If set then the key-value should be flushed to the backing store when the key is closed (not implemented).

Definition at line 227 of file configuration_store.h.

uint32_t lazy_flush

If set then configuration store will defer flushing the KV changes until an optimal time.

e.g. to save energy rather than performing the operation immediately (not implemented).

Definition at line 224 of file configuration_store.h.

uint32_t read

If set then the KV can be read.

Definition at line 229 of file configuration_store.h.

uint32_t reserved

Reserved.

Definition at line 235 of file configuration_store.h.

uint32_t storage_detect

If set then the call to ARM_CFSTORE_DRIVER::(*Create)() returns whether a key could be created with the required storage characteristics.

The key is not created.

Definition at line 232 of file configuration_store.h.

uint32_t write

If set then the KV can be written.

Definition at line 230 of file configuration_store.h.