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