diff options
Diffstat (limited to 'include/uapi/sound/compress_offload.h')
-rw-r--r-- | include/uapi/sound/compress_offload.h | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/include/uapi/sound/compress_offload.h b/include/uapi/sound/compress_offload.h index 1964026b5e09..22ed8cb7800b 100644 --- a/include/uapi/sound/compress_offload.h +++ b/include/uapi/sound/compress_offload.h | |||
@@ -32,7 +32,7 @@ | |||
32 | 32 | ||
33 | #define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2) | 33 | #define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2) |
34 | /** | 34 | /** |
35 | * struct snd_compressed_buffer: compressed buffer | 35 | * struct snd_compressed_buffer - compressed buffer |
36 | * @fragment_size: size of buffer fragment in bytes | 36 | * @fragment_size: size of buffer fragment in bytes |
37 | * @fragments: number of such fragments | 37 | * @fragments: number of such fragments |
38 | */ | 38 | */ |
@@ -42,7 +42,7 @@ struct snd_compressed_buffer { | |||
42 | } __attribute__((packed, aligned(4))); | 42 | } __attribute__((packed, aligned(4))); |
43 | 43 | ||
44 | /** | 44 | /** |
45 | * struct snd_compr_params: compressed stream params | 45 | * struct snd_compr_params - compressed stream params |
46 | * @buffer: buffer description | 46 | * @buffer: buffer description |
47 | * @codec: codec parameters | 47 | * @codec: codec parameters |
48 | * @no_wake_mode: dont wake on fragment elapsed | 48 | * @no_wake_mode: dont wake on fragment elapsed |
@@ -54,7 +54,7 @@ struct snd_compr_params { | |||
54 | } __attribute__((packed, aligned(4))); | 54 | } __attribute__((packed, aligned(4))); |
55 | 55 | ||
56 | /** | 56 | /** |
57 | * struct snd_compr_tstamp: timestamp descriptor | 57 | * struct snd_compr_tstamp - timestamp descriptor |
58 | * @byte_offset: Byte offset in ring buffer to DSP | 58 | * @byte_offset: Byte offset in ring buffer to DSP |
59 | * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP | 59 | * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP |
60 | * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by | 60 | * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by |
@@ -73,7 +73,7 @@ struct snd_compr_tstamp { | |||
73 | } __attribute__((packed, aligned(4))); | 73 | } __attribute__((packed, aligned(4))); |
74 | 74 | ||
75 | /** | 75 | /** |
76 | * struct snd_compr_avail: avail descriptor | 76 | * struct snd_compr_avail - avail descriptor |
77 | * @avail: Number of bytes available in ring buffer for writing/reading | 77 | * @avail: Number of bytes available in ring buffer for writing/reading |
78 | * @tstamp: timestamp infomation | 78 | * @tstamp: timestamp infomation |
79 | */ | 79 | */ |
@@ -88,7 +88,7 @@ enum snd_compr_direction { | |||
88 | }; | 88 | }; |
89 | 89 | ||
90 | /** | 90 | /** |
91 | * struct snd_compr_caps: caps descriptor | 91 | * struct snd_compr_caps - caps descriptor |
92 | * @codecs: pointer to array of codecs | 92 | * @codecs: pointer to array of codecs |
93 | * @direction: direction supported. Of type snd_compr_direction | 93 | * @direction: direction supported. Of type snd_compr_direction |
94 | * @min_fragment_size: minimum fragment supported by DSP | 94 | * @min_fragment_size: minimum fragment supported by DSP |
@@ -110,7 +110,7 @@ struct snd_compr_caps { | |||
110 | } __attribute__((packed, aligned(4))); | 110 | } __attribute__((packed, aligned(4))); |
111 | 111 | ||
112 | /** | 112 | /** |
113 | * struct snd_compr_codec_caps: query capability of codec | 113 | * struct snd_compr_codec_caps - query capability of codec |
114 | * @codec: codec for which capability is queried | 114 | * @codec: codec for which capability is queried |
115 | * @num_descriptors: number of codec descriptors | 115 | * @num_descriptors: number of codec descriptors |
116 | * @descriptor: array of codec capability descriptor | 116 | * @descriptor: array of codec capability descriptor |
@@ -122,18 +122,19 @@ struct snd_compr_codec_caps { | |||
122 | } __attribute__((packed, aligned(4))); | 122 | } __attribute__((packed, aligned(4))); |
123 | 123 | ||
124 | /** | 124 | /** |
125 | * enum sndrv_compress_encoder | ||
125 | * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the | 126 | * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the |
126 | * end of the track | 127 | * end of the track |
127 | * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the | 128 | * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the |
128 | * beginning of the track | 129 | * beginning of the track |
129 | */ | 130 | */ |
130 | enum { | 131 | enum sndrv_compress_encoder { |
131 | SNDRV_COMPRESS_ENCODER_PADDING = 1, | 132 | SNDRV_COMPRESS_ENCODER_PADDING = 1, |
132 | SNDRV_COMPRESS_ENCODER_DELAY = 2, | 133 | SNDRV_COMPRESS_ENCODER_DELAY = 2, |
133 | }; | 134 | }; |
134 | 135 | ||
135 | /** | 136 | /** |
136 | * struct snd_compr_metadata: compressed stream metadata | 137 | * struct snd_compr_metadata - compressed stream metadata |
137 | * @key: key id | 138 | * @key: key id |
138 | * @value: key value | 139 | * @value: key value |
139 | */ | 140 | */ |