Correction of AVR hal_gpt_lld to respect the project code style.

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

2 files changed, 51 insertions, 26 deletions

diff --git a/os/hal/ports/AVR/hal_gpt_lld.c b/os/hal/ports/AVR/hal_gpt_lld.c
index 49d1082d6..6ccc7cadd 100644
--- a/os/hal/ports/AVR/hal_gpt_lld.c
+++ b/os/hal/ports/AVR/hal_gpt_lld.c
@@ -20,7 +20,7 @@
 */

 

 /**

- * @file    AVR/gpt_lld.c

+ * @file    hal_gpt_lld.c

  * @brief   AVR GPT driver subsystem low level driver.

  *

  * @addtogroup GPT

@@ -159,6 +159,11 @@ static uint8_t getTimerIndex(GPTDriver *gptp) {
 /*===========================================================================*/

 

 #if AVR_GPT_USE_TIM1 || defined(__DOXYGEN__)

+/**

+ * @brief   TIM1 interrupt handler.

+ *

+ * @isr

+ */

 OSAL_IRQ_HANDLER(TIMER1_COMPA_vect) {

 

   OSAL_IRQ_PROLOGUE();

@@ -168,6 +173,11 @@ OSAL_IRQ_HANDLER(TIMER1_COMPA_vect) {
 #endif

 

 #if AVR_GPT_USE_TIM2 || defined(__DOXYGEN__)

+/**

+ * @brief   TIM2 interrupt handler.

+ *

+ * @isr

+ */

 OSAL_IRQ_HANDLER(TIMER2_COMPA_vect) {

 

   OSAL_IRQ_PROLOGUE();

@@ -177,6 +187,11 @@ OSAL_IRQ_HANDLER(TIMER2_COMPA_vect) {
 #endif

 

 #if AVR_GPT_USE_TIM3 || defined(__DOXYGEN__)

+/**

+ * @brief   TIM3 interrupt handler.

+ *

+ * @isr

+ */

 OSAL_IRQ_HANDLER(TIMER3_COMPA_vect) {

 

   OSAL_IRQ_PROLOGUE();

@@ -186,6 +201,11 @@ OSAL_IRQ_HANDLER(TIMER3_COMPA_vect) {
 #endif

 

 #if AVR_GPT_USE_TIM4 || defined(__DOXYGEN__)

+/**

+ * @brief   TIM4 interrupt handler.

+ *

+ * @isr

+ */

 OSAL_IRQ_HANDLER(TIMER4_COMPA_vect) {

 

   OSAL_IRQ_PROLOGUE();

@@ -195,6 +215,11 @@ OSAL_IRQ_HANDLER(TIMER4_COMPA_vect) {
 #endif

 

 #if AVR_GPT_USE_TIM5 || defined(__DOXYGEN__)

+/**

+ * @brief   TIM2 interrupt handler.

+ *

+ * @isr

+ */

 OSAL_IRQ_HANDLER(TIMER5_COMPA_vect) {

 

   OSAL_IRQ_PROLOGUE();

@@ -234,7 +259,7 @@ void gpt_lld_init(void) {
 /**

  * @brief   Configures and activates the GPT peripheral.

  *

- * @param[in] gptp      pointer to the @p GPTDriver object

+ * @param[in] gptp    pointer to the @p GPTDriver object

  *

  * @notapi

  */

@@ -275,7 +300,7 @@ void gpt_lld_start(GPTDriver *gptp) {
 /**

  * @brief   Deactivates the GPT peripheral.

  *

- * @param[in] gptp      pointer to the @p GPTDriver object

+ * @param[in] gptp    pointer to the @p GPTDriver object

  *

  * @notapi

  */

@@ -313,7 +338,7 @@ void gpt_lld_start_timer(GPTDriver *gptp, gptcnt_t period) {
 /**

  * @brief   Stops the timer.

  *

- * @param[in] gptp      pointer to the @p GPTDriver object

+ * @param[in] gptp    pointer to the @p GPTDriver object

  *

  * @notapi

  */

diff --git a/os/hal/ports/AVR/hal_gpt_lld.h b/os/hal/ports/AVR/hal_gpt_lld.h
index 6e16ccf90..a2bc614f9 100644
--- a/os/hal/ports/AVR/hal_gpt_lld.h
+++ b/os/hal/ports/AVR/hal_gpt_lld.h
@@ -43,45 +43,45 @@
 /*===========================================================================*/

 

 /**

- * @brief   GPT1 driver enable switch.

- * @details If set to @p TRUE the support for GPT1 is included.

- * @note    The default is @p FALSE.

+ * @brief     GPT1 driver enable switch.

+ * @details   If set to @p TRUE the support for GPT1 is included.

+ * @note      The default is @p FALSE.

  */

 #if !defined(AVR_GPT_USE_TIM1)

 #define AVR_GPT_USE_TIM1              FALSE

 #endif

 

 /**

- * @brief   GPT2 driver enable switch.

- * @details If set to @p TRUE the support for GPT2 is included.

- * @note    The default is @p FALSE.

+ * @brief     GPT2 driver enable switch.

+ * @details   If set to @p TRUE the support for GPT2 is included.

+ * @note      The default is @p FALSE.

  */

 #if !defined(AVR_GPT_USE_TIM2)

 #define AVR_GPT_USE_TIM2              FALSE

 #endif

 

 /**

- * @brief   GPT3 driver enable switch.

- * @details If set to @p TRUE the support for GPT3 is included.

- * @note    The default is @p FALSE.

+ * @brief     GPT3 driver enable switch.

+ * @details   If set to @p TRUE the support for GPT3 is included.

+ * @note      The default is @p FALSE.

  */

 #if !defined(AVR_GPT_USE_TIM3)

 #define AVR_GPT_USE_TIM3              FALSE

 #endif

 

 /**

- * @brief   GPT4 driver enable switch.

- * @details If set to @p TRUE the support for GPT4 is included.

- * @note    The default is @p FALSE.

+ * @brief     GPT4 driver enable switch.

+ * @details   If set to @p TRUE the support for GPT4 is included.

+ * @note      The default is @p FALSE.

  */

 #if !defined(AVR_GPT_USE_TIM4)

 #define AVR_GPT_USE_TIM4              FALSE

 #endif

 

 /**

- * @brief   GPT5 driver enable switch.

- * @details If set to @p TRUE the support for GPT5 is included.

- * @note    The default is @p FALSE.

+ * @brief     GPT5 driver enable switch.

+ * @details   If set to @p TRUE the support for GPT5 is included.

+ * @note      The default is @p FALSE.

  */

 #if !defined(AVR_GPT_USE_TIM5)

 #define AVR_GPT_USE_TIM5              FALSE

@@ -165,13 +165,13 @@ struct GPTDriver {
 /*===========================================================================*/

 

 /**

- * @brief   Changes the interval of GPT peripheral.

- * @details This function changes the interval of a running GPT unit.

- * @pre     The GPT unit must have been activated using @p gptStart().

- * @pre     The GPT unit must have been running in continuous mode using

- *          @p gptStartContinuous().

- * @post    The GPT unit interval is changed to the new value.

- * @note    The function has effect at the next cycle start.

+ * @brief     Changes the interval of GPT peripheral.

+ * @details   This function changes the interval of a running GPT unit.

+ * @pre       The GPT unit must have been activated using @p gptStart().

+ * @pre       The GPT unit must have been running in continuous mode using

+ *            @p gptStartContinuous().

+ * @post      The GPT unit interval is changed to the new value.

+ * @note      The function has effect at the next cycle start.

  *

  * @param[in] gptp      pointer to a @p GPTDriver object

  * @param[in] interval  new cycle time in timer ticks