• 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 /**
33  * @defgroup los_context hardware
34  * @ingroup kernel
35  */
36 
37 #ifndef _LOS_CONTEXT_H
38 #define _LOS_CONTEXT_H
39 
40 #include "los_compiler.h"
41 #include "los_interrupt.h"
42 
43 #ifdef __cplusplus
44 #if __cplusplus
45 extern "C" {
46 #endif /* __cplusplus */
47 #endif /* __cplusplus */
48 
49 /**
50  * @ingroup  los_context
51  * @brief: Task stack initialization.
52  *
53  * @par Description:
54  * This API is used to initialize the task stack.
55  *
56  * @attention:
57  * <ul><li>None.</li></ul>
58  *
59  * @param  taskID     [IN] Type#UINT32: TaskID.
60  * @param  stackSize  [IN] Type#UINT32: Total size of the stack.
61  * @param  topStack   [IN] Type#VOID *: Top of task's stack.
62  *
63  * @retval: context Type#TaskContext *.
64  * @par Dependency:
65  * <ul><li>los_context.h: the header file that contains the API declaration.</li></ul>
66  * @see None.
67  */
68 VOID *ArchTskStackInit(UINT32 taskID, UINT32 stackSize, VOID *topStack);
69 
70 /**
71  * @ingroup  los_context
72  * @brief: Function to sys exit.
73  *
74  * @par Description:
75  * This API is used to sys exit.
76  *
77  * @attention:
78  * <ul><li>None.</li></ul>
79  *
80  * @param  None.
81  *
82  * @retval: None.
83  * @par Dependency:
84  * <ul><li>los_context.h: the header file that contains the API declaration.</li></ul>
85  * @see None.
86  */
87 LITE_OS_SEC_TEXT_MINOR NORETURN VOID ArchSysExit(VOID);
88 
89 /**
90  * @ingroup  los_context
91  * @brief: Task scheduling Function.
92  *
93  * @par Description:
94  * This API is used to scheduling task.
95  *
96  * @attention:
97  * <ul><li>None.</li></ul>
98  *
99  * @param  None.
100  *
101  * @retval: None.
102  * @par Dependency:
103  * <ul><li>los_context.h: the header file that contains the API declaration.</li></ul>
104  * @see None.
105  */
106 VOID ArchTaskSchedule(VOID);
107 
108 UINT32 ArchStartSchedule(VOID);
109 VOID *ArchSignalContextInit(VOID *stackPointer, VOID *stackTop, UINTPTR sigHandler, UINT32 param);
110 
111 #ifdef __cplusplus
112 #if __cplusplus
113 }
114 #endif /* __cplusplus */
115 #endif /* __cplusplus */
116 
117 #endif /* _LOS_CONTEXT_H */
118