Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 859b2e37 authored by Vinod Koul's avatar Vinod Koul Committed by Takashi Iwai
Browse files

ALSA: compress: fix documentation errors 



Some structure documentation was not right so fix it now

Reported-by: default avatarkbuild test robot <fengguang.wu@intel.com>
Signed-off-by: default avatarVinod Koul <vinod.koul@intel.com>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent 7b366d5f

include/sound/compress_driver.h

+3 −2
Original line number Original line Diff line number Diff line
@@ -42,12 +42,11 @@ struct snd_compr_ops; 
 * @buffer_size: size of the above buffer

 * @buffer_size: size of the above buffer

 * @fragment_size: size of buffer fragment in bytes

 * @fragment_size: size of buffer fragment in bytes

 * @fragments: number of such fragments

 * @fragments: number of such fragments

 * @hw_pointer: offset of last location in buffer where DSP copied data

 * @app_pointer: offset of last location in buffer where app wrote data

 * @total_bytes_available: cumulative number of bytes made available in

 * @total_bytes_available: cumulative number of bytes made available in

 *	the ring buffer

 *	the ring buffer

 * @total_bytes_transferred: cumulative bytes transferred by offload DSP

 * @total_bytes_transferred: cumulative bytes transferred by offload DSP

 * @sleep: poll sleep

 * @sleep: poll sleep

 * @private_data: driver private data pointer

 */

 */

struct snd_compr_runtime {

struct snd_compr_runtime {

	snd_pcm_state_t state;

	snd_pcm_state_t state;
@@ -94,6 +93,8 @@ struct snd_compr_stream { 
 * This can be called in during stream creation only to set codec params

 * This can be called in during stream creation only to set codec params

 * and the stream properties

 * and the stream properties

 * @get_params: retrieve the codec parameters, mandatory

 * @get_params: retrieve the codec parameters, mandatory

 * @set_metadata: Set the metadata values for a stream

 * @get_metadata: retreives the requested metadata values from stream

 * @trigger: Trigger operations like start, pause, resume, drain, stop.

 * @trigger: Trigger operations like start, pause, resume, drain, stop.

 * This callback is mandatory

 * This callback is mandatory

 * @pointer: Retrieve current h/w pointer information. Mandatory

 * @pointer: Retrieve current h/w pointer information. Mandatory