c6d8373484d300c7f3c6deded36c9ff993da9629
[bertos.git] / bertos / cpu / attr.h
1 /**
2  * \file
3  * <!--
4  * This file is part of BeRTOS.
5  *
6  * Bertos is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  * As a special exception, you may use this file as part of a free software
21  * library without restriction.  Specifically, if other files instantiate
22  * templates or use macros or inline functions from this file, or you compile
23  * this file and link it with other files to produce an executable, this
24  * file does not by itself cause the resulting executable to be covered by
25  * the GNU General Public License.  This exception does not however
26  * invalidate any other reasons why the executable file might be covered by
27  * the GNU General Public License.
28  *
29  * Copyright 2004, 2005, 2006, 2007, 2008 Develer S.r.l. (http://www.develer.com/)
30  * Copyright 2004 Giovanni Bajo
31  * -->
32  *
33  * \brief CPU-specific attributes.
34  *
35  * \author Giovanni Bajo <rasky@develer.com>
36  * \author Bernie Innocenti <bernie@codewiz.org>
37  * \author Stefano Fedrigo <aleph@develer.com>
38  * \author Francesco Sacchi <batt@develer.com>
39  */
40 #ifndef CPU_ATTR_H
41 #define CPU_ATTR_H
42
43 #include "detect.h"
44
45 #include "cfg/cfg_attr.h"      /* CONFIG_FAST_MEM */
46
47
48 /**
49  * \name Macros for determining CPU endianness.
50  * \{
51  */
52 #define CPU_BIG_ENDIAN    0x1234
53 #define CPU_LITTLE_ENDIAN 0x3412 /* Look twice, pal. This is not a bug. */
54 /*\}*/
55
56 /** Macro to include cpu-specific versions of the headers. */
57 #define CPU_HEADER(module)          PP_STRINGIZE(drv/PP_CAT3(module, _, CPU_ID).h)
58
59 /** Macro to include cpu-specific versions of implementation files. */
60 #define CPU_CSOURCE(module)         PP_STRINGIZE(drv/PP_CAT3(module, _, CPU_ID).c)
61
62
63 #if CPU_I196
64
65         #define NOP                     nop_instruction()
66
67         #define CPU_REG_BITS            16
68         #define CPU_REGS_CNT            16
69         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
70         #define CPU_HARVARD             0
71
72         /// Valid pointers should be >= than this value (used for debug)
73         #define CPU_RAM_START           0x100
74
75 #elif CPU_X86
76
77         #define CPU_REGS_CNT            7
78         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
79         #define CPU_HARVARD             0
80
81         #if CPU_X86_64
82                 #define CPU_REG_BITS    64
83
84                 #ifdef __WIN64__
85                         /* WIN64 is an IL32-P64 weirdo. */
86                         #define SIZEOF_LONG  4
87                 #endif
88         #else
89                 #define CPU_REG_BITS    32
90         #endif
91
92         /// Valid pointers should be >= than this value (used for debug)
93         #define CPU_RAM_START      0x1000
94
95         #ifdef __GNUC__
96                 #define NOP         asm volatile ("nop")
97                 #define BREAKPOINT  asm volatile ("int3" ::)
98         #endif
99
100 #elif CPU_ARM
101
102         #define CPU_REG_BITS           32
103         #define CPU_REGS_CNT           16
104         #define CPU_HARVARD            0
105
106         /// Valid pointers should be >= than this value (used for debug)
107         #if CPU_ARM_AT91
108                 #define CPU_RAM_START           0x00200000
109         #else
110                 #warning Fix CPU_RAM_START address for your ARM, default value set to 0x200
111                 #define CPU_RAM_START           0x200
112         #endif
113
114         #ifdef __IAR_SYSTEMS_ICC__
115                 #warning Check CPU_BYTE_ORDER
116                 #define CPU_BYTE_ORDER (__BIG_ENDIAN__ ? CPU_BIG_ENDIAN : CPU_LITTLE_ENDIAN)
117
118                 #define NOP            __no_operation()
119
120         #else /* GCC and compatibles */
121
122                 #if defined(__ARMEB__)
123                         #define CPU_BYTE_ORDER CPU_BIG_ENDIAN
124                 #elif defined(__ARMEL__)
125                         #define CPU_BYTE_ORDER CPU_LITTLE_ENDIAN
126                 #else
127                         #error Unable to detect ARM endianness!
128                 #endif
129
130                 #define NOP            asm volatile ("mov r0,r0" ::)
131                 #define BREAKPOINT  /* asm("bkpt 0") DOES NOT WORK */
132
133                 #if CONFIG_FAST_MEM
134                         /**
135                          * Function attribute for use with performance critical code.
136                          *
137                          * On the AT91 family, code residing in flash has wait states.
138                          * Moving functions to the data section is a quick & dirty way
139                          * to get them transparently copied to SRAM for zero-wait-state
140                          * operation.
141                          */
142                         #define FAST_FUNC __attribute__((section(".data")))
143
144                         /**
145                          * Data attribute to move constant data to fast memory storage.
146                          *
147                          * \see FAST_FUNC
148                          */
149                         #define FAST_RODATA __attribute__((section(".data")))
150
151                 #else // !CONFIG_FAST_MEM
152                         #define FAST_RODATA /**/
153                         #define FAST_FUNC /**/
154                 #endif
155
156                 /**
157                  * Function attribute to declare an interrupt service routine.
158                  */
159                 #define ISR_FUNC __attribute__((interrupt))
160
161                 /*
162                  * Function attribute to move it into ram memory.
163                  */
164                 #define RAM_FUNC __attribute__((section(".data")))
165
166         #endif /* !__IAR_SYSTEMS_ICC_ */
167
168 #elif CPU_PPC
169
170         #define CPU_REG_BITS           (CPU_PPC32 ? 32 : 64)
171         #define CPU_REGS_CNT           FIXME
172         #define CPU_BYTE_ORDER         (__BIG_ENDIAN__ ? CPU_BIG_ENDIAN : CPU_LITTLE_ENDIAN)
173         #define CPU_HARVARD            0
174
175         /// Valid pointers should be >= than this value (used for debug)
176         #define CPU_RAM_START          0x1000
177
178         #ifdef __GNUC__
179             #define NOP         asm volatile ("nop" ::)
180                 #define BREAKPOINT  asm volatile ("twge 2,2" ::)
181         #endif
182
183 #elif CPU_DSP56K
184
185         #define CPU_REG_BITS            16
186         #define CPU_REGS_CNT            FIXME
187         #define CPU_BYTE_ORDER          CPU_BIG_ENDIAN
188         #define CPU_HARVARD             1
189
190         /* Memory is word-addessed in the DSP56K */
191         #define CPU_BITS_PER_CHAR  16
192         #define SIZEOF_SHORT        1
193         #define SIZEOF_INT          1
194         #define SIZEOF_LONG         2
195         #define SIZEOF_PTR          1
196
197         /// Valid pointers should be >= than this value (used for debug)
198         #define CPU_RAM_START       0x200
199
200         #define NOP                     asm(nop)
201         #define BREAKPOINT              asm(debug)
202
203 #elif CPU_AVR
204
205         #define NOP                     asm volatile ("nop" ::)
206
207         #define CPU_REG_BITS            8
208         #define CPU_REGS_CNT           33 /* Includes SREG */
209         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
210         #define CPU_HARVARD             1
211
212         /// Valid pointers should be >= than this value (used for debug)
213         #if CPU_AVR_ATMEGA8 || CPU_AVR_ATMEGA32 || CPU_AVR_ATMEGA103
214                 #define CPU_RAM_START       0x60
215         #elif CPU_AVR_ATMEGA64 || CPU_AVR_ATMEGA128 || CPU_AVR_ATMEGA168
216                 #define CPU_RAM_START       0x100
217         #elif CPU_AVR_ATMEGA1281
218                 #define CPU_RAM_START       0x200
219         #else
220                 #warning Fix CPU_RAM_START address for your AVR, default value set to 0x100
221                 #define CPU_RAM_START       0x100
222         #endif
223
224 #else
225         #error No CPU_... defined.
226 #endif
227
228 #ifndef BREAKPOINT
229 #define BREAKPOINT /* nop */
230 #endif
231
232 #ifndef FAST_FUNC
233         /// Function attribute for use with performance critical code.
234         #define FAST_FUNC /* */
235 #endif
236
237 #ifndef FAST_RODATA
238         /// Data attribute to move constant data to fast memory storage.
239         #define FAST_RODATA /* */
240 #endif
241
242 #endif /* CPU_ATTR_H */