[mirror_ubuntu-bionic-kernel.git] / drivers / mfd / intel_quark_i2c_gpio.c

/*
 * Intel Quark MFD PCI driver for I2C & GPIO
 *
 * Copyright(c) 2014 Intel Corporation.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms and conditions of the GNU General Public License,
 * version 2, as published by the Free Software Foundation.
 *
 * This program is distributed in the hope 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.
 *
 * Intel Quark PCI device for I2C and GPIO controller sharing the same
 * PCI function. This PCI driver will split the 2 devices into their
 * respective drivers.
 */

#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/pci.h>
#include <linux/mfd/core.h>
#include <linux/clkdev.h>
#include <linux/clk-provider.h>
#include <linux/dmi.h>
#include <linux/platform_data/gpio-dwapb.h>
#include <linux/platform_data/i2c-designware.h>

/* PCI BAR for register base address */
#define MFD_I2C_BAR		0
#define MFD_GPIO_BAR		1

/* ACPI _ADR value to match the child node */
#define MFD_ACPI_MATCH_GPIO	0ULL
#define MFD_ACPI_MATCH_I2C	1ULL

/* The base GPIO number under GPIOLIB framework */
#define INTEL_QUARK_MFD_GPIO_BASE	8

/* The default number of South-Cluster GPIO on Quark. */
#define INTEL_QUARK_MFD_NGPIO		8

/* The DesignWare GPIO ports on Quark. */
#define INTEL_QUARK_GPIO_NPORTS	1

#define INTEL_QUARK_IORES_MEM	0
#define INTEL_QUARK_IORES_IRQ	1

#define INTEL_QUARK_I2C_CONTROLLER_CLK "i2c_designware.0"

/* The Quark I2C controller source clock */
#define INTEL_QUARK_I2C_CLK_HZ	33000000

struct intel_quark_mfd {
	struct device		*dev;
	struct clk		*i2c_clk;
	struct clk_lookup	*i2c_clk_lookup;
};

static const struct dmi_system_id dmi_platform_info[] = {
	{
		.matches = {
			DMI_EXACT_MATCH(DMI_BOARD_NAME, "Galileo"),
		},
		.driver_data = (void *)100000,
	},
	{
		.matches = {
			DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
		},
		.driver_data = (void *)400000,
	},
	{
		.matches = {
			DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
			DMI_EXACT_MATCH(DMI_BOARD_ASSET_TAG,
					"6ES7647-0AA00-0YA2"),
		},
		.driver_data = (void *)400000,
	},
	{
		.matches = {
			DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
			DMI_EXACT_MATCH(DMI_BOARD_ASSET_TAG,
					"6ES7647-0AA00-1YA2"),
		},
		.driver_data = (void *)400000,
	},
	{}
};

static struct resource intel_quark_i2c_res[] = {
	[INTEL_QUARK_IORES_MEM] = {
		.flags = IORESOURCE_MEM,
	},
	[INTEL_QUARK_IORES_IRQ] = {
		.flags = IORESOURCE_IRQ,
	},
};

static struct mfd_cell_acpi_match intel_quark_acpi_match_i2c = {
	.adr = MFD_ACPI_MATCH_I2C,
};

static struct resource intel_quark_gpio_res[] = {
	[INTEL_QUARK_IORES_MEM] = {
		.flags = IORESOURCE_MEM,
	},
};

static struct mfd_cell_acpi_match intel_quark_acpi_match_gpio = {
	.adr = MFD_ACPI_MATCH_GPIO,
};

static struct mfd_cell intel_quark_mfd_cells[] = {
	{
		.id = MFD_GPIO_BAR,
		.name = "gpio-dwapb",
		.acpi_match = &intel_quark_acpi_match_gpio,
		.num_resources = ARRAY_SIZE(intel_quark_gpio_res),
		.resources = intel_quark_gpio_res,
		.ignore_resource_conflicts = true,
	},
	{
		.id = MFD_I2C_BAR,
		.name = "i2c_designware",
		.acpi_match = &intel_quark_acpi_match_i2c,
		.num_resources = ARRAY_SIZE(intel_quark_i2c_res),
		.resources = intel_quark_i2c_res,
		.ignore_resource_conflicts = true,
	},
};

static const struct pci_device_id intel_quark_mfd_ids[] = {
	{ PCI_VDEVICE(INTEL, 0x0934), },
	{},
};
MODULE_DEVICE_TABLE(pci, intel_quark_mfd_ids);

static int intel_quark_register_i2c_clk(struct device *dev)
{
	struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);
	struct clk *i2c_clk;

	i2c_clk = clk_register_fixed_rate(dev,
					  INTEL_QUARK_I2C_CONTROLLER_CLK, NULL,
					  0, INTEL_QUARK_I2C_CLK_HZ);
	if (IS_ERR(i2c_clk))
		return PTR_ERR(i2c_clk);

	quark_mfd->i2c_clk = i2c_clk;
	quark_mfd->i2c_clk_lookup = clkdev_create(i2c_clk, NULL,
						INTEL_QUARK_I2C_CONTROLLER_CLK);

	if (!quark_mfd->i2c_clk_lookup) {
		clk_unregister(quark_mfd->i2c_clk);
		dev_err(dev, "Fixed clk register failed\n");
		return -ENOMEM;
	}

	return 0;
}

static void intel_quark_unregister_i2c_clk(struct device *dev)
{
	struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);

	if (!quark_mfd->i2c_clk_lookup)
		return;

	clkdev_drop(quark_mfd->i2c_clk_lookup);
	clk_unregister(quark_mfd->i2c_clk);
}

static int intel_quark_i2c_setup(struct pci_dev *pdev, struct mfd_cell *cell)
{
	const struct dmi_system_id *dmi_id;
	struct dw_i2c_platform_data *pdata;
	struct resource *res = (struct resource *)cell->resources;
	struct device *dev = &pdev->dev;

	res[INTEL_QUARK_IORES_MEM].start =
		pci_resource_start(pdev, MFD_I2C_BAR);
	res[INTEL_QUARK_IORES_MEM].end =
		pci_resource_end(pdev, MFD_I2C_BAR);

	res[INTEL_QUARK_IORES_IRQ].start = pdev->irq;
	res[INTEL_QUARK_IORES_IRQ].end = pdev->irq;

	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	if (!pdata)
		return -ENOMEM;

	/* Normal mode by default */
	pdata->i2c_scl_freq = 100000;

	dmi_id = dmi_first_match(dmi_platform_info);
	if (dmi_id)
		pdata->i2c_scl_freq = (uintptr_t)dmi_id->driver_data;

	cell->platform_data = pdata;
	cell->pdata_size = sizeof(*pdata);

	return 0;
}

static int intel_quark_gpio_setup(struct pci_dev *pdev, struct mfd_cell *cell)
{
	struct dwapb_platform_data *pdata;
	struct resource *res = (struct resource *)cell->resources;
	struct device *dev = &pdev->dev;

	res[INTEL_QUARK_IORES_MEM].start =
		pci_resource_start(pdev, MFD_GPIO_BAR);
	res[INTEL_QUARK_IORES_MEM].end =
		pci_resource_end(pdev, MFD_GPIO_BAR);

	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	if (!pdata)
		return -ENOMEM;

	/* For intel quark x1000, it has only one port: portA */
	pdata->nports = INTEL_QUARK_GPIO_NPORTS;
	pdata->properties = devm_kcalloc(dev, pdata->nports,
					 sizeof(*pdata->properties),
					 GFP_KERNEL);
	if (!pdata->properties)
		return -ENOMEM;

	/* Set the properties for portA */
	pdata->properties->fwnode	= NULL;
	pdata->properties->idx		= 0;
	pdata->properties->ngpio	= INTEL_QUARK_MFD_NGPIO;
	pdata->properties->gpio_base	= INTEL_QUARK_MFD_GPIO_BASE;
	pdata->properties->irq		= pdev->irq;
	pdata->properties->irq_shared	= true;

	cell->platform_data = pdata;
	cell->pdata_size = sizeof(*pdata);

	return 0;
}

static int intel_quark_mfd_probe(struct pci_dev *pdev,
				 const struct pci_device_id *id)
{
	struct intel_quark_mfd *quark_mfd;
	int ret;

	ret = pcim_enable_device(pdev);
	if (ret)
		return ret;

	quark_mfd = devm_kzalloc(&pdev->dev, sizeof(*quark_mfd), GFP_KERNEL);
	if (!quark_mfd)
		return -ENOMEM;

	quark_mfd->dev = &pdev->dev;
	dev_set_drvdata(&pdev->dev, quark_mfd);

	ret = intel_quark_register_i2c_clk(&pdev->dev);
	if (ret)
		return ret;

	ret = intel_quark_i2c_setup(pdev, &intel_quark_mfd_cells[1]);
	if (ret)
		goto err_unregister_i2c_clk;

	ret = intel_quark_gpio_setup(pdev, &intel_quark_mfd_cells[0]);
	if (ret)
		goto err_unregister_i2c_clk;

	ret = mfd_add_devices(&pdev->dev, 0, intel_quark_mfd_cells,
			      ARRAY_SIZE(intel_quark_mfd_cells), NULL, 0,
			      NULL);
	if (ret)
		goto err_unregister_i2c_clk;

	return 0;

err_unregister_i2c_clk:
	intel_quark_unregister_i2c_clk(&pdev->dev);
	return ret;
}

static void intel_quark_mfd_remove(struct pci_dev *pdev)
{
	intel_quark_unregister_i2c_clk(&pdev->dev);
	mfd_remove_devices(&pdev->dev);
}

static struct pci_driver intel_quark_mfd_driver = {
	.name		= "intel_quark_mfd_i2c_gpio",
	.id_table	= intel_quark_mfd_ids,
	.probe		= intel_quark_mfd_probe,
	.remove		= intel_quark_mfd_remove,
};

module_pci_driver(intel_quark_mfd_driver);

MODULE_AUTHOR("Raymond Tan <raymond.tan@intel.com>");
MODULE_DESCRIPTION("Intel Quark MFD PCI driver for I2C & GPIO");
MODULE_LICENSE("GPL v2");
Commit	Line	Data
60ae5b9f RT	1	/*
	2	* Intel Quark MFD PCI driver for I2C & GPIO
	3	*
	4	* Copyright(c) 2014 Intel Corporation.
	5	*
	6	* This program is free software; you can redistribute it and/or modify it
	7	* under the terms and conditions of the GNU General Public License,
	8	* version 2, as published by the Free Software Foundation.
	9	*
	10	* This program is distributed in the hope it will be useful, but WITHOUT
	11	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
	12	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
	13	* more details.
	14	*
	15	* Intel Quark PCI device for I2C and GPIO controller sharing the same
	16	* PCI function. This PCI driver will split the 2 devices into their
	17	* respective drivers.
	18	*/
	19
	20	#include <linux/kernel.h>
	21	#include <linux/module.h>
	22	#include <linux/pci.h>
	23	#include <linux/mfd/core.h>
	24	#include <linux/clkdev.h>
	25	#include <linux/clk-provider.h>
	26	#include <linux/dmi.h>
	27	#include <linux/platform_data/gpio-dwapb.h>
	28	#include <linux/platform_data/i2c-designware.h>
	29
	30	/* PCI BAR for register base address */
	31	#define MFD_I2C_BAR 0
	32	#define MFD_GPIO_BAR 1
	33
918fe70c AS	34	/* ACPI _ADR value to match the child node */
	35	#define MFD_ACPI_MATCH_GPIO 0ULL
	36	#define MFD_ACPI_MATCH_I2C 1ULL
	37
60ae5b9f RT	38	/* The base GPIO number under GPIOLIB framework */
	39	#define INTEL_QUARK_MFD_GPIO_BASE 8
	40
	41	/* The default number of South-Cluster GPIO on Quark. */
	42	#define INTEL_QUARK_MFD_NGPIO 8
	43
	44	/* The DesignWare GPIO ports on Quark. */
	45	#define INTEL_QUARK_GPIO_NPORTS 1
	46
	47	#define INTEL_QUARK_IORES_MEM 0
	48	#define INTEL_QUARK_IORES_IRQ 1
	49
	50	#define INTEL_QUARK_I2C_CONTROLLER_CLK "i2c_designware.0"
	51
	52	/* The Quark I2C controller source clock */
	53	#define INTEL_QUARK_I2C_CLK_HZ 33000000
	54
60ae5b9f	55	struct intel_quark_mfd {
9caac886	56	struct device *dev;
60ae5b9f RT	57	struct clk *i2c_clk;
	58	struct clk_lookup *i2c_clk_lookup;
	59	};
	60
b518d4ad	61	static const struct dmi_system_id dmi_platform_info[] = {
60ae5b9f	62	{
b518d4ad JK	63	.matches = {
	64	DMI_EXACT_MATCH(DMI_BOARD_NAME, "Galileo"),
	65	},
	66	.driver_data = (void *)100000,
60ae5b9f RT	67	},
60ae5b9f RT	68	{
b518d4ad JK	69	.matches = {
	70	DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
	71	},
	72	.driver_data = (void *)400000,
60ae5b9f	73	},
842086d2 JK	74	{
	75	.matches = {
	76	DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
	77	DMI_EXACT_MATCH(DMI_BOARD_ASSET_TAG,
	78	"6ES7647-0AA00-0YA2"),
	79	},
	80	.driver_data = (void *)400000,
	81	},
	82	{
	83	.matches = {
	84	DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
	85	DMI_EXACT_MATCH(DMI_BOARD_ASSET_TAG,
	86	"6ES7647-0AA00-1YA2"),
	87	},
	88	.driver_data = (void *)400000,
	89	},
bafc1fac	90	{}
60ae5b9f RT	91	};
	92
	93	static struct resource intel_quark_i2c_res[] = {
	94	[INTEL_QUARK_IORES_MEM] = {
	95	.flags = IORESOURCE_MEM,
	96	},
	97	[INTEL_QUARK_IORES_IRQ] = {
	98	.flags = IORESOURCE_IRQ,
	99	},
	100	};
	101
918fe70c AS	102	static struct mfd_cell_acpi_match intel_quark_acpi_match_i2c = {
	103	.adr = MFD_ACPI_MATCH_I2C,
	104	};
	105
60ae5b9f RT	106	static struct resource intel_quark_gpio_res[] = {
	107	[INTEL_QUARK_IORES_MEM] = {
	108	.flags = IORESOURCE_MEM,
	109	},
	110	};
	111
918fe70c AS	112	static struct mfd_cell_acpi_match intel_quark_acpi_match_gpio = {
	113	.adr = MFD_ACPI_MATCH_GPIO,
	114	};
	115
60ae5b9f	116	static struct mfd_cell intel_quark_mfd_cells[] = {
60ae5b9f RT	117	{
	118	.id = MFD_GPIO_BAR,
	119	.name = "gpio-dwapb",
918fe70c	120	.acpi_match = &intel_quark_acpi_match_gpio,
60ae5b9f RT	121	.num_resources = ARRAY_SIZE(intel_quark_gpio_res),
	122	.resources = intel_quark_gpio_res,
	123	.ignore_resource_conflicts = true,
	124	},
236fd469 AS	125	{
	126	.id = MFD_I2C_BAR,
	127	.name = "i2c_designware",
918fe70c	128	.acpi_match = &intel_quark_acpi_match_i2c,
236fd469 AS	129	.num_resources = ARRAY_SIZE(intel_quark_i2c_res),
	130	.resources = intel_quark_i2c_res,
	131	.ignore_resource_conflicts = true,
	132	},
60ae5b9f RT	133	};
	134
	135	static const struct pci_device_id intel_quark_mfd_ids[] = {
	136	{ PCI_VDEVICE(INTEL, 0x0934), },
	137	{},
	138	};
	139	MODULE_DEVICE_TABLE(pci, intel_quark_mfd_ids);
	140
9caac886	141	static int intel_quark_register_i2c_clk(struct device *dev)
60ae5b9f	142	{
9caac886	143	struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);
60ae5b9f	144	struct clk *i2c_clk;
60ae5b9f	145
9caac886	146	i2c_clk = clk_register_fixed_rate(dev,
60ae5b9f	147	INTEL_QUARK_I2C_CONTROLLER_CLK, NULL,
36a0c088	148	0, INTEL_QUARK_I2C_CLK_HZ);
c4726abc SB	149	if (IS_ERR(i2c_clk))
c4726abc SB	150	return PTR_ERR(i2c_clk);
60ae5b9f	151
60ae5b9f	152	quark_mfd->i2c_clk = i2c_clk;
c4726abc SB	153	quark_mfd->i2c_clk_lookup = clkdev_create(i2c_clk, NULL,
c4726abc SB	154	INTEL_QUARK_I2C_CONTROLLER_CLK);
60ae5b9f	155
c4726abc	156	if (!quark_mfd->i2c_clk_lookup) {
7f0c5ae1	157	clk_unregister(quark_mfd->i2c_clk);
9caac886	158	dev_err(dev, "Fixed clk register failed\n");
c4726abc SB	159	return -ENOMEM;
c4726abc SB	160	}
60ae5b9f	161
c4726abc	162	return 0;
60ae5b9f RT	163	}
60ae5b9f RT	164
9caac886	165	static void intel_quark_unregister_i2c_clk(struct device *dev)
60ae5b9f	166	{
9caac886	167	struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);
60ae5b9f	168
7f0c5ae1	169	if (!quark_mfd->i2c_clk_lookup)
60ae5b9f RT	170	return;
	171
	172	clkdev_drop(quark_mfd->i2c_clk_lookup);
	173	clk_unregister(quark_mfd->i2c_clk);
	174	}
	175
	176	static int intel_quark_i2c_setup(struct pci_dev pdev, struct mfd_cell cell)
	177	{
b518d4ad	178	const struct dmi_system_id *dmi_id;
60ae5b9f RT	179	struct dw_i2c_platform_data *pdata;
	180	struct resource res = (struct resource )cell->resources;
	181	struct device *dev = &pdev->dev;
60ae5b9f RT	182
	183	res[INTEL_QUARK_IORES_MEM].start =
	184	pci_resource_start(pdev, MFD_I2C_BAR);
	185	res[INTEL_QUARK_IORES_MEM].end =
	186	pci_resource_end(pdev, MFD_I2C_BAR);
	187
	188	res[INTEL_QUARK_IORES_IRQ].start = pdev->irq;
	189	res[INTEL_QUARK_IORES_IRQ].end = pdev->irq;
	190
	191	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	192	if (!pdata)
	193	return -ENOMEM;
	194
bafc1fac AS	195	/* Normal mode by default */
	196	pdata->i2c_scl_freq = 100000;
	197
b518d4ad JK	198	dmi_id = dmi_first_match(dmi_platform_info);
	199	if (dmi_id)
	200	pdata->i2c_scl_freq = (uintptr_t)dmi_id->driver_data;
60ae5b9f RT	201
	202	cell->platform_data = pdata;
	203	cell->pdata_size = sizeof(*pdata);
	204
	205	return 0;
	206	}
	207
	208	static int intel_quark_gpio_setup(struct pci_dev pdev, struct mfd_cell cell)
	209	{
	210	struct dwapb_platform_data *pdata;
	211	struct resource res = (struct resource )cell->resources;
	212	struct device *dev = &pdev->dev;
	213
	214	res[INTEL_QUARK_IORES_MEM].start =
	215	pci_resource_start(pdev, MFD_GPIO_BAR);
	216	res[INTEL_QUARK_IORES_MEM].end =
	217	pci_resource_end(pdev, MFD_GPIO_BAR);
	218
	219	pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
	220	if (!pdata)
	221	return -ENOMEM;
	222
	223	/* For intel quark x1000, it has only one port: portA */
	224	pdata->nports = INTEL_QUARK_GPIO_NPORTS;
	225	pdata->properties = devm_kcalloc(dev, pdata->nports,
	226	sizeof(*pdata->properties),
	227	GFP_KERNEL);
	228	if (!pdata->properties)
	229	return -ENOMEM;
	230
	231	/* Set the properties for portA */
4ba8cfa7	232	pdata->properties->fwnode = NULL;
60ae5b9f RT	233	pdata->properties->idx = 0;
	234	pdata->properties->ngpio = INTEL_QUARK_MFD_NGPIO;
	235	pdata->properties->gpio_base = INTEL_QUARK_MFD_GPIO_BASE;
	236	pdata->properties->irq = pdev->irq;
	237	pdata->properties->irq_shared = true;
	238
	239	cell->platform_data = pdata;
	240	cell->pdata_size = sizeof(*pdata);
	241
	242	return 0;
	243	}
	244
	245	static int intel_quark_mfd_probe(struct pci_dev *pdev,
	246	const struct pci_device_id *id)
	247	{
	248	struct intel_quark_mfd *quark_mfd;
	249	int ret;
	250
	251	ret = pcim_enable_device(pdev);
	252	if (ret)
	253	return ret;
	254
	255	quark_mfd = devm_kzalloc(&pdev->dev, sizeof(*quark_mfd), GFP_KERNEL);
	256	if (!quark_mfd)
	257	return -ENOMEM;
60ae5b9f	258
9caac886	259	quark_mfd->dev = &pdev->dev;
7f0c5ae1	260	dev_set_drvdata(&pdev->dev, quark_mfd);
60ae5b9f	261
9caac886	262	ret = intel_quark_register_i2c_clk(&pdev->dev);
60ae5b9f RT	263	if (ret)
	264	return ret;
	265
236fd469	266	ret = intel_quark_i2c_setup(pdev, &intel_quark_mfd_cells[1]);
60ae5b9f	267	if (ret)
7f0c5ae1	268	goto err_unregister_i2c_clk;
60ae5b9f	269
236fd469	270	ret = intel_quark_gpio_setup(pdev, &intel_quark_mfd_cells[0]);
60ae5b9f	271	if (ret)
7f0c5ae1	272	goto err_unregister_i2c_clk;
60ae5b9f	273
7f0c5ae1 AS	274	ret = mfd_add_devices(&pdev->dev, 0, intel_quark_mfd_cells,
	275	ARRAY_SIZE(intel_quark_mfd_cells), NULL, 0,
	276	NULL);
	277	if (ret)
	278	goto err_unregister_i2c_clk;
	279
	280	return 0;
60ae5b9f	281
7f0c5ae1	282	err_unregister_i2c_clk:
9caac886	283	intel_quark_unregister_i2c_clk(&pdev->dev);
7f0c5ae1	284	return ret;
60ae5b9f RT	285	}
	286
	287	static void intel_quark_mfd_remove(struct pci_dev *pdev)
	288	{
9caac886	289	intel_quark_unregister_i2c_clk(&pdev->dev);
60ae5b9f RT	290	mfd_remove_devices(&pdev->dev);
	291	}
	292
	293	static struct pci_driver intel_quark_mfd_driver = {
	294	.name = "intel_quark_mfd_i2c_gpio",
	295	.id_table = intel_quark_mfd_ids,
	296	.probe = intel_quark_mfd_probe,
	297	.remove = intel_quark_mfd_remove,
	298	};
	299
	300	module_pci_driver(intel_quark_mfd_driver);
	301
	302	MODULE_AUTHOR("Raymond Tan <raymond.tan@intel.com>");
	303	MODULE_DESCRIPTION("Intel Quark MFD PCI driver for I2C & GPIO");
	304	MODULE_LICENSE("GPL v2");