1 // SPDX-License-Identifier: GPL-2.0-only
3 * bxt-sst.c - DSP library functions for BXT platform
5 * Copyright (C) 2015-16 Intel Corp
6 * Author:Rafal Redzimski <rafal.f.redzimski@intel.com>
7 * Jeeja KP <jeeja.kp@intel.com>
10 #include <linux/module.h>
11 #include <linux/delay.h>
12 #include <linux/firmware.h>
13 #include <linux/device.h>
15 #include "../common/sst-dsp.h"
16 #include "../common/sst-dsp-priv.h"
19 #define BXT_BASEFW_TIMEOUT 3000
20 #define BXT_ROM_INIT_TIMEOUT 70
21 #define BXT_IPC_PURGE_FW 0x01004000
23 #define BXT_ROM_INIT 0x5
24 #define BXT_ADSP_SRAM0_BASE 0x80000
26 /* Firmware status window */
27 #define BXT_ADSP_FW_STATUS BXT_ADSP_SRAM0_BASE
28 #define BXT_ADSP_ERROR_CODE (BXT_ADSP_FW_STATUS + 0x4)
30 #define BXT_ADSP_SRAM1_BASE 0xA0000
32 #define BXT_INSTANCE_ID 0
33 #define BXT_BASE_FW_MODULE_ID 0
35 #define BXT_ADSP_FW_BIN_HDR_OFFSET 0x2000
37 /* Delay before scheduling D0i3 entry */
38 #define BXT_D0I3_DELAY 5000
40 static unsigned int bxt_get_errorcode(struct sst_dsp
*ctx
)
42 return sst_dsp_shim_read(ctx
, BXT_ADSP_ERROR_CODE
);
46 bxt_load_library(struct sst_dsp
*ctx
, struct skl_lib_info
*linfo
, int lib_count
)
48 struct snd_dma_buffer dmab
;
49 struct skl_dev
*skl
= ctx
->thread_context
;
50 struct firmware stripped_fw
;
51 int ret
= 0, i
, dma_id
, stream_tag
;
53 /* library indices start from 1 to N. 0 represents base FW */
54 for (i
= 1; i
< lib_count
; i
++) {
55 ret
= skl_prepare_lib_load(skl
, &skl
->lib_info
[i
], &stripped_fw
,
56 BXT_ADSP_FW_BIN_HDR_OFFSET
, i
);
58 goto load_library_failed
;
60 stream_tag
= ctx
->dsp_ops
.prepare(ctx
->dev
, 0x40,
61 stripped_fw
.size
, &dmab
);
62 if (stream_tag
<= 0) {
63 dev_err(ctx
->dev
, "Lib prepare DMA err: %x\n",
66 goto load_library_failed
;
69 dma_id
= stream_tag
- 1;
70 memcpy(dmab
.area
, stripped_fw
.data
, stripped_fw
.size
);
72 ctx
->dsp_ops
.trigger(ctx
->dev
, true, stream_tag
);
73 ret
= skl_sst_ipc_load_library(&skl
->ipc
, dma_id
, i
, true);
75 dev_err(ctx
->dev
, "IPC Load Lib for %s fail: %d\n",
78 ctx
->dsp_ops
.trigger(ctx
->dev
, false, stream_tag
);
79 ctx
->dsp_ops
.cleanup(ctx
->dev
, &dmab
, stream_tag
);
85 skl_release_library(linfo
, lib_count
);
90 * First boot sequence has some extra steps. Core 0 waits for power
91 * status on core 1, so power up core 1 also momentarily, keep it in
92 * reset/stall and then turn it off
94 static int sst_bxt_prepare_fw(struct sst_dsp
*ctx
,
95 const void *fwdata
, u32 fwsize
)
99 stream_tag
= ctx
->dsp_ops
.prepare(ctx
->dev
, 0x40, fwsize
, &ctx
->dmab
);
100 if (stream_tag
<= 0) {
101 dev_err(ctx
->dev
, "Failed to prepare DMA FW loading err: %x\n",
106 ctx
->dsp_ops
.stream_tag
= stream_tag
;
107 memcpy(ctx
->dmab
.area
, fwdata
, fwsize
);
109 /* Step 1: Power up core 0 and core1 */
110 ret
= skl_dsp_core_power_up(ctx
, SKL_DSP_CORE0_MASK
|
111 SKL_DSP_CORE_MASK(1));
113 dev_err(ctx
->dev
, "dsp core0/1 power up failed\n");
114 goto base_fw_load_failed
;
117 /* Step 2: Purge FW request */
118 sst_dsp_shim_write(ctx
, SKL_ADSP_REG_HIPCI
, SKL_ADSP_REG_HIPCI_BUSY
|
119 (BXT_IPC_PURGE_FW
| ((stream_tag
- 1) << 9)));
121 /* Step 3: Unset core0 reset state & unstall/run core0 */
122 ret
= skl_dsp_start_core(ctx
, SKL_DSP_CORE0_MASK
);
124 dev_err(ctx
->dev
, "Start dsp core failed ret: %d\n", ret
);
126 goto base_fw_load_failed
;
129 /* Step 4: Wait for DONE Bit */
130 ret
= sst_dsp_register_poll(ctx
, SKL_ADSP_REG_HIPCIE
,
131 SKL_ADSP_REG_HIPCIE_DONE
,
132 SKL_ADSP_REG_HIPCIE_DONE
,
133 BXT_INIT_TIMEOUT
, "HIPCIE Done");
135 dev_err(ctx
->dev
, "Timeout for Purge Request%d\n", ret
);
136 goto base_fw_load_failed
;
139 /* Step 5: power down core1 */
140 ret
= skl_dsp_core_power_down(ctx
, SKL_DSP_CORE_MASK(1));
142 dev_err(ctx
->dev
, "dsp core1 power down failed\n");
143 goto base_fw_load_failed
;
146 /* Step 6: Enable Interrupt */
147 skl_ipc_int_enable(ctx
);
148 skl_ipc_op_int_enable(ctx
);
150 /* Step 7: Wait for ROM init */
151 ret
= sst_dsp_register_poll(ctx
, BXT_ADSP_FW_STATUS
, SKL_FW_STS_MASK
,
152 SKL_FW_INIT
, BXT_ROM_INIT_TIMEOUT
, "ROM Load");
154 dev_err(ctx
->dev
, "Timeout for ROM init, ret:%d\n", ret
);
155 goto base_fw_load_failed
;
161 ctx
->dsp_ops
.cleanup(ctx
->dev
, &ctx
->dmab
, stream_tag
);
162 skl_dsp_core_power_down(ctx
, SKL_DSP_CORE_MASK(1));
163 skl_dsp_disable_core(ctx
, SKL_DSP_CORE0_MASK
);
167 static int sst_transfer_fw_host_dma(struct sst_dsp
*ctx
)
171 ctx
->dsp_ops
.trigger(ctx
->dev
, true, ctx
->dsp_ops
.stream_tag
);
172 ret
= sst_dsp_register_poll(ctx
, BXT_ADSP_FW_STATUS
, SKL_FW_STS_MASK
,
173 BXT_ROM_INIT
, BXT_BASEFW_TIMEOUT
, "Firmware boot");
175 ctx
->dsp_ops
.trigger(ctx
->dev
, false, ctx
->dsp_ops
.stream_tag
);
176 ctx
->dsp_ops
.cleanup(ctx
->dev
, &ctx
->dmab
, ctx
->dsp_ops
.stream_tag
);
181 static int bxt_load_base_firmware(struct sst_dsp
*ctx
)
183 struct firmware stripped_fw
;
184 struct skl_dev
*skl
= ctx
->thread_context
;
187 if (ctx
->fw
== NULL
) {
188 ret
= request_firmware(&ctx
->fw
, ctx
->fw_name
, ctx
->dev
);
190 dev_err(ctx
->dev
, "Request firmware failed %d\n", ret
);
195 /* prase uuids on first boot */
196 if (skl
->is_first_boot
) {
197 ret
= snd_skl_parse_uuids(ctx
, ctx
->fw
, BXT_ADSP_FW_BIN_HDR_OFFSET
, 0);
199 goto sst_load_base_firmware_failed
;
202 stripped_fw
.data
= ctx
->fw
->data
;
203 stripped_fw
.size
= ctx
->fw
->size
;
204 skl_dsp_strip_extended_manifest(&stripped_fw
);
207 for (i
= 0; i
< BXT_FW_ROM_INIT_RETRY
; i
++) {
208 ret
= sst_bxt_prepare_fw(ctx
, stripped_fw
.data
, stripped_fw
.size
);
214 dev_err(ctx
->dev
, "Error code=0x%x: FW status=0x%x\n",
215 sst_dsp_shim_read(ctx
, BXT_ADSP_ERROR_CODE
),
216 sst_dsp_shim_read(ctx
, BXT_ADSP_FW_STATUS
));
218 dev_err(ctx
->dev
, "Core En/ROM load fail:%d\n", ret
);
219 goto sst_load_base_firmware_failed
;
222 ret
= sst_transfer_fw_host_dma(ctx
);
224 dev_err(ctx
->dev
, "Transfer firmware failed %d\n", ret
);
225 dev_info(ctx
->dev
, "Error code=0x%x: FW status=0x%x\n",
226 sst_dsp_shim_read(ctx
, BXT_ADSP_ERROR_CODE
),
227 sst_dsp_shim_read(ctx
, BXT_ADSP_FW_STATUS
));
229 skl_dsp_disable_core(ctx
, SKL_DSP_CORE0_MASK
);
231 dev_dbg(ctx
->dev
, "Firmware download successful\n");
232 ret
= wait_event_timeout(skl
->boot_wait
, skl
->boot_complete
,
233 msecs_to_jiffies(SKL_IPC_BOOT_MSECS
));
235 dev_err(ctx
->dev
, "DSP boot fail, FW Ready timeout\n");
236 skl_dsp_disable_core(ctx
, SKL_DSP_CORE0_MASK
);
240 skl
->fw_loaded
= true;
246 sst_load_base_firmware_failed
:
247 release_firmware(ctx
->fw
);
253 * Decide the D0i3 state that can be targeted based on the usecase
254 * ref counts and DSP state
256 * Decision Matrix: (X= dont care; state = target state)
258 * DSP state != SKL_DSP_RUNNING ; state = no d0i3
260 * DSP state == SKL_DSP_RUNNING , the following matrix applies
261 * non_d0i3 >0; streaming =X; non_streaming =X; state = no d0i3
262 * non_d0i3 =X; streaming =0; non_streaming =0; state = no d0i3
263 * non_d0i3 =0; streaming >0; non_streaming =X; state = streaming d0i3
264 * non_d0i3 =0; streaming =0; non_streaming =X; state = non-streaming d0i3
266 static int bxt_d0i3_target_state(struct sst_dsp
*ctx
)
268 struct skl_dev
*skl
= ctx
->thread_context
;
269 struct skl_d0i3_data
*d0i3
= &skl
->d0i3
;
271 if (skl
->cores
.state
[SKL_DSP_CORE0_ID
] != SKL_DSP_RUNNING
)
272 return SKL_DSP_D0I3_NONE
;
275 return SKL_DSP_D0I3_NONE
;
276 else if (d0i3
->streaming
)
277 return SKL_DSP_D0I3_STREAMING
;
278 else if (d0i3
->non_streaming
)
279 return SKL_DSP_D0I3_NON_STREAMING
;
281 return SKL_DSP_D0I3_NONE
;
284 static void bxt_set_dsp_D0i3(struct work_struct
*work
)
287 struct skl_ipc_d0ix_msg msg
;
288 struct skl_dev
*skl
= container_of(work
,
289 struct skl_dev
, d0i3
.work
.work
);
290 struct sst_dsp
*ctx
= skl
->dsp
;
291 struct skl_d0i3_data
*d0i3
= &skl
->d0i3
;
294 dev_dbg(ctx
->dev
, "In %s:\n", __func__
);
296 /* D0i3 entry allowed only if core 0 alone is running */
297 if (skl_dsp_get_enabled_cores(ctx
) != SKL_DSP_CORE0_MASK
) {
299 "D0i3 allowed when only core0 running:Exit\n");
303 target_state
= bxt_d0i3_target_state(ctx
);
304 if (target_state
== SKL_DSP_D0I3_NONE
)
311 if (target_state
== SKL_DSP_D0I3_STREAMING
)
314 ret
= skl_ipc_set_d0ix(&skl
->ipc
, &msg
);
317 dev_err(ctx
->dev
, "Failed to set DSP to D0i3 state\n");
321 /* Set Vendor specific register D0I3C.I3 to enable D0i3*/
322 if (skl
->update_d0i3c
)
323 skl
->update_d0i3c(skl
->dev
, true);
325 d0i3
->state
= target_state
;
326 skl
->cores
.state
[SKL_DSP_CORE0_ID
] = SKL_DSP_RUNNING_D0I3
;
329 static int bxt_schedule_dsp_D0i3(struct sst_dsp
*ctx
)
331 struct skl_dev
*skl
= ctx
->thread_context
;
332 struct skl_d0i3_data
*d0i3
= &skl
->d0i3
;
334 /* Schedule D0i3 only if the usecase ref counts are appropriate */
335 if (bxt_d0i3_target_state(ctx
) != SKL_DSP_D0I3_NONE
) {
337 dev_dbg(ctx
->dev
, "%s: Schedule D0i3\n", __func__
);
339 schedule_delayed_work(&d0i3
->work
,
340 msecs_to_jiffies(BXT_D0I3_DELAY
));
346 static int bxt_set_dsp_D0i0(struct sst_dsp
*ctx
)
349 struct skl_ipc_d0ix_msg msg
;
350 struct skl_dev
*skl
= ctx
->thread_context
;
352 dev_dbg(ctx
->dev
, "In %s:\n", __func__
);
354 /* First Cancel any pending attempt to put DSP to D0i3 */
355 cancel_delayed_work_sync(&skl
->d0i3
.work
);
357 /* If DSP is currently in D0i3, bring it to D0i0 */
358 if (skl
->cores
.state
[SKL_DSP_CORE0_ID
] != SKL_DSP_RUNNING_D0I3
)
361 dev_dbg(ctx
->dev
, "Set DSP to D0i0\n");
368 if (skl
->d0i3
.state
== SKL_DSP_D0I3_STREAMING
)
371 /* Clear Vendor specific register D0I3C.I3 to disable D0i3*/
372 if (skl
->update_d0i3c
)
373 skl
->update_d0i3c(skl
->dev
, false);
375 ret
= skl_ipc_set_d0ix(&skl
->ipc
, &msg
);
377 dev_err(ctx
->dev
, "Failed to set DSP to D0i0\n");
381 skl
->cores
.state
[SKL_DSP_CORE0_ID
] = SKL_DSP_RUNNING
;
382 skl
->d0i3
.state
= SKL_DSP_D0I3_NONE
;
387 static int bxt_set_dsp_D0(struct sst_dsp
*ctx
, unsigned int core_id
)
389 struct skl_dev
*skl
= ctx
->thread_context
;
391 struct skl_ipc_dxstate_info dx
;
392 unsigned int core_mask
= SKL_DSP_CORE_MASK(core_id
);
394 if (skl
->fw_loaded
== false) {
395 skl
->boot_complete
= false;
396 ret
= bxt_load_base_firmware(ctx
);
398 dev_err(ctx
->dev
, "reload fw failed: %d\n", ret
);
402 if (skl
->lib_count
> 1) {
403 ret
= bxt_load_library(ctx
, skl
->lib_info
,
406 dev_err(ctx
->dev
, "reload libs failed: %d\n", ret
);
410 skl
->cores
.state
[core_id
] = SKL_DSP_RUNNING
;
414 /* If core 0 is being turned on, turn on core 1 as well */
415 if (core_id
== SKL_DSP_CORE0_ID
)
416 ret
= skl_dsp_core_power_up(ctx
, core_mask
|
417 SKL_DSP_CORE_MASK(1));
419 ret
= skl_dsp_core_power_up(ctx
, core_mask
);
424 if (core_id
== SKL_DSP_CORE0_ID
) {
427 * Enable interrupt after SPA is set and before
430 skl_ipc_int_enable(ctx
);
431 skl_ipc_op_int_enable(ctx
);
432 skl
->boot_complete
= false;
435 ret
= skl_dsp_start_core(ctx
, core_mask
);
439 if (core_id
== SKL_DSP_CORE0_ID
) {
440 ret
= wait_event_timeout(skl
->boot_wait
,
442 msecs_to_jiffies(SKL_IPC_BOOT_MSECS
));
444 /* If core 1 was turned on for booting core 0, turn it off */
445 skl_dsp_core_power_down(ctx
, SKL_DSP_CORE_MASK(1));
447 dev_err(ctx
->dev
, "%s: DSP boot timeout\n", __func__
);
448 dev_err(ctx
->dev
, "Error code=0x%x: FW status=0x%x\n",
449 sst_dsp_shim_read(ctx
, BXT_ADSP_ERROR_CODE
),
450 sst_dsp_shim_read(ctx
, BXT_ADSP_FW_STATUS
));
451 dev_err(ctx
->dev
, "Failed to set core0 to D0 state\n");
457 /* Tell FW if additional core in now On */
459 if (core_id
!= SKL_DSP_CORE0_ID
) {
460 dx
.core_mask
= core_mask
;
461 dx
.dx_mask
= core_mask
;
463 ret
= skl_ipc_set_dx(&skl
->ipc
, BXT_INSTANCE_ID
,
464 BXT_BASE_FW_MODULE_ID
, &dx
);
466 dev_err(ctx
->dev
, "IPC set_dx for core %d fail: %d\n",
472 skl
->cores
.state
[core_id
] = SKL_DSP_RUNNING
;
475 if (core_id
== SKL_DSP_CORE0_ID
)
476 core_mask
|= SKL_DSP_CORE_MASK(1);
477 skl_dsp_disable_core(ctx
, core_mask
);
482 static int bxt_set_dsp_D3(struct sst_dsp
*ctx
, unsigned int core_id
)
485 struct skl_ipc_dxstate_info dx
;
486 struct skl_dev
*skl
= ctx
->thread_context
;
487 unsigned int core_mask
= SKL_DSP_CORE_MASK(core_id
);
489 dx
.core_mask
= core_mask
;
490 dx
.dx_mask
= SKL_IPC_D3_MASK
;
492 dev_dbg(ctx
->dev
, "core mask=%x dx_mask=%x\n",
493 dx
.core_mask
, dx
.dx_mask
);
495 ret
= skl_ipc_set_dx(&skl
->ipc
, BXT_INSTANCE_ID
,
496 BXT_BASE_FW_MODULE_ID
, &dx
);
499 "Failed to set DSP to D3:core id = %d;Continue reset\n",
502 * In case of D3 failure, re-download the firmware, so set
503 * fw_loaded to false.
505 skl
->fw_loaded
= false;
508 if (core_id
== SKL_DSP_CORE0_ID
) {
509 /* disable Interrupt */
510 skl_ipc_op_int_disable(ctx
);
511 skl_ipc_int_disable(ctx
);
513 ret
= skl_dsp_disable_core(ctx
, core_mask
);
515 dev_err(ctx
->dev
, "Failed to disable core %d\n", ret
);
518 skl
->cores
.state
[core_id
] = SKL_DSP_RESET
;
522 static const struct skl_dsp_fw_ops bxt_fw_ops
= {
523 .set_state_D0
= bxt_set_dsp_D0
,
524 .set_state_D3
= bxt_set_dsp_D3
,
525 .set_state_D0i3
= bxt_schedule_dsp_D0i3
,
526 .set_state_D0i0
= bxt_set_dsp_D0i0
,
527 .load_fw
= bxt_load_base_firmware
,
528 .get_fw_errcode
= bxt_get_errorcode
,
529 .load_library
= bxt_load_library
,
532 static struct sst_ops skl_ops
= {
533 .irq_handler
= skl_dsp_sst_interrupt
,
534 .write
= sst_shim32_write
,
535 .read
= sst_shim32_read
,
536 .free
= skl_dsp_free
,
539 static struct sst_dsp_device skl_dev
= {
540 .thread
= skl_dsp_irq_thread_handler
,
544 int bxt_sst_dsp_init(struct device
*dev
, void __iomem
*mmio_base
, int irq
,
545 const char *fw_name
, struct skl_dsp_loader_ops dsp_ops
,
546 struct skl_dev
**dsp
)
552 ret
= skl_sst_ctx_init(dev
, irq
, fw_name
, dsp_ops
, dsp
, &skl_dev
);
554 dev_err(dev
, "%s: no device\n", __func__
);
560 sst
->fw_ops
= bxt_fw_ops
;
561 sst
->addr
.lpe
= mmio_base
;
562 sst
->addr
.shim
= mmio_base
;
563 sst
->addr
.sram0_base
= BXT_ADSP_SRAM0_BASE
;
564 sst
->addr
.sram1_base
= BXT_ADSP_SRAM1_BASE
;
565 sst
->addr
.w0_stat_sz
= SKL_ADSP_W0_STAT_SZ
;
566 sst
->addr
.w0_up_sz
= SKL_ADSP_W0_UP_SZ
;
568 sst_dsp_mailbox_init(sst
, (BXT_ADSP_SRAM0_BASE
+ SKL_ADSP_W0_STAT_SZ
),
569 SKL_ADSP_W0_UP_SZ
, BXT_ADSP_SRAM1_BASE
, SKL_ADSP_W1_SZ
);
571 ret
= skl_ipc_init(dev
, skl
);
577 /* set the D0i3 check */
578 skl
->ipc
.ops
.check_dsp_lp_on
= skl_ipc_check_D0i0
;
580 skl
->boot_complete
= false;
581 init_waitqueue_head(&skl
->boot_wait
);
582 INIT_DELAYED_WORK(&skl
->d0i3
.work
, bxt_set_dsp_D0i3
);
583 skl
->d0i3
.state
= SKL_DSP_D0I3_NONE
;
585 return skl_dsp_acquire_irq(sst
);
587 EXPORT_SYMBOL_GPL(bxt_sst_dsp_init
);
589 int bxt_sst_init_fw(struct device
*dev
, struct skl_dev
*skl
)
592 struct sst_dsp
*sst
= skl
->dsp
;
594 ret
= sst
->fw_ops
.load_fw(sst
);
596 dev_err(dev
, "Load base fw failed: %x\n", ret
);
600 skl_dsp_init_core_state(sst
);
602 if (skl
->lib_count
> 1) {
603 ret
= sst
->fw_ops
.load_library(sst
, skl
->lib_info
,
606 dev_err(dev
, "Load Library failed : %x\n", ret
);
610 skl
->is_first_boot
= false;
614 EXPORT_SYMBOL_GPL(bxt_sst_init_fw
);
616 void bxt_sst_dsp_cleanup(struct device
*dev
, struct skl_dev
*skl
)
619 skl_release_library(skl
->lib_info
, skl
->lib_count
);
621 release_firmware(skl
->dsp
->fw
);
622 skl_freeup_uuid_list(skl
);
623 skl_ipc_free(&skl
->ipc
);
624 skl
->dsp
->ops
->free(skl
->dsp
);
626 EXPORT_SYMBOL_GPL(bxt_sst_dsp_cleanup
);
628 MODULE_LICENSE("GPL v2");
629 MODULE_DESCRIPTION("Intel Broxton IPC driver");