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