cpu.h

   1 /*!
   2  * \file
   3  * <!--
   4  * Copyright 2004 Develer S.r.l. (http://www.develer.com/)
   5  * Copyright 2004 Giovanni Bajo
   6  * This file is part of DevLib - See devlib/README for information.
   7  * -->
   8  *
   9  * \brief CPU-specific definitions
  10  *
  11  * \version $Id$
  12  *
  13  * \author Giovanni Bajo <rasky@develer.com>
  14  * \author Bernardo Innocenti <bernie@develer.com>
  15  * \author Stefano Fedrigo <aleph@develer.com>
  16  */
  17
  18 /*#*
  19  *#* $Log$
  20  *#* Revision 1.27  2004/12/31 17:02:47  bernie
  21  *#* IRQ_SAVE_DISABLE(), IRQ_RESTORE(): Add null stubs for x86.
  22  *#*
  23  *#* Revision 1.26  2004/12/13 12:08:12  bernie
  24  *#* DISABLE_IRQSAVE, ENABLE_IRQRESTORE, DISABLE_INTS, ENABLE_INTS: Remove obsolete macros.
  25  *#*
  26  *#* Revision 1.25  2004/12/08 08:31:02  bernie
  27  *#* CPU_HARVARD: Define to 1 for AVR and DSP56K.
  28  *#*
  29  *#* Revision 1.24  2004/12/08 08:04:13  bernie
  30  *#* Doxygen fixes.
  31  *#*
  32  *#* Revision 1.23  2004/11/16 22:41:58  bernie
  33  *#* Support 64bit CPUs.
  34  *#*
  35  *#* Revision 1.22  2004/11/16 21:57:59  bernie
  36  *#* CPU_IDLE: Rename from SCHEDULER_IDLE.
  37  *#*
  38  *#* Revision 1.21  2004/11/16 21:34:25  bernie
  39  *#* Commonize obsolete names for IRQ macros; Doxygen fixes.
  40  *#*
  41  *#* Revision 1.20  2004/11/16 20:33:32  bernie
  42  *#* CPU_HARVARD: New macro.
  43  *#*
  44  *#* Revision 1.19  2004/10/03 20:43:54  bernie
  45  *#* Fix Doxygen markup.
  46  *#*
  47  *#* Revision 1.18  2004/10/03 18:36:31  bernie
  48  *#* IRQ_GETSTATE(): New macro; Rename IRQ macros for consistency.
  49  *#*
  50  *#* Revision 1.17  2004/09/06 21:48:27  bernie
  51  *#* ATOMIC(): New macro.
  52  *#*
  53  *#* Revision 1.16  2004/08/29 21:58:33  bernie
  54  *#* Rename BITS_PER_XYZ macros; Add sanity checks.
  55  *#*
  56  *#* Revision 1.15  2004/08/25 14:12:08  rasky
  57  *#* Aggiornato il comment block dei log RCS
  58  *#*
  59  *#* Revision 1.14  2004/08/24 13:29:28  bernie
  60  *#* Trim CVS log; Rename header guards.
  61  *#*
  62  *#* Revision 1.12  2004/08/14 19:37:57  rasky
  63  *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
  64  *#*
  65  *#* Revision 1.11  2004/08/05 17:39:56  bernie
  66  *#* Fix a Doxygen tag.
  67  *#*
  68  *#* Revision 1.10  2004/08/02 20:20:29  aleph
  69  *#* Merge from project_ks
  70  *#*
  71  *#* Revision 1.9  2004/07/30 14:24:16  rasky
  72  *#* Task switching con salvataggio perfetto stato di interrupt (SR)
  73  *#* Kernel monitor per dump informazioni su stack dei processi
  74  *#*/
  75 #ifndef DEVLIB_CPU_H
  76 #define DEVLIB_CPU_H
  77
  78 #include "compiler.h" /* for uintXX_t, PP_CAT3(), PP_STRINGIZE() */
  79
  80
  81 /*!
  82  * \name Macros for determining CPU endianness.
  83  * \{
  84  */
  85 #define CPU_BIG_ENDIAN    0x1234
  86 #define CPU_LITTLE_ENDIAN 0x3412
  87 /*\}*/
  88
  89 /*! Macro to include cpu-specific versions of the headers. */
  90 #define CPU_HEADER(module)          PP_STRINGIZE(PP_CAT3(module, _, CPU_ID).h)
  91
  92
  93 #if CPU_I196
  94
  95         #define NOP                     nop_instruction()
  96         #define IRQ_DISABLE             disable_interrupt()
  97         #define IRQ_ENABLE              enable_interrupt()
  98
  99         typedef uint16_t cpuflags_t; // FIXME
 100         typedef unsigned int cpustack_t;
 101
 102         #define CPU_REG_BITS            16
 103         #define CPU_REGS_CNT            16
 104         #define CPU_STACK_GROWS_UPWARD  0
 105         #define CPU_SP_ON_EMPTY_SLOT    0
 106         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
 107         #define CPU_HARVARD             0
 108
 109 #elif CPU_X86
 110
 111         #define NOP                     asm volatile ("nop")
 112         #define IRQ_DISABLE             /* nothing */
 113         #define IRQ_ENABLE              /* nothing */
 114         #define IRQ_SAVE_DISABLE(x)     /* nothing */
 115         #define IRQ_RESTORE(x)          /* nothing */
 116
 117         typedef uint32_t cpuflags_t; // FIXME
 118         typedef uint32_t cpustack_t;
 119
 120         #define CPU_REG_BITS            32
 121         #define CPU_REGS_CNT            7
 122         #define CPU_STACK_GROWS_UPWARD  0
 123         #define CPU_SP_ON_EMPTY_SLOT    0
 124         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
 125         #define CPU_HARVARD             0
 126
 127 #elif CPU_DSP56K
 128
 129         #define NOP                     asm(nop)
 130         #define IRQ_DISABLE             do { asm(bfset #0x0200,SR); asm(nop); } while (0)
 131         #define IRQ_ENABLE              do { asm(bfclr #0x0200,SR); asm(nop); } while (0)
 132
 133         #define IRQ_SAVE_DISABLE(x)  \
 134                 do { (void)x; asm(move SR,x); asm(bfset #0x0200,SR); } while (0)
 135         #define IRQ_RESTORE(x)  \
 136                 do { (void)x; asm(move x,SR); } while (0)
 137
 138
 139         typedef uint16_t cpuflags_t;
 140         typedef unsigned int cpustack_t;
 141
 142         #define CPU_REG_BITS            16
 143         #define CPU_REGS_CNT            FIXME
 144         #define CPU_SAVED_REGS_CNT      8
 145         #define CPU_STACK_GROWS_UPWARD  1
 146         #define CPU_SP_ON_EMPTY_SLOT    0
 147         #define CPU_BYTE_ORDER          CPU_BIG_ENDIAN
 148         #define CPU_HARVARD             1
 149
 150         /* Memory is word-addessed in the DSP56K */
 151         #define CPU_BITS_PER_CHAR  16
 152         #define SIZEOF_SHORT        1
 153         #define SIZEOF_INT          1
 154         #define SIZEOF_LONG         2
 155         #define SIZEOF_PTR          1
 156
 157 #elif CPU_AVR
 158
 159         #define NOP           asm volatile ("nop" ::)
 160         #define IRQ_DISABLE   asm volatile ("cli" ::)
 161         #define IRQ_ENABLE    asm volatile ("sei" ::)
 162
 163         #define IRQ_SAVE_DISABLE(x) \
 164         do { \
 165                 __asm__ __volatile__( \
 166                         "in %0,__SREG__\n\t" \
 167                         "cli" \
 168                         : "=r" (x) : /* no inputs */ : "cc" \
 169                 ); \
 170         } while (0)
 171
 172         #define IRQ_RESTORE(x) \
 173         do { \
 174                 __asm__ __volatile__( \
 175                         "out __SREG__,%0" : /* no outputs */ : "r" (x) : "cc" \
 176                 ); \
 177         } while (0)
 178
 179         #define IRQ_GETSTATE() \
 180         ({ \
 181                 uint8_t sreg; \
 182                 __asm__ __volatile__( \
 183                         "in %0,__SREG__\n\t" \
 184                         : "=r" (sreg)  /* no inputs & no clobbers */ \
 185                 ); \
 186                 (bool)(sreg & 0x80); \
 187         })
 188
 189         typedef uint8_t cpuflags_t;
 190         typedef uint8_t cpustack_t;
 191
 192         /* Register counts include SREG too */
 193         #define CPU_REG_BITS            8
 194         #define CPU_REGS_CNT           33
 195         #define CPU_SAVED_REGS_CNT     19
 196         #define CPU_STACK_GROWS_UPWARD  0
 197         #define CPU_SP_ON_EMPTY_SLOT    1
 198         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
 199         #define CPU_HARVARD             1
 200
 201         /*!
 202          * Initialization value for registers in stack frame.
 203          * The register index is not directly corrispondent to CPU
 204          * register numbers. Index 0 is the SREG register: the initial
 205          * value is all 0 but the interrupt bit (bit 7).
 206          */
 207         #define CPU_REG_INIT_VALUE(reg) (reg == 0 ? 0x80 : 0)
 208
 209 #endif
 210
 211 /*!
 212  * Execute \a CODE atomically with respect to interrupts.
 213  *
 214  * \see IRQ_SAVE_DISABLE IRQ_RESTORE
 215  */
 216 #define ATOMIC(CODE) \
 217         do { \
 218                 cpuflags_t __flags; \
 219                 IRQ_SAVE_DISABLE(__flags); \
 220                 CODE; \
 221                 IRQ_RESTORE(__flags); \
 222         } while (0)
 223
 224
 225 //! Default for macro not defined in the right arch section
 226 #ifndef CPU_REG_INIT_VALUE
 227         #define CPU_REG_INIT_VALUE(reg)     0
 228 #endif
 229
 230
 231 #ifndef CPU_STACK_GROWS_UPWARD
 232         #error CPU_STACK_GROWS_UPWARD should have been defined to either 0 or 1
 233 #endif
 234
 235 #ifndef CPU_SP_ON_EMPTY_SLOT
 236         #error CPU_SP_ON_EMPTY_SLOT should have been defined to either 0 or 1
 237 #endif
 238
 239 /*
 240  * Support stack handling peculiarities of a few CPUs.
 241  *
 242  * Most processors let their stack grow downward and
 243  * keep SP pointing at the last pushed value.
 244  */
 245 #if !CPU_STACK_GROWS_UPWARD
 246         #if !CPU_SP_ON_EMPTY_SLOT
 247                 /* Most microprocessors (x86, m68k...) */
 248                 #define CPU_PUSH_WORD(sp, data) \
 249                         do { *--(sp) = (data); } while (0)
 250                 #define CPU_POP_WORD(sp) \
 251                         (*(sp)++)
 252         #else
 253                 /* AVR insanity */
 254                 #define CPU_PUSH_WORD(sp, data) \
 255                         do { *(sp)-- = (data); } while (0)
 256                 #define CPU_POP_WORD(sp) \
 257                         (*++(sp))
 258         #endif
 259
 260 #else /* CPU_STACK_GROWS_UPWARD */
 261
 262         #if !CPU_SP_ON_EMPTY_SLOT
 263                 /* DSP56K and other weirdos */
 264                 #define CPU_PUSH_WORD(sp, data) \
 265                         do { *++(sp) = (cpustack_t)(data); } while (0)
 266                 #define CPU_POP_WORD(sp) \
 267                         (*(sp)--)
 268         #else
 269                 #error I bet you cannot find a CPU like this
 270         #endif
 271 #endif
 272
 273
 274 #if CPU_DSP56K
 275         /*
 276          * DSP56k pushes both PC and SR to the stack in the JSR instruction, but
 277          * RTS discards SR while returning (it does not restore it). So we push
 278          * 0 to fake the same context.
 279          */
 280         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 281                 do { \
 282                         CPU_PUSH_WORD((sp), (func)); \
 283                         CPU_PUSH_WORD((sp), 0x100); \
 284                 } while (0);
 285
 286 #elif CPU_AVR
 287         /*
 288          * In AVR, the addresses are pushed into the stack as little-endian, while
 289          * memory accesses are big-endian (actually, it's a 8-bit CPU, so there is
 290          * no natural endianess).
 291          */
 292         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 293                 do { \
 294                         uint16_t funcaddr = (uint16_t)(func); \
 295                         CPU_PUSH_WORD((sp), funcaddr); \
 296                         CPU_PUSH_WORD((sp), funcaddr>>8); \
 297                 } while (0)
 298
 299 #else
 300         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 301                 CPU_PUSH_WORD((sp), (func))
 302 #endif
 303
 304
 305 /*!
 306  * \name Default type sizes.
 307  *
 308  * These defaults are reasonable for most 16/32bit machines.
 309  * Some of these macros may be overridden by CPU-specific code above.
 310  *
 311  * ANSI C requires that the following equations be true:
 312  * \code
 313  *   sizeof(char) <= sizeof(short) <= sizeof(int) <= sizeof(long)
 314  *   sizeof(float) <= sizeof(double)
 315  *   CPU_BITS_PER_CHAR  >= 8
 316  *   CPU_BITS_PER_SHORT >= 8
 317  *   CPU_BITS_PER_INT   >= 16
 318  *   CPU_BITS_PER_LONG  >= 32
 319  * \endcode
 320  * \{
 321  */
 322 #ifndef SIZEOF_CHAR
 323 #define SIZEOF_CHAR  1
 324 #endif
 325
 326 #ifndef SIZEOF_SHORT
 327 #define SIZEOF_SHORT  2
 328 #endif
 329
 330 #ifndef SIZEOF_INT
 331 #if CPU_REG_BITS < 32
 332         #define SIZEOF_INT  2
 333 #else
 334         #define SIZEOF_INT  4
 335 #endif
 336 #endif /* !SIZEOF_INT */
 337
 338 #ifndef SIZEOF_LONG
 339 #if CPU_REG_BITS > 32
 340         #define SIZEOF_LONG  8
 341 #else
 342         #define SIZEOF_LONG  4
 343 #endif
 344 #endif
 345
 346 #ifndef SIZEOF_PTR
 347 #define SIZEOF_PTR   SIZEOF_INT
 348 #endif
 349
 350 #ifndef CPU_BITS_PER_CHAR
 351 #define CPU_BITS_PER_CHAR   (SIZEOF_CHAR * 8)
 352 #endif
 353
 354 #ifndef CPU_BITS_PER_SHORT
 355 #define CPU_BITS_PER_SHORT  (SIZEOF_SHORT * CPU_BITS_PER_CHAR)
 356 #endif
 357
 358 #ifndef CPU_BITS_PER_INT
 359 #define CPU_BITS_PER_INT    (SIZEOF_INT * CPU_BITS_PER_CHAR)
 360 #endif
 361
 362 #ifndef CPU_BITS_PER_LONG
 363 #define CPU_BITS_PER_LONG   (SIZEOF_LONG * CPU_BITS_PER_CHAR)
 364 #endif
 365
 366 #ifndef CPU_BITS_PER_PTR
 367 #define CPU_BITS_PER_PTR    (SIZEOF_PTR * CPU_BITS_PER_CHAR)
 368 #endif
 369 /*\}*/
 370
 371 /* Sanity checks for the above definitions */
 372 STATIC_ASSERT(sizeof(char) == SIZEOF_CHAR);
 373 STATIC_ASSERT(sizeof(short) == SIZEOF_SHORT);
 374 STATIC_ASSERT(sizeof(long) == SIZEOF_LONG);
 375 STATIC_ASSERT(sizeof(int) == SIZEOF_INT);
 376
 377
 378 /*!
 379  * \def SCHEDULER_IDLE
 380  *
 381  * \brief Invoked by the scheduler to stop the CPU when idle.
 382  *
 383  * This hook can be redefined to put the CPU in low-power mode, or to
 384  * profile system load with an external strobe, or to save CPU cycles
 385  * in hosted environments such as emulators.
 386  */
 387 #ifndef CPU_IDLE
 388         #if defined(ARCH_EMUL) && (ARCH & ARCH_EMUL)
 389                 /* This emulator hook should yield the CPU to the host.  */
 390                 EXTERN_C_BEGIN
 391                 void SchedulerIdle(void);
 392                 EXTERN_C_END
 393                 #define CPU_IDLE SchedulerIdle()
 394         #else /* !ARCH_EMUL */
 395                 #define CPU_IDLE do { /* nothing */ } while (0)
 396         #endif /* !ARCH_EMUL */
 397 #endif /* !CPU_IDLE */
 398
 399 /* OBSOLETE */
 400 #define SCHEDULER_IDLE CPU_IDLE
 401
 402 #endif /* DEVLIB_CPU_H */