Add progmem datatypes; PSTR() definition.
[bertos.git] / cpu.h
diff --git a/cpu.h b/cpu.h
index 335876130765ffd001011786086c1da0aef8101b..1c8a62f387df5f85d449142958f491d09b84ce8d 100755 (executable)
--- a/cpu.h
+++ b/cpu.h
  * \version $Id$
  *
  * \author Giovanni Bajo <rasky@develer.com>
+ * \author Bernardo Innocenti <bernie@develer.com>
+ * \author Stefano Fedrigo <aleph@develer.com>
  */
 
-/*
- * $Log$
- * Revision 1.3  2004/07/18 21:49:51  bernie
- * Fixes for GCC 3.5.
- *
- * Revision 1.2  2004/06/03 11:27:09  bernie
- * Add dual-license information.
- *
- * Revision 1.1  2004/05/23 17:48:35  bernie
- * Add top-level files.
- *
+/*#*
+ *#* $Log$
+ *#* Revision 1.28  2004/12/31 17:39:41  bernie
+ *#* Fix documentation.
+ *#*
+ *#* Revision 1.27  2004/12/31 17:02:47  bernie
+ *#* IRQ_SAVE_DISABLE(), IRQ_RESTORE(): Add null stubs for x86.
+ *#*
+ *#* Revision 1.26  2004/12/13 12:08:12  bernie
+ *#* DISABLE_IRQSAVE, ENABLE_IRQRESTORE, DISABLE_INTS, ENABLE_INTS: Remove obsolete macros.
+ *#*
+ *#* Revision 1.25  2004/12/08 08:31:02  bernie
+ *#* CPU_HARVARD: Define to 1 for AVR and DSP56K.
+ *#*
+ *#* Revision 1.24  2004/12/08 08:04:13  bernie
+ *#* Doxygen fixes.
+ *#*
+ *#* Revision 1.23  2004/11/16 22:41:58  bernie
+ *#* Support 64bit CPUs.
+ *#*
+ *#* Revision 1.22  2004/11/16 21:57:59  bernie
+ *#* CPU_IDLE: Rename from SCHEDULER_IDLE.
+ *#*
+ *#* Revision 1.21  2004/11/16 21:34:25  bernie
+ *#* Commonize obsolete names for IRQ macros; Doxygen fixes.
+ *#*
+ *#* Revision 1.20  2004/11/16 20:33:32  bernie
+ *#* CPU_HARVARD: New macro.
+ *#*
+ *#* Revision 1.19  2004/10/03 20:43:54  bernie
+ *#* Fix Doxygen markup.
+ *#*
+ *#* Revision 1.18  2004/10/03 18:36:31  bernie
+ *#* IRQ_GETSTATE(): New macro; Rename IRQ macros for consistency.
+ *#*
+ *#* Revision 1.17  2004/09/06 21:48:27  bernie
+ *#* ATOMIC(): New macro.
+ *#*
+ *#* Revision 1.16  2004/08/29 21:58:33  bernie
+ *#* Rename BITS_PER_XYZ macros; Add sanity checks.
+ *#*
+ *#* Revision 1.15  2004/08/25 14:12:08  rasky
+ *#* Aggiornato il comment block dei log RCS
+ *#*
+ *#* Revision 1.14  2004/08/24 13:29:28  bernie
+ *#* Trim CVS log; Rename header guards.
+ *#*
+ *#* Revision 1.12  2004/08/14 19:37:57  rasky
+ *#* Merge da SC: macros.h, pool.h, BIT_CHANGE, nome dei processi, etc.
+ *#*
+ *#* Revision 1.11  2004/08/05 17:39:56  bernie
+ *#* Fix a Doxygen tag.
+ *#*
+ *#* Revision 1.10  2004/08/02 20:20:29  aleph
+ *#* Merge from project_ks
+ *#*
+ *#* Revision 1.9  2004/07/30 14:24:16  rasky
+ *#* Task switching con salvataggio perfetto stato di interrupt (SR)
+ *#* Kernel monitor per dump informazioni su stack dei processi
+ *#*/
+#ifndef DEVLIB_CPU_H
+#define DEVLIB_CPU_H
+
+#include "compiler.h" /* for uintXX_t */
+
+
+/*!
+ * \name Macros for determining CPU endianness.
+ * \{
  */
-#ifndef CPU_H
-#define CPU_H
+#define CPU_BIG_ENDIAN    0x1234
+#define CPU_LITTLE_ENDIAN 0x3412
+/*\}*/
 
-#include "compiler.h"
+/*! Macro to include cpu-specific versions of the headers. */
+#define CPU_HEADER(module)          PP_STRINGIZE(PP_CAT3(module, _, CPU_ID).h)
 
-//! Initialization value for registers in stack frame
-#define CPU_REG_INIT_VALUE(reg)     0
 
-#if defined(__IAR_SYSTEMS_ICC) || defined(__IAR_SYSTEMS_ICC__)  /* 80C196 */
+#if CPU_I196
 
-       #define DISABLE_INTS            disable_interrupt()
-       #define ENABLE_INTS             enable_interrupt()
        #define NOP                     nop_instruction()
-       #define SCHEDULER_IDLE          /* Hmmm... could we go in STOP mode? */
+       #define IRQ_DISABLE             disable_interrupt()
+       #define IRQ_ENABLE              enable_interrupt()
 
        typedef uint16_t cpuflags_t; // FIXME
        typedef unsigned int cpustack_t;
 
+       #define CPU_REG_BITS            16
        #define CPU_REGS_CNT            16
        #define CPU_STACK_GROWS_UPWARD  0
        #define CPU_SP_ON_EMPTY_SLOT    0
+       #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
+       #define CPU_HARVARD             0
 
-#elif defined(__i386__) || defined(_MSC_VER) /* x86 */
+#elif CPU_X86
 
        #define NOP                     asm volatile ("nop")
-       #define DISABLE_INTS            /* nothing */
-       #define ENABLE_INTS             /* nothing */
-       #define SCHEDULER_IDLE          SchedulerIdle()
+       #define IRQ_DISABLE             /* nothing */
+       #define IRQ_ENABLE              /* nothing */
+       #define IRQ_SAVE_DISABLE(x)     /* nothing */
+       #define IRQ_RESTORE(x)          /* nothing */
 
        typedef uint32_t cpuflags_t; // FIXME
        typedef uint32_t cpustack_t;
 
+       #define CPU_REG_BITS            32
        #define CPU_REGS_CNT            7
        #define CPU_STACK_GROWS_UPWARD  0
        #define CPU_SP_ON_EMPTY_SLOT    0
+       #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
+       #define CPU_HARVARD             0
 
-#elif defined(__m56800E__) || defined(__m56800__) /* DSP56K */
+#elif CPU_DSP56K
 
        #define NOP                     asm(nop)
-       #define DISABLE_INTS            do { asm(bfset #0x0200,SR); asm(nop); } while (0)
-       #define ENABLE_INTS             do { asm(bfclr #0x0200,SR); asm(nop); } while (0)
-       #define SCHEDULER_IDLE          /* nothing */
+       #define IRQ_DISABLE             do { asm(bfset #0x0200,SR); asm(nop); } while (0)
+       #define IRQ_ENABLE              do { asm(bfclr #0x0200,SR); asm(nop); } while (0)
+
+       #define IRQ_SAVE_DISABLE(x)  \
+               do { (void)x; asm(move SR,x); asm(bfset #0x0200,SR); } while (0)
+       #define IRQ_RESTORE(x)  \
+               do { (void)x; asm(move x,SR); } while (0)
 
-       #define DISABLE_IRQSAVE(x)  \
-               do { asm(move SR,x); asm(bfset #0x0200,SR); } while (0)
-       #define ENABLE_IRQRESTORE(x)  \
-               do { asm(move x,SR); } while (0)
 
        typedef uint16_t cpuflags_t;
        typedef unsigned int cpustack_t;
 
+       #define CPU_REG_BITS            16
        #define CPU_REGS_CNT            FIXME
-       #define CPU_SAVED_REGS_CNT      28
+       #define CPU_SAVED_REGS_CNT      8
        #define CPU_STACK_GROWS_UPWARD  1
        #define CPU_SP_ON_EMPTY_SLOT    0
+       #define CPU_BYTE_ORDER          CPU_BIG_ENDIAN
+       #define CPU_HARVARD             1
 
-       #undef CPU_REG_INIT_VALUE
-       INLINE uint16_t CPU_REG_INIT_VALUE(int reg)
-       {
-               if (reg == 14)
-               {
-                       uint16_t omr_img;
-                       asm(move OMR, omr_img);
-                       return omr_img & (BV(3)/*EX*/ | BV(1)/*MB*/ | BV(0)/*MA*/);
-               }
-               else if (reg == 16)/*M01*/
-                       return 0xFFFF;
-               return 0;
-       }
-
-#elif defined (__AVR__)
-
-       #define NOP                     asm volatile ("nop" ::)
-       #define DISABLE_INTS            asm volatile ("cli" ::)
-       #define ENABLE_INTS             asm volatile ("sei" ::)
-       #define SCHEDULER_IDLE          /* nothing */
-
-       #define DISABLE_IRQSAVE(x) \
+       /* Memory is word-addessed in the DSP56K */
+       #define CPU_BITS_PER_CHAR  16
+       #define SIZEOF_SHORT        1
+       #define SIZEOF_INT          1
+       #define SIZEOF_LONG         2
+       #define SIZEOF_PTR          1
+
+#elif CPU_AVR
+
+       #define NOP           asm volatile ("nop" ::)
+       #define IRQ_DISABLE   asm volatile ("cli" ::)
+       #define IRQ_ENABLE    asm volatile ("sei" ::)
+
+       #define IRQ_SAVE_DISABLE(x) \
        do { \
                __asm__ __volatile__( \
                        "in %0,__SREG__\n\t" \
                ); \
        } while (0)
 
-       #define ENABLE_IRQRESTORE(x) \
+       #define IRQ_RESTORE(x) \
        do { \
                __asm__ __volatile__( \
                        "out __SREG__,%0" : /* no outputs */ : "r" (x) : "cc" \
                ); \
        } while (0)
 
+       #define IRQ_GETSTATE() \
+       ({ \
+               uint8_t sreg; \
+               __asm__ __volatile__( \
+                       "in %0,__SREG__\n\t" \
+                       : "=r" (sreg)  /* no inputs & no clobbers */ \
+               ); \
+               (bool)(sreg & 0x80); \
+       })
+
        typedef uint8_t cpuflags_t;
        typedef uint8_t cpustack_t;
 
-       #define CPU_REGS_CNT            32
-       #define CPU_SAVED_REGS_CNT      18
+       /* Register counts include SREG too */
+       #define CPU_REG_BITS            8
+       #define CPU_REGS_CNT           33
+       #define CPU_SAVED_REGS_CNT     19
        #define CPU_STACK_GROWS_UPWARD  0
-       #define CPU_SP_ON_EMPTY_SLOT    1
+       #define CPU_SP_ON_EMPTY_SLOT    1
+       #define CPU_BYTE_ORDER          CPU_LITTLE_ENDIAN
+       #define CPU_HARVARD             1
+
+       /*!
+        * Initialization value for registers in stack frame.
+        * The register index is not directly corrispondent to CPU
+        * register numbers. Index 0 is the SREG register: the initial
+        * value is all 0 but the interrupt bit (bit 7).
+        */
+       #define CPU_REG_INIT_VALUE(reg) (reg == 0 ? 0x80 : 0)
 
-#else
-       #error Unknown CPU
+#endif
+
+/*!
+ * Execute \a CODE atomically with respect to interrupts.
+ *
+ * \see IRQ_SAVE_DISABLE IRQ_RESTORE
+ */
+#define ATOMIC(CODE) \
+       do { \
+               cpuflags_t __flags; \
+               IRQ_SAVE_DISABLE(__flags); \
+               CODE; \
+               IRQ_RESTORE(__flags); \
+       } while (0)
+
+
+//! Default for macro not defined in the right arch section
+#ifndef CPU_REG_INIT_VALUE
+       #define CPU_REG_INIT_VALUE(reg)     0
 #endif
 
 
 #endif
 
 
-#if defined(__m56800E__) || defined(__m56800__)
-       /* DSP56k pushes both PC and SR to the stack in the JSR instruction, but
+#if CPU_DSP56K
+       /*
+        * DSP56k pushes both PC and SR to the stack in the JSR instruction, but
         * RTS discards SR while returning (it does not restore it). So we push
         * 0 to fake the same context.
         */
        #define CPU_PUSH_CALL_CONTEXT(sp, func) \
                do { \
                        CPU_PUSH_WORD((sp), (func)); \
-                       CPU_PUSH_WORD((sp), 0); \
+                       CPU_PUSH_WORD((sp), 0x100); \
                } while (0);
 
-#elif defined (__AVR__)
-       /* In AVR, the addresses are pushed into the stack as little-endian, while
+#elif CPU_AVR
+       /*
+        * In AVR, the addresses are pushed into the stack as little-endian, while
         * memory accesses are big-endian (actually, it's a 8-bit CPU, so there is
         * no natural endianess).
         */
                CPU_PUSH_WORD((sp), (func))
 #endif
 
-#endif /* CPU_H */
+
+/*!
+ * \name Default type sizes.
+ *
+ * These defaults are reasonable for most 16/32bit machines.
+ * Some of these macros may be overridden by CPU-specific code above.
+ *
+ * ANSI C requires that the following equations be true:
+ * \code
+ *   sizeof(char) <= sizeof(short) <= sizeof(int) <= sizeof(long)
+ *   sizeof(float) <= sizeof(double)
+ *   CPU_BITS_PER_CHAR  >= 8
+ *   CPU_BITS_PER_SHORT >= 8
+ *   CPU_BITS_PER_INT   >= 16
+ *   CPU_BITS_PER_LONG  >= 32
+ * \endcode
+ * \{
+ */
+#ifndef SIZEOF_CHAR
+#define SIZEOF_CHAR  1
+#endif
+
+#ifndef SIZEOF_SHORT
+#define SIZEOF_SHORT  2
+#endif
+
+#ifndef SIZEOF_INT
+#if CPU_REG_BITS < 32
+       #define SIZEOF_INT  2
+#else
+       #define SIZEOF_INT  4
+#endif
+#endif /* !SIZEOF_INT */
+
+#ifndef SIZEOF_LONG
+#if CPU_REG_BITS > 32
+       #define SIZEOF_LONG  8
+#else
+       #define SIZEOF_LONG  4
+#endif
+#endif
+
+#ifndef SIZEOF_PTR
+#define SIZEOF_PTR   SIZEOF_INT
+#endif
+
+#ifndef CPU_BITS_PER_CHAR
+#define CPU_BITS_PER_CHAR   (SIZEOF_CHAR * 8)
+#endif
+
+#ifndef CPU_BITS_PER_SHORT
+#define CPU_BITS_PER_SHORT  (SIZEOF_SHORT * CPU_BITS_PER_CHAR)
+#endif
+
+#ifndef CPU_BITS_PER_INT
+#define CPU_BITS_PER_INT    (SIZEOF_INT * CPU_BITS_PER_CHAR)
+#endif
+
+#ifndef CPU_BITS_PER_LONG
+#define CPU_BITS_PER_LONG   (SIZEOF_LONG * CPU_BITS_PER_CHAR)
+#endif
+
+#ifndef CPU_BITS_PER_PTR
+#define CPU_BITS_PER_PTR    (SIZEOF_PTR * CPU_BITS_PER_CHAR)
+#endif
+/*\}*/
+
+/* Sanity checks for the above definitions */
+STATIC_ASSERT(sizeof(char) == SIZEOF_CHAR);
+STATIC_ASSERT(sizeof(short) == SIZEOF_SHORT);
+STATIC_ASSERT(sizeof(long) == SIZEOF_LONG);
+STATIC_ASSERT(sizeof(int) == SIZEOF_INT);
+
+
+/*!
+ * \def CPU_IDLE
+ *
+ * \brief Invoked by the scheduler to stop the CPU when idle.
+ *
+ * This hook can be redefined to put the CPU in low-power mode, or to
+ * profile system load with an external strobe, or to save CPU cycles
+ * in hosted environments such as emulators.
+ */
+#ifndef CPU_IDLE
+       #if defined(ARCH_EMUL) && (ARCH & ARCH_EMUL)
+               /* This emulator hook should yield the CPU to the host.  */
+               EXTERN_C_BEGIN
+               void SchedulerIdle(void);
+               EXTERN_C_END
+               #define CPU_IDLE SchedulerIdle()
+       #else /* !ARCH_EMUL */
+               #define CPU_IDLE do { /* nothing */ } while (0)
+       #endif /* !ARCH_EMUL */
+#endif /* !CPU_IDLE */
+
+/* OBSOLETE */
+#define SCHEDULER_IDLE CPU_IDLE
+
+#endif /* DEVLIB_CPU_H */