[mirror_ubuntu-bionic-kernel.git] / sound / soc / intel / common / sst-acpi.c

/*
 * Intel SST loader on ACPI systems
 *
 * Copyright (C) 2013, Intel Corporation. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License version
 * 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 */

#include <linux/acpi.h>
#include <linux/device.h>
#include <linux/firmware.h>
#include <linux/module.h>
#include <linux/platform_device.h>

#include "sst-dsp.h"
#include <sound/soc-acpi.h>

#define SST_LPT_DSP_DMA_ADDR_OFFSET	0x0F0000
#define SST_WPT_DSP_DMA_ADDR_OFFSET	0x0FE000
#define SST_LPT_DSP_DMA_SIZE		(1024 - 1)

/* Descriptor for setting up SST platform data */
struct sst_acpi_desc {
	const char *drv_name;
	struct snd_soc_acpi_mach *machines;
	/* Platform resource indexes. Must set to -1 if not used */
	int resindex_lpe_base;
	int resindex_pcicfg_base;
	int resindex_fw_base;
	int irqindex_host_ipc;
	int resindex_dma_base;
	/* Unique number identifying the SST core on platform */
	int sst_id;
	/* DMA only valid when resindex_dma_base != -1*/
	int dma_engine;
	int dma_size;
};

struct sst_acpi_priv {
	struct platform_device *pdev_mach;
	struct platform_device *pdev_pcm;
	struct sst_pdata sst_pdata;
	struct sst_acpi_desc *desc;
	struct snd_soc_acpi_mach *mach;
};

static void sst_acpi_fw_cb(const struct firmware *fw, void *context)
{
	struct platform_device *pdev = context;
	struct device *dev = &pdev->dev;
	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
	struct sst_acpi_desc *desc = sst_acpi->desc;
	struct snd_soc_acpi_mach *mach = sst_acpi->mach;

	sst_pdata->fw = fw;
	if (!fw) {
		dev_err(dev, "Cannot load firmware %s\n", mach->fw_filename);
		return;
	}

	/* register PCM and DAI driver */
	sst_acpi->pdev_pcm =
		platform_device_register_data(dev, desc->drv_name, -1,
					      sst_pdata, sizeof(*sst_pdata));
	if (IS_ERR(sst_acpi->pdev_pcm)) {
		dev_err(dev, "Cannot register device %s. Error %d\n",
			desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
	}

	return;
}

static int sst_acpi_probe(struct platform_device *pdev)
{
	const struct acpi_device_id *id;
	struct device *dev = &pdev->dev;
	struct sst_acpi_priv *sst_acpi;
	struct sst_pdata *sst_pdata;
	struct snd_soc_acpi_mach *mach;
	struct sst_acpi_desc *desc;
	struct resource *mmio;
	int ret = 0;

	sst_acpi = devm_kzalloc(dev, sizeof(*sst_acpi), GFP_KERNEL);
	if (sst_acpi == NULL)
		return -ENOMEM;

	id = acpi_match_device(dev->driver->acpi_match_table, dev);
	if (!id)
		return -ENODEV;

	desc = (struct sst_acpi_desc *)id->driver_data;
	mach = snd_soc_acpi_find_machine(desc->machines);
	if (mach == NULL) {
		dev_err(dev, "No matching ASoC machine driver found\n");
		return -ENODEV;
	}

	sst_pdata = &sst_acpi->sst_pdata;
	sst_pdata->id = desc->sst_id;
	sst_pdata->dma_dev = dev;
	sst_acpi->desc = desc;
	sst_acpi->mach = mach;

	sst_pdata->resindex_dma_base = desc->resindex_dma_base;
	if (desc->resindex_dma_base >= 0) {
		sst_pdata->dma_engine = desc->dma_engine;
		sst_pdata->dma_base = desc->resindex_dma_base;
		sst_pdata->dma_size = desc->dma_size;
	}

	if (desc->irqindex_host_ipc >= 0)
		sst_pdata->irq = platform_get_irq(pdev, desc->irqindex_host_ipc);

	if (desc->resindex_lpe_base >= 0) {
		mmio = platform_get_resource(pdev, IORESOURCE_MEM,
					     desc->resindex_lpe_base);
		if (mmio) {
			sst_pdata->lpe_base = mmio->start;
			sst_pdata->lpe_size = resource_size(mmio);
		}
	}

	if (desc->resindex_pcicfg_base >= 0) {
		mmio = platform_get_resource(pdev, IORESOURCE_MEM,
					     desc->resindex_pcicfg_base);
		if (mmio) {
			sst_pdata->pcicfg_base = mmio->start;
			sst_pdata->pcicfg_size = resource_size(mmio);
		}
	}

	if (desc->resindex_fw_base >= 0) {
		mmio = platform_get_resource(pdev, IORESOURCE_MEM,
					     desc->resindex_fw_base);
		if (mmio) {
			sst_pdata->fw_base = mmio->start;
			sst_pdata->fw_size = resource_size(mmio);
		}
	}

	platform_set_drvdata(pdev, sst_acpi);

	/* register machine driver */
	sst_acpi->pdev_mach =
		platform_device_register_data(dev, mach->drv_name, -1,
					      sst_pdata, sizeof(*sst_pdata));
	if (IS_ERR(sst_acpi->pdev_mach))
		return PTR_ERR(sst_acpi->pdev_mach);

	/* continue SST probing after firmware is loaded */
	ret = request_firmware_nowait(THIS_MODULE, true, mach->fw_filename,
				      dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);
	if (ret)
		platform_device_unregister(sst_acpi->pdev_mach);

	return ret;
}

static int sst_acpi_remove(struct platform_device *pdev)
{
	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;

	platform_device_unregister(sst_acpi->pdev_mach);
	if (!IS_ERR_OR_NULL(sst_acpi->pdev_pcm))
		platform_device_unregister(sst_acpi->pdev_pcm);
	release_firmware(sst_pdata->fw);

	return 0;
}

static struct snd_soc_acpi_mach haswell_machines[] = {
	{
		.id = "INT33CA",
		.drv_name = "haswell-audio",
		.fw_filename = "intel/IntcSST1.bin",
	},
	{}
};

static struct sst_acpi_desc sst_acpi_haswell_desc = {
	.drv_name = "haswell-pcm-audio",
	.machines = haswell_machines,
	.resindex_lpe_base = 0,
	.resindex_pcicfg_base = 1,
	.resindex_fw_base = -1,
	.irqindex_host_ipc = 0,
	.sst_id = SST_DEV_ID_LYNX_POINT,
	.dma_engine = SST_DMA_TYPE_DW,
	.resindex_dma_base = SST_LPT_DSP_DMA_ADDR_OFFSET,
	.dma_size = SST_LPT_DSP_DMA_SIZE,
};

static struct snd_soc_acpi_mach broadwell_machines[] = {
	{
		.id = "INT343A",
		.drv_name = "broadwell-audio",
		.fw_filename =  "intel/IntcSST2.bin",
	},
	{
		.id = "RT5677CE",
		.drv_name = "bdw-rt5677",
		.fw_filename =  "intel/IntcSST2.bin",
	},
	{}
};

static struct sst_acpi_desc sst_acpi_broadwell_desc = {
	.drv_name = "haswell-pcm-audio",
	.machines = broadwell_machines,
	.resindex_lpe_base = 0,
	.resindex_pcicfg_base = 1,
	.resindex_fw_base = -1,
	.irqindex_host_ipc = 0,
	.sst_id = SST_DEV_ID_WILDCAT_POINT,
	.dma_engine = SST_DMA_TYPE_DW,
	.resindex_dma_base = SST_WPT_DSP_DMA_ADDR_OFFSET,
	.dma_size = SST_LPT_DSP_DMA_SIZE,
};

#if !IS_ENABLED(CONFIG_SND_SST_IPC_ACPI)
static struct snd_soc_acpi_mach baytrail_machines[] = {
	{
		.id = "10EC5640",
		.drv_name = "byt-rt5640",
		.fw_filename = "intel/fw_sst_0f28.bin-48kHz_i2s_master",
	},
	{
		.id = "193C9890",
		.drv_name = "byt-max98090",
		.fw_filename = "intel/fw_sst_0f28.bin-48kHz_i2s_master",
	},
	{}
};

static struct sst_acpi_desc sst_acpi_baytrail_desc = {
	.drv_name = "baytrail-pcm-audio",
	.machines = baytrail_machines,
	.resindex_lpe_base = 0,
	.resindex_pcicfg_base = 1,
	.resindex_fw_base = 2,
	.irqindex_host_ipc = 5,
	.sst_id = SST_DEV_ID_BYT,
	.resindex_dma_base = -1,
};
#endif

static const struct acpi_device_id sst_acpi_match[] = {
	{ "INT33C8", (unsigned long)&sst_acpi_haswell_desc },
	{ "INT3438", (unsigned long)&sst_acpi_broadwell_desc },
#if !IS_ENABLED(CONFIG_SND_SST_IPC_ACPI)
	{ "80860F28", (unsigned long)&sst_acpi_baytrail_desc },
#endif
	{ }
};
MODULE_DEVICE_TABLE(acpi, sst_acpi_match);

static struct platform_driver sst_acpi_driver = {
	.probe = sst_acpi_probe,
	.remove = sst_acpi_remove,
	.driver = {
		.name = "sst-acpi",
		.acpi_match_table = ACPI_PTR(sst_acpi_match),
	},
};
module_platform_driver(sst_acpi_driver);

MODULE_AUTHOR("Jarkko Nikula <jarkko.nikula@linux.intel.com>");
MODULE_DESCRIPTION("Intel SST loader on ACPI systems");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
a4b12990 MB	1	/*
	2	* Intel SST loader on ACPI systems
	3	*
	4	* Copyright (C) 2013, Intel Corporation. All rights reserved.
	5	*
	6	* This program is free software; you can redistribute it and/or
	7	* modify it under the terms of the GNU General Public License version
	8	* 2 as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope that it will be useful,
	11	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	12	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	13	* GNU General Public License for more details.
	14	*
	15	*/
	16
	17	#include <linux/acpi.h>
	18	#include <linux/device.h>
	19	#include <linux/firmware.h>
	20	#include <linux/module.h>
	21	#include <linux/platform_device.h>
	22
	23	#include "sst-dsp.h"
7feb2f78	24	#include <sound/soc-acpi.h>
a4b12990 MB	25
	26	#define SST_LPT_DSP_DMA_ADDR_OFFSET 0x0F0000
	27	#define SST_WPT_DSP_DMA_ADDR_OFFSET 0x0FE000
	28	#define SST_LPT_DSP_DMA_SIZE (1024 - 1)
	29
a4b12990 MB	30	/* Descriptor for setting up SST platform data */
	31	struct sst_acpi_desc {
	32	const char *drv_name;
7feb2f78	33	struct snd_soc_acpi_mach *machines;
a4b12990 MB	34	/* Platform resource indexes. Must set to -1 if not used */
	35	int resindex_lpe_base;
	36	int resindex_pcicfg_base;
	37	int resindex_fw_base;
	38	int irqindex_host_ipc;
	39	int resindex_dma_base;
	40	/* Unique number identifying the SST core on platform */
	41	int sst_id;
	42	/* DMA only valid when resindex_dma_base != -1*/
	43	int dma_engine;
	44	int dma_size;
	45	};
	46
	47	struct sst_acpi_priv {
	48	struct platform_device *pdev_mach;
	49	struct platform_device *pdev_pcm;
	50	struct sst_pdata sst_pdata;
	51	struct sst_acpi_desc *desc;
7feb2f78	52	struct snd_soc_acpi_mach *mach;
a4b12990 MB	53	};
	54
	55	static void sst_acpi_fw_cb(const struct firmware fw, void context)
	56	{
	57	struct platform_device *pdev = context;
	58	struct device *dev = &pdev->dev;
	59	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
	60	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
	61	struct sst_acpi_desc *desc = sst_acpi->desc;
7feb2f78	62	struct snd_soc_acpi_mach *mach = sst_acpi->mach;
a4b12990 MB	63
	64	sst_pdata->fw = fw;
	65	if (!fw) {
	66	dev_err(dev, "Cannot load firmware %s\n", mach->fw_filename);
	67	return;
	68	}
	69
	70	/* register PCM and DAI driver */
	71	sst_acpi->pdev_pcm =
	72	platform_device_register_data(dev, desc->drv_name, -1,
	73	sst_pdata, sizeof(*sst_pdata));
	74	if (IS_ERR(sst_acpi->pdev_pcm)) {
	75	dev_err(dev, "Cannot register device %s. Error %d\n",
	76	desc->drv_name, (int)PTR_ERR(sst_acpi->pdev_pcm));
	77	}
	78
	79	return;
	80	}
	81
a4b12990 MB	82	static int sst_acpi_probe(struct platform_device *pdev)
	83	{
	84	const struct acpi_device_id *id;
	85	struct device *dev = &pdev->dev;
	86	struct sst_acpi_priv *sst_acpi;
	87	struct sst_pdata *sst_pdata;
7feb2f78	88	struct snd_soc_acpi_mach *mach;
a4b12990 MB	89	struct sst_acpi_desc *desc;
	90	struct resource *mmio;
	91	int ret = 0;
	92
	93	sst_acpi = devm_kzalloc(dev, sizeof(*sst_acpi), GFP_KERNEL);
	94	if (sst_acpi == NULL)
	95	return -ENOMEM;
	96
	97	id = acpi_match_device(dev->driver->acpi_match_table, dev);
	98	if (!id)
	99	return -ENODEV;
	100
	101	desc = (struct sst_acpi_desc *)id->driver_data;
7feb2f78	102	mach = snd_soc_acpi_find_machine(desc->machines);
a4b12990 MB	103	if (mach == NULL) {
	104	dev_err(dev, "No matching ASoC machine driver found\n");
	105	return -ENODEV;
	106	}
	107
	108	sst_pdata = &sst_acpi->sst_pdata;
	109	sst_pdata->id = desc->sst_id;
10df3509	110	sst_pdata->dma_dev = dev;
a4b12990 MB	111	sst_acpi->desc = desc;
	112	sst_acpi->mach = mach;
	113
6212755e	114	sst_pdata->resindex_dma_base = desc->resindex_dma_base;
a4b12990 MB	115	if (desc->resindex_dma_base >= 0) {
	116	sst_pdata->dma_engine = desc->dma_engine;
	117	sst_pdata->dma_base = desc->resindex_dma_base;
	118	sst_pdata->dma_size = desc->dma_size;
	119	}
	120
	121	if (desc->irqindex_host_ipc >= 0)
	122	sst_pdata->irq = platform_get_irq(pdev, desc->irqindex_host_ipc);
	123
	124	if (desc->resindex_lpe_base >= 0) {
	125	mmio = platform_get_resource(pdev, IORESOURCE_MEM,
	126	desc->resindex_lpe_base);
	127	if (mmio) {
	128	sst_pdata->lpe_base = mmio->start;
	129	sst_pdata->lpe_size = resource_size(mmio);
	130	}
	131	}
	132
	133	if (desc->resindex_pcicfg_base >= 0) {
	134	mmio = platform_get_resource(pdev, IORESOURCE_MEM,
	135	desc->resindex_pcicfg_base);
	136	if (mmio) {
	137	sst_pdata->pcicfg_base = mmio->start;
	138	sst_pdata->pcicfg_size = resource_size(mmio);
	139	}
	140	}
	141
	142	if (desc->resindex_fw_base >= 0) {
	143	mmio = platform_get_resource(pdev, IORESOURCE_MEM,
	144	desc->resindex_fw_base);
	145	if (mmio) {
	146	sst_pdata->fw_base = mmio->start;
	147	sst_pdata->fw_size = resource_size(mmio);
	148	}
	149	}
	150
	151	platform_set_drvdata(pdev, sst_acpi);
	152
	153	/* register machine driver */
	154	sst_acpi->pdev_mach =
	155	platform_device_register_data(dev, mach->drv_name, -1,
	156	sst_pdata, sizeof(*sst_pdata));
	157	if (IS_ERR(sst_acpi->pdev_mach))
	158	return PTR_ERR(sst_acpi->pdev_mach);
	159
	160	/* continue SST probing after firmware is loaded */
	161	ret = request_firmware_nowait(THIS_MODULE, true, mach->fw_filename,
	162	dev, GFP_KERNEL, pdev, sst_acpi_fw_cb);
	163	if (ret)
	164	platform_device_unregister(sst_acpi->pdev_mach);
	165
	166	return ret;
	167	}
	168
	169	static int sst_acpi_remove(struct platform_device *pdev)
	170	{
	171	struct sst_acpi_priv *sst_acpi = platform_get_drvdata(pdev);
	172	struct sst_pdata *sst_pdata = &sst_acpi->sst_pdata;
	173
	174	platform_device_unregister(sst_acpi->pdev_mach);
	175	if (!IS_ERR_OR_NULL(sst_acpi->pdev_pcm))
	176	platform_device_unregister(sst_acpi->pdev_pcm);
	177	release_firmware(sst_pdata->fw);
	178
179	return 0;
180	}
181
7feb2f78	182	static struct snd_soc_acpi_mach haswell_machines[] = {
928c8a8f PLB	183	{
	184	.id = "INT33CA",
	185	.drv_name = "haswell-audio",
	186	.fw_filename = "intel/IntcSST1.bin",
	187	},
a4b12990 MB	188	{}
	189	};
	190
	191	static struct sst_acpi_desc sst_acpi_haswell_desc = {
	192	.drv_name = "haswell-pcm-audio",
	193	.machines = haswell_machines,
	194	.resindex_lpe_base = 0,
	195	.resindex_pcicfg_base = 1,
	196	.resindex_fw_base = -1,
	197	.irqindex_host_ipc = 0,
	198	.sst_id = SST_DEV_ID_LYNX_POINT,
	199	.dma_engine = SST_DMA_TYPE_DW,
	200	.resindex_dma_base = SST_LPT_DSP_DMA_ADDR_OFFSET,
	201	.dma_size = SST_LPT_DSP_DMA_SIZE,
	202	};
	203
7feb2f78	204	static struct snd_soc_acpi_mach broadwell_machines[] = {
928c8a8f PLB	205	{
	206	.id = "INT343A",
	207	.drv_name = "broadwell-audio",
	208	.fw_filename = "intel/IntcSST2.bin",
	209	},
	210	{
	211	.id = "RT5677CE",
	212	.drv_name = "bdw-rt5677",
	213	.fw_filename = "intel/IntcSST2.bin",
	214	},
a4b12990 MB	215	{}
	216	};
	217
	218	static struct sst_acpi_desc sst_acpi_broadwell_desc = {
	219	.drv_name = "haswell-pcm-audio",
	220	.machines = broadwell_machines,
	221	.resindex_lpe_base = 0,
	222	.resindex_pcicfg_base = 1,
	223	.resindex_fw_base = -1,
	224	.irqindex_host_ipc = 0,
	225	.sst_id = SST_DEV_ID_WILDCAT_POINT,
	226	.dma_engine = SST_DMA_TYPE_DW,
	227	.resindex_dma_base = SST_WPT_DSP_DMA_ADDR_OFFSET,
	228	.dma_size = SST_LPT_DSP_DMA_SIZE,
	229	};
	230
cfffcc66	231	#if !IS_ENABLED(CONFIG_SND_SST_IPC_ACPI)
7feb2f78	232	static struct snd_soc_acpi_mach baytrail_machines[] = {
928c8a8f PLB	233	{
	234	.id = "10EC5640",
	235	.drv_name = "byt-rt5640",
	236	.fw_filename = "intel/fw_sst_0f28.bin-48kHz_i2s_master",
	237	},
	238	{
	239	.id = "193C9890",
	240	.drv_name = "byt-max98090",
	241	.fw_filename = "intel/fw_sst_0f28.bin-48kHz_i2s_master",
	242	},
a4b12990 MB	243	{}
	244	};
	245
	246	static struct sst_acpi_desc sst_acpi_baytrail_desc = {
	247	.drv_name = "baytrail-pcm-audio",
	248	.machines = baytrail_machines,
	249	.resindex_lpe_base = 0,
	250	.resindex_pcicfg_base = 1,
	251	.resindex_fw_base = 2,
	252	.irqindex_host_ipc = 5,
	253	.sst_id = SST_DEV_ID_BYT,
	254	.resindex_dma_base = -1,
	255	};
cfffcc66	256	#endif
a4b12990	257
e85dae70	258	static const struct acpi_device_id sst_acpi_match[] = {
a4b12990 MB	259	{ "INT33C8", (unsigned long)&sst_acpi_haswell_desc },
a4b12990 MB	260	{ "INT3438", (unsigned long)&sst_acpi_broadwell_desc },
cfffcc66	261	#if !IS_ENABLED(CONFIG_SND_SST_IPC_ACPI)
a4b12990	262	{ "80860F28", (unsigned long)&sst_acpi_baytrail_desc },
cfffcc66	263	#endif
a4b12990 MB	264	{ }
	265	};
	266	MODULE_DEVICE_TABLE(acpi, sst_acpi_match);
	267
	268	static struct platform_driver sst_acpi_driver = {
	269	.probe = sst_acpi_probe,
	270	.remove = sst_acpi_remove,
	271	.driver = {
	272	.name = "sst-acpi",
a4b12990 MB	273	.acpi_match_table = ACPI_PTR(sst_acpi_match),
	274	},
	275	};
	276	module_platform_driver(sst_acpi_driver);
	277
	278	MODULE_AUTHOR("Jarkko Nikula <jarkko.nikula@linux.intel.com>");
	279	MODULE_DESCRIPTION("Intel SST loader on ACPI systems");
	280	MODULE_LICENSE("GPL v2");