| Message ID | 20240326-dai_mclk_hint-v1-1-653cbd2d78d9@jookia.org (mailing list archive) |
|---|---|
| State | Accepted |
| Commit | 1e90a846493c716e3e6b4d901fc0844e9eea6430 |
| Headers | show |
| Series | ASoC: soc-dai: Note valid values of sysclock direction | expand |
On Tue, 26 Mar 2024 22:48:00 +1100, John Watts wrote: > Clock direction is marked as 'unsigned int' but only two values are > currently used in practice. Note these down in the documentation. > > Applied to https://git.kernel.org/pub/scm/linux/kernel/git/broonie/sound.git for-next Thanks! [1/1] ASoC: soc-dai: Note valid values of sysclock direction commit: 1e90a846493c716e3e6b4d901fc0844e9eea6430 All being well this means that it will be integrated into the linux-next tree (usually sometime in the next 24 hours) and sent to Linus during the next merge window (or sooner if it is a bug fix), however if problems are discovered then the patch may be dropped or reverted. You may get further e-mails resulting from automated or manual testing and review of the tree, please engage with people reporting problems and send followup patches addressing any issues that are reported if needed. If any updates are required or you are submitting further changes they should be sent as incremental updates against current git, existing patches will not be replaced. Please add any relevant lists and maintainers to the CCs when replying to this mail. Thanks, Mark
diff --git a/sound/soc/soc-dai.c b/sound/soc/soc-dai.c index 6f8773a8fc05..fefe394dce72 100644 --- a/sound/soc/soc-dai.c +++ b/sound/soc/soc-dai.c @@ -45,7 +45,7 @@ static inline int _soc_dai_ret(struct snd_soc_dai *dai, * @dai: DAI * @clk_id: DAI specific clock ID * @freq: new clock frequency in Hz - * @dir: new clock direction - input/output. + * @dir: new clock direction (SND_SOC_CLOCK_IN or SND_SOC_CLOCK_OUT) * * Configures the DAI master (MCLK) or system (SYSCLK) clocking. */
Clock direction is marked as 'unsigned int' but only two values are currently used in practice. Note these down in the documentation. Signed-off-by: John Watts <contact@jookia.org> --- When writing a driver I wasn't sure what values of 'dir' to check against, so I decided to note them down in the documentation. I'm not sure exactly how correct this is: All the drivers I've checked use these values, though I'm sure some code uses 0 or 1 somewhere or something like 'if (dir)'. Maybe changing to an enum would help here? I'm not sure. --- sound/soc/soc-dai.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- base-commit: 72fb52fb0ac44b6a1edd9bc390e44bce3acccd26 change-id: 20240326-dai_mclk_hint-715cbdb09207 Best regards,