nvdm.h

/* Copyright Statement:
 *
 * (C) 2005-2017 MediaTek Inc. All rights reserved.
 *
 * This software/firmware and related documentation ("MediaTek Software") are
 * protected under relevant copyright laws. The information contained herein
 * is confidential and proprietary to MediaTek Inc. ("MediaTek") and/or its licensors.
 * Without the prior written permission of MediaTek and/or its licensors,
 * any reproduction, modification, use or disclosure of MediaTek Software,
 * and information contained herein, in whole or in part, shall be strictly prohibited.
 * You may only use, reproduce, modify, or distribute (as applicable) MediaTek Software
 * if you have agreed to and been bound by the applicable license agreement with
 * MediaTek ("License Agreement") and been granted explicit permission to do so within
 * the License Agreement ("Permitted User"). If you are not a Permitted User,
 * please cease any access or use of MediaTek Software immediately.
 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
 * THAT MEDIATEK SOFTWARE RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES
 * ARE PROVIDED TO RECEIVER ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT.
 * NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH RESPECT TO THE
 * SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY, INCORPORATED IN, OR
 * SUPPLIED WITH MEDIATEK SOFTWARE, AND RECEIVER AGREES TO LOOK ONLY TO SUCH
 * THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO. RECEIVER EXPRESSLY ACKNOWLEDGES
 * THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES
 * CONTAINED IN MEDIATEK SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK
 * SOFTWARE RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S ENTIRE AND
 * CUMULATIVE LIABILITY WITH RESPECT TO MEDIATEK SOFTWARE RELEASED HEREUNDER WILL BE,
 * AT MEDIATEK'S OPTION, TO REVISE OR REPLACE MEDIATEK SOFTWARE AT ISSUE,
 * OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE CHARGE PAID BY RECEIVER TO
 * MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
 */

#ifndef __NVDM_H__
#define __NVDM_H__

#ifdef MTK_NVDM_ENABLE

#include <stdint.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum {
    NVDM_DATA_ITEM_TYPE_RAW_DATA = 0x01,   
    NVDM_DATA_ITEM_TYPE_STRING = 0x02,     
} nvdm_data_item_type_t;

typedef enum {
    NVDM_STATUS_INVALID_PARAMETER = -5,  
    NVDM_STATUS_ITEM_NOT_FOUND = -4,     
    NVDM_STATUS_INSUFFICIENT_SPACE = -3, 
    NVDM_STATUS_INCORRECT_CHECKSUM = -2, 
    NVDM_STATUS_ERROR = -1,              
    NVDM_STATUS_OK = 0,                  
} nvdm_status_t;

nvdm_status_t nvdm_init(void);

nvdm_status_t nvdm_write_data_item(const char *group_name,
                                   const char *data_item_name,
                                   nvdm_data_item_type_t type,
                                   const uint8_t *buffer,
                                   uint32_t size);

nvdm_status_t nvdm_read_data_item(const char *group_name,
                                  const char *data_item_name,
                                  uint8_t *buffer,
                                  uint32_t *size);

/*
 * @brief     This function deletes a single data item stored in the NVDM region.
 * @param[in] group_name   is the group name of the data item, such as "Bluetooth".
 * @param[in] data_item_name   is the name of the data item, such as "address" of the "Bluetooth".
 * @return
 *                #NVDM_STATUS_OK, if the operation completed successfully. \n
 *                #NVDM_STATUS_ERROR, if an unknown error occurred. \n
 *                #NVDM_STATUS_INVALID_PARAMETER, if the parameter is invalid. \n
 *                #NVDM_STATUS_ITEM_NOT_FOUND, if the data item is not found. \n
 */
nvdm_status_t nvdm_delete_data_item(const char *group_name, const char *data_item_name);

/*
 * @brief     This function is used to delete all data items in the group.
 * @param[in] group_name   is the group name of the data item, such as "Bluetooth".
 * @return
 *                #NVDM_STATUS_OK, if the operation completed successfully. \n
 *                #NVDM_STATUS_ERROR, if an unknown error occurred. \n
 *                #NVDM_STATUS_INVALID_PARAMETER, if the parameter is invalid. \n
 *                #NVDM_STATUS_ITEM_NOT_FOUND, if the data item group is not found. \n
 */
nvdm_status_t nvdm_delete_group(const char *group_name);

/*
 * @brief     This function is used to delete all data items stored in the NVDM region.
 * @return
 *                #NVDM_STATUS_OK, if the operation completed successfully. \n
 *                #NVDM_STATUS_ERROR, if an unknown error occurred. \n
 *                #NVDM_STATUS_ITEM_NOT_FOUND, if the data item group is not found. \n
 * @note
 *                It's dangerous to call this API, as this will remove everything in NVDM region.
 */
nvdm_status_t nvdm_delete_all(void);

/*
 * @brief     This function marks the start of the query.
 *                User should call this API before #nvdm_query_next_group_name() and
 *                #nvdm_query_next_data_item_name() to query the naming information of data items.
 * @return
 *                #NVDM_STATUS_OK, if the operation completed successfully. \n
 *                #NVDM_STATUS_ERROR, if an unknown error occurred. \n
 */
nvdm_status_t nvdm_query_begin(void);

/*
 * @brief     This function marks the end of the query.
 *                User should call this API after #nvdm_query_next_group_name() and
 *                #nvdm_query_next_data_item_name() to query the naming information of data items.
 * @return
 *                #NVDM_STATUS_OK, if the operation completed successfully. \n
 *                #NVDM_STATUS_ERROR, if an unknown error occurred. \n
 */
nvdm_status_t nvdm_query_end(void);

nvdm_status_t nvdm_query_next_group_name(char *group_name);

nvdm_status_t nvdm_query_next_data_item_name(char *data_item_name);

#ifdef __cplusplus
}
#endif

#endif

#endif /* __NVDM_H__ */