diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-01-18 16:51:15 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2009-01-18 16:51:15 +0000 |
| commit | cb692f1c51bb79c7c6f015cef9da5dfeb1bfebba (patch) | |
| tree | 802fa46e8f5657bf8af7625849e6bce66656a9b0 /ports | |
| parent | 69d687d05d42ba501c5aa1a6b26a2a7f46954612 (diff) | |
| download | ChibiOS-cb692f1c51bb79c7c6f015cef9da5dfeb1bfebba.tar.gz ChibiOS-cb692f1c51bb79c7c6f015cef9da5dfeb1bfebba.tar.bz2 ChibiOS-cb692f1c51bb79c7c6f015cef9da5dfeb1bfebba.zip | |
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@636 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'ports')
| -rw-r--r-- | ports/MSP430/port.dox | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/ports/MSP430/port.dox b/ports/MSP430/port.dox new file mode 100644 index 000000000..d35317c75 --- /dev/null +++ b/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.
+ */
+/** @} */
|