gr55xx_nvds.h
Go to the documentation of this file.
1 /**
2  ******************************************************************************
3  *
4  * @file gr55xx_nvds.h
5  *
6  * @brief NVDS API
7  *
8  ******************************************************************************
9  * @attention
10  #####Copyright (c) 2019 GOODIX
11  All rights reserved.
12 
13  Redistribution and use in source and binary forms, with or without
14  modification, are permitted provided that the following conditions are met:
15  * Redistributions of source code must retain the above copyright
16  notice, this list of conditions and the following disclaimer.
17  * Redistributions in binary form must reproduce the above copyright
18  notice, this list of conditions and the following disclaimer in the
19  documentation and/or other materials provided with the distribution.
20  * Neither the name of GOODIX nor the names of its contributors may be used
21  to endorse or promote products derived from this software without
22  specific prior written permission.
23 
24  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
25  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE
28  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
29  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
30  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
31  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
32  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
33  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
34  POSSIBILITY OF SUCH DAMAGE.
35  *****************************************************************************************
36  */
37 
38 /**
39  * @addtogroup SYSTEM
40  * @{
41  */
42  /**
43  @addtogroup NVDS Non-Volatile Data Storage
44  @{
45  @brief Definitions and prototypes for the NVDS interface.
46  */
47 
48 #ifndef __GR55XX_NVDS_H__
49 #define __GR55XX_NVDS_H__
50 
51 #include <stdint.h>
52 #include <stdbool.h>
53 
54 /** @addtogroup NVDS_DEFINES Defines
55  * @{ */
56 #define NV_TAGCAT_APP 0x4000 /**< NVDS tag mask for user application. */
57 #define NV_TAG_APP(idx) (NV_TAGCAT_APP | ((idx) & 0x3FFF)) /**< Get NVDS tag for user application.
58  The values of Tag 0x0000 and 0xFFFF are invalid.
59  Idx should not be used as the parameter of NVDS APIs directly.
60  The range of idx is 0x0000~0x3FFF. */
61 /** @} */
62 
63 /**@addtogroup NVDS_ENUMERATIONS Enumerations
64  * @{ */
65 /**@brief NVDS Returned Status. */
67 {
68  NVDS_SUCCESS, /**< NVDS succeeds. */
69  NVDS_GC_COMPLETE, /**< NVDS garbage collection complete. */
70  NVDS_FAIL, /**< NVDS failed. */
71  NVDS_NOT_INIT, /**< NVDS not initialize. */
72  NVDS_TAG_NOT_EXISTED, /**< NVDS tag does not exist. */
73  NVDS_SPACE_NOT_ENOUGH, /**< NVDS space is not enough. */
74  NVDS_LENGTH_OUT_OF_RANGE, /**< NVDS length out of range. */
75  NVDS_INVALID_PARA, /**< NVDS invalid params. */
76  NVDS_INVALID_SECTORS, /**< NVDS_INIT input parameter sectors error */
77  NVDS_INIT_START_ADDR_NO_ALIGN, /**< NVDS_INIT input parameter start addr is not 4K aligned. */
78  NVDS_INIT_AREA_SLOP_OVER, /**< NVDS_INIT input parameters cause nvds to out of range. */
79  NVDS_INIT_CHECKSUM_FAIL, /**< When nvds has been initialized and read tag, verification fail. */
80  NVDS_INIT_TAG_LEN_ERR, /**< When nvds has been initialized and read tag, the tag length is 0. */
81  NVDS_INIT_READ_TAG_NOT_COMPLETE, /**< When nvds has been initialized read tag not complate. */
82  NVDS_INIT_MGR_ERR, /**< When nvds has been initialized and read tag complate, avail size is error. */
83  NVDS_COMPACT_FAILED, /**< NVDS failed to compact sectors. */
84  NVDS_STORAGE_ACCESS_FAILED, /**< NVDS failed to access storage. */
85  NVDS_POINTER_NULL /**< NVDS or driver function repalce error: NULL. */
86 };
87 /** @} */
88 
89 /**@addtogroup NVDS_TYPEDEFS Type Typedefs
90  * @{ */
91 /**@brief NVDS Item tag. */
92 typedef uint16_t NvdsTag_t;
93 /** @} */
94 
95 
96 /**@addtogroup NVDS_STRUCTURES Enumerations
97  * @{ */
98 /**@brief NVDS drive function struct. */
99 typedef struct
100 {
101  uint32_t (*p_nvds_flash_read)(const uint32_t addr, uint8_t *buf, const uint32_t size); /**< NVDS flash read function. */
102  uint32_t (*p_nvds_flash_write_r)(const uint32_t addr, const uint8_t *buf, const uint32_t size); /**< NVDS flash write_r function. */
103  void (*p_nvds_flash_set_security)(bool enable); /**< NVDS flash security set function. */
104  bool (*p_nvds_flash_get_security)(void); /**< NVDS flash security get function. */
105  bool (*p_nvds_flash_erase)(const uint32_t addr, const uint32_t size); /**< NVDS flash erase function. */
106  void (*p_nvds_flash_get_info)(uint32_t *id, uint32_t *size); /**< NVDS flash information get function. */
108 
109 /**@brief NVDS function struct. */
110 typedef struct
111 {
112  uint8_t (*p_nvds_init)(uint32_t start_addr, uint8_t sectors); /**< NVDS init function */
113  uint8_t (*p_nvds_get)(uint16_t tag, uint16_t *p_len, uint8_t *p_buf); /**< NVDS get function */
114  uint8_t (*p_nvds_put)(uint16_t tag, uint16_t len, const uint8_t *p_buf); /**< NVDS put function */
115  uint8_t (*p_nvds_del)(uint16_t tag); /**< NVDS delete function */
116  uint16_t (*p_nvds_tag_length)(uint16_t tag); /**< NVDS tag length get function */
117 }nvds_func_t;
118 /** @} */
119 
120 
121 
122 /** @addtogroup NVDS_FUNCTIONS Functions
123  * @{ */
124 /**
125  ****************************************************************************************
126  * @brief Initialize the sectors for NVDS.
127  *
128  * @note NVDS module will use one more sector flash for garbage collection.
129  *
130  * @param[in] start_addr: Start address of NVDS area. If the value does not equal zero, it must be sector-aligned.
131  If the value equals zero, NVDS area will locate in the last two sector(s) in flash memory.
132  * @param[in] sectors: The number of sectors.
133  *
134  * @return Result of nvds init.
135  ****************************************************************************************
136  */
137 uint8_t nvds_init(uint32_t start_addr, uint8_t sectors);
138 
139 /**
140  ****************************************************************************************
141  * @brief Read data from NVDS.
142  *
143  * @param[in] tag: Valid NVDS item tag.
144  * @param[in,out] p_len: Pointer to the length of data.
145  * @param[out] p_buf: Data is read into the buffer.
146  *
147  * @return Result of nvds get.
148  ****************************************************************************************
149  */
150 uint8_t nvds_get(NvdsTag_t tag, uint16_t *p_len, uint8_t *p_buf);
151 
152 /**
153  ****************************************************************************************
154  * @brief Write data to NVDS. If the tag does not exist, create one.
155  *
156  * @param[in] tag: Valid NVDS item tag.
157  * @param[in] len: Length of data to be written.
158  * @param[in] p_buf: Data to be written.
159  *
160  * @return Result of nvds put.
161  ****************************************************************************************
162  */
163 uint8_t nvds_put(NvdsTag_t tag, uint16_t len, const uint8_t *p_buf);
164 
165 /**
166  ****************************************************************************************
167  * @brief Delete a tag in NVDS
168  *
169  * @param[in] tag: The tag to be deleted.
170  *
171  * @return Result of nvds delete.
172  ****************************************************************************************
173  */
174 uint8_t nvds_del(NvdsTag_t tag);
175 
176 /**
177  ****************************************************************************************
178  * @brief Get the length of a tag in NVDS
179  *
180  * @param[in] tag: The tag to get the length.
181  *
182  * @return Length of tag data.
183  ****************************************************************************************
184  */
186 
187 /**
188  ****************************************************************************************
189  * @brief Replace the drive function.
190  *
191  * @param[in] p_nvds_drv_func: Pointer to drive functions.
192  *
193  * @return Result of drive function replace.
194  ****************************************************************************************
195  */
196 uint8_t nvds_drv_func_replace(nvds_drv_func_t *p_nvds_drv_func);
197 
198 /**
199  ****************************************************************************************
200  * @brief Replace the function in NVDS.
201  *
202  * @param[in] p_nvds_func: Pointer to nvds functions.
203  *
204  * @return Result nvds function replace.
205  ****************************************************************************************
206  */
207 uint8_t nvds_func_replace(nvds_func_t *p_nvds_func);
208 
209 /**
210  ****************************************************************************************
211  * @brief Calculate the space reserved for system.
212  *
213  * @param[in] bond_dev_num: The number of bond device.
214  *
215  * @return System retention size.
216  ****************************************************************************************
217  */
218 void nvds_retention_size(uint8_t bond_dev_num);
219 /** @} */
220 #endif
221 
222 /** @} */
223 /** @} */
224 
nvds_del
uint8_t nvds_del(NvdsTag_t tag)
Delete a tag in NVDS.
NVDS_SPACE_NOT_ENOUGH
@ NVDS_SPACE_NOT_ENOUGH
Definition: gr55xx_nvds.h:73
NVDS_POINTER_NULL
@ NVDS_POINTER_NULL
Definition: gr55xx_nvds.h:85
NVDS_COMPACT_FAILED
@ NVDS_COMPACT_FAILED
Definition: gr55xx_nvds.h:83
NVDS_INIT_AREA_SLOP_OVER
@ NVDS_INIT_AREA_SLOP_OVER
Definition: gr55xx_nvds.h:78
NVDS_INIT_MGR_ERR
@ NVDS_INIT_MGR_ERR
Definition: gr55xx_nvds.h:82
NVDS_INIT_READ_TAG_NOT_COMPLETE
@ NVDS_INIT_READ_TAG_NOT_COMPLETE
Definition: gr55xx_nvds.h:81
nvds_drv_func_t
NVDS drive function struct.
Definition: gr55xx_nvds.h:100
NVDS_NOT_INIT
@ NVDS_NOT_INIT
Definition: gr55xx_nvds.h:71
NVDS_LENGTH_OUT_OF_RANGE
@ NVDS_LENGTH_OUT_OF_RANGE
Definition: gr55xx_nvds.h:74
NVDS_GC_COMPLETE
@ NVDS_GC_COMPLETE
Definition: gr55xx_nvds.h:69
nvds_drv_func_replace
uint8_t nvds_drv_func_replace(nvds_drv_func_t *p_nvds_drv_func)
Replace the drive function.
NVDS_INIT_CHECKSUM_FAIL
@ NVDS_INIT_CHECKSUM_FAIL
Definition: gr55xx_nvds.h:79
NVDS_INIT_TAG_LEN_ERR
@ NVDS_INIT_TAG_LEN_ERR
Definition: gr55xx_nvds.h:80
NVDS_INIT_START_ADDR_NO_ALIGN
@ NVDS_INIT_START_ADDR_NO_ALIGN
Definition: gr55xx_nvds.h:77
NVDS_INVALID_PARA
@ NVDS_INVALID_PARA
Definition: gr55xx_nvds.h:75
NVDS_STORAGE_ACCESS_FAILED
@ NVDS_STORAGE_ACCESS_FAILED
Definition: gr55xx_nvds.h:84
nvds_retention_size
void nvds_retention_size(uint8_t bond_dev_num)
Calculate the space reserved for system.
NVDS_INVALID_SECTORS
@ NVDS_INVALID_SECTORS
Definition: gr55xx_nvds.h:76
NVDS_FAIL
@ NVDS_FAIL
Definition: gr55xx_nvds.h:70
nvds_put
uint8_t nvds_put(NvdsTag_t tag, uint16_t len, const uint8_t *p_buf)
Write data to NVDS. If the tag does not exist, create one.
nvds_tag_length
uint16_t nvds_tag_length(NvdsTag_t tag)
Get the length of a tag in NVDS.
nvds_func_t
NVDS function struct.
Definition: gr55xx_nvds.h:111
NvdsTag_t
uint16_t NvdsTag_t
NVDS Item tag.
Definition: gr55xx_nvds.h:92
nvds_func_replace
uint8_t nvds_func_replace(nvds_func_t *p_nvds_func)
Replace the function in NVDS.
NVDS_STATUS
NVDS_STATUS
NVDS Returned Status.
Definition: gr55xx_nvds.h:67
NVDS_SUCCESS
@ NVDS_SUCCESS
Definition: gr55xx_nvds.h:68
NVDS_TAG_NOT_EXISTED
@ NVDS_TAG_NOT_EXISTED
Definition: gr55xx_nvds.h:72
nvds_init
uint8_t nvds_init(uint32_t start_addr, uint8_t sectors)
Initialize the sectors for NVDS.
nvds_get
uint8_t nvds_get(NvdsTag_t tag, uint16_t *p_len, uint8_t *p_buf)
Read data from NVDS.