[PATCH 13/28] ASoC: qcom: qdsp6: q6asm: Provide documentation for WMA 'codec_profile'

[Vinod Koul]

On 07-07-20, 11:16, Lee Jones wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>  sound/soc/qcom/qdsp6/q6asm.c:924: warning: Function parameter or member 'codec_profile' not described in 'q6asm_open_write'
> 
> Cc: Patrick Lai <plai at codeaurora.org>
> Cc: Banajit Goswami <bgoswami at codeaurora.org>
> Cc: Srinivas Kandagatla <srinivas.kandagatla at linaro.org>
> Cc: Vinod Koul <vkoul at kernel.org>
> Signed-off-by: Lee Jones <lee.jones at linaro.org>
> ---
>  sound/soc/qcom/qdsp6/q6asm.c | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/sound/soc/qcom/qdsp6/q6asm.c b/sound/soc/qcom/qdsp6/q6asm.c
> index ae4b2cabdf2d6..58720b18fc8c8 100644
> --- a/sound/soc/qcom/qdsp6/q6asm.c
> +++ b/sound/soc/qcom/qdsp6/q6asm.c
> @@ -915,6 +915,7 @@ static int q6asm_ac_send_cmd_sync(struct audio_client *ac, struct apr_pkt *pkt)
>   *
>   * @ac: audio client pointer
>   * @format: audio sample format
> + * @codec_profile: profile to use when WMA

Yes it is used with WMA only for now, but we should describe in
generically as "Audio codec profile"

>   * @bits_per_sample: bits per sample
>   *
>   * Return: Will be an negative value on error or zero on success
> -- 
> 2.25.1

-- 
~Vinod