Unverified Commit b329b3d3 authored Nov 17, 2021 by Charles Keepax Committed by Mark Brown Nov 17, 2021

firmware: cs_dsp: Clarify some kernel doc comments

Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Link: https://lore.kernel.org/r/20211117132300.1290-8-ckeepax@opensource.cirrus.com

Signed-off-by: Mark Brown <broonie@kernel.org>

parent 86c60804

drivers/firmware/cirrus/cs_dsp.c

+2 −2

Original line number	Diff line number	Diff line
		@@ -746,7 +746,7 @@ static int cs_dsp_coeff_write_ctrl_raw(struct cs_dsp_coeff_ctl *ctl,
		* cs_dsp_coeff_write_ctrl() - Writes the given buffer to the given coefficient control
		* @ctl: pointer to coefficient control
		* @buf: the buffer to write to the given control
		* @len: the length of the buffer
		* @len: the length of the buffer in bytes
		*
		* Must be called with pwr_lock held.
		*
		@@ -808,7 +808,7 @@ static int cs_dsp_coeff_read_ctrl_raw(struct cs_dsp_coeff_ctl ctl, void buf, s
		* cs_dsp_coeff_read_ctrl() - Reads the given coefficient control into the given buffer
		* @ctl: pointer to coefficient control
		* @buf: the buffer to store to the given control
		* @len: the length of the buffer
		* @len: the length of the buffer in bytes
		*
		* Must be called with pwr_lock held.
		*

include/linux/firmware/cirrus/cs_dsp.h

+2 −2

Original line number	Diff line number	Diff line
		@@ -76,8 +76,8 @@ struct cs_dsp_alg_region {
		* @enabled: Flag indicating whether control is enabled
		* @list: List node for internal use
		* @cache: Cached value of the control
		* @offset: Offset of control within alg_region
		* @len: Length of the cached value
		* @offset: Offset of control within alg_region in words
		* @len: Length of the cached value in bytes
		* @set: Flag indicating the value has been written by the user
		* @flags: Bitfield of WMFW_CTL_FLAG_ control flags defined in wmfw.h
		* @type: One of the WMFW_CTL_TYPE_ control types defined in wmfw.h