aboutsummaryrefslogtreecommitdiffstats
path: root/ports/ARM7/chcore.h
blob: ae914b8bdbf625dce26b79565d10e259f43012fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
/*
    ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.

    This file is part of ChibiOS/RT.

    ChibiOS/RT is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 3 of the License, or
    (at your option) any later version.

    ChibiOS/RT is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

/**
 * @addtogroup ARM7_CORE
 * @{
 */

#ifndef _CHCORE_H_
#define _CHCORE_H_

/**
 * Macro defining the ARM7 architecture.
 */
#define CH_ARCHITECTURE_ARM7

/**
 * 32 bit stack alignment.
 */
typedef uint32_t stkalign_t;

/**
 * Generic ARM register.
 */
typedef void *regarm_t;

/**
 * Interrupt saved context.
 * This structure represents the stack frame saved during a preemption-capable
 * interrupt handler.
 */
struct extctx {
  regarm_t      spsr_irq;
  regarm_t      lr_irq;
  regarm_t      r0;
  regarm_t      r1;
  regarm_t      r2;
  regarm_t      r3;
  regarm_t      r12;
  regarm_t      lr_usr;
};

/**
 * System saved context.
 * This structure represents the inner stack frame during a context switching.
 */
struct intctx {
  regarm_t      r4;
  regarm_t      r5;
  regarm_t      r6;
#ifndef CH_CURRP_REGISTER_CACHE
  regarm_t      r7;
#endif
  regarm_t      r8;
  regarm_t      r9;
  regarm_t      r10;
  regarm_t      r11;
  regarm_t      lr;
};

/**
 * Platform dependent part of the @p Thread structure.
 * In the ARM7 port this structure contains just the copy of the user mode
 * stack pointer.
 */
typedef struct {
  struct intctx *r13;
} Context;

/**
 * Platform dependent part of the @p chThdInit() API.
 */
#define SETUP_CONTEXT(workspace, wsize, pf, arg) {                      \
  tp->p_ctx.r13 = (struct intctx *)((uint8_t *)workspace +              \
                                     wsize -                            \
                                     sizeof(struct intctx));            \
  tp->p_ctx.r13->r4 = pf;                                               \
  tp->p_ctx.r13->r5 = arg;                                              \
  tp->p_ctx.r13->lr = _sys_thread_start;                                \
}

/**
 * Stack size for the system idle thread.
 */
#ifndef IDLE_THREAD_STACK_SIZE
#define IDLE_THREAD_STACK_SIZE 0
#endif

/**
 * Per-thread stack overhead for interrupts servicing, it is used in the
 * calculation of the correct working area size.
 * In this port 0x10 is a safe value, it can be reduced after careful generated
 * code analysis.
 */
#ifndef INT_REQUIRED_STACK
#define INT_REQUIRED_STACK 0x10
#endif

/**
 * Enforces a correct alignment for a stack area size value.
 */
#define STACK_ALIGN(n) ((((n) - 1) | sizeof(stkalign_t)) + 1)

 /**
  * Computes the thread working area global size.
  */
#define THD_WA_SIZE(n) STACK_ALIGN(sizeof(Thread) +                     \
                                   sizeof(struct intctx) +              \
                                   sizeof(struct extctx) +              \
                                  (n) + (INT_REQUIRED_STACK))

/**
 * Macro used to allocate a thread working area aligned as both position and
 * size.
 */
#define WORKING_AREA(s, n) stkalign_t s[THD_WA_SIZE(n) / sizeof(stkalign_t)];

/**
 * IRQ prologue code, inserted at the start of all IRQ handlers enabled to
 * invoke system APIs.
 * @note This macro has a different implementation depending if compiled in
 *       ARM or THUMB mode.
 */
#ifdef THUMB
#define SYS_IRQ_PROLOGUE() {                                            \
  asm volatile (".code 32                                 \n\t"         \
                "stmfd    sp!, {r0-r3, r12, lr}           \n\t"         \
                "add      r0, pc, #1                      \n\t"         \
                "bx       r0                              \n\t"         \
                ".code 16");                                            \
}
#else /* THUMB */
#define SYS_IRQ_PROLOGUE() {                                            \
  asm volatile ("stmfd    sp!, {r0-r3, r12, lr}");                      \
}
#endif /* !THUMB */

/**
 * IRQ epilogue code, inserted at the end of all IRQ handlers enabled to
 * invoke system APIs.
 * @note This macro has a different implementation depending if compiled in
 *       ARM or THUMB mode.
 */
#ifdef THUMB
#define SYS_IRQ_EPILOGUE() {                                            \
  asm volatile ("ldr      r0, =_sys_irq_common            \n\t"         \
                "bx       r0");                                         \
}
#else /* THUMB */
#define SYS_IRQ_EPILOGUE() {                                            \
  asm volatile ("b        _sys_irq_common");                            \
}
#endif /* !THUMB */

/**
 * IRQ handler function modifier.
 */
#define SYS_IRQ_HANDLER __attribute__((naked))

/**
 * Performs a context switch between two threads.
 * @param otp the thread to be switched out
 * @param ntp the thread to be switched in
 * @note This macro has a different implementation depending if compiled in
 *       ARM or THUMB mode.
 * @note This macro assumes to be invoked in ARM system mode.
 */
#ifdef THUMB
#define sys_switch(otp, ntp) _sys_switch_thumb(otp, ntp)
#else /* THUMB */
#define sys_switch(otp, ntp) _sys_switch_arm(otp, ntp)
#endif /* !THUMB */

/**
 * In this port this macro disables the IRQ sources.
 * @note This macro has a different implementation depending if compiled in
 *       ARM or THUMB mode.
 * @note This macro assumes to be invoked in ARM system mode.
 */
#ifdef THUMB
#define sys_disable() _sys_disable_thumb()
#else /* THUMB */
#define sys_disable() asm volatile ("msr     CPSR_c, #0x9F")
#endif /* !THUMB */

/**
 * This port function is implemented as inlined code for performance reasons.
 * @note This macro has a different implementation depending if compiled in
 *       ARM or THUMB mode.
 * @note This macro assumes to be invoked in ARM system mode.
 */
#ifdef THUMB
#define sys_enable() _sys_enable_thumb()
#else /* THUMB */
#define sys_enable() asm volatile ("msr     CPSR_c, #0x1F")
#endif /* !THUMB */

/**
 * This function is empty in this port.
 */
#define sys_disable_from_isr()

/**
 * This function is empty in this port.
 */
#define sys_enable_from_isr()

/**
 * Disables all the interrupt sources, even those having a priority higher
 * to the kernel.
 * In the ARM7 port this code disables both IRQ and FIQ sources.
 */
#ifdef THUMB
#define sys_disable_all() _sys_disable_all_thumb()
#else /* THUMB */
#define sys_disable_all() {                                             \
  asm volatile ("mrs     r3, CPSR                         \n\t"         \
                "orr     r3, #0x80                        \n\t"         \
                "msr     CPSR_c, r3                       \n\t"         \
                "orr     r3, #0x40                        \n\t"         \
                "msr     CPSR_c, r3" : : : "r3");                       \
}
#endif /* !THUMB */

#ifdef __cplusplus
extern "C" {
#endif
  void sys_puts(char *msg);
  void sys_wait_for_interrupt(void);
  void sys_halt(void);
  void _sys_enable_thumb(void);
  void _sys_disable_thumb(void);
#ifdef THUMB
  void _sys_switch_thumb(Thread *otp, Thread *ntp);
#else /* THUMB */
  void _sys_switch_arm(Thread *otp, Thread *ntp);
#endif /* !THUMB */
  void _sys_thread_start(void);
#ifdef __cplusplus
}
#endif

#endif /* _CHCORE_H_ */

/** @} */