diff options
| author | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-02 13:06:38 +0000 |
|---|---|---|
| committer | gdisirio <gdisirio@35acf78f-673a-0410-8e92-d51de3d6d3f4> | 2010-10-02 13:06:38 +0000 |
| commit | c62d4d6407ef7ec46ff6258fe7390de645810a10 (patch) | |
| tree | 0bc7d833cb5d273fe0c63ff4b21edde834359281 /os/ports/RC | |
| parent | 631a5044e10ac0a63f0a0aa1ca02c3971d880d83 (diff) | |
| download | ChibiOS-c62d4d6407ef7ec46ff6258fe7390de645810a10.tar.gz ChibiOS-c62d4d6407ef7ec46ff6258fe7390de645810a10.tar.bz2 ChibiOS-c62d4d6407ef7ec46ff6258fe7390de645810a10.zip | |
Documentation related fixes.
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2224 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/ports/RC')
| -rw-r--r-- | os/ports/RC/STM8/port.dox | 32 |
1 files changed, 20 insertions, 12 deletions
diff --git a/os/ports/RC/STM8/port.dox b/os/ports/RC/STM8/port.dox index 2f6d55236..5daf546f9 100644 --- a/os/ports/RC/STM8/port.dox +++ b/os/ports/RC/STM8/port.dox @@ -21,8 +21,11 @@ * @defgroup STM8_RAISONANCE STM8
* @details STM8 port for the Raisonance C compiler.
*
+ * @section STM8_RAISONANCE_INTRO Introduction
+ * This port supports all STM8 8 bits MCUs.
+ *
* @section STM8_RAISONANCE_STATES Mapping of the System States in the STM8 port
- * The ChibiOS/RT logical @ref system_states are mapped as follow in the STM8
+ * The ChibiOS/RT logical system states are mapped as follow in the STM8
* 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
@@ -62,25 +65,30 @@ /**
* @defgroup STM8_RAISONANCE_CONF Configuration Options
- * @brief STM8 Configuration Options.
- * @details The STM8 port allows some architecture-specific configurations
- * settings that can be specified externally, as example on the compiler
- * command line:
+ * @details STM8 Configuration Options. The STM8 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
- * thread so be careful in order to not waste precious RAM space.<br>
- * The default value is set into <b>./os/ports/RC/STM8/chcore.h</b>.
+ * The default for this value is @p 48, this space is allocated for each
+ * thread so be careful in order to not waste precious RAM space.
* .
* @ingroup STM8_RAISONANCE
*/
+ /**
+ * @defgroup STM8_RAISONANCE_STARTUP Startup Support
+ * @details ChibiOS/RT doed not provide startup files for the STM8, there
+ * are no special startup requirement so the normal toolchain-provided
+ * startup files can be used.
+ *
+ * @ingroup STM8_RAISONANCE
+ */
+
/**
* @defgroup STM8_RAISONANCE_CORE Core Port Implementation
- * @brief STM8 specific port code, structures and macros.
+ * @details STM8 specific port code, structures and macros.
*
* @ingroup STM8_RAISONANCE
- * @file RC/STM8/chtypes.h Port types.
- * @file RC/STM8/chcore.h Port related structures and macros.
- * @file RC/STM8/chcore.c Port related code.
*/
|