blob: ff6c74153fa1045279c4366afc913ca39f9a39ae [file] [log] [blame]
Vinod Koule60061a2011-12-23 10:36:38 +05301/*
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 hw_pointer;
60 u64 app_pointer;
61 u64 total_bytes_available;
62 u64 total_bytes_transferred;
63 wait_queue_head_t sleep;
Vinod Koul49681072012-08-16 17:10:40 +053064 void *private_data;
Vinod Koule60061a2011-12-23 10:36:38 +053065};
66
67/**
68 * struct snd_compr_stream: compressed stream
69 * @name: device name
70 * @ops: pointer to DSP callbacks
71 * @runtime: pointer to runtime structure
72 * @device: device pointer
73 * @direction: stream direction, playback/recording
Jeeja KP9727b492013-02-14 16:52:51 +053074 * @metadata_set: metadata set flag, true when set
75 * @next_track: has userspace signall next track transistion, true when set
Vinod Koule60061a2011-12-23 10:36:38 +053076 * @private_data: pointer to DSP private data
77 */
78struct snd_compr_stream {
79 const char *name;
80 struct snd_compr_ops *ops;
81 struct snd_compr_runtime *runtime;
82 struct snd_compr *device;
83 enum snd_compr_direction direction;
Jeeja KP9727b492013-02-14 16:52:51 +053084 bool metadata_set;
85 bool next_track;
Vinod Koule60061a2011-12-23 10:36:38 +053086 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 * @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);
Jeeja KP9727b492013-02-14 16:52:51 +0530117 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);
Vinod Koule60061a2011-12-23 10:36:38 +0530121 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, const 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: Device pointer
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};
156
157/* compress device register APIs */
158int snd_compress_register(struct snd_compr *device);
159int snd_compress_deregister(struct snd_compr *device);
160int snd_compress_new(struct snd_card *card, int device,
161 int type, struct snd_compr *compr);
162
163/* dsp driver callback apis
164 * For playback: driver should call snd_compress_fragment_elapsed() to let the
165 * framework know that a fragment has been consumed from the ring buffer
166 *
167 * For recording: we want to know when a frame is available or when
168 * at least one frame is available so snd_compress_frame_elapsed()
169 * callback should be called when a encodeded frame is available
170 */
171static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
172{
173 wake_up(&stream->runtime->sleep);
174}
175
176#endif