[ALSA] Fix DocBook warnings (df8db936) · Commits · e / devices / android_kernel_xiaomi_nabu

sound/core/pcm_lib.c

+113 −4

Original line number	Original line	Diff line number	Diff line
	@@ -524,6 +524,9 @@ void snd_interval_mul(const snd_interval_t a, const snd_interval_t b, snd_inte

	/**		/**
	* snd_interval_div - refine the interval value with division		* snd_interval_div - refine the interval value with division
			* @a: dividend
			* @b: divisor
			* @c: quotient
	*		*
	* c = a / b		* c = a / b
	*		*
	@@ -555,6 +558,10 @@ void snd_interval_div(const snd_interval_t a, const snd_interval_t b, snd_inte

	/**		/**
	* snd_interval_muldivk - refine the interval value		* snd_interval_muldivk - refine the interval value
			* @a: dividend 1
			* @b: dividend 2
			* @k: divisor (as integer)
			* @c: result
	*		*
	* c = a * b / k		* c = a * b / k
	*		*
	@@ -582,6 +589,10 @@ void snd_interval_muldivk(const snd_interval_t a, const snd_interval_t b,

	/**		/**
	* snd_interval_mulkdiv - refine the interval value		* snd_interval_mulkdiv - refine the interval value
			* @a: dividend 1
			* @k: dividend 2 (as integer)
			* @b: divisor
			* @c: result
	*		*
	* c = a * k / b		* c = a * k / b
	*		*
	@@ -618,6 +629,11 @@ void snd_interval_mulkdiv(const snd_interval_t *a, unsigned int k,

	/**		/**
	* snd_interval_ratnum - refine the interval value		* snd_interval_ratnum - refine the interval value
			* @i: interval to refine
			* @rats_count: number of ratnum_t
			* @rats: ratnum_t array
			* @nump: pointer to store the resultant numerator
			* @denp: pointer to store the resultant denominator
	*		*
	* Returns non-zero if the value is changed, zero if not changed.		* Returns non-zero if the value is changed, zero if not changed.
	*/		*/
	@@ -715,6 +731,11 @@ int snd_interval_ratnum(snd_interval_t *i,

	/**		/**
	* snd_interval_ratden - refine the interval value		* snd_interval_ratden - refine the interval value
			* @i: interval to refine
			* @rats_count: number of ratden_t
			* @rats: ratden_t array
			* @nump: pointer to store the resultant numerator
			* @denp: pointer to store the resultant denominator
	*		*
	* Returns non-zero if the value is changed, zero if not changed.		* Returns non-zero if the value is changed, zero if not changed.
	*/		*/
	@@ -936,6 +957,11 @@ int snd_pcm_hw_rule_add(snd_pcm_runtime_t *runtime, unsigned int cond,

	/**		/**
	* snd_pcm_hw_constraint_mask		* snd_pcm_hw_constraint_mask
			* @runtime: PCM runtime instance
			* @var: hw_params variable to apply the mask
			* @mask: the bitmap mask
			*
			* Apply the constraint of the given bitmap mask to a mask parameter.
	*/		*/
	int snd_pcm_hw_constraint_mask(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,		int snd_pcm_hw_constraint_mask(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
	u_int32_t mask)		u_int32_t mask)
	@@ -951,6 +977,11 @@ int snd_pcm_hw_constraint_mask(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t va

	/**		/**
	* snd_pcm_hw_constraint_mask64		* snd_pcm_hw_constraint_mask64
			* @runtime: PCM runtime instance
			* @var: hw_params variable to apply the mask
			* @mask: the 64bit bitmap mask
			*
			* Apply the constraint of the given bitmap mask to a mask parameter.
	*/		*/
	int snd_pcm_hw_constraint_mask64(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,		int snd_pcm_hw_constraint_mask64(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
	u_int64_t mask)		u_int64_t mask)
	@@ -967,6 +998,10 @@ int snd_pcm_hw_constraint_mask64(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t

	/**		/**
	* snd_pcm_hw_constraint_integer		* snd_pcm_hw_constraint_integer
			* @runtime: PCM runtime instance
			* @var: hw_params variable to apply the integer constraint
			*
			* Apply the constraint of integer to an interval parameter.
	*/		*/
	int snd_pcm_hw_constraint_integer(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var)		int snd_pcm_hw_constraint_integer(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var)
	{		{
	@@ -976,6 +1011,12 @@ int snd_pcm_hw_constraint_integer(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t

	/**		/**
	* snd_pcm_hw_constraint_minmax		* snd_pcm_hw_constraint_minmax
			* @runtime: PCM runtime instance
			* @var: hw_params variable to apply the range
			* @min: the minimal value
			* @max: the maximal value
			*
			* Apply the min/max range constraint to an interval parameter.
	*/		*/
	int snd_pcm_hw_constraint_minmax(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,		int snd_pcm_hw_constraint_minmax(snd_pcm_runtime_t *runtime, snd_pcm_hw_param_t var,
	unsigned int min, unsigned int max)		unsigned int min, unsigned int max)
	@@ -999,6 +1040,12 @@ static int snd_pcm_hw_rule_list(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_constraint_list		* snd_pcm_hw_constraint_list
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @var: hw_params variable to apply the list constraint
			* @l: list
			*
			* Apply the list of constraints to an interval parameter.
	*/		*/
	int snd_pcm_hw_constraint_list(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_list(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1027,6 +1074,10 @@ static int snd_pcm_hw_rule_ratnums(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_constraint_ratnums		* snd_pcm_hw_constraint_ratnums
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @var: hw_params variable to apply the ratnums constraint
			* @r: ratnums_t constriants
	*/		*/
	int snd_pcm_hw_constraint_ratnums(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_ratnums(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1054,6 +1105,10 @@ static int snd_pcm_hw_rule_ratdens(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_constraint_ratdens		* snd_pcm_hw_constraint_ratdens
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @var: hw_params variable to apply the ratdens constraint
			* @r: ratdens_t constriants
	*/		*/
	int snd_pcm_hw_constraint_ratdens(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_ratdens(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1079,6 +1134,10 @@ static int snd_pcm_hw_rule_msbits(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_constraint_msbits		* snd_pcm_hw_constraint_msbits
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @width: sample bits width
			* @msbits: msbits width
	*/		*/
	int snd_pcm_hw_constraint_msbits(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_msbits(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1101,6 +1160,10 @@ static int snd_pcm_hw_rule_step(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_constraint_step		* snd_pcm_hw_constraint_step
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @var: hw_params variable to apply the step constraint
			* @step: step size
	*/		*/
	int snd_pcm_hw_constraint_step(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_step(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1126,6 +1189,9 @@ static int snd_pcm_hw_rule_pow2(snd_pcm_hw_params_t params, snd_pcm_hw_rule_t

	/**		/**
	* snd_pcm_hw_constraint_pow2		* snd_pcm_hw_constraint_pow2
			* @runtime: PCM runtime instance
			* @cond: condition bits
			* @var: hw_params variable to apply the power-of-2 constraint
	*/		*/
	int snd_pcm_hw_constraint_pow2(snd_pcm_runtime_t *runtime,		int snd_pcm_hw_constraint_pow2(snd_pcm_runtime_t *runtime,
	unsigned int cond,		unsigned int cond,
	@@ -1162,7 +1228,7 @@ static void _snd_pcm_hw_param_any(snd_pcm_hw_params_t *params,
	}		}

	#if 0		#if 0
	/**		/*
	* snd_pcm_hw_param_any		* snd_pcm_hw_param_any
	*/		*/
	int snd_pcm_hw_param_any(snd_pcm_t pcm, snd_pcm_hw_params_t params,		int snd_pcm_hw_param_any(snd_pcm_t pcm, snd_pcm_hw_params_t params,
	@@ -1185,7 +1251,7 @@ void _snd_pcm_hw_params_any(snd_pcm_hw_params_t *params)
	}		}

	#if 0		#if 0
	/**		/*
	* snd_pcm_hw_params_any		* snd_pcm_hw_params_any
	*		*
	* Fill PARAMS with full configuration space boundaries		* Fill PARAMS with full configuration space boundaries
	@@ -1199,6 +1265,9 @@ int snd_pcm_hw_params_any(snd_pcm_t pcm, snd_pcm_hw_params_t params)

	/**		/**
	* snd_pcm_hw_param_value		* snd_pcm_hw_param_value
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Return the value for field PAR if it's fixed in configuration space		* Return the value for field PAR if it's fixed in configuration space
	* defined by PARAMS. Return -EINVAL otherwise		* defined by PARAMS. Return -EINVAL otherwise
	@@ -1228,6 +1297,9 @@ static int snd_pcm_hw_param_value(const snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_value_min		* snd_pcm_hw_param_value_min
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Return the minimum value for field PAR.		* Return the minimum value for field PAR.
	*/		*/
	@@ -1251,6 +1323,9 @@ unsigned int snd_pcm_hw_param_value_min(const snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_value_max		* snd_pcm_hw_param_value_max
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Return the maximum value for field PAR.		* Return the maximum value for field PAR.
	*/		*/
	@@ -1302,7 +1377,7 @@ int _snd_pcm_hw_param_setinteger(snd_pcm_hw_params_t *params,
	}		}

	#if 0		#if 0
	/**		/*
	* snd_pcm_hw_param_setinteger		* snd_pcm_hw_param_setinteger
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	@@ -1347,6 +1422,10 @@ static int _snd_pcm_hw_param_first(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_first		* snd_pcm_hw_param_first
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	* values > minimum. Reduce configuration space accordingly.		* values > minimum. Reduce configuration space accordingly.
	@@ -1388,6 +1467,10 @@ static int _snd_pcm_hw_param_last(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_last		* snd_pcm_hw_param_last
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	* values < maximum. Reduce configuration space accordingly.		* values < maximum. Reduce configuration space accordingly.
	@@ -1439,6 +1522,11 @@ int _snd_pcm_hw_param_min(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_min		* snd_pcm_hw_param_min
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @val: minimal value
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	* values < VAL. Reduce configuration space accordingly.		* values < VAL. Reduce configuration space accordingly.
	@@ -1494,6 +1582,11 @@ static int _snd_pcm_hw_param_max(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_max		* snd_pcm_hw_param_max
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @val: maximal value
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	* values >= VAL + 1. Reduce configuration space accordingly.		* values >= VAL + 1. Reduce configuration space accordingly.
	@@ -1565,6 +1658,11 @@ int _snd_pcm_hw_param_set(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_set		* snd_pcm_hw_param_set
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @val: value to set
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all		* Inside configuration space defined by PARAMS remove from PAR all
	* values != VAL. Reduce configuration space accordingly.		* values != VAL. Reduce configuration space accordingly.
	@@ -1599,6 +1697,10 @@ static int _snd_pcm_hw_param_mask(snd_pcm_hw_params_t *params,

	/**		/**
	* snd_pcm_hw_param_mask		* snd_pcm_hw_param_mask
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @val: mask to apply
	*		*
	* Inside configuration space defined by PARAMS remove from PAR all values		* Inside configuration space defined by PARAMS remove from PAR all values
	* not contained in MASK. Reduce configuration space accordingly.		* not contained in MASK. Reduce configuration space accordingly.
	@@ -1671,6 +1773,11 @@ static int boundary_nearer(int min, int mindir,

	/**		/**
	* snd_pcm_hw_param_near		* snd_pcm_hw_param_near
			* @pcm: PCM instance
			* @params: the hw_params instance
			* @var: parameter to retrieve
			* @best: value to set
			* @dir: pointer to the direction (-1,0,1) or NULL
	*		*
	* Inside configuration space defined by PARAMS set PAR to the available value		* Inside configuration space defined by PARAMS set PAR to the available value
	* nearest to VAL. Reduce configuration space accordingly.		* nearest to VAL. Reduce configuration space accordingly.
	@@ -1747,6 +1854,8 @@ int snd_pcm_hw_param_near(snd_pcm_t pcm, snd_pcm_hw_params_t params,

	/**		/**
	* snd_pcm_hw_param_choose		* snd_pcm_hw_param_choose
			* @pcm: PCM instance
			* @params: the hw_params instance
	*		*
	* Choose one configuration from configuration space defined by PARAMS		* Choose one configuration from configuration space defined by PARAMS
	* The configuration chosen is that obtained fixing in this order:		* The configuration chosen is that obtained fixing in this order:

sound/core/pcm_memory.c

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -244,7 +244,7 @@ int snd_pcm_lib_preallocate_pages(snd_pcm_substream_t *substream,

	/**		/**
	* snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams)		* snd_pcm_lib_preallocate_pages_for_all - pre-allocation for continous memory type (all substreams)
	* @substream: the pcm substream instance		* @pcm: the pcm instance
	* @type: DMA type (SNDRV_DMA_TYPE_*)		* @type: DMA type (SNDRV_DMA_TYPE_*)
	* @data: DMA type dependant data		* @data: DMA type dependant data
	* @size: the requested pre-allocation size in bytes		* @size: the requested pre-allocation size in bytes

sound/core/pcm_native.c

+9 −0

Original line number	Original line	Diff line number	Diff line
	@@ -859,6 +859,7 @@ static struct action_ops snd_pcm_action_start = {

	/**		/**
	* snd_pcm_start		* snd_pcm_start
			* @substream: the PCM substream instance
	*		*
	* Start all linked streams.		* Start all linked streams.
	*/		*/
	@@ -908,6 +909,8 @@ static struct action_ops snd_pcm_action_stop = {

	/**		/**
	* snd_pcm_stop		* snd_pcm_stop
			* @substream: the PCM substream instance
			* @state: PCM state after stopping the stream
	*		*
	* Try to stop all running streams in the substream group.		* Try to stop all running streams in the substream group.
	* The state of each stream is changed to the given value after that unconditionally.		* The state of each stream is changed to the given value after that unconditionally.
	@@ -919,6 +922,7 @@ int snd_pcm_stop(snd_pcm_substream_t *substream, int state)

	/**		/**
	* snd_pcm_drain_done		* snd_pcm_drain_done
			* @substream: the PCM substream
	*		*
	* Stop the DMA only when the given stream is playback.		* Stop the DMA only when the given stream is playback.
	* The state is changed to SETUP.		* The state is changed to SETUP.
	@@ -1040,6 +1044,7 @@ static struct action_ops snd_pcm_action_suspend = {

	/**		/**
	* snd_pcm_suspend		* snd_pcm_suspend
			* @substream: the PCM substream
	*		*
	* Trigger SUSPEND to all linked streams.		* Trigger SUSPEND to all linked streams.
	* After this call, all streams are changed to SUSPENDED state.		* After this call, all streams are changed to SUSPENDED state.
	@@ -1057,6 +1062,7 @@ int snd_pcm_suspend(snd_pcm_substream_t *substream)

	/**		/**
	* snd_pcm_suspend_all		* snd_pcm_suspend_all
			* @pcm: the PCM instance
	*		*
	* Trigger SUSPEND to all substreams in the given pcm.		* Trigger SUSPEND to all substreams in the given pcm.
	* After this call, all streams are changed to SUSPENDED state.		* After this call, all streams are changed to SUSPENDED state.
	@@ -1272,6 +1278,9 @@ static struct action_ops snd_pcm_action_prepare = {

	/**		/**
	* snd_pcm_prepare		* snd_pcm_prepare
			* @substream: the PCM substream instance
			*
			* Prepare the PCM substream to be triggerable.
	*/		*/
	int snd_pcm_prepare(snd_pcm_substream_t *substream)		int snd_pcm_prepare(snd_pcm_substream_t *substream)
	{		{

sound/core/rawmidi.c

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -1109,7 +1109,7 @@ int snd_rawmidi_transmit_ack(snd_rawmidi_substream_t * substream, int count)
	/**		/**
	* snd_rawmidi_transmit - copy from the buffer to the device		* snd_rawmidi_transmit - copy from the buffer to the device
	* @substream: the rawmidi substream		* @substream: the rawmidi substream
	* @buf: the buffer pointer		* @buffer: the buffer pointer
	* @count: the data size to transfer		* @count: the data size to transfer
	*		*
	* Copies data from the buffer to the device and advances the pointer.		* Copies data from the buffer to the device and advances the pointer.