configif.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012-2018, Texas Instruments Incorporated
 * 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 Texas Instruments Incorporated 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 THE COPYRIGHT OWNER 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.
 * */
/*
 * ======== configif.h ========
 *
 * Configuration Manager Interface functions
 *
 */
#ifndef _CONFIGIF_H
#define _CONFIGIF_H

#ifdef __cplusplus
extern "C" {
#endif

extern void *CfgNew();

extern void CfgFree( void *hCfg );

extern void CfgSetDefault( void *hCfg );

extern void *CfgGetDefault();

extern int  CfgLoad( void *hCfg, int Size, unsigned char *pData );

extern int  CfgSave( void *hCfg, int *pSize, unsigned char *pData );

extern int CfgSetExecuteOrder( void *hCfg, uint32_t Tags,
                        uint32_t *pOpenOrder, uint32_t *pCloseOrder );

extern int  CfgExecute( void *hCfg, uint32_t fExecute );

extern int  CfgSetService( void *hCfg, uint32_t Tag,
                           int (*pCb) (void *, uint32_t, uint32_t, uint32_t,
                           void *) );

#define CFGOP_REMOVE    0       
#define CFGOP_ADD       1       
extern int  CfgAddEntry( void *hCfg, uint32_t Tag, uint32_t Item,
                         uint32_t Mode, int Size, unsigned char *pData,
                         void **phCfgEntry );

/* Add Entry Flags */
#define CFG_ADDMODE_UNIQUE      0x0001  
#define CFG_ADDMODE_DUPLICATE   0x0002  
#define CFG_ADDMODE_NOSAVE      0x0004  
extern int  CfgRemoveEntry( void *hCfg, void *hCfgEntry );

extern int  CfgGetEntryCnt( void *hCfg, uint32_t Tag, uint32_t Item );

extern int  CfgGetEntry( void *hCfg, uint32_t Tag, uint32_t Item,
                         uint32_t Index, void **phCfgEntry );

extern int  CfgGetNextEntry( void *hCfg, void *hCfgEntry,
                             void **phCfgEntryNext );

extern int CfgGetImmediate( void *hCfg, uint32_t Tag, uint32_t Item,
                            uint32_t Index, int Size, unsigned char *pData );

extern int  CfgEntryRef( void *hCfgEntry );

extern int  CfgEntryDeRef( void *hCfgEntry );

extern int  CfgEntryGetData( void *hCfgEntry, int *pSize, unsigned char *pData );

extern int  CfgEntrySetData( void *hCfgEntry, int Size, unsigned char *pData );

extern int  CfgEntryInfo( void *hCfgEntry, int *pSize, unsigned char **ppData );

#define CFGERROR_BADHANDLE      -1      
#define CFGERROR_BADPARAM       -2      
#define CFGERROR_RESOURCES      -3      
#define CFGERROR_REFERROR       -4      
#define CFGERROR_ALREADY        -5      
#define CFGERROR_SERVICE        -100    
#define CFG_MAKE_CFGERROR(x)     ((x)+CFGERROR_SERVICE)

#define CFG_GET_SERVICE_ERROR(x) ((x)-CFGERROR_SERVICE)
#define CFG_IS_SERVICE_ERROR(x)  ((x)<=CFGERROR_SERVICE)

#ifdef __cplusplus
}
#endif /* extern "C" */

#endif