1 /* SPDX-License-Identifier: GPL-2.0
2 *
3 * compress_driver.h - compress offload driver definations
4 *
5 * Copyright (C) 2011 Intel Corporation
6 * Authors: Vinod Koul <vinod.koul@linux.intel.com>
7 * Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
8 */
9
10 #ifndef __COMPRESS_DRIVER_H
11 #define __COMPRESS_DRIVER_H
12
13 #include <linux/types.h>
14 #include <linux/sched.h>
15 #include <linux/android_kabi.h>
16 #include <sound/core.h>
17 #include <sound/compress_offload.h>
18 #include <sound/asound.h>
19 #include <sound/pcm.h>
20
21 struct snd_compr_ops;
22
23 /**
24 * struct snd_compr_runtime: runtime stream description
25 * @state: stream state
26 * @ops: pointer to DSP callbacks
27 * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
28 * DSP doesn't implement copy
29 * @buffer_size: size of the above buffer
30 * @fragment_size: size of buffer fragment in bytes
31 * @fragments: number of such fragments
32 * @total_bytes_available: cumulative number of bytes made available in
33 * the ring buffer
34 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
35 * @sleep: poll sleep
36 * @private_data: driver private data pointer
37 * @dma_area: virtual buffer address
38 * @dma_addr: physical buffer address (not accessible from main CPU)
39 * @dma_bytes: size of DMA area
40 * @dma_buffer_p: runtime dma buffer pointer
41 */
42 struct snd_compr_runtime {
43 snd_pcm_state_t state;
44 struct snd_compr_ops *ops;
45 void *buffer;
46 u64 buffer_size;
47 u32 fragment_size;
48 u32 fragments;
49 u64 total_bytes_available;
50 u64 total_bytes_transferred;
51 wait_queue_head_t sleep;
52 void *private_data;
53
54 unsigned char *dma_area;
55 dma_addr_t dma_addr;
56 size_t dma_bytes;
57 struct snd_dma_buffer *dma_buffer_p;
58
59 ANDROID_KABI_RESERVE(1);
60 };
61
62 /**
63 * struct snd_compr_stream: compressed stream
64 * @name: device name
65 * @ops: pointer to DSP callbacks
66 * @runtime: pointer to runtime structure
67 * @device: device pointer
68 * @error_work: delayed work used when closing the stream due to an error
69 * @direction: stream direction, playback/recording
70 * @metadata_set: metadata set flag, true when set
71 * @next_track: has userspace signal next track transition, true when set
72 * @partial_drain: undergoing partial_drain for stream, true when set
73 * @private_data: pointer to DSP private data
74 * @dma_buffer: allocated buffer if any
75 */
76 struct snd_compr_stream {
77 const char *name;
78 struct snd_compr_ops *ops;
79 struct snd_compr_runtime *runtime;
80 struct snd_compr *device;
81 struct delayed_work error_work;
82 enum snd_compr_direction direction;
83 bool metadata_set;
84 bool next_track;
85 bool partial_drain;
86 void *private_data;
87 struct snd_dma_buffer dma_buffer;
88
89 ANDROID_KABI_RESERVE(1);
90 };
91
92 /**
93 * struct snd_compr_ops: compressed path DSP operations
94 * @open: Open the compressed stream
95 * This callback is mandatory and shall keep dsp ready to receive the stream
96 * parameter
97 * @free: Close the compressed stream, mandatory
98 * @set_params: Sets the compressed stream parameters, mandatory
99 * This can be called in during stream creation only to set codec params
100 * and the stream properties
101 * @get_params: retrieve the codec parameters, mandatory
102 * @set_metadata: Set the metadata values for a stream
103 * @get_metadata: retrieves the requested metadata values from stream
104 * @trigger: Trigger operations like start, pause, resume, drain, stop.
105 * This callback is mandatory
106 * @pointer: Retrieve current h/w pointer information. Mandatory
107 * @copy: Copy the compressed data to/from userspace, Optional
108 * Can't be implemented if DSP supports mmap
109 * @mmap: DSP mmap method to mmap DSP memory
110 * @ack: Ack for DSP when data is written to audio buffer, Optional
111 * Not valid if copy is implemented
112 * @get_caps: Retrieve DSP capabilities, mandatory
113 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
114 */
115 struct snd_compr_ops {
116 int (*open)(struct snd_compr_stream *stream);
117 int (*free)(struct snd_compr_stream *stream);
118 int (*set_params)(struct snd_compr_stream *stream,
119 struct snd_compr_params *params);
120 int (*get_params)(struct snd_compr_stream *stream,
121 struct snd_codec *params);
122 int (*set_metadata)(struct snd_compr_stream *stream,
123 struct snd_compr_metadata *metadata);
124 int (*get_metadata)(struct snd_compr_stream *stream,
125 struct snd_compr_metadata *metadata);
126 int (*trigger)(struct snd_compr_stream *stream, int cmd);
127 int (*pointer)(struct snd_compr_stream *stream,
128 struct snd_compr_tstamp *tstamp);
129 int (*copy)(struct snd_compr_stream *stream, char __user *buf,
130 size_t count);
131 int (*mmap)(struct snd_compr_stream *stream,
132 struct vm_area_struct *vma);
133 int (*ack)(struct snd_compr_stream *stream, size_t bytes);
134 int (*get_caps) (struct snd_compr_stream *stream,
135 struct snd_compr_caps *caps);
136 int (*get_codec_caps) (struct snd_compr_stream *stream,
137 struct snd_compr_codec_caps *codec);
138
139 ANDROID_KABI_RESERVE(1);
140 };
141
142 /**
143 * struct snd_compr: Compressed device
144 * @name: DSP device name
145 * @dev: associated device instance
146 * @ops: pointer to DSP callbacks
147 * @private_data: pointer to DSP pvt data
148 * @card: sound card pointer
149 * @direction: Playback or capture direction
150 * @lock: device lock
151 * @device: device id
152 */
153 struct snd_compr {
154 const char *name;
155 struct device dev;
156 struct snd_compr_ops *ops;
157 void *private_data;
158 struct snd_card *card;
159 unsigned int direction;
160 struct mutex lock;
161 int device;
162 #ifdef CONFIG_SND_VERBOSE_PROCFS
163 /* private: */
164 char id[64];
165 struct snd_info_entry *proc_root;
166 struct snd_info_entry *proc_info_entry;
167 #endif
168 ANDROID_KABI_RESERVE(1);
169 };
170
171 /* compress device register APIs */
172 int snd_compress_register(struct snd_compr *device);
173 int snd_compress_deregister(struct snd_compr *device);
174 int snd_compress_new(struct snd_card *card, int device,
175 int type, const char *id, struct snd_compr *compr);
176
177 /* dsp driver callback apis
178 * For playback: driver should call snd_compress_fragment_elapsed() to let the
179 * framework know that a fragment has been consumed from the ring buffer
180 *
181 * For recording: we want to know when a frame is available or when
182 * at least one frame is available so snd_compress_frame_elapsed()
183 * callback should be called when a encodeded frame is available
184 */
snd_compr_fragment_elapsed(struct snd_compr_stream * stream)185 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
186 {
187 wake_up(&stream->runtime->sleep);
188 }
189
snd_compr_drain_notify(struct snd_compr_stream * stream)190 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
191 {
192 if (snd_BUG_ON(!stream))
193 return;
194
195 /* for partial_drain case we are back to running state on success */
196 if (stream->partial_drain) {
197 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
198 stream->partial_drain = false; /* clear this flag as well */
199 } else {
200 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
201 }
202
203 wake_up(&stream->runtime->sleep);
204 }
205
206 /**
207 * snd_compr_set_runtime_buffer - Set the Compress runtime buffer
208 * @stream: compress stream to set
209 * @bufp: the buffer information, NULL to clear
210 *
211 * Copy the buffer information to runtime buffer when @bufp is non-NULL.
212 * Otherwise it clears the current buffer information.
213 */
214 static inline void
snd_compr_set_runtime_buffer(struct snd_compr_stream * stream,struct snd_dma_buffer * bufp)215 snd_compr_set_runtime_buffer(struct snd_compr_stream *stream,
216 struct snd_dma_buffer *bufp)
217 {
218 struct snd_compr_runtime *runtime = stream->runtime;
219
220 if (bufp) {
221 runtime->dma_buffer_p = bufp;
222 runtime->dma_area = bufp->area;
223 runtime->dma_addr = bufp->addr;
224 runtime->dma_bytes = bufp->bytes;
225 } else {
226 runtime->dma_buffer_p = NULL;
227 runtime->dma_area = NULL;
228 runtime->dma_addr = 0;
229 runtime->dma_bytes = 0;
230 }
231 }
232
233 int snd_compr_malloc_pages(struct snd_compr_stream *stream, size_t size);
234 int snd_compr_free_pages(struct snd_compr_stream *stream);
235
236 int snd_compr_stop_error(struct snd_compr_stream *stream,
237 snd_pcm_state_t state);
238
239 #endif
240