From 487a81e29725d598cf0ccdd8c9cd59c5c03634d9 Mon Sep 17 00:00:00 2001 From: gdisirio Date: Tue, 26 Oct 2010 17:39:29 +0000 Subject: Documentation related changes. git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@2293 35acf78f-673a-0410-8e92-d51de3d6d3f4 --- os/hal/platforms/STM8/hal_lld.c | 2 +- os/hal/platforms/STM8/hal_lld.h | 2 +- os/hal/platforms/STM8/pal_lld.c | 2 +- os/hal/platforms/STM8/pal_lld.h | 2 +- os/hal/platforms/STM8/platform.dox | 65 ++++++++++++++++++++++++++++++-------- os/hal/platforms/STM8/serial_lld.c | 2 +- os/hal/platforms/STM8/serial_lld.h | 2 +- 7 files changed, 57 insertions(+), 20 deletions(-) (limited to 'os/hal/platforms/STM8') diff --git a/os/hal/platforms/STM8/hal_lld.c b/os/hal/platforms/STM8/hal_lld.c index b67513f5b..edd36a6f3 100644 --- a/os/hal/platforms/STM8/hal_lld.c +++ b/os/hal/platforms/STM8/hal_lld.c @@ -21,7 +21,7 @@ * @file STM8/hal_lld.c * @brief STM8 HAL subsystem low level driver source. * - * @addtogroup STM8_HAL + * @addtogroup HAL * @{ */ diff --git a/os/hal/platforms/STM8/hal_lld.h b/os/hal/platforms/STM8/hal_lld.h index 786843ffc..a7bcbe89a 100644 --- a/os/hal/platforms/STM8/hal_lld.h +++ b/os/hal/platforms/STM8/hal_lld.h @@ -21,7 +21,7 @@ * @file STM8/hal_lld.h * @brief STM8 HAL subsystem low level driver source. * - * @addtogroup STM8_HAL + * @addtogroup HAL * @{ */ diff --git a/os/hal/platforms/STM8/pal_lld.c b/os/hal/platforms/STM8/pal_lld.c index 14b5fe8c7..56bae5cc3 100644 --- a/os/hal/platforms/STM8/pal_lld.c +++ b/os/hal/platforms/STM8/pal_lld.c @@ -21,7 +21,7 @@ * @file STM8/pal_lld.c * @brief STM8 GPIO low level driver code. * - * @addtogroup STM8_PAL + * @addtogroup PAL * @{ */ diff --git a/os/hal/platforms/STM8/pal_lld.h b/os/hal/platforms/STM8/pal_lld.h index ae992594f..8fb511cf1 100644 --- a/os/hal/platforms/STM8/pal_lld.h +++ b/os/hal/platforms/STM8/pal_lld.h @@ -21,7 +21,7 @@ * @file STM8/pal_lld.h * @brief STM8 GPIO low level driver header. * - * @addtogroup STM8_PAL + * @addtogroup PAL * @{ */ diff --git a/os/hal/platforms/STM8/platform.dox b/os/hal/platforms/STM8/platform.dox index 20a2637af..2b6e34f59 100644 --- a/os/hal/platforms/STM8/platform.dox +++ b/os/hal/platforms/STM8/platform.dox @@ -18,30 +18,54 @@ */ /** - * @defgroup STM8_DRIVERS STM8 Drivers - * @brief STM8 specific support. + * @defgroup STM8_DRIVERS STM8x Drivers + * @details This section describes all the supported drivers on the STM8S and + * STM8A platforms and the implementation details of the single + * drivers. * * @ingroup platforms */ /** - * @defgroup STM8_HAL STM8 HAL Support - * @brief HAL support. + * @defgroup STM8_HAL STM8 Initialization Support + * @details The STM8 HAL support is responsible for system initialization. * + * @section stm8_hal_1 Supported HW resources + * - CLK. + * . + * @section stm8_hal_2 STM8 HAL driver implementation features + * - Clock tree initialization. + * - Clock source selection. + * . * @ingroup STM8_DRIVERS */ /** - * @defgroup STM8_PAL STM8 I/O Ports Support - * @brief I/O Ports peripherals support. - * @details This module supports the STM8 GPIO controller. The controller - * supports the following features (see @ref PAL): + * @defgroup STM8_PAL STM8 GPIO Support + * @details The STM8 PAL driver uses the GPIO peripherals. + * + * @section stm8_pal_1 Supported HW resources + * - AFIO. + * - GPIOA. + * - GPIOB. + * - GPIOC. + * - GPIOD. + * - GPIOE. + * - GPIOF. + * - GPIOG (where present). + * - GPIOH (where present). + * - GPIOI (where present). + * . + * @section stm8_pal_2 STM8 PAL driver implementation features + * The PAL driver implementation fully supports the following hardware + * capabilities: * - 8 bits wide ports. * - Atomic set/reset/toggle functions because special STM8 instruction set. * - Output latched regardless of the pad setting. * - Direct read of input pads regardless of the pad setting. * . - *

Supported Setup Modes

+ * @section stm8_pal_3 Supported PAL setup modes + * The STM8 PAL driver supports the following I/O modes: * - @p PAL_MODE_RESET. * - @p PAL_MODE_UNCONNECTED. * - @p PAL_MODE_INPUT. @@ -51,8 +75,9 @@ * . * Any attempt to setup an invalid mode is ignored. * - *

Suboptimal Behavior

- * Some STM8 I/O ports features are less than optimal: + * @section stm8_pal_4 Suboptimal behavior + * The STM8 GPIO is less than optimal in several areas, the limitations + * should be taken in account while using the PAL driver: * - Bus/group writing is not atomic. * - Pad/group mode setup is not atomic. * . @@ -60,9 +85,21 @@ */ /** - * @defgroup STM8_SERIAL STM8 UART Support - * @brief USART support. - * @details The serial driver supports the STM8 USARTs in asynchronous mode. + * @defgroup STM8_SERIAL STM8 UART Support (buffered) + * @details The STM8 Serial driver uses the UART peripherals in a + * buffered, interrupt driven, implementation. * + * @section stm8_serial_1 Supported HW resources + * The serial driver can support any of the following hardware resources: + * - UART1. + * - UART2 (where present). + * - UART3 (where present). + * . + * @section stm8_serial_2 STM8 Serial driver implementation features + * - Clock stop for reduced power usage when the driver is in stop state. + * - Each UART can be independently enabled and programmed. Unused + * peripherals are left in low power mode. + * - Fully interrupt driven. + * . * @ingroup STM8_DRIVERS */ diff --git a/os/hal/platforms/STM8/serial_lld.c b/os/hal/platforms/STM8/serial_lld.c index b60c20130..eeda867f9 100644 --- a/os/hal/platforms/STM8/serial_lld.c +++ b/os/hal/platforms/STM8/serial_lld.c @@ -21,7 +21,7 @@ * @file STM8/serial_lld.c * @brief STM8 low level serial driver code. * - * @addtogroup STM8_SERIAL + * @addtogroup SERIAL * @{ */ diff --git a/os/hal/platforms/STM8/serial_lld.h b/os/hal/platforms/STM8/serial_lld.h index f0bea84f7..ee7848870 100644 --- a/os/hal/platforms/STM8/serial_lld.h +++ b/os/hal/platforms/STM8/serial_lld.h @@ -21,7 +21,7 @@ * @file STM8/serial_lld.h * @brief STM8 low level serial driver header. * - * @addtogroup STM8_SERIAL + * @addtogroup SERIAL * @{ */ -- cgit v1.2.3