Persistent Store (flash)#

Persistent Store (PS) commands manage user data in PS keys in the flash memory of the Bluetooth device. User data stored within the flash memory is persistent across reset and power cycling of the device. The persistent store size is 2048 bytes. Because Bluetooth bondings are also stored in this area, the space available for user data additionally depends on the number of bondings the device has at the time. The size of a Bluetooth bonding is around 150 bytes.

The maximum user data size associated to a PS key is 56 bytes.

flash commands#

flash_ps_erase#

Delete a single PS key and its value from the persistent store.

C API#

/* Function */  
struct gecko_msg_flash_ps_erase_rsp_t *gecko_cmd_flash_ps_erase(uint16 key);  
  
/* Response id */  
gecko_rsp_flash_ps_erase_id  
  
/* Response structure */  
struct gecko_msg_flash_ps_erase_rsp_t  
{  
  uint16 result;  
}  

Command Parameters (for BGAPI headers refer to link)#

Response Parameters (for BGAPI headers refer to link)#

• 0: success

• Non-zero: an error has occurred

For other values see Error codes

flash_ps_erase_all#

Delete all PS keys and their corresponding values.

C API#

/* Function */  
struct gecko_msg_flash_ps_erase_all_rsp_t *gecko_cmd_flash_ps_erase_all();  
  
/* Response id */  
gecko_rsp_flash_ps_erase_all_id  
  
/* Response structure */  
struct gecko_msg_flash_ps_erase_all_rsp_t  
{  
  uint16 result;  
}  

Command does not have parameters (for BGAPI headers refer to#

link)

Response Parameters (for BGAPI headers refer to link)#

• 0: success

• Non-zero: an error has occurred

For other values see Error codes

flash_ps_load#

Retrieve the value of the specified PS key.

C API#

/* Function */  
struct gecko_msg_flash_ps_load_rsp_t *gecko_cmd_flash_ps_load(uint16 key);  
  
/* Response id */  
gecko_rsp_flash_ps_load_id  
  
/* Response structure */  
struct gecko_msg_flash_ps_load_rsp_t  
{  
  uint16 result;  
  uint8array value;  
}  

Command Parameters (for BGAPI headers refer to link)#

Response Parameters (for BGAPI headers refer to link)#

• 0: success

• Non-zero: an error has occurred

For other values see Error codes
uint8array | value | The returned value of the specified PS key

flash_ps_save#

Store a value into the specified PS key. Allowed PS keys are in range from 0x4000 to 0x407F. At most, 56 bytes user data can be stored in one PS key. Error code 0x018a (command_too_long) is returned if the value data is more than 56 bytes.

C API#

/* Function */  
struct gecko_msg_flash_ps_save_rsp_t *gecko_cmd_flash_ps_save(uint16 key, uint8 value_len, const uint8 *value_data);  
  
/* Response id */  
gecko_rsp_flash_ps_save_id  
  
/* Response structure */  
struct gecko_msg_flash_ps_save_rsp_t  
{  
  uint16 result;  
}  

Command Parameters (for BGAPI headers refer to link)#

Response Parameters (for BGAPI headers refer to link)#

• 0: success

• Non-zero: an error has occurred

For other values see Error codes

flash defines#

flash_ps_keys#

Define keys

Defines#