diff options
author | Vinod Koul <vinod.koul@intel.com> | 2014-10-28 11:55:13 -0400 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2014-10-28 12:40:27 -0400 |
commit | 859b2e374a86482004d1b8b94c1666269e1d7fd6 (patch) | |
tree | 07ef9359164704fe510bdc41ce02b04d8a501c12 /include/sound | |
parent | 7b366d5f161c2a69eeafe525105a5a9277982472 (diff) |
ALSA: compress: fix documentation errors
Some structure documentation was not right so fix it now
Reported-by: kbuild test robot <fengguang.wu@intel.com>
Signed-off-by: Vinod Koul <vinod.koul@intel.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
Diffstat (limited to 'include/sound')
-rw-r--r-- | include/sound/compress_driver.h | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/include/sound/compress_driver.h b/include/sound/compress_driver.h index ae6c3b8ed2f5..396e8f73670a 100644 --- a/include/sound/compress_driver.h +++ b/include/sound/compress_driver.h | |||
@@ -42,12 +42,11 @@ struct snd_compr_ops; | |||
42 | * @buffer_size: size of the above buffer | 42 | * @buffer_size: size of the above buffer |
43 | * @fragment_size: size of buffer fragment in bytes | 43 | * @fragment_size: size of buffer fragment in bytes |
44 | * @fragments: number of such fragments | 44 | * @fragments: number of such fragments |
45 | * @hw_pointer: offset of last location in buffer where DSP copied data | ||
46 | * @app_pointer: offset of last location in buffer where app wrote data | ||
47 | * @total_bytes_available: cumulative number of bytes made available in | 45 | * @total_bytes_available: cumulative number of bytes made available in |
48 | * the ring buffer | 46 | * the ring buffer |
49 | * @total_bytes_transferred: cumulative bytes transferred by offload DSP | 47 | * @total_bytes_transferred: cumulative bytes transferred by offload DSP |
50 | * @sleep: poll sleep | 48 | * @sleep: poll sleep |
49 | * @private_data: driver private data pointer | ||
51 | */ | 50 | */ |
52 | struct snd_compr_runtime { | 51 | struct snd_compr_runtime { |
53 | snd_pcm_state_t state; | 52 | snd_pcm_state_t state; |
@@ -94,6 +93,8 @@ struct snd_compr_stream { | |||
94 | * This can be called in during stream creation only to set codec params | 93 | * This can be called in during stream creation only to set codec params |
95 | * and the stream properties | 94 | * and the stream properties |
96 | * @get_params: retrieve the codec parameters, mandatory | 95 | * @get_params: retrieve the codec parameters, mandatory |
96 | * @set_metadata: Set the metadata values for a stream | ||
97 | * @get_metadata: retreives the requested metadata values from stream | ||
97 | * @trigger: Trigger operations like start, pause, resume, drain, stop. | 98 | * @trigger: Trigger operations like start, pause, resume, drain, stop. |
98 | * This callback is mandatory | 99 | * This callback is mandatory |
99 | * @pointer: Retrieve current h/w pointer information. Mandatory | 100 | * @pointer: Retrieve current h/w pointer information. Mandatory |