aboutsummaryrefslogtreecommitdiffstats
path: root/os
diff options
context:
space:
mode:
authorgdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-10-02 10:27:36 +0000
committergdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4>2010-10-02 10:27:36 +0000
commit55848af13c5077a42ef71b15ab98e003ed709948 (patch)
treedec00ffb0a6e896713a037479292b4a21bc8b3eb /os
parent1e7634e7ad8881ce948b00755fda8badc9e1e654 (diff)
downloadChibiOS-55848af13c5077a42ef71b15ab98e003ed709948.tar.gz
ChibiOS-55848af13c5077a42ef71b15ab98e003ed709948.tar.bz2
ChibiOS-55848af13c5077a42ef71b15ab98e003ed709948.zip
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2221 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os')
-rw-r--r--os/ports/GCC/MSP430/port.dox30
1 files changed, 19 insertions, 11 deletions
diff --git a/os/ports/GCC/MSP430/port.dox b/os/ports/GCC/MSP430/port.dox
index 721540baf..3f9609cf9 100644
--- a/os/ports/GCC/MSP430/port.dox
+++ b/os/ports/GCC/MSP430/port.dox
@@ -21,8 +21,11 @@
* @defgroup MSP430 MSP430
* @details MSP430 port for the GCC compiler.
*
+ * @section MSP430_INTRO Introduction
+ * This port supports all the cores implementing the MSP430 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
+ * The ChibiOS/RT logical system states are mapped as follow in the MSP430
* port:
* - <b>Init</b>. This state is represented by the startup code and the
* initialization code before @p chSysInit() is executed. It has not a
@@ -46,8 +49,7 @@
* @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>.
+ * by modifying the @p INT_REQUIRED_STACK configuration options.
* - The state of the hardware multiplier is not saved in the thread context,
* make sure to use it in <b>Suspended</b> state (interrupts masked).
* - The port code does not define the switch to a low power mode for the
@@ -60,10 +62,10 @@
/**
* @defgroup MSP430_CONF Configuration Options
- * @brief MSP430 Configuration Options.
- * @details The MSP430 port allows some architecture-specific configurations
- * settings that can be overridden by redefining them in @p chconf.h.
- * Usually there is no need to change the default values.
+ * @details MSP430 Configuration Options. The MSP430 port allows some
+ * architecture-specific configurations settings that can be overridden
+ * by redefining them in @p chconf.h. Usually there is no need to change
+ * the default values.
* - @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
@@ -76,12 +78,18 @@
* @ingroup MSP430
*/
+ /**
+ * @defgroup MSP430_STARTUP Startup Support
+ * @details ChibiOS/RT doed not provide startup files for the MSP430, there
+ * are no special startup requirement so the normal toolchain-provided
+ * startup files can be used.
+ *
+ * @ingroup MSP430
+ */
+
/**
* @defgroup MSP430_CORE Core Port Implementation
- * @brief MSP430 specific port code, structures and macros.
+ * @details MSP430 specific port code, structures and macros.
*
* @ingroup MSP430
- * @file MSP430/chtypes.h Port types.
- * @file MSP430/chcore.h Port related structures and macros.
- * @file MSP430/chcore.c Port related code.
*/