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_HOOK_H 33 #define _LOS_HOOK_H 34 35 #include "internal/los_hook_types.h" 36 #include "los_config.h" 37 #include "los_error.h" 38 39 #ifdef __cplusplus 40 #if __cplusplus 41 extern "C" { 42 #endif /* __cplusplus */ 43 #endif /* __cplusplus */ 44 45 #if (LOSCFG_DEBUG_HOOK == 1) 46 /** 47 * @ingroup los_hook 48 * Hook error code: The hook pool is insufficient. 49 * 50 * Value: 0x02001f00 51 * 52 * Solution: Deregister the registered hook. 53 */ 54 #define LOS_ERRNO_HOOK_POOL_IS_FULL LOS_ERRNO_OS_ERROR(LOS_MOD_HOOK, 0x00) 55 56 /** 57 * @ingroup los_hook 58 * Hook error code: Invalid parameter. 59 * 60 * Value: 0x02001f01 61 * 62 * Solution: Check the input parameters of LOS_HookReg. 63 */ 64 #define LOS_ERRNO_HOOK_REG_INVALID LOS_ERRNO_OS_ERROR(LOS_MOD_HOOK, 0x01) 65 66 /** 67 * @ingroup los_hook 68 * Hook error code: Invalid parameter. 69 * 70 * Value: 0x02001f02 71 * 72 * Solution: Check the input parameters of LOS_HookUnReg. 73 */ 74 #define LOS_ERRNO_HOOK_UNREG_INVALID LOS_ERRNO_OS_ERROR(LOS_MOD_HOOK, 0x02) 75 76 /** 77 * @ingroup los_hook 78 * @brief Registration of hook function. 79 * 80 * @par Description: 81 * This API is used to register hook function. 82 * 83 * @attention 84 * <ul> 85 * <li> None.</li> 86 * </ul> 87 * 88 * @param hookType [IN] Register the type of the hook. 89 * @param hookFn [IN] The function to be registered. 90 * 91 * @retval None. 92 * @par Dependency: 93 * <ul><li>los_hook.h: the header file that contains the API declaration.</li></ul> 94 * @see 95 */ 96 #define LOS_HookReg(hookType, hookFn) hookType##_RegHook(hookFn) 97 98 /** 99 * @ingroup los_hook 100 * @brief Deregistration of hook function. 101 * 102 * @par Description: 103 * This API is used to deregister hook function. 104 * 105 * @attention 106 * <ul> 107 * <li> None.</li> 108 * </ul> 109 * 110 * @param hookType [IN] Deregister the type of the hook. 111 * @param hookFn [IN] The function to be deregistered. 112 * 113 * @retval None. 114 * @par Dependency: 115 * <ul><li>los_hook.h: the header file that contains the API declaration.</li></ul> 116 * @see 117 */ 118 #define LOS_HookUnReg(hookType, hookFn) hookType##_UnRegHook(hookFn) 119 120 /** 121 * Call hook functions. 122 */ 123 #define OsHookCall(hookType, ...) hookType##_CallHook(__VA_ARGS__) 124 125 #else 126 #define LOS_HookReg(hookType, hookFn) 127 #define LOS_HookUnReg(hookType, hookFn) 128 #define OsHookCall(hookType, ...) 129 #endif 130 131 #ifdef __cplusplus 132 #if __cplusplus 133 } 134 #endif /* __cplusplus */ 135 #endif /* __cplusplus */ 136 137 #endif /* _LOS_HOOK_H */ 138