1 /* SPDX-License-Identifier: GPL-2.0
3 * compress_driver.h - compress offload driver definations
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>
10 #ifndef __COMPRESS_DRIVER_H
11 #define __COMPRESS_DRIVER_H
13 #include <linux/types.h>
14 #include <linux/sched.h>
15 #include <sound/core.h>
16 #include <sound/compress_offload.h>
17 #include <sound/asound.h>
18 #include <sound/pcm.h>
23 * struct snd_compr_runtime: runtime stream description
24 * @state: stream state
25 * @ops: pointer to DSP callbacks
26 * @dma_buffer_p: runtime dma buffer pointer
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
34 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
36 * @private_data: driver private data pointer
38 struct snd_compr_runtime {
39 snd_pcm_state_t state;
40 struct snd_compr_ops *ops;
41 struct snd_dma_buffer *dma_buffer_p;
46 u64 total_bytes_available;
47 u64 total_bytes_transferred;
48 wait_queue_head_t sleep;
53 * struct snd_compr_stream: compressed stream
55 * @ops: pointer to DSP callbacks
56 * @runtime: pointer to runtime structure
57 * @device: device pointer
58 * @error_work: delayed work used when closing the stream due to an error
59 * @direction: stream direction, playback/recording
60 * @metadata_set: metadata set flag, true when set
61 * @next_track: has userspace signal next track transition, true when set
62 * @partial_drain: undergoing partial_drain for stream, true when set
63 * @private_data: pointer to DSP private data
65 struct snd_compr_stream {
67 struct snd_compr_ops *ops;
68 struct snd_compr_runtime *runtime;
69 struct snd_compr *device;
70 struct delayed_work error_work;
71 enum snd_compr_direction direction;
79 * struct snd_compr_ops: compressed path DSP operations
80 * @open: Open the compressed stream
81 * This callback is mandatory and shall keep dsp ready to receive the stream
83 * @free: Close the compressed stream, mandatory
84 * @set_params: Sets the compressed stream parameters, mandatory
85 * This can be called in during stream creation only to set codec params
86 * and the stream properties
87 * @get_params: retrieve the codec parameters, mandatory
88 * @set_metadata: Set the metadata values for a stream
89 * @get_metadata: retrieves the requested metadata values from stream
90 * @trigger: Trigger operations like start, pause, resume, drain, stop.
91 * This callback is mandatory
92 * @pointer: Retrieve current h/w pointer information. Mandatory
93 * @copy: Copy the compressed data to/from userspace, Optional
94 * Can't be implemented if DSP supports mmap
95 * @mmap: DSP mmap method to mmap DSP memory
96 * @ack: Ack for DSP when data is written to audio buffer, Optional
97 * Not valid if copy is implemented
98 * @get_caps: Retrieve DSP capabilities, mandatory
99 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
101 struct snd_compr_ops {
102 int (*open)(struct snd_compr_stream *stream);
103 int (*free)(struct snd_compr_stream *stream);
104 int (*set_params)(struct snd_compr_stream *stream,
105 struct snd_compr_params *params);
106 int (*get_params)(struct snd_compr_stream *stream,
107 struct snd_codec *params);
108 int (*set_metadata)(struct snd_compr_stream *stream,
109 struct snd_compr_metadata *metadata);
110 int (*get_metadata)(struct snd_compr_stream *stream,
111 struct snd_compr_metadata *metadata);
112 int (*trigger)(struct snd_compr_stream *stream, int cmd);
113 int (*pointer)(struct snd_compr_stream *stream,
114 struct snd_compr_tstamp *tstamp);
115 int (*copy)(struct snd_compr_stream *stream, char __user *buf,
117 int (*mmap)(struct snd_compr_stream *stream,
118 struct vm_area_struct *vma);
119 int (*ack)(struct snd_compr_stream *stream, size_t bytes);
120 int (*get_caps) (struct snd_compr_stream *stream,
121 struct snd_compr_caps *caps);
122 int (*get_codec_caps) (struct snd_compr_stream *stream,
123 struct snd_compr_codec_caps *codec);
127 * struct snd_compr: Compressed device
128 * @name: DSP device name
129 * @dev: associated device instance
130 * @ops: pointer to DSP callbacks
131 * @private_data: pointer to DSP pvt data
132 * @card: sound card pointer
133 * @direction: Playback or capture direction
140 struct snd_compr_ops *ops;
142 struct snd_card *card;
143 unsigned int direction;
146 #ifdef CONFIG_SND_VERBOSE_PROCFS
149 struct snd_info_entry *proc_root;
150 struct snd_info_entry *proc_info_entry;
154 /* compress device register APIs */
155 int snd_compress_register(struct snd_compr *device);
156 int snd_compress_deregister(struct snd_compr *device);
157 int snd_compress_new(struct snd_card *card, int device,
158 int type, const char *id, struct snd_compr *compr);
160 /* dsp driver callback apis
161 * For playback: driver should call snd_compress_fragment_elapsed() to let the
162 * framework know that a fragment has been consumed from the ring buffer
164 * For recording: we want to know when a frame is available or when
165 * at least one frame is available so snd_compress_frame_elapsed()
166 * callback should be called when a encodeded frame is available
168 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
170 wake_up(&stream->runtime->sleep);
173 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
175 if (snd_BUG_ON(!stream))
178 /* for partial_drain case we are back to running state on success */
179 if (stream->partial_drain) {
180 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
181 stream->partial_drain = false; /* clear this flag as well */
183 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
186 wake_up(&stream->runtime->sleep);
190 * snd_compr_set_runtime_buffer - Set the Compress runtime buffer
191 * @substream: compress substream to set
192 * @bufp: the buffer information, NULL to clear
194 * Copy the buffer information to runtime buffer when @bufp is non-NULL.
195 * Otherwise it clears the current buffer information.
197 static inline void snd_compr_set_runtime_buffer(
198 struct snd_compr_stream *substream,
199 struct snd_dma_buffer *bufp)
201 struct snd_compr_runtime *runtime = substream->runtime;
203 runtime->dma_buffer_p = bufp;
206 int snd_compr_stop_error(struct snd_compr_stream *stream,
207 snd_pcm_state_t state);