1 /* 2 * Copyright (c) 2013-2019 Huawei Technologies Co., Ltd. All rights reserved. 3 * Copyright (c) 2022-2022 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 _RTC_TIME_HOOK_H 33 #define _RTC_TIME_HOOK_H 34 35 #include "los_config.h" 36 37 #ifdef __cplusplus 38 #if __cplusplus 39 extern "C" { 40 #endif /* __cplusplus */ 41 #endif /* __cplusplus */ 42 43 44 /* 45 * RTC interfaces for improving the accuracy of the time, need implement and 46 * register by user, implementation method is as follows: 47 * 48 * UINT64 RtcGetTickHook(VOID) 49 * brief: supplement expanded ticks 50 * input: VOID 51 * return: UINT64 ticks 52 * 53 * INT32 RtcGetTimeHook(UINT64 *usec) 54 * brief: get RTC time 55 * output: UINT64 *usec, pointer to get the time, value is counted in microsecond(us) 56 * return: non-0 if error, 0 if success. 57 * 58 * INT32 RtcSetTimeHook(UINT64 msec, UINT64 *usec) 59 * brief: set RTC time 60 * input: UINT64 msec, the time to be set counted in millisecond(ms). 61 * input: UINT64 *usec, the time to be set counted in microsecond(us) 62 * return: non-0 if error, 0 if success. 63 * 64 * INT32 RtcGetTimezoneHook(INT32 *tz) 65 * brief: get RTC timezone 66 * output: INT32 *tz, pointer to get the timezone, value is counted in second 67 * return: non-0 if error, 0 if success. 68 * 69 * INT32 RtcSetTimezoneHook(INT32 tz) 70 * brief: set RTC timezone 71 * input: INT32 tz, the timezone to be set, value is counted in second 72 * return: non-0 if error, 0 if success. 73 */ 74 struct RtcTimeHook { 75 UINT64 (*RtcGetTickHook)(VOID); 76 INT32 (*RtcGetTimeHook)(UINT64 *usec); 77 INT32 (*RtcSetTimeHook)(UINT64 msec, UINT64 *usec); 78 INT32 (*RtcGetTimezoneHook)(INT32 *tz); 79 INT32 (*RtcSetTimezoneHook)(INT32 tz); 80 }; 81 82 /* 83 * @brief let user register a RTC getter hook to improve time accuracy for time-related POSIX methods. 84 * @param cfg, a structure, member is pointer to function to be registered 85 * @return VOID. 86 */ 87 VOID LOS_RtcHookRegister(struct RtcTimeHook *cfg); 88 89 #ifdef __cplusplus 90 #if __cplusplus 91 extern "C" { 92 #endif /* __cplusplus */ 93 #endif /* __cplusplus */ 94 95 #endif 96