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