Documentation related changes.

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

7 files changed, 50 insertions, 21 deletions

diff --git a/os/hal/platforms/MSP430/hal_lld.c b/os/hal/platforms/MSP430/hal_lld.c
index 6cbc0c2f1..dd36e5ae1 100644
--- a/os/hal/platforms/MSP430/hal_lld.c
+++ b/os/hal/platforms/MSP430/hal_lld.c
@@ -21,7 +21,7 @@
  * @file    MSP430/hal_lld.c

  * @brief   MSP430 HAL subsystem low level driver source.

  *

- * @addtogroup MSP430_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/MSP430/hal_lld.h b/os/hal/platforms/MSP430/hal_lld.h
index 681392645..8f9ae59af 100644
--- a/os/hal/platforms/MSP430/hal_lld.h
+++ b/os/hal/platforms/MSP430/hal_lld.h
@@ -21,7 +21,7 @@
  * @file    MSP430/hal_lld.h

  * @brief   MSP430 HAL subsystem low level driver header.

  *

- * @addtogroup MSP430_HAL

+ * @addtogroup HAL

  * @{

  */

 

diff --git a/os/hal/platforms/MSP430/pal_lld.c b/os/hal/platforms/MSP430/pal_lld.c
index 419b1ca82..767692efa 100644
--- a/os/hal/platforms/MSP430/pal_lld.c
+++ b/os/hal/platforms/MSP430/pal_lld.c
@@ -21,7 +21,7 @@
  * @file    MSP430/pal_lld.c

  * @brief   MSP430 Digital I/O low level driver code.

  *

- * @addtogroup MSP430_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/MSP430/pal_lld.h b/os/hal/platforms/MSP430/pal_lld.h
index e9b67bf18..954f6b5c2 100644
--- a/os/hal/platforms/MSP430/pal_lld.h
+++ b/os/hal/platforms/MSP430/pal_lld.h
@@ -21,7 +21,7 @@
  * @file    MSP430/pal_lld.h

  * @brief   MSP430 Digital I/O low level driver header.

  *

- * @addtogroup MSP430_PAL

+ * @addtogroup PAL

  * @{

  */

 

diff --git a/os/hal/platforms/MSP430/platform.dox b/os/hal/platforms/MSP430/platform.dox
index 4bcb197ba..ec6bbd535 100644
--- a/os/hal/platforms/MSP430/platform.dox
+++ b/os/hal/platforms/MSP430/platform.dox
@@ -19,29 +19,49 @@
 

 /**

  * @defgroup MSP430_DRIVERS MSP430 Drivers

- * @brief MSP430 specific support.

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

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

  *

  * @ingroup platforms

  */

 

 /**

- * @defgroup MSP430_HAL MSP430 HAL Support

- * @brief HAL support.

+ * @defgroup MSP430_HAL MSP430 Initialization Support

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

  *

+ * @section msp430_hal_1 Supported HW resources

+ * - DCOCTL.

+ * - BCSCTL1.

+ * - BCSCTL2.

+ * .

+ * @section msp430_hal_2 MSP430 HAL driver implementation features

+ * - Clock source selection.

+ * .

  * @ingroup MSP430_DRIVERS

  */

 

 /**

- * @defgroup MSP430_PAL MSP430 I/O Ports Support

- * @brief I/O Ports peripherals support.

- * @details This module supports the MSP430 Digital I/O controller. The

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

+ * @defgroup MSP430_PAL MSP430 PORT Support

+ * @details The MSP430 PAL driver uses the PORT peripherals.

+ *

+ * @section msp430_pal_1 Supported HW resources

+ * - PORT1 (where present).

+ * - PORT2 (where present).

+ * - PORT3 (where present).

+ * - PORT4 (where present).

+ * - PORT5 (where present).

+ * - PORT6 (where present).

+ * .

+ * @section msp430_pal_2 MSP430 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 MSP430 instruction set.

  * - Output latched regardless of the pad setting.

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

  * .

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

+ * @section msp430_pal_3 Supported PAL setup modes

+ * The MSP430 PAL driver supports the following I/O modes:

  * - @p PAL_MODE_RESET.

  * - @p PAL_MODE_UNCONNECTED.

  * - @p PAL_MODE_INPUT.

@@ -49,19 +69,28 @@
  * .

  * Any attempt to setup an invalid mode is ignored.

  *

- * <h2>Suboptimal Behavior</h2>

- * Some MSP430 I/O ports features are less than optimal:

- * - Bus/group writing is not atomic.

+ * @section msp430_pal_4 Suboptimal behavior

+ * The MSP430 PORT is less than optimal in several areas, the limitations

+ * should be taken in account while using the PAL driver:

+ * - Bus/group writes is not atomic.

  * - Pad/group mode setup is not atomic.

  * .

  * @ingroup MSP430_DRIVERS

  */

 

 /**

- * @defgroup MSP430_SERIAL MSP430 USART Support

- * @brief USART support.

- * @details The serial driver supports both the MSP430 USARTs in asynchronous

- * mode.

+ * @defgroup MSP430_SERIAL MSP430 USART Support (buffered)

+ * @details The MSP430 Serial driver uses the USART peripherals in a

+ *          buffered, interrupt driven, implementation.

  *

+ * @section msp430_serial_1 Supported HW resources

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

+ * - USART0.

+ * - USART1.

+ * .

+ * @section msp430_serial_2 MSP430 Serial driver implementation features

+ * - Each USART can be independently enabled and programmed.

+ * - Fully interrupt driven.

+ * .

  * @ingroup MSP430_DRIVERS

  */

diff --git a/os/hal/platforms/MSP430/serial_lld.c b/os/hal/platforms/MSP430/serial_lld.c
index 25d3d06cd..4b5dcf1ee 100644
--- a/os/hal/platforms/MSP430/serial_lld.c
+++ b/os/hal/platforms/MSP430/serial_lld.c
@@ -21,7 +21,7 @@
  * @file    MSP430/serial_lld.c

  * @brief   MSP430 low level serial driver code.

  *

- * @addtogroup MSP430_SERIAL

+ * @addtogroup SERIAL

  * @{

  */

 

diff --git a/os/hal/platforms/MSP430/serial_lld.h b/os/hal/platforms/MSP430/serial_lld.h
index b81333133..c6205f64b 100644
--- a/os/hal/platforms/MSP430/serial_lld.h
+++ b/os/hal/platforms/MSP430/serial_lld.h
@@ -21,7 +21,7 @@
  * @file    MSP430/serial_lld.h

  * @brief   MSP430 low level serial driver header.

  *

- * @addtogroup MSP430_SERIAL

+ * @addtogroup SERIAL

  * @{

  */