1 |
786 |
skrzyp |
#ifndef CYGONCE_HAL_ARCH_H
|
2 |
|
|
#define CYGONCE_HAL_ARCH_H
|
3 |
|
|
|
4 |
|
|
//==========================================================================
|
5 |
|
|
//
|
6 |
|
|
// hal_arch.h
|
7 |
|
|
//
|
8 |
|
|
// Architecture specific abstractions
|
9 |
|
|
//
|
10 |
|
|
//==========================================================================
|
11 |
|
|
// ####ECOSGPLCOPYRIGHTBEGIN####
|
12 |
|
|
// -------------------------------------------
|
13 |
|
|
// This file is part of eCos, the Embedded Configurable Operating System.
|
14 |
|
|
// Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
|
15 |
|
|
//
|
16 |
|
|
// eCos is free software; you can redistribute it and/or modify it under
|
17 |
|
|
// the terms of the GNU General Public License as published by the Free
|
18 |
|
|
// Software Foundation; either version 2 or (at your option) any later
|
19 |
|
|
// version.
|
20 |
|
|
//
|
21 |
|
|
// eCos is distributed in the hope that it will be useful, but WITHOUT
|
22 |
|
|
// ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
|
23 |
|
|
// FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
|
24 |
|
|
// for more details.
|
25 |
|
|
//
|
26 |
|
|
// You should have received a copy of the GNU General Public License
|
27 |
|
|
// along with eCos; if not, write to the Free Software Foundation, Inc.,
|
28 |
|
|
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
29 |
|
|
//
|
30 |
|
|
// As a special exception, if other files instantiate templates or use
|
31 |
|
|
// macros or inline functions from this file, or you compile this file
|
32 |
|
|
// and link it with other works to produce a work based on this file,
|
33 |
|
|
// this file does not by itself cause the resulting work to be covered by
|
34 |
|
|
// the GNU General Public License. However the source code for this file
|
35 |
|
|
// must still be made available in accordance with section (3) of the GNU
|
36 |
|
|
// General Public License v2.
|
37 |
|
|
//
|
38 |
|
|
// This exception does not invalidate any other reasons why a work based
|
39 |
|
|
// on this file might be covered by the GNU General Public License.
|
40 |
|
|
// -------------------------------------------
|
41 |
|
|
// ####ECOSGPLCOPYRIGHTEND####
|
42 |
|
|
//==========================================================================
|
43 |
|
|
//#####DESCRIPTIONBEGIN####
|
44 |
|
|
//
|
45 |
|
|
// Author(s): nickg, gthomas, hmt
|
46 |
|
|
// Contributors: nickg, gthomas, hmt
|
47 |
|
|
// Date: 1999-02-20
|
48 |
|
|
// Purpose: Define architecture abstractions
|
49 |
|
|
// Usage: #include <cyg/hal/hal_arch.h>
|
50 |
|
|
//
|
51 |
|
|
//####DESCRIPTIONEND####
|
52 |
|
|
//
|
53 |
|
|
//==========================================================================
|
54 |
|
|
|
55 |
|
|
#include <pkgconf/hal.h>
|
56 |
|
|
#include <pkgconf/hal_sparc.h>
|
57 |
|
|
|
58 |
|
|
#include <cyg/infra/cyg_type.h>
|
59 |
|
|
|
60 |
|
|
#include <cyg/hal/hal_intr.h> // HAL_DISABLE_INTERRUPTS
|
61 |
|
|
|
62 |
|
|
//--------------------------------------------------------------------------
|
63 |
|
|
// Processor saved states:
|
64 |
|
|
//
|
65 |
|
|
// All these structures must be doubleword (64 bit) aligned.
|
66 |
|
|
// The code that creates them on the stack will ensure this is so.
|
67 |
|
|
|
68 |
|
|
#define HAL_THREAD_CONTEXT_GLOBAL_BASE 0
|
69 |
|
|
#define HAL_THREAD_CONTEXT_OUT_BASE 8
|
70 |
|
|
#define HAL_THREAD_CONTEXT_LOCAL_BASE 16
|
71 |
|
|
#define HAL_THREAD_CONTEXT_IN_BASE 24
|
72 |
|
|
|
73 |
|
|
typedef struct
|
74 |
|
|
{
|
75 |
|
|
// this is the save structure found at *(stack_ptr) always, note that
|
76 |
|
|
// i[6] is the frame pointer is the previous stack pointer, and
|
77 |
|
|
// o[6] is the stack pointer is the next frame pointer,
|
78 |
|
|
// so they form a linked list back up the call stack.
|
79 |
|
|
cyg_uint32 l[8]; /* Locals r16-r23 */
|
80 |
|
|
cyg_uint32 i[8]; /* Ins r24-r31 */
|
81 |
|
|
} HAL_SavedWindow;
|
82 |
|
|
|
83 |
|
|
typedef struct
|
84 |
|
|
{
|
85 |
|
|
// Window save at stack pointer
|
86 |
|
|
HAL_SavedWindow li;
|
87 |
|
|
//16
|
88 |
|
|
// This is the rest of the save state:
|
89 |
|
|
// NOTE: g[0] is used for the CWP, for %g0 == 0. Also note that the
|
90 |
|
|
// assembler routines must load/store it in the right order.
|
91 |
|
|
cyg_uint32 g[8] ; /* Globals r0- r7 */
|
92 |
|
|
cyg_uint32 o[8] ; /* Outs r8-r15 */
|
93 |
|
|
//32 words in size
|
94 |
|
|
|
95 |
|
|
// There is no need to save any other state; for example, condition codes,
|
96 |
|
|
// the PC and NextPC, and Y, are preserved in local registers in the trap
|
97 |
|
|
// handling window and so preserved in the caller stack frame as viewed
|
98 |
|
|
// from an ISR. Note that the VSR is jumped to with those locals being set
|
99 |
|
|
// up (and Y in situ), and it must preserve them itself before calling any
|
100 |
|
|
// subsequent handlers (ISRs).
|
101 |
|
|
|
102 |
|
|
} HAL_SavedRegisters;
|
103 |
|
|
|
104 |
|
|
|
105 |
|
|
typedef struct
|
106 |
|
|
{
|
107 |
|
|
// Window save at stack pointer
|
108 |
|
|
HAL_SavedWindow li;
|
109 |
|
|
cyg_uint32 composite_return_ptr; /* structure returns */
|
110 |
|
|
cyg_uint32 spill_args[6]; /* for callee to store */
|
111 |
|
|
cyg_uint32 spare; /* keep this 64-bits */
|
112 |
|
|
} HAL_FrameStructure;
|
113 |
|
|
|
114 |
|
|
|
115 |
|
|
//--------------------------------------------------------------------------
|
116 |
|
|
// Exception handling function.
|
117 |
|
|
// This function is defined by the kernel according to this prototype. It is
|
118 |
|
|
// invoked from the HAL to deal with any CPU exceptions that the HAL does
|
119 |
|
|
// not want to deal with itself. It usually invokes the kernel's exception
|
120 |
|
|
// delivery mechanism.
|
121 |
|
|
|
122 |
|
|
externC void cyg_hal_deliver_exception( CYG_WORD code, CYG_ADDRWORD data );
|
123 |
|
|
|
124 |
|
|
//--------------------------------------------------------------------------
|
125 |
|
|
// Bit manipulation macros
|
126 |
|
|
#ifndef CYGPKG_HAL_SPARC_SCAN
|
127 |
|
|
/* Most sparc's does not have 'scan' instruction */
|
128 |
|
|
externC cyg_uint32 hal_lsbit_index(cyg_uint32 mask);
|
129 |
|
|
externC cyg_uint32 hal_msbit_index(cyg_uint32 mask);
|
130 |
|
|
#define HAL_LSBIT_INDEX(index, mask) index = hal_lsbit_index(mask);
|
131 |
|
|
#define HAL_MSBIT_INDEX(index, mask) index = hal_msbit_index(mask);
|
132 |
|
|
#else
|
133 |
|
|
#define HAL_LSBIT_INDEX(index, mask) \
|
134 |
|
|
CYG_MACRO_START \
|
135 |
|
|
asm volatile ( \
|
136 |
|
|
"scan %1, 0, %%l7;" \
|
137 |
|
|
"mov 31, %0;" \
|
138 |
|
|
"sub %0, %%l7, %0" \
|
139 |
|
|
: "=r"(index) \
|
140 |
|
|
: "r"(mask & ~(mask-1)) \
|
141 |
|
|
: "l7" \
|
142 |
|
|
); \
|
143 |
|
|
CYG_MACRO_END
|
144 |
|
|
|
145 |
|
|
#define HAL_MSBIT_INDEX(index, mask) \
|
146 |
|
|
CYG_MACRO_START \
|
147 |
|
|
asm volatile ( \
|
148 |
|
|
"scan %1, 0, %%l7;" \
|
149 |
|
|
"mov 31, %0;" \
|
150 |
|
|
"sub %0, %%l7, %0" \
|
151 |
|
|
: "=r"(index) \
|
152 |
|
|
: "r"(mask) \
|
153 |
|
|
: "l7" \
|
154 |
|
|
); \
|
155 |
|
|
CYG_MACRO_END
|
156 |
|
|
#endif
|
157 |
|
|
|
158 |
|
|
//--------------------------------------------------------------------------
|
159 |
|
|
// Context Initialization
|
160 |
|
|
// Initialize the context of a thread.
|
161 |
|
|
// Arguments:
|
162 |
|
|
// _sparg_ name of variable containing current sp, will be written with new sp
|
163 |
|
|
// _thread_ thread object address, passed as argument to entry point
|
164 |
|
|
// _entry_ entry point address.
|
165 |
|
|
// _id_ bit pattern used in initializing registers, for debugging.
|
166 |
|
|
|
167 |
|
|
externC CYG_ADDRESS
|
168 |
|
|
hal_thread_init_context( CYG_WORD sparg,
|
169 |
|
|
CYG_WORD thread,
|
170 |
|
|
CYG_WORD entry,
|
171 |
|
|
CYG_WORD id );
|
172 |
|
|
|
173 |
|
|
#define HAL_THREAD_INIT_CONTEXT( _sparg_, _thread_, _entry_, _id_ ) \
|
174 |
|
|
CYG_MACRO_START \
|
175 |
|
|
_sparg_ = hal_thread_init_context( (CYG_WORD)(_sparg_), \
|
176 |
|
|
(CYG_WORD)(_thread_), \
|
177 |
|
|
(CYG_WORD)(_entry_), \
|
178 |
|
|
(CYG_WORD)(_id_) ); \
|
179 |
|
|
CYG_MACRO_END
|
180 |
|
|
|
181 |
|
|
//---------------------------------------------------------------------------
|
182 |
|
|
// Context switch macros.
|
183 |
|
|
// The arguments are pointers to locations where the stack pointer
|
184 |
|
|
// of the current thread is to be stored, and from where the sp of the
|
185 |
|
|
// next thread is to be fetched.
|
186 |
|
|
|
187 |
|
|
externC void hal_thread_switch_context( CYG_ADDRESS to, CYG_ADDRESS from );
|
188 |
|
|
externC void hal_thread_load_context( CYG_ADDRESS to )
|
189 |
|
|
__attribute__ ((noreturn));
|
190 |
|
|
|
191 |
|
|
#define HAL_THREAD_SWITCH_CONTEXT(_fspptr_,_tspptr_) \
|
192 |
|
|
hal_thread_switch_context((CYG_ADDRESS)_tspptr_, \
|
193 |
|
|
(CYG_ADDRESS)_fspptr_);
|
194 |
|
|
|
195 |
|
|
#define HAL_THREAD_LOAD_CONTEXT(_tspptr_) \
|
196 |
|
|
hal_thread_load_context( (CYG_ADDRESS)_tspptr_ );
|
197 |
|
|
|
198 |
|
|
|
199 |
|
|
//---------------------------------------------------------------------------
|
200 |
|
|
// Execution reorder barrier.
|
201 |
|
|
// When optimizing the compiler can reorder code. In multithreaded systems
|
202 |
|
|
// where the order of actions is vital, this can sometimes cause problems.
|
203 |
|
|
// This macro may be inserted into places where reordering should not happen.
|
204 |
|
|
|
205 |
|
|
#define HAL_REORDER_BARRIER() asm volatile ( "" : : : "memory" )
|
206 |
|
|
|
207 |
|
|
//---------------------------------------------------------------------------
|
208 |
|
|
// Breakpoint support
|
209 |
|
|
// HAL_BREAKPOINT() is a code sequence that will cause a breakpoint to happen
|
210 |
|
|
// if executed.
|
211 |
|
|
// HAL_BREAKINST is the value of the breakpoint instruction and
|
212 |
|
|
// HAL_BREAKINST_SIZE is its size in bytes.
|
213 |
|
|
|
214 |
|
|
#define HAL_BREAKPOINT(_label_) \
|
215 |
|
|
asm volatile (" .globl " #_label_ ";" \
|
216 |
|
|
#_label_":" \
|
217 |
|
|
"ta 1" \
|
218 |
|
|
);
|
219 |
|
|
|
220 |
|
|
#define HAL_BREAKINST {0x91,0xd0,0x20,0x01}
|
221 |
|
|
#define HAL_BREAKINST_SIZE 4
|
222 |
|
|
|
223 |
|
|
//---------------------------------------------------------------------------
|
224 |
|
|
// Thread register state manipulation for GDB support.
|
225 |
|
|
|
226 |
|
|
// Translate a stack pointer as saved by the thread context macros above into
|
227 |
|
|
// a pointer to a HAL_SavedRegisters structure.
|
228 |
|
|
#define HAL_THREAD_GET_SAVED_REGISTERS( _sp_, _regs_ ) \
|
229 |
|
|
(_regs_) = (HAL_SavedRegisters *)(_sp_)
|
230 |
|
|
|
231 |
|
|
// Routines in icontext.c used here because they're quite large for
|
232 |
|
|
// the SPARC (note param order):
|
233 |
|
|
externC void
|
234 |
|
|
cyg_hal_sparc_get_gdb_regs( void *gdb_regset,
|
235 |
|
|
HAL_SavedRegisters *eCos_regset );
|
236 |
|
|
|
237 |
|
|
externC void
|
238 |
|
|
cyg_hal_sparc_set_gdb_regs( HAL_SavedRegisters *eCos_regset,
|
239 |
|
|
void *gdb_regset );
|
240 |
|
|
|
241 |
|
|
|
242 |
|
|
// Copy a set of registers from a HAL_SavedRegisters structure into a GDB
|
243 |
|
|
// ordered array.
|
244 |
|
|
#define HAL_GET_GDB_REGISTERS( _aregval_, _regs_ ) \
|
245 |
|
|
CYG_MACRO_START \
|
246 |
|
|
cyg_hal_sparc_get_gdb_regs( (_aregval_), (_regs_) ); \
|
247 |
|
|
CYG_MACRO_END
|
248 |
|
|
|
249 |
|
|
// Copy a GDB ordered array into a HAL_SavedRegisters structure.
|
250 |
|
|
#define HAL_SET_GDB_REGISTERS( _regs_ , _aregval_ ) \
|
251 |
|
|
CYG_MACRO_START \
|
252 |
|
|
cyg_hal_sparc_set_gdb_regs( (_regs_), (_aregval_) ); \
|
253 |
|
|
CYG_MACRO_END
|
254 |
|
|
|
255 |
|
|
//---------------------------------------------------------------------------
|
256 |
|
|
// HAL setjmp
|
257 |
|
|
|
258 |
|
|
#define CYGARC_JMP_BUF_SIZE 32 // (words)
|
259 |
|
|
|
260 |
|
|
// this too must be doubleword aligned (64 bit)
|
261 |
|
|
|
262 |
|
|
typedef cyg_uint64 hal_jmp_buf[ CYGARC_JMP_BUF_SIZE / 2 ];
|
263 |
|
|
|
264 |
|
|
externC int hal_setjmp(hal_jmp_buf env);
|
265 |
|
|
externC void hal_longjmp(hal_jmp_buf env, int val);
|
266 |
|
|
|
267 |
|
|
//---------------------------------------------------------------------------
|
268 |
|
|
// Flush Register Windows
|
269 |
|
|
//
|
270 |
|
|
// This is implemented as trap 3 in some SPARC systems.
|
271 |
|
|
// This macro is only for use from normal, foreground code.
|
272 |
|
|
// (including exception handlers and the like)
|
273 |
|
|
|
274 |
|
|
#define HAL_FLUSH_REGISTERS_TO_STACK() \
|
275 |
|
|
CYG_MACRO_START \
|
276 |
|
|
cyg_uint32 _saveintr_; \
|
277 |
|
|
HAL_DISABLE_INTERRUPTS( _saveintr_ ); /* leave traps on */ \
|
278 |
|
|
asm volatile ( \
|
279 |
|
|
/* force out all our callers register sets onto the stack */ \
|
280 |
|
|
/* if necessary: the system will handily take care of this for */ \
|
281 |
|
|
/* us as follows: */ \
|
282 |
|
|
"save %%sp, -16 * 4, %%sp;" /* need all these to preserve */ \
|
283 |
|
|
"save %%sp, -16 * 4, %%sp;" /* the linked list property... */ \
|
284 |
|
|
"save %%sp, -16 * 4, %%sp;" \
|
285 |
|
|
"save %%sp, -16 * 4, %%sp;" \
|
286 |
|
|
"save %%sp, -16 * 4, %%sp;" \
|
287 |
|
|
"save %%sp, -16 * 4, %%sp;" \
|
288 |
|
|
"restore;" \
|
289 |
|
|
"restore;" \
|
290 |
|
|
"restore;" \
|
291 |
|
|
"restore;" \
|
292 |
|
|
"restore;" \
|
293 |
|
|
"restore" \
|
294 |
|
|
/* six of these is correct; a seventh would force out the */ \
|
295 |
|
|
/* current set that we are using right now. Note that minimal */ \
|
296 |
|
|
/* space is allowed on stack for locals and ins in case this */ \
|
297 |
|
|
/* sequence itself gets interrupted and recurses too deep. */ \
|
298 |
|
|
: \
|
299 |
|
|
: \
|
300 |
|
|
: "memory" \
|
301 |
|
|
); \
|
302 |
|
|
HAL_RESTORE_INTERRUPTS( _saveintr_ ); \
|
303 |
|
|
CYG_MACRO_END
|
304 |
|
|
|
305 |
|
|
//---------------------------------------------------------------------------
|
306 |
|
|
// Idle thread code.
|
307 |
|
|
// This macro is called in the idle thread loop, and gives the HAL the
|
308 |
|
|
// chance to insert code. Typical idle thread behaviour might be to halt the
|
309 |
|
|
// processor.
|
310 |
|
|
|
311 |
|
|
externC void hal_idle_thread_action(cyg_uint32 loop_count);
|
312 |
|
|
|
313 |
|
|
#ifndef HAL_IDLE_THREAD_ACTION
|
314 |
|
|
#define HAL_IDLE_THREAD_ACTION(_count_) \
|
315 |
|
|
/* Cyg_Clock::real_time_clock->tick() */
|
316 |
|
|
#endif
|
317 |
|
|
|
318 |
|
|
//---------------------------------------------------------------------------
|
319 |
|
|
|
320 |
|
|
// Minimal and sensible stack sizes: the intention is that applications
|
321 |
|
|
// will use these to provide a stack size in the first instance prior to
|
322 |
|
|
// proper analysis. Idle thread stack should be this big.
|
323 |
|
|
|
324 |
|
|
// THESE ARE NOT INTENDED TO BE MICROMETRICALLY ACCURATE FIGURES.
|
325 |
|
|
// THEY ARE HOWEVER ENOUGH TO START PROGRAMMING.
|
326 |
|
|
// YOU MUST MAKE YOUR STACKS LARGER IF YOU HAVE LARGE "AUTO" VARIABLES!
|
327 |
|
|
|
328 |
|
|
// We define quite large stack needs for SPARC, for it requires 576
|
329 |
|
|
// bytes (144 words) to process an interrupt and thread-switch, and
|
330 |
|
|
// momentarily, but needed in case of recursive interrupts, it needs 208
|
331 |
|
|
// words - if a sequence of saves to push out other regsets is interrupted.
|
332 |
|
|
|
333 |
|
|
// This is not a config option because it should not be adjusted except
|
334 |
|
|
// under "enough rope" sort of disclaimers.
|
335 |
|
|
|
336 |
|
|
// A minimal, optimized stack frame is 24 words, but even -O2 code seems to
|
337 |
|
|
// place a few locals in the locals area: round this up to provide a
|
338 |
|
|
// sensible overestimate:
|
339 |
|
|
#define CYGNUM_HAL_STACK_FRAME_SIZE (4 * 32)
|
340 |
|
|
|
341 |
|
|
// Stack needed for a context switch: this is implicit in the estimate for
|
342 |
|
|
// interrupts so not explicitly used below:
|
343 |
|
|
#define CYGNUM_HAL_STACK_CONTEXT_SIZE (4 * 32)
|
344 |
|
|
|
345 |
|
|
// Interrupt + call to ISR, interrupt_end() and the DSR
|
346 |
|
|
#define CYGNUM_HAL_STACK_INTERRUPT_SIZE \
|
347 |
|
|
((208 * 4) + 2 * CYGNUM_HAL_STACK_FRAME_SIZE)
|
348 |
|
|
|
349 |
|
|
// And we have lots of registers so no particular amount is added in for
|
350 |
|
|
// typical local variable usage.
|
351 |
|
|
|
352 |
|
|
// Typically we have 4 nestable interrupt sources, clock, serialin,
|
353 |
|
|
// serialout, (and NMI button, but you want it to not destroy context):
|
354 |
|
|
|
355 |
|
|
#define CYGNUM_HAL_STACK_SIZE_MINIMUM \
|
356 |
|
|
(4 * CYGNUM_HAL_STACK_INTERRUPT_SIZE + 2 * CYGNUM_HAL_STACK_FRAME_SIZE)
|
357 |
|
|
|
358 |
|
|
#define CYGNUM_HAL_STACK_SIZE_TYPICAL \
|
359 |
|
|
(CYGNUM_HAL_STACK_SIZE_MINIMUM + 8 * CYGNUM_HAL_STACK_FRAME_SIZE)
|
360 |
|
|
|
361 |
|
|
//--------------------------------------------------------------------------
|
362 |
|
|
// Macros for switching context between two eCos instances (jump from
|
363 |
|
|
// code in ROM to code in RAM or vice versa).
|
364 |
|
|
#define CYGARC_HAL_SAVE_GP()
|
365 |
|
|
#define CYGARC_HAL_RESTORE_GP()
|
366 |
|
|
|
367 |
|
|
//-----------------------------------------------------------------------------
|
368 |
|
|
|
369 |
|
|
#endif // CYGONCE_HAL_ARCH_H
|
370 |
|
|
// End of hal_arch.h
|