source: svn/trunk/newcon3bcm2_21bu/dta/tests/unit_test/umstore.h

/***************************************************************************
 *     Copyright (c) 2011, Broadcom Corporation
 *     All Rights Reserved
 *     Confidential Property of Broadcom Corporation
 *
 *  THIS SOFTWARE MAY ONLY BE USED SUBJECT TO AN EXECUTED SOFTWARE LICENSE
 *  AGREEMENT  BETWEEN THE USER AND BROADCOM.  YOU HAVE NO RIGHT TO USE OR
 *  EXPLOIT THIS MATERIAL EXCEPT SUBJECT TO THE TERMS OF SUCH AN AGREEMENT.
 *
 * $brcm_Workfile: $
 * $brcm_Revision: $
 * $brcm_Date: $
 *
 * Module Description: UDTA message storage interface.
 *
 * Revision History:
 *
 * $brcm_Log: $
 * 
 *
 ***************************************************************************/
#if !defined(__umstore_h__)
#define __umstore_h__


#define BUMS_OK 0
#define BUMS_ERROR 1


#define BUMS_ID_START 100
#define BUMS_ID_CA_SYS_ID BUMS_ID_START
/* must point to the last defined id */
#define BUMS_ID_LAST BUMS_ID_CA_SYS_ID

typedef struct bums_data_t * bums_handle;

/***************************************************************************
Summary:
 Open flash database and initialize it for access.
Description:
 Database will be positioned on the first valid record;
Input:
Output:
Returns:
SeeAlso:
None
***************************************************************************/
void bums_open(void);

/***************************************************************************
Summary:
 Close flash database and free data structures
Description:
 Database is closed and all allocated memory is freed.
Input:
Output:
Returns:
SeeAlso:
None
***************************************************************************/
void bums_close(void);

/***************************************************************************
Summary:
 Read data with given ID from the database.
Description:
 Read data from the database and place it in the provided memory.
 If there is no record in the database return error.
Input:
Output:
Returns:
SeeAlso:
None
***************************************************************************/
int bums_read_data(unsigned char data_id, char * data, size_t size);

/***************************************************************************
Summary:
 Write data with given ID in to the database.
Description:
 Write data in to the database.
 Previous data with the same ID will be replaced with the new data.
Input:
Output:
Returns:
SeeAlso:
None
***************************************************************************/
int bums_write_data(unsigned char data_id, char * data, size_t size);

/***************************************************************************
Summary:
 Erase data with given ID from the database.
Description:
 Erase data from the database.
 Previous data with the same ID will be replaced with the new data.
Input:
Output:
Returns:
SeeAlso:
None
***************************************************************************/
int bums_delete_data(unsigned char data_id);

#endif