1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright(c) 2021-2022 Intel Corporation. All rights reserved.
5 * Authors: Cezary Rojewski <cezary.rojewski@intel.com>
6 * Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
9 #ifndef __SOUND_SOC_INTEL_AVS_MSGS_H
10 #define __SOUND_SOC_INTEL_AVS_MSGS_H
12 #include <linux/sizes.h>
16 #define AVS_MAILBOX_SIZE SZ_4K
23 enum avs_msg_direction {
28 enum avs_global_msg_type {
29 AVS_GLB_ROM_CONTROL = 1,
30 AVS_GLB_LOAD_MULTIPLE_MODULES = 15,
31 AVS_GLB_UNLOAD_MULTIPLE_MODULES = 16,
32 AVS_GLB_CREATE_PIPELINE = 17,
33 AVS_GLB_DELETE_PIPELINE = 18,
34 AVS_GLB_SET_PIPELINE_STATE = 19,
35 AVS_GLB_GET_PIPELINE_STATE = 20,
36 AVS_GLB_LOAD_LIBRARY = 24,
37 AVS_GLB_NOTIFICATION = 27,
40 union avs_global_msg {
47 u32 global_msg_type:5;
53 u32 rom_ctrl_msg_type:9;
61 /* pipeline management */
70 } ppl; /* generic ppl request */
87 /* pipeline management */
89 u32 lp:1; /* low power flag */
91 u32 attributes:16; /* additional scheduling flags */
103 enum avs_module_msg_type {
104 AVS_MOD_INIT_INSTANCE = 0,
105 AVS_MOD_LARGE_CONFIG_GET = 3,
106 AVS_MOD_LARGE_CONFIG_SET = 4,
110 AVS_MOD_SET_D0IX = 8,
111 AVS_MOD_DELETE_INSTANCE = 11,
114 union avs_module_msg {
122 u32 module_msg_type:5;
130 u32 param_block_size:16;
131 u32 ppl_instance_id:8;
136 u32 data_off_size:20;
137 u32 large_param_id:8;
142 u32 dst_module_id:16;
143 u32 dst_instance_id:8;
155 #define AVS_IPC_NOT_SUPPORTED 15
157 union avs_reply_msg {
164 u32 global_msg_type:5;
175 /* pipeline management */
179 /* module management */
181 u32 data_off_size:20;
182 u32 large_param_id:8;
190 enum avs_notify_msg_type {
191 AVS_NOTIFY_PHRASE_DETECTED = 4,
192 AVS_NOTIFY_RESOURCE_EVENT = 5,
193 AVS_NOTIFY_LOG_BUFFER_STATUS = 6,
194 AVS_NOTIFY_FW_READY = 8,
195 AVS_NOTIFY_EXCEPTION_CAUGHT = 10,
196 AVS_NOTIFY_MODULE_EVENT = 12,
199 union avs_notify_msg {
206 u32 notify_msg_type:8;
207 u32 global_msg_type:5;
220 u32 stack_dump_size:16;
226 #define AVS_MSG(hdr) { .val = hdr }
228 #define AVS_GLOBAL_REQUEST(msg_type) \
230 .global_msg_type = AVS_GLB_##msg_type, \
231 .msg_direction = AVS_MSG_REQUEST, \
232 .msg_target = AVS_FW_GEN_MSG, \
235 #define AVS_MODULE_REQUEST(msg_type) \
237 .module_msg_type = AVS_MOD_##msg_type, \
238 .msg_direction = AVS_MSG_REQUEST, \
239 .msg_target = AVS_MOD_MSG, \
242 #define AVS_NOTIFICATION(msg_type) \
244 .notify_msg_type = AVS_NOTIFY_##msg_type,\
245 .global_msg_type = AVS_GLB_NOTIFICATION,\
246 .msg_direction = AVS_MSG_REPLY, \
247 .msg_target = AVS_FW_GEN_MSG, \
250 #define avs_msg_is_reply(hdr) \
252 union avs_reply_msg __msg = AVS_MSG(hdr); \
253 __msg.msg_direction == AVS_MSG_REPLY && \
254 __msg.global_msg_type != AVS_GLB_NOTIFICATION; \
257 /* Notification types */
259 struct avs_notify_voice_data {
264 struct avs_notify_res_data {
272 struct avs_notify_mod_data {
273 u32 module_instance_id;
280 enum avs_rom_control_msg_type {
281 AVS_ROM_SET_BOOT_CONFIG = 0,
284 int avs_ipc_set_boot_config(struct avs_dev *adev, u32 dma_id, u32 purge);
286 /* Code loading messages */
287 int avs_ipc_load_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids);
288 int avs_ipc_unload_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids);
289 int avs_ipc_load_library(struct avs_dev *adev, u32 dma_id, u32 lib_id);
291 /* Pipeline management messages */
292 enum avs_pipeline_state {
293 AVS_PPL_STATE_INVALID,
294 AVS_PPL_STATE_UNINITIALIZED,
296 AVS_PPL_STATE_PAUSED,
297 AVS_PPL_STATE_RUNNING,
300 int avs_ipc_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority,
301 u8 instance_id, bool lp, u16 attributes);
302 int avs_ipc_delete_pipeline(struct avs_dev *adev, u8 instance_id);
303 int avs_ipc_set_pipeline_state(struct avs_dev *adev, u8 instance_id,
304 enum avs_pipeline_state state);
305 int avs_ipc_get_pipeline_state(struct avs_dev *adev, u8 instance_id,
306 enum avs_pipeline_state *state);
308 /* Module management messages */
309 int avs_ipc_init_instance(struct avs_dev *adev, u16 module_id, u8 instance_id,
310 u8 ppl_id, u8 core_id, u8 domain,
311 void *param, u32 param_size);
312 int avs_ipc_delete_instance(struct avs_dev *adev, u16 module_id, u8 instance_id);
313 int avs_ipc_bind(struct avs_dev *adev, u16 module_id, u8 instance_id,
314 u16 dst_module_id, u8 dst_instance_id,
315 u8 dst_queue, u8 src_queue);
316 int avs_ipc_unbind(struct avs_dev *adev, u16 module_id, u8 instance_id,
317 u16 dst_module_id, u8 dst_instance_id,
318 u8 dst_queue, u8 src_queue);
319 int avs_ipc_set_large_config(struct avs_dev *adev, u16 module_id,
320 u8 instance_id, u8 param_id,
321 u8 *request, size_t request_size);
322 int avs_ipc_get_large_config(struct avs_dev *adev, u16 module_id, u8 instance_id,
323 u8 param_id, u8 *request_data, size_t request_size,
324 u8 **reply_data, size_t *reply_size);
326 /* DSP cores and domains power management messages */
327 struct avs_dxstate_info {
328 u32 core_mask; /* which cores are subject for power transition */
329 u32 dx_mask; /* bit[n]=1 core n goes to D0, bit[n]=0 it goes to D3 */
332 int avs_ipc_set_dx(struct avs_dev *adev, u32 core_mask, bool powerup);
333 int avs_ipc_set_d0ix(struct avs_dev *adev, bool enable_pg, bool streaming);
335 /* Base-firmware runtime parameters */
337 #define AVS_BASEFW_MOD_ID 0
338 #define AVS_BASEFW_INST_ID 0
340 enum avs_basefw_runtime_param {
341 AVS_BASEFW_ENABLE_LOGS = 6,
342 AVS_BASEFW_FIRMWARE_CONFIG = 7,
343 AVS_BASEFW_HARDWARE_CONFIG = 8,
344 AVS_BASEFW_MODULES_INFO = 9,
345 AVS_BASEFW_LIBRARIES_INFO = 16,
346 AVS_BASEFW_SYSTEM_TIME = 20,
349 enum avs_log_enable {
354 enum avs_skl_log_priority {
355 AVS_SKL_LOG_CRITICAL = 1,
362 struct skl_log_state {
367 struct skl_log_state_info {
369 struct skl_log_state logs_core[];
372 struct apl_log_state_info {
373 u32 aging_timer_period;
374 u32 fifo_full_timer_period;
376 struct skl_log_state logs_core[];
379 int avs_ipc_set_enable_logs(struct avs_dev *adev, u8 *log_info, size_t size);
381 struct avs_fw_version {
388 enum avs_fw_cfg_params {
389 AVS_FW_CFG_FW_VERSION = 0,
390 AVS_FW_CFG_MEMORY_RECLAIMED,
391 AVS_FW_CFG_SLOW_CLOCK_FREQ_HZ,
392 AVS_FW_CFG_FAST_CLOCK_FREQ_HZ,
393 AVS_FW_CFG_DMA_BUFFER_CONFIG,
394 AVS_FW_CFG_ALH_SUPPORT_LEVEL,
395 AVS_FW_CFG_IPC_DL_MAILBOX_BYTES,
396 AVS_FW_CFG_IPC_UL_MAILBOX_BYTES,
397 AVS_FW_CFG_TRACE_LOG_BYTES,
398 AVS_FW_CFG_MAX_PPL_COUNT,
399 AVS_FW_CFG_MAX_ASTATE_COUNT,
400 AVS_FW_CFG_MAX_MODULE_PIN_COUNT,
401 AVS_FW_CFG_MODULES_COUNT,
402 AVS_FW_CFG_MAX_MOD_INST_COUNT,
403 AVS_FW_CFG_MAX_LL_TASKS_PER_PRI_COUNT,
404 AVS_FW_CFG_LL_PRI_COUNT,
405 AVS_FW_CFG_MAX_DP_TASKS_COUNT,
406 AVS_FW_CFG_MAX_LIBS_COUNT,
407 AVS_FW_CFG_SCHEDULER_CONFIG,
408 AVS_FW_CFG_XTAL_FREQ_HZ,
409 AVS_FW_CFG_CLOCKS_CONFIG,
411 AVS_FW_CFG_POWER_GATING_POLICY,
412 AVS_FW_CFG_ASSERT_MODE,
416 struct avs_fw_version fw_version;
417 u32 memory_reclaimed;
418 u32 slow_clock_freq_hz;
419 u32 fast_clock_freq_hz;
421 u32 ipc_dl_mailbox_bytes;
422 u32 ipc_ul_mailbox_bytes;
425 u32 max_astate_count;
426 u32 max_module_pin_count;
428 u32 max_mod_inst_count;
429 u32 max_ll_tasks_per_pri_count;
431 u32 max_dp_tasks_count;
434 u32 power_gating_policy;
437 int avs_ipc_get_fw_config(struct avs_dev *adev, struct avs_fw_cfg *cfg);
439 enum avs_hw_cfg_params {
441 AVS_HW_CFG_DSP_CORES,
442 AVS_HW_CFG_MEM_PAGE_BYTES,
443 AVS_HW_CFG_TOTAL_PHYS_MEM_PAGES,
445 AVS_HW_CFG_GPDMA_CAPS,
446 AVS_HW_CFG_GATEWAY_COUNT,
447 AVS_HW_CFG_HP_EBB_COUNT,
448 AVS_HW_CFG_LP_EBB_COUNT,
449 AVS_HW_CFG_EBB_SIZE_BYTES,
452 enum avs_iface_version {
453 AVS_AVS_VER_1_5 = 0x10005,
454 AVS_AVS_VER_1_8 = 0x10008,
457 enum avs_i2s_version {
458 AVS_I2S_VER_15_SKYLAKE = 0x00000,
459 AVS_I2S_VER_15_BROXTON = 0x10000,
460 AVS_I2S_VER_15_BROXTON_P = 0x20000,
461 AVS_I2S_VER_18_KBL_CNL = 0x30000,
464 struct avs_i2s_caps {
474 u32 total_phys_mem_pages;
475 struct avs_i2s_caps i2s_caps;
482 int avs_ipc_get_hw_config(struct avs_dev *adev, struct avs_hw_cfg *cfg);
484 #define AVS_MODULE_LOAD_TYPE_BUILTIN 0
485 #define AVS_MODULE_LOAD_TYPE_LOADABLE 1
486 #define AVS_MODULE_STATE_LOADED BIT(0)
488 struct avs_module_type {
497 union avs_segment_flags {
513 struct avs_segment_desc {
514 union avs_segment_flags flags;
519 struct avs_module_entry {
524 struct avs_module_type type;
530 u16 instance_max_count;
531 u16 instance_bss_size;
532 struct avs_segment_desc segments[3];
535 struct avs_mods_info {
537 struct avs_module_entry entries[];
540 static inline bool avs_module_entry_is_loaded(struct avs_module_entry *mentry)
542 return mentry->type.load_type == AVS_MODULE_LOAD_TYPE_BUILTIN ||
543 mentry->state_flags & AVS_MODULE_STATE_LOADED;
546 int avs_ipc_get_modules_info(struct avs_dev *adev, struct avs_mods_info **info);
548 struct avs_sys_time {
553 int avs_ipc_set_system_time(struct avs_dev *adev);
555 /* Module configuration */
557 #define AVS_MIXIN_MOD_UUID \
558 GUID_INIT(0x39656EB2, 0x3B71, 0x4049, 0x8D, 0x3F, 0xF9, 0x2C, 0xD5, 0xC4, 0x3C, 0x09)
560 #define AVS_MIXOUT_MOD_UUID \
561 GUID_INIT(0x3C56505A, 0x24D7, 0x418F, 0xBD, 0xDC, 0xC1, 0xF5, 0xA3, 0xAC, 0x2A, 0xE0)
563 #define AVS_COPIER_MOD_UUID \
564 GUID_INIT(0x9BA00C83, 0xCA12, 0x4A83, 0x94, 0x3C, 0x1F, 0xA2, 0xE8, 0x2F, 0x9D, 0xDA)
566 #define AVS_PEAKVOL_MOD_UUID \
567 GUID_INIT(0x8A171323, 0x94A3, 0x4E1D, 0xAF, 0xE9, 0xFE, 0x5D, 0xBA, 0xa4, 0xC3, 0x93)
569 #define AVS_GAIN_MOD_UUID \
570 GUID_INIT(0x61BCA9A8, 0x18D0, 0x4A18, 0x8E, 0x7B, 0x26, 0x39, 0x21, 0x98, 0x04, 0xB7)
572 #define AVS_KPBUFF_MOD_UUID \
573 GUID_INIT(0xA8A0CB32, 0x4A77, 0x4DB1, 0x85, 0xC7, 0x53, 0xD7, 0xEE, 0x07, 0xBC, 0xE6)
575 #define AVS_MICSEL_MOD_UUID \
576 GUID_INIT(0x32FE92C1, 0x1E17, 0x4FC2, 0x97, 0x58, 0xC7, 0xF3, 0x54, 0x2E, 0x98, 0x0A)
578 #define AVS_MUX_MOD_UUID \
579 GUID_INIT(0x64CE6E35, 0x857A, 0x4878, 0xAC, 0xE8, 0xE2, 0xA2, 0xF4, 0x2e, 0x30, 0x69)
581 #define AVS_UPDWMIX_MOD_UUID \
582 GUID_INIT(0x42F8060C, 0x832F, 0x4DBF, 0xB2, 0x47, 0x51, 0xE9, 0x61, 0x99, 0x7b, 0x35)
584 #define AVS_SRCINTC_MOD_UUID \
585 GUID_INIT(0xE61BB28D, 0x149A, 0x4C1F, 0xB7, 0x09, 0x46, 0x82, 0x3E, 0xF5, 0xF5, 0xAE)
587 #define AVS_PROBE_MOD_UUID \
588 GUID_INIT(0x7CAD0808, 0xAB10, 0xCD23, 0xEF, 0x45, 0x12, 0xAB, 0x34, 0xCD, 0x56, 0xEF)
590 #define AVS_AEC_MOD_UUID \
591 GUID_INIT(0x46CB87FB, 0xD2C9, 0x4970, 0x96, 0xD2, 0x6D, 0x7E, 0x61, 0x4B, 0xB6, 0x05)
593 #define AVS_ASRC_MOD_UUID \
594 GUID_INIT(0x66B4402D, 0xB468, 0x42F2, 0x81, 0xA7, 0xB3, 0x71, 0x21, 0x86, 0x3D, 0xD4)
596 #define AVS_INTELWOV_MOD_UUID \
597 GUID_INIT(0xEC774FA9, 0x28D3, 0x424A, 0x90, 0xE4, 0x69, 0xF9, 0x84, 0xF1, 0xEE, 0xB7)
600 enum avs_channel_index {
601 AVS_CHANNEL_LEFT = 0,
602 AVS_CHANNEL_RIGHT = 1,
603 AVS_CHANNEL_CENTER = 2,
604 AVS_CHANNEL_LEFT_SURROUND = 3,
605 AVS_CHANNEL_CENTER_SURROUND = 3,
606 AVS_CHANNEL_RIGHT_SURROUND = 4,
608 AVS_CHANNEL_INVALID = 0xF,
611 enum avs_channel_config {
612 AVS_CHANNEL_CONFIG_MONO = 0,
613 AVS_CHANNEL_CONFIG_STEREO = 1,
614 AVS_CHANNEL_CONFIG_2_1 = 2,
615 AVS_CHANNEL_CONFIG_3_0 = 3,
616 AVS_CHANNEL_CONFIG_3_1 = 4,
617 AVS_CHANNEL_CONFIG_QUATRO = 5,
618 AVS_CHANNEL_CONFIG_4_0 = 6,
619 AVS_CHANNEL_CONFIG_5_0 = 7,
620 AVS_CHANNEL_CONFIG_5_1 = 8,
621 AVS_CHANNEL_CONFIG_DUAL_MONO = 9,
622 AVS_CHANNEL_CONFIG_I2S_DUAL_STEREO_0 = 10,
623 AVS_CHANNEL_CONFIG_I2S_DUAL_STEREO_1 = 11,
624 AVS_CHANNEL_CONFIG_7_1 = 12,
625 AVS_CHANNEL_CONFIG_INVALID
628 enum avs_interleaving {
629 AVS_INTERLEAVING_PER_CHANNEL = 0,
630 AVS_INTERLEAVING_PER_SAMPLE = 1,
633 enum avs_sample_type {
634 AVS_SAMPLE_TYPE_INT_MSB = 0,
635 AVS_SAMPLE_TYPE_INT_LSB = 1,
636 AVS_SAMPLE_TYPE_INT_SIGNED = 2,
637 AVS_SAMPLE_TYPE_INT_UNSIGNED = 3,
638 AVS_SAMPLE_TYPE_FLOAT = 4,
641 #define AVS_CHANNELS_MAX 8
642 #define AVS_ALL_CHANNELS_MASK UINT_MAX
644 struct avs_audio_format {
651 u32 valid_bit_depth:8;
656 struct avs_modcfg_base {
661 struct avs_audio_format audio_fmt;
664 struct avs_pin_format {
667 struct avs_audio_format audio_fmt;
670 struct avs_modcfg_ext {
671 struct avs_modcfg_base base;
675 /* input pin formats followed by output ones */
676 struct avs_pin_format pin_fmts[];
680 AVS_DMA_HDA_HOST_OUTPUT = 0,
681 AVS_DMA_HDA_HOST_INPUT = 1,
682 AVS_DMA_HDA_LINK_OUTPUT = 8,
683 AVS_DMA_HDA_LINK_INPUT = 9,
684 AVS_DMA_DMIC_LINK_INPUT = 11,
685 AVS_DMA_I2S_LINK_OUTPUT = 12,
686 AVS_DMA_I2S_LINK_INPUT = 13,
689 union avs_virtual_index {
702 union avs_connector_node_id {
711 #define INVALID_PIPELINE_ID 0xFF
712 #define INVALID_NODE_ID \
713 ((union avs_connector_node_id) { UINT_MAX })
715 union avs_gtw_attributes {
718 u32 lp_buffer_alloc:1;
723 struct avs_copier_gtw_cfg {
724 union avs_connector_node_id node_id;
728 union avs_gtw_attributes attrs;
733 struct avs_copier_cfg {
734 struct avs_modcfg_base base;
735 struct avs_audio_format out_fmt;
737 struct avs_copier_gtw_cfg gtw_cfg;
740 struct avs_volume_cfg {
744 u32 reserved; /* alignment */
748 struct avs_peakvol_cfg {
749 struct avs_modcfg_base base;
750 struct avs_volume_cfg vols[];
753 struct avs_micsel_cfg {
754 struct avs_modcfg_base base;
755 struct avs_audio_format out_fmt;
759 struct avs_modcfg_base base;
760 struct avs_audio_format ref_fmt;
761 struct avs_audio_format out_fmt;
764 struct avs_updown_mixer_cfg {
765 struct avs_modcfg_base base;
766 u32 out_channel_config;
767 u32 coefficients_select;
768 s32 coefficients[AVS_CHANNELS_MAX];
773 struct avs_modcfg_base base;
777 struct avs_probe_gtw_cfg {
778 union avs_connector_node_id node_id;
782 struct avs_probe_cfg {
783 struct avs_modcfg_base base;
784 struct avs_probe_gtw_cfg gtw_cfg;
788 struct avs_modcfg_base base;
789 struct avs_audio_format ref_fmt;
790 struct avs_audio_format out_fmt;
794 struct avs_asrc_cfg {
795 struct avs_modcfg_base base;
800 u32 disable_jitter_buffer:1;
805 struct avs_modcfg_base base;
809 /* Module runtime parameters */
811 enum avs_copier_runtime_param {
812 AVS_COPIER_SET_SINK_FORMAT = 2,
815 struct avs_copier_sink_format {
817 struct avs_audio_format src_fmt;
818 struct avs_audio_format sink_fmt;
821 int avs_ipc_copier_set_sink_format(struct avs_dev *adev, u16 module_id,
822 u8 instance_id, u32 sink_id,
823 const struct avs_audio_format *src_fmt,
824 const struct avs_audio_format *sink_fmt);
826 enum avs_peakvol_runtime_param {
827 AVS_PEAKVOL_VOLUME = 0,
830 enum avs_audio_curve_type {
831 AVS_AUDIO_CURVE_NONE = 0,
832 AVS_AUDIO_CURVE_WINDOWS_FADE = 1,
835 int avs_ipc_peakvol_set_volume(struct avs_dev *adev, u16 module_id, u8 instance_id,
836 struct avs_volume_cfg *vol);
837 int avs_ipc_peakvol_get_volume(struct avs_dev *adev, u16 module_id, u8 instance_id,
838 struct avs_volume_cfg **vols, size_t *num_vols);
840 #define AVS_PROBE_INST_ID 0
842 enum avs_probe_runtime_param {
843 AVS_PROBE_INJECTION_DMA = 1,
844 AVS_PROBE_INJECTION_DMA_DETACH,
846 AVS_PROBE_POINTS_DISCONNECT,
849 struct avs_probe_dma {
850 union avs_connector_node_id node_id;
854 enum avs_probe_type {
855 AVS_PROBE_TYPE_INPUT = 0,
856 AVS_PROBE_TYPE_OUTPUT,
857 AVS_PROBE_TYPE_INTERNAL
860 union avs_probe_point_id {
870 enum avs_connection_purpose {
871 AVS_CONNECTION_PURPOSE_EXTRACT = 0,
872 AVS_CONNECTION_PURPOSE_INJECT,
873 AVS_CONNECTION_PURPOSE_INJECT_REEXTRACT,
876 struct avs_probe_point_desc {
877 union avs_probe_point_id id;
879 union avs_connector_node_id node_id;
882 int avs_ipc_probe_get_dma(struct avs_dev *adev, struct avs_probe_dma **dmas, size_t *num_dmas);
883 int avs_ipc_probe_attach_dma(struct avs_dev *adev, struct avs_probe_dma *dmas, size_t num_dmas);
884 int avs_ipc_probe_detach_dma(struct avs_dev *adev, union avs_connector_node_id *node_ids,
885 size_t num_node_ids);
886 int avs_ipc_probe_get_points(struct avs_dev *adev, struct avs_probe_point_desc **descs,
888 int avs_ipc_probe_connect_points(struct avs_dev *adev, struct avs_probe_point_desc *descs,
890 int avs_ipc_probe_disconnect_points(struct avs_dev *adev, union avs_probe_point_id *ids,
893 #endif /* __SOUND_SOC_INTEL_AVS_MSGS_H */