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 #include <linux/slab.h>
13 #define AVS_CL_TIMEOUT_MS 5000
15 int avs_ipc_set_boot_config(struct avs_dev *adev, u32 dma_id, u32 purge)
17 union avs_global_msg msg = AVS_GLOBAL_REQUEST(ROM_CONTROL);
18 struct avs_ipc_msg request = {{0}};
21 msg.boot_cfg.rom_ctrl_msg_type = AVS_ROM_SET_BOOT_CONFIG;
22 msg.boot_cfg.dma_id = dma_id;
23 msg.boot_cfg.purge_request = purge;
24 request.header = msg.val;
26 ret = avs_dsp_send_rom_msg(adev, &request);
28 avs_ipc_err(adev, &request, "set boot config", ret);
33 int avs_ipc_load_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids)
35 union avs_global_msg msg = AVS_GLOBAL_REQUEST(LOAD_MULTIPLE_MODULES);
36 struct avs_ipc_msg request;
39 msg.load_multi_mods.mod_cnt = num_mod_ids;
40 request.header = msg.val;
41 request.data = mod_ids;
42 request.size = sizeof(*mod_ids) * num_mod_ids;
44 ret = avs_dsp_send_msg_timeout(adev, &request, NULL, AVS_CL_TIMEOUT_MS);
46 avs_ipc_err(adev, &request, "load multiple modules", ret);
51 int avs_ipc_unload_modules(struct avs_dev *adev, u16 *mod_ids, u32 num_mod_ids)
53 union avs_global_msg msg = AVS_GLOBAL_REQUEST(UNLOAD_MULTIPLE_MODULES);
54 struct avs_ipc_msg request;
57 msg.load_multi_mods.mod_cnt = num_mod_ids;
58 request.header = msg.val;
59 request.data = mod_ids;
60 request.size = sizeof(*mod_ids) * num_mod_ids;
62 ret = avs_dsp_send_msg_timeout(adev, &request, NULL, AVS_CL_TIMEOUT_MS);
64 avs_ipc_err(adev, &request, "unload multiple modules", ret);
69 int avs_ipc_load_library(struct avs_dev *adev, u32 dma_id, u32 lib_id)
71 union avs_global_msg msg = AVS_GLOBAL_REQUEST(LOAD_LIBRARY);
72 struct avs_ipc_msg request = {{0}};
75 msg.load_lib.dma_id = dma_id;
76 msg.load_lib.lib_id = lib_id;
77 request.header = msg.val;
79 ret = avs_dsp_send_msg_timeout(adev, &request, NULL, AVS_CL_TIMEOUT_MS);
81 avs_ipc_err(adev, &request, "load library", ret);
86 int avs_ipc_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority,
87 u8 instance_id, bool lp, u16 attributes)
89 union avs_global_msg msg = AVS_GLOBAL_REQUEST(CREATE_PIPELINE);
90 struct avs_ipc_msg request = {{0}};
93 msg.create_ppl.ppl_mem_size = req_size;
94 msg.create_ppl.ppl_priority = priority;
95 msg.create_ppl.instance_id = instance_id;
96 msg.ext.create_ppl.lp = lp;
97 msg.ext.create_ppl.attributes = attributes;
98 request.header = msg.val;
100 ret = avs_dsp_send_msg(adev, &request, NULL);
102 avs_ipc_err(adev, &request, "create pipeline", ret);
107 int avs_ipc_delete_pipeline(struct avs_dev *adev, u8 instance_id)
109 union avs_global_msg msg = AVS_GLOBAL_REQUEST(DELETE_PIPELINE);
110 struct avs_ipc_msg request = {{0}};
113 msg.ppl.instance_id = instance_id;
114 request.header = msg.val;
116 ret = avs_dsp_send_msg(adev, &request, NULL);
118 avs_ipc_err(adev, &request, "delete pipeline", ret);
123 int avs_ipc_set_pipeline_state(struct avs_dev *adev, u8 instance_id,
124 enum avs_pipeline_state state)
126 union avs_global_msg msg = AVS_GLOBAL_REQUEST(SET_PIPELINE_STATE);
127 struct avs_ipc_msg request = {{0}};
130 msg.set_ppl_state.ppl_id = instance_id;
131 msg.set_ppl_state.state = state;
132 request.header = msg.val;
134 ret = avs_dsp_send_msg(adev, &request, NULL);
136 avs_ipc_err(adev, &request, "set pipeline state", ret);
141 int avs_ipc_get_pipeline_state(struct avs_dev *adev, u8 instance_id,
142 enum avs_pipeline_state *state)
144 union avs_global_msg msg = AVS_GLOBAL_REQUEST(GET_PIPELINE_STATE);
145 struct avs_ipc_msg request = {{0}};
146 struct avs_ipc_msg reply = {{0}};
149 msg.get_ppl_state.ppl_id = instance_id;
150 request.header = msg.val;
152 ret = avs_dsp_send_msg(adev, &request, &reply);
154 avs_ipc_err(adev, &request, "get pipeline state", ret);
158 *state = reply.rsp.ext.get_ppl_state.state;
163 * avs_ipc_init_instance - Initialize module instance
165 * @adev: Driver context
166 * @module_id: Module-type id
167 * @instance_id: Unique module instance id
168 * @ppl_id: Parent pipeline id
169 * @core_id: DSP core to allocate module on
170 * @domain: Processing domain (low latency or data processing)
171 * @param: Module-type specific configuration
172 * @param_size: Size of @param in bytes
174 * Argument verification, as well as pipeline state checks are done by the
177 * Note: @ppl_id and @core_id are independent of each other as single pipeline
178 * can be composed of module instances located on different DSP cores.
180 int avs_ipc_init_instance(struct avs_dev *adev, u16 module_id, u8 instance_id,
181 u8 ppl_id, u8 core_id, u8 domain,
182 void *param, u32 param_size)
184 union avs_module_msg msg = AVS_MODULE_REQUEST(INIT_INSTANCE);
185 struct avs_ipc_msg request;
188 msg.module_id = module_id;
189 msg.instance_id = instance_id;
190 /* firmware expects size provided in dwords */
191 msg.ext.init_instance.param_block_size = DIV_ROUND_UP(param_size, sizeof(u32));
192 msg.ext.init_instance.ppl_instance_id = ppl_id;
193 msg.ext.init_instance.core_id = core_id;
194 msg.ext.init_instance.proc_domain = domain;
196 request.header = msg.val;
197 request.data = param;
198 request.size = param_size;
200 ret = avs_dsp_send_msg(adev, &request, NULL);
202 avs_ipc_err(adev, &request, "init instance", ret);
208 * avs_ipc_delete_instance - Delete module instance
210 * @adev: Driver context
211 * @module_id: Module-type id
212 * @instance_id: Unique module instance id
214 * Argument verification, as well as pipeline state checks are done by the
217 * Note: only standalone modules i.e. without a parent pipeline shall be
218 * deleted using this IPC message. In all other cases, pipeline owning the
219 * modules performs cleanup automatically when it is deleted.
221 int avs_ipc_delete_instance(struct avs_dev *adev, u16 module_id, u8 instance_id)
223 union avs_module_msg msg = AVS_MODULE_REQUEST(DELETE_INSTANCE);
224 struct avs_ipc_msg request = {{0}};
227 msg.module_id = module_id;
228 msg.instance_id = instance_id;
229 request.header = msg.val;
231 ret = avs_dsp_send_msg(adev, &request, NULL);
233 avs_ipc_err(adev, &request, "delete instance", ret);
239 * avs_ipc_bind - Bind two module instances
241 * @adev: Driver context
242 * @module_id: Source module-type id
243 * @instance_id: Source module instance id
244 * @dst_module_id: Sink module-type id
245 * @dst_instance_id: Sink module instance id
246 * @dst_queue: Sink module pin to bind @src_queue with
247 * @src_queue: Source module pin to bind @dst_queue with
249 int avs_ipc_bind(struct avs_dev *adev, u16 module_id, u8 instance_id,
250 u16 dst_module_id, u8 dst_instance_id,
251 u8 dst_queue, u8 src_queue)
253 union avs_module_msg msg = AVS_MODULE_REQUEST(BIND);
254 struct avs_ipc_msg request = {{0}};
257 msg.module_id = module_id;
258 msg.instance_id = instance_id;
259 msg.ext.bind_unbind.dst_module_id = dst_module_id;
260 msg.ext.bind_unbind.dst_instance_id = dst_instance_id;
261 msg.ext.bind_unbind.dst_queue = dst_queue;
262 msg.ext.bind_unbind.src_queue = src_queue;
263 request.header = msg.val;
265 ret = avs_dsp_send_msg(adev, &request, NULL);
267 avs_ipc_err(adev, &request, "bind modules", ret);
273 * avs_ipc_unbind - Unbind two module instances
275 * @adev: Driver context
276 * @module_id: Source module-type id
277 * @instance_id: Source module instance id
278 * @dst_module_id: Sink module-type id
279 * @dst_instance_id: Sink module instance id
280 * @dst_queue: Sink module pin to unbind @src_queue from
281 * @src_queue: Source module pin to unbind @dst_queue from
283 int avs_ipc_unbind(struct avs_dev *adev, u16 module_id, u8 instance_id,
284 u16 dst_module_id, u8 dst_instance_id,
285 u8 dst_queue, u8 src_queue)
287 union avs_module_msg msg = AVS_MODULE_REQUEST(UNBIND);
288 struct avs_ipc_msg request = {{0}};
291 msg.module_id = module_id;
292 msg.instance_id = instance_id;
293 msg.ext.bind_unbind.dst_module_id = dst_module_id;
294 msg.ext.bind_unbind.dst_instance_id = dst_instance_id;
295 msg.ext.bind_unbind.dst_queue = dst_queue;
296 msg.ext.bind_unbind.src_queue = src_queue;
297 request.header = msg.val;
299 ret = avs_dsp_send_msg(adev, &request, NULL);
301 avs_ipc_err(adev, &request, "unbind modules", ret);
306 static int __avs_ipc_set_large_config(struct avs_dev *adev, u16 module_id, u8 instance_id,
307 u8 param_id, bool init_block, bool final_block,
308 u8 *request_data, size_t request_size, size_t off_size)
310 union avs_module_msg msg = AVS_MODULE_REQUEST(LARGE_CONFIG_SET);
311 struct avs_ipc_msg request;
314 msg.module_id = module_id;
315 msg.instance_id = instance_id;
316 msg.ext.large_config.data_off_size = off_size;
317 msg.ext.large_config.large_param_id = param_id;
318 msg.ext.large_config.final_block = final_block;
319 msg.ext.large_config.init_block = init_block;
321 request.header = msg.val;
322 request.data = request_data;
323 request.size = request_size;
325 ret = avs_dsp_send_msg(adev, &request, NULL);
327 avs_ipc_err(adev, &request, "large config set", ret);
332 int avs_ipc_set_large_config(struct avs_dev *adev, u16 module_id,
333 u8 instance_id, u8 param_id,
334 u8 *request, size_t request_size)
336 size_t remaining, tx_size;
340 remaining = request_size;
341 tx_size = min_t(size_t, AVS_MAILBOX_SIZE, remaining);
342 final = (tx_size == remaining);
344 /* Initial request states total payload size. */
345 ret = __avs_ipc_set_large_config(adev, module_id, instance_id,
346 param_id, 1, final, request, tx_size,
351 remaining -= tx_size;
353 /* Loop the rest only when payload exceeds mailbox's size. */
357 offset = request_size - remaining;
358 tx_size = min_t(size_t, AVS_MAILBOX_SIZE, remaining);
359 final = (tx_size == remaining);
361 ret = __avs_ipc_set_large_config(adev, module_id, instance_id,
363 request + offset, tx_size,
368 remaining -= tx_size;
374 int avs_ipc_get_large_config(struct avs_dev *adev, u16 module_id, u8 instance_id,
375 u8 param_id, u8 *request_data, size_t request_size,
376 u8 **reply_data, size_t *reply_size)
378 union avs_module_msg msg = AVS_MODULE_REQUEST(LARGE_CONFIG_GET);
379 struct avs_ipc_msg request;
380 struct avs_ipc_msg reply = {{0}};
384 reply.data = kzalloc(AVS_MAILBOX_SIZE, GFP_KERNEL);
388 msg.module_id = module_id;
389 msg.instance_id = instance_id;
390 msg.ext.large_config.data_off_size = request_size;
391 msg.ext.large_config.large_param_id = param_id;
392 /* final_block is always 0 on request. Updated by fw on reply. */
393 msg.ext.large_config.final_block = 0;
394 msg.ext.large_config.init_block = 1;
396 request.header = msg.val;
397 request.data = request_data;
398 request.size = request_size;
399 reply.size = AVS_MAILBOX_SIZE;
401 ret = avs_dsp_send_msg(adev, &request, &reply);
403 avs_ipc_err(adev, &request, "large config get", ret);
408 buf = krealloc(reply.data, reply.size, GFP_KERNEL);
415 *reply_size = reply.size;
420 int avs_ipc_set_dx(struct avs_dev *adev, u32 core_mask, bool powerup)
422 union avs_module_msg msg = AVS_MODULE_REQUEST(SET_DX);
423 struct avs_ipc_msg request;
424 struct avs_dxstate_info dx;
427 dx.core_mask = core_mask;
428 dx.dx_mask = powerup ? core_mask : 0;
429 request.header = msg.val;
431 request.size = sizeof(dx);
433 ret = avs_dsp_send_pm_msg(adev, &request, NULL, true);
435 avs_ipc_err(adev, &request, "set dx", ret);
441 * avs_ipc_set_d0ix - Set power gating policy (entering D0IX substates)
443 * @enable_pg: Whether to enable or disable power gating
444 * @streaming: Whether a stream is running when transitioning
446 int avs_ipc_set_d0ix(struct avs_dev *adev, bool enable_pg, bool streaming)
448 union avs_module_msg msg = AVS_MODULE_REQUEST(SET_D0IX);
449 struct avs_ipc_msg request = {{0}};
452 msg.ext.set_d0ix.wake = enable_pg;
453 msg.ext.set_d0ix.streaming = streaming;
455 request.header = msg.val;
457 ret = avs_dsp_send_pm_msg(adev, &request, NULL, false);
459 avs_ipc_err(adev, &request, "set d0ix", ret);
464 int avs_ipc_get_fw_config(struct avs_dev *adev, struct avs_fw_cfg *cfg)
472 ret = avs_ipc_get_large_config(adev, AVS_BASEFW_MOD_ID, AVS_BASEFW_INST_ID,
473 AVS_BASEFW_FIRMWARE_CONFIG, NULL, 0,
474 &payload, &payload_size);
478 while (offset < payload_size) {
479 tlv = (struct avs_tlv *)(payload + offset);
482 case AVS_FW_CFG_FW_VERSION:
483 memcpy(&cfg->fw_version, tlv->value, sizeof(cfg->fw_version));
486 case AVS_FW_CFG_MEMORY_RECLAIMED:
487 cfg->memory_reclaimed = *tlv->value;
490 case AVS_FW_CFG_SLOW_CLOCK_FREQ_HZ:
491 cfg->slow_clock_freq_hz = *tlv->value;
494 case AVS_FW_CFG_FAST_CLOCK_FREQ_HZ:
495 cfg->fast_clock_freq_hz = *tlv->value;
498 case AVS_FW_CFG_ALH_SUPPORT_LEVEL:
499 cfg->alh_support = *tlv->value;
502 case AVS_FW_CFG_IPC_DL_MAILBOX_BYTES:
503 cfg->ipc_dl_mailbox_bytes = *tlv->value;
506 case AVS_FW_CFG_IPC_UL_MAILBOX_BYTES:
507 cfg->ipc_ul_mailbox_bytes = *tlv->value;
510 case AVS_FW_CFG_TRACE_LOG_BYTES:
511 cfg->trace_log_bytes = *tlv->value;
514 case AVS_FW_CFG_MAX_PPL_COUNT:
515 cfg->max_ppl_count = *tlv->value;
518 case AVS_FW_CFG_MAX_ASTATE_COUNT:
519 cfg->max_astate_count = *tlv->value;
522 case AVS_FW_CFG_MAX_MODULE_PIN_COUNT:
523 cfg->max_module_pin_count = *tlv->value;
526 case AVS_FW_CFG_MODULES_COUNT:
527 cfg->modules_count = *tlv->value;
530 case AVS_FW_CFG_MAX_MOD_INST_COUNT:
531 cfg->max_mod_inst_count = *tlv->value;
534 case AVS_FW_CFG_MAX_LL_TASKS_PER_PRI_COUNT:
535 cfg->max_ll_tasks_per_pri_count = *tlv->value;
538 case AVS_FW_CFG_LL_PRI_COUNT:
539 cfg->ll_pri_count = *tlv->value;
542 case AVS_FW_CFG_MAX_DP_TASKS_COUNT:
543 cfg->max_dp_tasks_count = *tlv->value;
546 case AVS_FW_CFG_MAX_LIBS_COUNT:
547 cfg->max_libs_count = *tlv->value;
550 case AVS_FW_CFG_XTAL_FREQ_HZ:
551 cfg->xtal_freq_hz = *tlv->value;
554 case AVS_FW_CFG_POWER_GATING_POLICY:
555 cfg->power_gating_policy = *tlv->value;
558 /* Known but not useful to us. */
559 case AVS_FW_CFG_DMA_BUFFER_CONFIG:
560 case AVS_FW_CFG_SCHEDULER_CONFIG:
561 case AVS_FW_CFG_CLOCKS_CONFIG:
565 dev_info(adev->dev, "Unrecognized fw param: %d\n", tlv->type);
569 offset += sizeof(*tlv) + tlv->length;
572 /* No longer needed, free it as it's owned by the get_large_config() caller. */
577 int avs_ipc_get_hw_config(struct avs_dev *adev, struct avs_hw_cfg *cfg)
581 size_t size, offset = 0;
585 ret = avs_ipc_get_large_config(adev, AVS_BASEFW_MOD_ID, AVS_BASEFW_INST_ID,
586 AVS_BASEFW_HARDWARE_CONFIG, NULL, 0,
587 &payload, &payload_size);
591 while (offset < payload_size) {
592 tlv = (struct avs_tlv *)(payload + offset);
595 case AVS_HW_CFG_AVS_VER:
596 cfg->avs_version = *tlv->value;
599 case AVS_HW_CFG_DSP_CORES:
600 cfg->dsp_cores = *tlv->value;
603 case AVS_HW_CFG_MEM_PAGE_BYTES:
604 cfg->mem_page_bytes = *tlv->value;
607 case AVS_HW_CFG_TOTAL_PHYS_MEM_PAGES:
608 cfg->total_phys_mem_pages = *tlv->value;
611 case AVS_HW_CFG_I2S_CAPS:
612 cfg->i2s_caps.i2s_version = tlv->value[0];
613 size = tlv->value[1];
614 cfg->i2s_caps.ctrl_count = size;
618 /* Multiply to get entire array size. */
619 size *= sizeof(*cfg->i2s_caps.ctrl_base_addr);
620 cfg->i2s_caps.ctrl_base_addr = devm_kmemdup(adev->dev,
623 if (!cfg->i2s_caps.ctrl_base_addr) {
629 case AVS_HW_CFG_GATEWAY_COUNT:
630 cfg->gateway_count = *tlv->value;
633 case AVS_HW_CFG_HP_EBB_COUNT:
634 cfg->hp_ebb_count = *tlv->value;
637 case AVS_HW_CFG_LP_EBB_COUNT:
638 cfg->lp_ebb_count = *tlv->value;
641 case AVS_HW_CFG_EBB_SIZE_BYTES:
642 cfg->ebb_size_bytes = *tlv->value;
645 case AVS_HW_CFG_GPDMA_CAPS:
649 dev_info(adev->dev, "Unrecognized hw config: %d\n", tlv->type);
653 offset += sizeof(*tlv) + tlv->length;
657 /* No longer needed, free it as it's owned by the get_large_config() caller. */
662 int avs_ipc_get_modules_info(struct avs_dev *adev, struct avs_mods_info **info)
668 ret = avs_ipc_get_large_config(adev, AVS_BASEFW_MOD_ID, AVS_BASEFW_INST_ID,
669 AVS_BASEFW_MODULES_INFO, NULL, 0,
670 &payload, &payload_size);
674 *info = (struct avs_mods_info *)payload;
678 int avs_ipc_set_enable_logs(struct avs_dev *adev, u8 *log_info, size_t size)
682 ret = avs_ipc_set_large_config(adev, AVS_BASEFW_MOD_ID, AVS_BASEFW_INST_ID,
683 AVS_BASEFW_ENABLE_LOGS, log_info, size);
685 dev_err(adev->dev, "enable logs failed: %d\n", ret);
690 int avs_ipc_set_system_time(struct avs_dev *adev)
692 struct avs_sys_time sys_time;
696 /* firmware expects UTC time in micro seconds */
697 us = ktime_to_us(ktime_get());
698 sys_time.val_l = us & UINT_MAX;
699 sys_time.val_u = us >> 32;
701 ret = avs_ipc_set_large_config(adev, AVS_BASEFW_MOD_ID, AVS_BASEFW_INST_ID,
702 AVS_BASEFW_SYSTEM_TIME, (u8 *)&sys_time, sizeof(sys_time));
704 dev_err(adev->dev, "set system time failed: %d\n", ret);
709 int avs_ipc_copier_set_sink_format(struct avs_dev *adev, u16 module_id,
710 u8 instance_id, u32 sink_id,
711 const struct avs_audio_format *src_fmt,
712 const struct avs_audio_format *sink_fmt)
714 struct avs_copier_sink_format cpr_fmt;
716 cpr_fmt.sink_id = sink_id;
717 /* Firmware expects driver to resend copier's input format. */
718 cpr_fmt.src_fmt = *src_fmt;
719 cpr_fmt.sink_fmt = *sink_fmt;
721 return avs_ipc_set_large_config(adev, module_id, instance_id,
722 AVS_COPIER_SET_SINK_FORMAT,
723 (u8 *)&cpr_fmt, sizeof(cpr_fmt));