• 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 #ifndef _LOS_TICK_PRI_H
33 #define _LOS_TICK_PRI_H
34 
35 #include "los_base.h"
36 #include "los_tick.h"
37 #include "los_spinlock.h"
38 
39 #ifdef __cplusplus
40 #if __cplusplus
41 extern "C" {
42 #endif /* __cplusplus */
43 #endif /* __cplusplus */
44 
45 /**
46  * @ingroup los_tick
47  * Cycle to nanosecond scale
48  */
49 extern DOUBLE g_cycle2NsScale;
50 
51 /**
52 * @ingroup  los_tick
53 * @brief Handle the system tick timeout.
54 *
55 * @par Description:
56 * This API is called when the system tick timeout and triggers the interrupt.
57 *
58 * @attention
59 * <ul>
60 * <li>None.</li>
61 * </ul>
62 *
63 * @param none.
64 *
65 * @retval None.
66 * @par Dependency:
67 * <ul><li>los_tick.h: the header file that contains the API declaration.</li></ul>
68 * @see None.
69 */
70 extern VOID OsTickHandler(VOID);
71 
72 /**
73  * @ingroup los_tick
74  * Convert from the cycle count to nanosecond.
75  */
76 #define CYCLE_TO_NS(cycles) ((cycles) * g_cycle2NsScale)
77 
78 /**
79  * Current system timer register is 32 bit, therefore TIMER_MAXLOAD define just in order to avoid ambiguity.
80  */
81 #define TIMER_MAXLOAD 0xffffffff
82 
83 #ifdef __cplusplus
84 #if __cplusplus
85 }
86 #endif /* __cplusplus */
87 #endif /* __cplusplus */
88 
89 #endif /* _LOS_TICK_PRI_H */
90