From cfbd190b1e161029c6d8e87325697fedfd2a5816 Mon Sep 17 00:00:00 2001 From: marcoveeneman Date: Tue, 18 Apr 2017 23:17:00 +0200 Subject: Fixed Tiva low level driver @file documentation. --- os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.c | 2 +- os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.h | 2 +- os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.c | 2 +- os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.h | 2 +- os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.c | 2 +- os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.h | 2 +- os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.c | 2 +- os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.h | 2 +- os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.c | 2 +- os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.h | 2 +- os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.c | 2 +- os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.h | 2 +- os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.c | 2 +- os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.h | 2 +- os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.c | 2 +- os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.h | 2 +- os/hal/ports/TIVA/LLD/UART/hal_serial_lld.c | 2 +- os/hal/ports/TIVA/LLD/UART/hal_serial_lld.h | 8 ++------ os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.c | 2 +- os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.h | 2 +- os/hal/ports/TIVA/LLD/uDMA/tiva_udma.c | 10 ++++++++++ os/hal/ports/TIVA/LLD/uDMA/tiva_udma.h | 10 ++++++++++ 22 files changed, 41 insertions(+), 25 deletions(-) (limited to 'os/hal/ports/TIVA') diff --git a/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.c b/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.c index d0788f4..8da6e2b 100644 --- a/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.c +++ b/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.c @@ -15,7 +15,7 @@ */ /** - * @file Tiva/ext_lld.c + * @file GPIO/hal_ext_lld.c * @brief Tiva EXT subsystem low level driver source. * * @addtogroup EXT diff --git a/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.h b/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.h index 08accb2..4631ce3 100644 --- a/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.h +++ b/os/hal/ports/TIVA/LLD/GPIO/hal_ext_lld.h @@ -15,7 +15,7 @@ */ /** - * @file Tiva/ext_lld.h + * @file GPIO/hal_ext_lld.h * @brief Tiva EXT subsystem low level driver header. * * @addtogroup EXT diff --git a/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.c b/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.c index 9adbf11..17b9c36 100644 --- a/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.c +++ b/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/pal_lld.c + * @file GPIO/hal_pal_lld.c * @brief TM4C123x/TM4C129x PAL subsystem low level driver. * * @addtogroup PAL diff --git a/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.h b/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.h index a2d84ac..f7a3637 100644 --- a/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.h +++ b/os/hal/ports/TIVA/LLD/GPIO/hal_pal_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/pal_lld.h + * @file GPIO/hal_pal_lld.h * @brief TM4C123x/TM4C129x PAL subsystem low level driver header. * * @addtogroup PAL diff --git a/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.c b/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.c index 60d2b82..17b6888 100644 --- a/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.c +++ b/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/gpt_lld.c + * @file GPTM/hal_gpt_lld.c * @brief TM4C123x/TM4C129x GPT subsystem low level driver source. * * @addtogroup GPT diff --git a/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.h b/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.h index 88a6809..cb563e5 100644 --- a/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.h +++ b/os/hal/ports/TIVA/LLD/GPTM/hal_gpt_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/gpt_lld.h + * @file GPTM/hal_gpt_lld.h * @brief TM4C123x/TM4C129x GPT subsystem low level driver header. * * @addtogroup GPT diff --git a/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.c b/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.c index d87652b..cbd6635 100644 --- a/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.c +++ b/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.c @@ -15,7 +15,7 @@ */ /** - * @file Tiva/LLD/st_lld.c + * @file GPTM/hal_st_lld.c * @brief ST Driver subsystem low level driver code. * * @addtogroup ST diff --git a/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.h b/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.h index cd076d6..0e58219 100644 --- a/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.h +++ b/os/hal/ports/TIVA/LLD/GPTM/hal_st_lld.h @@ -15,7 +15,7 @@ */ /** - * @file Tiva/LLD/st_lld.h + * @file GPTM/hal_st_lld.h * @brief ST Driver subsystem low level driver header. * @details This header is designed to be include-able without having to * include other files from the HAL. diff --git a/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.c b/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.c index cf70dca..bbd0a40 100644 --- a/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.c +++ b/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/i2c_lld.c + * @file I2C/hal_i2c_lld.c * @brief TM4C123x/TM4C129x I2C subsystem low level driver source. * * @addtogroup I2C diff --git a/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.h b/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.h index 4eabda8..6b00f56 100644 --- a/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.h +++ b/os/hal/ports/TIVA/LLD/I2C/hal_i2c_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/i2c_lld.h + * @file I2C/hal_i2c_lld.h * @brief TM4C123x/TM4C129x I2C subsystem low level driver header. * * @addtogroup I2C diff --git a/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.c b/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.c index 7c33a85..4109836 100644 --- a/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.c +++ b/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/mac_lld.c + * @file MAC/hal_mac_lld.c * @brief MAC Driver subsystem low level driver source. * * @addtogroup MAC diff --git a/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.h b/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.h index 98036bb..9e70493 100644 --- a/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.h +++ b/os/hal/ports/TIVA/LLD/MAC/hal_mac_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/mac_lld.h + * @file MAC/hal_mac_lld.h * @brief MAC Driver subsystem low level driver header. * * @addtogroup MAC diff --git a/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.c b/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.c index 964f45b..789a37a 100644 --- a/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.c +++ b/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/pwm_lld.c + * @file PWM/hal_pwm_lld.c * @brief TM4C123x/TM4C129x PWM subsystem low level driver. * * @addtogroup PWM diff --git a/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.h b/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.h index 7ddbd4d..e5b83e9 100644 --- a/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.h +++ b/os/hal/ports/TIVA/LLD/PWM/hal_pwm_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/pwm_lld.c + * @file PWM/hal_pwm_lld.c * @brief TM4C123x/TM4C129x PWM subsystem low level driver header. * * @addtogroup PWM diff --git a/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.c b/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.c index 42efca6..7c8e071 100644 --- a/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.c +++ b/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/spi_lld.c + * @file SSI/hal_spi_lld.c * @brief TM4C123x/TM4C129x SPI subsystem low level driver. * * @addtogroup SPI diff --git a/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.h b/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.h index dd49e84..4b88ca8 100644 --- a/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.h +++ b/os/hal/ports/TIVA/LLD/SSI/hal_spi_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/spi_lld.h + * @file SSI/hal_spi_lld.h * @brief TM4C123x/TM4C129x SPI subsystem low level driver. * * @addtogroup SPI diff --git a/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.c b/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.c index bc462d7..33887fc 100644 --- a/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.c +++ b/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.c @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/serial_lld.c + * @file UART/hal_serial_lld.c * @brief Tiva low level serial driver code. * * @addtogroup SERIAL diff --git a/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.h b/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.h index 256f8f4..669a7ac 100644 --- a/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.h +++ b/os/hal/ports/TIVA/LLD/UART/hal_serial_lld.h @@ -15,7 +15,7 @@ */ /** - * @file TIVA/LLD/serial_lld.h + * @file UART/hal_serial_lld.h * @brief Tiva low level serial driver header. * * @addtogroup SERIAL @@ -48,7 +48,6 @@ * @name Configuration options * @{ */ - /** * @brief UART0 driver enable switch. * @details If set to @p TRUE the support for UART0 is included. @@ -288,10 +287,7 @@ #if !defined(TIVA_SERIAL_UART7_OUT_BUF_SIZE) || defined(__DOXYGEN__) #define TIVA_SERIAL_UART7_OUT_BUF_SIZE SERIAL_BUFFERS_SIZE #endif - -/** - * @} - */ +/** @} */ /*===========================================================================*/ /* Derived constants and error checks. */ diff --git a/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.c b/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.c index ddd01e0..4533dcc 100644 --- a/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.c +++ b/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.c @@ -16,7 +16,7 @@ /** - * @file TIVA/wdg_lld.c + * @file WDT/hal_wdg_lld.c * @brief WDG Driver subsystem low level driver source. * * @addtogroup WDG diff --git a/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.h b/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.h index 77badb3..3a833a1 100644 --- a/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.h +++ b/os/hal/ports/TIVA/LLD/WDT/hal_wdg_lld.h @@ -16,7 +16,7 @@ /** - * @file TIVA/wdg_lld.h + * @file WDT/hal_wdg_lld.h * @brief WDG Driver subsystem low level driver header. * * @addtogroup WDG diff --git a/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.c b/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.c index bb379cb..1e78bcd 100644 --- a/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.c +++ b/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.c @@ -14,6 +14,14 @@ limitations under the License. */ +/** + * @file uDMA/tiva_udma.c + * @brief DMA helper driver code. + * + * @addtogroup TIVA_DMA + * @{ + */ + #include "hal.h" /* The following macro is only defined if some driver requiring DMA services @@ -139,3 +147,5 @@ void udmaChannelRelease(uint8_t dmach) } #endif + +/** @} */ diff --git a/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.h b/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.h index 0157277..9b7d255 100644 --- a/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.h +++ b/os/hal/ports/TIVA/LLD/uDMA/tiva_udma.h @@ -14,6 +14,14 @@ limitations under the License. */ +/** + * @file uDMA/tiva_udma.h + * @brief DMA helper driver header. + * + * @addtogroup TIVA_DMA + * @{ + */ + #ifndef TIVA_UDMA_H_ #define TIVA_UDMA_H_ @@ -150,3 +158,5 @@ extern "C" { #endif #endif /* TIVA_UDMA_H_ */ + +/** @} */ -- cgit v1.2.3