LXR linux/include/sound/compress

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