Documentation related changes.

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

7 files changed, 71 insertions, 26 deletions

diff --git a/os/hal/platforms/LPC13xx/hal_lld.c b/os/hal/platforms/LPC13xx/hal_lld.c
index 37421f752..33d5f2f11 100644
--- a/os/hal/platforms/LPC13xx/hal_lld.c
+++ b/os/hal/platforms/LPC13xx/hal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC13xx/hal_lld.c

  * @brief   LPC13xx HAL subsystem low level driver source.

  *

- * @addtogroup LPC13xx_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC13xx/hal_lld.h b/os/hal/platforms/LPC13xx/hal_lld.h
index abe15ada5..63f1c6110 100644
--- a/os/hal/platforms/LPC13xx/hal_lld.h
+++ b/os/hal/platforms/LPC13xx/hal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC13xx/hal_lld.h

  * @brief   HAL subsystem low level driver header template.

  *

- * @addtogroup LPC13xx_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC13xx/pal_lld.c b/os/hal/platforms/LPC13xx/pal_lld.c
index f1e766c4d..d0f9ca3e5 100644
--- a/os/hal/platforms/LPC13xx/pal_lld.c
+++ b/os/hal/platforms/LPC13xx/pal_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC13xx/pal_lld.c

  * @brief   LPC13xx GPIO low level driver code.

  *

- * @addtogroup LPC13xx_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC13xx/pal_lld.h b/os/hal/platforms/LPC13xx/pal_lld.h
index aefaa3be2..eec4a5596 100644
--- a/os/hal/platforms/LPC13xx/pal_lld.h
+++ b/os/hal/platforms/LPC13xx/pal_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC13xx/pal_lld.h

  * @brief   LPC13xx GPIO low level driver header.

  *

- * @addtogroup LPC13xx_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC13xx/platform.dox b/os/hal/platforms/LPC13xx/platform.dox
index 4baeeedaa..9f22a0252 100644
--- a/os/hal/platforms/LPC13xx/platform.dox
+++ b/os/hal/platforms/LPC13xx/platform.dox
@@ -19,34 +19,47 @@
 

 /**

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

- * .

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

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

+ *

  * @ingroup platforms

  */

 

 /**

- * @defgroup LPC13xx_HAL LPC13xx HAL Support

- * @brief HAL support.

+ * @defgroup LPC13xx_HAL LPC13xx Initialization Support

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

  *

+ * @section lpc13xx_hal_1 Supported HW resources

+ * - SYSCON.

+ * - Flash.

+ * .

+ * @section lpc13xx_hal_2 LPC13xx HAL driver implementation features

+ * - Clock tree initialization.

+ * - Clock source selection.

+ * - Flash controller initialization.

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

+ * .

  * @ingroup LPC13xx

  */

 

 /**

- * @defgroup LPC13xx_PAL LPC13xx I/O Ports Support

- * @brief I/O Ports peripherals support.

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

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

+ * @defgroup LPC13xx_PAL LPC13xx GPIO Support

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

+ *

+ * @section lpc13xx_pal_1 Supported HW resources

+ * - GPIO0.

+ * - GPIO1.

+ * - GPIO2.

+ * - GPIO3.

+ * .

+ * @section lpc13xx_pal_2 LPC13xx 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 lpc13xx_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 lpc13xx_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 LPC13xx_SERIAL LPC13xx UART Support

- * @brief UART peripherals support.

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

- *          its deep hardware buffers.

+ * @defgroup LPC13xx_SPI LPC13xx SPI Support

+ * @details The SPI driver supports the LPC13xx 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 lpc13xx_spi_1 Supported HW resources

+ * - SSP0.

+ * - SSP1 (where present).

+ * .

+ * @section lpc13xx_spi_2 LPC13xx 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 LPC13xx

+ */

+

+/**

+ * @defgroup LPC13xx_SERIAL LPC13xx UART Support (buffered)

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

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

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

+ *

+ * @section lpc13xx_serial_1 Supported HW resources

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

+ * - UART.

+ * .

+ * @section lpc13xx_serial_2 LPC13xx 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 LPC13xx

  */

diff --git a/os/hal/platforms/LPC13xx/serial_lld.c b/os/hal/platforms/LPC13xx/serial_lld.c
index 12da197e8..6e186efc5 100644
--- a/os/hal/platforms/LPC13xx/serial_lld.c
+++ b/os/hal/platforms/LPC13xx/serial_lld.c
@@ -21,7 +21,7 @@
  * @file    LPC13xx/serial_lld.c

  * @brief   LPC13xx low level serial driver code.

  *

- * @addtogroup LPC13xx_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/LPC13xx/serial_lld.h b/os/hal/platforms/LPC13xx/serial_lld.h
index 54207d39d..4a4a5fa81 100644
--- a/os/hal/platforms/LPC13xx/serial_lld.h
+++ b/os/hal/platforms/LPC13xx/serial_lld.h
@@ -21,7 +21,7 @@
  * @file    LPC13xx/serial_lld.h

  * @brief   LPC13xx low level serial driver header.

  *

- * @addtogroup LPC13xx_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

@@ -109,7 +109,7 @@
  * @brief   UART0 interrupt priority level setting.

  */

 #if !defined(LPC13xx_UART0_PRIORITY) || defined(__DOXYGEN__)

-#define LPC13xx_UART0_PRIORITY      3

+#define LPC13xx_UART0_PRIORITY      6

 #endif

 

 /*===========================================================================*/