Skip to content

Commit 7f97818

Browse files
charleskeepaxbroonie
authored andcommitted
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 <[email protected]> Link: https://patch.msgid.link/[email protected] Signed-off-by: Mark Brown <[email protected]>
1 parent 534bfb3 commit 7f97818

File tree

1 file changed

+16
-13
lines changed

1 file changed

+16
-13
lines changed

sound/soc/soc-ops.c

Lines changed: 16 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -846,9 +846,10 @@ EXPORT_SYMBOL_GPL(snd_soc_bytes_tlv_callback);
846846
* @kcontrol: mreg control
847847
* @uinfo: control element information
848848
*
849-
* Callback to provide information of a control that can
850-
* span multiple codec registers which together
851-
* forms a single signed value in a MSB/LSB manner.
849+
* Callback to provide information of a control that can span multiple
850+
* codec registers which together forms a single signed value. Note
851+
* that unlike the non-xr variant of sx controls these may or may not
852+
* include the sign bit, depending on nbits, and there is no shift.
852853
*
853854
* Returns 0 for success.
854855
*/
@@ -872,11 +873,12 @@ EXPORT_SYMBOL_GPL(snd_soc_info_xr_sx);
872873
* @kcontrol: mreg control
873874
* @ucontrol: control element information
874875
*
875-
* Callback to get the value of a control that can span
876-
* multiple codec registers which together forms a single
877-
* signed value in a MSB/LSB manner. The control supports
878-
* specifying total no of bits used to allow for bitfields
879-
* across the multiple codec registers.
876+
* Callback to get the value of a control that can span multiple codec
877+
* registers which together forms a single signed value. The control
878+
* supports specifying total no of bits used to allow for bitfields
879+
* across the multiple codec registers. Note that unlike the non-xr
880+
* variant of sx controls these may or may not include the sign bit,
881+
* depending on nbits, and there is no shift.
880882
*
881883
* Returns 0 for success.
882884
*/
@@ -918,11 +920,12 @@ EXPORT_SYMBOL_GPL(snd_soc_get_xr_sx);
918920
* @kcontrol: mreg control
919921
* @ucontrol: control element information
920922
*
921-
* Callback to set the value of a control that can span
922-
* multiple codec registers which together forms a single
923-
* signed value in a MSB/LSB manner. The control supports
924-
* specifying total no of bits used to allow for bitfields
925-
* across the multiple codec registers.
923+
* Callback to set the value of a control that can span multiple codec
924+
* registers which together forms a single signed value. The control
925+
* supports specifying total no of bits used to allow for bitfields
926+
* across the multiple codec registers. Note that unlike the non-xr
927+
* variant of sx controls these may or may not include the sign bit,
928+
* depending on nbits, and there is no shift.
926929
*
927930
* Returns 0 for success.
928931
*/

0 commit comments

Comments
 (0)