Cordio Stack and Cordio Profiles  r2p3-02rel0
app_param.h
Go to the documentation of this file.
1 /*************************************************************************************************/
2 /*!
3  * \file
4  *
5  * \brief Application framework parameter database.
6  *
7  * Copyright (c) 2015-2018 Arm Ltd. All Rights Reserved.
8  * ARM Ltd. confidential and proprietary.
9  *
10  * IMPORTANT. Your use of this file is governed by a Software License Agreement
11  * ("Agreement") that must be accepted in order to download or otherwise receive a
12  * copy of this file. You may not use or copy this file for any purpose other than
13  * as described in the Agreement. If you do not agree to all of the terms of the
14  * Agreement do not use this file and delete all copies in your possession or control;
15  * if you do not have a copy of the Agreement, you must contact ARM Ltd. prior
16  * to any use, copying or further distribution of this software.
17  */
18 /*************************************************************************************************/
19 #ifndef APP_PARAM_H
20 #define APP_PARAM_H
21 
22 #ifdef __cplusplus
23 extern "C" {
24 #endif
25 
26 /*! \addtogroup APP_FRAMEWORK_PARAM_API
27  * \{ */
28 
29 /**************************************************************************************************
30  Function Declarations
31 **************************************************************************************************/
32 
33 /** \name App Parameter Database
34  * Interface to read and write parameter data in a file system.
35  */
36 /**@{*/
37 
38 /*************************************************************************************************/
39 /*!
40  * \brief Initialize the parameter database.
41  *
42  * \return None.
43  */
44 /*************************************************************************************************/
45 void AppParamInit(void);
46 
47 /*************************************************************************************************/
48 /*!
49  * \brief Clear the parameter database.
50  *
51  * \return None.
52  */
53 /*************************************************************************************************/
54 void AppParamClear(void);
55 
56 /*************************************************************************************************/
57 /*!
58  * \brief Write parameter value.
59  *
60  * \param id Identifier.
61  * \param valueLen Value length in bytes.
62  * \param pValue Value data.
63  *
64  * \return Number of bytes written.
65  */
66 /*************************************************************************************************/
67 uint16_t AppParamWrite(uint16_t id, uint16_t valueLen, const uint8_t *pValue);
68 
69 /*************************************************************************************************/
70 /*!
71  * \brief Read parameter value.
72  *
73  * \param id Identifier.
74  * \param valueLen Maximum value length in bytes.
75  * \param pValue Storage value data.
76  *
77  * \return Number of bytes read.
78  */
79 /*************************************************************************************************/
80 uint16_t AppParamRead(uint16_t id, uint16_t valueLen, uint8_t *pValue);
81 
82 /**@}*/
83 
84 /*! \} */ /*! APP_FRAMEWORK_PARAM_API */
85 
86 #ifdef __cplusplus
87 };
88 #endif
89 
90 #endif /* APP_PARAM_H */
void AppParamInit(void)
Initialize the parameter database.
void AppParamClear(void)
Clear the parameter database.
uint16_t AppParamWrite(uint16_t id, uint16_t valueLen, const uint8_t *pValue)
Write parameter value.
unsigned short uint16_t
Unsigned 16-bit value.
Definition: wsf_types.h:67
uint16_t AppParamRead(uint16_t id, uint16_t valueLen, uint8_t *pValue)
Read parameter value.
unsigned char uint8_t
Unsigned 8-bit value.
Definition: wsf_types.h:63