/*
|
* Copyright (c) 2019-2025 Beijing Hanwei Innovation Technology Ltd. Co. and
|
* its subsidiaries and affiliates (collectly called MKSEMI).
|
*
|
* All rights reserved.
|
*
|
* Redistribution and use in source and binary forms, with or without
|
* modification, are permitted provided that the following conditions are met:
|
*
|
* 1. Redistributions of source code must retain the above copyright notice,
|
* this list of conditions and the following disclaimer.
|
*
|
* 2. Redistributions in binary form, except as embedded into an MKSEMI
|
* integrated circuit in a product or a software update for such product,
|
* 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.
|
*
|
* 3. Neither the name of MKSEMI nor the names of its contributors may be used
|
* to endorse or promote products derived from this software without
|
* specific prior written permission.
|
*
|
* 4. This software, with or without modification, must only be used with a
|
* MKSEMI integrated circuit.
|
*
|
* 5. Any software provided in binary form under this license must not be
|
* reverse engineered, decompiled, modified and/or disassembled.
|
*
|
* THIS SOFTWARE IS PROVIDED BY MKSEMI "AS IS" AND ANY EXPRESS OR IMPLIED
|
* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
|
* MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
* DISCLAIMED. IN NO EVENT SHALL MKSEMI OR 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.
|
*/
|
#ifndef MK_NVM_H
|
#define MK_NVM_H
|
|
#include "mk_common.h"
|
#include "mk_flash.h"
|
|
#ifdef __cplusplus
|
extern "C" {
|
#endif
|
|
/*! \addtogroup MK_NVM_API
|
* \{ */
|
|
/**************************************************************************************************
|
Function Declarations
|
**************************************************************************************************/
|
|
/*************************************************************************************************/
|
/*!
|
* \brief Initialize the NVM system.
|
*/
|
/*************************************************************************************************/
|
void mk_nvm_init(void);
|
|
/*************************************************************************************************/
|
/*!
|
* \brief Read data.
|
*
|
* \param id Read ID.
|
* \param pData Buffer to read to.
|
* \param len Data length to read.
|
*
|
* \return TRUE if NVM operation is successful, FALSE otherwise.
|
*/
|
/*************************************************************************************************/
|
bool mk_nvm_read(uint16_t id, uint8_t *pData, uint16_t len);
|
|
/*************************************************************************************************/
|
/*!
|
* \brief Write data.
|
*
|
* \param id Write ID.
|
* \param pData Buffer to write.
|
* \param len Data length to write.
|
*
|
* \return TRUE if NVM operation is successful, FALSE otherwise.
|
*/
|
/*************************************************************************************************/
|
bool mk_nvm_write(uint16_t id, const uint8_t *pData, uint16_t len);
|
|
/*************************************************************************************************/
|
/*!
|
* \brief Erase data.
|
*
|
* \param id Erase ID.
|
*
|
* \return TRUE if NVM operation is successful, FALSE otherwise.
|
*/
|
/*************************************************************************************************/
|
bool mk_nvm_erase(uint16_t id);
|
|
/*************************************************************************************************/
|
/*!
|
* \brief Erase all data located in NVM storage.
|
*/
|
/*************************************************************************************************/
|
void mk_nvm_erase_all(void);
|
|
/*! \} */ /* MK_NVM_API */
|
|
#ifdef __cplusplus
|
}
|
#endif
|
|
#endif /* MK_NVM_H */
|
