ARMmbed
/
mbed-os
mirror of https://github.com/ARMmbed/mbed-os.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #6373 from 0xc0170/fix_flash_docs 

flash: add docs for user defined data
pull/6512/head
Anna Bridge 2018-03-28 15:55:35 +01:00 committed by GitHub
parent 25a2d15f05 e828b392bc
commit 773fb90670
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 24 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
hal/TARGET_FLASH_CMSIS_ALGO/flash_data.h
View File

@ -18,35 +18,44 @@
#include <stdint.h> #include <stdint.h>
// Target flash algorithm structure /** Target flash algorithm structure
*/
typedef struct { typedef struct {
const uint32_t init; const uint32_t init; /**< Init function address */
const uint32_t uninit; const uint32_t uninit; /**< Uninit function address */
const uint32_t erase_sector; const uint32_t erase_sector; /**< Erase sector function address */
const uint32_t program_page; const uint32_t program_page; /**< Program page function address */
const uint32_t static_base; const uint32_t static_base; /**< Static base address */
uint32_t *algo_blob; uint32_t *algo_blob; /**< Pointer to flash algo binary blob */
} flash_algo_t; } flash_algo_t;
/** Sector information structure
*/
typedef struct { typedef struct {
const uint32_t start; const uint32_t start; /**< Sector start address */
const uint32_t size; const uint32_t size; /**< Sector size */
} sector_info_t; } sector_info_t;
/** Flash configuration structure
*/
typedef struct { typedef struct {
const uint32_t page_size; const uint32_t page_size; /**< The minimum program page size that can be written */
const uint32_t flash_start; const uint32_t flash_start; /**< Start address of the flash <0, flash_size) */
const uint32_t flash_size; const uint32_t flash_size; /**< Flash size. The size is accumulative sum of all sector sizes */
const sector_info_t *sectors; const sector_info_t *sectors; /**< List of sectors - sector can vary in sizes */
const uint32_t sector_info_count; const uint32_t sector_info_count; /**< Number of sectors */
} flash_target_config_t; } flash_target_config_t;
// Target flash configuration /** Target flash configuration
*/
struct flash_s { struct flash_s {
const flash_target_config_t *target_config; const flash_target_config_t *target_config;
const flash_algo_t *flash_algo; const flash_algo_t *flash_algo;
}; };
/** Flash algo argument structure
* Contains all registers that should be preserved
*/
typedef struct { typedef struct {
uint32_t r0; uint32_t r0;
uint32_t r1; uint32_t r1;