1/*
  2 *  compress_driver.h - compress offload driver definations
  3 *
  4 *  Copyright (C) 2011 Intel Corporation
  5 *  Authors:	Vinod Koul <vinod.koul@linux.intel.com>
  6 *		Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
  7 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  8 *
  9 *  This program is free software; you can redistribute it and/or modify
 10 *  it under the terms of the GNU General Public License as published by
 11 *  the Free Software Foundation; version 2 of the License.
 12 *
 13 *  This program is distributed in the hope that it will be useful, but
 14 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 15 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 16 *  General Public License for more details.
 17 *
 18 *  You should have received a copy of the GNU General Public License along
 19 *  with this program; if not, write to the Free Software Foundation, Inc.,
 20 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 21 *
 22 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 23 *
 24 */
 25#ifndef __COMPRESS_DRIVER_H
 26#define __COMPRESS_DRIVER_H
 27
 28#include <linux/types.h>
 29#include <linux/sched.h>
 30#include <sound/core.h>
 31#include <sound/compress_offload.h>
 32#include <sound/asound.h>
 33#include <sound/pcm.h>
 34
 35struct snd_compr_ops;
 36
 37/**
 38 * struct snd_compr_runtime: runtime stream description
 39 * @state: stream state
 40 * @ops: pointer to DSP callbacks
 41 * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
 42 *	DSP doesn't implement copy
 43 * @buffer_size: size of the above buffer
 44 * @fragment_size: size of buffer fragment in bytes
 45 * @fragments: number of such fragments
 46 * @total_bytes_available: cumulative number of bytes made available in
 47 *	the ring buffer
 48 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
 49 * @sleep: poll sleep
 50 * @private_data: driver private data pointer
 51 */
 52struct snd_compr_runtime {
 53	snd_pcm_state_t state;
 54	struct snd_compr_ops *ops;
 55	void *buffer;
 56	u64 buffer_size;
 57	u32 fragment_size;
 58	u32 fragments;
 59	u64 total_bytes_available;
 60	u64 total_bytes_transferred;
 61	wait_queue_head_t sleep;
 62	void *private_data;
 63};
 64
 65/**
 66 * struct snd_compr_stream: compressed stream
 67 * @name: device name
 68 * @ops: pointer to DSP callbacks
 69 * @runtime: pointer to runtime structure
 70 * @device: device pointer
 71 * @error_work: delayed work used when closing the stream due to an error
 72 * @direction: stream direction, playback/recording
 73 * @metadata_set: metadata set flag, true when set
 74 * @next_track: has userspace signal next track transition, true when set
 75 * @private_data: pointer to DSP private data
 76 */
 77struct snd_compr_stream {
 78	const char *name;
 79	struct snd_compr_ops *ops;
 80	struct snd_compr_runtime *runtime;
 81	struct snd_compr *device;
 82	struct delayed_work error_work;
 83	enum snd_compr_direction direction;
 84	bool metadata_set;
 85	bool next_track;
 86	void *private_data;
 87};
 88
 89/**
 90 * struct snd_compr_ops: compressed path DSP operations
 91 * @open: Open the compressed stream
 92 * This callback is mandatory and shall keep dsp ready to receive the stream
 93 * parameter
 94 * @free: Close the compressed stream, mandatory
 95 * @set_params: Sets the compressed stream parameters, mandatory
 96 * This can be called in during stream creation only to set codec params
 97 * and the stream properties
 98 * @get_params: retrieve the codec parameters, mandatory
 99 * @set_metadata: Set the metadata values for a stream
100 * @get_metadata: retrieves the requested metadata values from stream
101 * @trigger: Trigger operations like start, pause, resume, drain, stop.
102 * This callback is mandatory
103 * @pointer: Retrieve current h/w pointer information. Mandatory
104 * @copy: Copy the compressed data to/from userspace, Optional
105 * Can't be implemented if DSP supports mmap
106 * @mmap: DSP mmap method to mmap DSP memory
107 * @ack: Ack for DSP when data is written to audio buffer, Optional
108 * Not valid if copy is implemented
109 * @get_caps: Retrieve DSP capabilities, mandatory
110 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
111 */
112struct snd_compr_ops {
113	int (*open)(struct snd_compr_stream *stream);
114	int (*free)(struct snd_compr_stream *stream);
115	int (*set_params)(struct snd_compr_stream *stream,
116			struct snd_compr_params *params);
117	int (*get_params)(struct snd_compr_stream *stream,
118			struct snd_codec *params);
119	int (*set_metadata)(struct snd_compr_stream *stream,
120			struct snd_compr_metadata *metadata);
121	int (*get_metadata)(struct snd_compr_stream *stream,
122			struct snd_compr_metadata *metadata);
123	int (*trigger)(struct snd_compr_stream *stream, int cmd);
124	int (*pointer)(struct snd_compr_stream *stream,
125			struct snd_compr_tstamp *tstamp);
126	int (*copy)(struct snd_compr_stream *stream, char __user *buf,
127		       size_t count);
128	int (*mmap)(struct snd_compr_stream *stream,
129			struct vm_area_struct *vma);
130	int (*ack)(struct snd_compr_stream *stream, size_t bytes);
131	int (*get_caps) (struct snd_compr_stream *stream,
132			struct snd_compr_caps *caps);
133	int (*get_codec_caps) (struct snd_compr_stream *stream,
134			struct snd_compr_codec_caps *codec);
135};
136
137/**
138 * struct snd_compr: Compressed device
139 * @name: DSP device name
140 * @dev: associated device instance
141 * @ops: pointer to DSP callbacks
142 * @private_data: pointer to DSP pvt data
143 * @card: sound card pointer
144 * @direction: Playback or capture direction
145 * @lock: device lock
146 * @device: device id
147 */
148struct snd_compr {
149	const char *name;
150	struct device dev;
151	struct snd_compr_ops *ops;
152	void *private_data;
153	struct snd_card *card;
154	unsigned int direction;
155	struct mutex lock;
156	int device;
157#ifdef CONFIG_SND_VERBOSE_PROCFS
158	/* private: */
159	char id[64];
160	struct snd_info_entry *proc_root;
161	struct snd_info_entry *proc_info_entry;
162#endif
163};
164
165/* compress device register APIs */
166int snd_compress_register(struct snd_compr *device);
167int snd_compress_deregister(struct snd_compr *device);
168int snd_compress_new(struct snd_card *card, int device,
169			int type, const char *id, struct snd_compr *compr);
170
171/* dsp driver callback apis
172 * For playback: driver should call snd_compress_fragment_elapsed() to let the
173 * framework know that a fragment has been consumed from the ring buffer
174 *
175 * For recording: we want to know when a frame is available or when
176 * at least one frame is available so snd_compress_frame_elapsed()
177 * callback should be called when a encodeded frame is available
178 */
179static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
180{
181	wake_up(&stream->runtime->sleep);
182}
183
184static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
185{
186	if (snd_BUG_ON(!stream))
187		return;
188
189	stream->runtime->state = SNDRV_PCM_STATE_SETUP;
190	wake_up(&stream->runtime->sleep);
191}
192
193int snd_compr_stop_error(struct snd_compr_stream *stream,
194			 snd_pcm_state_t state);
195
196#endif