125981136fb13bcacf5f475f3e0ec750341e1e671Christopher Ferris/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/* 3224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * compress_offload.h - compress offload header definations 4224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 5224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * Copyright (C) 2011 Intel Corporation 6224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * Authors: Vinod Koul <vinod.koul@linux.intel.com> 7224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * Pierre-Louis Bossart <pierre-louis.bossart@linux.intel.com> 8224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 9224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 10224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * This program is free software; you can redistribute it and/or modify 11224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * it under the terms of the GNU General Public License as published by 12224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * the Free Software Foundation; version 2 of the License. 13224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 14224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * This program is distributed in the hope that it will be useful, but 15224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * WITHOUT ANY WARRANTY; without even the implied warranty of 16224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * General Public License for more details. 18224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 19224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * You should have received a copy of the GNU General Public License along 20224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * with this program; if not, write to the Free Software Foundation, Inc., 21224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 22224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 23224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 25224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 26224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#ifndef __COMPRESS_OFFLOAD_H 27224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define __COMPRESS_OFFLOAD_H 28224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 29224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#include <linux/types.h> 30224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#include <sound/asound.h> 31224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#include <sound/compress_params.h> 32224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 33224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 34e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris#define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2) 35224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 3612e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compressed_buffer - compressed buffer 37224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @fragment_size: size of buffer fragment in bytes 38224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @fragments: number of such fragments 39224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 40224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compressed_buffer { 41224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 fragment_size; 42224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 fragments; 43314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 44224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 45224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 4612e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_params - compressed stream params 47224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @buffer: buffer description 48224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @codec: codec parameters 49224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @no_wake_mode: dont wake on fragment elapsed 50224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 51224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_params { 52224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_compressed_buffer buffer; 53224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_codec codec; 54224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u8 no_wake_mode; 55314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 56224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 57224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 5812e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_tstamp - timestamp descriptor 59224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @byte_offset: Byte offset in ring buffer to DSP 60224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP 61224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by 62224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * large steps and should only be used to monitor encoding/decoding 63224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * progress. It shall not be used for timing estimates. 64224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @pcm_io_frames: Frames rendered or received by DSP into a mixer or an audio 65224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * output/input. This field should be used for A/V sync or time estimates. 66224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @sampling_rate: sampling rate of audio 67224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 68224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_tstamp { 69224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 byte_offset; 70224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 copied_total; 71e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris __u32 pcm_frames; 72e084501669a4e4931c9d648351ecd7d595b81b79Christopher Ferris __u32 pcm_io_frames; 73224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 sampling_rate; 74314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 75224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 76224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 7712e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_avail - avail descriptor 78224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @avail: Number of bytes available in ring buffer for writing/reading 7912e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * @tstamp: timestamp information 80224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 81224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_avail { 82224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u64 avail; 83224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_compr_tstamp tstamp; 84314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 85224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 86224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengenum snd_compr_direction { 87224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng SND_COMPRESS_PLAYBACK = 0, 88224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng SND_COMPRESS_CAPTURE 89224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng}; 90224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 91224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 9212e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_caps - caps descriptor 93224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @codecs: pointer to array of codecs 94224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @direction: direction supported. Of type snd_compr_direction 95224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @min_fragment_size: minimum fragment supported by DSP 96224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @max_fragment_size: maximum fragment supported by DSP 97224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @min_fragments: min fragments supported by DSP 98224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @max_fragments: max fragments supported by DSP 99224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @num_codecs: number of codecs supported 100224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @reserved: reserved field 101224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 102224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_caps { 103224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 num_codecs; 104224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 direction; 105224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 min_fragment_size; 106224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 max_fragment_size; 107224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 min_fragments; 108224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 max_fragments; 109224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 codecs[MAX_NUM_CODECS]; 110224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 reserved[11]; 111314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 112224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 113224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 11412e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_codec_caps - query capability of codec 115224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @codec: codec for which capability is queried 116224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @num_descriptors: number of codec descriptors 117224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @descriptor: array of codec capability descriptor 118224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 119224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_codec_caps { 120224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 codec; 121224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 num_descriptors; 122224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_codec_desc descriptor[MAX_NUM_CODEC_DESCRIPTORS]; 123314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 124224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 125224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 12612e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * enum sndrv_compress_encoder 127224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the 128224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * end of the track 129224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the 130224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * beginning of the track 131224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 13212e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferrisenum sndrv_compress_encoder { 133224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng SNDRV_COMPRESS_ENCODER_PADDING = 1, 134224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng SNDRV_COMPRESS_ENCODER_DELAY = 2, 135224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng}; 136224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 137224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 13812e1f28cce28271eb109a5bae818a804f0c3bb27Christopher Ferris * struct snd_compr_metadata - compressed stream metadata 139224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @key: key id 140224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * @value: key value 141224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 142224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Chengstruct snd_compr_metadata { 143224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 key; 144224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng __u32 value[8]; 145314752488cb92b9f86028836d0b8eabd8acb6a7cChristopher Ferris} __attribute__((packed, aligned(4))); 146224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng 147224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/** 148224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * compress path ioctl definitions 149224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_GET_CAPS: Query capability of DSP 150224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_GET_CODEC_CAPS: Query capability of a codec 151224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_SET_PARAMS: Set codec and stream parameters 152224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * Note: only codec params can be changed runtime and stream params cant be 153224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_GET_PARAMS: Query codec params 154224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_TSTAMP: get the current timestamp value 155224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_AVAIL: get the current buffer avail value. 156224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * This also queries the tstamp properties 157224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_PAUSE: Pause the running stream 158224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_RESUME: resume a paused stream 159224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_START: Start a stream 160224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_STOP: stop a running stream, discarding ring buffer content 161224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * and the buffers currently with DSP 162224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_DRAIN: Play till end of buffers and stop after that 163224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * SNDRV_COMPRESS_IOCTL_VERSION: Query the API version 164224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 165224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_IOCTL_VERSION _IOR('C', 0x00, int) 166224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_GET_CAPS _IOWR('C', 0x10, struct snd_compr_caps) 167224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_GET_CODEC_CAPS _IOWR('C', 0x11,\ 168224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_compr_codec_caps) 169224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_SET_PARAMS _IOW('C', 0x12, struct snd_compr_params) 170224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_GET_PARAMS _IOR('C', 0x13, struct snd_codec) 171224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_SET_METADATA _IOW('C', 0x14,\ 172224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_compr_metadata) 173224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_GET_METADATA _IOWR('C', 0x15,\ 174224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng struct snd_compr_metadata) 175224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_TSTAMP _IOR('C', 0x20, struct snd_compr_tstamp) 176224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_AVAIL _IOR('C', 0x21, struct snd_compr_avail) 177224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_PAUSE _IO('C', 0x30) 178224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_RESUME _IO('C', 0x31) 179224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_START _IO('C', 0x32) 180224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_STOP _IO('C', 0x33) 181224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_DRAIN _IO('C', 0x34) 182224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_NEXT_TRACK _IO('C', 0x35) 183224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SNDRV_COMPRESS_PARTIAL_DRAIN _IO('C', 0x36) 184224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng/* 185224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * TODO 186224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 1. add mmap support 187224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng * 188224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng */ 189224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SND_COMPR_TRIGGER_DRAIN 7 /*FIXME move this to pcm.h */ 190224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SND_COMPR_TRIGGER_NEXT_TRACK 8 191224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#define SND_COMPR_TRIGGER_PARTIAL_DRAIN 9 192224b54f69543a5c0ec18f99bd717d2b724582eb6Ben Cheng#endif 193