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

9 files changed, 242 insertions, 242 deletions

diff --git a/os/hal/src/adc.c b/os/hal/src/adc.c
index 16bdeac43..dff7d828b 100644
--- a/os/hal/src/adc.c
+++ b/os/hal/src/adc.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file adc.c

- * @brief ADC Driver code.

+ * @file    adc.c

+ * @brief   ADC Driver code.

+ *

  * @addtogroup ADC

  * @{

  */

@@ -46,7 +47,7 @@
 /*===========================================================================*/

 

 /**

- * @brief ADC Driver initialization.

+ * @brief   ADC Driver initialization.

  */

 void adcInit(void) {

 

@@ -54,7 +55,7 @@ void adcInit(void) {
 }

 

 /**

- * @brief Initializes the standard part of a @p ADCDriver structure.

+ * @brief   Initializes the standard part of a @p ADCDriver structure.

  *

  * @param[in] adcp      pointer to the @p ADCDriver object

  */

@@ -70,7 +71,7 @@ void adcObjectInit(ADCDriver *adcp) {
 }

 

 /**

- * @brief Configures and activates the ADC peripheral.

+ * @brief   Configures and activates the ADC peripheral.

  *

  * @param[in] adcp      pointer to the @p ADCDriver object

  * @param[in] config    pointer to the @p ADCConfig object

@@ -90,7 +91,7 @@ void adcStart(ADCDriver *adcp, const ADCConfig *config) {
 }

 

 /**

- * @brief Deactivates the ADC peripheral.

+ * @brief   Deactivates the ADC peripheral.

  *

  * @param[in] adcp      pointer to the @p ADCDriver object

  */

@@ -108,7 +109,7 @@ void adcStop(ADCDriver *adcp) {
 }

 

 /**

- * @brief Starts an ADC conversion.

+ * @brief   Starts an ADC conversion.

  * @details Starts a conversion operation, there are two kind of conversion

  *          modes:

  *          - <b>LINEAR</b>, this mode is activated when the @p callback

@@ -122,6 +123,10 @@ void adcStop(ADCDriver *adcp) {
  *            time. This kind of conversion can only be stopped by explicitly

  *            invoking @p adcStopConversion().

  *          .

+ * @note    The buffer is organized as a matrix of M*N elements where M is the

+ *          channels number configured into the conversion group and N is the

+ *          buffer depth. The samples are sequentially written into the buffer

+ *          with no gaps.
  *
  * @param[in] adcp      pointer to the @p ADCDriver object
  * @param[in] grpp      pointer to a @p ADCConversionGroup object
@@ -129,14 +134,9 @@ void adcStop(ADCDriver *adcp) {
  * @param[in] depth     buffer depth (matrix rows number). The buffer depth

  *                      must be one or an even number.

  * @param[in] callback  pointer to the conversion callback function

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the conversion has been started.

  * @retval TRUE         the driver is busy, conversion not started.

- *

- * @note The buffer is organized as a matrix of M*N elements where M is the

- *       channels number configured into the conversion group and N is the

- *       buffer depth. The samples are sequentially written into the buffer

- *       with no gaps.
  */

 bool_t adcStartConversion(ADCDriver *adcp,

                           const ADCConversionGroup *grpp,

@@ -169,9 +169,9 @@ bool_t adcStartConversion(ADCDriver *adcp,
 }

 

 /**

- * @brief Stops an ongoing conversion.

+ * @brief   Stops an ongoing conversion.

  *
- * @param[in] adcp pointer to the @p ADCDriver object
+ * @param[in] adcp      pointer to the @p ADCDriver object
  */

 void adcStopConversion(ADCDriver *adcp) {

 

@@ -196,7 +196,7 @@ void adcStopConversion(ADCDriver *adcp) {
 }

 

 /**

- * @brief Waits for completion.

+ * @brief   Waits for completion.

  * @details If the conversion is not completed or not yet started then the

  *          invoking thread waits for a conversion completion event.

  *
@@ -206,9 +206,9 @@ void adcStopConversion(ADCDriver *adcp) {
  *                      - @a TIME_IMMEDIATE immediate timeout.

  *                      - @a TIME_INFINITE no timeout.

  *                      .

- * @return The operation result.

- * @retval RDY_OK conversion finished.

- * @retval RDY_TIMEOUT conversion not finished within the specified time.
+ * @return              The operation result.

+ * @retval RDY_OK       conversion finished.

+ * @retval RDY_TIMEOUT  conversion not finished within the specified time.
  */

 msg_t adcWaitConversion(ADCDriver *adcp, systime_t timeout) {

 

diff --git a/os/hal/src/can.c b/os/hal/src/can.c
index e70c25617..a4da35b8e 100644
--- a/os/hal/src/can.c
+++ b/os/hal/src/can.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file CAN.c

- * @brief CAN Driver code.

+ * @file    can.c

+ * @brief   CAN Driver code.

+ *

  * @addtogroup CAN

  * @{

  */

@@ -46,7 +47,7 @@
 /*===========================================================================*/

 

 /**

- * @brief CAN Driver initialization.

+ * @brief   CAN Driver initialization.

  */

 void canInit(void) {

 

@@ -54,7 +55,7 @@ void canInit(void) {
 }

 

 /**

- * @brief Initializes the standard part of a @p CANDriver structure.

+ * @brief   Initializes the standard part of a @p CANDriver structure.

  *

  * @param[in] canp      pointer to the @p CANDriver object

  */

@@ -75,7 +76,7 @@ void canObjectInit(CANDriver *canp) {
 }

 

 /**

- * @brief Configures and activates the CAN peripheral.

+ * @brief   Configures and activates the CAN peripheral.

  *

  * @param[in] canp      pointer to the @p CANDriver object

  * @param[in] config    pointer to the @p CANConfig object

@@ -101,7 +102,7 @@ void canStart(CANDriver *canp, const CANConfig *config) {
 }

 

 /**

- * @brief Deactivates the CAN peripheral.

+ * @brief   Deactivates the CAN peripheral.

  *

  * @param[in] canp      pointer to the @p CANDriver object

  */

@@ -123,10 +124,10 @@ void canStop(CANDriver *canp) {
 }

 

 /**

- * @brief Can frame transmission.

+ * @brief   Can frame transmission.

  * @details The specified frame is queued for transmission, if the hardware

  *          queue is full then the invoking thread is queued.

- * @note Trying to transmit while in sleep mode simply enqueues the thread.

+ * @note    Trying to transmit while in sleep mode simply enqueues the thread.

  *
  * @param[in] canp      pointer to the @p CANDriver object
  * @param[in] ctfp       pointer to the CAN frame to be transmitted
@@ -135,10 +136,10 @@ void canStop(CANDriver *canp) {
  *                      - @a TIME_IMMEDIATE immediate timeout.

  *                      - @a TIME_INFINITE no timeout.

  *                      .

- * @return The operation result.

- * @retval RDY_OK the frame has been queued for transmission.

- * @retval RDY_TIMEOUT operation not finished within the specified time.

- * @retval RDY_RESET driver stopped while waiting.

+ * @return              The operation result.

+ * @retval RDY_OK       the frame has been queued for transmission.

+ * @retval RDY_TIMEOUT  operation not finished within the specified time.

+ * @retval RDY_RESET    driver stopped while waiting.

  */

 msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) {

 

@@ -161,9 +162,9 @@ msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) {
 }

 

 /**

- * @brief Can frame receive.

+ * @brief   Can frame receive.

  * @details The function waits until a frame is received.

- * @note Trying to receive while in sleep mode simply enqueues the thread.

+ * @note    Trying to receive while in sleep mode simply enqueues the thread.

  *

  * @param[in] canp      pointer to the @p CANDriver object

  * @param[out] crfp     pointer to the buffer where the CAN frame is copied

@@ -174,11 +175,12 @@ msg_t canTransmit(CANDriver *canp, const CANTxFrame *ctfp, systime_t timeout) {
  *                        for I/O).

  *                      - @a TIME_INFINITE no timeout.

  *                      .

- * @return The operation result.

- * @retval RDY_OK a frame has been received and placed in the buffer.

- * @retval RDY_TIMEOUT operation not finished within the specified time or

- *         frame not immediately available if invoked using @p TIME_IMMEDIATE.

- * @retval RDY_RESET driver stopped while waiting.

+ * @return              The operation result.

+ * @retval RDY_OK       a frame has been received and placed in the buffer.

+ * @retval RDY_TIMEOUT  operation not finished within the specified time or

+ *                      frame not immediately available if invoked using

+ *                      @p TIME_IMMEDIATE.

+ * @retval RDY_RESET    driver stopped while waiting.

  */

 msg_t canReceive(CANDriver *canp, CANRxFrame *crfp, systime_t timeout) {

 

@@ -201,11 +203,10 @@ msg_t canReceive(CANDriver *canp, CANRxFrame *crfp, systime_t timeout) {
 }

 

 /**

- * @brief Returns the current status mask and clears it.
+ * @brief   Returns the current status mask and clears it.
  *

  * @param[in] canp      pointer to the @p CANDriver object

- *

- * @return The status flags mask.

+ * @return              The status flags mask.

  */

 canstatus_t canGetAndClearFlags(CANDriver *canp) {

   canstatus_t status;

@@ -219,7 +220,7 @@ canstatus_t canGetAndClearFlags(CANDriver *canp) {
 

 #if CAN_USE_SLEEP_MODE || defined(__DOXYGEN__)

 /**

- * @brief Enters the sleep mode.
+ * @brief   Enters the sleep mode.
  *

  * @param[in] canp      pointer to the @p CANDriver object

  */

@@ -241,9 +242,9 @@ void canSleep(CANDriver *canp) {
 }

 

 /**

- * @brief Enforces leaving the sleep mode.

- * @note The sleep mode is supposed to be usually exited automatically by an

- *       hardware event.
+ * @brief   Enforces leaving the sleep mode.

+ * @note    The sleep mode is supposed to be usually exited automatically by

+ *          an hardware event.
  *

  * @param[in] canp      pointer to the @p CANDriver object

  */

diff --git a/os/hal/src/hal.c b/os/hal/src/hal.c
index 3631028e5..f93f036c6 100644
--- a/os/hal/src/hal.c
+++ b/os/hal/src/hal.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file hal.c

- * @brief HAL subsystem code.

+ * @file    hal.c

+ * @brief   HAL subsystem code.

+ *

  * @addtogroup HAL

  * @{

  */

@@ -44,7 +45,7 @@
 /*===========================================================================*/

 

 /**

- * @brief HAL initialization.
+ * @brief   HAL initialization.
  */

 void halInit(void) {

 

diff --git a/os/hal/src/mac.c b/os/hal/src/mac.c
index 6d31c7b9e..74e08bdf4 100644
--- a/os/hal/src/mac.c
+++ b/os/hal/src/mac.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file mac.c

- * @brief MAC Driver code.

+ * @file    mac.c

+ * @brief   MAC Driver code.

+ *

  * @addtogroup MAC

  * @{

  */

@@ -50,7 +51,7 @@
 /*===========================================================================*/

 

 /**

- * @brief MAC Driver initialization.
+ * @brief   MAC Driver initialization.
  */

 void macInit(void) {

 

@@ -58,9 +59,9 @@ void macInit(void) {
 }

 

 /**

- * @brief Initialize the standard part of a @p MACDriver structure.
+ * @brief   Initialize the standard part of a @p MACDriver structure.
  *

- * @param[in] macp pointer to the @p MACDriver object

+ * @param[in] macp      pointer to the @p MACDriver object

  */

 void macObjectInit(MACDriver *macp) {

 

@@ -72,15 +73,15 @@ void macObjectInit(MACDriver *macp) {
 }

 

 /**

- * @brief MAC address setup.

+ * @brief   MAC address setup.

+ * @note    This function must be invoked only with the driver in the stopped

+ *          state. If invoked on an active interface then it is ignored.
  *

- * @param[in] macp pointer to the @p MACDriver object
- * @param[in] p pointer to a six bytes buffer containing the MAC address. If

- *            this parameter is set to @p NULL then a system default MAC is

- *            used.

+ * @param[in] macp      pointer to the @p MACDriver object
+ * @param[in] p         pointer to a six bytes buffer containing the MAC

+ *                      address. If this parameter is set to @p NULL then MAC

+ *                      a system default is used.

  *

- * @note This function must be invoked only with the driver in the stopped

- *       state. If invoked on an active interface then it is ignored.
  */

 void macSetAddress(MACDriver *macp, const uint8_t *p) {

 

@@ -88,21 +89,21 @@ void macSetAddress(MACDriver *macp, const uint8_t *p) {
 }

 

 /**

- * @brief Allocates a transmission descriptor.

+ * @brief   Allocates a transmission descriptor.

  * @details One of the available transmission descriptors is locked and

  *          returned. If a descriptor is not currently available then the

  *          invoking thread is queued until one is freed.

  *
- * @param[in] macp pointer to the @p MACDriver object

- * @param[out] tdp pointer to a @p MACTransmitDescriptor structure

- * @param[in] time the number of ticks before the operation timeouts,

- *            the following special values are allowed:

- *            - @a TIME_IMMEDIATE immediate timeout.

- *            - @a TIME_INFINITE no timeout.

- *            .

- * @return The operation status.

- * @retval RDY_OK the descriptor was obtained.

- * @retval RDY_TIMEOUT the operation timed out, descriptor not initialized.
+ * @param[in] macp      pointer to the @p MACDriver object

+ * @param[out] tdp      pointer to a @p MACTransmitDescriptor structure

+ * @param[in] time      the number of ticks before the operation timeouts,

+ *                      the following special values are allowed:

+ *                      - @a TIME_IMMEDIATE immediate timeout.

+ *                      - @a TIME_INFINITE no timeout.

+ *                      .

+ * @return              The operation status.

+ * @retval RDY_OK       the descriptor was obtained.

+ * @retval RDY_TIMEOUT  the operation timed out, descriptor not initialized.
  */

 msg_t macWaitTransmitDescriptor(MACDriver *macp,

                                 MACTransmitDescriptor *tdp,

@@ -123,10 +124,10 @@ msg_t macWaitTransmitDescriptor(MACDriver *macp,
 }

 

 /**

- * @brief Releases a transmit descriptor and starts the transmission of the

- *        enqueued data as a single frame.

+ * @brief   Releases a transmit descriptor and starts the transmission of the

+ *          enqueued data as a single frame.

  *
- * @param[in] tdp the pointer to the @p MACTransmitDescriptor structure
+ * @param[in] tdp       the pointer to the @p MACTransmitDescriptor structure
  */

 void macReleaseTransmitDescriptor(MACTransmitDescriptor *tdp) {

 

@@ -134,21 +135,21 @@ void macReleaseTransmitDescriptor(MACTransmitDescriptor *tdp) {
 }

 

 /**

- * @brief Waits for a received frame.

+ * @brief   Waits for a received frame.

  * @details Stops until a frame is received and buffered. If a frame is

  *          not immediately available then the invoking thread is queued

  *          until one is received.

  *

- * @param[in] macp pointer to the @p MACDriver object

- * @param[out] rdp pointer to a @p MACReceiveDescriptor structure

- * @param[in] time the number of ticks before the operation timeouts,

- *            the following special values are allowed:

- *            - @a TIME_IMMEDIATE immediate timeout.

- *            - @a TIME_INFINITE no timeout.

- *            .

- * @return The operation status.

- * @retval RDY_OK the descriptor was obtained.

- * @retval RDY_TIMEOUT the operation timed out, descriptor not initialized.

+ * @param[in] macp      pointer to the @p MACDriver object

+ * @param[out] rdp      pointer to a @p MACReceiveDescriptor structure

+ * @param[in] time      the number of ticks before the operation timeouts,

+ *                      the following special values are allowed:

+ *                      - @a TIME_IMMEDIATE immediate timeout.

+ *                      - @a TIME_INFINITE no timeout.

+ *                      .

+ * @return              The operation status.

+ * @retval RDY_OK       the descriptor was obtained.

+ * @retval RDY_TIMEOUT  the operation timed out, descriptor not initialized.

  */

 msg_t macWaitReceiveDescriptor(MACDriver *macp,

                                MACReceiveDescriptor *rdp,

@@ -169,11 +170,11 @@ msg_t macWaitReceiveDescriptor(MACDriver *macp,
 }

 

 /**

- * @brief Releases a receive descriptor.

+ * @brief   Releases a receive descriptor.

  * @details The descriptor and its buffer are made available for more incoming

  *          frames.

  *

- * @param[in] rdp the pointer to the @p MACReceiveDescriptor structure

+ * @param[in] rdp       the pointer to the @p MACReceiveDescriptor structure

  */

 void macReleaseReceiveDescriptor(MACReceiveDescriptor *rdp) {

 

@@ -181,12 +182,12 @@ void macReleaseReceiveDescriptor(MACReceiveDescriptor *rdp) {
 }

 

 /**

- * @brief Updates and returns the link status.

+ * @brief   Updates and returns the link status.

  *
- * @param[in] macp pointer to the @p MACDriver object

- * @return The link status.

- * @retval TRUE if the link is active.

- * @retval FALSE if the link is down.
+ * @param[in] macp      pointer to the @p MACDriver object

+ * @return              The link status.

+ * @retval TRUE         if the link is active.

+ * @retval FALSE        if the link is down.
  */

 bool_t macPollLinkStatus(MACDriver *macp) {

 

diff --git a/os/hal/src/mmc_spi.c b/os/hal/src/mmc_spi.c
index f9f8eef5a..c1cb313ec 100644
--- a/os/hal/src/mmc_spi.c
+++ b/os/hal/src/mmc_spi.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file mmc_spi.c

- * @brief MMC over SPI driver code.

+ * @file    mmc_spi.c

+ * @brief   MMC over SPI driver code.

+ *

  * @addtogroup MMC_SPI

  * @{

  */

@@ -41,6 +42,11 @@
 /* Driver local functions.                                                   */

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

 

+/**

+ * @brief   Inserion monitor timer callback function.

+ *

+ * @param[in] p         pointer to the @p MMCDriver object
+ */

 void tmrfunc(void *p) {

   MMCDriver *mmcp = p;

 

@@ -65,7 +71,7 @@ void tmrfunc(void *p) {
 }

 

 /**

- * @brief Waits an idle condition.

+ * @brief   Waits an idle condition.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

  */

@@ -91,7 +97,7 @@ static void wait(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Sends a command header.

+ * @brief   Sends a command header.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

  * @param cmd[in]       the command id
@@ -113,11 +119,10 @@ static void send_hdr(MMCDriver *mmcp, uint8_t cmd, uint32_t arg) {
 }

 

 /**

- * @brief Receives a single byte response.

+ * @brief   Receives a single byte response.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

- *

- * @return The response as an @p uint8_t value.

+ * @return              The response as an @p uint8_t value.

  * @retval 0xFF         timed out.
  */

 static uint8_t recvr1(MMCDriver *mmcp) {

@@ -133,13 +138,12 @@ static uint8_t recvr1(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Sends a command an returns a single byte response.

+ * @brief   Sends a command an returns a single byte response.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

  * @param cmd[in]       the command id

  * @param arg[in]       the command argument

- *

- * @return The response as an @p uint8_t value.

+ * @return              The response as an @p uint8_t value.

  * @retval 0xFF         timed out.

  */

 static uint8_t send_command(MMCDriver *mmcp, uint8_t cmd, uint32_t arg) {

@@ -153,7 +157,7 @@ static uint8_t send_command(MMCDriver *mmcp, uint8_t cmd, uint32_t arg) {
 }

 

 /**

- * @brief Waits that the card reaches an idle state.
+ * @brief   Waits that the card reaches an idle state.
  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

  */

@@ -177,14 +181,14 @@ static void sync(MMCDriver *mmcp) {
 /*===========================================================================*/

 

 /**

- * @brief MMC over SPI driver initialization.

+ * @brief   MMC over SPI driver initialization.

  */

 void mmcInit(void) {

 

 }

 

 /**

- * @brief Initializes an instance.

+ * @brief   Initializes an instance.

  *

  * @param[in] mmcp          pointer to the @p MMCDriver object

  * @param[in] spip          pointer to the SPI driver to be used as interface

@@ -211,7 +215,7 @@ void mmcObjectInit(MMCDriver *mmcp, SPIDriver *spip,
 }

 

 /**

- * @brief Configures and activates the MMC peripheral.

+ * @brief   Configures and activates the MMC peripheral.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

  * @param[in] config    pointer to the @p MMCConfig object

@@ -230,7 +234,7 @@ void mmcStart(MMCDriver *mmcp, const MMCConfig *config) {
 }

 

 /**

- * @brief Disables the MMC peripheral.

+ * @brief   Disables the MMC peripheral.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

  */

@@ -253,16 +257,15 @@ void mmcStop(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Performs the initialization procedure on the inserted card.

+ * @brief   Performs the initialization procedure on the inserted card.

  * @details This function should be invoked when a card is inserted and

  *          brings the driver in the @p MMC_READY state where it is possible

  *          to perform read and write operations.

- * @note It is possible to invoke this function from the insertion event

- *       handler.

+ * @note    It is possible to invoke this function from the insertion event

+ *          handler.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

- *

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful and the driver is now

  *                      in the @p MMC_READY state.

  * @retval TRUE         the operation failed.

@@ -331,10 +334,10 @@ bool_t mmcConnect(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Brings the driver in a state safe for card removal.

+ * @brief   Brings the driver in a state safe for card removal.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful and the driver is now

  *                      in the @p MMC_INSERTED state.

  * @retval TRUE         the operation failed.

@@ -363,12 +366,11 @@ bool_t mmcDisconnect(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Starts a sequential read.

+ * @brief   Starts a sequential read.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

- * @param[in] startblk  first block to read

- *
- * @return The operation status.

+ * @param[in] startblk  first block to read
+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

@@ -398,12 +400,11 @@ bool_t mmcStartSequentialRead(MMCDriver *mmcp, uint32_t startblk) {
 }

 

 /**

- * @brief Reads a block within a sequential read operation.

+ * @brief   Reads a block within a sequential read operation.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

- * @param[out] buffer   pointer to the read buffer
- *

- * @return The operation status.

+ * @param[out] buffer   pointer to the read buffer

+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

@@ -438,11 +439,10 @@ bool_t mmcSequentialRead(MMCDriver *mmcp, uint8_t *buffer) {
 }

 

 /**

- * @brief Stops a sequential read gracefully.

+ * @brief   Stops a sequential read gracefully.

  *
  * @param[in] mmcp      pointer to the @p MMCDriver object

- *

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

@@ -471,12 +471,11 @@ bool_t mmcStopSequentialRead(MMCDriver *mmcp) {
 }

 

 /**

- * @brief Starts a sequential write.

+ * @brief   Starts a sequential write.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

  * @param[in] startblk  first block to write

- *

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

@@ -506,12 +505,11 @@ bool_t mmcStartSequentialWrite(MMCDriver *mmcp, uint32_t startblk) {
 }

 

 /**

- * @brief Writes a block within a sequential write operation.

+ * @brief   Writes a block within a sequential write operation.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

  * @param[out] buffer   pointer to the write buffer

- *

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

@@ -545,11 +543,10 @@ bool_t mmcSequentialWrite(MMCDriver *mmcp, const uint8_t *buffer) {
 }

 

 /**

- * @brief Stops a sequential write gracefully.

+ * @brief   Stops a sequential write gracefully.

  *

  * @param[in] mmcp      pointer to the @p MMCDriver object

- *

- * @return The operation status.

+ * @return              The operation status.

  * @retval FALSE        the operation was successful.

  * @retval TRUE         the operation failed.

  */

diff --git a/os/hal/src/pal.c b/os/hal/src/pal.c
index a04f4ed96..cc898d2fd 100644
--- a/os/hal/src/pal.c
+++ b/os/hal/src/pal.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file pal.c

- * @brief I/O Ports Abstraction Layer code.

+ * @file    pal.c

+ * @brief   I/O Ports Abstraction Layer code.

+ *

  * @addtogroup PAL

  * @{

  */

@@ -46,17 +47,17 @@
 /*===========================================================================*/

 

 /**

- * @brief Read from an I/O bus.

- *

- * @param[in] bus the I/O bus, pointer to a @p IOBus structure

- * @return The bus logical states.

+ * @brief   Read from an I/O bus.

+ * @note    The operation is not guaranteed to be atomic on all the

+ *          architectures, for atomicity and/or portability reasons you may

+ *          need to enclose port I/O operations between @p chSysLock() and

+ *          @p chSysUnlock().

+ * @note    The function internally uses the @p palReadGroup() macro. The use

+ *          of this function is preferred when you value code size, readability

+ *          and error checking over speed.

  *

- * @note The operation is not guaranteed to be atomic on all the architectures,

- *       for atomicity and/or portability reasons you may need to enclose port

- *       I/O operations between @p chSysLock() and @p chSysUnlock().

- * @note The function internally uses the @p palReadGroup() macro. The use of

- *       this function is preferred when you value code size, readability  and

- *       error checking over speed.

+ * @param[in] bus       the I/O bus, pointer to a @p IOBus structure

+ * @return              The bus logical states.

  */

 ioportmask_t palReadBus(IOBus *bus) {

 

@@ -67,18 +68,19 @@ ioportmask_t palReadBus(IOBus *bus) {
 }

 

 /**

- * @brief Write to an I/O bus.

+ * @brief   Write to an I/O bus.

+ * @note    The operation is not guaranteed to be atomic on all the

+ *          architectures, for atomicity and/or portability reasons you may

+ *          need to enclose port I/O operations between @p chSysLock() and

+ *          @p chSysUnlock().

+ * @note    The default implementation is non atomic and not necessarily

+ *          optimal. Low level drivers may  optimize the function by using

+ *          specific hardware or coding.

  *

- * @param[in] bus the I/O bus, pointer to a @p IOBus structure

- * @param[in] bits the bits to be written on the I/O bus. Values exceeding

- *            the bus width are masked so most significant bits are lost.

- *

- * @note The operation is not guaranteed to be atomic on all the architectures,

- *       for atomicity and/or portability reasons you may need to enclose port

- *       I/O operations between @p chSysLock() and @p chSysUnlock().

- * @note The default implementation is non atomic and not necessarily

- *       optimal. Low level drivers may  optimize the function by using

- *       specific hardware or coding.

+ * @param[in] bus       the I/O bus, pointer to a @p IOBus structure

+ * @param[in] bits      the bits to be written on the I/O bus. Values exceeding

+ *                      the bus width are masked so most significant bits are

+ *                      lost.

  */

 void palWriteBus(IOBus *bus, ioportmask_t bits) {

 

@@ -89,17 +91,17 @@ void palWriteBus(IOBus *bus, ioportmask_t bits) {
 }

 

 /**

- * @brief Programs a bus with the specified mode.

+ * @brief   Programs a bus with the specified mode.

+ * @note    The operation is not guaranteed to be atomic on all the

+ *          architectures, for atomicity and/or portability reasons you may

+ *          need to enclose port I/O operations between @p chSysLock() and

+ *          @p chSysUnlock().

+ * @note    The default implementation is non atomic and not necessarily

+ *          optimal. Low level drivers may  optimize the function by using

+ *          specific hardware or coding.

  *
- * @param[in] bus the I/O bus, pointer to a @p IOBus structure

- * @param[in] mode the mode

- *

- * @note The operation is not guaranteed to be atomic on all the architectures,

- *       for atomicity and/or portability reasons you may need to enclose port

- *       I/O operations between @p chSysLock() and @p chSysUnlock().

- * @note The default implementation is non atomic and not necessarily

- *       optimal. Low level drivers may  optimize the function by using

- *       specific hardware or coding.

+ * @param[in] bus       the I/O bus, pointer to a @p IOBus structure

+ * @param[in] mode      the mode

  */

 void palSetBusMode(IOBus *bus, uint_fast8_t mode) {

 

diff --git a/os/hal/src/pwm.c b/os/hal/src/pwm.c
index 404f3d8a7..ddfb6dd83 100644
--- a/os/hal/src/pwm.c
+++ b/os/hal/src/pwm.c
@@ -18,8 +18,8 @@
 */

 

 /**

- * @file PWM.c

- * @brief PWM Driver code.

+ * @file    pwm.c

+ * @brief   PWM Driver code.

  * @addtogroup PWM

  * @{

  */

@@ -46,7 +46,7 @@
 /*===========================================================================*/

 

 /**

- * @brief PWM Driver initialization.

+ * @brief   PWM Driver initialization.

  */

 void pwmInit(void) {

 

@@ -54,7 +54,7 @@ void pwmInit(void) {
 }

 

 /**

- * @brief Initializes the standard part of a @p PWMDriver structure.

+ * @brief   Initializes the standard part of a @p PWMDriver structure.

  *

  * @param[in] pwmp      pointer to a @p PWMDriver object

  */

@@ -65,7 +65,7 @@ void pwmObjectInit(PWMDriver *pwmp) {
 }

 

 /**

- * @brief Configures and activates the PWM peripheral.

+ * @brief   Configures and activates the PWM peripheral.

  *

  * @param[in] pwmp      pointer to a @p PWMDriver object

  * @param[in] config    pointer to a @p PWMConfig object

@@ -85,7 +85,7 @@ void pwmStart(PWMDriver *pwmp, const PWMConfig *config) {
 }

 

 /**

- * @brief Deactivates the PWM peripheral.

+ * @brief   Deactivates the PWM peripheral.

  *

  * @param[in] pwmp      pointer to a @p PWMDriver object

  */

@@ -103,7 +103,7 @@ void pwmStop(PWMDriver *pwmp) {
 }

 

 /**

- * @brief Enables a PWM channel.

+ * @brief   Enables a PWM channel.

  *
  * @param[in] pwmp      pointer to a @p PWMDriver object

  * @param[in] channel   PWM channel identifier
diff --git a/os/hal/src/serial.c b/os/hal/src/serial.c
index 9b5219fca..851f16ffb 100644
--- a/os/hal/src/serial.c
+++ b/os/hal/src/serial.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file serial.c

- * @brief Serial Driver code.

+ * @file    serial.c

+ * @brief   Serial Driver code.

+ *

  * @addtogroup SERIAL

  * @{

  */

@@ -97,7 +98,7 @@ static const struct SerialDriverVMT vmt = {
 /*===========================================================================*/

 

 /**

- * @brief Serial Driver initialization.

+ * @brief   Serial Driver initialization.

  */

 void sdInit(void) {

 

@@ -105,17 +106,17 @@ void sdInit(void) {
 }

 

 /**

- * @brief Initializes a generic full duplex driver object.

+ * @brief   Initializes a generic full duplex driver object.

  * @details The HW dependent part of the initialization has to be performed

  *          outside, usually in the hardware initialization code.

  *

- * @param[out] sdp pointer to a @p SerialDriver structure

- * @param[in] inotify pointer to a callback function that is invoked when

- *                    some data is read from the Queue. The value can be

- *                    @p NULL.

- * @param[in] onotify pointer to a callback function that is invoked when

- *                    some data is written in the Queue. The value can be

- *                    @p NULL.

+ * @param[out] sdp      pointer to a @p SerialDriver structure

+ * @param[in] inotify   pointer to a callback function that is invoked when

+ *                      some data is read from the Queue. The value can be

+ *                      @p NULL.

+ * @param[in] onotify   pointer to a callback function that is invoked when

+ *                      some data is written in the Queue. The value can be

+ *                      @p NULL.

  */

 void sdObjectInit(SerialDriver *sdp, qnotify_t inotify, qnotify_t onotify) {

 

@@ -130,12 +131,12 @@ void sdObjectInit(SerialDriver *sdp, qnotify_t inotify, qnotify_t onotify) {
 }

 

 /**

- * @brief Configures and starts the driver.

+ * @brief   Configures and starts the driver.

  *

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

- * @param[in] config the architecture-dependent serial driver configuration.

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

- *                   configuration is used.

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

+ * @param[in] config    the architecture-dependent serial driver configuration.

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

+ *                      configuration is used.

  */

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

 

@@ -152,11 +153,11 @@ void sdStart(SerialDriver *sdp, const SerialConfig *config) {
 }

 

 /**

- * @brief Stops the driver.

+ * @brief   Stops the driver.

  * @details Any thread waiting on the driver's queues will be awakened with

  *          the message @p Q_RESET.

  *

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

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

  */

 void sdStop(SerialDriver *sdp) {

 

@@ -175,18 +176,18 @@ void sdStop(SerialDriver *sdp) {
 }

 

 /**

- * @brief Handles incoming data.

+ * @brief   Handles incoming data.

  * @details This function must be called from the input interrupt service

  *          routine in order to enqueue incoming data and generate the

  *          related events.

- * @note The incoming data event is only generated when the input queue

- *       becomes non-empty.

- * @note In order to gain some performance it is suggested to not use

- *       this function directly but copy this code directly into the

- *       interrupt service routine.

+ * @note    The incoming data event is only generated when the input queue

+ *          becomes non-empty.

+ * @note    In order to gain some performance it is suggested to not use

+ *          this function directly but copy this code directly into the

+ *          interrupt service routine.

  *

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

- * @param[in] b the byte to be written in the driver's Input Queue

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

+ * @param[in] b         the byte to be written in the driver's Input Queue

  */

 void sdIncomingDataI(SerialDriver *sdp, uint8_t b) {

 

@@ -199,17 +200,17 @@ void sdIncomingDataI(SerialDriver *sdp, uint8_t b) {
 }

 

 /**

- * @brief Handles outgoing data.

+ * @brief   Handles outgoing data.

  * @details Must be called from the output interrupt service routine in order

  *          to get the next byte to be transmitted.

- * @note In order to gain some performance it is suggested to not use

- *       this function directly but copy this code directly into the

- *       interrupt service routine.

+ * @note    In order to gain some performance it is suggested to not use

+ *          this function directly but copy this code directly into the

+ *          interrupt service routine.

  *

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

- * @return The byte value read from the driver's output queue.

- * @retval Q_EMPTY if the queue is empty (the lower driver usually disables

- *                 the interrupt source when this happens).

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

+ * @return              The byte value read from the driver's output queue.

+ * @retval Q_EMPTY      if the queue is empty (the lower driver usually

+ *                      disables the interrupt source when this happens).

  */

 msg_t sdRequestDataI(SerialDriver *sdp) {

   msg_t  b;

@@ -223,12 +224,12 @@ msg_t sdRequestDataI(SerialDriver *sdp) {
 }

 

 /**

- * @brief Handles communication events/errors.

+ * @brief   Handles communication events/errors.

  * @details Must be called from the I/O interrupt service routine in order to

  *          notify I/O conditions as errors, signals change etc.

  *

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

- * @param[in] mask condition flags to be added to the mask

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

+ * @param[in] mask      condition flags to be added to the mask

  */

 void sdAddFlagsI(SerialDriver *sdp, sdflags_t mask) {

 

@@ -239,11 +240,11 @@ void sdAddFlagsI(SerialDriver *sdp, sdflags_t mask) {
 }

 

 /**

- * @brief Returns and clears the errors mask associated to the driver.

+ * @brief   Returns and clears the errors mask associated to the driver.

  *

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

- * @return The condition flags modified since last time this function was

- *         invoked.

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

+ * @return              The condition flags modified since last time this

+ *                      function was invoked.

  */

 sdflags_t sdGetAndClearFlags(SerialDriver *sdp) {

   sdflags_t mask;

diff --git a/os/hal/src/spi.c b/os/hal/src/spi.c
index 36bde9a3a..611a454a7 100644
--- a/os/hal/src/spi.c
+++ b/os/hal/src/spi.c
@@ -18,8 +18,9 @@
 */

 

 /**

- * @file spi.c

- * @brief SPI Driver code.

+ * @file    spi.c

+ * @brief   SPI Driver code.

+ *

  * @addtogroup SPI

  * @{

  */

@@ -46,7 +47,7 @@
 /*===========================================================================*/

 

 /**

- * @brief SPI Driver initialization.

+ * @brief   SPI Driver initialization.

  */

 void spiInit(void) {

 

@@ -54,7 +55,7 @@ void spiInit(void) {
 }

 

 /**

- * @brief Initializes the standard part of a @p SPIDriver structure.

+ * @brief   Initializes the standard part of a @p SPIDriver structure.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

  */

@@ -70,7 +71,7 @@ void spiObjectInit(SPIDriver *spip) {
 }

 

 /**

- * @brief Configures and activates the SPI peripheral.

+ * @brief   Configures and activates the SPI peripheral.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

  * @param[in] config    pointer to the @p SPIConfig object

@@ -108,7 +109,7 @@ void spiStop(SPIDriver *spip) {
 }

 

 /**

- * @brief Asserts the slave select signal and prepares for transfers.

+ * @brief   Asserts the slave select signal and prepares for transfers.

  *
  * @param[in] spip      pointer to the @p SPIDriver object

  */

@@ -127,7 +128,7 @@ void spiSelect(SPIDriver *spip) {
 }

 

 /**

- * @brief Deasserts the slave select signal.

+ * @brief   Deasserts the slave select signal.

  * @details The previously selected peripheral is unselected.

  *
  * @param[in] spip      pointer to the @p SPIDriver object

@@ -147,7 +148,7 @@ void spiUnselect(SPIDriver *spip) {
 }

 

 /**

- * @brief Ignores data on the SPI bus.

+ * @brief   Ignores data on the SPI bus.

  * @details This function transmits a series of idle words on the SPI bus and

  *          ignores the received data. This function can be invoked even

  *          when a slave select signal has not been yet asserted.

@@ -166,16 +167,15 @@ void spiIgnore(SPIDriver *spip, size_t n) {
 }

 

 /**

- * @brief Exchanges data on the SPI bus.

+ * @brief   Exchanges data on the SPI bus.

  * @details This function performs a simultaneous transmit/receive operation.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below

+ *          or equal to 8 bits else it is organized as uint16_t arrays.

  *
  * @param[in] spip      pointer to the @p SPIDriver object

  * @param[in] n         number of words to be exchanged
  * @param[in] txbuf     the pointer to the transmit buffer

  * @param[out] rxbuf    the pointer to the receive buffer

- *

- * @note The buffers are organized as uint8_t arrays for data sizes below or

- *       equal to 8 bits else it is organized as uint16_t arrays.

  */

 void spiExchange(SPIDriver *spip, size_t n, const void *txbuf, void *rxbuf) {

 

@@ -189,14 +189,13 @@ void spiExchange(SPIDriver *spip, size_t n, const void *txbuf, void *rxbuf) {
 }

 

 /**

- * @brief Sends data ever the SPI bus.

+ * @brief   Sends data ever the SPI bus.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below

+ *          or equal to 8 bits else it is organized as uint16_t arrays.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

  * @param[in] n         number of words to send

  * @param[in] txbuf     the pointer to the transmit buffer

- *

- * @note The buffers are organized as uint8_t arrays for data sizes below or

- *       equal to 8 bits else it is organized as uint16_t arrays.

  */

 void spiSend(SPIDriver *spip, size_t n, const void *txbuf) {

 

@@ -210,14 +209,13 @@ void spiSend(SPIDriver *spip, size_t n, const void *txbuf) {
 }

 

 /**

- * @brief Receives data from the SPI bus.

+ * @brief   Receives data from the SPI bus.

+ * @note    The buffers are organized as uint8_t arrays for data sizes below

+ *          or equal to 8 bits else it is organized as uint16_t arrays.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

  * @param[in] n         number of words to receive

  * @param[out] rxbuf    the pointer to the receive buffer

- *

- * @note The buffers are organized as uint8_t arrays for data sizes below or

- *       equal to 8 bits else it is organized as uint16_t arrays.

  */

 void spiReceive(SPIDriver *spip, size_t n, void *rxbuf) {

 

@@ -232,14 +230,14 @@ void spiReceive(SPIDriver *spip, size_t n, void *rxbuf) {
 

 #if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)

 /**

- * @brief Gains exclusive access to the SPI bus.

+ * @brief   Gains exclusive access to the SPI bus.

  * @details This function tries to gain ownership to the SPI bus, if the bus

  *          is already being used then the invoking thread is queued.

+ * @note    This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION

+ *          option is set to @p TRUE.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

  *

- * @note This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION

- *       option is set to @p TRUE.

  */

 void spiAcquireBus(SPIDriver *spip) {

 

@@ -253,12 +251,11 @@ void spiAcquireBus(SPIDriver *spip) {
 }

 

 /**

- * @brief Releases exclusive access to the SPI bus.

+ * @brief   Releases exclusive access to the SPI bus.

+ * @note    This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION

+ *          option is set to @p TRUE.

  *

  * @param[in] spip      pointer to the @p SPIDriver object

- *

- * @note This function is only available when the @p SPI_USE_MUTUAL_EXCLUSION

- *       option is set to @p TRUE.

  */

 void spiReleaseBus(SPIDriver *spip) {