Unverified Commit 4674bf06 authored by Pierre-Louis Bossart's avatar Pierre-Louis Bossart Committed by Mark Brown
Browse files

ASoC: fsl: fsl_asrc: fix kernel-doc 



Fix W=1 warnings. fix kernel doc and describe arguments.

Signed-off-by: default avatarPierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
Acked-by: default avatarNicolin Chen <nicoleotsuka@gmail.com>
Link: https://lore.kernel.org/r/20200702192141.168018-6-pierre-louis.bossart@linux.intel.com


Signed-off-by: default avatarMark Brown <broonie@kernel.org>
parent 28fd6ff1

sound/soc/fsl/fsl_asrc.c

+39 −18
Original line number Diff line number Diff line
@@ -37,7 +37,7 @@ static struct snd_pcm_hw_constraint_list fsl_asrc_rate_constraints = { 
	.list = supported_asrc_rate,

};



/**

/*

 * The following tables map the relationship between asrc_inclk/asrc_outclk in

 * fsl_asrc.h and the registers of ASRCSR

 */
@@ -68,7 +68,7 @@ static unsigned char output_clk_map_imx53[ASRC_CLK_MAP_LEN] = { 
	0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7, 0x7,

};



/**

/*

 * i.MX8QM/i.MX8QXP uses the same map for input and output.

 * clk_map_imx8qm[0] is for i.MX8QM asrc0

 * clk_map_imx8qm[1] is for i.MX8QM asrc1
@@ -102,16 +102,17 @@ static unsigned char clk_map_imx8qxp[2][ASRC_CLK_MAP_LEN] = { 
};



/**

 * Select the pre-processing and post-processing options

 * fsl_asrc_sel_proc - Select the pre-processing and post-processing options

 * @inrate: input sample rate

 * @outrate: output sample rate

 * @pre_proc: return value for pre-processing option

 * @post_proc: return value for post-processing option

 *

 * Make sure to exclude following unsupported cases before

 * calling this function:

 * 1) inrate > 8.125 * outrate

 * 2) inrate > 16.125 * outrate

 *

 * inrate: input sample rate

 * outrate: output sample rate

 * pre_proc: return value for pre-processing option

 * post_proc: return value for post-processing option

 */

static void fsl_asrc_sel_proc(int inrate, int outrate,

			     int *pre_proc, int *post_proc)
@@ -148,7 +149,9 @@ static void fsl_asrc_sel_proc(int inrate, int outrate, 
}



/**

 * Request ASRC pair

 * fsl_asrc_request_pair - Request ASRC pair

 * @channels: number of channels

 * @pair: pointer to pair

 *

 * It assigns pair by the order of A->C->B because allocation of pair B,

 * within range [ANCA, ANCA+ANCB-1], depends on the channels of pair A
@@ -193,7 +196,8 @@ static int fsl_asrc_request_pair(int channels, struct fsl_asrc_pair *pair) 
}



/**

 * Release ASRC pair

 * fsl_asrc_release_pair - Release ASRC pair

 * @pair: pair to release

 *

 * It clears the resource from asrc and releases the occupied channels.

 */
@@ -217,7 +221,10 @@ static void fsl_asrc_release_pair(struct fsl_asrc_pair *pair) 
}



/**

 * Configure input and output thresholds

 * fsl_asrc_set_watermarks- configure input and output thresholds

 * @pair: pointer to pair

 * @in: input threshold

 * @out: output threshold

 */

static void fsl_asrc_set_watermarks(struct fsl_asrc_pair *pair, u32 in, u32 out)

{
@@ -234,7 +241,9 @@ static void fsl_asrc_set_watermarks(struct fsl_asrc_pair *pair, u32 in, u32 out) 
}



/**

 * Calculate the total divisor between asrck clock rate and sample rate

 * fsl_asrc_cal_asrck_divisor - Calculate the total divisor between asrck clock rate and sample rate

 * @pair: pointer to pair

 * @div: divider

 *

 * It follows the formula clk_rate = samplerate * (2 ^ prescaler) * divider

 */
@@ -250,7 +259,10 @@ static u32 fsl_asrc_cal_asrck_divisor(struct fsl_asrc_pair *pair, u32 div) 
}



/**

 * Calculate and set the ratio for Ideal Ratio mode only

 * fsl_asrc_set_ideal_ratio - Calculate and set the ratio for Ideal Ratio mode only

 * @pair: pointer to pair

 * @inrate: input rate

 * @outrate: output rate

 *

 * The ratio is a 32-bit fixed point value with 26 fractional bits.

 */
@@ -293,7 +305,9 @@ static int fsl_asrc_set_ideal_ratio(struct fsl_asrc_pair *pair, 
}



/**

 * Configure the assigned ASRC pair

 * fsl_asrc_config_pair - Configure the assigned ASRC pair

 * @pair: pointer to pair

 * @use_ideal_rate: boolean configuration

 *

 * It configures those ASRC registers according to a configuration instance

 * of struct asrc_config which includes in/output sample rate, width, channel
@@ -508,7 +522,8 @@ static int fsl_asrc_config_pair(struct fsl_asrc_pair *pair, bool use_ideal_rate) 
}



/**

 * Start the assigned ASRC pair

 * fsl_asrc_start_pair - Start the assigned ASRC pair

 * @pair: pointer to pair

 *

 * It enables the assigned pair and makes it stopped at the stall level.

 */
@@ -539,7 +554,8 @@ static void fsl_asrc_start_pair(struct fsl_asrc_pair *pair) 
}



/**

 * Stop the assigned ASRC pair

 * fsl_asrc_stop_pair - Stop the assigned ASRC pair

 * @pair: pointer to pair

 */

static void fsl_asrc_stop_pair(struct fsl_asrc_pair *pair)

{
@@ -552,7 +568,9 @@ static void fsl_asrc_stop_pair(struct fsl_asrc_pair *pair) 
}



/**

 * Get DMA channel according to the pair and direction.

 * fsl_asrc_get_dma_channel- Get DMA channel according to the pair and direction.

 * @pair: pointer to pair

 * @dir: DMA direction

 */

static struct dma_chan *fsl_asrc_get_dma_channel(struct fsl_asrc_pair *pair,

						 bool dir)
@@ -896,7 +914,8 @@ static const struct regmap_config fsl_asrc_regmap_config = { 
};



/**

 * Initialize ASRC registers with a default configurations

 * fsl_asrc_init - Initialize ASRC registers with a default configuration

 * @asrc: ASRC context

 */

static int fsl_asrc_init(struct fsl_asrc *asrc)

{
@@ -930,7 +949,9 @@ static int fsl_asrc_init(struct fsl_asrc *asrc) 
}



/**

 * Interrupt handler for ASRC

 * fsl_asrc_isr- Interrupt handler for ASRC

 * @irq: irq number

 * @dev_id: ASRC context

 */

static irqreturn_t fsl_asrc_isr(int irq, void *dev_id)

{