include/sound/compress_driver.h

   1 /* SPDX-License-Identifier: GPL-2.0
   2  *
   3  *  compress_driver.h - compress offload driver definations
   4  *
   5  *  Copyright (C) 2011 Intel Corporation
   6  *  Authors:    Vinod Koul <vinod.koul@linux.intel.com>
   7  *              Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
   8  */
   9
  10 #ifndef __COMPRESS_DRIVER_H
  11 #define __COMPRESS_DRIVER_H
  12
  13 #include <linux/types.h>
  14 #include <linux/sched.h>
  15 #include <sound/core.h>
  16 #include <sound/compress_offload.h>
  17 #include <sound/asound.h>
  18 #include <sound/pcm.h>
  19
  20 struct snd_compr_ops;
  21
  22 /**
  23  * struct snd_compr_runtime: runtime stream description
  24  * @state: stream state
  25  * @ops: pointer to DSP callbacks
  26  * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
  27  *      DSP doesn't implement copy
  28  * @buffer_size: size of the above buffer
  29  * @fragment_size: size of buffer fragment in bytes
  30  * @fragments: number of such fragments
  31  * @total_bytes_available: cumulative number of bytes made available in
  32  *      the ring buffer
  33  * @total_bytes_transferred: cumulative bytes transferred by offload DSP
  34  * @sleep: poll sleep
  35  * @private_data: driver private data pointer
  36  * @dma_area: virtual buffer address
  37  * @dma_addr: physical buffer address (not accessible from main CPU)
  38  * @dma_bytes: size of DMA area
  39  * @dma_buffer_p: runtime dma buffer pointer
  40  */
  41 struct snd_compr_runtime {
  42         snd_pcm_state_t state;
  43         struct snd_compr_ops *ops;
  44         void *buffer;
  45         u64 buffer_size;
  46         u32 fragment_size;
  47         u32 fragments;
  48         u64 total_bytes_available;
  49         u64 total_bytes_transferred;
  50         wait_queue_head_t sleep;
  51         void *private_data;
  52
  53         unsigned char *dma_area;
  54         dma_addr_t dma_addr;
  55         size_t dma_bytes;
  56         struct snd_dma_buffer *dma_buffer_p;
  57 };
  58
  59 /**
  60  * struct snd_compr_stream: compressed stream
  61  * @name: device name
  62  * @ops: pointer to DSP callbacks
  63  * @runtime: pointer to runtime structure
  64  * @device: device pointer
  65  * @error_work: delayed work used when closing the stream due to an error
  66  * @direction: stream direction, playback/recording
  67  * @metadata_set: metadata set flag, true when set
  68  * @next_track: has userspace signal next track transition, true when set
  69  * @private_data: pointer to DSP private data
  70  * @dma_buffer: allocated buffer if any
  71  */
  72 struct snd_compr_stream {
  73         const char *name;
  74         struct snd_compr_ops *ops;
  75         struct snd_compr_runtime *runtime;
  76         struct snd_compr *device;
  77         struct delayed_work error_work;
  78         enum snd_compr_direction direction;
  79         bool metadata_set;
  80         bool next_track;
  81         void *private_data;
  82         struct snd_dma_buffer dma_buffer;
  83 };
  84
  85 /**
  86  * struct snd_compr_ops: compressed path DSP operations
  87  * @open: Open the compressed stream
  88  * This callback is mandatory and shall keep dsp ready to receive the stream
  89  * parameter
  90  * @free: Close the compressed stream, mandatory
  91  * @set_params: Sets the compressed stream parameters, mandatory
  92  * This can be called in during stream creation only to set codec params
  93  * and the stream properties
  94  * @get_params: retrieve the codec parameters, mandatory
  95  * @set_metadata: Set the metadata values for a stream
  96  * @get_metadata: retrieves the requested metadata values from stream
  97  * @trigger: Trigger operations like start, pause, resume, drain, stop.
  98  * This callback is mandatory
  99  * @pointer: Retrieve current h/w pointer information. Mandatory
 100  * @copy: Copy the compressed data to/from userspace, Optional
 101  * Can't be implemented if DSP supports mmap
 102  * @mmap: DSP mmap method to mmap DSP memory
 103  * @ack: Ack for DSP when data is written to audio buffer, Optional
 104  * Not valid if copy is implemented
 105  * @get_caps: Retrieve DSP capabilities, mandatory
 106  * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
 107  */
 108 struct snd_compr_ops {
 109         int (*open)(struct snd_compr_stream *stream);
 110         int (*free)(struct snd_compr_stream *stream);
 111         int (*set_params)(struct snd_compr_stream *stream,
 112                         struct snd_compr_params *params);
 113         int (*get_params)(struct snd_compr_stream *stream,
 114                         struct snd_codec *params);
 115         int (*set_metadata)(struct snd_compr_stream *stream,
 116                         struct snd_compr_metadata *metadata);
 117         int (*get_metadata)(struct snd_compr_stream *stream,
 118                         struct snd_compr_metadata *metadata);
 119         int (*trigger)(struct snd_compr_stream *stream, int cmd);
 120         int (*pointer)(struct snd_compr_stream *stream,
 121                         struct snd_compr_tstamp *tstamp);
 122         int (*copy)(struct snd_compr_stream *stream, char __user *buf,
 123                        size_t count);
 124         int (*mmap)(struct snd_compr_stream *stream,
 125                         struct vm_area_struct *vma);
 126         int (*ack)(struct snd_compr_stream *stream, size_t bytes);
 127         int (*get_caps) (struct snd_compr_stream *stream,
 128                         struct snd_compr_caps *caps);
 129         int (*get_codec_caps) (struct snd_compr_stream *stream,
 130                         struct snd_compr_codec_caps *codec);
 131 };
 132
 133 /**
 134  * struct snd_compr: Compressed device
 135  * @name: DSP device name
 136  * @dev: associated device instance
 137  * @ops: pointer to DSP callbacks
 138  * @private_data: pointer to DSP pvt data
 139  * @card: sound card pointer
 140  * @direction: Playback or capture direction
 141  * @lock: device lock
 142  * @device: device id
 143  */
 144 struct snd_compr {
 145         const char *name;
 146         struct device dev;
 147         struct snd_compr_ops *ops;
 148         void *private_data;
 149         struct snd_card *card;
 150         unsigned int direction;
 151         struct mutex lock;
 152         int device;
 153 #ifdef CONFIG_SND_VERBOSE_PROCFS
 154         /* private: */
 155         char id[64];
 156         struct snd_info_entry *proc_root;
 157         struct snd_info_entry *proc_info_entry;
 158 #endif
 159 };
 160
 161 /* compress device register APIs */
 162 int snd_compress_register(struct snd_compr *device);
 163 int snd_compress_deregister(struct snd_compr *device);
 164 int snd_compress_new(struct snd_card *card, int device,
 165                         int type, const char *id, struct snd_compr *compr);
 166
 167 /* dsp driver callback apis
 168  * For playback: driver should call snd_compress_fragment_elapsed() to let the
 169  * framework know that a fragment has been consumed from the ring buffer
 170  *
 171  * For recording: we want to know when a frame is available or when
 172  * at least one frame is available so snd_compress_frame_elapsed()
 173  * callback should be called when a encodeded frame is available
 174  */
 175 static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
 176 {
 177         wake_up(&stream->runtime->sleep);
 178 }
 179
 180 static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
 181 {
 182         if (snd_BUG_ON(!stream))
 183                 return;
 184
 185         stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 186
 187         wake_up(&stream->runtime->sleep);
 188 }
 189
 190 /**
 191  * snd_compr_set_runtime_buffer - Set the Compress runtime buffer
 192  * @stream: compress stream to set
 193  * @bufp: the buffer information, NULL to clear
 194  *
 195  * Copy the buffer information to runtime buffer when @bufp is non-NULL.
 196  * Otherwise it clears the current buffer information.
 197  */
 198 static inline void
 199 snd_compr_set_runtime_buffer(struct snd_compr_stream *stream,
 200                              struct snd_dma_buffer *bufp)
 201 {
 202         struct snd_compr_runtime *runtime = stream->runtime;
 203
 204         if (bufp) {
 205                 runtime->dma_buffer_p = bufp;
 206                 runtime->dma_area = bufp->area;
 207                 runtime->dma_addr = bufp->addr;
 208                 runtime->dma_bytes = bufp->bytes;
 209         } else {
 210                 runtime->dma_buffer_p = NULL;
 211                 runtime->dma_area = NULL;
 212                 runtime->dma_addr = 0;
 213                 runtime->dma_bytes = 0;
 214         }
 215 }
 216
 217 int snd_compr_malloc_pages(struct snd_compr_stream *stream, size_t size);
 218 int snd_compr_free_pages(struct snd_compr_stream *stream);
 219
 220 int snd_compr_stop_error(struct snd_compr_stream *stream,
 221                          snd_pcm_state_t state);
 222
 223 #endif