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

2010-06-18 11:30:57 +00:00 · 2010-06-18 11:30:57 +00:00 · 7cac72ed6d
parent 0970c44b08
commit 7cac72ed6d
18 changed files with 64 additions and 40 deletions
--- a/os/hal/hal.dox
+++ b/os/hal/hal.dox
@ -57,6 +57,17 @@
 * .
 */

+/**
+ * @defgroup platforms Platforms
+ * @brief Supported platforms.
+ * @details The implementation of the device drivers can be sligthly different
+ * on the various platforms because architectural constrains. This section
+ * describes the implementation of the various device drivers on the various
+ * supported platforms.
+ *
+ * @ingroup IO
+ */
+
 /**
 * @defgroup HAL HAL Driver
 * @brief Hardware Abstraction Layer.
--- a/os/hal/platforms/AT91SAM7/platform.dox
+++ b/os/hal/platforms/AT91SAM7/platform.dox
@ -18,7 +18,7 @@
 */

 /**
- * @defgroup AT91SAM7 AT91SAM7 Support
+ * @defgroup AT91SAM7 AT91SAM7 Drivers
 * @brief AT91SAM7 specific support.
 * @details The AT91SAM7 support includes:
 * - Buffered, interrupt driven, serial driver.
@ -27,7 +27,7 @@
 * - A Web server demo using the uIP TCP/IP stack.
 * - A Web server demo using the lwIP TCP/IP stack.
 * .
- * @ingroup ARM7
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/AVR/platform.dox
+++ b/os/hal/platforms/AVR/platform.dox
@ -19,9 +19,9 @@

 /**
 * @defgroup AVR_DRIVERS AVR Drivers
- * @brief Device drivers included in the AVR support.
+ * @brief AVR specific support.
 *
- * @ingroup AVR
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/LPC11xx/platform.dox
+++ b/os/hal/platforms/LPC11xx/platform.dox
@ -18,14 +18,14 @@
 */

 /**
- * @defgroup LPC11xx LPC11xx Support
+ * @defgroup LPC11xx LPC11xx Drivers
 * @brief LPC11xx specific support.
 * @details The LPC11xx support includes:
 * - I/O ports driver.
 * - Buffered, interrupt driven, serial driver.
 * - A demo supporting the kernel test suite.
 * .
- * @ingroup ARMCMx
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/LPC13xx/platform.dox
+++ b/os/hal/platforms/LPC13xx/platform.dox
@ -18,14 +18,14 @@
 */

 /**
- * @defgroup LPC13xx LPC13xx Support
+ * @defgroup LPC13xx LPC13xx Drivers
 * @brief LPC13xx specific support.
 * @details The LPC13xx support includes:
 * - I/O ports driver.
 * - Buffered, interrupt driven, serial driver.
 * - A demo supporting the kernel test suite.
 * .
- * @ingroup ARMCMx
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/LPC214x/platform.dox
+++ b/os/hal/platforms/LPC214x/platform.dox
@ -18,7 +18,7 @@
 */

 /**
- * @defgroup LPC214x LPC214x Support
+ * @defgroup LPC214x LPC214x Drivers
 * @brief LPC214x specific support.
 * @details The LPC214x support includes:
 * - VIC support code.
@ -29,7 +29,7 @@
 * - A C++ demo supporting the kernel test suite.
 * - A demo integrating ChibiOS/RT with FatFS.
 * .
- * @ingroup ARM7
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/MSP430/platform.dox
+++ b/os/hal/platforms/MSP430/platform.dox
@ -19,9 +19,9 @@

 /**
 * @defgroup MSP430_DRIVERS MSP430 Drivers
- * @brief Device drivers included in the MSP430 support.
+ * @brief MSP430 specific support.
 *
- * @ingroup MSP430
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/SPC56x/platform.dox
+++ b/os/hal/platforms/SPC56x/platform.dox
@ -19,9 +19,9 @@

 /**
 * @defgroup SPC563_DRIVERS SPC563 Drivers
- * @brief Device drivers included in the SPC563 support.
+ * @brief SPC563 specific support.
 *
- * @ingroup PPC
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/STM32/platform.dox
+++ b/os/hal/platforms/STM32/platform.dox
@ -18,7 +18,7 @@
 */

 /**
- * @defgroup STM32 STM32 Support
+ * @defgroup STM32 STM32 Drivers
 * @brief STM32 specific support.
 * @details The STM32 support includes:
 * - I/O ports driver.
@ -30,7 +30,7 @@
 * - A demo supporting the kernel test suite.
 * - A demo that demonstrate the FatFs use with the MMC driver.
 * .
- * @ingroup ARMCMx
+ * @ingroup platforms
 */

 /**
--- a/os/hal/platforms/STM8/platform.dox
+++ b/os/hal/platforms/STM8/platform.dox
@ -19,9 +19,9 @@

 /**
 * @defgroup STM8_DRIVERS STM8 Drivers
- * @brief Device drivers included in the STM8 support.
+ * @brief STM8 specific support.
 *
- * @ingroup STM8
+ * @ingroup platforms
 */

 /**
--- a/os/ports/GCC/ARM7/port.dox
+++ b/os/ports/GCC/ARM7/port.dox
@ -18,12 +18,11 @@
 */

 /**
- * @defgroup ARM7 ARM7TDMI
- * @details The ARM7 architecture is quite complex for a microcontroller and
- * some explanations are required about the port choices.
+ * @defgroup ARM7 ARM7
+ * @details ARM7 port for the GCC compiler.
 *
- * @section ARM7_NOTES The ARM7 modes
- * The ARM7 port supports three modes:
+ * @section ARM7_NOTES Supported ARM7 modes
+ * The ARM7-GCC port supports three modes:
 * - Pure ARM mode, this is the preferred mode for code speed. The code size
 *   is larger however. This mode is enabled when all the modules are compiled
 *   in ARM mode, see the Makefiles.
@ -118,7 +117,7 @@
 * greatly improves code efficiency and size. You can look at the serial
 * driver for real examples of interrupt handlers.
 *
- * @ingroup ports
+ * @ingroup gcc
 */

 /**
--- a/os/ports/GCC/ARMCMx/port.dox
+++ b/os/ports/GCC/ARMCMx/port.dox
@ -19,8 +19,11 @@

 /**
 * @defgroup ARMCMx ARM Cortex-Mx
- * @details This port supports the ARMv6-M and ARMv7-M architectures (all the
- * Cortex-Mx cores).
+ * @details ARM Cortex-Mx port for the GCC compiler.
+ 
+ * @section ARMCMx_INTRO
+ * This port supports all the cores implementing the ARMv6-M and ARMv7-M
+ * architectures.
 *
 * @section ARMCMx_STATES_A System logical states in ARMv6-M
 * - <b>Init</b>. This state is represented by the startup code and the
@ -102,7 +105,7 @@
 * - The threads are started in thread-privileged mode.
 * - Interrupt nesting and the other advanced core/NVIC features are supported.
 * .
- * @ingroup ports
+ * @ingroup gcc
 */

 /**
--- a/os/ports/GCC/AVR/port.dox
+++ b/os/ports/GCC/AVR/port.dox
@ -19,8 +19,7 @@

 /**
 * @defgroup AVR MegaAVR
- * @details AVR port details. This section how the ChibiOS/RT features are
- * implemented on this architecture.
+ * @details AVR port for the GCC compiler.
 *
 * @section AVR_STATES Mapping of the System States in the AVR port
 * The ChibiOS/RT logical @ref system_states are mapped as follow in the AVR
@ -50,7 +49,7 @@
 *   by modifying the @p INT_REQUIRED_STACK macro into
 *   <b>./ports/AVR/chcore.h</b>.
 * .
- * @ingroup ports
+ * @ingroup gcc
 */

 /**
--- a/os/ports/GCC/MSP430/port.dox
+++ b/os/ports/GCC/MSP430/port.dox
@ -19,8 +19,7 @@

 /**
 * @defgroup MSP430 MSP430
- * @details MSP430 port details. This section how the ChibiOS/RT features are
- * implemented on this architecture.
+ * @details MSP430 port for the GCC compiler.
 *
 * @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
@ -56,7 +55,7 @@
 *   select the proper low power mode for you application by defining the
 *   macro @p port_wait_for_interrupt().
 * .
- * @ingroup ports
+ * @ingroup gcc
 */

 /**
--- a/os/ports/GCC/PPC/port.dox
+++ b/os/ports/GCC/PPC/port.dox
@ -18,9 +18,8 @@
 */

 /**
- * @defgroup PPC PowerPC
- * @details PowerPC port details. This section describes how the ChibiOS/RT
- * features are implemented on this architecture.
+ * @defgroup PPC Power Architecture
+ * @details Power Architecture port for the GCC compiler.
 *
 * @section PPC_STATES Mapping of the System States in the PowerPC port
 * The ChibiOS/RT logical @ref system_states are mapped as follow in the
@ -53,7 +52,7 @@
 * - The Book-E Decrementer Timer, mapped on IVOR10, is used for system tick.
 * - Interrupt nesting is not currently supported.
 * .
- * @ingroup ports
+ * @ingroup gcc
 */

 /**
--- a/os/ports/RC/STM8/port.dox
+++ b/os/ports/RC/STM8/port.dox
@ -19,8 +19,7 @@

 /**
 * @defgroup STM8 STM8
- * @details STM8 port details. This section how the ChibiOS/RT features are
- * implemented on this architecture.
+ * @details STM8 port for the Raisonance C compiler.
 *
 * @section STM8_STATES Mapping of the System States in the STM8 port
 * The ChibiOS/RT logical @ref system_states are mapped as follow in the STM8
@ -58,7 +57,7 @@
 *   because the missing support of the @p inline "C" keyword in the
 *   compiler.
 * .
- * @ingroup ports
+ * @ingroup raisonance
 */

 /**
--- a/os/ports/ports.dox
+++ b/os/ports/ports.dox
@ -23,3 +23,16 @@
 * ChibiOS/RT ports.
 */

+/**
+ * @defgroup gcc GCC Ports
+ * Ports for the GCC compiler or derivatives.
+ *
+ * @ingroup ports
+ */
+
+/**
+ * @defgroup raisonance Raisonance Ports
+ * Ports for the Raisonance compiler or derivatives.
+ *
+ * @ingroup ports
+ */
--- a/readme.txt
+++ b/readme.txt
@ -62,6 +62,8 @@
 - FIX: Fixed broken AVR port (bug 3016619)(backported in 2.0.0).
 - FIX: Fixed assertion in adcStop() (bug 3015109)(backported in 2.0.0).
 - OPT: Simplified the test suite code, now it is smaller.
+- Reorganized the documentation, now the description of the device drivers
+  implementation is under the HAL module instead of the Ports module.

 *** 1.5.9 ***
 - FIX: Fixed STM8 baud rate setup error (bug 3010990).