ASoC: SDCA: Add comment for function reset polling

Add a comment to better explain the function reset polling rate.

Tested-by: Bard Liao <yung-chuan.liao@linux.intel.com>
Reviewed-by: Maciej Strozek <mstrozek@opensource.cirrus.com>
Reviewed-by: Peter Ujfalusi <peter.ujfalusi@linux.intel.com>
Tested-by: Richard Fitzgerald <rf@opensource.cirrus.com>
Signed-off-by: Charles Keepax <ckeepax@opensource.cirrus.com>
Link: https://patch.msgid.link/20251120153023.2105663-6-ckeepax@opensource.cirrus.com
Reviewed-by: Vinod Koul <vkoul@kernel.org>
Signed-off-by: Mark Brown <broonie@kernel.org>

diff --git a/sound/soc/sdca/sdca_fdl.c b/sound/soc/sdca/sdca_fdl.c
index 6568afacdf1a1d326a6a79b484651429d08d4023..3180ebd07c4007adc070dacdc39344d3db7e7697 100644 (file)
--- a/sound/soc/sdca/sdca_fdl.c
+++ b/sound/soc/sdca/sdca_fdl.c
@@ -51,6 +51,10 @@ int sdca_reset_function(struct device *dev, struct sdca_function_data *function,
                return -EINVAL;
        }
 
+       /*
+        * Poll up to 16 times but no more than once per ms, these are just
+        * arbitrarily selected values, so may be fine tuned in future.
+        */
        poll_us = umin(function->reset_max_delay >> 4, 1000);
 
        ret = regmap_read_poll_timeout(regmap, reg, val, !val, poll_us,