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/compress_offload.h>
 31#include <sound/asound.h>
 32#include <sound/pcm.h>
 33
 34struct snd_compr_ops;
 35
 36/**
 37 * struct snd_compr_runtime: runtime stream description
 38 * @state: stream state
 39 * @ops: pointer to DSP callbacks
 40 * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
 41 *	DSP doesn't implement copy
 42 * @buffer_size: size of the above buffer
 43 * @fragment_size: size of buffer fragment in bytes
 44 * @fragments: number of such fragments
 45 * @hw_pointer: offset of last location in buffer where DSP copied data
 46 * @app_pointer: offset of last location in buffer where app wrote data
 47 * @total_bytes_available: cumulative number of bytes made available in
 48 *	the ring buffer
 49 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
 50 * @sleep: poll sleep
 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 * @direction: stream direction, playback/recording
 72 * @metadata_set: metadata set flag, true when set
 73 * @next_track: has userspace signall next track transistion, true when set
 74 * @private_data: pointer to DSP private data
 75 */
 76struct 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	enum snd_compr_direction direction;
 82	bool metadata_set;
 83	bool next_track;
 84	void *private_data;
 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 * @trigger: Trigger operations like start, pause, resume, drain, stop.
 98 * This callback is mandatory
 99 * @pointer: Retrieve current h/w pointer information. Mandatory
100 * @copy: Copy the compressed data to/from userspace, Optional
101 * Can't be implemented if DSP supports mmap
102 * @mmap: DSP mmap method to mmap DSP memory
103 * @ack: Ack for DSP when data is written to audio buffer, Optional
104 * Not valid if copy is implemented
105 * @get_caps: Retrieve DSP capabilities, mandatory
106 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
107 */
108struct snd_compr_ops {
109	int (*open)(struct snd_compr_stream *stream);
110	int (*free)(struct snd_compr_stream *stream);
111	int (*set_params)(struct snd_compr_stream *stream,
112			struct snd_compr_params *params);
113	int (*get_params)(struct snd_compr_stream *stream,
114			struct snd_codec *params);
115	int (*set_metadata)(struct snd_compr_stream *stream,
116			struct snd_compr_metadata *metadata);
117	int (*get_metadata)(struct snd_compr_stream *stream,
118			struct snd_compr_metadata *metadata);
119	int (*trigger)(struct snd_compr_stream *stream, int cmd);
120	int (*pointer)(struct snd_compr_stream *stream,
121			struct snd_compr_tstamp *tstamp);
122	int (*copy)(struct snd_compr_stream *stream, char __user *buf,
123		       size_t count);
124	int (*mmap)(struct snd_compr_stream *stream,
125			struct vm_area_struct *vma);
126	int (*ack)(struct snd_compr_stream *stream, size_t bytes);
127	int (*get_caps) (struct snd_compr_stream *stream,
128			struct snd_compr_caps *caps);
129	int (*get_codec_caps) (struct snd_compr_stream *stream,
130			struct snd_compr_codec_caps *codec);
131};
132
133/**
134 * struct snd_compr: Compressed device
135 * @name: DSP device name
136 * @dev: Device pointer
137 * @ops: pointer to DSP callbacks
138 * @private_data: pointer to DSP pvt data
139 * @card: sound card pointer
140 * @direction: Playback or capture direction
141 * @lock: device lock
142 * @device: device id
143 */
144struct snd_compr {
145	const char *name;
146	struct device *dev;
147	struct snd_compr_ops *ops;
148	void *private_data;
149	struct snd_card *card;
150	unsigned int direction;
151	struct mutex lock;
152	int device;
153};
154
155/* compress device register APIs */
156int snd_compress_register(struct snd_compr *device);
157int snd_compress_deregister(struct snd_compr *device);
158int snd_compress_new(struct snd_card *card, int device,
159			int type, struct snd_compr *compr);
160
161/* dsp driver callback apis
162 * For playback: driver should call snd_compress_fragment_elapsed() to let the
163 * framework know that a fragment has been consumed from the ring buffer
164 *
165 * For recording: we want to know when a frame is available or when
166 * at least one frame is available so snd_compress_frame_elapsed()
167 * callback should be called when a encodeded frame is available
168 */
169static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
170{
171	wake_up(&stream->runtime->sleep);
172}
173
174static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
175{
176	if (snd_BUG_ON(!stream))
177		return;
178
179	stream->runtime->state = SNDRV_PCM_STATE_SETUP;
180	wake_up(&stream->runtime->sleep);
181}
182
183#endif