1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * compress_offload.h - compress offload header 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 * This program is free software; you can redistribute it and/or modify 11 * it under the terms of the GNU General Public License as published by 12 * the Free Software Foundation; version 2 of the License. 13 * 14 * This program is distributed in the hope that it will be useful, but 15 * WITHOUT ANY WARRANTY; without even the implied warranty of 16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 17 * General Public License for more details. 18 * 19 * You should have received a copy of the GNU General Public License along 20 * with this program; if not, write to the Free Software Foundation, Inc., 21 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA. 22 * 23 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 24 * 25 */ 26 #ifndef __COMPRESS_OFFLOAD_H 27 #define __COMPRESS_OFFLOAD_H 28 29 #include <linux/types.h> 30 #include <sound/asound.h> 31 #include <sound/compress_params.h> 32 33 34 #define SNDRV_COMPRESS_VERSION SNDRV_PROTOCOL_VERSION(0, 1, 2) 35 /** 36 * struct snd_compressed_buffer - compressed buffer 37 * @fragment_size: size of buffer fragment in bytes 38 * @fragments: number of such fragments 39 */ 40 struct snd_compressed_buffer { 41 __u32 fragment_size; 42 __u32 fragments; 43 } __attribute__((packed, aligned(4))); 44 45 /** 46 * struct snd_compr_params - compressed stream params 47 * @buffer: buffer description 48 * @codec: codec parameters 49 * @no_wake_mode: dont wake on fragment elapsed 50 */ 51 struct snd_compr_params { 52 struct snd_compressed_buffer buffer; 53 struct snd_codec codec; 54 __u8 no_wake_mode; 55 } __attribute__((packed, aligned(4))); 56 57 /** 58 * struct snd_compr_tstamp - timestamp descriptor 59 * @byte_offset: Byte offset in ring buffer to DSP 60 * @copied_total: Total number of bytes copied from/to ring buffer to/by DSP 61 * @pcm_frames: Frames decoded or encoded by DSP. This field will evolve by 62 * large steps and should only be used to monitor encoding/decoding 63 * progress. It shall not be used for timing estimates. 64 * @pcm_io_frames: Frames rendered or received by DSP into a mixer or an audio 65 * output/input. This field should be used for A/V sync or time estimates. 66 * @sampling_rate: sampling rate of audio 67 * @timestamp: timestamp of audio clips 68 */ 69 struct snd_compr_tstamp { 70 __u32 byte_offset; 71 __u64 copied_total; 72 __u32 pcm_frames; 73 __u32 pcm_io_frames; 74 __u32 sampling_rate; 75 __u64 timestamp; 76 } __attribute__((packed, aligned(4))); 77 78 /** 79 * struct snd_compr_avail - avail descriptor 80 * @avail: Number of bytes available in ring buffer for writing/reading 81 * @tstamp: timestamp information 82 */ 83 struct snd_compr_avail { 84 __u64 avail; 85 struct snd_compr_tstamp tstamp; 86 } __attribute__((packed, aligned(4))); 87 88 enum snd_compr_direction { 89 SND_COMPRESS_PLAYBACK = 0, 90 SND_COMPRESS_CAPTURE 91 }; 92 93 /** 94 * struct snd_compr_caps - caps descriptor 95 * @codecs: pointer to array of codecs 96 * @direction: direction supported. Of type snd_compr_direction 97 * @min_fragment_size: minimum fragment supported by DSP 98 * @max_fragment_size: maximum fragment supported by DSP 99 * @min_fragments: min fragments supported by DSP 100 * @max_fragments: max fragments supported by DSP 101 * @num_codecs: number of codecs supported 102 * @reserved: reserved field 103 */ 104 struct snd_compr_caps { 105 __u32 num_codecs; 106 __u32 direction; 107 __u32 min_fragment_size; 108 __u32 max_fragment_size; 109 __u32 min_fragments; 110 __u32 max_fragments; 111 __u32 codecs[MAX_NUM_CODECS]; 112 __u32 reserved[11]; 113 } __attribute__((packed, aligned(4))); 114 115 /** 116 * struct snd_compr_codec_caps - query capability of codec 117 * @codec: codec for which capability is queried 118 * @num_descriptors: number of codec descriptors 119 * @descriptor: array of codec capability descriptor 120 */ 121 struct snd_compr_codec_caps { 122 __u32 codec; 123 __u32 num_descriptors; 124 struct snd_codec_desc descriptor[MAX_NUM_CODEC_DESCRIPTORS]; 125 } __attribute__((packed, aligned(4))); 126 127 /** 128 * struct snd_compr_audio_info: compressed input audio information 129 * @frame_size: legth of the encoded frame with valid data 130 * @reserved: reserved for furture use 131 */ 132 struct snd_compr_audio_info { 133 __u32 frame_size; 134 __u32 reserved[15]; 135 } __attribute__((packed, aligned(4))); 136 137 #define SNDRV_COMPRESS_RENDER_MODE_AUDIO_MASTER 0 138 #define SNDRV_COMPRESS_RENDER_MODE_STC_MASTER 1 139 #define SNDRV_COMPRESS_RENDER_MODE_TTP 2 140 #define SNDRV_COMPRESS_RENDER_MODE_TTP_PASS_THROUGH 3 141 142 #define SNDRV_COMPRESS_CLK_REC_MODE_NONE 0 143 #define SNDRV_COMPRESS_CLK_REC_MODE_AUTO 1 144 145 #define SNDRV_COMPRESS_TIMESTAMP_VALID 0x00000000 146 #define SNDRV_COMPRESS_TIMESTAMP_CONTINUE 0x00000001 147 148 enum sndrv_compress_latency_mode { 149 SNDRV_COMPRESS_LEGACY_LATENCY_MODE = 0, 150 SNDRV_COMPRESS_LOW_LATENCY_MODE = 1, 151 }; 152 153 /** 154 * enum sndrv_compress_encoder 155 * @SNDRV_COMPRESS_ENCODER_PADDING: no of samples appended by the encoder at the 156 * end of the track 157 * @SNDRV_COMPRESS_ENCODER_DELAY: no of samples inserted by the encoder at the 158 * beginning of the track 159 * @SNDRV_COMPRESS_PATH_DELAY: dsp path delay in microseconds 160 * @SNDRV_COMPRESS_RENDER_MODE: dsp render mode (audio master or stc) 161 * @SNDRV_COMPRESS_CLK_REC_MODE: clock recovery mode ( none or auto) 162 * @SNDRV_COMPRESS_RENDER_WINDOW: render window 163 * @SNDRV_COMPRESS_START_DELAY: start delay 164 * @SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK: enable dsp drift correction 165 * @SNDRV_COMPRESS_ADJUST_SESSION_CLOCK: set drift correction value 166 */ 167 enum sndrv_compress_encoder { 168 SNDRV_COMPRESS_ENCODER_PADDING = 1, 169 SNDRV_COMPRESS_ENCODER_DELAY = 2, 170 SNDRV_COMPRESS_MIN_BLK_SIZE = 3, 171 SNDRV_COMPRESS_MAX_BLK_SIZE = 4, 172 SNDRV_COMPRESS_PATH_DELAY = 5, 173 SNDRV_COMPRESS_RENDER_MODE = 6, 174 SNDRV_COMPRESS_CLK_REC_MODE = 7, 175 SNDRV_COMPRESS_RENDER_WINDOW = 8, 176 SNDRV_COMPRESS_START_DELAY = 9, 177 SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK = 10, 178 SNDRV_COMPRESS_ADJUST_SESSION_CLOCK = 11, 179 SNDRV_COMPRESS_LATENCY_MODE = 12, 180 SNDRV_COMPRESS_IN_TTP_OFFSET = 13, 181 }; 182 183 #define SNDRV_COMPRESS_MIN_BLK_SIZE SNDRV_COMPRESS_MIN_BLK_SIZE 184 #define SNDRV_COMPRESS_MAX_BLK_SIZE SNDRV_COMPRESS_MAX_BLK_SIZE 185 #define SNDRV_COMPRESS_PATH_DELAY SNDRV_COMPRESS_PATH_DELAY 186 #define SNDRV_COMPRESS_RENDER_MODE SNDRV_COMPRESS_RENDER_MODE 187 #define SNDRV_COMPRESS_CLK_REC_MODE SNDRV_COMPRESS_CLK_REC_MODE 188 #define SNDRV_COMPRESS_RENDER_WINDOW SNDRV_COMPRESS_RENDER_WINDOW 189 #define SNDRV_COMPRESS_START_DELAY SNDRV_COMPRESS_START_DELAY 190 #define SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK \ 191 SNDRV_COMPRESS_ENABLE_ADJUST_SESSION_CLOCK 192 #define SNDRV_COMPRESS_ADJUST_SESSION_CLOCK SNDRV_COMPRESS_ADJUST_SESSION_CLOCK 193 #define SNDRV_COMPRESS_LATENCY_MODE SNDRV_COMPRESS_LATENCY_MODE 194 #define SNDRV_COMPRESS_IN_TTP_OFFSET SNDRV_COMPRESS_IN_TTP_OFFSET 195 196 /** 197 * struct snd_compr_metadata - compressed stream metadata 198 * @key: key id 199 * @value: key value 200 */ 201 struct snd_compr_metadata { 202 __u32 key; 203 __u32 value[8]; 204 } __attribute__((packed, aligned(4))); 205 206 /** 207 * compress path ioctl definitions 208 * SNDRV_COMPRESS_GET_CAPS: Query capability of DSP 209 * SNDRV_COMPRESS_GET_CODEC_CAPS: Query capability of a codec 210 * SNDRV_COMPRESS_SET_PARAMS: Set codec and stream parameters 211 * Note: only codec params can be changed runtime and stream params cant be 212 * SNDRV_COMPRESS_GET_PARAMS: Query codec params 213 * SNDRV_COMPRESS_TSTAMP: get the current timestamp value 214 * SNDRV_COMPRESS_AVAIL: get the current buffer avail value. 215 * This also queries the tstamp properties 216 * SNDRV_COMPRESS_PAUSE: Pause the running stream 217 * SNDRV_COMPRESS_RESUME: resume a paused stream 218 * SNDRV_COMPRESS_START: Start a stream 219 * SNDRV_COMPRESS_STOP: stop a running stream, discarding ring buffer content 220 * and the buffers currently with DSP 221 * SNDRV_COMPRESS_DRAIN: Play till end of buffers and stop after that 222 * SNDRV_COMPRESS_SET_NEXT_TRACK_PARAM: send codec specific data for the next 223 * track in gapless 224 * SNDRV_COMPRESS_IOCTL_VERSION: Query the API version 225 */ 226 #define SNDRV_COMPRESS_IOCTL_VERSION _IOR('C', 0x00, int) 227 #define SNDRV_COMPRESS_GET_CAPS _IOWR('C', 0x10, struct snd_compr_caps) 228 #define SNDRV_COMPRESS_GET_CODEC_CAPS _IOWR('C', 0x11,\ 229 struct snd_compr_codec_caps) 230 #define SNDRV_COMPRESS_SET_PARAMS _IOW('C', 0x12, struct snd_compr_params) 231 #define SNDRV_COMPRESS_GET_PARAMS _IOR('C', 0x13, struct snd_codec) 232 #define SNDRV_COMPRESS_SET_METADATA _IOW('C', 0x14,\ 233 struct snd_compr_metadata) 234 #define SNDRV_COMPRESS_GET_METADATA _IOWR('C', 0x15,\ 235 struct snd_compr_metadata) 236 #define SNDRV_COMPRESS_TSTAMP _IOR('C', 0x20, struct snd_compr_tstamp) 237 #define SNDRV_COMPRESS_AVAIL _IOR('C', 0x21, struct snd_compr_avail) 238 #define SNDRV_COMPRESS_PAUSE _IO('C', 0x30) 239 #define SNDRV_COMPRESS_RESUME _IO('C', 0x31) 240 #define SNDRV_COMPRESS_START _IO('C', 0x32) 241 #define SNDRV_COMPRESS_STOP _IO('C', 0x33) 242 #define SNDRV_COMPRESS_DRAIN _IO('C', 0x34) 243 #define SNDRV_COMPRESS_NEXT_TRACK _IO('C', 0x35) 244 #define SNDRV_COMPRESS_PARTIAL_DRAIN _IO('C', 0x36) 245 #define SNDRV_COMPRESS_SET_NEXT_TRACK_PARAM\ 246 _IOW('C', 0x80, union snd_codec_options) 247 /* 248 * TODO 249 * 1. add mmap support 250 * 251 */ 252 #define SND_COMPR_TRIGGER_DRAIN 7 /*FIXME move this to pcm.h */ 253 #define SND_COMPR_TRIGGER_NEXT_TRACK 8 254 #define SND_COMPR_TRIGGER_PARTIAL_DRAIN 9 255 #define SNDRV_COMPRESS_DSP_POSITION 10 256 #endif 257