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 34 struct 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 * @total_bytes_available: cumulative number of bytes made available in 46 * the ring buffer 47 * @total_bytes_transferred: cumulative bytes transferred by offload DSP 48 * @sleep: poll sleep 49 * @private_data: driver private data pointer 50 */ 51 struct snd_compr_runtime { 52 snd_pcm_state_t state; 53 struct snd_compr_ops *ops; 54 void *buffer; 55 u64 buffer_size; 56 u32 fragment_size; 57 u32 fragments; 58 u64 total_bytes_available; 59 u64 total_bytes_transferred; 60 wait_queue_head_t sleep; 61 void *private_data; 62 }; 63 64 /** 65 * struct snd_compr_stream: compressed stream 66 * @name: device name 67 * @ops: pointer to DSP callbacks 68 * @runtime: pointer to runtime structure 69 * @device: device pointer 70 * @direction: stream direction, playback/recording 71 * @metadata_set: metadata set flag, true when set 72 * @next_track: has userspace signall next track transistion, true when set 73 * @private_data: pointer to DSP private data 74 */ 75 struct snd_compr_stream { 76 const char *name; 77 struct snd_compr_ops *ops; 78 struct snd_compr_runtime *runtime; 79 struct snd_compr *device; 80 enum snd_compr_direction direction; 81 bool metadata_set; 82 bool next_track; 83 void *private_data; 84 }; 85 86 /** 87 * struct snd_compr_ops: compressed path DSP operations 88 * @open: Open the compressed stream 89 * This callback is mandatory and shall keep dsp ready to receive the stream 90 * parameter 91 * @free: Close the compressed stream, mandatory 92 * @set_params: Sets the compressed stream parameters, mandatory 93 * This can be called in during stream creation only to set codec params 94 * and the stream properties 95 * @get_params: retrieve the codec parameters, mandatory 96 * @set_metadata: Set the metadata values for a stream 97 * @get_metadata: retreives the requested metadata values from stream 98 * @trigger: Trigger operations like start, pause, resume, drain, stop. 99 * This callback is mandatory 100 * @pointer: Retrieve current h/w pointer information. Mandatory 101 * @copy: Copy the compressed data to/from userspace, Optional 102 * Can't be implemented if DSP supports mmap 103 * @mmap: DSP mmap method to mmap DSP memory 104 * @ack: Ack for DSP when data is written to audio buffer, Optional 105 * Not valid if copy is implemented 106 * @get_caps: Retrieve DSP capabilities, mandatory 107 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory 108 */ 109 struct snd_compr_ops { 110 int (*open)(struct snd_compr_stream *stream); 111 int (*free)(struct snd_compr_stream *stream); 112 int (*set_params)(struct snd_compr_stream *stream, 113 struct snd_compr_params *params); 114 int (*get_params)(struct snd_compr_stream *stream, 115 struct snd_codec *params); 116 int (*set_metadata)(struct snd_compr_stream *stream, 117 struct snd_compr_metadata *metadata); 118 int (*get_metadata)(struct snd_compr_stream *stream, 119 struct snd_compr_metadata *metadata); 120 int (*trigger)(struct snd_compr_stream *stream, int cmd); 121 int (*pointer)(struct snd_compr_stream *stream, 122 struct snd_compr_tstamp *tstamp); 123 int (*copy)(struct snd_compr_stream *stream, char __user *buf, 124 size_t count); 125 int (*mmap)(struct snd_compr_stream *stream, 126 struct vm_area_struct *vma); 127 int (*ack)(struct snd_compr_stream *stream, size_t bytes); 128 int (*get_caps) (struct snd_compr_stream *stream, 129 struct snd_compr_caps *caps); 130 int (*get_codec_caps) (struct snd_compr_stream *stream, 131 struct snd_compr_codec_caps *codec); 132 }; 133 134 /** 135 * struct snd_compr: Compressed device 136 * @name: DSP device name 137 * @dev: Device pointer 138 * @ops: pointer to DSP callbacks 139 * @private_data: pointer to DSP pvt data 140 * @card: sound card pointer 141 * @direction: Playback or capture direction 142 * @lock: device lock 143 * @device: device id 144 */ 145 struct snd_compr { 146 const char *name; 147 struct device *dev; 148 struct snd_compr_ops *ops; 149 void *private_data; 150 struct snd_card *card; 151 unsigned int direction; 152 struct mutex lock; 153 int device; 154 }; 155 156 /* compress device register APIs */ 157 int snd_compress_register(struct snd_compr *device); 158 int snd_compress_deregister(struct snd_compr *device); 159 int snd_compress_new(struct snd_card *card, int device, 160 int type, struct snd_compr *compr); 161 162 /* dsp driver callback apis 163 * For playback: driver should call snd_compress_fragment_elapsed() to let the 164 * framework know that a fragment has been consumed from the ring buffer 165 * 166 * For recording: we want to know when a frame is available or when 167 * at least one frame is available so snd_compress_frame_elapsed() 168 * callback should be called when a encodeded frame is available 169 */ 170 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream) 171 { 172 wake_up(&stream->runtime->sleep); 173 } 174 175 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream) 176 { 177 if (snd_BUG_ON(!stream)) 178 return; 179 180 stream->runtime->state = SNDRV_PCM_STATE_SETUP; 181 wake_up(&stream->runtime->sleep); 182 } 183 184 #endif 185