Back to home page

OSCL-LXR

 
 

    


0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright(c) 2021-2022 Intel Corporation. All rights reserved.
0004  *
0005  * Authors: Cezary Rojewski <cezary.rojewski@intel.com>
0006  *          Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
0007  */
0008 
0009 #ifndef __SOUND_SOC_INTEL_AVS_MSGS_H
0010 #define __SOUND_SOC_INTEL_AVS_MSGS_H
0011 
0012 struct avs_dev;
0013 
0014 #define AVS_MAILBOX_SIZE 4096
0015 
0016 enum avs_msg_target {
0017     AVS_FW_GEN_MSG = 0,
0018     AVS_MOD_MSG = 1
0019 };
0020 
0021 enum avs_msg_direction {
0022     AVS_MSG_REQUEST = 0,
0023     AVS_MSG_REPLY = 1
0024 };
0025 
0026 enum avs_global_msg_type {
0027     AVS_GLB_ROM_CONTROL = 1,
0028     AVS_GLB_LOAD_MULTIPLE_MODULES = 15,
0029     AVS_GLB_UNLOAD_MULTIPLE_MODULES = 16,
0030     AVS_GLB_CREATE_PIPELINE = 17,
0031     AVS_GLB_DELETE_PIPELINE = 18,
0032     AVS_GLB_SET_PIPELINE_STATE = 19,
0033     AVS_GLB_GET_PIPELINE_STATE = 20,
0034     AVS_GLB_LOAD_LIBRARY = 24,
0035     AVS_GLB_NOTIFICATION = 27,
0036 };
0037 
0038 union avs_global_msg {
0039     u64 val;
0040     struct {
0041         union {
0042             u32 primary;
0043             struct {
0044                 u32 rsvd:24;
0045                 u32 global_msg_type:5;
0046                 u32 msg_direction:1;
0047                 u32 msg_target:1;
0048             };
0049             /* set boot config */
0050             struct {
0051                 u32 rom_ctrl_msg_type:9;
0052                 u32 dma_id:5;
0053                 u32 purge_request:1;
0054             } boot_cfg;
0055             /* module loading */
0056             struct {
0057                 u32 mod_cnt:8;
0058             } load_multi_mods;
0059             /* pipeline management */
0060             struct {
0061                 u32 ppl_mem_size:11;
0062                 u32 ppl_priority:5;
0063                 u32 instance_id:8;
0064             } create_ppl;
0065             struct {
0066                 u32 rsvd:16;
0067                 u32 instance_id:8;
0068             } ppl; /* generic ppl request */
0069             struct {
0070                 u32 state:16;
0071                 u32 ppl_id:8;
0072             } set_ppl_state;
0073             struct {
0074                 u32 ppl_id:8;
0075             } get_ppl_state;
0076             /* library loading */
0077             struct {
0078                 u32 dma_id:5;
0079                 u32 rsvd:11;
0080                 u32 lib_id:4;
0081             } load_lib;
0082         };
0083         union {
0084             u32 val;
0085             /* pipeline management */
0086             struct {
0087                 u32 lp:1; /* low power flag */
0088                 u32 rsvd:3;
0089                 u32 attributes:16; /* additional scheduling flags */
0090             } create_ppl;
0091         } ext;
0092     };
0093 } __packed;
0094 
0095 struct avs_tlv {
0096     u32 type;
0097     u32 length;
0098     u32 value[];
0099 } __packed;
0100 
0101 enum avs_module_msg_type {
0102     AVS_MOD_INIT_INSTANCE = 0,
0103     AVS_MOD_LARGE_CONFIG_GET = 3,
0104     AVS_MOD_LARGE_CONFIG_SET = 4,
0105     AVS_MOD_BIND = 5,
0106     AVS_MOD_UNBIND = 6,
0107     AVS_MOD_SET_DX = 7,
0108     AVS_MOD_SET_D0IX = 8,
0109     AVS_MOD_DELETE_INSTANCE = 11,
0110 };
0111 
0112 union avs_module_msg {
0113     u64 val;
0114     struct {
0115         union {
0116             u32 primary;
0117             struct {
0118                 u32 module_id:16;
0119                 u32 instance_id:8;
0120                 u32 module_msg_type:5;
0121                 u32 msg_direction:1;
0122                 u32 msg_target:1;
0123             };
0124         };
0125         union {
0126             u32 val;
0127             struct {
0128                 u32 param_block_size:16;
0129                 u32 ppl_instance_id:8;
0130                 u32 core_id:4;
0131                 u32 proc_domain:1;
0132             } init_instance;
0133             struct {
0134                 u32 data_off_size:20;
0135                 u32 large_param_id:8;
0136                 u32 final_block:1;
0137                 u32 init_block:1;
0138             } large_config;
0139             struct {
0140                 u32 dst_module_id:16;
0141                 u32 dst_instance_id:8;
0142                 u32 dst_queue:3;
0143                 u32 src_queue:3;
0144             } bind_unbind;
0145             struct {
0146                 u32 wake:1;
0147                 u32 streaming:1;
0148             } set_d0ix;
0149         } ext;
0150     };
0151 } __packed;
0152 
0153 union avs_reply_msg {
0154     u64 val;
0155     struct {
0156         union {
0157             u32 primary;
0158             struct {
0159                 u32 status:24;
0160                 u32 global_msg_type:5;
0161                 u32 msg_direction:1;
0162                 u32 msg_target:1;
0163             };
0164         };
0165         union {
0166             u32 val;
0167             /* module loading */
0168             struct {
0169                 u32 err_mod_id:16;
0170             } load_multi_mods;
0171             /* pipeline management */
0172             struct {
0173                 u32 state:5;
0174             } get_ppl_state;
0175             /* module management */
0176             struct {
0177                 u32 data_off_size:20;
0178                 u32 large_param_id:8;
0179                 u32 final_block:1;
0180                 u32 init_block:1;
0181             } large_config;
0182         } ext;
0183     };
0184 } __packed;
0185 
0186 enum avs_notify_msg_type {
0187     AVS_NOTIFY_PHRASE_DETECTED = 4,
0188     AVS_NOTIFY_RESOURCE_EVENT = 5,
0189     AVS_NOTIFY_LOG_BUFFER_STATUS = 6,
0190     AVS_NOTIFY_FW_READY = 8,
0191     AVS_NOTIFY_EXCEPTION_CAUGHT = 10,
0192     AVS_NOTIFY_MODULE_EVENT = 12,
0193 };
0194 
0195 union avs_notify_msg {
0196     u64 val;
0197     struct {
0198         union {
0199             u32 primary;
0200             struct {
0201                 u32 rsvd:16;
0202                 u32 notify_msg_type:8;
0203                 u32 global_msg_type:5;
0204                 u32 msg_direction:1;
0205                 u32 msg_target:1;
0206             };
0207             struct {
0208                 u16 rsvd:12;
0209                 u16 core:4;
0210             } log;
0211         };
0212         union {
0213             u32 val;
0214             struct {
0215                 u32 core_id:2;
0216                 u32 stack_dump_size:16;
0217             } coredump;
0218         } ext;
0219     };
0220 } __packed;
0221 
0222 #define AVS_MSG(hdr) { .val = hdr }
0223 
0224 #define AVS_GLOBAL_REQUEST(msg_type)        \
0225 {                       \
0226     .global_msg_type = AVS_GLB_##msg_type,  \
0227     .msg_direction = AVS_MSG_REQUEST,   \
0228     .msg_target = AVS_FW_GEN_MSG,       \
0229 }
0230 
0231 #define AVS_MODULE_REQUEST(msg_type)        \
0232 {                       \
0233     .module_msg_type = AVS_MOD_##msg_type,  \
0234     .msg_direction = AVS_MSG_REQUEST,   \
0235     .msg_target = AVS_MOD_MSG,      \
0236 }
0237 
0238 #define AVS_NOTIFICATION(msg_type)      \
0239 {                       \
0240     .notify_msg_type = AVS_NOTIFY_##msg_type,\
0241     .global_msg_type = AVS_GLB_NOTIFICATION,\
0242     .msg_direction = AVS_MSG_REPLY,     \
0243     .msg_target = AVS_FW_GEN_MSG,       \
0244 }
0245 
0246 #define avs_msg_is_reply(hdr) \
0247 ({ \
0248     union avs_reply_msg __msg = AVS_MSG(hdr); \
0249     __msg.msg_direction == AVS_MSG_REPLY && \
0250     __msg.global_msg_type != AVS_GLB_NOTIFICATION; \
0251 })
0252 
0253 /* Notification types */
0254 
0255 struct avs_notify_voice_data {
0256     u16 kpd_score;
0257     u16 reserved;
0258 } __packed;
0259 
0260 struct avs_notify_res_data {
0261     u32 resource_type;
0262     u32 resource_id;
0263     u32 event_type;
0264     u32 reserved;
0265     u32 data[6];
0266 } __packed;
0267 
0268 struct avs_notify_mod_data {
0269     u32 module_instance_id;
0270     u32 event_id;
0271     u32 data_size;
0272     u32 data[];
0273 } __packed;
0274 
0275 /* ROM messages */
0276 enum avs_rom_control_msg_type {
0277     AVS_ROM_SET_BOOT_CONFIG = 0,
0278 };
0279 
0280 int avs_ipc_set_boot_config(struct avs_dev *adev, u32 dma_id, u32 purge);
0281 
0282 /* Code loading messages */
0283 int avs_ipc_load_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids);
0284 int avs_ipc_unload_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids);
0285 int avs_ipc_load_library(struct avs_dev *adev, u32 dma_id, u32 lib_id);
0286 
0287 /* Pipeline management messages */
0288 enum avs_pipeline_state {
0289     AVS_PPL_STATE_INVALID,
0290     AVS_PPL_STATE_UNINITIALIZED,
0291     AVS_PPL_STATE_RESET,
0292     AVS_PPL_STATE_PAUSED,
0293     AVS_PPL_STATE_RUNNING,
0294 };
0295 
0296 int avs_ipc_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority,
0297                 u8 instance_id, bool lp, u16 attributes);
0298 int avs_ipc_delete_pipeline(struct avs_dev *adev, u8 instance_id);
0299 int avs_ipc_set_pipeline_state(struct avs_dev *adev, u8 instance_id,
0300                    enum avs_pipeline_state state);
0301 int avs_ipc_get_pipeline_state(struct avs_dev *adev, u8 instance_id,
0302                    enum avs_pipeline_state *state);
0303 
0304 /* Module management messages */
0305 int avs_ipc_init_instance(struct avs_dev *adev, u16 module_id, u8 instance_id,
0306               u8 ppl_id, u8 core_id, u8 domain,
0307               void *param, u32 param_size);
0308 int avs_ipc_delete_instance(struct avs_dev *adev, u16 module_id, u8 instance_id);
0309 int avs_ipc_bind(struct avs_dev *adev, u16 module_id, u8 instance_id,
0310          u16 dst_module_id, u8 dst_instance_id,
0311          u8 dst_queue, u8 src_queue);
0312 int avs_ipc_unbind(struct avs_dev *adev, u16 module_id, u8 instance_id,
0313            u16 dst_module_id, u8 dst_instance_id,
0314            u8 dst_queue, u8 src_queue);
0315 int avs_ipc_set_large_config(struct avs_dev *adev, u16 module_id,
0316                  u8 instance_id, u8 param_id,
0317                  u8 *request, size_t request_size);
0318 int avs_ipc_get_large_config(struct avs_dev *adev, u16 module_id, u8 instance_id,
0319                  u8 param_id, u8 *request_data, size_t request_size,
0320                  u8 **reply_data, size_t *reply_size);
0321 
0322 /* DSP cores and domains power management messages */
0323 struct avs_dxstate_info {
0324     u32 core_mask;  /* which cores are subject for power transition */
0325     u32 dx_mask;    /* bit[n]=1 core n goes to D0, bit[n]=0 it goes to D3 */
0326 } __packed;
0327 
0328 int avs_ipc_set_dx(struct avs_dev *adev, u32 core_mask, bool powerup);
0329 int avs_ipc_set_d0ix(struct avs_dev *adev, bool enable_pg, bool streaming);
0330 
0331 /* Base-firmware runtime parameters */
0332 
0333 #define AVS_BASEFW_MOD_ID   0
0334 #define AVS_BASEFW_INST_ID  0
0335 
0336 enum avs_basefw_runtime_param {
0337     AVS_BASEFW_ENABLE_LOGS = 6,
0338     AVS_BASEFW_FIRMWARE_CONFIG = 7,
0339     AVS_BASEFW_HARDWARE_CONFIG = 8,
0340     AVS_BASEFW_MODULES_INFO = 9,
0341     AVS_BASEFW_LIBRARIES_INFO = 16,
0342     AVS_BASEFW_SYSTEM_TIME = 20,
0343 };
0344 
0345 enum avs_log_enable {
0346     AVS_LOG_DISABLE = 0,
0347     AVS_LOG_ENABLE = 1
0348 };
0349 
0350 enum avs_skl_log_priority {
0351     AVS_SKL_LOG_CRITICAL = 1,
0352     AVS_SKL_LOG_HIGH,
0353     AVS_SKL_LOG_MEDIUM,
0354     AVS_SKL_LOG_LOW,
0355     AVS_SKL_LOG_VERBOSE,
0356 };
0357 
0358 struct skl_log_state {
0359     u32 enable;
0360     u32 min_priority;
0361 } __packed;
0362 
0363 struct skl_log_state_info {
0364     u32 core_mask;
0365     struct skl_log_state logs_core[];
0366 } __packed;
0367 
0368 struct apl_log_state_info {
0369     u32 aging_timer_period;
0370     u32 fifo_full_timer_period;
0371     u32 core_mask;
0372     struct skl_log_state logs_core[];
0373 } __packed;
0374 
0375 int avs_ipc_set_enable_logs(struct avs_dev *adev, u8 *log_info, size_t size);
0376 
0377 struct avs_fw_version {
0378     u16 major;
0379     u16 minor;
0380     u16 hotfix;
0381     u16 build;
0382 };
0383 
0384 enum avs_fw_cfg_params {
0385     AVS_FW_CFG_FW_VERSION = 0,
0386     AVS_FW_CFG_MEMORY_RECLAIMED,
0387     AVS_FW_CFG_SLOW_CLOCK_FREQ_HZ,
0388     AVS_FW_CFG_FAST_CLOCK_FREQ_HZ,
0389     AVS_FW_CFG_DMA_BUFFER_CONFIG,
0390     AVS_FW_CFG_ALH_SUPPORT_LEVEL,
0391     AVS_FW_CFG_IPC_DL_MAILBOX_BYTES,
0392     AVS_FW_CFG_IPC_UL_MAILBOX_BYTES,
0393     AVS_FW_CFG_TRACE_LOG_BYTES,
0394     AVS_FW_CFG_MAX_PPL_COUNT,
0395     AVS_FW_CFG_MAX_ASTATE_COUNT,
0396     AVS_FW_CFG_MAX_MODULE_PIN_COUNT,
0397     AVS_FW_CFG_MODULES_COUNT,
0398     AVS_FW_CFG_MAX_MOD_INST_COUNT,
0399     AVS_FW_CFG_MAX_LL_TASKS_PER_PRI_COUNT,
0400     AVS_FW_CFG_LL_PRI_COUNT,
0401     AVS_FW_CFG_MAX_DP_TASKS_COUNT,
0402     AVS_FW_CFG_MAX_LIBS_COUNT,
0403     AVS_FW_CFG_SCHEDULER_CONFIG,
0404     AVS_FW_CFG_XTAL_FREQ_HZ,
0405     AVS_FW_CFG_CLOCKS_CONFIG,
0406     AVS_FW_CFG_RESERVED,
0407     AVS_FW_CFG_POWER_GATING_POLICY,
0408     AVS_FW_CFG_ASSERT_MODE,
0409 };
0410 
0411 struct avs_fw_cfg {
0412     struct avs_fw_version fw_version;
0413     u32 memory_reclaimed;
0414     u32 slow_clock_freq_hz;
0415     u32 fast_clock_freq_hz;
0416     u32 alh_support;
0417     u32 ipc_dl_mailbox_bytes;
0418     u32 ipc_ul_mailbox_bytes;
0419     u32 trace_log_bytes;
0420     u32 max_ppl_count;
0421     u32 max_astate_count;
0422     u32 max_module_pin_count;
0423     u32 modules_count;
0424     u32 max_mod_inst_count;
0425     u32 max_ll_tasks_per_pri_count;
0426     u32 ll_pri_count;
0427     u32 max_dp_tasks_count;
0428     u32 max_libs_count;
0429     u32 xtal_freq_hz;
0430     u32 power_gating_policy;
0431 };
0432 
0433 int avs_ipc_get_fw_config(struct avs_dev *adev, struct avs_fw_cfg *cfg);
0434 
0435 enum avs_hw_cfg_params {
0436     AVS_HW_CFG_AVS_VER,
0437     AVS_HW_CFG_DSP_CORES,
0438     AVS_HW_CFG_MEM_PAGE_BYTES,
0439     AVS_HW_CFG_TOTAL_PHYS_MEM_PAGES,
0440     AVS_HW_CFG_I2S_CAPS,
0441     AVS_HW_CFG_GPDMA_CAPS,
0442     AVS_HW_CFG_GATEWAY_COUNT,
0443     AVS_HW_CFG_HP_EBB_COUNT,
0444     AVS_HW_CFG_LP_EBB_COUNT,
0445     AVS_HW_CFG_EBB_SIZE_BYTES,
0446 };
0447 
0448 enum avs_iface_version {
0449     AVS_AVS_VER_1_5 = 0x10005,
0450     AVS_AVS_VER_1_8 = 0x10008,
0451 };
0452 
0453 enum avs_i2s_version {
0454     AVS_I2S_VER_15_SKYLAKE   = 0x00000,
0455     AVS_I2S_VER_15_BROXTON   = 0x10000,
0456     AVS_I2S_VER_15_BROXTON_P = 0x20000,
0457     AVS_I2S_VER_18_KBL_CNL   = 0x30000,
0458 };
0459 
0460 struct avs_i2s_caps {
0461     u32 i2s_version;
0462     u32 ctrl_count;
0463     u32 *ctrl_base_addr;
0464 };
0465 
0466 struct avs_hw_cfg {
0467     u32 avs_version;
0468     u32 dsp_cores;
0469     u32 mem_page_bytes;
0470     u32 total_phys_mem_pages;
0471     struct avs_i2s_caps i2s_caps;
0472     u32 gateway_count;
0473     u32 hp_ebb_count;
0474     u32 lp_ebb_count;
0475     u32 ebb_size_bytes;
0476 };
0477 
0478 int avs_ipc_get_hw_config(struct avs_dev *adev, struct avs_hw_cfg *cfg);
0479 
0480 #define AVS_MODULE_LOAD_TYPE_BUILTIN    0
0481 #define AVS_MODULE_LOAD_TYPE_LOADABLE   1
0482 #define AVS_MODULE_STATE_LOADED     BIT(0)
0483 
0484 struct avs_module_type {
0485     u32 load_type:4;
0486     u32 auto_start:1;
0487     u32 domain_ll:1;
0488     u32 domain_dp:1;
0489     u32 lib_code:1;
0490     u32 rsvd:24;
0491 } __packed;
0492 
0493 union avs_segment_flags {
0494     u32 ul;
0495     struct {
0496         u32 contents:1;
0497         u32 alloc:1;
0498         u32 load:1;
0499         u32 readonly:1;
0500         u32 code:1;
0501         u32 data:1;
0502         u32 rsvd_1:2;
0503         u32 type:4;
0504         u32 rsvd_2:4;
0505         u32 length:16;
0506     };
0507 } __packed;
0508 
0509 struct avs_segment_desc {
0510     union avs_segment_flags flags;
0511     u32 v_base_addr;
0512     u32 file_offset;
0513 } __packed;
0514 
0515 struct avs_module_entry {
0516     u16 module_id;
0517     u16 state_flags;
0518     u8 name[8];
0519     guid_t uuid;
0520     struct avs_module_type type;
0521     u8 hash[32];
0522     u32 entry_point;
0523     u16 cfg_offset;
0524     u16 cfg_count;
0525     u32 affinity_mask;
0526     u16 instance_max_count;
0527     u16 instance_bss_size;
0528     struct avs_segment_desc segments[3];
0529 } __packed;
0530 
0531 struct avs_mods_info {
0532     u32 count;
0533     struct avs_module_entry entries[];
0534 } __packed;
0535 
0536 static inline bool avs_module_entry_is_loaded(struct avs_module_entry *mentry)
0537 {
0538     return mentry->type.load_type == AVS_MODULE_LOAD_TYPE_BUILTIN ||
0539            mentry->state_flags & AVS_MODULE_STATE_LOADED;
0540 }
0541 
0542 int avs_ipc_get_modules_info(struct avs_dev *adev, struct avs_mods_info **info);
0543 
0544 struct avs_sys_time {
0545     u32 val_l;
0546     u32 val_u;
0547 } __packed;
0548 
0549 int avs_ipc_set_system_time(struct avs_dev *adev);
0550 
0551 /* Module configuration */
0552 
0553 #define AVS_MIXIN_MOD_UUID \
0554     GUID_INIT(0x39656EB2, 0x3B71, 0x4049, 0x8D, 0x3F, 0xF9, 0x2C, 0xD5, 0xC4, 0x3C, 0x09)
0555 
0556 #define AVS_MIXOUT_MOD_UUID \
0557     GUID_INIT(0x3C56505A, 0x24D7, 0x418F, 0xBD, 0xDC, 0xC1, 0xF5, 0xA3, 0xAC, 0x2A, 0xE0)
0558 
0559 #define AVS_COPIER_MOD_UUID \
0560     GUID_INIT(0x9BA00C83, 0xCA12, 0x4A83, 0x94, 0x3C, 0x1F, 0xA2, 0xE8, 0x2F, 0x9D, 0xDA)
0561 
0562 #define AVS_KPBUFF_MOD_UUID \
0563     GUID_INIT(0xA8A0CB32, 0x4A77, 0x4DB1, 0x85, 0xC7, 0x53, 0xD7, 0xEE, 0x07, 0xBC, 0xE6)
0564 
0565 #define AVS_MICSEL_MOD_UUID \
0566     GUID_INIT(0x32FE92C1, 0x1E17, 0x4FC2, 0x97, 0x58, 0xC7, 0xF3, 0x54, 0x2E, 0x98, 0x0A)
0567 
0568 #define AVS_MUX_MOD_UUID \
0569     GUID_INIT(0x64CE6E35, 0x857A, 0x4878, 0xAC, 0xE8, 0xE2, 0xA2, 0xF4, 0x2e, 0x30, 0x69)
0570 
0571 #define AVS_UPDWMIX_MOD_UUID \
0572     GUID_INIT(0x42F8060C, 0x832F, 0x4DBF, 0xB2, 0x47, 0x51, 0xE9, 0x61, 0x99, 0x7b, 0x35)
0573 
0574 #define AVS_SRCINTC_MOD_UUID \
0575     GUID_INIT(0xE61BB28D, 0x149A, 0x4C1F, 0xB7, 0x09, 0x46, 0x82, 0x3E, 0xF5, 0xF5, 0xAE)
0576 
0577 #define AVS_PROBE_MOD_UUID \
0578     GUID_INIT(0x7CAD0808, 0xAB10, 0xCD23, 0xEF, 0x45, 0x12, 0xAB, 0x34, 0xCD, 0x56, 0xEF)
0579 
0580 #define AVS_AEC_MOD_UUID \
0581     GUID_INIT(0x46CB87FB, 0xD2C9, 0x4970, 0x96, 0xD2, 0x6D, 0x7E, 0x61, 0x4B, 0xB6, 0x05)
0582 
0583 #define AVS_ASRC_MOD_UUID \
0584     GUID_INIT(0x66B4402D, 0xB468, 0x42F2, 0x81, 0xA7, 0xB3, 0x71, 0x21, 0x86, 0x3D, 0xD4)
0585 
0586 #define AVS_INTELWOV_MOD_UUID \
0587     GUID_INIT(0xEC774FA9, 0x28D3, 0x424A, 0x90, 0xE4, 0x69, 0xF9, 0x84, 0xF1, 0xEE, 0xB7)
0588 
0589 /* channel map */
0590 enum avs_channel_index {
0591     AVS_CHANNEL_LEFT = 0,
0592     AVS_CHANNEL_RIGHT = 1,
0593     AVS_CHANNEL_CENTER = 2,
0594     AVS_CHANNEL_LEFT_SURROUND = 3,
0595     AVS_CHANNEL_CENTER_SURROUND = 3,
0596     AVS_CHANNEL_RIGHT_SURROUND = 4,
0597     AVS_CHANNEL_LFE = 7,
0598     AVS_CHANNEL_INVALID = 0xF,
0599 };
0600 
0601 enum avs_channel_config {
0602     AVS_CHANNEL_CONFIG_MONO = 0,
0603     AVS_CHANNEL_CONFIG_STEREO = 1,
0604     AVS_CHANNEL_CONFIG_2_1 = 2,
0605     AVS_CHANNEL_CONFIG_3_0 = 3,
0606     AVS_CHANNEL_CONFIG_3_1 = 4,
0607     AVS_CHANNEL_CONFIG_QUATRO = 5,
0608     AVS_CHANNEL_CONFIG_4_0 = 6,
0609     AVS_CHANNEL_CONFIG_5_0 = 7,
0610     AVS_CHANNEL_CONFIG_5_1 = 8,
0611     AVS_CHANNEL_CONFIG_DUAL_MONO = 9,
0612     AVS_CHANNEL_CONFIG_I2S_DUAL_STEREO_0 = 10,
0613     AVS_CHANNEL_CONFIG_I2S_DUAL_STEREO_1 = 11,
0614     AVS_CHANNEL_CONFIG_4_CHANNEL = 12,
0615     AVS_CHANNEL_CONFIG_INVALID
0616 };
0617 
0618 enum avs_interleaving {
0619     AVS_INTERLEAVING_PER_CHANNEL = 0,
0620     AVS_INTERLEAVING_PER_SAMPLE = 1,
0621 };
0622 
0623 enum avs_sample_type {
0624     AVS_SAMPLE_TYPE_INT_MSB = 0,
0625     AVS_SAMPLE_TYPE_INT_LSB = 1,
0626     AVS_SAMPLE_TYPE_INT_SIGNED = 2,
0627     AVS_SAMPLE_TYPE_INT_UNSIGNED = 3,
0628     AVS_SAMPLE_TYPE_FLOAT = 4,
0629 };
0630 
0631 #define AVS_CHANNELS_MAX    8
0632 #define AVS_ALL_CHANNELS_MASK   UINT_MAX
0633 
0634 struct avs_audio_format {
0635     u32 sampling_freq;
0636     u32 bit_depth;
0637     u32 channel_map;
0638     u32 channel_config;
0639     u32 interleaving;
0640     u32 num_channels:8;
0641     u32 valid_bit_depth:8;
0642     u32 sample_type:8;
0643     u32 reserved:8;
0644 } __packed;
0645 
0646 struct avs_modcfg_base {
0647     u32 cpc;
0648     u32 ibs;
0649     u32 obs;
0650     u32 is_pages;
0651     struct avs_audio_format audio_fmt;
0652 } __packed;
0653 
0654 struct avs_pin_format {
0655     u32 pin_index;
0656     u32 iobs;
0657     struct avs_audio_format audio_fmt;
0658 } __packed;
0659 
0660 struct avs_modcfg_ext {
0661     struct avs_modcfg_base base;
0662     u16 num_input_pins;
0663     u16 num_output_pins;
0664     u8 reserved[12];
0665     /* input pin formats followed by output ones */
0666     struct avs_pin_format pin_fmts[];
0667 } __packed;
0668 
0669 enum avs_dma_type {
0670     AVS_DMA_HDA_HOST_OUTPUT = 0,
0671     AVS_DMA_HDA_HOST_INPUT = 1,
0672     AVS_DMA_HDA_LINK_OUTPUT = 8,
0673     AVS_DMA_HDA_LINK_INPUT = 9,
0674     AVS_DMA_DMIC_LINK_INPUT = 11,
0675     AVS_DMA_I2S_LINK_OUTPUT = 12,
0676     AVS_DMA_I2S_LINK_INPUT = 13,
0677 };
0678 
0679 union avs_virtual_index {
0680     u8 val;
0681     struct {
0682         u8 time_slot:4;
0683         u8 instance:4;
0684     } i2s;
0685     struct {
0686         u8 queue_id:3;
0687         u8 time_slot:2;
0688         u8 instance:3;
0689     } dmic;
0690 } __packed;
0691 
0692 union avs_connector_node_id {
0693     u32 val;
0694     struct {
0695         u32 vindex:8;
0696         u32 dma_type:5;
0697         u32 rsvd:19;
0698     };
0699 } __packed;
0700 
0701 #define INVALID_PIPELINE_ID 0xFF
0702 #define INVALID_NODE_ID \
0703     ((union avs_connector_node_id) { UINT_MAX })
0704 
0705 union avs_gtw_attributes {
0706     u32 val;
0707     struct {
0708         u32 lp_buffer_alloc:1;
0709         u32 rsvd:31;
0710     };
0711 } __packed;
0712 
0713 struct avs_copier_gtw_cfg {
0714     union avs_connector_node_id node_id;
0715     u32 dma_buffer_size;
0716     u32 config_length;
0717     struct {
0718         union avs_gtw_attributes attrs;
0719         u32 blob[];
0720     } config;
0721 } __packed;
0722 
0723 struct avs_copier_cfg {
0724     struct avs_modcfg_base base;
0725     struct avs_audio_format out_fmt;
0726     u32 feature_mask;
0727     struct avs_copier_gtw_cfg gtw_cfg;
0728 } __packed;
0729 
0730 struct avs_micsel_cfg {
0731     struct avs_modcfg_base base;
0732     struct avs_audio_format out_fmt;
0733 } __packed;
0734 
0735 struct avs_mux_cfg {
0736     struct avs_modcfg_base base;
0737     struct avs_audio_format ref_fmt;
0738     struct avs_audio_format out_fmt;
0739 } __packed;
0740 
0741 struct avs_updown_mixer_cfg {
0742     struct avs_modcfg_base base;
0743     u32 out_channel_config;
0744     u32 coefficients_select;
0745     s32 coefficients[AVS_CHANNELS_MAX];
0746     u32 channel_map;
0747 } __packed;
0748 
0749 struct avs_src_cfg {
0750     struct avs_modcfg_base base;
0751     u32 out_freq;
0752 } __packed;
0753 
0754 struct avs_probe_gtw_cfg {
0755     union avs_connector_node_id node_id;
0756     u32 dma_buffer_size;
0757 } __packed;
0758 
0759 struct avs_probe_cfg {
0760     struct avs_modcfg_base base;
0761     struct avs_probe_gtw_cfg gtw_cfg;
0762 } __packed;
0763 
0764 struct avs_aec_cfg {
0765     struct avs_modcfg_base base;
0766     struct avs_audio_format ref_fmt;
0767     struct avs_audio_format out_fmt;
0768     u32 cpc_lp_mode;
0769 } __packed;
0770 
0771 struct avs_asrc_cfg {
0772     struct avs_modcfg_base base;
0773     u32 out_freq;
0774     u32 rsvd0:1;
0775     u32 mode:1;
0776     u32 rsvd2:2;
0777     u32 disable_jitter_buffer:1;
0778     u32 rsvd3:27;
0779 } __packed;
0780 
0781 struct avs_wov_cfg {
0782     struct avs_modcfg_base base;
0783     u32 cpc_lp_mode;
0784 } __packed;
0785 
0786 /* Module runtime parameters */
0787 
0788 enum avs_copier_runtime_param {
0789     AVS_COPIER_SET_SINK_FORMAT = 2,
0790 };
0791 
0792 struct avs_copier_sink_format {
0793     u32 sink_id;
0794     struct avs_audio_format src_fmt;
0795     struct avs_audio_format sink_fmt;
0796 } __packed;
0797 
0798 int avs_ipc_copier_set_sink_format(struct avs_dev *adev, u16 module_id,
0799                    u8 instance_id, u32 sink_id,
0800                    const struct avs_audio_format *src_fmt,
0801                    const struct avs_audio_format *sink_fmt);
0802 
0803 #endif /* __SOUND_SOC_INTEL_AVS_MSGS_H */