Documentation related changes.

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

9 files changed, 70 insertions, 39 deletions

diff --git a/os/hal/platforms/LPC214x/hal_lld.c b/os/hal/platforms/LPC214x/hal_lld.c
index 352f5c736..beee5f40b 100644
--- a/os/hal/platforms/LPC214x/hal_lld.c
+++ b/os/hal/platforms/LPC214x/hal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC214x/hal_lld.c

  * @brief   LPC214x HAL subsystem low level driver source.

  *

- * @addtogroup LPC214x_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/hal_lld.h b/os/hal/platforms/LPC214x/hal_lld.h
index 4b88f13fc..54d91b881 100644
--- a/os/hal/platforms/LPC214x/hal_lld.h
+++ b/os/hal/platforms/LPC214x/hal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC214x/hal_lld.h

  * @brief   LPC214x HAL subsystem low level driver header.

  *

- * @addtogroup LPC214x_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/pal_lld.c b/os/hal/platforms/LPC214x/pal_lld.c
index 9e145ed48..f860bfb9f 100644
--- a/os/hal/platforms/LPC214x/pal_lld.c
+++ b/os/hal/platforms/LPC214x/pal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC214x/pal_lld.c

  * @brief   LPC214x FIO low level driver code.

  *

- * @addtogroup LPC214x_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/pal_lld.h b/os/hal/platforms/LPC214x/pal_lld.h
index f9e41b358..4137f19f9 100644
--- a/os/hal/platforms/LPC214x/pal_lld.h
+++ b/os/hal/platforms/LPC214x/pal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC214x/pal_lld.h

  * @brief   LPC214x FIO low level driver header.

  *

- * @addtogroup LPC214x_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/platform.dox b/os/hal/platforms/LPC214x/platform.dox
index 48df22f36..10cac7bf1 100644
--- a/os/hal/platforms/LPC214x/platform.dox
+++ b/os/hal/platforms/LPC214x/platform.dox
@@ -19,44 +19,44 @@
 

 /**

  * @defgroup LPC214x LPC214x Drivers

- * @brief LPC214x specific support.

- * @details The LPC214x support includes:

- * - VIC support code.

- * - I/O ports driver.

- * - Buffered, interrupt driven, serial driver.

- * - SPI driver.

- * - A demo supporting the kernel test suite.

- * - A C++ demo supporting the kernel test suite.

- * - A demo integrating ChibiOS/RT with FatFS.

- * .

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

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

+ *

  * @ingroup platforms

  */

 

 /**

- * @defgroup LPC214x_VIC VIC Support

- * @brief VIC peripheral support.

+ * @defgroup LPC214x_HAL LPC214x Initialization Support

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

  *

+ * @section lpc214x_hal_1 Supported HW resources

+ * - PLL0.

+ * - MAM.

+ * - VPBDIV.

+ * .

+ * @section lpc214x_hal_2 LPC214x HAL driver implementation features

+ * - Clock tree initialization.

+ * - Clock source selection.

+ * - MAM initialization.

+ * .

  * @ingroup LPC214x

  */

 

 /**

- * @defgroup LPC214x_HAL LPC214x HAL Support

- * @brief HAL support.

+ * @defgroup LPC214x_PAL LPC214x FIO Support

+ * @details The LPC214x PAL driver uses the FIO peripherals.

  *

- * @ingroup LPC214x

- */

-

-/**

- * @defgroup LPC214x_PAL LPC214x I/O Ports Support

- * @brief I/O Ports peripherals support.

- * @details This module supports the LPC214x FIO controller. The controller

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

+ * @section lpc214x_pal_1 Supported HW resources

+ * - FIO0.

+ * - FIO1.

+ * .

+ * @section lpc214x_pal_2 LPC214x PAL driver implementation features

  * - 32 bits wide ports.

  * - Atomic set/reset functions.

  * - Output latched regardless of the pad setting.

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

  * .

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

+ * @section lpc214x_pal_3 Supported PAL setup modes

  * - @p PAL_MODE_RESET.

  * - @p PAL_MODE_UNCONNECTED.

  * - @p PAL_MODE_INPUT.

@@ -65,7 +65,8 @@
  * .

  * Any attempt to setup an invalid mode is ignored.

  *

- * <h2>Suboptimal Behavior</h2>

+ * @section lpc214x_pal_4 Suboptimal behavior

+ * Some FIO features are less than optimal:

  * - Pad/port toggling operations are not atomic.

  * - Pad/group mode setup is not atomic.

  * .

@@ -73,18 +74,48 @@
  */

 

 /**

- * @defgroup LPC214x_SERIAL LPC214x UART Support

- * @brief UART peripherals support.

- * @details The serial driver supports the LPC214x UART peripherals.

+ * @defgroup LPC214x_SPI LPC214x SPI Support

+ * @details The SPI driver supports the LPC214x SSP peripheral 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 lpc214x_spi_1 Supported HW resources

+ * - SSP (SPI0).

+ * .

+ * @section lpc214x_spi_2 LPC214x SPI driver implementation features

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

+ * - Programmable interrupt priority level.

+ * .

+ * @ingroup LPC214x

+ */

+

+/**

+ * @defgroup LPC214x_SERIAL LPC214x UART Support (buffered)

+ * @details The LPC214x Serial driver uses the UART peripherals in a

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

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

  *

+ * @section lpc214x_serial_1 Supported HW resources

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

+ * - UART0.

+ * - UART1.

+ * .

+ * @section lpc214x_serial_2 LPC214x Serial driver implementation features

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

+ * - Fully interrupt driven.

+ * - Programmable interrupt priority levels for each UART.

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

+ * .

  * @ingroup LPC214x

  */

 

 /**

- * @defgroup LPC214x_SPI LPC214x SPI Support

- * @brief SSP peripheral support.

- * @details The SPI driver supports the LPC214x SSP, the driver works in

- * polling mode.

+ * @defgroup LPC214x_VIC LPC214x VIC Support

+ * @details This VIC helper driver is used by the other drivers in order to

+ *          access the shared VIC resources in a consistent way.

  *

  * @ingroup LPC214x

  */

diff --git a/os/hal/platforms/LPC214x/serial_lld.c b/os/hal/platforms/LPC214x/serial_lld.c
index cec8f5c7a..4390941c1 100644
--- a/os/hal/platforms/LPC214x/serial_lld.c
+++ b/os/hal/platforms/LPC214x/serial_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC214x/serial_lld.c

  * @brief   LPC214x low level serial driver code.

  *

- * @addtogroup LPC214x_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/serial_lld.h b/os/hal/platforms/LPC214x/serial_lld.h
index 7b11cad38..b41845624 100644
--- a/os/hal/platforms/LPC214x/serial_lld.h
+++ b/os/hal/platforms/LPC214x/serial_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC214x/serial_lld.h

  * @brief   LPC214x low level serial driver header.

  *

- * @addtogroup LPC214x_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/spi_lld.c b/os/hal/platforms/LPC214x/spi_lld.c
index 69d0b6a44..7c3287298 100644
--- a/os/hal/platforms/LPC214x/spi_lld.c
+++ b/os/hal/platforms/LPC214x/spi_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC214x/spi_lld.c

  * @brief   LPC214x low level SPI driver code.

  *

- * @addtogroup LPC214x_SPI

+ * @addtogroup SPI

  * @{

  */

 

diff --git a/os/hal/platforms/LPC214x/spi_lld.h b/os/hal/platforms/LPC214x/spi_lld.h
index 57d02d4de..eafa23f88 100644
--- a/os/hal/platforms/LPC214x/spi_lld.h
+++ b/os/hal/platforms/LPC214x/spi_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC214x/spi_lld.h

  * @brief   LPC214x low level SPI driver header.

  *

- * @addtogroup LPC214x_SPI

+ * @addtogroup SPI

  * @{

  */