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_SCHED_H
33 #define _LOS_SCHED_H
34
35 #include "los_task.h"
36 #include "los_interrupt.h"
37 #include "los_tick.h"
38 #include "los_sortlink.h"
39
40 #ifdef __cplusplus
41 #if __cplusplus
42 extern "C" {
43 #endif /* __cplusplus */
44 #endif /* __cplusplus */
45
46 #define OS_SCHED_MINI_PERIOD (g_sysClock / LOSCFG_BASE_CORE_TICK_PER_SECOND_MINI)
47 #define OS_SCHED_MAX_RESPONSE_TIME OS_SORT_LINK_UINT64_MAX
48
49 extern UINT32 g_taskScheduled;
50 typedef BOOL (*SchedScan)(VOID);
51
52 VOID OsSchedResetSchedResponseTime(UINT64 responseTime);
53
54 VOID OsSchedSetIdleTaskSchedParam(LosTaskCB *idleTask);
55
56 UINT32 OsSchedSwtmrScanRegister(SchedScan func);
57
58 VOID OsSchedUpdateExpireTime(VOID);
59
60 UINT64 OsSchedGetNextExpireTime(UINT64 startTime);
61
62 VOID OsSchedTaskDeQueue(LosTaskCB *taskCB);
63
64 VOID OsSchedTaskEnQueue(LosTaskCB *taskCB);
65
66 VOID OsSchedTaskWait(LOS_DL_LIST *list, UINT32 timeout);
67
68 VOID OsSchedTaskWake(LosTaskCB *resumedTask);
69
70 BOOL OsSchedModifyTaskSchedParam(LosTaskCB *taskCB, UINT16 priority);
71
72 VOID OsSchedDelay(LosTaskCB *runTask, UINT32 tick);
73
74 VOID OsSchedYield(VOID);
75
76 VOID OsSchedTaskExit(LosTaskCB *taskCB);
77
78 VOID OsSchedSuspend(LosTaskCB *taskCB);
79
80 BOOL OsSchedResume(LosTaskCB *taskCB);
81
82 VOID OsSchedTick(VOID);
83
84 UINT32 OsSchedInit(VOID);
85
86 VOID OsSchedStart(VOID);
87
88 BOOL OsSchedTaskSwitch(VOID);
89
90 LosTaskCB *OsGetTopTask(VOID);
91
OsGetCurrSchedTimeCycle(VOID)92 STATIC INLINE UINT64 OsGetCurrSchedTimeCycle(VOID)
93 {
94 return LOS_SysCycleGet();
95 }
96
97 /**
98 * @ingroup los_sched
99 * @brief Get the time, in nanoseconds, remaining before the next tick interrupt response.
100 *
101 * @par Description:
102 * This API is used to get the time, in nanoseconds, remaining before the next tick interrupt response.
103 *
104 * @attention None.
105 *
106 * @param None.
107 *
108 * @retval #time, in nanoseconds.
109 * @par Dependency:
110 * <ul><li>los_sched.h: the header file that contains the API declaration.</li></ul>
111 * @see
112 */
113 extern UINT64 LOS_SchedTickTimeoutNsGet(VOID);
114
115 /**
116 * @ingroup los_sched
117 * @brief The system-provided tick interrupt handler.
118 *
119 * @par Description:
120 * This API is used to wake up a task that is blocked by time.
121 *
122 * @attention None.
123 *
124 * @param None.
125 *
126 * @retval None.
127 * @par Dependency:
128 * <ul><li>los_sched.h: the header file that contains the API declaration.</li></ul>
129 * @see
130 */
131 extern VOID LOS_SchedTickHandler(VOID);
132
133 /**
134 * @ingroup los_sched
135 * @brief Trigger a system dispatch.
136 *
137 * @par Description:
138 * This API is used to trigger a system dispatch.
139 *
140 * @attention None.
141 *
142 * @param None.
143 *
144 * @retval None.
145 * @par Dependency:
146 * <ul><li>los_sched.h: the header file that contains the API declaration.</li></ul>
147 * @see
148 */
149 extern VOID LOS_Schedule(VOID);
150
151 #ifdef __cplusplus
152 #if __cplusplus
153 }
154 #endif /* __cplusplus */
155 #endif /* __cplusplus */
156
157 #endif /* _LOS_SCHED_H */
158