/* SPDX-License-Identifier: GPL-2.0
 *
 *  compress_driver.h - compress offload driver definations
 *
 *  Copyright (C) 2011 Intel Corporation
 *  Authors: Vinod Koul <vinod.koul@linux.intel.com>
 *  Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com>
 */

#ifndef __COMPRESS_DRIVER_H
#define __COMPRESS_DRIVER_H

#include <linux/types.h>
#include <linux/sched.h>
#include <sound/core.h>
#include <sound/compress_offload.h>
#include <sound/asound.h>
#include <sound/pcm.h>

struct snd_compr_ops;

/**
 * struct snd_compr_task_runtime: task runtime description
 * @list: list of all managed tasks
 * @input: input DMA buffer
 * @output: output DMA buffer
 * @seqno: sequence number
 * @input_size: really used data in the input buffer
 * @output_size: really used data in the output buffer
 * @flags: see SND_COMPRESS_TFLG_*
 * @state: actual task state
 * @private_value: used by the lowlevel driver (opaque)
 */
struct snd_compr_task_runtime {
 struct list_head list;
 struct dma_buf *input;
 struct dma_buf *output;
 u64 seqno;
 u64 input_size;
 u64 output_size;
 u32 flags;
 u8 state;
 void *private_value;
};

/**
 * struct snd_compr_runtime: runtime stream description
 * @state: stream state
 * @ops: pointer to DSP callbacks
 * @buffer: pointer to kernel buffer, valid only when not in mmap mode or
 * DSP doesn't implement copy
 * @buffer_size: size of the above buffer
 * @fragment_size: size of buffer fragment in bytes
 * @fragments: number of such fragments
 * @total_bytes_available: cumulative number of bytes made available in
 * the ring buffer
 * @total_bytes_transferred: cumulative bytes transferred by offload DSP
 * @sleep: poll sleep
 * @private_data: driver private data pointer
 * @dma_area: virtual buffer address
 * @dma_addr: physical buffer address (not accessible from main CPU)
 * @dma_bytes: size of DMA area
 * @dma_buffer_p: runtime dma buffer pointer
 * @active_tasks: count of active tasks
 * @total_tasks: count of all tasks
 * @task_seqno: last task sequence number (!= 0)
 * @tasks: list of all tasks
 */
struct snd_compr_runtime {
 snd_pcm_state_t state;
 struct snd_compr_ops *ops;
 void *buffer;
 u64 buffer_size;
 u32 fragment_size;
 u32 fragments;
 u64 total_bytes_available;
 u64 total_bytes_transferred;
 wait_queue_head_t sleep;
 void *private_data;

 unsigned char *dma_area;
 dma_addr_t dma_addr;
 size_t dma_bytes;
 struct snd_dma_buffer *dma_buffer_p;

#if IS_ENABLED(CONFIG_SND_COMPRESS_ACCEL)
 u32 active_tasks;
 u32 total_tasks;
 u64 task_seqno;
 struct list_head tasks;
#endif
};

/**
 * struct snd_compr_stream: compressed stream
 * @name: device name
 * @ops: pointer to DSP callbacks
 * @runtime: pointer to runtime structure
 * @device: device pointer
 * @error_work: delayed work used when closing the stream due to an error
 * @direction: stream direction, playback/recording
 * @metadata_set: metadata set flag, true when set
 * @next_track: has userspace signal next track transition, true when set
 * @partial_drain: undergoing partial_drain for stream, true when set
 * @pause_in_draining: paused during draining state, true when set
 * @private_data: pointer to DSP private data
 * @dma_buffer: allocated buffer if any
 */
struct snd_compr_stream {
 const char *name;
 struct snd_compr_ops *ops;
 struct snd_compr_runtime *runtime;
 struct snd_compr *device;
 struct delayed_work error_work;
 enum snd_compr_direction direction;
 bool metadata_set;
 bool next_track;
 bool partial_drain;
 bool pause_in_draining;
 void *private_data;
 struct snd_dma_buffer dma_buffer;
};

/**
 * struct snd_compr_ops: compressed path DSP operations
 * @open: Open the compressed stream
 * This callback is mandatory and shall keep dsp ready to receive the stream
 * parameter
 * @free: Close the compressed stream, mandatory
 * @set_params: Sets the compressed stream parameters, mandatory
 * This can be called in during stream creation only to set codec params
 * and the stream properties
 * @get_params: retrieve the codec parameters, mandatory
 * @set_metadata: Set the metadata values for a stream
 * @get_metadata: retrieves the requested metadata values from stream
 * @trigger: Trigger operations like start, pause, resume, drain, stop.
 * This callback is mandatory
 * @pointer: Retrieve current h/w pointer information. Mandatory
 * @copy: Copy the compressed data to/from userspace, Optional
 * Can't be implemented if DSP supports mmap
 * @mmap: DSP mmap method to mmap DSP memory
 * @ack: Ack for DSP when data is written to audio buffer, Optional
 * Not valid if copy is implemented
 * @get_caps: Retrieve DSP capabilities, mandatory
 * @get_codec_caps: Retrieve capabilities for a specific codec, mandatory
 * @task_create: Create a set of input/output buffers for accel operations
 * @task_start: Start (queue) a task for accel operations
 * @task_stop: Stop (dequeue) a task for accel operations
 * @task_free: Free a set of input/output buffers for accel operations
 */
struct snd_compr_ops {
 int (*open)(struct snd_compr_stream *stream);
 int (*free)(struct snd_compr_stream *stream);
 int (*set_params)(struct snd_compr_stream *stream,
   struct snd_compr_params *params);
 int (*get_params)(struct snd_compr_stream *stream,
   struct snd_codec *params);
 int (*set_metadata)(struct snd_compr_stream *stream,
   struct snd_compr_metadata *metadata);
 int (*get_metadata)(struct snd_compr_stream *stream,
   struct snd_compr_metadata *metadata);
 int (*trigger)(struct snd_compr_stream *stream, int cmd);
 int (*pointer)(struct snd_compr_stream *stream,
   struct snd_compr_tstamp *tstamp);
 int (*copy)(struct snd_compr_stream *stream, char __user *buf,
         size_t count);
 int (*mmap)(struct snd_compr_stream *stream,
   struct vm_area_struct *vma);
 int (*ack)(struct snd_compr_stream *stream, size_t bytes);
 int (*get_caps) (struct snd_compr_stream *stream,
   struct snd_compr_caps *caps);
 int (*get_codec_caps) (struct snd_compr_stream *stream,
   struct snd_compr_codec_caps *codec);
#if IS_ENABLED(CONFIG_SND_COMPRESS_ACCEL)
 int (*task_create) (struct snd_compr_stream *stream, struct snd_compr_task_runtime *task);
 int (*task_start) (struct snd_compr_stream *stream, struct snd_compr_task_runtime *task);
 int (*task_stop) (struct snd_compr_stream *stream, struct snd_compr_task_runtime *task);
 int (*task_free) (struct snd_compr_stream *stream, struct snd_compr_task_runtime *task);
#endif
};

/**
 * struct snd_compr: Compressed device
 * @name: DSP device name
 * @dev: associated device instance
 * @ops: pointer to DSP callbacks
 * @private_data: pointer to DSP pvt data
 * @card: sound card pointer
 * @direction: Playback or capture direction
 * @lock: device lock
 * @device: device id
 * @use_pause_in_draining: allow pause in draining, true when set
 */
struct snd_compr {
 const char *name;
 struct device *dev;
 struct snd_compr_ops *ops;
 void *private_data;
 struct snd_card *card;
 unsigned int direction;
 struct mutex lock;
 int device;
 bool use_pause_in_draining;
#ifdef CONFIG_SND_VERBOSE_PROCFS
 /* private: */
 char id[64];
 struct snd_info_entry *proc_root;
 struct snd_info_entry *proc_info_entry;
#endif
};

/* compress device register APIs */
int snd_compress_new(struct snd_card *card, int device,
   int type, const char *id, struct snd_compr *compr);

/**
 * snd_compr_use_pause_in_draining - Allow pause and resume in draining state
 * @substream: compress substream to set
 *
 * Allow pause and resume in draining state.
 * Only HW driver supports this transition can call this API.
 */
static inline void snd_compr_use_pause_in_draining(struct snd_compr_stream *substream)
{
 substream->device->use_pause_in_draining = true;
}

/* dsp driver callback apis
 * For playback: driver should call snd_compress_fragment_elapsed() to let the
 * framework know that a fragment has been consumed from the ring buffer
 *
 * For recording: we want to know when a frame is available or when
 * at least one frame is available so snd_compress_frame_elapsed()
 * callback should be called when a encodeded frame is available
 */
static inline void snd_compr_fragment_elapsed(struct snd_compr_stream *stream)
{
 wake_up(&stream->runtime->sleep);
}

static inline void snd_compr_drain_notify(struct snd_compr_stream *stream)
{
 if (snd_BUG_ON(!stream))
  return;

 /* for partial_drain case we are back to running state on success */
 if (stream->partial_drain) {
  stream->runtime->state = SNDRV_PCM_STATE_RUNNING;
  stream->partial_drain = false; /* clear this flag as well */
 } else {
  stream->runtime->state = SNDRV_PCM_STATE_SETUP;
 }

 wake_up(&stream->runtime->sleep);
}

/**
 * snd_compr_set_runtime_buffer - Set the Compress runtime buffer
 * @stream: compress stream to set
 * @bufp: the buffer information, NULL to clear
 *
 * Copy the buffer information to runtime buffer when @bufp is non-NULL.
 * Otherwise it clears the current buffer information.
 */
static inline void
snd_compr_set_runtime_buffer(struct snd_compr_stream *stream,
        struct snd_dma_buffer *bufp)
{
 struct snd_compr_runtime *runtime = stream->runtime;

 if (bufp) {
  runtime->dma_buffer_p = bufp;
  runtime->dma_area = bufp->area;
  runtime->dma_addr = bufp->addr;
  runtime->dma_bytes = bufp->bytes;
 } else {
  runtime->dma_buffer_p = NULL;
  runtime->dma_area = NULL;
  runtime->dma_addr = 0;
  runtime->dma_bytes = 0;
 }
}

int snd_compr_malloc_pages(struct snd_compr_stream *stream, size_t size);
int snd_compr_free_pages(struct snd_compr_stream *stream);

int snd_compr_stop_error(struct snd_compr_stream *stream,
    snd_pcm_state_t state);

#if IS_ENABLED(CONFIG_SND_COMPRESS_ACCEL)
void snd_compr_task_finished(struct snd_compr_stream *stream,
        struct snd_compr_task_runtime *task);
#endif

#endif