ASoC: ops: Update comments for xr_sx control helpers

Update the comments for the xr_sx control helper functions to better
clarify the difference between these and the normal sx helpers.

Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Link: https://patch.msgid.link/20250318171459.3203730-4-ckeepax@opensource.cirrus.com
Signed-off-by: Mark Brown <broonie@kernel.org>
This commit is contained in:
Charles Keepax 2025-03-18 17:14:47 +00:00 committed by Mark Brown
parent 534bfb330b
commit 7f97818067
No known key found for this signature in database
GPG Key ID: 24D68B725D5487D0

View File

@ -846,9 +846,10 @@ EXPORT_SYMBOL_GPL(snd_soc_bytes_tlv_callback);
* @kcontrol: mreg control
* @uinfo: control element information
*
* Callback to provide information of a control that can
* span multiple codec registers which together
* forms a single signed value in a MSB/LSB manner.
* Callback to provide information of a control that can span multiple
* codec registers which together forms a single signed value. Note
* that unlike the non-xr variant of sx controls these may or may not
* include the sign bit, depending on nbits, and there is no shift.
*
* Returns 0 for success.
*/
@ -872,11 +873,12 @@ EXPORT_SYMBOL_GPL(snd_soc_info_xr_sx);
* @kcontrol: mreg control
* @ucontrol: control element information
*
* Callback to get the value of a control that can span
* multiple codec registers which together forms a single
* signed value in a MSB/LSB manner. The control supports
* specifying total no of bits used to allow for bitfields
* across the multiple codec registers.
* Callback to get the value of a control that can span multiple codec
* registers which together forms a single signed value. The control
* supports specifying total no of bits used to allow for bitfields
* across the multiple codec registers. Note that unlike the non-xr
* variant of sx controls these may or may not include the sign bit,
* depending on nbits, and there is no shift.
*
* Returns 0 for success.
*/
@ -918,11 +920,12 @@ EXPORT_SYMBOL_GPL(snd_soc_get_xr_sx);
* @kcontrol: mreg control
* @ucontrol: control element information
*
* Callback to set the value of a control that can span
* multiple codec registers which together forms a single
* signed value in a MSB/LSB manner. The control supports
* specifying total no of bits used to allow for bitfields
* across the multiple codec registers.
* Callback to set the value of a control that can span multiple codec
* registers which together forms a single signed value. The control
* supports specifying total no of bits used to allow for bitfields
* across the multiple codec registers. Note that unlike the non-xr
* variant of sx controls these may or may not include the sign bit,
* depending on nbits, and there is no shift.
*
* Returns 0 for success.
*/