Documentation improvements, fixed a small error in the STM32 serial driver.

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

5 files changed, 53 insertions, 15 deletions

diff --git a/os/hal/platforms/LPC13xx/hal_lld.c b/os/hal/platforms/LPC13xx/hal_lld.c
index a3415ee90..37421f752 100644
--- a/os/hal/platforms/LPC13xx/hal_lld.c
+++ b/os/hal/platforms/LPC13xx/hal_lld.c
@@ -42,7 +42,7 @@
 /*===========================================================================*/

 

 /**

- * @brief PAL setup.

+ * @brief   PAL setup.

  * @details Digital I/O ports static configuration as defined in @p board.h.

  */

 const PALConfig pal_default_config = {

@@ -66,6 +66,8 @@ const PALConfig pal_default_config = {
 

 /**

  * @brief   Low level HAL driver initialization.

+ *

+ * @notapi

  */

 void hal_lld_init(void) {

 

@@ -81,6 +83,9 @@ void hal_lld_init(void) {
 /**

  * @brief   LPC13xx clocks and PLL initialization.

  * @note    All the involved constants come from the file @p board.h.

+ * @note    This function must be invoked only after the system reset.

+ *

+ * @special

  */

 void LPC13xx_clock_init(void) {

   unsigned i;

diff --git a/os/hal/platforms/LPC13xx/pal_lld.c b/os/hal/platforms/LPC13xx/pal_lld.c
index f63650c0f..f1e766c4d 100644
--- a/os/hal/platforms/LPC13xx/pal_lld.c
+++ b/os/hal/platforms/LPC13xx/pal_lld.c
@@ -50,10 +50,12 @@
 /* Driver exported functions.                                                */

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

 /**

- * @brief LPC13xx I/O ports configuration.

+ * @brief   LPC13xx I/O ports configuration.

  * @details GPIO unit registers initialization.

  *

  * @param[in] config the LPC13xx ports configuration

+ *

+ * @notapi

  */

 void _pal_lld_init(const PALConfig *config) {

 

@@ -68,20 +70,19 @@ void _pal_lld_init(const PALConfig *config) {
 }

 

 /**

- * @brief Pads mode setup.

+ * @brief   Pads mode setup.

  * @details This function programs a pads group belonging to the same port

  *          with the specified mode.

+ * @note    @p PAL_MODE_UNCONNECTED is implemented as push pull output with

+ *          high state.

+ * @note    This function does not alter the @p PINSELx registers. Alternate

+ *          functions setup must be handled by device-specific code.

  *

- * @param[in] port the port identifier

- * @param[in] mask the group mask

- * @param[in] mode the mode

+ * @param[in] port      the port identifier

+ * @param[in] mask      the group mask

+ * @param[in] mode      the mode

  *

- * @note This function is not meant to be invoked directly by the application

- *       code.

- * @note @p PAL_MODE_UNCONNECTED is implemented as push pull output with high

- *       state.

- * @note This function does not alter the @p PINSELx registers. Alternate

- *       functions setup must be handled by device-specific code.

+ * @notapi

  */

 void _pal_lld_setgroupmode(ioportid_t port,

                            ioportmask_t mask,

diff --git a/os/hal/platforms/LPC13xx/pal_lld.h b/os/hal/platforms/LPC13xx/pal_lld.h
index 4e145be80..aefaa3be2 100644
--- a/os/hal/platforms/LPC13xx/pal_lld.h
+++ b/os/hal/platforms/LPC13xx/pal_lld.h
@@ -44,7 +44,7 @@
 /*===========================================================================*/

 

 /**

- * @brief GPIO port setup info.

+ * @brief   GPIO port setup info.

  */

 typedef struct {

   /** Initial value for FIO_PIN register.*/

@@ -134,6 +134,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  * @brief   Low level PAL subsystem initialization.

  *

  * @param[in] config    architecture-dependent ports configuration

+ *

+ * @notapi

  */

 #define pal_lld_init(config) _pal_lld_init(config)

 

@@ -144,6 +146,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @return              The port bits.

+ *

+ * @notapi

  */

 #define pal_lld_readport(port) ((port)->DATA)

 

@@ -156,6 +160,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @return              The latched logical states.

+ *

+ * @notapi

  */

 #define pal_lld_readlatch(port) ((port)->DATA)

 

@@ -166,6 +172,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] bits      bits to be written on the specified port

+ *

+ * @notapi

  */

 #define pal_lld_writeport(port, bits) ((port)->DATA = (bits))

 

@@ -179,6 +187,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] bits      bits to be ORed on the specified port

+ *

+ * @notapi

  */

 #define pal_lld_setport(port, bits) ((port)->MASKED_ACCESS[bits] = 0xFFFFFFFF)

 

@@ -192,6 +202,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] bits      bits to be cleared on the specified port

+ *

+ * @notapi

  */

 #define pal_lld_clearport(port, bits) ((port)->MASKED_ACCESS[bits] = 0)

 

@@ -207,6 +219,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  * @param[in] mask      group mask

  * @param[in] offset    group bit offset within the port

  * @return              The group logical states.

+ *

+ * @notapi

  */

 #define pal_lld_readgroup(port, mask, offset)                               \

   ((port)->MASKED_ACCESS[(mask) << (offset)])

@@ -224,6 +238,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  * @param[in] offset    group bit offset within the port

  * @param[in] bits      bits to be written. Values exceeding the group width

  *                      are masked.

+ *

+ * @notapi

  */

 #define pal_lld_writegroup(port, mask, offset, bits)                        \

   ((port)->MASKED_ACCESS[(mask) << (offset)] = (bits))

@@ -239,6 +255,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  * @param[in] port      port identifier

  * @param[in] mask      group mask

  * @param[in] mode      group mode

+ *

+ * @notapi

  */

 #define pal_lld_setgroupmode(port, mask, mode)                              \

   _pal_lld_setgroupmode(port, mask, mode)

@@ -253,8 +271,10 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] pad       pad number within the port

- * @param[out] bit      logical value, the value must be @p PAL_LOW or

+ * @param[in] bit       logical value, the value must be @p PAL_LOW or

  *                      @p PAL_HIGH

+ *

+ * @notapi

  */

 #define pal_lld_writepad(port, pad, bit)                                    \

   ((port)->MASKED_ACCESS[(mask) << (pad)] = (bit) << (pad))

@@ -269,6 +289,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] pad       pad number within the port

+ *

+ * @notapi

  */

 #define pal_lld_setpad(port, pad)                                           \

   ((port)->MASKED_ACCESS[1 << (pad)] = 1 << (pad))

@@ -283,6 +305,8 @@ typedef LPC_GPIO_TypeDef *ioportid_t;
  *

  * @param[in] port      port identifier

  * @param[in] pad       pad number within the port

+ *

+ * @notapi

  */

 #define pal_lld_clearpad(port, pad)                                         \

   ((port)->MASKED_ACCESS[1 << (pad)] = 0)

diff --git a/os/hal/platforms/LPC13xx/serial_lld.c b/os/hal/platforms/LPC13xx/serial_lld.c
index 2c5b7f47e..12da197e8 100644
--- a/os/hal/platforms/LPC13xx/serial_lld.c
+++ b/os/hal/platforms/LPC13xx/serial_lld.c
@@ -210,6 +210,8 @@ static void notify1(void) {
 

 /**

  * @brief   UART0 IRQ handler.

+ *

+ * @isr

  */

 #if USE_LPC13xx_UART0 || defined(__DOXYGEN__)

 CH_IRQ_HANDLER(VectorF8) {

@@ -228,6 +230,8 @@ CH_IRQ_HANDLER(VectorF8) {
 

 /**

  * @brief   Low level serial driver initialization.

+ *

+ * @notapi

  */

 void sd_lld_init(void) {

 

@@ -246,6 +250,8 @@ void sd_lld_init(void) {
  * @param[in] config    the architecture-dependent serial driver configuration.

  *                      If this parameter is set to @p NULL then a default

  *                      configuration is used.

+ *

+ * @notapi

  */

 void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {

 

@@ -270,6 +276,8 @@ void sd_lld_start(SerialDriver *sdp, const SerialConfig *config) {
  *          interrupt vector.

  *

  * @param[in] sdp       pointer to a @p SerialDriver object

+ *

+ * @notapi

  */

 void sd_lld_stop(SerialDriver *sdp) {

 

diff --git a/os/hal/platforms/LPC13xx/serial_lld.h b/os/hal/platforms/LPC13xx/serial_lld.h
index 0426c6d5f..54207d39d 100644
--- a/os/hal/platforms/LPC13xx/serial_lld.h
+++ b/os/hal/platforms/LPC13xx/serial_lld.h
@@ -150,7 +150,7 @@ typedef struct {
 } SerialConfig;

 

 /**

- * @brief @p SerialDriver specific data.

+ * @brief   @p SerialDriver specific data.

  */

 #define _serial_driver_data                                                 \

   _base_asynchronous_channel_data                                           \