2 * skl-sst.c - HDA DSP library functions for SKL platform
4 * Copyright (C) 2014-15, Intel Corporation.
5 * Author:Rafal Redzimski <rafal.f.redzimski@intel.com>
6 * Jeeja KP <jeeja.kp@intel.com>
7 * ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
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 version 2, as
11 * published by the Free Software Foundation.
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.
19 #include <linux/module.h>
20 #include <linux/delay.h>
21 #include <linux/device.h>
22 #include <linux/err.h>
23 #include <linux/uuid.h>
24 #include "../common/sst-dsp.h"
25 #include "../common/sst-dsp-priv.h"
26 #include "../common/sst-ipc.h"
27 #include "skl-sst-ipc.h"
29 #define SKL_BASEFW_TIMEOUT 300
30 #define SKL_INIT_TIMEOUT 1000
32 /* Intel HD Audio SRAM Window 0*/
33 #define SKL_ADSP_SRAM0_BASE 0x8000
35 /* Firmware status window */
36 #define SKL_ADSP_FW_STATUS SKL_ADSP_SRAM0_BASE
37 #define SKL_ADSP_ERROR_CODE (SKL_ADSP_FW_STATUS + 0x4)
39 #define SKL_NUM_MODULES 1
41 static bool skl_check_fw_status(struct sst_dsp
*ctx
, u32 status
)
45 cur_sts
= sst_dsp_shim_read(ctx
, SKL_ADSP_FW_STATUS
) & SKL_FW_STS_MASK
;
47 return (cur_sts
== status
);
50 static int skl_transfer_firmware(struct sst_dsp
*ctx
,
51 const void *basefw
, u32 base_fw_size
)
55 ret
= ctx
->cl_dev
.ops
.cl_copy_to_dmabuf(ctx
, basefw
, base_fw_size
);
59 ret
= sst_dsp_register_poll(ctx
,
66 ctx
->cl_dev
.ops
.cl_stop_dma(ctx
);
71 static int skl_load_base_firmware(struct sst_dsp
*ctx
)
74 struct skl_sst
*skl
= ctx
->thread_context
;
77 skl
->boot_complete
= false;
78 init_waitqueue_head(&skl
->boot_wait
);
80 if (ctx
->fw
== NULL
) {
81 ret
= request_firmware(&ctx
->fw
, ctx
->fw_name
, ctx
->dev
);
83 dev_err(ctx
->dev
, "Request firmware failed %d\n", ret
);
84 skl_dsp_disable_core(ctx
);
89 ret
= skl_dsp_boot(ctx
);
91 dev_err(ctx
->dev
, "Boot dsp core failed ret: %d", ret
);
92 goto skl_load_base_firmware_failed
;
95 ret
= skl_cldma_prepare(ctx
);
97 dev_err(ctx
->dev
, "CL dma prepare failed : %d", ret
);
98 goto skl_load_base_firmware_failed
;
101 /* enable Interrupt */
102 skl_ipc_int_enable(ctx
);
103 skl_ipc_op_int_enable(ctx
);
105 /* check ROM Status */
106 for (i
= SKL_INIT_TIMEOUT
; i
> 0; --i
) {
107 if (skl_check_fw_status(ctx
, SKL_FW_INIT
)) {
109 "ROM loaded, we can continue with FW loading\n");
115 reg
= sst_dsp_shim_read(ctx
, SKL_ADSP_FW_STATUS
);
117 "Timeout waiting for ROM init done, reg:0x%x\n", reg
);
119 goto transfer_firmware_failed
;
122 ret
= skl_transfer_firmware(ctx
, ctx
->fw
->data
, ctx
->fw
->size
);
124 dev_err(ctx
->dev
, "Transfer firmware failed%d\n", ret
);
125 goto transfer_firmware_failed
;
127 ret
= wait_event_timeout(skl
->boot_wait
, skl
->boot_complete
,
128 msecs_to_jiffies(SKL_IPC_BOOT_MSECS
));
130 dev_err(ctx
->dev
, "DSP boot failed, FW Ready timed-out\n");
132 goto transfer_firmware_failed
;
135 dev_dbg(ctx
->dev
, "Download firmware successful%d\n", ret
);
136 skl_dsp_set_state_locked(ctx
, SKL_DSP_RUNNING
);
139 transfer_firmware_failed
:
140 ctx
->cl_dev
.ops
.cl_cleanup_controller(ctx
);
141 skl_load_base_firmware_failed
:
142 skl_dsp_disable_core(ctx
);
143 release_firmware(ctx
->fw
);
148 static int skl_set_dsp_D0(struct sst_dsp
*ctx
)
152 ret
= skl_load_base_firmware(ctx
);
154 dev_err(ctx
->dev
, "unable to load firmware\n");
158 skl_dsp_set_state_locked(ctx
, SKL_DSP_RUNNING
);
163 static int skl_set_dsp_D3(struct sst_dsp
*ctx
)
166 struct skl_ipc_dxstate_info dx
;
167 struct skl_sst
*skl
= ctx
->thread_context
;
169 dev_dbg(ctx
->dev
, "In %s:\n", __func__
);
170 mutex_lock(&ctx
->mutex
);
171 if (!is_skl_dsp_running(ctx
)) {
172 mutex_unlock(&ctx
->mutex
);
175 mutex_unlock(&ctx
->mutex
);
177 dx
.core_mask
= SKL_DSP_CORE0_MASK
;
178 dx
.dx_mask
= SKL_IPC_D3_MASK
;
179 ret
= skl_ipc_set_dx(&skl
->ipc
, SKL_INSTANCE_ID
, SKL_BASE_FW_MODULE_ID
, &dx
);
182 "D3 request to FW failed, continuing reset: %d", ret
);
184 /* disable Interrupt */
185 ctx
->cl_dev
.ops
.cl_cleanup_controller(ctx
);
186 skl_cldma_int_disable(ctx
);
187 skl_ipc_op_int_disable(ctx
);
188 skl_ipc_int_disable(ctx
);
190 ret
= skl_dsp_disable_core(ctx
);
192 dev_err(ctx
->dev
, "disable dsp core failed ret: %d\n", ret
);
195 skl_dsp_set_state_locked(ctx
, SKL_DSP_RESET
);
200 static unsigned int skl_get_errorcode(struct sst_dsp
*ctx
)
202 return sst_dsp_shim_read(ctx
, SKL_ADSP_ERROR_CODE
);
206 * since get/set_module are called from DAPM context,
207 * we don't need lock for usage count
209 static int skl_get_module(struct sst_dsp
*ctx
, u16 mod_id
)
211 struct skl_module_table
*module
;
213 list_for_each_entry(module
, &ctx
->module_list
, list
) {
214 if (module
->mod_info
->mod_id
== mod_id
)
215 return ++module
->usage_cnt
;
221 static int skl_put_module(struct sst_dsp
*ctx
, u16 mod_id
)
223 struct skl_module_table
*module
;
225 list_for_each_entry(module
, &ctx
->module_list
, list
) {
226 if (module
->mod_info
->mod_id
== mod_id
)
227 return --module
->usage_cnt
;
233 static struct skl_module_table
*skl_fill_module_table(struct sst_dsp
*ctx
,
234 char *mod_name
, int mod_id
)
236 const struct firmware
*fw
;
237 struct skl_module_table
*skl_module
;
241 ret
= request_firmware(&fw
, mod_name
, ctx
->dev
);
243 dev_err(ctx
->dev
, "Request Module %s failed :%d\n",
248 skl_module
= devm_kzalloc(ctx
->dev
, sizeof(*skl_module
), GFP_KERNEL
);
249 if (skl_module
== NULL
) {
250 release_firmware(fw
);
254 size
= sizeof(*skl_module
->mod_info
);
255 skl_module
->mod_info
= devm_kzalloc(ctx
->dev
, size
, GFP_KERNEL
);
256 if (skl_module
->mod_info
== NULL
) {
257 release_firmware(fw
);
261 skl_module
->mod_info
->mod_id
= mod_id
;
262 skl_module
->mod_info
->fw
= fw
;
263 list_add(&skl_module
->list
, &ctx
->module_list
);
268 /* get a module from it's unique ID */
269 static struct skl_module_table
*skl_module_get_from_id(
270 struct sst_dsp
*ctx
, u16 mod_id
)
272 struct skl_module_table
*module
;
274 if (list_empty(&ctx
->module_list
)) {
275 dev_err(ctx
->dev
, "Module list is empty\n");
279 list_for_each_entry(module
, &ctx
->module_list
, list
) {
280 if (module
->mod_info
->mod_id
== mod_id
)
287 static int skl_transfer_module(struct sst_dsp
*ctx
,
288 struct skl_load_module_info
*module
)
291 struct skl_sst
*skl
= ctx
->thread_context
;
293 ret
= ctx
->cl_dev
.ops
.cl_copy_to_dmabuf(ctx
, module
->fw
->data
,
298 ret
= skl_ipc_load_modules(&skl
->ipc
, SKL_NUM_MODULES
,
299 (void *)&module
->mod_id
);
301 dev_err(ctx
->dev
, "Failed to Load module: %d\n", ret
);
303 ctx
->cl_dev
.ops
.cl_stop_dma(ctx
);
308 static int skl_load_module(struct sst_dsp
*ctx
, u16 mod_id
, u8
*guid
)
310 struct skl_module_table
*module_entry
= NULL
;
312 char mod_name
[64]; /* guid str = 32 chars + 4 hyphens */
315 uuid_mod
= (uuid_le
*)guid
;
316 snprintf(mod_name
, sizeof(mod_name
), "%s%pUL%s",
317 "intel/dsp_fw_", uuid_mod
, ".bin");
319 module_entry
= skl_module_get_from_id(ctx
, mod_id
);
320 if (module_entry
== NULL
) {
321 module_entry
= skl_fill_module_table(ctx
, mod_name
, mod_id
);
322 if (module_entry
== NULL
) {
323 dev_err(ctx
->dev
, "Failed to Load module\n");
328 if (!module_entry
->usage_cnt
) {
329 ret
= skl_transfer_module(ctx
, module_entry
->mod_info
);
331 dev_err(ctx
->dev
, "Failed to Load module\n");
336 ret
= skl_get_module(ctx
, mod_id
);
341 static int skl_unload_module(struct sst_dsp
*ctx
, u16 mod_id
)
344 struct skl_sst
*skl
= ctx
->thread_context
;
347 usage_cnt
= skl_put_module(ctx
, mod_id
);
349 dev_err(ctx
->dev
, "Module bad usage cnt!:%d\n", usage_cnt
);
352 ret
= skl_ipc_unload_modules(&skl
->ipc
,
353 SKL_NUM_MODULES
, &mod_id
);
355 dev_err(ctx
->dev
, "Failed to UnLoad module\n");
356 skl_get_module(ctx
, mod_id
);
363 static void skl_clear_module_table(struct sst_dsp
*ctx
)
365 struct skl_module_table
*module
, *tmp
;
367 if (list_empty(&ctx
->module_list
))
370 list_for_each_entry_safe(module
, tmp
, &ctx
->module_list
, list
) {
371 list_del(&module
->list
);
372 release_firmware(module
->mod_info
->fw
);
376 static struct skl_dsp_fw_ops skl_fw_ops
= {
377 .set_state_D0
= skl_set_dsp_D0
,
378 .set_state_D3
= skl_set_dsp_D3
,
379 .load_fw
= skl_load_base_firmware
,
380 .get_fw_errcode
= skl_get_errorcode
,
381 .load_mod
= skl_load_module
,
382 .unload_mod
= skl_unload_module
,
385 static struct sst_ops skl_ops
= {
386 .irq_handler
= skl_dsp_sst_interrupt
,
387 .write
= sst_shim32_write
,
388 .read
= sst_shim32_read
,
389 .ram_read
= sst_memcpy_fromio_32
,
390 .ram_write
= sst_memcpy_toio_32
,
391 .free
= skl_dsp_free
,
394 static struct sst_dsp_device skl_dev
= {
395 .thread
= skl_dsp_irq_thread_handler
,
399 int skl_sst_dsp_init(struct device
*dev
, void __iomem
*mmio_base
, int irq
,
400 const char *fw_name
, struct skl_dsp_loader_ops dsp_ops
, struct skl_sst
**dsp
)
406 skl
= devm_kzalloc(dev
, sizeof(*skl
), GFP_KERNEL
);
411 skl_dev
.thread_context
= skl
;
413 skl
->dsp
= skl_dsp_ctx_init(dev
, &skl_dev
, irq
);
415 dev_err(skl
->dev
, "%s: no device\n", __func__
);
421 sst
->fw_name
= fw_name
;
422 sst
->addr
.lpe
= mmio_base
;
423 sst
->addr
.shim
= mmio_base
;
424 sst_dsp_mailbox_init(sst
, (SKL_ADSP_SRAM0_BASE
+ SKL_ADSP_W0_STAT_SZ
),
425 SKL_ADSP_W0_UP_SZ
, SKL_ADSP_SRAM1_BASE
, SKL_ADSP_W1_SZ
);
427 INIT_LIST_HEAD(&sst
->module_list
);
428 sst
->dsp_ops
= dsp_ops
;
429 sst
->fw_ops
= skl_fw_ops
;
431 ret
= skl_ipc_init(dev
, skl
);
435 ret
= sst
->fw_ops
.load_fw(sst
);
437 dev_err(dev
, "Load base fw failed : %d", ret
);
447 skl_sst_dsp_cleanup(dev
, skl
);
450 EXPORT_SYMBOL_GPL(skl_sst_dsp_init
);
452 void skl_sst_dsp_cleanup(struct device
*dev
, struct skl_sst
*ctx
)
454 skl_clear_module_table(ctx
->dsp
);
455 skl_ipc_free(&ctx
->ipc
);
456 ctx
->dsp
->ops
->free(ctx
->dsp
);
457 if (ctx
->boot_complete
) {
458 ctx
->dsp
->cl_dev
.ops
.cl_cleanup_controller(ctx
->dsp
);
459 skl_cldma_int_disable(ctx
->dsp
);
462 EXPORT_SYMBOL_GPL(skl_sst_dsp_cleanup
);
464 MODULE_LICENSE("GPL v2");
465 MODULE_DESCRIPTION("Intel Skylake IPC driver");