[linux-2.6-block.git] / drivers / soundwire / intel_init.c

// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
// Copyright(c) 2015-17 Intel Corporation.

/*
 * SDW Intel Init Routines
 *
 * Initializes and creates SDW devices based on ACPI and Hardware values
 */

#include <linux/acpi.h>
#include <linux/export.h>
#include <linux/module.h>
#include <linux/platform_device.h>
#include <linux/soundwire/sdw_intel.h>
#include "intel.h"

#define SDW_LINK_TYPE		4 /* from Intel ACPI documentation */
#define SDW_MAX_LINKS		4
#define SDW_SHIM_LCAP		0x0
#define SDW_SHIM_BASE		0x2C000
#define SDW_ALH_BASE		0x2C800
#define SDW_LINK_BASE		0x30000
#define SDW_LINK_SIZE		0x10000

struct sdw_link_data {
	struct sdw_intel_link_res res;
	struct platform_device *pdev;
};

struct sdw_intel_ctx {
	int count;
	struct sdw_link_data *links;
};

static int sdw_intel_cleanup_pdev(struct sdw_intel_ctx *ctx)
{
	struct sdw_link_data *link = ctx->links;
	int i;

	if (!link)
		return 0;

	for (i = 0; i < ctx->count; i++) {
		if (link->pdev)
			platform_device_unregister(link->pdev);
		link++;
	}

	kfree(ctx->links);
	ctx->links = NULL;

	return 0;
}

static struct sdw_intel_ctx
*sdw_intel_add_controller(struct sdw_intel_res *res)
{
	struct platform_device_info pdevinfo;
	struct platform_device *pdev;
	struct sdw_link_data *link;
	struct sdw_intel_ctx *ctx;
	struct acpi_device *adev;
	int ret, i;
	u8 count;
	u32 caps;

	if (acpi_bus_get_device(res->handle, &adev))
		return NULL;

	/* Found controller, find links supported */
	count = 0;
	ret = fwnode_property_read_u8_array(acpi_fwnode_handle(adev),
					    "mipi-sdw-master-count", &count, 1);

	/* Don't fail on error, continue and use hw value */
	if (ret) {
		dev_err(&adev->dev,
			"Failed to read mipi-sdw-master-count: %d\n", ret);
		count = SDW_MAX_LINKS;
	}

	/* Check SNDWLCAP.LCOUNT */
	caps = ioread32(res->mmio_base + SDW_SHIM_BASE + SDW_SHIM_LCAP);
	caps &= GENMASK(2, 0);

	/* Check HW supported vs property value and use min of two */
	count = min_t(u8, caps, count);

	/* Check count is within bounds */
	if (count > SDW_MAX_LINKS) {
		dev_err(&adev->dev, "Link count %d exceeds max %d\n",
			count, SDW_MAX_LINKS);
		return NULL;
	} else if (!count) {
		dev_warn(&adev->dev, "No SoundWire links detected\n");
		return NULL;
	}

	dev_dbg(&adev->dev, "Creating %d SDW Link devices\n", count);

	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
	if (!ctx)
		return NULL;

	ctx->count = count;
	ctx->links = kcalloc(ctx->count, sizeof(*ctx->links), GFP_KERNEL);
	if (!ctx->links)
		goto link_err;

	link = ctx->links;

	/* Create SDW Master devices */
	for (i = 0; i < count; i++) {
		link->res.irq = res->irq;
		link->res.registers = res->mmio_base + SDW_LINK_BASE
					+ (SDW_LINK_SIZE * i);
		link->res.shim = res->mmio_base + SDW_SHIM_BASE;
		link->res.alh = res->mmio_base + SDW_ALH_BASE;

		link->res.ops = res->ops;
		link->res.arg = res->arg;

		memset(&pdevinfo, 0, sizeof(pdevinfo));

		pdevinfo.parent = res->parent;
		pdevinfo.name = "int-sdw";
		pdevinfo.id = i;
		pdevinfo.fwnode = acpi_fwnode_handle(adev);
		pdevinfo.data = &link->res;
		pdevinfo.size_data = sizeof(link->res);

		pdev = platform_device_register_full(&pdevinfo);
		if (IS_ERR(pdev)) {
			dev_err(&adev->dev,
				"platform device creation failed: %ld\n",
				PTR_ERR(pdev));
			goto pdev_err;
		}

		link->pdev = pdev;
		link++;
	}

	return ctx;

pdev_err:
	sdw_intel_cleanup_pdev(ctx);
link_err:
	kfree(ctx);
	return NULL;
}

static acpi_status sdw_intel_acpi_cb(acpi_handle handle, u32 level,
				     void *cdata, void **return_value)
{
	struct sdw_intel_res *res = cdata;
	struct acpi_device *adev;
	acpi_status status;
	u64 adr;

	status = acpi_evaluate_integer(handle, METHOD_NAME__ADR, NULL, &adr);
	if (ACPI_FAILURE(status))
		return AE_OK; /* keep going */

	if (acpi_bus_get_device(handle, &adev)) {
		pr_err("%s: Couldn't find ACPI handle\n", __func__);
		return AE_NOT_FOUND;
	}

	res->handle = handle;

	/*
	 * On some Intel platforms, multiple children of the HDAS
	 * device can be found, but only one of them is the SoundWire
	 * controller. The SNDW device is always exposed with
	 * Name(_ADR, 0x40000000), with bits 31..28 representing the
	 * SoundWire link so filter accordingly
	 */
	if ((adr & GENMASK(31, 28)) >> 28 != SDW_LINK_TYPE)
		return AE_OK; /* keep going */

	/* device found, stop namespace walk */
	return AE_CTRL_TERMINATE;
}

/**
 * sdw_intel_init() - SoundWire Intel init routine
 * @parent_handle: ACPI parent handle
 * @res: resource data
 *
 * This scans the namespace and creates SoundWire link controller devices
 * based on the info queried.
 */
void *sdw_intel_init(acpi_handle *parent_handle, struct sdw_intel_res *res)
{
	acpi_status status;

	status = acpi_walk_namespace(ACPI_TYPE_DEVICE,
				     parent_handle, 1,
				     sdw_intel_acpi_cb,
				     NULL, res, NULL);
	if (ACPI_FAILURE(status))
		return NULL;

	return sdw_intel_add_controller(res);
}
EXPORT_SYMBOL(sdw_intel_init);

/**
 * sdw_intel_exit() - SoundWire Intel exit
 * @arg: callback context
 *
 * Delete the controller instances created and cleanup
 */
void sdw_intel_exit(void *arg)
{
	struct sdw_intel_ctx *ctx = arg;

	sdw_intel_cleanup_pdev(ctx);
	kfree(ctx);
}
EXPORT_SYMBOL(sdw_intel_exit);

MODULE_LICENSE("Dual BSD/GPL");
MODULE_DESCRIPTION("Intel Soundwire Init Library");
Commit	Line	Data
d62a7d41 VK	1	// SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause)
	2	// Copyright(c) 2015-17 Intel Corporation.
	3
	4	/*
	5	* SDW Intel Init Routines
	6	*
	7	* Initializes and creates SDW devices based on ACPI and Hardware values
	8	*/
	9
	10	#include <linux/acpi.h>
4abbd783 PG	11	#include <linux/export.h>
4abbd783 PG	12	#include <linux/module.h>
d62a7d41 VK	13	#include <linux/platform_device.h>
	14	#include <linux/soundwire/sdw_intel.h>
	15	#include "intel.h"
	16
6f11586f	17	#define SDW_LINK_TYPE 4 /* from Intel ACPI documentation */
d62a7d41 VK	18	#define SDW_MAX_LINKS 4
	19	#define SDW_SHIM_LCAP 0x0
	20	#define SDW_SHIM_BASE 0x2C000
	21	#define SDW_ALH_BASE 0x2C800
	22	#define SDW_LINK_BASE 0x30000
	23	#define SDW_LINK_SIZE 0x10000
	24
	25	struct sdw_link_data {
	26	struct sdw_intel_link_res res;
	27	struct platform_device *pdev;
	28	};
	29
	30	struct sdw_intel_ctx {
	31	int count;
	32	struct sdw_link_data *links;
	33	};
	34
	35	static int sdw_intel_cleanup_pdev(struct sdw_intel_ctx *ctx)
	36	{
	37	struct sdw_link_data *link = ctx->links;
	38	int i;
	39
	40	if (!link)
	41	return 0;
	42
	43	for (i = 0; i < ctx->count; i++) {
	44	if (link->pdev)
	45	platform_device_unregister(link->pdev);
	46	link++;
	47	}
	48
	49	kfree(ctx->links);
	50	ctx->links = NULL;
	51
	52	return 0;
	53	}
	54
	55	static struct sdw_intel_ctx
	56	sdw_intel_add_controller(struct sdw_intel_res res)
	57	{
	58	struct platform_device_info pdevinfo;
	59	struct platform_device *pdev;
	60	struct sdw_link_data *link;
	61	struct sdw_intel_ctx *ctx;
	62	struct acpi_device *adev;
	63	int ret, i;
	64	u8 count;
	65	u32 caps;
	66
	67	if (acpi_bus_get_device(res->handle, &adev))
	68	return NULL;
	69
	70	/* Found controller, find links supported */
	71	count = 0;
	72	ret = fwnode_property_read_u8_array(acpi_fwnode_handle(adev),
505ccb00	73	"mipi-sdw-master-count", &count, 1);
d62a7d41 VK	74
	75	/* Don't fail on error, continue and use hw value */
	76	if (ret) {
	77	dev_err(&adev->dev,
	78	"Failed to read mipi-sdw-master-count: %d\n", ret);
	79	count = SDW_MAX_LINKS;
	80	}
	81
	82	/* Check SNDWLCAP.LCOUNT */
	83	caps = ioread32(res->mmio_base + SDW_SHIM_BASE + SDW_SHIM_LCAP);
432732b8	84	caps &= GENMASK(2, 0);
d62a7d41 VK	85
	86	/* Check HW supported vs property value and use min of two */
	87	count = min_t(u8, caps, count);
	88
	89	/* Check count is within bounds */
	90	if (count > SDW_MAX_LINKS) {
	91	dev_err(&adev->dev, "Link count %d exceeds max %d\n",
505ccb00	92	count, SDW_MAX_LINKS);
d62a7d41	93	return NULL;
432732b8 PLB	94	} else if (!count) {
	95	dev_warn(&adev->dev, "No SoundWire links detected\n");
	96	return NULL;
d62a7d41 VK	97	}
	98
	99	dev_dbg(&adev->dev, "Creating %d SDW Link devices\n", count);
	100
	101	ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
	102	if (!ctx)
	103	return NULL;
	104
	105	ctx->count = count;
	106	ctx->links = kcalloc(ctx->count, sizeof(*ctx->links), GFP_KERNEL);
	107	if (!ctx->links)
	108	goto link_err;
	109
	110	link = ctx->links;
	111
	112	/* Create SDW Master devices */
	113	for (i = 0; i < count; i++) {
d62a7d41 VK	114	link->res.irq = res->irq;
	115	link->res.registers = res->mmio_base + SDW_LINK_BASE
	116	+ (SDW_LINK_SIZE * i);
	117	link->res.shim = res->mmio_base + SDW_SHIM_BASE;
	118	link->res.alh = res->mmio_base + SDW_ALH_BASE;
	119
c46302ec VK	120	link->res.ops = res->ops;
	121	link->res.arg = res->arg;
	122
d62a7d41 VK	123	memset(&pdevinfo, 0, sizeof(pdevinfo));
	124
	125	pdevinfo.parent = res->parent;
	126	pdevinfo.name = "int-sdw";
	127	pdevinfo.id = i;
	128	pdevinfo.fwnode = acpi_fwnode_handle(adev);
	129	pdevinfo.data = &link->res;
	130	pdevinfo.size_data = sizeof(link->res);
	131
	132	pdev = platform_device_register_full(&pdevinfo);
	133	if (IS_ERR(pdev)) {
	134	dev_err(&adev->dev,
	135	"platform device creation failed: %ld\n",
	136	PTR_ERR(pdev));
	137	goto pdev_err;
	138	}
	139
	140	link->pdev = pdev;
	141	link++;
	142	}
	143
	144	return ctx;
	145
	146	pdev_err:
	147	sdw_intel_cleanup_pdev(ctx);
	148	link_err:
	149	kfree(ctx);
	150	return NULL;
	151	}
	152
	153	static acpi_status sdw_intel_acpi_cb(acpi_handle handle, u32 level,
505ccb00	154	void cdata, void *return_value)
d62a7d41 VK	155	{
	156	struct sdw_intel_res *res = cdata;
	157	struct acpi_device *adev;
6f11586f PLB	158	acpi_status status;
	159	u64 adr;
	160
	161	status = acpi_evaluate_integer(handle, METHOD_NAME__ADR, NULL, &adr);
	162	if (ACPI_FAILURE(status))
	163	return AE_OK; /* keep going */
d62a7d41 VK	164
d62a7d41 VK	165	if (acpi_bus_get_device(handle, &adev)) {
e1c815f4	166	pr_err("%s: Couldn't find ACPI handle\n", __func__);
d62a7d41 VK	167	return AE_NOT_FOUND;
	168	}
	169
	170	res->handle = handle;
6f11586f PLB	171
	172	/*
	173	* On some Intel platforms, multiple children of the HDAS
	174	* device can be found, but only one of them is the SoundWire
	175	* controller. The SNDW device is always exposed with
	176	* Name(_ADR, 0x40000000), with bits 31..28 representing the
	177	* SoundWire link so filter accordingly
	178	*/
	179	if ((adr & GENMASK(31, 28)) >> 28 != SDW_LINK_TYPE)
	180	return AE_OK; /* keep going */
	181
	182	/* device found, stop namespace walk */
	183	return AE_CTRL_TERMINATE;
d62a7d41 VK	184	}
	185
	186	/**
	187	* sdw_intel_init() - SoundWire Intel init routine
	188	* @parent_handle: ACPI parent handle
	189	* @res: resource data
	190	*
	191	* This scans the namespace and creates SoundWire link controller devices
	192	* based on the info queried.
	193	*/
	194	void sdw_intel_init(acpi_handle parent_handle, struct sdw_intel_res *res)
	195	{
	196	acpi_status status;
	197
	198	status = acpi_walk_namespace(ACPI_TYPE_DEVICE,
505ccb00 PLB	199	parent_handle, 1,
	200	sdw_intel_acpi_cb,
	201	NULL, res, NULL);
d62a7d41 VK	202	if (ACPI_FAILURE(status))
	203	return NULL;
	204
	205	return sdw_intel_add_controller(res);
	206	}
	207	EXPORT_SYMBOL(sdw_intel_init);
	208
	209	/**
	210	* sdw_intel_exit() - SoundWire Intel exit
	211	* @arg: callback context
	212	*
	213	* Delete the controller instances created and cleanup
	214	*/
	215	void sdw_intel_exit(void *arg)
	216	{
	217	struct sdw_intel_ctx *ctx = arg;
	218
	219	sdw_intel_cleanup_pdev(ctx);
	220	kfree(ctx);
	221	}
	222	EXPORT_SYMBOL(sdw_intel_exit);
	223
	224	MODULE_LICENSE("Dual BSD/GPL");
	225	MODULE_DESCRIPTION("Intel Soundwire Init Library");