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 #ifndef _LOS_ERR_PRI_H 33 #define _LOS_ERR_PRI_H 34 35 #include "los_err.h" 36 37 #ifdef __cplusplus 38 #if __cplusplus 39 extern "C" { 40 #endif /* __cplusplus */ 41 #endif /* __cplusplus */ 42 43 /** 44 * @ingroup los_err 45 * Define the error magic word. 46 */ 47 #define OS_ERR_MAGIC_WORD 0xa1b2c3f8 48 49 /** 50 * @ingroup los_err 51 * @brief Error handling macro capable of returning error codes. 52 * 53 * @par Description: 54 * This API is used to call the error handling function by using an error code and return the same error code. 55 * @attention 56 * <ul> 57 * <li>None.</li> 58 * </ul> 59 * 60 * @param errNo [IN] Error code. 61 * 62 * @retval errNo 63 * @par Dependency: 64 * <ul><li>los_err_pri.h: the header file that contains the API declaration.</li></ul> 65 * @see None. 66 */ 67 #define OS_RETURN_ERROR(errNo) do { \ 68 (VOID)LOS_ErrHandle("os_unspecific_file", OS_ERR_MAGIC_WORD, errNo, 0, NULL); \ 69 return errNo; \ 70 } while (0) 71 72 /** 73 * @ingroup los_err 74 * @brief Error handling macro capable of returning error codes. 75 * 76 * @par Description: 77 * This API is used to call the error handling function by using an error code and the line number of 78 * the erroneous line, and return the same error code. 79 * @attention 80 * <ul> 81 * <li>None.</li> 82 * </ul> 83 * 84 * @param errLine [IN] Line number of the erroneous line. 85 * @param errNo [IN] Error code. 86 * 87 * @retval errNo 88 * @par Dependency: 89 * <ul><li>los_err_pri.h: the header file that contains the API declaration.</li></ul> 90 * @see None. 91 */ 92 #define OS_RETURN_ERROR_P2(errLine, errNo) do { \ 93 (VOID)LOS_ErrHandle("os_unspecific_file", errLine, errNo, 0, NULL); \ 94 return errNo; \ 95 } while (0) 96 97 /** 98 * @ingroup los_err 99 * @brief Macro for jumping to error handler. 100 * 101 * @par Description: 102 * This API is used to call the error handling function by using an error code. 103 * @attention 104 * <ul> 105 * <li>None.</li> 106 * </ul> 107 * 108 * @param errorNo [IN] Error code. 109 * 110 * @retval None. 111 * @par Dependency: 112 * <ul><li>los_err_pri.h: the header file that contains the API declaration.</li></ul> 113 * @see None. 114 */ 115 #define OS_GOTO_ERR_HANDLER(errorNo) do { \ 116 errNo = errorNo; \ 117 errLine = OS_ERR_MAGIC_WORD; \ 118 goto ERR_HANDLER; \ 119 } while (0) 120 121 #ifdef __cplusplus 122 #if __cplusplus 123 } 124 #endif /* __cplusplus */ 125 #endif /* __cplusplus */ 126 127 #endif /* _LOS_ERR_PRI_H */ 128