leandrof/linux
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

ASoC: fsl: fsl_esai: fix kernel-doc

Browse Source 
Fix W=1 warnings. Fix kernel-doc syntax and add missing parameters.

Signed-off-by: Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Acked-by: Nicolin Chen <nicoleotsuka@gmail.com>
Link: https://lore.kernel.org/r/20200702192141.168018-7-pierre-louis.bossart@linux.intel.com
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Pierre-Louis Bossart 2020-07-02 14:21:41 -05:00 committed by Mark Brown
parent 4674bf0622
commit 3bae1719b3
No known key found for this signature in database
GPG Key ID: 24D68B725D5487D0
1 changed files with 18 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
sound/soc/fsl/fsl_esai.c
View File

@ -22,8 +22,7 @@
SNDRV_PCM_FMTBIT_S24_LE) SNDRV_PCM_FMTBIT_S24_LE)
/** /**
* fsl_esai_soc_data: soc specific data * struct fsl_esai_soc_data - soc specific data
*
* @imx: for imx platform * @imx: for imx platform
* @reset_at_xrun: flags for enable reset operaton * @reset_at_xrun: flags for enable reset operaton
*/ */
@ -33,8 +32,7 @@ struct fsl_esai_soc_data {
}; };
/** /**
* fsl_esai: ESAI private data * struct fsl_esai - ESAI private data
*
* @dma_params_rx: DMA parameters for receive channel * @dma_params_rx: DMA parameters for receive channel
* @dma_params_tx: DMA parameters for transmit channel * @dma_params_tx: DMA parameters for transmit channel
* @pdev: platform device pointer * @pdev: platform device pointer
@ -49,6 +47,8 @@ struct fsl_esai_soc_data {
* @fifo_depth: depth of tx/rx FIFO * @fifo_depth: depth of tx/rx FIFO
* @slot_width: width of each DAI slot * @slot_width: width of each DAI slot
* @slots: number of slots * @slots: number of slots
* @tx_mask: slot mask for TX
* @rx_mask: slot mask for RX
* @channels: channel num for tx or rx * @channels: channel num for tx or rx
* @hck_rate: clock rate of desired HCKx clock * @hck_rate: clock rate of desired HCKx clock
* @sck_rate: clock rate of desired SCKx clock * @sck_rate: clock rate of desired SCKx clock
@ -157,13 +157,15 @@ static irqreturn_t esai_isr(int irq, void *devid)
} }
/** /**
* This function is used to calculate the divisors of psr, pm, fp and it is * fsl_esai_divisor_cal - This function is used to calculate the
* supposed to be called in set_dai_sysclk() and set_bclk(). * divisors of psr, pm, fp and it is supposed to be called in
* set_dai_sysclk() and set_bclk().
* *
* @dai: pointer to DAI
* @tx: current setting is for playback or capture
* @ratio: desired overall ratio for the paticipating dividers * @ratio: desired overall ratio for the paticipating dividers
* @usefp: for HCK setting, there is no need to set fp divider * @usefp: for HCK setting, there is no need to set fp divider
* @fp: bypass other dividers by setting fp directly if fp != 0 * @fp: bypass other dividers by setting fp directly if fp != 0
* @tx: current setting is for playback or capture
*/ */
static int fsl_esai_divisor_cal(struct snd_soc_dai *dai, bool tx, u32 ratio, static int fsl_esai_divisor_cal(struct snd_soc_dai *dai, bool tx, u32 ratio,
bool usefp, u32 fp) bool usefp, u32 fp)
@ -250,13 +252,12 @@ out_fp:
} }
/** /**
* This function mainly configures the clock frequency of MCLK (HCKT/HCKR) * fsl_esai_set_dai_sysclk - configure the clock frequency of MCLK (HCKT/HCKR)
* * @dai: pointer to DAI
* @Parameters: * @clk_id: The clock source of HCKT/HCKR
* clk_id: The clock source of HCKT/HCKR
* (Input from outside; output from inside, FSYS or EXTAL) * (Input from outside; output from inside, FSYS or EXTAL)
* freq: The required clock rate of HCKT/HCKR * @freq: The required clock rate of HCKT/HCKR
* dir: The clock direction of HCKT/HCKR * @dir: The clock direction of HCKT/HCKR
* *
* Note: If the direction is input, we do not care about clk_id. * Note: If the direction is input, we do not care about clk_id.
*/ */
@ -358,7 +359,10 @@ out:
} }
/** /**
* This function configures the related dividers according to the bclk rate * fsl_esai_set_bclk - configure the related dividers according to the bclk rate
* @dai: pointer to DAI
* @tx: direction boolean
* @freq: bclk freq
*/ */
static int fsl_esai_set_bclk(struct snd_soc_dai *dai, bool tx, u32 freq) static int fsl_esai_set_bclk(struct snd_soc_dai *dai, bool tx, u32 freq)
{ {