From: Vinod Koul <vinod.koul@intel.com>
Date: Sat, 4 Jan 2014 11:29:12 +0000 (+0530)
Subject: ALSA: compress: update comment for sample rate in snd_codec
X-Git-Tag: firefly_0821_release~4090^2~155
X-Git-Url: http://demsky.eecs.uci.edu/git/?a=commitdiff_plain;h=55fc15e33d13dd6f230fd86c6c9f9837c30b8bc6;p=firefly-linux-kernel-4.4.55.git

ALSA: compress: update comment for sample rate in snd_codec

Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
(cherry picked from commit d9afee6904caa7cf3c7f417f02e765db89d2b5dc)
Signed-off-by: Yuchen Song <yuchens@nvidia.com>
Change-Id: I7608d924613611222766a898a97c856a64c2eb68
---

diff --git a/include/uapi/sound/compress_params.h b/include/uapi/sound/compress_params.h
index 1114e380aecd..8c23aebc82a5 100644
--- a/include/uapi/sound/compress_params.h
+++ b/include/uapi/sound/compress_params.h
@@ -364,7 +364,8 @@ struct snd_codec_desc {
  * @ch_out: Number of output channels. In case of contradiction between
  *		this field and the channelMode field, the channelMode field
  *		overrides.
- * @sample_rate: Audio sample rate of input data
+ * @sample_rate: Audio sample rate of input data in Hz, use values like 48000
+ *		for this.
  * @bit_rate: Bitrate of encoded data. May be ignored by decoders
  * @rate_control: Encoding rate control. See SND_RATECONTROLMODE defines.
  *               Encoders may rely on profiles for quality levels.