Documentation related changes.

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

9 files changed, 72 insertions, 27 deletions

diff --git a/os/hal/platforms/LPC11xx/hal_lld.c b/os/hal/platforms/LPC11xx/hal_lld.c
index efaf4c98f..29ff0a9ec 100644
--- a/os/hal/platforms/LPC11xx/hal_lld.c
+++ b/os/hal/platforms/LPC11xx/hal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC11xx/hal_lld.c

  * @brief   LPC11xx HAL subsystem low level driver source.

  *

- * @addtogroup LPC11xx_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/hal_lld.h b/os/hal/platforms/LPC11xx/hal_lld.h
index 35e8db6a6..718e9457a 100644
--- a/os/hal/platforms/LPC11xx/hal_lld.h
+++ b/os/hal/platforms/LPC11xx/hal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC11xx/hal_lld.h

  * @brief   HAL subsystem low level driver header template.

  *

- * @addtogroup LPC11xx_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/pal_lld.c b/os/hal/platforms/LPC11xx/pal_lld.c
index 769dcba17..f48ae8529 100644
--- a/os/hal/platforms/LPC11xx/pal_lld.c
+++ b/os/hal/platforms/LPC11xx/pal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC11xx/pal_lld.c

  * @brief   LPC11xx GPIO low level driver code.

  *

- * @addtogroup LPC11xx_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/pal_lld.h b/os/hal/platforms/LPC11xx/pal_lld.h
index 42e2ac247..83605cb65 100644
--- a/os/hal/platforms/LPC11xx/pal_lld.h
+++ b/os/hal/platforms/LPC11xx/pal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC11xx/pal_lld.h

  * @brief   LPC11xx GPIO low level driver header.

  *

- * @addtogroup LPC11xx_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/platform.dox b/os/hal/platforms/LPC11xx/platform.dox
index 89a10f6c0..82d0b0a6e 100644
--- a/os/hal/platforms/LPC11xx/platform.dox
+++ b/os/hal/platforms/LPC11xx/platform.dox
@@ -19,34 +19,47 @@
 

 /**

  * @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.

- * .

+ * @details This section describes all the supported drivers on the LPC11xx

+ *          platform and the implementation details of the single drivers.

+ *

  * @ingroup platforms

  */

 

 /**

- * @defgroup LPC11xx_HAL LPC11xx HAL Support

- * @brief HAL support.

+ * @defgroup LPC11xx_HAL LPC11xx Initialization Support

+ * @details The LPC11xx HAL support is responsible for system initialization.

  *

+ * @section lpc11xx_hal_1 Supported HW resources

+ * - SYSCON.

+ * - Flash.

+ * .

+ * @section lpc11xx_hal_2 LPC11xx HAL driver implementation features

+ * - Clock tree initialization.

+ * - Clock source selection.

+ * - Flash controller initialization.

+ * - SYSTICK initialization based on current clock and kernel required rate.

+ * .

  * @ingroup LPC11xx

  */

 

 /**

- * @defgroup LPC11xx_PAL LPC11xx I/O Ports Support

- * @brief I/O Ports peripherals support.

- * @details This module supports the LPC11xx GPIO controller. The controller

- * supports the following features (see @ref PAL):

+ * @defgroup LPC11xx_PAL LPC11xx GPIO Support

+ * @details The LPC11xx PAL driver uses the GPIO peripherals.

+ *

+ * @section lpc11xx_pal_1 Supported HW resources

+ * - GPIO0.

+ * - GPIO1.

+ * - GPIO2.

+ * - GPIO3.

+ * .

+ * @section lpc11xx_pal_2 LPC11xx PAL driver implementation features

  * - 12 bits wide ports.

  * - Atomic set/reset functions.

  * - Atomic set+reset function (atomic bus operations).

  * - Output latched regardless of the pad setting.

  * - Direct read of input pads regardless of the pad setting.

  * .

- * <h2>Supported Setup Modes</h2>

+ * @section lpc11xx_pal_3 Supported PAL setup modes

  * - @p PAL_MODE_RESET.

  * - @p PAL_MODE_UNCONNECTED.

  * - @p PAL_MODE_INPUT.

@@ -54,11 +67,11 @@
  * .

  * Any attempt to setup an invalid mode is ignored.

  *

- * <h2>Suboptimal Behavior</h2>

+ * @section lpc11xx_pal_4 Suboptimal behavior

  * Some GPIO features are less than optimal:

  * - Pad/port toggling operations are not atomic.

  * - Pull-up and Pull-down resistors cannot be programmed through the PAL

- *   driver and must be programmed separately.

+ *   driver and must be programmed separately using the IOCON peripheral.

  * - Reading of the output latch for pads programmed as input is not possible,

  *   the input pin value is returned instead.

  * .

@@ -66,10 +79,42 @@
  */

 

 /**

- * @defgroup LPC11xx_SERIAL LPC11xx UART Support

- * @brief UART peripherals support.

- * @details The serial driver supports the LPC11xx UART taking advantage of

- *          its deep hardware buffers.

+ * @defgroup LPC11xx_SPI LPC11xx SPI Support

+ * @details The SPI driver supports the LPC11xx SSP peripherals in an interrupt

+ *          driven implementation.

+ * @note    Being the SPI a fast peripheral, much care must be taken to

+ *          not saturate the CPU bandwidth with an excessive IRQ rate. The

+ *          maximum transfer bit rate is likely limited by the IRQ

+ *          handling.

  *

+ * @section lpc11xx_spi_1 Supported HW resources

+ * - SSP0.

+ * - SSP1 (where present).

+ * .

+ * @section lpc11xx_spi_2 LPC11xx SPI driver implementation features

+ * - Clock stop for reduced power usage when the driver is in stop state.

+ * - Each SSP can be independently enabled and programmed. Unused

+ *   peripherals are left in low power mode.

+ * - Programmable interrupt priority levels for each SSP.

+ * .

+ * @ingroup LPC11xx

+ */

+

+/**

+ * @defgroup LPC11xx_SERIAL LPC11xx UART Support (buffered)

+ * @details The LPC11xx Serial driver uses the UART peripheral in a

+ *          buffered, interrupt driven, implementation. The serial driver

+ *          also takes advantage of the LPC11xx UARTs deep hardware buffers.

+ *

+ * @section lpc11xx_serial_1 Supported HW resources

+ * The serial driver can support any of the following hardware resources:

+ * - UART.

+ * .

+ * @section lpc11xx_serial_2 LPC11xx Serial driver implementation features

+ * - Clock stop for reduced power usage when the driver is in stop state.

+ * - Fully interrupt driven.

+ * - Programmable priority level.

+ * - Takes advantage of the input and output FIFOs.

+ * .

  * @ingroup LPC11xx

  */

diff --git a/os/hal/platforms/LPC11xx/serial_lld.c b/os/hal/platforms/LPC11xx/serial_lld.c
index 42bc5ebb3..563c5bcf7 100644
--- a/os/hal/platforms/LPC11xx/serial_lld.c
+++ b/os/hal/platforms/LPC11xx/serial_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC11xx/serial_lld.c

  * @brief   LPC11xx low level serial driver code.

  *

- * @addtogroup LPC11xx_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/serial_lld.h b/os/hal/platforms/LPC11xx/serial_lld.h
index cd2acdbf4..aae1e423c 100644
--- a/os/hal/platforms/LPC11xx/serial_lld.h
+++ b/os/hal/platforms/LPC11xx/serial_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC11xx/serial_lld.h

  * @brief   LPC11xx low level serial driver header.

  *

- * @addtogroup LPC11xx_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/spi_lld.c b/os/hal/platforms/LPC11xx/spi_lld.c
index 884cdab75..becf691a3 100644
--- a/os/hal/platforms/LPC11xx/spi_lld.c
+++ b/os/hal/platforms/LPC11xx/spi_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC11xx/spi_lld.c

  * @brief   LPC11xx low level SPI driver code.

  *

- * @addtogroup LPC11xx_SPI

+ * @addtogroup SPI

  * @{

  */

 

diff --git a/os/hal/platforms/LPC11xx/spi_lld.h b/os/hal/platforms/LPC11xx/spi_lld.h
index 580787bb1..021099097 100644
--- a/os/hal/platforms/LPC11xx/spi_lld.h
+++ b/os/hal/platforms/LPC11xx/spi_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC11xx/spi_lld.h

  * @brief   LPC11xx low level SPI driver header.

  *

- * @addtogroup LPC11xx_SPI

+ * @addtogroup SPI

  * @{

  */