Skip to content

Firmware debugging fixes and updates.#1208

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
plbossart merged 4 commits into from
Sep 16, 2019
Merged

Firmware debugging fixes and updates. #1208

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef697a5
ASoC: SOF: core: make debug module params and state global.
lrgirdwo Sep 16, 2019
cc356f3
ASoC: SOF: Intel: initialise and verify FW crash dump data.
lrgirdwo Sep 8, 2019
2c1ae1c
ASoC: SOF: ipc: retain DSP context after FW exception.
lrgirdwo Sep 12, 2019
724701f
ASoC: SOF: intel: Add context data to any IPC timeout.
lrgirdwo Sep 12, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions sound/soc/sof/Kconfig
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -158,6 +158,14 @@ config SND_SOC_SOF_DEBUG_IPC_FLOOD_TEST
Say Y if you want to enable IPC flood test.
If unsure, select "N".

config SND_SOC_SOF_DEBUG_RETAIN_DSP_CONTEXT
bool "SOF retain DSP context on any FW exceptions"
help
This option keeps the DSP in D0 state so that firmware debug
information can be retained and dumped to userspace.
Say Y if you want to retain DSP context for FW exceptions.
If unsure, select "N".

endif ## SND_SOC_SOF_DEBUG

endif ## SND_SOC_SOF_OPTIONS
Expand Down
7 changes: 3 additions & 4 deletions sound/soc/sof/core.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -16,12 +16,11 @@
#include "sof-priv.h"
#include "ops.h"

static int sof_core_debug;
/* see SOF_DBG_ flags */
int sof_core_debug;
module_param_named(sof_debug, sof_core_debug, int, 0444);
MODULE_PARM_DESC(sof_debug, "SOF core debug options (0x0 all off)");

#define SOF_CORE_ENABLE_TRACE BIT(0)

/* SOF defaults if not provided by the platform in ms */
#define TIMEOUT_DEFAULT_IPC_MS 500
#define TIMEOUT_DEFAULT_BOOT_MS 2000
Expand DownExpand Up@@ -357,7 +356,7 @@ static int sof_probe_continue(struct snd_sof_dev *sdev)
}

if (IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_FIRMWARE_TRACE) ||
(sof_core_debug & SOF_CORE_ENABLE_TRACE)) {
(sof_core_debug & SOF_DBG_ENABLE_TRACE)) {
sdev->dtrace_is_supported = true;

/* init DMA trace */
Expand Down
16 changes: 16 additions & 0 deletions sound/soc/sof/debug.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -461,3 +461,19 @@ void snd_sof_free_debug(struct snd_sof_dev *sdev)
debugfs_remove_recursive(sdev->debugfs_root);
}
EXPORT_SYMBOL_GPL(snd_sof_free_debug);

void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev)
{
if (IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_RETAIN_DSP_CONTEXT) ||
(sof_core_debug & SOF_DBG_RETAIN_CTX)) {
/* should we prevent DSP entering D3 ? */
dev_info(sdev->dev, "info: preventing DSP entering D3 state to preserve context\n");
pm_runtime_get_noresume(sdev->dev);
}

/* dump vital information to the logs */
snd_sof_dsp_dbg_dump(sdev, SOF_DBG_REGS | SOF_DBG_MBOX);
snd_sof_ipc_dump(sdev);
snd_sof_trace_notify_for_error(sdev);
Comment thread
lgirdwood marked this conversation as resolved.
}
EXPORT_SYMBOL(snd_sof_handle_fw_exception);
29 changes: 28 additions & 1 deletion sound/soc/sof/intel/bdw.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -37,6 +37,7 @@
#define MBOX_SIZE 0x1000
#define MBOX_DUMP_SIZE 0x30
#define EXCEPT_OFFSET 0x800
#define EXCEPT_MAX_HDR_SIZE 0x400

/* DSP peripherals */
#define DMAC0_OFFSET 0xFE000
Expand DownExpand Up@@ -228,6 +229,11 @@ static void bdw_get_registers(struct snd_sof_dev *sdev,
/* note: variable AR register array is not read */

/* then get panic info */
if (xoops->arch_hdr.totalsize > EXCEPT_MAX_HDR_SIZE) {
dev_err(sdev->dev, "invalid header size 0x%x. FW oops is bogus\n",
xoops->arch_hdr.totalsize);
return;
}
offset += xoops->arch_hdr.totalsize;
sof_mailbox_read(sdev, offset, panic_info, sizeof(*panic_info));

Expand All@@ -241,7 +247,7 @@ static void bdw_dump(struct snd_sof_dev *sdev, u32 flags)
struct sof_ipc_dsp_oops_xtensa xoops;
struct sof_ipc_panic_info panic_info;
u32 stack[BDW_STACK_DUMP_SIZE];
u32 status, panic;
u32 status, panic, imrx, imrd;

/* now try generic SOF status messages */
status = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IPCD);
Expand All@@ -250,6 +256,26 @@ static void bdw_dump(struct snd_sof_dev *sdev, u32 flags)
BDW_STACK_DUMP_SIZE);
snd_sof_get_status(sdev, status, panic, &xoops, &panic_info, stack,
BDW_STACK_DUMP_SIZE);

/* provide some context for firmware debug */
imrx = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IMRX);
imrd = snd_sof_dsp_read(sdev, BDW_DSP_BAR, SHIM_IMRD);
dev_err(sdev->dev,
"error: ipc host -> DSP: pending %s complete %s raw 0x%8.8x\n",
panic & SHIM_IPCX_BUSY ? "yes" : "no",
panic & SHIM_IPCX_DONE ? "yes" : "no", panic);
dev_err(sdev->dev,
"error: mask host: pending %s complete %s raw 0x%8.8x\n",
imrx & SHIM_IMRX_BUSY ? "yes" : "no",
imrx & SHIM_IMRX_DONE ? "yes" : "no", imrx);
dev_err(sdev->dev,
"error: ipc DSP -> host: pending %s complete %s raw 0x%8.8x\n",
status & SHIM_IPCD_BUSY ? "yes" : "no",
status & SHIM_IPCD_DONE ? "yes" : "no", status);
dev_err(sdev->dev,
"error: mask DSP: pending %s complete %s raw 0x%8.8x\n",
imrd & SHIM_IMRD_BUSY ? "yes" : "no",
imrd & SHIM_IMRD_DONE ? "yes" : "no", imrd);
}

/*
Expand DownExpand Up@@ -451,6 +477,7 @@ static int bdw_probe(struct snd_sof_dev *sdev)
/* TODO: add offsets */
sdev->mmio_bar = BDW_DSP_BAR;
sdev->mailbox_bar = BDW_DSP_BAR;
sdev->dsp_oops_offset = MBOX_OFFSET;
Comment thread
plbossart marked this conversation as resolved.

/* PCI base */
mmio = platform_get_resource(pdev, IORESOURCE_MEM,
Expand Down
29 changes: 28 additions & 1 deletion sound/soc/sof/intel/byt.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,6 +28,7 @@
#define MBOX_OFFSET 0x144000
#define MBOX_SIZE 0x1000
#define EXCEPT_OFFSET 0x800
#define EXCEPT_MAX_HDR_SIZE 0x400

/* DSP peripherals */
#define DMAC0_OFFSET 0x098000
Expand DownExpand Up@@ -126,6 +127,11 @@ static void byt_get_registers(struct snd_sof_dev *sdev,
/* note: variable AR register array is not read */

/* then get panic info */
if (xoops->arch_hdr.totalsize > EXCEPT_MAX_HDR_SIZE) {
dev_err(sdev->dev, "invalid header size 0x%x. FW oops is bogus\n",
xoops->arch_hdr.totalsize);
return;
}
offset += xoops->arch_hdr.totalsize;
sof_mailbox_read(sdev, offset, panic_info, sizeof(*panic_info));

Expand All@@ -139,7 +145,7 @@ static void byt_dump(struct snd_sof_dev *sdev, u32 flags)
struct sof_ipc_dsp_oops_xtensa xoops;
struct sof_ipc_panic_info panic_info;
u32 stack[BYT_STACK_DUMP_SIZE];
u32 status, panic;
u32 status, panic, imrd, imrx;

/* now try generic SOF status messages */
status = snd_sof_dsp_read(sdev, BYT_DSP_BAR, SHIM_IPCD);
Expand All@@ -148,6 +154,27 @@ static void byt_dump(struct snd_sof_dev *sdev, u32 flags)
BYT_STACK_DUMP_SIZE);
snd_sof_get_status(sdev, status, panic, &xoops, &panic_info, stack,
BYT_STACK_DUMP_SIZE);

/* provide some context for firmware debug */
imrx = snd_sof_dsp_read(sdev, BYT_DSP_BAR, SHIM_IMRX);
imrd = snd_sof_dsp_read(sdev, BYT_DSP_BAR, SHIM_IMRD);
dev_err(sdev->dev,
"error: ipc host -> DSP: pending %s complete %s raw 0x%8.8x\n",
panic & SHIM_IPCX_BUSY ? "yes" : "no",
panic & SHIM_IPCX_DONE ? "yes" : "no", panic);
dev_err(sdev->dev,
"error: mask host: pending %s complete %s raw 0x%8.8x\n",
imrx & SHIM_IMRX_BUSY ? "yes" : "no",
imrx & SHIM_IMRX_DONE ? "yes" : "no", imrx);
dev_err(sdev->dev,
"error: ipc DSP -> host: pending %s complete %s raw 0x%8.8x\n",
status & SHIM_IPCD_BUSY ? "yes" : "no",
status & SHIM_IPCD_DONE ? "yes" : "no", status);
dev_err(sdev->dev,
"error: mask DSP: pending %s complete %s raw 0x%8.8x\n",
imrd & SHIM_IMRD_BUSY ? "yes" : "no",
imrd & SHIM_IMRD_DONE ? "yes" : "no", imrd);

}

/*
Expand Down
7 changes: 7 additions & 0 deletions sound/soc/sof/intel/hda.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -35,6 +35,8 @@
#define IS_CFL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0xa348)
#define IS_CNL(pci) ((pci)->vendor == 0x8086 && (pci)->device == 0x9dc8)

#define EXCEPT_MAX_HDR_SIZE 0x400

/*
* Debug
*/
Expand DownExpand Up@@ -131,6 +133,11 @@ static void hda_dsp_get_registers(struct snd_sof_dev *sdev,
/* note: variable AR register array is not read */

/* then get panic info */
if (xoops->arch_hdr.totalsize > EXCEPT_MAX_HDR_SIZE) {
dev_err(sdev->dev, "invalid header size 0x%x. FW oops is bogus\n",
xoops->arch_hdr.totalsize);
return;
}
offset += xoops->arch_hdr.totalsize;
sof_block_read(sdev, sdev->mmio_bar, offset,
panic_info, sizeof(*panic_info));
Expand Down
4 changes: 1 addition & 3 deletions sound/soc/sof/ipc.c
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -210,9 +210,7 @@ static int tx_wait_done(struct snd_sof_ipc *ipc, struct snd_sof_ipc_msg *msg,
if (ret == 0) {
dev_err(sdev->dev, "error: ipc timed out for 0x%x size %d\n",
hdr->cmd, hdr->size);
snd_sof_dsp_dbg_dump(ipc->sdev, SOF_DBG_REGS | SOF_DBG_MBOX);
snd_sof_ipc_dump(ipc->sdev);
snd_sof_trace_notify_for_error(ipc->sdev);
snd_sof_handle_fw_exception(ipc->sdev);
ret = -ETIMEDOUT;
} else {
/* copy the data returned from DSP */
Expand Down
14 changes: 10 additions & 4 deletions sound/soc/sof/sof-priv.h
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,10 +28,15 @@
#include <uapi/sound/sof/fw.h>

/* debug flags */
#define SOF_DBG_REGS BIT(1)
#define SOF_DBG_MBOX BIT(2)
#define SOF_DBG_TEXT BIT(3)
#define SOF_DBG_PCI BIT(4)
#define SOF_DBG_ENABLE_TRACE BIT(0)
#define SOF_DBG_REGS BIT(1)
#define SOF_DBG_MBOX BIT(2)
#define SOF_DBG_TEXT BIT(3)
#define SOF_DBG_PCI BIT(4)
#define SOF_DBG_RETAIN_CTX BIT(5) /* prevent DSP D3 on FW exception */

/* global debug state set by SOF_DBG_ flags */
extern int sof_core_debug;

/* max BARs mmaped devices can use */
#define SND_SOF_BARS 8
Expand DownExpand Up@@ -576,6 +581,7 @@ void snd_sof_get_status(struct snd_sof_dev *sdev, u32 panic_code,
struct sof_ipc_panic_info *panic_info,
void *stack, size_t stack_words);
int snd_sof_init_trace_ipc(struct snd_sof_dev *sdev);
void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev);

/*
* Platform specific ops.
Expand Down