1 // SPDX-License-Identifier: GPL-2.0-only
3 * Intel Quark MFD PCI driver for I2C & GPIO
5 * Copyright(c) 2014 Intel Corporation.
7 * Intel Quark PCI device for I2C and GPIO controller sharing the same
8 * PCI function. This PCI driver will split the 2 devices into their
12 #include <linux/kernel.h>
13 #include <linux/module.h>
14 #include <linux/pci.h>
15 #include <linux/mfd/core.h>
16 #include <linux/clkdev.h>
17 #include <linux/clk-provider.h>
18 #include <linux/dmi.h>
19 #include <linux/platform_data/gpio-dwapb.h>
20 #include <linux/platform_data/i2c-designware.h>
22 /* PCI BAR for register base address */
24 #define MFD_GPIO_BAR 1
26 /* ACPI _ADR value to match the child node */
27 #define MFD_ACPI_MATCH_GPIO 0ULL
28 #define MFD_ACPI_MATCH_I2C 1ULL
30 /* The base GPIO number under GPIOLIB framework */
31 #define INTEL_QUARK_MFD_GPIO_BASE 8
33 /* The default number of South-Cluster GPIO on Quark. */
34 #define INTEL_QUARK_MFD_NGPIO 8
36 /* The DesignWare GPIO ports on Quark. */
37 #define INTEL_QUARK_GPIO_NPORTS 1
39 #define INTEL_QUARK_IORES_MEM 0
40 #define INTEL_QUARK_IORES_IRQ 1
42 #define INTEL_QUARK_I2C_CONTROLLER_CLK "i2c_designware.0"
44 /* The Quark I2C controller source clock */
45 #define INTEL_QUARK_I2C_CLK_HZ 33000000
47 struct intel_quark_mfd {
50 struct clk_lookup *i2c_clk_lookup;
53 static const struct dmi_system_id dmi_platform_info[] = {
56 DMI_EXACT_MATCH(DMI_BOARD_NAME, "Galileo"),
58 .driver_data = (void *)100000,
62 DMI_EXACT_MATCH(DMI_BOARD_NAME, "GalileoGen2"),
64 .driver_data = (void *)400000,
68 DMI_EXACT_MATCH(DMI_BOARD_NAME, "SIMATIC IOT2000"),
70 .driver_data = (void *)400000,
75 /* This is used as a place holder and will be modified at run-time */
76 static struct resource intel_quark_i2c_res[] = {
77 [INTEL_QUARK_IORES_MEM] = {
78 .flags = IORESOURCE_MEM,
80 [INTEL_QUARK_IORES_IRQ] = {
81 .flags = IORESOURCE_IRQ,
85 static struct mfd_cell_acpi_match intel_quark_acpi_match_i2c = {
86 .adr = MFD_ACPI_MATCH_I2C,
89 /* This is used as a place holder and will be modified at run-time */
90 static struct resource intel_quark_gpio_res[] = {
91 [INTEL_QUARK_IORES_MEM] = {
92 .flags = IORESOURCE_MEM,
96 static struct mfd_cell_acpi_match intel_quark_acpi_match_gpio = {
97 .adr = MFD_ACPI_MATCH_GPIO,
100 static struct mfd_cell intel_quark_mfd_cells[] = {
103 .name = "gpio-dwapb",
104 .acpi_match = &intel_quark_acpi_match_gpio,
105 .num_resources = ARRAY_SIZE(intel_quark_gpio_res),
106 .resources = intel_quark_gpio_res,
107 .ignore_resource_conflicts = true,
111 .name = "i2c_designware",
112 .acpi_match = &intel_quark_acpi_match_i2c,
113 .num_resources = ARRAY_SIZE(intel_quark_i2c_res),
114 .resources = intel_quark_i2c_res,
115 .ignore_resource_conflicts = true,
119 static const struct pci_device_id intel_quark_mfd_ids[] = {
120 { PCI_VDEVICE(INTEL, 0x0934), },
123 MODULE_DEVICE_TABLE(pci, intel_quark_mfd_ids);
125 static int intel_quark_register_i2c_clk(struct device *dev)
127 struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);
130 i2c_clk = clk_register_fixed_rate(dev,
131 INTEL_QUARK_I2C_CONTROLLER_CLK, NULL,
132 0, INTEL_QUARK_I2C_CLK_HZ);
134 return PTR_ERR(i2c_clk);
136 quark_mfd->i2c_clk = i2c_clk;
137 quark_mfd->i2c_clk_lookup = clkdev_create(i2c_clk, NULL,
138 INTEL_QUARK_I2C_CONTROLLER_CLK);
140 if (!quark_mfd->i2c_clk_lookup) {
141 clk_unregister(quark_mfd->i2c_clk);
142 dev_err(dev, "Fixed clk register failed\n");
149 static void intel_quark_unregister_i2c_clk(struct device *dev)
151 struct intel_quark_mfd *quark_mfd = dev_get_drvdata(dev);
153 if (!quark_mfd->i2c_clk_lookup)
156 clkdev_drop(quark_mfd->i2c_clk_lookup);
157 clk_unregister(quark_mfd->i2c_clk);
160 static int intel_quark_i2c_setup(struct pci_dev *pdev, struct mfd_cell *cell)
162 const struct dmi_system_id *dmi_id;
163 struct dw_i2c_platform_data *pdata;
164 struct resource *res = (struct resource *)cell->resources;
165 struct device *dev = &pdev->dev;
167 res[INTEL_QUARK_IORES_MEM].start =
168 pci_resource_start(pdev, MFD_I2C_BAR);
169 res[INTEL_QUARK_IORES_MEM].end =
170 pci_resource_end(pdev, MFD_I2C_BAR);
172 res[INTEL_QUARK_IORES_IRQ].start = pdev->irq;
173 res[INTEL_QUARK_IORES_IRQ].end = pdev->irq;
175 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
179 /* Normal mode by default */
180 pdata->i2c_scl_freq = 100000;
182 dmi_id = dmi_first_match(dmi_platform_info);
184 pdata->i2c_scl_freq = (uintptr_t)dmi_id->driver_data;
186 cell->platform_data = pdata;
187 cell->pdata_size = sizeof(*pdata);
192 static int intel_quark_gpio_setup(struct pci_dev *pdev, struct mfd_cell *cell)
194 struct dwapb_platform_data *pdata;
195 struct resource *res = (struct resource *)cell->resources;
196 struct device *dev = &pdev->dev;
198 res[INTEL_QUARK_IORES_MEM].start =
199 pci_resource_start(pdev, MFD_GPIO_BAR);
200 res[INTEL_QUARK_IORES_MEM].end =
201 pci_resource_end(pdev, MFD_GPIO_BAR);
203 pdata = devm_kzalloc(dev, sizeof(*pdata), GFP_KERNEL);
207 /* For intel quark x1000, it has only one port: portA */
208 pdata->nports = INTEL_QUARK_GPIO_NPORTS;
209 pdata->properties = devm_kcalloc(dev, pdata->nports,
210 sizeof(*pdata->properties),
212 if (!pdata->properties)
215 /* Set the properties for portA */
216 pdata->properties->fwnode = NULL;
217 pdata->properties->idx = 0;
218 pdata->properties->ngpio = INTEL_QUARK_MFD_NGPIO;
219 pdata->properties->gpio_base = INTEL_QUARK_MFD_GPIO_BASE;
220 pdata->properties->irq[0] = pdev->irq;
221 pdata->properties->irq_shared = true;
223 cell->platform_data = pdata;
224 cell->pdata_size = sizeof(*pdata);
229 static int intel_quark_mfd_probe(struct pci_dev *pdev,
230 const struct pci_device_id *id)
232 struct intel_quark_mfd *quark_mfd;
235 ret = pcim_enable_device(pdev);
239 quark_mfd = devm_kzalloc(&pdev->dev, sizeof(*quark_mfd), GFP_KERNEL);
243 quark_mfd->dev = &pdev->dev;
244 dev_set_drvdata(&pdev->dev, quark_mfd);
246 ret = intel_quark_register_i2c_clk(&pdev->dev);
250 ret = intel_quark_i2c_setup(pdev, &intel_quark_mfd_cells[1]);
252 goto err_unregister_i2c_clk;
254 ret = intel_quark_gpio_setup(pdev, &intel_quark_mfd_cells[0]);
256 goto err_unregister_i2c_clk;
258 ret = mfd_add_devices(&pdev->dev, 0, intel_quark_mfd_cells,
259 ARRAY_SIZE(intel_quark_mfd_cells), NULL, 0,
262 goto err_unregister_i2c_clk;
266 err_unregister_i2c_clk:
267 intel_quark_unregister_i2c_clk(&pdev->dev);
271 static void intel_quark_mfd_remove(struct pci_dev *pdev)
273 intel_quark_unregister_i2c_clk(&pdev->dev);
274 mfd_remove_devices(&pdev->dev);
277 static struct pci_driver intel_quark_mfd_driver = {
278 .name = "intel_quark_mfd_i2c_gpio",
279 .id_table = intel_quark_mfd_ids,
280 .probe = intel_quark_mfd_probe,
281 .remove = intel_quark_mfd_remove,
284 module_pci_driver(intel_quark_mfd_driver);
286 MODULE_AUTHOR("Raymond Tan <raymond.tan@intel.com>");
287 MODULE_DESCRIPTION("Intel Quark MFD PCI driver for I2C & GPIO");
288 MODULE_LICENSE("GPL v2");