michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: i2s/i2s_litex: remove @return doc for void functions

Browse source 
For functions returning nothing, there is no need to document
with @return, as Doxgen complains about "documented empty
return type of ...".

Signed-off-by: Daniel Leung <daniel.leung@intel.com>
This commit is contained in:
Daniel Leung 2022-01-06 16:50:51 -08:00 • committed by Anas Nashif
commit bae4847b51
1 changed files with 4 additions and 18 deletions
Download patch file Download diff file Expand all files Collapse all files

22
drivers/i2s/i2s_litex.c
View file

@ -26,8 +26,6 @@ LOG_MODULE_REGISTER(i2s_litex);
* @brief Enable i2s device * @brief Enable i2s device
* *
* @param reg base register of device * @param reg base register of device
*
* @return N/A
*/ */
static void i2s_enable(uintptr_t reg) static void i2s_enable(uintptr_t reg)
{ {
@ -40,8 +38,6 @@ static void i2s_enable(uintptr_t reg)
* @brief Disable i2s device * @brief Disable i2s device
* *
* @param reg base register of device * @param reg base register of device
*
* @return N/A
*/ */
static void i2s_disable(uintptr_t reg) static void i2s_disable(uintptr_t reg)
{ {
@ -54,8 +50,6 @@ static void i2s_disable(uintptr_t reg)
* @brief Reset i2s fifo * @brief Reset i2s fifo
* *
* @param reg base register of device * @param reg base register of device
*
* @return N/A
*/ */
static void i2s_reset_fifo(uintptr_t reg) static void i2s_reset_fifo(uintptr_t reg)
{ {
@ -120,8 +114,6 @@ static uint32_t i2s_get_audio_freq(uintptr_t reg)
* *
* @param reg base register of device * @param reg base register of device
* @param irq_type irq type to be enabled one of I2S_EV_READY or I2S_EV_ERROR * @param irq_type irq type to be enabled one of I2S_EV_READY or I2S_EV_ERROR
*
* @return N/A
*/ */
static void i2s_irq_enable(uintptr_t reg, int irq_type) static void i2s_irq_enable(uintptr_t reg, int irq_type)
{ {
@ -137,8 +129,6 @@ static void i2s_irq_enable(uintptr_t reg, int irq_type)
* *
* @param reg base register of device * @param reg base register of device
* @param irq_type irq type to be disabled one of I2S_EV_READY or I2S_EV_ERROR * @param irq_type irq type to be disabled one of I2S_EV_READY or I2S_EV_ERROR
*
* @return N/A
*/ */
static void i2s_irq_disable(uintptr_t reg, int irq_type) static void i2s_irq_disable(uintptr_t reg, int irq_type)
{ {
@ -153,8 +143,6 @@ static void i2s_irq_disable(uintptr_t reg, int irq_type)
* @brief Clear all pending irqs * @brief Clear all pending irqs
* *
* @param reg base register of device * @param reg base register of device
*
* @return N/A
*/ */
static void i2s_clear_pending_irq(uintptr_t reg) static void i2s_clear_pending_irq(uintptr_t reg)
{ {
@ -165,15 +153,14 @@ static void i2s_clear_pending_irq(uintptr_t reg)
/** /**
* @brief fast data copy function, * @brief fast data copy function,
* each operation copies 32 bit data chunks *
* Each operation copies 32 bit data chunks
* This function copies data from fifo into user buffer * This function copies data from fifo into user buffer
* *
* @param dst memory destination where fifo data will be copied to * @param dst memory destination where fifo data will be copied to
* @param size amount of data to be copied * @param size amount of data to be copied
* @param sample_width width of signle sample in bits * @param sample_width width of signle sample in bits
* @param channels number of received channels * @param channels number of received channels
*
* @return N/A
*/ */
static void i2s_copy_from_fifo(uint8_t *dst, size_t size, int sample_width, static void i2s_copy_from_fifo(uint8_t *dst, size_t size, int sample_width,
int channels) int channels)
@ -219,15 +206,14 @@ static void i2s_copy_from_fifo(uint8_t *dst, size_t size, int sample_width,
/** /**
* @brief fast data copy function, * @brief fast data copy function,
* each operation copies 32 bit data chunks *
* Each operation copies 32 bit data chunks
* This function copies data from user buffer into fifo * This function copies data from user buffer into fifo
* *
* @param src memory from which data will be copied to fifo * @param src memory from which data will be copied to fifo
* @param size amount of data to be copied in bytes * @param size amount of data to be copied in bytes
* @param sample_width width of signle sample in bits * @param sample_width width of signle sample in bits
* @param channels number of received channels * @param channels number of received channels
*
* @return N/A
*/ */
static void i2s_copy_to_fifo(uint8_t *src, size_t size, int sample_width, static void i2s_copy_to_fifo(uint8_t *src, size_t size, int sample_width,
int channels) int channels)