include/sound/compress_driver.h

   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  * @error_work: delayed work used when closing the stream due to an error
  72  * @direction: stream direction, playback/recording
  73  * @metadata_set: metadata set flag, true when set
  74  * @next_track: has userspace signal next track transition, true when set
  75  * @partial_drain: undergoing partial_drain for stream, true when set
  76  * @private_data: pointer to DSP private data
  77  */
  78 struct 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         struct delayed_work error_work;
  84         enum snd_compr_direction direction;
  85         bool metadata_set;
  86         bool next_track;
  87         bool partial_drain;
  88         void *private_data;
  89 };
  90
  91 /**
  92  * struct snd_compr_ops: compressed path DSP operations
  93  * @open: Open the compressed stream
  94  * This callback is mandatory and shall keep dsp ready to receive the stream
  95  * parameter
  96  * @free: Close the compressed stream, mandatory
  97  * @set_params: Sets the compressed stream parameters, mandatory
  98  * This can be called in during stream creation only to set codec params
  99  * and the stream properties
 100  * @get_params: retrieve the codec parameters, mandatory
 101  * @set_metadata: Set the metadata values for a stream
 102  * @get_metadata: retrieves the requested metadata values from stream
 103  * @trigger: Trigger operations like start, pause, resume, drain, stop.
 104  * This callback is mandatory
 105  * @pointer: Retrieve current h/w pointer information. Mandatory
 106  * @copy: Copy the compressed data to/from userspace, Optional
 107  * Can't be implemented if DSP supports mmap
 108  * @mmap: DSP mmap method to mmap DSP memory
 109  * @ack: Ack for DSP when data is written to audio buffer, Optional
 110  * Not valid if copy is implemented
 111  * @get_caps: Retrieve DSP capabilities, mandatory
 112  * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
 113  */
 114 struct snd_compr_ops {
 115         int (*open)(struct snd_compr_stream *stream);
 116         int (*free)(struct snd_compr_stream *stream);
 117         int (*set_params)(struct snd_compr_stream *stream,
 118                         struct snd_compr_params *params);
 119         int (*get_params)(struct snd_compr_stream *stream,
 120                         struct snd_codec *params);
 121         int (*set_metadata)(struct snd_compr_stream *stream,
 122                         struct snd_compr_metadata *metadata);
 123         int (*get_metadata)(struct snd_compr_stream *stream,
 124                         struct snd_compr_metadata *metadata);
 125         int (*trigger)(struct snd_compr_stream *stream, int cmd);
 126         int (*pointer)(struct snd_compr_stream *stream,
 127                         struct snd_compr_tstamp *tstamp);
 128         int (*copy)(struct snd_compr_stream *stream, char __user *buf,
 129                        size_t count);
 130         int (*mmap)(struct snd_compr_stream *stream,
 131                         struct vm_area_struct *vma);
 132         int (*ack)(struct snd_compr_stream *stream, size_t bytes);
 133         int (*get_caps) (struct snd_compr_stream *stream,
 134                         struct snd_compr_caps *caps);
 135         int (*get_codec_caps) (struct snd_compr_stream *stream,
 136                         struct snd_compr_codec_caps *codec);
 137 };
 138
 139 /**
 140  * struct snd_compr: Compressed device
 141  * @name: DSP device name
 142  * @dev: associated device instance
 143  * @ops: pointer to DSP callbacks
 144  * @private_data: pointer to DSP pvt data
 145  * @card: sound card pointer
 146  * @direction: Playback or capture direction
 147  * @lock: device lock
 148  * @device: device id
 149  */
 150 struct snd_compr {
 151         const char *name;
 152         struct device dev;
 153         struct snd_compr_ops *ops;
 154         void *private_data;
 155         struct snd_card *card;
 156         unsigned int direction;
 157         struct mutex lock;
 158         int device;
 159 #ifdef CONFIG_SND_VERBOSE_PROCFS
 160         /* private: */
 161         char id[64];
 162         struct snd_info_entry *proc_root;
 163         struct snd_info_entry *proc_info_entry;
 164 #endif
 165 };
 166
 167 /* compress device register APIs */
 168 int snd_compress_register(struct snd_compr *device);
 169 int snd_compress_deregister(struct snd_compr *device);
 170 int snd_compress_new(struct snd_card *card, int device,
 171                         int type, const char *id, struct snd_compr *compr);
 172
 173 /* dsp driver callback apis
 174  * For playback: driver should call snd_compress_fragment_elapsed() to let the
 175  * framework know that a fragment has been consumed from the ring buffer
 176  *
 177  * For recording: we want to know when a frame is available or when
 178  * at least one frame is available so snd_compress_frame_elapsed()
 179  * callback should be called when a encodeded frame is available
 180  */
 181 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
 182 {
 183         wake_up(&stream->runtime->sleep);
 184 }
 185
 186 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
 187 {
 188         if (snd_BUG_ON(!stream))
 189                 return;
 190
 191         /* for partial_drain case we are back to running state on success */
 192         if (stream->partial_drain) {
 193                 stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
 194                 stream->partial_drain = false; /* clear this flag as well */
 195         } else {
 196                 stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 197         }
 198
 199         wake_up(&stream->runtime->sleep);
 200 }
 201
 202 int snd_compr_stop_error(struct snd_compr_stream *stream,
 203                          snd_pcm_state_t state);
 204
 205 #endif