Merge with 5eed0471196ddd710647bb8cf83ad6e9aa189c61 (default branch)

[arc.git] / include / Mcu.h

diff --git a/include/Mcu.h b/include/Mcu.h
index 7f28ad8ab4acdfedb66853cf863110787589c2a4..56130efdd1c7ed6794b3eb5a6b3aeff396cc0bf8 100644 (file)
--- a/include/Mcu.h
+++ b/include/Mcu.h
@@ -13,12 +13,12 @@
  * for more details.
  * -------------------------------- Arctic Core ------------------------------*/
 
+/** @addtogroup Mcu MCU Driver
+ *  @{ */
 
-
-
-
-
-
+/** @file Mcu.h
+ * API and type definitions for MCU Driver.
+ */
 
 #ifndef MCU_H_\r
 #define MCU_H_\r
@@ -31,7 +31,8 @@
 #include "irq_types.h"\r
 //#include "mpc55xx_aos.h"\r
 \r
-/* Service ID's */\r
+/** @name Service id's */
+//@{
 #define MCU_INIT_SERVICE_ID                 0x00\r
 #define MCU_INITRAMSECTION_SERVICE_ID       0x01\r
 #define MCU_INITCLOCK_SERVICE_ID            0x02\r
@@ -43,18 +44,21 @@
 #define MCU_SETMODE_SERVICE_ID              0x08\r
 #define MCU_GETVERSIONINFO_SERVICE_ID       0x09\r
 #define MCU_INTCVECTORINSTALL_SERVICE_ID    0x0A // Not in spec but follows pattern\r
-\r
-/* Development error codes */\r
+//@}
+
+/** @name Error Codes */
+//@{
 #define MCU_E_PARAM_CONFIG                  0x0A\r
 #define MCU_E_PARAM_CLOCK                   0x0B\r
 #define MCU_E_PARAM_MODE                    0x0C\r
 #define MCU_E_PARAM_RAMSECTION              0x0D\r
 #define MCU_E_PLL_NOT_LOCKED                0x0E\r
 #define MCU_E_UNINIT                        0x0F\r
+//@}
 \r
 /* Specific return values */\r
-#define MCU_GETRESETRAWVALUE_NORESETREG_RV  0x00 // MCU006\r
-#define MCU_GETRESETRAWVALUE_UNINIT_RV      0xffffffff // MCU135\r
+#define MCU_GETRESETRAWVALUE_NORESETREG_RV  0x00 /**< MCU006 */
+#define MCU_GETRESETRAWVALUE_UNINIT_RV      0xffffffff /**< MCU135 */
 \r
 typedef enum {\r
        MCU_PLL_LOCKED,\r
@@ -123,3 +127,4 @@ void McuE_DisableInterrupts(void);
 \r
 \r
 #endif /*MCU_H_*/\r
+/** @} */