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 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 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 */ 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; 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 */ 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; 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 * @set_metadata: Set the metadata values for a stream 98 * @get_metadata: retreives 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 */ 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); 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 */ 146 struct 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 */ 158 int snd_compress_register(struct snd_compr *device); 159 int snd_compress_deregister(struct snd_compr *device); 160 int 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 */ 171 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream) 172 { 173 wake_up(&stream->runtime->sleep); 174 } 175 176 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream) 177 { 178 if (snd_BUG_ON(!stream)) 179 return; 180 181 stream->runtime->state = SNDRV_PCM_STATE_SETUP; 182 wake_up(&stream->runtime->sleep); 183 } 184 185 #endif 186