| // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) |
| // |
| // Copyright 2019-2025 NXP |
| // |
| // Author: Daniel Baluta <daniel.baluta@nxp.com> |
| // |
| // Hardware interface for audio DSP on i.MX8 |
| |
| #include <dt-bindings/firmware/imx/rsrc.h> |
| |
| #include <linux/arm-smccc.h> |
| #include <linux/firmware/imx/svc/misc.h> |
| #include <linux/mfd/syscon.h> |
| |
| #include "imx-common.h" |
| |
| /* imx8/imx8x macros */ |
| #define RESET_VECTOR_VADDR 0x596f8000 |
| |
| /* imx8m macros */ |
| #define IMX8M_DAP_DEBUG 0x28800000 |
| #define IMX8M_DAP_DEBUG_SIZE (64 * 1024) |
| #define IMX8M_DAP_PWRCTL (0x4000 + 0x3020) |
| #define IMX8M_PWRCTL_CORERESET BIT(16) |
| |
| #define AudioDSP_REG0 0x100 |
| #define AudioDSP_REG1 0x104 |
| #define AudioDSP_REG2 0x108 |
| #define AudioDSP_REG3 0x10c |
| |
| #define AudioDSP_REG2_RUNSTALL BIT(5) |
| |
| /* imx8ulp macros */ |
| #define FSL_SIP_HIFI_XRDC 0xc200000e |
| #define SYSCTRL0 0x8 |
| #define EXECUTE_BIT BIT(13) |
| #define RESET_BIT BIT(16) |
| #define HIFI4_CLK_BIT BIT(17) |
| #define PB_CLK_BIT BIT(18) |
| #define PLAT_CLK_BIT BIT(19) |
| #define DEBUG_LOGIC_BIT BIT(25) |
| |
| struct imx8m_chip_data { |
| void __iomem *dap; |
| struct regmap *regmap; |
| }; |
| |
| /* |
| * DSP control. |
| */ |
| static int imx8x_run(struct snd_sof_dev *sdev) |
| { |
| int ret; |
| |
| ret = imx_sc_misc_set_control(get_chip_pdata(sdev), IMX_SC_R_DSP, |
| IMX_SC_C_OFS_SEL, 1); |
| if (ret < 0) { |
| dev_err(sdev->dev, "Error system address offset source select\n"); |
| return ret; |
| } |
| |
| ret = imx_sc_misc_set_control(get_chip_pdata(sdev), IMX_SC_R_DSP, |
| IMX_SC_C_OFS_AUDIO, 0x80); |
| if (ret < 0) { |
| dev_err(sdev->dev, "Error system address offset of AUDIO\n"); |
| return ret; |
| } |
| |
| ret = imx_sc_misc_set_control(get_chip_pdata(sdev), IMX_SC_R_DSP, |
| IMX_SC_C_OFS_PERIPH, 0x5A); |
| if (ret < 0) { |
| dev_err(sdev->dev, "Error system address offset of PERIPH %d\n", |
| ret); |
| return ret; |
| } |
| |
| ret = imx_sc_misc_set_control(get_chip_pdata(sdev), IMX_SC_R_DSP, |
| IMX_SC_C_OFS_IRQ, 0x51); |
| if (ret < 0) { |
| dev_err(sdev->dev, "Error system address offset of IRQ\n"); |
| return ret; |
| } |
| |
| imx_sc_pm_cpu_start(get_chip_pdata(sdev), IMX_SC_R_DSP, true, |
| RESET_VECTOR_VADDR); |
| |
| return 0; |
| } |
| |
| static int imx8_run(struct snd_sof_dev *sdev) |
| { |
| int ret; |
| |
| ret = imx_sc_misc_set_control(get_chip_pdata(sdev), IMX_SC_R_DSP, |
| IMX_SC_C_OFS_SEL, 0); |
| if (ret < 0) { |
| dev_err(sdev->dev, "Error system address offset source select\n"); |
| return ret; |
| } |
| |
| imx_sc_pm_cpu_start(get_chip_pdata(sdev), IMX_SC_R_DSP, true, |
| RESET_VECTOR_VADDR); |
| |
| return 0; |
| } |
| |
| static int imx8_probe(struct snd_sof_dev *sdev) |
| { |
| struct imx_sc_ipc *sc_ipc_handle; |
| struct imx_common_data *common; |
| int ret; |
| |
| common = sdev->pdata->hw_pdata; |
| |
| ret = imx_scu_get_handle(&sc_ipc_handle); |
| if (ret < 0) |
| return dev_err_probe(sdev->dev, ret, |
| "failed to fetch SC IPC handle\n"); |
| |
| common->chip_pdata = sc_ipc_handle; |
| |
| return 0; |
| } |
| |
| static int imx8m_reset(struct snd_sof_dev *sdev) |
| { |
| struct imx8m_chip_data *chip; |
| u32 pwrctl; |
| |
| chip = get_chip_pdata(sdev); |
| |
| /* put DSP into reset and stall */ |
| pwrctl = readl(chip->dap + IMX8M_DAP_PWRCTL); |
| pwrctl |= IMX8M_PWRCTL_CORERESET; |
| writel(pwrctl, chip->dap + IMX8M_DAP_PWRCTL); |
| |
| /* keep reset asserted for 10 cycles */ |
| usleep_range(1, 2); |
| |
| regmap_update_bits(chip->regmap, AudioDSP_REG2, |
| AudioDSP_REG2_RUNSTALL, AudioDSP_REG2_RUNSTALL); |
| |
| /* take the DSP out of reset and keep stalled for FW loading */ |
| pwrctl = readl(chip->dap + IMX8M_DAP_PWRCTL); |
| pwrctl &= ~IMX8M_PWRCTL_CORERESET; |
| writel(pwrctl, chip->dap + IMX8M_DAP_PWRCTL); |
| |
| return 0; |
| } |
| |
| static int imx8m_run(struct snd_sof_dev *sdev) |
| { |
| struct imx8m_chip_data *chip = get_chip_pdata(sdev); |
| |
| regmap_update_bits(chip->regmap, AudioDSP_REG2, AudioDSP_REG2_RUNSTALL, 0); |
| |
| return 0; |
| } |
| |
| static int imx8m_probe(struct snd_sof_dev *sdev) |
| { |
| struct imx_common_data *common; |
| struct imx8m_chip_data *chip; |
| |
| common = sdev->pdata->hw_pdata; |
| |
| chip = devm_kzalloc(sdev->dev, sizeof(*chip), GFP_KERNEL); |
| if (!chip) |
| return dev_err_probe(sdev->dev, -ENOMEM, |
| "failed to allocate chip data\n"); |
| |
| chip->dap = devm_ioremap(sdev->dev, IMX8M_DAP_DEBUG, IMX8M_DAP_DEBUG_SIZE); |
| if (!chip->dap) |
| return dev_err_probe(sdev->dev, -ENODEV, |
| "failed to ioremap DAP\n"); |
| |
| chip->regmap = syscon_regmap_lookup_by_phandle(sdev->dev->of_node, "fsl,dsp-ctrl"); |
| if (IS_ERR(chip->regmap)) |
| return dev_err_probe(sdev->dev, PTR_ERR(chip->regmap), |
| "failed to fetch dsp ctrl regmap\n"); |
| |
| common->chip_pdata = chip; |
| |
| return 0; |
| } |
| |
| static int imx8ulp_run(struct snd_sof_dev *sdev) |
| { |
| struct regmap *regmap = get_chip_pdata(sdev); |
| |
| /* Controls the HiFi4 DSP Reset: 1 in reset, 0 out of reset */ |
| regmap_update_bits(regmap, SYSCTRL0, RESET_BIT, 0); |
| |
| /* Reset HiFi4 DSP Debug logic: 1 debug reset, 0 out of reset*/ |
| regmap_update_bits(regmap, SYSCTRL0, DEBUG_LOGIC_BIT, 0); |
| |
| /* Stall HIFI4 DSP Execution: 1 stall, 0 run */ |
| regmap_update_bits(regmap, SYSCTRL0, EXECUTE_BIT, 0); |
| |
| return 0; |
| } |
| |
| static int imx8ulp_reset(struct snd_sof_dev *sdev) |
| { |
| struct arm_smccc_res smc_res; |
| struct regmap *regmap; |
| |
| regmap = get_chip_pdata(sdev); |
| |
| /* HiFi4 Platform Clock Enable: 1 enabled, 0 disabled */ |
| regmap_update_bits(regmap, SYSCTRL0, PLAT_CLK_BIT, PLAT_CLK_BIT); |
| |
| /* HiFi4 PBCLK clock enable: 1 enabled, 0 disabled */ |
| regmap_update_bits(regmap, SYSCTRL0, PB_CLK_BIT, PB_CLK_BIT); |
| |
| /* HiFi4 Clock Enable: 1 enabled, 0 disabled */ |
| regmap_update_bits(regmap, SYSCTRL0, HIFI4_CLK_BIT, HIFI4_CLK_BIT); |
| |
| regmap_update_bits(regmap, SYSCTRL0, RESET_BIT, RESET_BIT); |
| |
| usleep_range(1, 2); |
| |
| /* Stall HIFI4 DSP Execution: 1 stall, 0 not stall */ |
| regmap_update_bits(regmap, SYSCTRL0, EXECUTE_BIT, EXECUTE_BIT); |
| usleep_range(1, 2); |
| |
| arm_smccc_smc(FSL_SIP_HIFI_XRDC, 0, 0, 0, 0, 0, 0, 0, &smc_res); |
| |
| return smc_res.a0; |
| } |
| |
| static int imx8ulp_probe(struct snd_sof_dev *sdev) |
| { |
| struct imx_common_data *common; |
| struct regmap *regmap; |
| |
| common = sdev->pdata->hw_pdata; |
| |
| regmap = syscon_regmap_lookup_by_phandle(sdev->dev->of_node, "fsl,dsp-ctrl"); |
| if (IS_ERR(regmap)) |
| return dev_err_probe(sdev->dev, PTR_ERR(regmap), |
| "failed to fetch dsp ctrl regmap\n"); |
| |
| common->chip_pdata = regmap; |
| |
| return 0; |
| } |
| |
| static struct snd_soc_dai_driver imx8_dai[] = { |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("esai0", 1, 8), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai1", 1, 32), |
| }; |
| |
| static struct snd_soc_dai_driver imx8m_dai[] = { |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai1", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai2", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai3", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai5", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai6", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai7", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY("micfil", 0, 0, 1, 8), |
| }; |
| |
| static struct snd_soc_dai_driver imx8ulp_dai[] = { |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai5", 1, 32), |
| IMX_SOF_DAI_DRV_ENTRY_BIDIR("sai6", 1, 32), |
| }; |
| |
| static struct snd_sof_dsp_ops sof_imx8_ops; |
| |
| static int imx8_ops_init(struct snd_sof_dev *sdev) |
| { |
| /* first copy from template */ |
| memcpy(&sof_imx8_ops, &sof_imx_ops, sizeof(sof_imx_ops)); |
| |
| /* then set common imx8 ops */ |
| sof_imx8_ops.dbg_dump = imx8_dump; |
| sof_imx8_ops.dsp_arch_ops = &sof_xtensa_arch_ops; |
| sof_imx8_ops.debugfs_add_region_item = |
| snd_sof_debugfs_add_region_item_iomem; |
| |
| /* ... and finally set DAI driver */ |
| sof_imx8_ops.drv = get_chip_info(sdev)->drv; |
| sof_imx8_ops.num_drv = get_chip_info(sdev)->num_drv; |
| |
| return 0; |
| } |
| |
| static const struct imx_chip_ops imx8_chip_ops = { |
| .probe = imx8_probe, |
| .core_kick = imx8_run, |
| }; |
| |
| static const struct imx_chip_ops imx8x_chip_ops = { |
| .probe = imx8_probe, |
| .core_kick = imx8x_run, |
| }; |
| |
| static const struct imx_chip_ops imx8m_chip_ops = { |
| .probe = imx8m_probe, |
| .core_kick = imx8m_run, |
| .core_reset = imx8m_reset, |
| }; |
| |
| static const struct imx_chip_ops imx8ulp_chip_ops = { |
| .probe = imx8ulp_probe, |
| .core_kick = imx8ulp_run, |
| .core_reset = imx8ulp_reset, |
| }; |
| |
| static struct imx_memory_info imx8_memory_regions[] = { |
| { .name = "iram", .reserved = false }, |
| { .name = "sram", .reserved = true }, |
| { } |
| }; |
| |
| static struct imx_memory_info imx8m_memory_regions[] = { |
| { .name = "iram", .reserved = false }, |
| { .name = "sram", .reserved = true }, |
| { } |
| }; |
| |
| static struct imx_memory_info imx8ulp_memory_regions[] = { |
| { .name = "iram", .reserved = false }, |
| { .name = "sram", .reserved = true }, |
| { } |
| }; |
| |
| static const struct imx_chip_info imx8_chip_info = { |
| .ipc_info = { |
| .has_panic_code = true, |
| .boot_mbox_offset = 0x800000, |
| .window_offset = 0x800000, |
| }, |
| .memory = imx8_memory_regions, |
| .drv = imx8_dai, |
| .num_drv = ARRAY_SIZE(imx8_dai), |
| .ops = &imx8_chip_ops, |
| }; |
| |
| static const struct imx_chip_info imx8x_chip_info = { |
| .ipc_info = { |
| .has_panic_code = true, |
| .boot_mbox_offset = 0x800000, |
| .window_offset = 0x800000, |
| }, |
| .memory = imx8_memory_regions, |
| .drv = imx8_dai, |
| .num_drv = ARRAY_SIZE(imx8_dai), |
| .ops = &imx8x_chip_ops, |
| }; |
| |
| static const struct imx_chip_info imx8m_chip_info = { |
| .ipc_info = { |
| .has_panic_code = true, |
| .boot_mbox_offset = 0x800000, |
| .window_offset = 0x800000, |
| }, |
| .memory = imx8m_memory_regions, |
| .drv = imx8m_dai, |
| .num_drv = ARRAY_SIZE(imx8m_dai), |
| .ops = &imx8m_chip_ops, |
| }; |
| |
| static const struct imx_chip_info imx8ulp_chip_info = { |
| .ipc_info = { |
| .has_panic_code = true, |
| .boot_mbox_offset = 0x800000, |
| .window_offset = 0x800000, |
| }, |
| .has_dma_reserved = true, |
| .memory = imx8ulp_memory_regions, |
| .drv = imx8ulp_dai, |
| .num_drv = ARRAY_SIZE(imx8ulp_dai), |
| .ops = &imx8ulp_chip_ops, |
| }; |
| |
| static struct snd_sof_of_mach sof_imx8_machs[] = { |
| { |
| .compatible = "fsl,imx8qxp-mek", |
| .sof_tplg_filename = "sof-imx8-wm8960.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8qxp-mek-wcpu", |
| .sof_tplg_filename = "sof-imx8-wm8962.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8qm-mek", |
| .sof_tplg_filename = "sof-imx8-wm8960.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8qm-mek-revd", |
| .sof_tplg_filename = "sof-imx8-wm8962.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8qxp-mek-bb", |
| .sof_tplg_filename = "sof-imx8-cs42888.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8qm-mek-bb", |
| .sof_tplg_filename = "sof-imx8-cs42888.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8mp-evk", |
| .sof_tplg_filename = "sof-imx8mp-wm8960.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8mp-evk-revb4", |
| .sof_tplg_filename = "sof-imx8mp-wm8962.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| { |
| .compatible = "fsl,imx8ulp-evk", |
| .sof_tplg_filename = "sof-imx8ulp-btsco.tplg", |
| .drv_name = "asoc-audio-graph-card2", |
| }, |
| {} |
| }; |
| |
| IMX_SOF_DEV_DESC(imx8, sof_imx8_machs, &imx8_chip_info, &sof_imx8_ops, imx8_ops_init); |
| IMX_SOF_DEV_DESC(imx8x, sof_imx8_machs, &imx8x_chip_info, &sof_imx8_ops, imx8_ops_init); |
| IMX_SOF_DEV_DESC(imx8m, sof_imx8_machs, &imx8m_chip_info, &sof_imx8_ops, imx8_ops_init); |
| IMX_SOF_DEV_DESC(imx8ulp, sof_imx8_machs, &imx8ulp_chip_info, &sof_imx8_ops, imx8_ops_init); |
| |
| static const struct of_device_id sof_of_imx8_ids[] = { |
| { |
| .compatible = "fsl,imx8qxp-dsp", |
| .data = &IMX_SOF_DEV_DESC_NAME(imx8x), |
| }, |
| { |
| .compatible = "fsl,imx8qm-dsp", |
| .data = &IMX_SOF_DEV_DESC_NAME(imx8), |
| }, |
| { |
| .compatible = "fsl,imx8mp-dsp", |
| .data = &IMX_SOF_DEV_DESC_NAME(imx8m), |
| }, |
| { |
| .compatible = "fsl,imx8ulp-dsp", |
| .data = &IMX_SOF_DEV_DESC_NAME(imx8ulp), |
| }, |
| { } |
| }; |
| MODULE_DEVICE_TABLE(of, sof_of_imx8_ids); |
| |
| /* DT driver definition */ |
| static struct platform_driver snd_sof_of_imx8_driver = { |
| .probe = sof_of_probe, |
| .remove = sof_of_remove, |
| .driver = { |
| .name = "sof-audio-of-imx8", |
| .pm = pm_ptr(&sof_of_pm), |
| .of_match_table = sof_of_imx8_ids, |
| }, |
| }; |
| module_platform_driver(snd_sof_of_imx8_driver); |
| |
| MODULE_LICENSE("Dual BSD/GPL"); |
| MODULE_DESCRIPTION("SOF support for IMX8 platforms"); |
| MODULE_IMPORT_NS("SND_SOC_SOF_XTENSA"); |