From 7cac72ed6d172e67967c5cadbaa4fe8d9aa758fb Mon Sep 17 00:00:00 2001 From: gdisirio Date: Fri, 18 Jun 2010 11:30:57 +0000 Subject: git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2024 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/hal.dox | 11 +++++++++++ os/hal/platforms/AT91SAM7/platform.dox | 4 ++-- os/hal/platforms/AVR/platform.dox | 4 ++-- os/hal/platforms/LPC11xx/platform.dox | 4 ++-- os/hal/platforms/LPC13xx/platform.dox | 4 ++-- os/hal/platforms/LPC214x/platform.dox | 4 ++-- os/hal/platforms/MSP430/platform.dox | 4 ++-- os/hal/platforms/SPC56x/platform.dox | 4 ++-- os/hal/platforms/STM32/platform.dox | 4 ++-- os/hal/platforms/STM8/platform.dox | 4 ++-- os/ports/GCC/ARM7/port.dox | 11 +++++------ os/ports/GCC/ARMCMx/port.dox | 9 ++++++--- os/ports/GCC/AVR/port.dox | 5 ++--- os/ports/GCC/MSP430/port.dox | 5 ++--- os/ports/GCC/PPC/port.dox | 7 +++---- os/ports/RC/STM8/port.dox | 5 ++--- os/ports/ports.dox | 13 +++++++++++++ 17 files changed, 62 insertions(+), 40 deletions(-) (limited to 'os') diff --git a/os/hal/hal.dox b/os/hal/hal.dox index 08a3ebbd1..733e71758 100644 --- 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. diff --git a/os/hal/platforms/AT91SAM7/platform.dox b/os/hal/platforms/AT91SAM7/platform.dox index 770e80e5b..931f97c49 100644 --- 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 */ /** diff --git a/os/hal/platforms/AVR/platform.dox b/os/hal/platforms/AVR/platform.dox index 6e51eb843..b14441ebc 100644 --- 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 */ /** diff --git a/os/hal/platforms/LPC11xx/platform.dox b/os/hal/platforms/LPC11xx/platform.dox index e41fffa13..89a10f6c0 100644 --- 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 */ /** diff --git a/os/hal/platforms/LPC13xx/platform.dox b/os/hal/platforms/LPC13xx/platform.dox index 8fc0cf389..4baeeedaa 100644 --- 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 */ /** diff --git a/os/hal/platforms/LPC214x/platform.dox b/os/hal/platforms/LPC214x/platform.dox index 5323f1ecf..48df22f36 100644 --- 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 */ /** diff --git a/os/hal/platforms/MSP430/platform.dox b/os/hal/platforms/MSP430/platform.dox index 2ea6c1593..4bcb197ba 100644 --- 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 */ /** diff --git a/os/hal/platforms/SPC56x/platform.dox b/os/hal/platforms/SPC56x/platform.dox index 119300758..a97718c0f 100644 --- 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 */ /** diff --git a/os/hal/platforms/STM32/platform.dox b/os/hal/platforms/STM32/platform.dox index 36cdcfa0d..81b95d2c8 100644 --- 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 */ /** diff --git a/os/hal/platforms/STM8/platform.dox b/os/hal/platforms/STM8/platform.dox index 0a6dbbb80..20a2637af 100644 --- 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 */ /** diff --git a/os/ports/GCC/ARM7/port.dox b/os/ports/GCC/ARM7/port.dox index 7f61bbf63..b70d230e7 100644 --- 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 */ /** diff --git a/os/ports/GCC/ARMCMx/port.dox b/os/ports/GCC/ARMCMx/port.dox index 5cef7ea98..3b60e6fc6 100644 --- 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 * - Init. 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 */ /** diff --git a/os/ports/GCC/AVR/port.dox b/os/ports/GCC/AVR/port.dox index 512d7f2e5..d5bf64f99 100644 --- 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 * ./ports/AVR/chcore.h. * . - * @ingroup ports + * @ingroup gcc */ /** diff --git a/os/ports/GCC/MSP430/port.dox b/os/ports/GCC/MSP430/port.dox index c68ac48bc..721540baf 100644 --- 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 */ /** diff --git a/os/ports/GCC/PPC/port.dox b/os/ports/GCC/PPC/port.dox index e020387f9..6295641b6 100644 --- 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 */ /** diff --git a/os/ports/RC/STM8/port.dox b/os/ports/RC/STM8/port.dox index 3c2e812a8..66f88c427 100644 --- 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 */ /** diff --git a/os/ports/ports.dox b/os/ports/ports.dox index 393d787be..e47c390fe 100644 --- 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 + */ -- cgit v1.2.3