git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@636 35acf78f-673a-0410-8e92-d51de3d6d3f4

docs/Doxyfile

@@ -84,7 +84,7 @@ WARN_LOGFILE =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT = ../src/include ../src/templates ../src ../docs/ch.txt ../src/lib ../ports/ARM7 ../ports/ARMCM3 
+INPUT = ../src/include ../src/templates ../src ../docs/ch.txt ../src/lib ../ports/ARM7 ../ports/ARMCM3 ../ports/MSP430 
 INPUT_ENCODING = UTF-8
 FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py *.ddf
 RECURSIVE = YES

docs/ch.txt

@@ -328,40 +328,6 @@
  */
 /** @} */
 
-/**
- * @defgroup MSP430 MSP430
- * @{
- * <p>
- * Notes about the MSP430 port:
- * </p>
- * <ul>
- * <li>The MSP430 does not have a dedicated interrupt stack, make sure to reserve
- *     enough stack space for interrupts in each thread stack. This can be done
- *     by modifying the @p INT_REQUIRED_STACK macro into
- *     <b>./ports/MSP430/chcore.h</b>.</li>
- * </ul>
- * @ingroup Ports
- */
-/** @} */
-
-/**
- * @defgroup MSP430CONF Configuration Options
- * @{
- * <p>
- * The MSP430 port allows some architecture-specific configurations settings
- * that can be specified externally, as example on the compiler command line:
- * <ul>
- * <li>@p INT_REQUIRED_STACK, this value represent the amount of stack space
- *     used by the interrupt handlers.<br>
- *     The default for this value is @p 32, this space is allocated for each
- *     thread so be careful in order to not waste precious RAM space.<br>
- *     The default value is set into <b>./ports/MSP430/chcore.h</b>.</li>
- * </ul>
- * </p>
- * @ingroup MSP430
- */
-/** @} */
-
 /**
  * @defgroup Kernel Kernel
  * @{

ports/MSP430/port.dox

@@ -0,0 +1,64 @@
+/**
+ * @defgroup MSP430 MSP430
+ * @{
+ * @details MSP430 port details. This section how the ChibiOS/RT features are
+ * implemented on this architecture.
+ *
+ * @section MSP430_STATES Mapping of the System States in the MSP430 port
+ * The ChibiOS/RT logical @ref system_states are mapped as follow in the MSP430
+ * port:
+ * - <b>Initialization</b>. This state is represented by the startup code and
+ *   the initialization code before @p chSysInit() is executed. It has not a
+ *   special hardware state associated.
+ * - <b>Normal</b>. This is the state the system has after executing
+ *   @p chSysInit(). Interrupts are enabled.
+ * - <b>Suspended</b>. Interrupts are disabled.
+ * - <b>Disabled</b>. Interrupts are enabled. This state is equivalent to the
+ *   Suspended state because there are no fast interrupts in this architecture.
+ * - <b>Sleep</b>. Not yet implemented.
+ * - <b>S-Locked</b>. Interrupts are disabled.
+ * - <b>I-Locked</b>. This state is equivalent to the SRI state, the
+ *   @p chSysLockI() and @p chSysUnlockI() APIs do nothing (still use them in
+ *   order to formally change state because this may change).
+ * - <b>Serving Regular Interrupt</b>. Normal interrupt service code.
+ * - <b>Serving Fast Interrupt</b>. Not present in this architecture.
+ * - <b>Serving Non-Maskable Interrupt</b>. Not present in this architecture.
+ * - <b>Halted</b>. Implemented as an infinite loop with interrupts disabled.
+ * 
+ * @section MSP430_NOTES The MSP430 port notes
+ * - The MSP430 does not have a dedicated interrupt stack, make sure to reserve
+ *     enough stack space for interrupts in each thread stack. This can be done
+ *     by modifying the @p INT_REQUIRED_STACK macro into
+ *     <b>./ports/MSP430/chcore.h</b>.
+ *
+ * @ingroup Ports
+ */
+/** @} */
+
+/**
+ * @defgroup MSP430_CONF Configuration Options
+ * @{
+ * @brief MSP430 Configuration Options.
+ * The MSP430 port allows some architecture-specific configurations settings
+ * that can be specified externally, as example on the compiler command line:
+ * - @p INT_REQUIRED_STACK, this value represent the amount of stack space
+ *   used by the interrupt handlers.<br>
+ *   The default for this value is @p 32, this space is allocated for each
+ *   thread so be careful in order to not waste precious RAM space.<br>
+ *   The default value is set into <b>./ports/MSP430/chcore.h</b>.
+ *
+ * @ingroup MSP430
+ */
+/** @} */
+
+/**
+ * @defgroup MSP430_CORE MSP430 Core Implementation
+ * @{
+ * @brief MSP430 specific port code, structures and macros.
+ *
+ * @ingroup MSP430
+ * @file ports/MSP430/chtypes.h Port types.
+ * @file ports/MSP430/chcore.h Port related structures and macros.
+ * @file ports/MSP430/chcore.c Port related code.
+ */
+/** @} */