Typo.

[bertos.git] / cfg / cpu.h

diff --git a/cfg/cpu.h b/cfg/cpu.h
index f845bde1239daa0530e90708af6ca141c4096909..66ae5d731b891f7cbb3000ff1d04b0e14ba15e6e 100755 (executable)
--- a/cfg/cpu.h
+++ b/cfg/cpu.h
@@ -1,4 +1,4 @@
-/*!
+/**
  * \file
  * <!--
  * Copyright 2004, 2005 Develer S.r.l. (http://www.develer.com/)
@@ -17,6 +17,15 @@
 
 /*#*
  *#* $Log$
+ *#* Revision 1.15  2006/07/19 12:56:25  bernie
+ *#* Convert to new Doxygen style.
+ *#*
+ *#* Revision 1.14  2006/07/19 12:54:12  bernie
+ *#* Documentation fixes.
+ *#*
+ *#* Revision 1.13  2006/03/27 04:49:23  bernie
+ *#* CPU_IDLE(): Fix for new emulator.
+ *#*
  *#* Revision 1.12  2006/03/21 10:52:39  bernie
  *#* Update ARM support.
  *#*
@@ -75,9 +84,10 @@
 #define DEVLIB_CPU_H
 
 #include <cfg/compiler.h> /* for uintXX_t */
+#include <cfg/arch_config.h>  /* ARCH_EMUL */
 
 
-/*!
+/**
  * \name Macros for determining CPU endianness.
  * \{
  */
@@ -85,10 +95,10 @@
 #define CPU_LITTLE_ENDIAN 0x3412 /* Look twice, pal. This is not a bug. */
 /*\}*/
 
-/*! Macro to include cpu-specific versions of the headers. */
+/** Macro to include cpu-specific versions of the headers. */
 #define CPU_HEADER(module)          PP_STRINGIZE(PP_CAT3(module, _, CPU_ID).h)
 
-/*! Macro to include cpu-specific versions of implementation files. */
+/** Macro to include cpu-specific versions of implementation files. */
 #define CPU_CSOURCE(module)         PP_STRINGIZE(PP_CAT3(module, _, CPU_ID).c)
 
 
@@ -365,7 +375,7 @@
        #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
@@ -377,7 +387,7 @@
        #error No CPU_... defined.
 #endif
 
-/*!
+/**
  * Execute \a CODE atomically with respect to interrupts.
  *
  * \see IRQ_SAVE_DISABLE IRQ_RESTORE
@@ -391,7 +401,7 @@
        } while (0)
 
 
-//! Default for macro not defined in the right arch section
+/// Default for macro not defined in the right arch section
 #ifndef CPU_REG_INIT_VALUE
        #define CPU_REG_INIT_VALUE(reg)     0
 #endif
@@ -471,7 +481,7 @@
 #endif
 
 
-/*!
+/**
  * \name Default type sizes.
  *
  * These defaults are reasonable for most 16/32bit machines.
@@ -565,7 +575,7 @@ STATIC_ASSERT(sizeof(int64_t) * CPU_BITS_PER_CHAR == 64);
 STATIC_ASSERT(sizeof(uint64_t) * CPU_BITS_PER_CHAR == 64);
 #endif
 
-/*!
+/**
  * \def CPU_IDLE
  *
  * \brief Invoked by the scheduler to stop the CPU when idle.
@@ -578,15 +588,12 @@ STATIC_ASSERT(sizeof(uint64_t) * CPU_BITS_PER_CHAR == 64);
        #if defined(ARCH_EMUL) && (ARCH & ARCH_EMUL)
                /* This emulator hook should yield the CPU to the host.  */
                EXTERN_C_BEGIN
-               void SchedulerIdle(void);
+               void emul_idle(void);
                EXTERN_C_END
-               #define CPU_IDLE SchedulerIdle()
+               #define CPU_IDLE emul_idle()
        #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 */