Macros | Typedefs | Enumerations | Functions
gr55xx_nvds.h File Reference

NVDS API. More...

`#include <stdint.h>`
`#include <stdbool.h>`

Go to the source code of this file.

## Macros
#define | NV_TAGCAT_APP 0x4000
#define | NV_TAG_APP(idx) (NV_TAGCAT_APP | ((idx) & 0x3FFF))
| Get NVDS tag for user application. The values of Tag 0x0000 and 0xFFFF are invalid. idx should not be used as the parameter of NVDS APIs directly. The range of idx is 0x0001~0x3FFF.

## Typedefs
typedef uint16_t | NvdsTag_t
| NVDS Item tag.

## Enumerations
enum | NVDS_STATUS { NVDS_SUCCESS, NVDS_FAIL, NVDS_TAG_NOT_EXISTED, NVDS_SPACE_NOT_ENOUGH, NVDS_LENGTH_OUT_OF_RANGE, NVDS_INVALID_PARA, NVDS_INVALID_START_ADDR, NVDS_INVALID_SECTORS, NVDS_COMPACT_FAILED, NVDS_STORAGE_ACCESS_FAILED, NVDS_GC_COMPLETE, NVDS_NOT_INIT, NVDS_POINTER_NULL }
| NVDS Returned Status. More...

## Functions
uint8_t | nvds_init (uint32_t start_addr, uint8_t sectors)
| Initialize the sectors for NVDS. More...
uint8_t | nvds_get (NvdsTag_t tag, uint16_t *p_len, uint8_t *p_buf)
| Read data from NVDS. More...
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. More...
uint8_t | nvds_del (NvdsTag_t tag)
| Delete a tag in NVDS. More...
uint16_t | nvds_tag_length (NvdsTag_t tag)
| Get the length of a tag in NVDS. More...
bool | local_hal_flash_erase_chip (void)
| Flash operation API based on hal flash. More...
bool | local_hal_flash_erase (const uint32_t addr, const uint32_t size)
| Erase flash region. More...
uint32_t | local_hal_flash_write (const uint32_t addr, const uint8_t *buf, const uint32_t size)
| Write flash Memory. More...
uint32_t | local_hal_flash_read (const uint32_t addr, uint8_t *buf, const uint32_t size)
| Read flash Memory. More...
void | local_hal_flash_get_info (uint32_t *id, uint32_t *size)
| Get Flash information. More...
bool | local_hal_flash_get_security (void)
| Get encrypted and decrypted status in write-read operations. More...
void | local_hal_flash_set_security (bool enable)
| Enable encrypted and decrypted in write-read operations. More...
uint32_t | local_hal_flash_write_r (const uint32_t addr, const uint8_t *buf, const uint32_t size)
| Write flash Memory reliably. More...

## Detailed Description

NVDS API.

Attention

  ##### Copyright (c) 2019 GOODIX

All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of GOODIX nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL COPYRIGHT HOLDERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.