cpu/cpu.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 Develer S.r.l. (http://www.develer.com/)
  30  * Copyright 2004 Giovanni Bajo
  31  *
  32  * -->
  33  *
  34  * \brief CPU-specific definitions
  35  *
  36  * \author Giovanni Bajo <rasky@develer.com>
  37  * \author Bernardo Innocenti <bernie@develer.com>
  38  * \author Stefano Fedrigo <aleph@develer.com>
  39  * \author Francesco Sacchi <batt@develer.com>
  40  */
  41 #ifndef CPU_CPU_H
  42 #define CPU_CPU_H
  43
  44 #include "detect.h"
  45 #include <cfg/compiler.h> /* for uintXX_t */
  46 #include <cfg/arch_config.h>  /* ARCH_EMUL */
  47
  48
  49 /**
  50  * \name Macros for determining CPU endianness.
  51  * \{
  52  */
  53 #define CPU_BIG_ENDIAN    0x1234
  54 #define CPU_LITTLE_ENDIAN 0x3412 /* Look twice, pal. This is not a bug. */
  55 /*\}*/
  56
  57 /** Macro to include cpu-specific versions of the headers. */
  58 #define CPU_HEADER(module)          PP_STRINGIZE(drv/PP_CAT3(module, _, CPU_ID).h)
  59
  60 /** Macro to include cpu-specific versions of implementation files. */
  61 #define CPU_CSOURCE(module)         PP_STRINGIZE(drv/PP_CAT3(module, _, CPU_ID).c)
  62
  63
  64 #if CPU_I196
  65
  66         #define NOP                     nop_instruction()
  67         #define IRQ_DISABLE             disable_interrupt()
  68         #define IRQ_ENABLE              enable_interrupt()
  69
  70         typedef uint16_t cpuflags_t; // FIXME
  71         typedef unsigned int cpustack_t;
  72
  73         #define CPU_REG_BITS            16
  74         #define CPU_REGS_CNT            16
  75         #define CPU_STACK_GROWS_UPWARD  0
  76         #define CPU_SP_ON_EMPTY_SLOT    0
  77         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
  78         #define CPU_HARVARD             0
  79
  80 #elif CPU_X86
  81
  82         #define NOP                     asm volatile ("nop")
  83
  84         /* Get IRQ_* definitions from the hosting environment. */
  85         #include <cfg/os.h>
  86         #if OS_EMBEDDED
  87                 #define IRQ_DISABLE             FIXME
  88                 #define IRQ_ENABLE              FIXME
  89                 #define IRQ_SAVE_DISABLE(x)     FIXME
  90                 #define IRQ_RESTORE(x)          FIXME
  91                 typedef uint32_t cpuflags_t; // FIXME
  92         #endif /* OS_EMBEDDED */
  93
  94
  95         #define CPU_REGS_CNT            7
  96         #define CPU_SAVED_REGS_CNT      7
  97         #define CPU_STACK_GROWS_UPWARD  0
  98         #define CPU_SP_ON_EMPTY_SLOT    0
  99         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
 100         #define CPU_HARVARD             0
 101
 102         #if CPU_X86_64
 103                 typedef uint64_t cpustack_t;
 104                 #define CPU_REG_BITS    64
 105
 106                 #ifdef __WIN64__
 107                         /* WIN64 is an IL32-P64 weirdo. */
 108                         #define SIZEOF_LONG  4
 109                 #endif
 110         #else
 111                 typedef uint32_t cpustack_t;
 112                 #define CPU_REG_BITS    32
 113         #endif
 114
 115 #elif CPU_ARM
 116
 117         typedef uint32_t cpuflags_t;
 118         typedef uint32_t cpustack_t;
 119
 120         /* Register counts include SREG too */
 121         #define CPU_REG_BITS           32
 122         #define CPU_REGS_CNT           16
 123         #define CPU_SAVED_REGS_CNT     FIXME
 124         #define CPU_STACK_GROWS_UPWARD 0
 125         #define CPU_SP_ON_EMPTY_SLOT   0
 126         #define CPU_BYTE_ORDER         (__BIG_ENDIAN__ ? CPU_BIG_ENDIAN : CPU_LITTLE_ENDIAN)
 127         #define CPU_HARVARD            0
 128
 129         #ifdef __IAR_SYSTEMS_ICC__
 130
 131                 #include <inarm.h>
 132
 133                 #if __CPU_MODE__ == 1 /* Thumb */
 134                         /* Use stubs */
 135                         extern cpuflags_t get_CPSR(void);
 136                         extern void set_CPSR(cpuflags_t flags);
 137                 #else
 138                         #define get_CPSR __get_CPSR
 139                         #define set_CPSR __set_CPSR
 140                 #endif
 141
 142                 #define NOP         __no_operation()
 143                 #define IRQ_DISABLE __disable_interrupt()
 144                 #define IRQ_ENABLE  __enable_interrupt()
 145
 146                 #define IRQ_SAVE_DISABLE(x) \
 147                 do { \
 148                         (x) = get_CPSR(); \
 149                         __disable_interrupt(); \
 150                 } while (0)
 151
 152                 #define IRQ_RESTORE(x) \
 153                 do { \
 154                         set_CPSR(x); \
 155                 } while (0)
 156
 157                 #define IRQ_GETSTATE() \
 158                         ((bool)(get_CPSR() & 0xb0))
 159
 160                 #define BREAKPOINT  /* asm("bkpt 0") DOES NOT WORK */
 161
 162         #else /* !__IAR_SYSTEMS_ICC__ */
 163                 #define NOP         asm volatile ("mov r0,r0" ::)
 164
 165                 #define IRQ_DISABLE \
 166                 do { \
 167                         asm volatile ( \
 168                                 "mrs r0, cpsr\n\t" \
 169                                 "orr r0, r0, #0xc0\n\t" \
 170                                 "msr cpsr_c, r0" \
 171                                 ::: "r0" \
 172                         ); \
 173                 } while (0)
 174
 175                 #define IRQ_ENABLE \
 176                 do { \
 177                         asm volatile ( \
 178                                 "mrs r0, cpsr\n\t" \
 179                                 "bic r0, r0, #0xc0\n\t" \
 180                                 "msr cpsr_c, r0" \
 181                                 ::: "r0" \
 182                         ); \
 183                 } while (0)
 184
 185                 #define IRQ_SAVE_DISABLE(x) \
 186                 do { \
 187                         asm volatile ( \
 188                                 "mrs %0, cpsr\n\t" \
 189                                 "orr r0, %0, #0xc0\n\t" \
 190                                 "msr cpsr_c, r0" \
 191                                 : "=r" (x) \
 192                                 : /* no inputs */ \
 193                                 : "r0" \
 194                         ); \
 195                 } while (0)
 196
 197                 #define IRQ_RESTORE(x) \
 198                 do { \
 199                         asm volatile ( \
 200                                 "msr cpsr_c, %0" \
 201                                 : /* no outputs */ \
 202                                 : "r" (x) \
 203                         ); \
 204                 } while (0)
 205
 206                 #define IRQ_GETSTATE() \
 207                 ({ \
 208                         uint32_t sreg; \
 209                         asm volatile ( \
 210                                 "mrs %0, cpsr\n\t" \
 211                                 : "=r" (sreg) \
 212                                 : /* no inputs */ \
 213                         ); \
 214                         !((sreg & 0xc0) == 0xc0); \
 215                 })
 216
 217         #endif /* !__IAR_SYSTEMS_ICC_ */
 218
 219 #elif CPU_PPC
 220         #define NOP                 asm volatile ("nop" ::)
 221
 222         #define IRQ_DISABLE         FIXME
 223         #define IRQ_ENABLE          FIXME
 224         #define IRQ_SAVE_DISABLE(x) FIXME
 225         #define IRQ_RESTORE(x)      FIXME
 226         #define IRQ_GETSTATE()      FIXME
 227
 228         typedef uint32_t cpuflags_t; // FIXME
 229         typedef uint32_t cpustack_t; // FIXME
 230
 231         /* Register counts include SREG too */
 232         #define CPU_REG_BITS           (CPU_PPC32 ? 32 : 64)
 233         #define CPU_REGS_CNT           FIXME
 234         #define CPU_SAVED_REGS_CNT     FIXME
 235         #define CPU_STACK_GROWS_UPWARD 0  //FIXME
 236         #define CPU_SP_ON_EMPTY_SLOT   0  //FIXME
 237         #define CPU_BYTE_ORDER         (__BIG_ENDIAN__ ? CPU_BIG_ENDIAN : CPU_LITTLE_ENDIAN)
 238         #define CPU_HARVARD            0
 239
 240 #elif CPU_DSP56K
 241
 242         #define NOP                     asm(nop)
 243         #define BREAKPOINT              asm(debug)
 244         #define IRQ_DISABLE             do { asm(bfset #0x0200,SR); asm(nop); } while (0)
 245         #define IRQ_ENABLE              do { asm(bfclr #0x0200,SR); asm(nop); } while (0)
 246
 247         #define IRQ_SAVE_DISABLE(x)  \
 248                 do { (void)x; asm(move SR,x); asm(bfset #0x0200,SR); } while (0)
 249         #define IRQ_RESTORE(x)  \
 250                 do { (void)x; asm(move x,SR); } while (0)
 251
 252         static inline bool irq_running(void)
 253         {
 254                 extern void *user_sp;
 255                 return !!user_sp;
 256         }
 257         #define IRQ_RUNNING() irq_running()
 258
 259         static inline bool irq_getstate(void)
 260         {
 261                 uint16_t x;
 262                 asm(move SR,x);
 263                 return !(x & 0x0200);
 264         }
 265         #define IRQ_GETSTATE() irq_getstate()
 266
 267         typedef uint16_t cpuflags_t;
 268         typedef unsigned int cpustack_t;
 269
 270         #define CPU_REG_BITS            16
 271         #define CPU_REGS_CNT            FIXME
 272         #define CPU_SAVED_REGS_CNT      8
 273         #define CPU_STACK_GROWS_UPWARD  1
 274         #define CPU_SP_ON_EMPTY_SLOT    0
 275         #define CPU_BYTE_ORDER          CPU_BIG_ENDIAN
 276         #define CPU_HARVARD             1
 277
 278         /* Memory is word-addessed in the DSP56K */
 279         #define CPU_BITS_PER_CHAR  16
 280         #define SIZEOF_SHORT        1
 281         #define SIZEOF_INT          1
 282         #define SIZEOF_LONG         2
 283         #define SIZEOF_PTR          1
 284
 285 #elif CPU_AVR
 286
 287         #define NOP           asm volatile ("nop" ::)
 288         #define IRQ_DISABLE   asm volatile ("cli" ::)
 289         #define IRQ_ENABLE    asm volatile ("sei" ::)
 290
 291         #define IRQ_SAVE_DISABLE(x) \
 292         do { \
 293                 __asm__ __volatile__( \
 294                         "in %0,__SREG__\n\t" \
 295                         "cli" \
 296                         : "=r" (x) : /* no inputs */ : "cc" \
 297                 ); \
 298         } while (0)
 299
 300         #define IRQ_RESTORE(x) \
 301         do { \
 302                 __asm__ __volatile__( \
 303                         "out __SREG__,%0" : /* no outputs */ : "r" (x) : "cc" \
 304                 ); \
 305         } while (0)
 306
 307         #define IRQ_GETSTATE() \
 308         ({ \
 309                 uint8_t sreg; \
 310                 __asm__ __volatile__( \
 311                         "in %0,__SREG__\n\t" \
 312                         : "=r" (sreg)  /* no inputs & no clobbers */ \
 313                 ); \
 314                 (bool)(sreg & 0x80); \
 315         })
 316
 317         typedef uint8_t cpuflags_t;
 318         typedef uint8_t cpustack_t;
 319
 320         /* Register counts include SREG too */
 321         #define CPU_REG_BITS            8
 322         #define CPU_REGS_CNT           33
 323         #define CPU_SAVED_REGS_CNT     19
 324         #define CPU_STACK_GROWS_UPWARD  0
 325         #define CPU_SP_ON_EMPTY_SLOT    1
 326         #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
 327         #define CPU_HARVARD             1
 328
 329         /**
 330          * Initialization value for registers in stack frame.
 331          * The register index is not directly corrispondent to CPU
 332          * register numbers. Index 0 is the SREG register: the initial
 333          * value is all 0 but the interrupt bit (bit 7).
 334          */
 335         #define CPU_REG_INIT_VALUE(reg) (reg == 0 ? 0x80 : 0)
 336
 337 #else
 338         #error No CPU_... defined.
 339 #endif
 340
 341 /**
 342  * Execute \a CODE atomically with respect to interrupts.
 343  *
 344  * \see IRQ_SAVE_DISABLE IRQ_RESTORE
 345  */
 346 #define ATOMIC(CODE) \
 347         do { \
 348                 cpuflags_t __flags; \
 349                 IRQ_SAVE_DISABLE(__flags); \
 350                 CODE; \
 351                 IRQ_RESTORE(__flags); \
 352         } while (0)
 353
 354
 355 /// Default for macro not defined in the right arch section
 356 #ifndef CPU_REG_INIT_VALUE
 357         #define CPU_REG_INIT_VALUE(reg)     0
 358 #endif
 359
 360
 361 #ifndef CPU_STACK_GROWS_UPWARD
 362         #error CPU_STACK_GROWS_UPWARD should have been defined to either 0 or 1
 363 #endif
 364
 365 #ifndef CPU_SP_ON_EMPTY_SLOT
 366         #error CPU_SP_ON_EMPTY_SLOT should have been defined to either 0 or 1
 367 #endif
 368
 369 /*
 370  * Support stack handling peculiarities of a few CPUs.
 371  *
 372  * Most processors let their stack grow downward and
 373  * keep SP pointing at the last pushed value.
 374  */
 375 #if !CPU_STACK_GROWS_UPWARD
 376         #if !CPU_SP_ON_EMPTY_SLOT
 377                 /* Most microprocessors (x86, m68k...) */
 378                 #define CPU_PUSH_WORD(sp, data) \
 379                         do { *--(sp) = (data); } while (0)
 380                 #define CPU_POP_WORD(sp) \
 381                         (*(sp)++)
 382         #else
 383                 /* AVR insanity */
 384                 #define CPU_PUSH_WORD(sp, data) \
 385                         do { *(sp)-- = (data); } while (0)
 386                 #define CPU_POP_WORD(sp) \
 387                         (*++(sp))
 388         #endif
 389
 390 #else /* CPU_STACK_GROWS_UPWARD */
 391
 392         #if !CPU_SP_ON_EMPTY_SLOT
 393                 /* DSP56K and other weirdos */
 394                 #define CPU_PUSH_WORD(sp, data) \
 395                         do { *++(sp) = (cpustack_t)(data); } while (0)
 396                 #define CPU_POP_WORD(sp) \
 397                         (*(sp)--)
 398         #else
 399                 #error I bet you cannot find a CPU like this
 400         #endif
 401 #endif
 402
 403
 404 #if CPU_DSP56K
 405         /*
 406          * DSP56k pushes both PC and SR to the stack in the JSR instruction, but
 407          * RTS discards SR while returning (it does not restore it). So we push
 408          * 0 to fake the same context.
 409          */
 410         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 411                 do { \
 412                         CPU_PUSH_WORD((sp), (func)); \
 413                         CPU_PUSH_WORD((sp), 0x100); \
 414                 } while (0);
 415
 416 #elif CPU_AVR
 417         /*
 418          * In AVR, the addresses are pushed into the stack as little-endian, while
 419          * memory accesses are big-endian (actually, it's a 8-bit CPU, so there is
 420          * no natural endianess).
 421          */
 422         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 423                 do { \
 424                         uint16_t funcaddr = (uint16_t)(func); \
 425                         CPU_PUSH_WORD((sp), funcaddr); \
 426                         CPU_PUSH_WORD((sp), funcaddr>>8); \
 427                 } while (0)
 428
 429 #else
 430         #define CPU_PUSH_CALL_CONTEXT(sp, func) \
 431                 CPU_PUSH_WORD((sp), (cpustack_t)(func))
 432 #endif
 433
 434
 435 /**
 436  * \name Default type sizes.
 437  *
 438  * These defaults are reasonable for most 16/32bit machines.
 439  * Some of these macros may be overridden by CPU-specific code above.
 440  *
 441  * ANSI C requires that the following equations be true:
 442  * \code
 443  *   sizeof(char) <= sizeof(short) <= sizeof(int) <= sizeof(long)
 444  *   sizeof(float) <= sizeof(double)
 445  *   CPU_BITS_PER_CHAR  >= 8
 446  *   CPU_BITS_PER_SHORT >= 8
 447  *   CPU_BITS_PER_INT   >= 16
 448  *   CPU_BITS_PER_LONG  >= 32
 449  * \endcode
 450  * \{
 451  */
 452 #ifndef SIZEOF_CHAR
 453 #define SIZEOF_CHAR  1
 454 #endif
 455
 456 #ifndef SIZEOF_SHORT
 457 #define SIZEOF_SHORT  2
 458 #endif
 459
 460 #ifndef SIZEOF_INT
 461 #if CPU_REG_BITS < 32
 462         #define SIZEOF_INT  2
 463 #else
 464         #define SIZEOF_INT  4
 465 #endif
 466 #endif /* !SIZEOF_INT */
 467
 468 #ifndef SIZEOF_LONG
 469 #if CPU_REG_BITS > 32
 470         #define SIZEOF_LONG  8
 471 #else
 472         #define SIZEOF_LONG  4
 473 #endif
 474 #endif
 475
 476 #ifndef SIZEOF_PTR
 477 #if CPU_REG_BITS < 32
 478         #define SIZEOF_PTR   2
 479 #elif CPU_REG_BITS == 32
 480         #define SIZEOF_PTR   4
 481 #else /* CPU_REG_BITS > 32 */
 482         #define SIZEOF_PTR   8
 483 #endif
 484 #endif
 485
 486 #ifndef CPU_BITS_PER_CHAR
 487 #define CPU_BITS_PER_CHAR   (SIZEOF_CHAR * 8)
 488 #endif
 489
 490 #ifndef CPU_BITS_PER_SHORT
 491 #define CPU_BITS_PER_SHORT  (SIZEOF_SHORT * CPU_BITS_PER_CHAR)
 492 #endif
 493
 494 #ifndef CPU_BITS_PER_INT
 495 #define CPU_BITS_PER_INT    (SIZEOF_INT * CPU_BITS_PER_CHAR)
 496 #endif
 497
 498 #ifndef CPU_BITS_PER_LONG
 499 #define CPU_BITS_PER_LONG   (SIZEOF_LONG * CPU_BITS_PER_CHAR)
 500 #endif
 501
 502 #ifndef CPU_BITS_PER_PTR
 503 #define CPU_BITS_PER_PTR    (SIZEOF_PTR * CPU_BITS_PER_CHAR)
 504 #endif
 505
 506 #ifndef BREAKPOINT
 507 #define BREAKPOINT /* nop */
 508 #endif
 509
 510 /*\}*/
 511
 512 /* Sanity checks for the above definitions */
 513 STATIC_ASSERT(sizeof(char) == SIZEOF_CHAR);
 514 STATIC_ASSERT(sizeof(short) == SIZEOF_SHORT);
 515 STATIC_ASSERT(sizeof(long) == SIZEOF_LONG);
 516 STATIC_ASSERT(sizeof(int) == SIZEOF_INT);
 517 STATIC_ASSERT(sizeof(void *) == SIZEOF_PTR);
 518 STATIC_ASSERT(sizeof(int8_t) * CPU_BITS_PER_CHAR == 8);
 519 STATIC_ASSERT(sizeof(uint8_t) * CPU_BITS_PER_CHAR == 8);
 520 STATIC_ASSERT(sizeof(int16_t) * CPU_BITS_PER_CHAR == 16);
 521 STATIC_ASSERT(sizeof(uint16_t) * CPU_BITS_PER_CHAR == 16);
 522 STATIC_ASSERT(sizeof(int32_t) * CPU_BITS_PER_CHAR == 32);
 523 STATIC_ASSERT(sizeof(uint32_t) * CPU_BITS_PER_CHAR == 32);
 524 #ifdef __HAS_INT64_T__
 525 STATIC_ASSERT(sizeof(int64_t) * CPU_BITS_PER_CHAR == 64);
 526 STATIC_ASSERT(sizeof(uint64_t) * CPU_BITS_PER_CHAR == 64);
 527 #endif
 528
 529 /**
 530  * \def CPU_IDLE
 531  *
 532  * \brief Invoked by the scheduler to stop the CPU when idle.
 533  *
 534  * This hook can be redefined to put the CPU in low-power mode, or to
 535  * profile system load with an external strobe, or to save CPU cycles
 536  * in hosted environments such as emulators.
 537  */
 538 #ifndef CPU_IDLE
 539         #if defined(ARCH_EMUL) && (ARCH & ARCH_EMUL)
 540                 /* This emulator hook should yield the CPU to the host.  */
 541                 EXTERN_C_BEGIN
 542                 void emul_idle(void);
 543                 EXTERN_C_END
 544                 #define CPU_IDLE emul_idle()
 545         #else /* !ARCH_EMUL */
 546                 #define CPU_IDLE do { /* nothing */ } while (0)
 547         #endif /* !ARCH_EMUL */
 548 #endif /* !CPU_IDLE */
 549
 550 #endif /* CPU_CPU_H */