From: bui duc phuc <[email protected]> The summary line of fsl_sai_dir_is_synced() reads as if @dir follows the clocks of the opposite stream, while the function returns true when @dir provides the clocks and the opposite stream is synchronous.
Reword the description to match the behavior and document the return value. No functional change. Signed-off-by: bui duc phuc <[email protected]> --- sound/soc/fsl/fsl_sai.c | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/sound/soc/fsl/fsl_sai.c b/sound/soc/fsl/fsl_sai.c index f75a1d61d7b7..25243b6859d6 100644 --- a/sound/soc/fsl/fsl_sai.c +++ b/sound/soc/fsl/fsl_sai.c @@ -88,14 +88,16 @@ static const struct snd_kcontrol_new fsl_sai_timestamp_ctrls[] = { }; /** - * fsl_sai_dir_is_synced - Check if stream is synced by the opposite stream - * - * SAI supports synchronous mode using bit/frame clocks of either Transmitter's - * or Receiver's for both streams. This function is used to check if clocks of - * the stream's are synced by the opposite stream. - * + * fsl_sai_dir_is_synced - Check if the opposite stream is synced to @dir * @sai: SAI context - * @dir: stream direction + * @dir: stream direction, TX or RX + * + * SAI supports synchronous mode, where one direction uses the bit clock and + * frame sync of the other. This function checks whether @dir provides the + * clocks, i.e. @dir runs in asynchronous mode while the opposite direction + * runs in synchronous mode. + * + * Return: true if the opposite direction uses the clocks of @dir. */ static inline bool fsl_sai_dir_is_synced(struct fsl_sai *sai, int dir) { -- 2.43.0
