blob: 081dcd7afe8c34eedf36db534998f72f3087d649 [file] [log] [blame]
// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
/*
* This file is provided under a dual BSD/GPLv2 license. When using or
* redistributing this file, you may do so under either license.
*
* Copyright(c) 2017 Intel Corporation. All rights reserved.
*
* Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
* Ranjani Sridharan <ranjani.sridharan@linux.intel.com>
* Jeeja KP <jeeja.kp@intel.com>
* Rander Wang <rander.wang@intel.com>
* Keyon Jie <yang.jie@linux.intel.com>
*/
/*
* Hardware interface for HDA DSP code loader
*/
#include <linux/delay.h>
#include <linux/fs.h>
#include <linux/slab.h>
#include <linux/device.h>
#include <linux/interrupt.h>
#include <linux/module.h>
#include <linux/dma-mapping.h>
#include <linux/firmware.h>
#include <linux/pci.h>
#include <sound/hdaudio_ext.h>
#include <sound/sof.h>
#include <sound/pcm_params.h>
#include <linux/pm_runtime.h>
#include "../sof-priv.h"
#include "../ops.h"
#include "hda.h"
#define HDA_FW_BOOT_ATTEMPTS 3
static int cl_stream_prepare(struct snd_sof_dev *sdev, unsigned int format,
unsigned int size, struct snd_dma_buffer *dmab,
int direction)
{
struct hdac_ext_stream *stream = NULL;
struct hdac_stream *hstream;
struct pci_dev *pci = sdev->pci;
int ret;
if (direction == SNDRV_PCM_STREAM_PLAYBACK) {
stream = hda_dsp_stream_get_pstream(sdev);
} else {
dev_err(sdev->dev, "error: code loading DMA is playback only\n");
return -EINVAL;
}
if (!stream) {
dev_err(sdev->dev, "error: no stream available\n");
return -ENODEV;
}
hstream = &stream->hstream;
/* allocate DMA buffer */
ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV_SG, &pci->dev, size, dmab);
if (ret < 0) {
dev_err(sdev->dev, "error: memory alloc failed: %x\n", ret);
goto error;
}
hstream->format_val = format;
hstream->bufsize = size;
ret = hda_dsp_stream_hw_params(sdev, stream, dmab, NULL);
if (ret < 0) {
dev_err(sdev->dev, "error: hdac prepare failed: %x\n", ret);
goto error;
}
hda_dsp_stream_spib_config(sdev, stream, HDA_DSP_SPIB_ENABLE, size);
return hstream->stream_tag;
error:
hda_dsp_stream_put_pstream(sdev, hstream->stream_tag);
snd_dma_free_pages(dmab);
return ret;
}
/*
* first boot sequence has some extra steps. core 0 waits for power
* status on core 1, so power up core 1 also momentarily, keep it in
* reset/stall and then turn it off
*/
static int cl_dsp_init(struct snd_sof_dev *sdev, const void *fwdata,
u32 fwsize)
{
int tag, ret, i;
u32 hipcie;
const struct sof_intel_dsp_desc *chip = sdev->hda->desc;
/* prepare DMA for code loader stream */
tag = cl_stream_prepare(sdev, 0x40, fwsize, &sdev->dmab,
SNDRV_PCM_STREAM_PLAYBACK);
if (tag <= 0) {
dev_err(sdev->dev, "error: dma prepare for fw loading err: %x\n",
tag);
return tag;
}
memcpy(sdev->dmab.area, fwdata, fwsize);
/* step 1: power up corex */
ret = hda_dsp_core_power_up(sdev, chip->cores_mask);
if (ret < 0) {
dev_err(sdev->dev, "error: dsp core 0/1 power up failed\n");
goto err;
}
/* step 2: purge FW request */
snd_sof_dsp_write(sdev, HDA_DSP_BAR, chip->ipc_req,
chip->ipc_req_mask | (HDA_DSP_IPC_PURGE_FW |
((tag - 1) << 9)));
/* step 3: unset core 0 reset state & unstall/run core 0 */
ret = hda_dsp_core_run(sdev, HDA_DSP_CORE_MASK(0));
if (ret < 0) {
dev_err(sdev->dev, "error: dsp core start failed %d\n", ret);
ret = -EIO;
goto err;
}
/* step 4: wait for IPC DONE bit from ROM */
for (i = HDA_DSP_INIT_TIMEOUT; i > 0; i--) {
hipcie = snd_sof_dsp_read(sdev, HDA_DSP_BAR,
chip->ipc_ack);
if (hipcie & chip->ipc_ack_mask) {
snd_sof_dsp_update_bits(sdev, HDA_DSP_BAR,
chip->ipc_ack,
chip->ipc_ack_mask,
chip->ipc_ack_mask);
goto step5;
}
mdelay(1);
}
dev_err(sdev->dev, "error: waiting for HIPCIE done, reg: 0x%x\n",
hipcie);
goto err;
step5:
/* step 5: power down corex */
ret = hda_dsp_core_power_down(sdev,
chip->cores_mask & ~(HDA_DSP_CORE_MASK(0)));
if (ret < 0) {
dev_err(sdev->dev, "error: dsp core x power down failed\n");
goto err;
}
/* step 6: enable interrupt */
snd_sof_dsp_update_bits(sdev, HDA_DSP_BAR, HDA_DSP_REG_ADSPIC,
HDA_DSP_ADSPIC_IPC, HDA_DSP_ADSPIC_IPC);
/* enable IPC DONE interrupt */
snd_sof_dsp_update_bits(sdev, HDA_DSP_BAR, chip->ipc_ctl,
HDA_DSP_REG_HIPCCTL_DONE,
HDA_DSP_REG_HIPCCTL_DONE);
/* enable IPC BUSY interrupt */
snd_sof_dsp_update_bits(sdev, HDA_DSP_BAR, chip->ipc_ctl,
HDA_DSP_REG_HIPCCTL_BUSY,
HDA_DSP_REG_HIPCCTL_BUSY);
/* step 7: wait for ROM init */
ret = snd_sof_dsp_register_poll(sdev, HDA_DSP_BAR,
HDA_DSP_SRAM_REG_ROM_STATUS,
HDA_DSP_ROM_STS_MASK, HDA_DSP_ROM_INIT,
HDA_DSP_INIT_TIMEOUT);
if (ret >= 0)
goto out;
ret = -EIO;
err:
hda_dsp_dump(sdev, SOF_DBG_REGS | SOF_DBG_PCI | SOF_DBG_MBOX);
//sdev->dsp_ops.cleanup(sdev->dev, &sdev->dmab, tag);
hda_dsp_core_reset_power_down(sdev, HDA_DSP_CORE_MASK(0) |
HDA_DSP_CORE_MASK(1));
return ret;
out:
return tag;
}
static int cl_trigger(struct snd_sof_dev *sdev,
struct hdac_ext_stream *stream, int cmd)
{
struct hdac_stream *hstream = &stream->hstream;
int sd_offset = SOF_STREAM_SD_OFFSET(hstream);
/* code loader is special case that reuses stream ops */
switch (cmd) {
case SNDRV_PCM_TRIGGER_START:
wait_event_timeout(sdev->waitq, !sdev->code_loading,
HDA_DSP_CL_TRIGGER_TIMEOUT);
snd_sof_dsp_update_bits(sdev, HDA_DSP_HDA_BAR, SOF_HDA_INTCTL,
1 << hstream->index,
1 << hstream->index);
snd_sof_dsp_update_bits(sdev, HDA_DSP_HDA_BAR,
sd_offset,
SOF_HDA_SD_CTL_DMA_START |
SOF_HDA_CL_DMA_SD_INT_MASK,
SOF_HDA_SD_CTL_DMA_START |
SOF_HDA_CL_DMA_SD_INT_MASK);
hstream->running = true;
return 0;
default:
return hda_dsp_stream_trigger(sdev, stream, cmd);
}
}
static int cl_cleanup(struct snd_sof_dev *sdev, struct snd_dma_buffer *dmab,
struct hdac_ext_stream *stream)
{
struct hdac_stream *hstream = &stream->hstream;
int sd_offset = SOF_STREAM_SD_OFFSET(hstream);
int ret;
ret = hda_dsp_stream_spib_config(sdev, stream, HDA_DSP_SPIB_DISABLE, 0);
/* TODO: spin lock ?*/
hstream->opened = 0;
hstream->running = 0;
hstream->substream = NULL;
/* reset BDL address */
snd_sof_dsp_write(sdev, HDA_DSP_HDA_BAR,
sd_offset + SOF_HDA_ADSP_REG_CL_SD_BDLPL, 0);
snd_sof_dsp_write(sdev, HDA_DSP_HDA_BAR,
sd_offset + SOF_HDA_ADSP_REG_CL_SD_BDLPU, 0);
snd_sof_dsp_write(sdev, HDA_DSP_HDA_BAR, sd_offset, 0);
snd_dma_free_pages(dmab);
dmab->area = NULL;
hstream->bufsize = 0;
hstream->format_val = 0;
return ret;
}
static int cl_copy_fw(struct snd_sof_dev *sdev, int tag)
{
struct hdac_bus *bus = sof_to_bus(sdev);
struct hdac_ext_stream *stream = NULL;
struct hdac_stream *s;
int ret, status;
/* get stream with tag */
list_for_each_entry(s, &bus->stream_list, list) {
if (s->direction == SNDRV_PCM_STREAM_PLAYBACK
&& s->stream_tag == tag) {
stream = stream_to_hdac_ext_stream(s);
break;
}
}
if (!stream) {
dev_err(sdev->dev,
"error: could not get stream with stream tag%d\n",
tag);
return -ENODEV;
}
ret = cl_trigger(sdev, stream, SNDRV_PCM_TRIGGER_START);
if (ret < 0) {
dev_err(sdev->dev, "error: DMA trigger start failed\n");
return ret;
}
status = snd_sof_dsp_register_poll(sdev, HDA_DSP_BAR,
HDA_DSP_SRAM_REG_ROM_STATUS,
HDA_DSP_ROM_STS_MASK,
HDA_DSP_ROM_FW_ENTERED,
HDA_DSP_BASEFW_TIMEOUT);
ret = cl_trigger(sdev, stream, SNDRV_PCM_TRIGGER_STOP);
if (ret < 0) {
dev_err(sdev->dev, "error: DMA trigger stop failed\n");
return ret;
}
ret = cl_cleanup(sdev, &sdev->dmab, stream);
if (ret < 0) {
dev_err(sdev->dev, "error: Code loader DSP cleanup failed\n");
return ret;
}
return status;
}
int hda_dsp_cl_load_fw(struct snd_sof_dev *sdev, bool first_boot)
{
struct snd_sof_pdata *plat_data = dev_get_platdata(sdev->dev);
/* set code loading condition to true */
sdev->code_loading = 1;
return request_firmware(&plat_data->fw,
plat_data->machine->sof_fw_filename, sdev->dev);
}
int hda_dsp_cl_boot_firmware(struct snd_sof_dev *sdev)
{
struct snd_sof_pdata *plat_data = dev_get_platdata(sdev->dev);
struct firmware stripped_firmware;
int ret, tag, i;
stripped_firmware.data = plat_data->fw->data;
stripped_firmware.size = plat_data->fw->size;
/* init for booting wait */
init_waitqueue_head(&sdev->boot_wait);
sdev->boot_complete = false;
/* try attempting fw boot a few times before giving up */
for (i = 0; i < HDA_FW_BOOT_ATTEMPTS; i++) {
tag = cl_dsp_init(sdev, stripped_firmware.data,
stripped_firmware.size);
if (tag <= 0) {
dev_err(sdev->dev, "Error code=0x%x: FW status=0x%x\n",
snd_sof_dsp_read(sdev, HDA_DSP_BAR,
HDA_DSP_SRAM_REG_ROM_ERROR),
snd_sof_dsp_read(sdev, HDA_DSP_BAR,
HDA_DSP_SRAM_REG_ROM_STATUS));
dev_err(sdev->dev, "iteration %d of Core En/ROM load fail:%d\n",
i, tag);
ret = tag;
continue;
}
/* at this point DSP ROM has been initialized and
* should be ready for code loading and firmware boot
*/
ret = cl_copy_fw(sdev, tag);
if (ret < 0) {
dev_err(sdev->dev, "error: iteration %d of load fw failed err: %d\n",
i, ret);
hda_dsp_core_reset_power_down(sdev, HDA_DSP_CORE_MASK(0) |
HDA_DSP_CORE_MASK(1));
continue;
}
dev_dbg(sdev->dev, "Firmware download successful, booting...\n");
return ret;
}
hda_dsp_dump(sdev, SOF_DBG_REGS | SOF_DBG_PCI | SOF_DBG_MBOX);
/* disable DSP */
snd_sof_dsp_update_bits(sdev, HDA_DSP_PP_BAR, SOF_HDA_REG_PP_PPCTL,
SOF_HDA_PPCTL_GPROCEN, 0);
dev_err(sdev->dev, "error: load fw failed after %d attempts with err: %d\n",
HDA_FW_BOOT_ATTEMPTS, ret);
return ret;
}