• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved.
3  * Copyright (c) 2020-2021 Huawei Device Co., Ltd. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without modification,
6  * are permitted provided that the following conditions are met:
7  *
8  * 1. Redistributions of source code must retain the above copyright notice, this list of
9  *    conditions and the following disclaimer.
10  *
11  * 2. Redistributions in binary form must reproduce the above copyright notice, this list
12  *    of conditions and the following disclaimer in the documentation and/or other materials
13  *    provided with the distribution.
14  *
15  * 3. Neither the name of the copyright holder nor the names of its contributors may be used
16  *    to endorse or promote products derived from this software without specific prior written
17  *    permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
21  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
22  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
26  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
27  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
28  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
29  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 /**
33  * @defgroup los_errno Error code
34  * @ingroup kernel
35  */
36 
37 #ifndef _LOS_ERRNO_H
38 #define _LOS_ERRNO_H
39 
40 #include "los_typedef.h"
41 
42 #ifdef __cplusplus
43 #if __cplusplus
44 extern "C" {
45 #endif /* __cplusplus */
46 #endif /* __cplusplus */
47 
48 /**
49  * @ingroup los_errno
50  * OS error code flag.
51  */
52 #define LOS_ERRNO_OS_ID (0x00U << 16)
53 
54 /**
55  * @ingroup los_errno
56  * Define the error level as informative.
57  */
58 #define LOS_ERRTYPE_NORMAL (0x00U << 24)
59 
60 /**
61  * @ingroup los_errno
62  * Define the error level as warning.
63  */
64 #define LOS_ERRTYPE_WARN (0x01U << 24)
65 
66 /**
67  * @ingroup los_errno
68  * Define the error level as critical.
69  */
70 #define LOS_ERRTYPE_ERROR (0x02U << 24)
71 
72 /**
73  * @ingroup los_errno
74  * Define the error level as fatal.
75  */
76 #define LOS_ERRTYPE_FATAL (0x03U << 24)
77 
78 /**
79  * @ingroup los_errno
80  * Define fatal OS errors.
81  */
82 #define LOS_ERRNO_OS_FATAL(MID, ERRNO) \
83     (LOS_ERRTYPE_FATAL | LOS_ERRNO_OS_ID | ((UINT32)(MID) << 8) | ((UINT32)(ERRNO)))
84 
85 /**
86  * @ingroup los_errno
87  * Define critical OS errors.
88  */
89 #define LOS_ERRNO_OS_ERROR(MID, ERRNO) \
90     (LOS_ERRTYPE_ERROR | LOS_ERRNO_OS_ID | ((UINT32)(MID) << 8) | ((UINT32)(ERRNO)))
91 
92 /**
93  * @ingroup los_errno
94  * Define warning OS errors.
95  */
96 #define LOS_ERRNO_OS_WARN(MID, ERRNO) \
97     (LOS_ERRTYPE_WARN | LOS_ERRNO_OS_ID | ((UINT32)(MID) << 8) | ((UINT32)(ERRNO)))
98 
99 /**
100  * @ingroup los_errno
101  * Define informative OS errors.
102  */
103 #define LOS_ERRNO_OS_NORMAL(MID, ERRNO) \
104     (LOS_ERRTYPE_NORMAL | LOS_ERRNO_OS_ID | ((UINT32)(MID) << 8) | ((UINT32)(ERRNO)))
105 
106 #ifdef __cplusplus
107 #if __cplusplus
108 }
109 #endif /* __cplusplus */
110 #endif /* __cplusplus */
111 
112 #endif /* _LOS_ERRNO_H */
113