[linux-2.6-block.git] / include / sound / compress_driver.h

/*
 *  compress_driver.h - compress offload driver definations
 *
 *  Copyright (C) 2011 Intel Corporation
 *  Authors:	Vinod Koul <vinod.koul@linux.intel.com>
 *		Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
 *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; version 2 of the License.
 *
 *  This program is distributed in the hope that it will be useful, but
 *  WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, write to the Free Software Foundation, Inc.,
 *  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
 *
 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 *
 */
#ifndef __COMPRESS_DRIVER_H
#define __COMPRESS_DRIVER_H

#include <linux/types.h>
#include <linux/sched.h>
#include <sound/core.h>
#include <sound/compress_offload.h>
#include <sound/asound.h>
#include <sound/pcm.h>

struct snd_compr_ops;

/**
 * struct snd_compr_runtime: runtime stream description
 * @state: stream state
 * @ops: pointer to DSP callbacks
 * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
 *	DSP doesn't implement copy
 * @buffer_size: size of the above buffer
 * @fragment_size: size of buffer fragment in bytes
 * @fragments: number of such fragments
 * @total_bytes_available: cumulative number of bytes made available in
 *	the ring buffer
 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
 * @sleep: poll sleep
 * @private_data: driver private data pointer
 */
struct snd_compr_runtime {
	snd_pcm_state_t state;
	struct snd_compr_ops *ops;
	void *buffer;
	u64 buffer_size;
	u32 fragment_size;
	u32 fragments;
	u64 total_bytes_available;
	u64 total_bytes_transferred;
	wait_queue_head_t sleep;
	void *private_data;
};

/**
 * struct snd_compr_stream: compressed stream
 * @name: device name
 * @ops: pointer to DSP callbacks
 * @runtime: pointer to runtime structure
 * @device: device pointer
 * @direction: stream direction, playback/recording
 * @metadata_set: metadata set flag, true when set
 * @next_track: has userspace signal next track transition, true when set
 * @private_data: pointer to DSP private data
 */
struct snd_compr_stream {
	const char *name;
	struct snd_compr_ops *ops;
	struct snd_compr_runtime *runtime;
	struct snd_compr *device;
	enum snd_compr_direction direction;
	bool metadata_set;
	bool next_track;
	void *private_data;
};

/**
 * struct snd_compr_ops: compressed path DSP operations
 * @open: Open the compressed stream
 * This callback is mandatory and shall keep dsp ready to receive the stream
 * parameter
 * @free: Close the compressed stream, mandatory
 * @set_params: Sets the compressed stream parameters, mandatory
 * This can be called in during stream creation only to set codec params
 * and the stream properties
 * @get_params: retrieve the codec parameters, mandatory
 * @set_metadata: Set the metadata values for a stream
 * @get_metadata: retrieves the requested metadata values from stream
 * @trigger: Trigger operations like start, pause, resume, drain, stop.
 * This callback is mandatory
 * @pointer: Retrieve current h/w pointer information. Mandatory
 * @copy: Copy the compressed data to/from userspace, Optional
 * Can't be implemented if DSP supports mmap
 * @mmap: DSP mmap method to mmap DSP memory
 * @ack: Ack for DSP when data is written to audio buffer, Optional
 * Not valid if copy is implemented
 * @get_caps: Retrieve DSP capabilities, mandatory
 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
 */
struct snd_compr_ops {
	int (*open)(struct snd_compr_stream *stream);
	int (*free)(struct snd_compr_stream *stream);
	int (*set_params)(struct snd_compr_stream *stream,
			struct snd_compr_params *params);
	int (*get_params)(struct snd_compr_stream *stream,
			struct snd_codec *params);
	int (*set_metadata)(struct snd_compr_stream *stream,
			struct snd_compr_metadata *metadata);
	int (*get_metadata)(struct snd_compr_stream *stream,
			struct snd_compr_metadata *metadata);
	int (*trigger)(struct snd_compr_stream *stream, int cmd);
	int (*pointer)(struct snd_compr_stream *stream,
			struct snd_compr_tstamp *tstamp);
	int (*copy)(struct snd_compr_stream *stream, char __user *buf,
		       size_t count);
	int (*mmap)(struct snd_compr_stream *stream,
			struct vm_area_struct *vma);
	int (*ack)(struct snd_compr_stream *stream, size_t bytes);
	int (*get_caps) (struct snd_compr_stream *stream,
			struct snd_compr_caps *caps);
	int (*get_codec_caps) (struct snd_compr_stream *stream,
			struct snd_compr_codec_caps *codec);
};

/**
 * struct snd_compr: Compressed device
 * @name: DSP device name
 * @dev: associated device instance
 * @ops: pointer to DSP callbacks
 * @private_data: pointer to DSP pvt data
 * @card: sound card pointer
 * @direction: Playback or capture direction
 * @lock: device lock
 * @device: device id
 */
struct snd_compr {
	const char *name;
	struct device dev;
	struct snd_compr_ops *ops;
	void *private_data;
	struct snd_card *card;
	unsigned int direction;
	struct mutex lock;
	int device;
#ifdef CONFIG_SND_VERBOSE_PROCFS
	char id[64];
	struct snd_info_entry *proc_root;
	struct snd_info_entry *proc_info_entry;
#endif
};

/* compress device register APIs */
int snd_compress_register(struct snd_compr *device);
int snd_compress_deregister(struct snd_compr *device);
int snd_compress_new(struct snd_card *card, int device,
			int type, const char *id, struct snd_compr *compr);

/* dsp driver callback apis
 * For playback: driver should call snd_compress_fragment_elapsed() to let the
 * framework know that a fragment has been consumed from the ring buffer
 *
 * For recording: we want to know when a frame is available or when
 * at least one frame is available so snd_compress_frame_elapsed()
 * callback should be called when a encodeded frame is available
 */
static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
{
	wake_up(&stream->runtime->sleep);
}

static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
{
	if (snd_BUG_ON(!stream))
		return;

	stream->runtime->state = SNDRV_PCM_STATE_SETUP;
	wake_up(&stream->runtime->sleep);
}

#endif
Commit	Line	Data
e60061a3 VK	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>
7b617289	30	#include <sound/core.h>
e60061a3 VK	31	#include <sound/compress_offload.h>
	32	#include <sound/asound.h>
	33	#include <sound/pcm.h>
	34
	35	struct 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
e60061a3 VK	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
859b2e37	50	* @private_data: driver private data pointer
e60061a3 VK	51	*/
	52	struct 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;
e60061a3 VK	59	u64 total_bytes_available;
	60	u64 total_bytes_transferred;
	61	wait_queue_head_t sleep;
49681077	62	void *private_data;
e60061a3 VK	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
9727b490	72	* @metadata_set: metadata set flag, true when set
1a6ab46f	73	* @next_track: has userspace signal next track transition, true when set
e60061a3 VK	74	* @private_data: pointer to DSP private data
	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	enum snd_compr_direction direction;
9727b490 JK	82	bool metadata_set;
9727b490 JK	83	bool next_track;
e60061a3 VK	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
859b2e37	97	* @set_metadata: Set the metadata values for a stream
1a6ab46f	98	* @get_metadata: retrieves the requested metadata values from stream
e60061a3 VK	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	*/
	110	struct 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);
9727b490 JK	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);
e60061a3 VK	121	int (trigger)(struct snd_compr_stream stream, int cmd);
	122	int (pointer)(struct snd_compr_stream stream,
	123	struct snd_compr_tstamp *tstamp);
4daf891c	124	int (copy)(struct snd_compr_stream stream, char __user *buf,
e60061a3 VK	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
04c5d5a4	138	* @dev: associated device instance
e60061a3 VK	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	*/
	146	struct snd_compr {
	147	const char *name;
04c5d5a4	148	struct device dev;
e60061a3 VK	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;
31742724 RF	155	#ifdef CONFIG_SND_VERBOSE_PROCFS
	156	char id[64];
	157	struct snd_info_entry *proc_root;
	158	struct snd_info_entry *proc_info_entry;
	159	#endif
e60061a3 VK	160	};
	161
	162	/* compress device register APIs */
	163	int snd_compress_register(struct snd_compr *device);
	164	int snd_compress_deregister(struct snd_compr *device);
	165	int snd_compress_new(struct snd_card *card, int device,
e5241a8c	166	int type, const char id, struct snd_compr compr);
e60061a3 VK	167
	168	/* dsp driver callback apis
	169	* For playback: driver should call snd_compress_fragment_elapsed() to let the
	170	* framework know that a fragment has been consumed from the ring buffer
	171	*
	172	* For recording: we want to know when a frame is available or when
	173	* at least one frame is available so snd_compress_frame_elapsed()
	174	* callback should be called when a encodeded frame is available
	175	*/
	176	static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
	177	{
	178	wake_up(&stream->runtime->sleep);
	179	}
	180
917f4b5c VK	181	static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
917f4b5c VK	182	{
f44f2a54 VK	183	if (snd_BUG_ON(!stream))
f44f2a54 VK	184	return;
917f4b5c	185
f44f2a54 VK	186	stream->runtime->state = SNDRV_PCM_STATE_SETUP;
f44f2a54 VK	187	wake_up(&stream->runtime->sleep);
917f4b5c VK	188	}
917f4b5c VK	189
e60061a3	190	#endif