RDK Documentation (Open Sourced RDK Components)
dsError.h
Go to the documentation of this file.
1 /*
2  * If not stated otherwise in this file or this component's Licenses.txt file the
3  * following copyright and licenses apply:
4  *
5  * Copyright 2016 RDK Management
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18 */
19 
20 /**
21  * @file
22  *
23  * @brief Device Settings HAL error codes.
24  *
25  * This API defines common error codes used by the Device Settings HAL.
26  *
27  * @par Document
28  * Document reference.
29  *
30  * @par Open Issues (in no particular order)
31  * -# None
32  *
33  * @par Assumptions
34  * -# None
35  *
36  * @par Abbreviations
37  * - BE: Big-Endian.
38  * - cb: Callback function (suffix).
39  * - DS: Device Settings.
40  * - FPD: Front-Panel Display.
41  * - HAL: Hardware Abstraction Layer.
42  * - LE: Little-Endian.
43  * - LS: Least Significant.
44  * - MBZ: Must be zero.
45  * - MS: Most Significant.
46  * - RDK: Reference Design Kit.
47  * - _t: Type (suffix).
48  *
49  * @par Implementation Notes
50  * -# None
51  *
52  */
53 
54 
55 
56 /**
57 * @defgroup devicesettings
58 * @{
59 * @defgroup hal
60 * @{
61 **/
62 
63 
64 #ifndef _DS_ERROR_H_
65 #define _DS_ERROR_H_
66 
67 #ifdef __cplusplus
68 extern "C" {
69 #endif
70 
71 /** @addtogroup DSHAL_ERROR Device Settings HAL Error Codes
72 * @ingroup DSHAL_API
73 *
74 * Defined hereunder are the error codes that are used in the Device Settings library.
75 * @{
76 */
77 
78 /**
79  * @brief Device Settings API Error return codes.
80  *
81  * A non-zero value indicates an error.
82  *
83  */
84 typedef enum {
85  dsERR_NONE = 0, /**< No error (success). */
86  dsERR_GENERAL = 0x1000, /**< General failure to take action. */
87  dsERR_INVALID_PARAM, /**< Invalid input parameter. */
88  dsERR_INVALID_STATE, /**< Failure due to invalid state. */
89  dsERR_OPERATION_NOT_SUPPORTED, /**< Operation not supported. */
90  dsERR_UNKNOWN /**< Unknown error. */
91 } dsError_t;
92 
93 /* End of DSHAL_ERROR doxygen group */
94 /**
95  * @}
96  */
97 
98 #ifdef __cplusplus
99 }
100 #endif
101 #endif /* _DS_ERROR_H_ */
102 
103 
104 /** @} */
105 /** @} */
dsERR_UNKNOWN
@ dsERR_UNKNOWN
Definition: dsError.h:90
dsERR_INVALID_STATE
@ dsERR_INVALID_STATE
Definition: dsError.h:88
dsERR_GENERAL
@ dsERR_GENERAL
Definition: dsError.h:86
dsERR_NONE
@ dsERR_NONE
Definition: dsError.h:85
dsERR_OPERATION_NOT_SUPPORTED
@ dsERR_OPERATION_NOT_SUPPORTED
Definition: dsError.h:89
dsERR_INVALID_PARAM
@ dsERR_INVALID_PARAM
Definition: dsError.h:87
dsError_t
dsError_t
Device Settings API Error return codes.
Definition: dsError.h:84