sound/soc/intel/skylake/skl-topology.h

   1 /*
   2  *  skl_topology.h - Intel HDA Platform topology header file
   3  *
   4  *  Copyright (C) 2014-15 Intel Corp
   5  *  Author: Jeeja KP <jeeja.kp@intel.com>
   6  *  ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; version 2 of the License.
  11  *
  12  *  This program is distributed in the hope that it will be useful, but
  13  *  WITHOUT ANY WARRANTY; without even the implied warranty of
  14  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  *  General Public License for more details.
  16  *
  17  * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  18  *
  19  */
  20
  21 #ifndef __SKL_TOPOLOGY_H__
  22 #define __SKL_TOPOLOGY_H__
  23
  24 #include <linux/types.h>
  25
  26 #include <sound/hdaudio_ext.h>
  27 #include <sound/soc.h>
  28 #include "skl.h"
  29 #include "skl-tplg-interface.h"
  30
  31 #define BITS_PER_BYTE 8
  32 #define MAX_TS_GROUPS 8
  33 #define MAX_DMIC_TS_GROUPS 4
  34 #define MAX_FIXED_DMIC_PARAMS_SIZE 727
  35
  36 /* Maximum number of coefficients up down mixer module */
  37 #define UP_DOWN_MIXER_MAX_COEFF         6
  38
  39 #define MODULE_MAX_IN_PINS      8
  40 #define MODULE_MAX_OUT_PINS     8
  41
  42 #define SKL_MIC_CH_SUPPORT      4
  43 #define SKL_MIC_MAX_CH_SUPPORT  8
  44 #define SKL_DEFAULT_MIC_SEL_GAIN        0x3FF
  45 #define SKL_MIC_SEL_SWITCH      0x3
  46
  47 #define SKL_OUTPUT_PIN          0
  48 #define SKL_INPUT_PIN           1
  49 #define SKL_MAX_PATH_CONFIGS    8
  50 #define SKL_MAX_MODULES_IN_PIPE 8
  51 #define SKL_MAX_MODULE_FORMATS          32
  52 #define SKL_MAX_MODULE_RESOURCES        32
  53
  54 enum skl_channel_index {
  55         SKL_CHANNEL_LEFT = 0,
  56         SKL_CHANNEL_RIGHT = 1,
  57         SKL_CHANNEL_CENTER = 2,
  58         SKL_CHANNEL_LEFT_SURROUND = 3,
  59         SKL_CHANNEL_CENTER_SURROUND = 3,
  60         SKL_CHANNEL_RIGHT_SURROUND = 4,
  61         SKL_CHANNEL_LFE = 7,
  62         SKL_CHANNEL_INVALID = 0xF,
  63 };
  64
  65 enum skl_bitdepth {
  66         SKL_DEPTH_8BIT = 8,
  67         SKL_DEPTH_16BIT = 16,
  68         SKL_DEPTH_24BIT = 24,
  69         SKL_DEPTH_32BIT = 32,
  70         SKL_DEPTH_INVALID
  71 };
  72
  73
  74 enum skl_s_freq {
  75         SKL_FS_8000 = 8000,
  76         SKL_FS_11025 = 11025,
  77         SKL_FS_12000 = 12000,
  78         SKL_FS_16000 = 16000,
  79         SKL_FS_22050 = 22050,
  80         SKL_FS_24000 = 24000,
  81         SKL_FS_32000 = 32000,
  82         SKL_FS_44100 = 44100,
  83         SKL_FS_48000 = 48000,
  84         SKL_FS_64000 = 64000,
  85         SKL_FS_88200 = 88200,
  86         SKL_FS_96000 = 96000,
  87         SKL_FS_128000 = 128000,
  88         SKL_FS_176400 = 176400,
  89         SKL_FS_192000 = 192000,
  90         SKL_FS_INVALID
  91 };
  92
  93 enum skl_widget_type {
  94         SKL_WIDGET_VMIXER = 1,
  95         SKL_WIDGET_MIXER = 2,
  96         SKL_WIDGET_PGA = 3,
  97         SKL_WIDGET_MUX = 4
  98 };
  99
 100 struct skl_audio_data_format {
 101         enum skl_s_freq s_freq;
 102         enum skl_bitdepth bit_depth;
 103         u32 channel_map;
 104         enum skl_ch_cfg ch_cfg;
 105         enum skl_interleaving interleaving;
 106         u8 number_of_channels;
 107         u8 valid_bit_depth;
 108         u8 sample_type;
 109         u8 reserved[1];
 110 } __packed;
 111
 112 struct skl_base_cfg {
 113         u32 cps;
 114         u32 ibs;
 115         u32 obs;
 116         u32 is_pages;
 117         struct skl_audio_data_format audio_fmt;
 118 };
 119
 120 struct skl_cpr_gtw_cfg {
 121         u32 node_id;
 122         u32 dma_buffer_size;
 123         u32 config_length;
 124         /* not mandatory; required only for DMIC/I2S */
 125         u32 config_data[1];
 126 } __packed;
 127
 128 struct skl_dma_control {
 129         u32 node_id;
 130         u32 config_length;
 131         u32 config_data[0];
 132 } __packed;
 133
 134 struct skl_cpr_cfg {
 135         struct skl_base_cfg base_cfg;
 136         struct skl_audio_data_format out_fmt;
 137         u32 cpr_feature_mask;
 138         struct skl_cpr_gtw_cfg gtw_cfg;
 139 } __packed;
 140
 141
 142 struct skl_src_module_cfg {
 143         struct skl_base_cfg base_cfg;
 144         enum skl_s_freq src_cfg;
 145 } __packed;
 146
 147 struct notification_mask {
 148         u32 notify;
 149         u32 enable;
 150 } __packed;
 151
 152 struct skl_up_down_mixer_cfg {
 153         struct skl_base_cfg base_cfg;
 154         enum skl_ch_cfg out_ch_cfg;
 155         /* This should be set to 1 if user coefficients are required */
 156         u32 coeff_sel;
 157         /* Pass the user coeff in this array */
 158         s32 coeff[UP_DOWN_MIXER_MAX_COEFF];
 159 } __packed;
 160
 161 struct skl_algo_cfg {
 162         struct skl_base_cfg  base_cfg;
 163         char params[0];
 164 } __packed;
 165
 166 struct skl_base_outfmt_cfg {
 167         struct skl_base_cfg base_cfg;
 168         struct skl_audio_data_format out_fmt;
 169 } __packed;
 170
 171 enum skl_dma_type {
 172         SKL_DMA_HDA_HOST_OUTPUT_CLASS = 0,
 173         SKL_DMA_HDA_HOST_INPUT_CLASS = 1,
 174         SKL_DMA_HDA_HOST_INOUT_CLASS = 2,
 175         SKL_DMA_HDA_LINK_OUTPUT_CLASS = 8,
 176         SKL_DMA_HDA_LINK_INPUT_CLASS = 9,
 177         SKL_DMA_HDA_LINK_INOUT_CLASS = 0xA,
 178         SKL_DMA_DMIC_LINK_INPUT_CLASS = 0xB,
 179         SKL_DMA_I2S_LINK_OUTPUT_CLASS = 0xC,
 180         SKL_DMA_I2S_LINK_INPUT_CLASS = 0xD,
 181 };
 182
 183 union skl_ssp_dma_node {
 184         u8 val;
 185         struct {
 186                 u8 time_slot_index:4;
 187                 u8 i2s_instance:4;
 188         } dma_node;
 189 };
 190
 191 union skl_connector_node_id {
 192         u32 val;
 193         struct {
 194                 u32 vindex:8;
 195                 u32 dma_type:4;
 196                 u32 rsvd:20;
 197         } node;
 198 };
 199
 200 struct skl_module_fmt {
 201         u32 channels;
 202         u32 s_freq;
 203         u32 bit_depth;
 204         u32 valid_bit_depth;
 205         u32 ch_cfg;
 206         u32 interleaving_style;
 207         u32 sample_type;
 208         u32 ch_map;
 209 };
 210
 211 struct skl_module_cfg;
 212
 213 struct skl_mod_inst_map {
 214         u16 mod_id;
 215         u16 inst_id;
 216 };
 217
 218 struct skl_kpb_params {
 219         u32 num_modules;
 220         struct skl_mod_inst_map map[0];
 221 };
 222
 223 struct skl_module_inst_id {
 224         uuid_le mod_uuid;
 225         int module_id;
 226         u32 instance_id;
 227         int pvt_id;
 228 };
 229
 230 enum skl_module_pin_state {
 231         SKL_PIN_UNBIND = 0,
 232         SKL_PIN_BIND_DONE = 1,
 233 };
 234
 235 struct skl_module_pin {
 236         struct skl_module_inst_id id;
 237         bool is_dynamic;
 238         bool in_use;
 239         enum skl_module_pin_state pin_state;
 240         struct skl_module_cfg *tgt_mcfg;
 241 };
 242
 243 struct skl_specific_cfg {
 244         u32 set_params;
 245         u32 param_id;
 246         u32 caps_size;
 247         u32 *caps;
 248 };
 249
 250 enum skl_pipe_state {
 251         SKL_PIPE_INVALID = 0,
 252         SKL_PIPE_CREATED = 1,
 253         SKL_PIPE_PAUSED = 2,
 254         SKL_PIPE_STARTED = 3,
 255         SKL_PIPE_RESET = 4
 256 };
 257
 258 struct skl_pipe_module {
 259         struct snd_soc_dapm_widget *w;
 260         struct list_head node;
 261 };
 262
 263 struct skl_pipe_params {
 264         u8 host_dma_id;
 265         u8 link_dma_id;
 266         u32 ch;
 267         u32 s_freq;
 268         u32 s_fmt;
 269         u8 linktype;
 270         snd_pcm_format_t format;
 271         int link_index;
 272         int stream;
 273         unsigned int host_bps;
 274         unsigned int link_bps;
 275 };
 276
 277 struct skl_pipe_fmt {
 278         u32 freq;
 279         u8 channels;
 280         u8 bps;
 281 };
 282
 283 struct skl_pipe_mcfg {
 284         u8 res_idx;
 285         u8 fmt_idx;
 286 };
 287
 288 struct skl_path_config {
 289         u8 mem_pages;
 290         struct skl_pipe_fmt in_fmt;
 291         struct skl_pipe_fmt out_fmt;
 292 };
 293
 294 struct skl_pipe {
 295         u8 ppl_id;
 296         u8 pipe_priority;
 297         u16 conn_type;
 298         u32 memory_pages;
 299         u8 lp_mode;
 300         struct skl_pipe_params *p_params;
 301         enum skl_pipe_state state;
 302         u8 direction;
 303         u8 cur_config_idx;
 304         u8 nr_cfgs;
 305         struct skl_path_config configs[SKL_MAX_PATH_CONFIGS];
 306         struct list_head w_list;
 307         bool passthru;
 308 };
 309
 310 enum skl_module_state {
 311         SKL_MODULE_UNINIT = 0,
 312         SKL_MODULE_LOADED = 1,
 313         SKL_MODULE_INIT_DONE = 2,
 314         SKL_MODULE_BIND_DONE = 3,
 315         SKL_MODULE_UNLOADED = 4,
 316 };
 317
 318 enum d0i3_capability {
 319         SKL_D0I3_NONE = 0,
 320         SKL_D0I3_STREAMING = 1,
 321         SKL_D0I3_NON_STREAMING = 2,
 322 };
 323
 324 struct skl_module_pin_fmt {
 325         u8 id;
 326         struct skl_module_fmt fmt;
 327 };
 328
 329 struct skl_module_iface {
 330         u8 fmt_idx;
 331         u8 nr_in_fmt;
 332         u8 nr_out_fmt;
 333         struct skl_module_pin_fmt inputs[MAX_IN_QUEUE];
 334         struct skl_module_pin_fmt outputs[MAX_OUT_QUEUE];
 335 };
 336
 337 struct skl_module_pin_resources {
 338         u8 pin_index;
 339         u32 buf_size;
 340 };
 341
 342 struct skl_module_res {
 343         u8 id;
 344         u32 is_pages;
 345         u32 cps;
 346         u32 ibs;
 347         u32 obs;
 348         u32 dma_buffer_size;
 349         u32 cpc;
 350         u8 nr_input_pins;
 351         u8 nr_output_pins;
 352         struct skl_module_pin_resources input[MAX_IN_QUEUE];
 353         struct skl_module_pin_resources output[MAX_OUT_QUEUE];
 354 };
 355
 356 struct skl_module {
 357         uuid_le uuid;
 358         u8 loadable;
 359         u8 input_pin_type;
 360         u8 output_pin_type;
 361         u8 max_input_pins;
 362         u8 max_output_pins;
 363         u8 nr_resources;
 364         u8 nr_interfaces;
 365         struct skl_module_res resources[SKL_MAX_MODULE_RESOURCES];
 366         struct skl_module_iface formats[SKL_MAX_MODULE_FORMATS];
 367 };
 368
 369 struct skl_module_cfg {
 370         u8 guid[16];
 371         struct skl_module_inst_id id;
 372         struct skl_module *module;
 373         int res_idx;
 374         int fmt_idx;
 375         u8 domain;
 376         bool homogenous_inputs;
 377         bool homogenous_outputs;
 378         struct skl_module_fmt in_fmt[MODULE_MAX_IN_PINS];
 379         struct skl_module_fmt out_fmt[MODULE_MAX_OUT_PINS];
 380         u8 max_in_queue;
 381         u8 max_out_queue;
 382         u8 in_queue_mask;
 383         u8 out_queue_mask;
 384         u8 in_queue;
 385         u8 out_queue;
 386         u32 mcps;
 387         u32 ibs;
 388         u32 obs;
 389         u8 is_loadable;
 390         u8 core_id;
 391         u8 dev_type;
 392         u8 dma_id;
 393         u8 time_slot;
 394         u8 dmic_ch_combo_index;
 395         u32 dmic_ch_type;
 396         u32 params_fixup;
 397         u32 converter;
 398         u32 vbus_id;
 399         u32 mem_pages;
 400         enum d0i3_capability d0i3_caps;
 401         u32 dma_buffer_size; /* in milli seconds */
 402         struct skl_module_pin *m_in_pin;
 403         struct skl_module_pin *m_out_pin;
 404         enum skl_module_type m_type;
 405         enum skl_hw_conn_type  hw_conn_type;
 406         enum skl_module_state m_state;
 407         struct skl_pipe *pipe;
 408         struct skl_specific_cfg formats_config;
 409         struct skl_pipe_mcfg mod_cfg[SKL_MAX_MODULES_IN_PIPE];
 410 };
 411
 412 struct skl_algo_data {
 413         u32 param_id;
 414         u32 set_params;
 415         u32 max;
 416         u32 size;
 417         char *params;
 418 };
 419
 420 struct skl_pipeline {
 421         struct skl_pipe *pipe;
 422         struct list_head node;
 423 };
 424
 425 struct skl_module_deferred_bind {
 426         struct skl_module_cfg *src;
 427         struct skl_module_cfg *dst;
 428         struct list_head node;
 429 };
 430
 431 struct skl_mic_sel_config {
 432         u16 mic_switch;
 433         u16 flags;
 434         u16 blob[SKL_MIC_MAX_CH_SUPPORT][SKL_MIC_MAX_CH_SUPPORT];
 435 } __packed;
 436
 437 enum skl_channel {
 438         SKL_CH_MONO = 1,
 439         SKL_CH_STEREO = 2,
 440         SKL_CH_TRIO = 3,
 441         SKL_CH_QUATRO = 4,
 442 };
 443
 444 static inline struct skl *get_skl_ctx(struct device *dev)
 445 {
 446         struct hdac_ext_bus *ebus = dev_get_drvdata(dev);
 447
 448         return ebus_to_skl(ebus);
 449 }
 450
 451 int skl_tplg_be_update_params(struct snd_soc_dai *dai,
 452         struct skl_pipe_params *params);
 453 int skl_dsp_set_dma_control(struct skl_sst *ctx,
 454                 struct skl_module_cfg *mconfig);
 455 void skl_tplg_set_be_dmic_config(struct snd_soc_dai *dai,
 456         struct skl_pipe_params *params, int stream);
 457 int skl_tplg_init(struct snd_soc_platform *platform,
 458                                 struct hdac_ext_bus *ebus);
 459 struct skl_module_cfg *skl_tplg_fe_get_cpr_module(
 460                 struct snd_soc_dai *dai, int stream);
 461 int skl_tplg_update_pipe_params(struct device *dev,
 462                 struct skl_module_cfg *mconfig, struct skl_pipe_params *params);
 463
 464 void skl_tplg_d0i3_get(struct skl *skl, enum d0i3_capability caps);
 465 void skl_tplg_d0i3_put(struct skl *skl, enum d0i3_capability caps);
 466
 467 int skl_create_pipeline(struct skl_sst *ctx, struct skl_pipe *pipe);
 468
 469 int skl_run_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
 470
 471 int skl_pause_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
 472
 473 int skl_delete_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
 474
 475 int skl_stop_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
 476
 477 int skl_reset_pipe(struct skl_sst *ctx, struct skl_pipe *pipe);
 478
 479 int skl_init_module(struct skl_sst *ctx, struct skl_module_cfg *module_config);
 480
 481 int skl_bind_modules(struct skl_sst *ctx, struct skl_module_cfg
 482         *src_module, struct skl_module_cfg *dst_module);
 483
 484 int skl_unbind_modules(struct skl_sst *ctx, struct skl_module_cfg
 485         *src_module, struct skl_module_cfg *dst_module);
 486
 487 int skl_set_module_params(struct skl_sst *ctx, u32 *params, int size,
 488                         u32 param_id, struct skl_module_cfg *mcfg);
 489 int skl_get_module_params(struct skl_sst *ctx, u32 *params, int size,
 490                           u32 param_id, struct skl_module_cfg *mcfg);
 491
 492 struct skl_module_cfg *skl_tplg_be_get_cpr_module(struct snd_soc_dai *dai,
 493                                                                 int stream);
 494 enum skl_bitdepth skl_get_bit_depth(int params);
 495 int skl_pcm_host_dma_prepare(struct device *dev,
 496                         struct skl_pipe_params *params);
 497 int skl_pcm_link_dma_prepare(struct device *dev,
 498                         struct skl_pipe_params *params);
 499 #endif