2 * Kontron PLD MFD core driver
4 * Copyright (c) 2010-2013 Kontron Europe GmbH
5 * Author: Michael Brunner <michael.brunner@kontron.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License 2 as published
9 * by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
17 #include <linux/platform_device.h>
18 #include <linux/mfd/core.h>
19 #include <linux/mfd/kempld.h>
20 #include <linux/module.h>
21 #include <linux/dmi.h>
23 #include <linux/delay.h>
26 static char force_device_id[MAX_ID_LEN + 1] = "";
27 module_param_string(force_device_id, force_device_id, sizeof(force_device_id), 0);
28 MODULE_PARM_DESC(force_device_id, "Override detected product");
31 * Get hardware mutex to block firmware from accessing the pld.
32 * It is possible for the firmware may hold the mutex for an extended length of
33 * time. This function will block until access has been granted.
35 static void kempld_get_hardware_mutex(struct kempld_device_data *pld)
37 /* The mutex bit will read 1 until access has been granted */
38 while (ioread8(pld->io_index) & KEMPLD_MUTEX_KEY)
42 static void kempld_release_hardware_mutex(struct kempld_device_data *pld)
44 /* The harware mutex is released when 1 is written to the mutex bit. */
45 iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
48 static int kempld_get_info_generic(struct kempld_device_data *pld)
53 kempld_get_mutex(pld);
55 version = kempld_read16(pld, KEMPLD_VERSION);
56 spec = kempld_read8(pld, KEMPLD_SPEC);
57 pld->info.buildnr = kempld_read16(pld, KEMPLD_BUILDNR);
59 pld->info.minor = KEMPLD_VERSION_GET_MINOR(version);
60 pld->info.major = KEMPLD_VERSION_GET_MAJOR(version);
61 pld->info.number = KEMPLD_VERSION_GET_NUMBER(version);
62 pld->info.type = KEMPLD_VERSION_GET_TYPE(version);
65 pld->info.spec_minor = 0;
66 pld->info.spec_major = 1;
68 pld->info.spec_minor = KEMPLD_SPEC_GET_MINOR(spec);
69 pld->info.spec_major = KEMPLD_SPEC_GET_MAJOR(spec);
72 if (pld->info.spec_major > 0)
73 pld->feature_mask = kempld_read16(pld, KEMPLD_FEATURE);
75 pld->feature_mask = 0;
77 kempld_release_mutex(pld);
89 static struct mfd_cell kempld_devs[] = {
97 .name = "kempld-gpio",
100 .name = "kempld-uart",
104 #define KEMPLD_MAX_DEVS ARRAY_SIZE(kempld_devs)
106 static int kempld_register_cells_generic(struct kempld_device_data *pld)
108 struct mfd_cell devs[KEMPLD_MAX_DEVS];
111 if (pld->feature_mask & KEMPLD_FEATURE_BIT_I2C)
112 devs[i++] = kempld_devs[KEMPLD_I2C];
114 if (pld->feature_mask & KEMPLD_FEATURE_BIT_WATCHDOG)
115 devs[i++] = kempld_devs[KEMPLD_WDT];
117 if (pld->feature_mask & KEMPLD_FEATURE_BIT_GPIO)
118 devs[i++] = kempld_devs[KEMPLD_GPIO];
120 if (pld->feature_mask & KEMPLD_FEATURE_MASK_UART)
121 devs[i++] = kempld_devs[KEMPLD_UART];
123 return mfd_add_devices(pld->dev, -1, devs, i, NULL, 0, NULL);
126 static struct resource kempld_ioresource = {
127 .start = KEMPLD_IOINDEX,
128 .end = KEMPLD_IODATA,
129 .flags = IORESOURCE_IO,
132 static const struct kempld_platform_data kempld_platform_data_generic = {
133 .pld_clock = KEMPLD_CLK,
134 .ioresource = &kempld_ioresource,
135 .get_hardware_mutex = kempld_get_hardware_mutex,
136 .release_hardware_mutex = kempld_release_hardware_mutex,
137 .get_info = kempld_get_info_generic,
138 .register_cells = kempld_register_cells_generic,
141 static struct platform_device *kempld_pdev;
143 static int kempld_create_platform_device(const struct dmi_system_id *id)
145 struct kempld_platform_data *pdata = id->driver_data;
148 kempld_pdev = platform_device_alloc("kempld", -1);
152 ret = platform_device_add_data(kempld_pdev, pdata, sizeof(*pdata));
156 ret = platform_device_add_resources(kempld_pdev, pdata->ioresource, 1);
160 ret = platform_device_add(kempld_pdev);
166 platform_device_put(kempld_pdev);
171 * kempld_read8 - read 8 bit register
172 * @pld: kempld_device_data structure describing the PLD
173 * @index: register index on the chip
175 * kempld_get_mutex must be called prior to calling this function.
177 u8 kempld_read8(struct kempld_device_data *pld, u8 index)
179 iowrite8(index, pld->io_index);
180 return ioread8(pld->io_data);
182 EXPORT_SYMBOL_GPL(kempld_read8);
185 * kempld_write8 - write 8 bit register
186 * @pld: kempld_device_data structure describing the PLD
187 * @index: register index on the chip
188 * @data: new register value
190 * kempld_get_mutex must be called prior to calling this function.
192 void kempld_write8(struct kempld_device_data *pld, u8 index, u8 data)
194 iowrite8(index, pld->io_index);
195 iowrite8(data, pld->io_data);
197 EXPORT_SYMBOL_GPL(kempld_write8);
200 * kempld_read16 - read 16 bit register
201 * @pld: kempld_device_data structure describing the PLD
202 * @index: register index on the chip
204 * kempld_get_mutex must be called prior to calling this function.
206 u16 kempld_read16(struct kempld_device_data *pld, u8 index)
208 return kempld_read8(pld, index) | kempld_read8(pld, index + 1) << 8;
210 EXPORT_SYMBOL_GPL(kempld_read16);
213 * kempld_write16 - write 16 bit register
214 * @pld: kempld_device_data structure describing the PLD
215 * @index: register index on the chip
216 * @data: new register value
218 * kempld_get_mutex must be called prior to calling this function.
220 void kempld_write16(struct kempld_device_data *pld, u8 index, u16 data)
222 kempld_write8(pld, index, (u8)data);
223 kempld_write8(pld, index + 1, (u8)(data >> 8));
225 EXPORT_SYMBOL_GPL(kempld_write16);
228 * kempld_read32 - read 32 bit register
229 * @pld: kempld_device_data structure describing the PLD
230 * @index: register index on the chip
232 * kempld_get_mutex must be called prior to calling this function.
234 u32 kempld_read32(struct kempld_device_data *pld, u8 index)
236 return kempld_read16(pld, index) | kempld_read16(pld, index + 2) << 16;
238 EXPORT_SYMBOL_GPL(kempld_read32);
241 * kempld_write32 - write 32 bit register
242 * @pld: kempld_device_data structure describing the PLD
243 * @index: register index on the chip
244 * @data: new register value
246 * kempld_get_mutex must be called prior to calling this function.
248 void kempld_write32(struct kempld_device_data *pld, u8 index, u32 data)
250 kempld_write16(pld, index, (u16)data);
251 kempld_write16(pld, index + 2, (u16)(data >> 16));
253 EXPORT_SYMBOL_GPL(kempld_write32);
256 * kempld_get_mutex - acquire PLD mutex
257 * @pld: kempld_device_data structure describing the PLD
259 void kempld_get_mutex(struct kempld_device_data *pld)
261 struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
263 mutex_lock(&pld->lock);
264 pdata->get_hardware_mutex(pld);
266 EXPORT_SYMBOL_GPL(kempld_get_mutex);
269 * kempld_release_mutex - release PLD mutex
270 * @pld: kempld_device_data structure describing the PLD
272 void kempld_release_mutex(struct kempld_device_data *pld)
274 struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
276 pdata->release_hardware_mutex(pld);
277 mutex_unlock(&pld->lock);
279 EXPORT_SYMBOL_GPL(kempld_release_mutex);
282 * kempld_get_info - update device specific information
283 * @pld: kempld_device_data structure describing the PLD
285 * This function calls the configured board specific kempld_get_info_XXXX
286 * function which is responsible for gathering information about the specific
287 * hardware. The information is then stored within the pld structure.
289 static int kempld_get_info(struct kempld_device_data *pld)
291 struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
293 return pdata->get_info(pld);
297 * kempld_register_cells - register cell drivers
299 * This function registers cell drivers for the detected hardware by calling
300 * the configured kempld_register_cells_XXXX function which is responsible
301 * to detect and register the needed cell drivers.
303 static int kempld_register_cells(struct kempld_device_data *pld)
305 struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
307 return pdata->register_cells(pld);
310 static int kempld_detect_device(struct kempld_device_data *pld)
316 mutex_lock(&pld->lock);
318 /* Check for empty IO space */
319 index_reg = ioread8(pld->io_index);
320 if (index_reg == 0xff && ioread8(pld->io_data) == 0xff) {
321 mutex_unlock(&pld->lock);
325 /* Release hardware mutex if acquired */
326 if (!(index_reg & KEMPLD_MUTEX_KEY)) {
327 iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
328 /* PXT and COMe-cPC2 boards may require a second release */
329 iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
332 mutex_unlock(&pld->lock);
334 ret = kempld_get_info(pld);
338 switch (pld->info.type) {
340 version_type = "release";
343 version_type = "debug";
346 version_type = "custom";
349 version_type = "unspecified";
352 dev_info(pld->dev, "Found Kontron PLD %d\n", pld->info.number);
353 dev_info(pld->dev, "%s version %d.%d build %d, specification %d.%d\n",
354 version_type, pld->info.major, pld->info.minor,
355 pld->info.buildnr, pld->info.spec_major,
356 pld->info.spec_minor);
358 return kempld_register_cells(pld);
361 static int kempld_probe(struct platform_device *pdev)
363 struct kempld_platform_data *pdata = dev_get_platdata(&pdev->dev);
364 struct device *dev = &pdev->dev;
365 struct kempld_device_data *pld;
366 struct resource *ioport;
369 pld = devm_kzalloc(dev, sizeof(*pld), GFP_KERNEL);
373 ioport = platform_get_resource(pdev, IORESOURCE_IO, 0);
377 pld->io_base = devm_ioport_map(dev, ioport->start,
378 ioport->end - ioport->start);
382 pld->io_index = pld->io_base;
383 pld->io_data = pld->io_base + 1;
384 pld->pld_clock = pdata->pld_clock;
387 mutex_init(&pld->lock);
388 platform_set_drvdata(pdev, pld);
390 ret = kempld_detect_device(pld);
397 static int kempld_remove(struct platform_device *pdev)
399 struct kempld_device_data *pld = platform_get_drvdata(pdev);
400 struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
402 mfd_remove_devices(&pdev->dev);
403 pdata->release_hardware_mutex(pld);
408 static struct platform_driver kempld_driver = {
411 .owner = THIS_MODULE,
413 .probe = kempld_probe,
414 .remove = kempld_remove,
417 static struct dmi_system_id __initdata kempld_dmi_table[] = {
421 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
422 DMI_MATCH(DMI_BOARD_NAME, "COMe-bHL6"),
424 .driver_data = (void *)&kempld_platform_data_generic,
425 .callback = kempld_create_platform_device,
430 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
431 DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP2"),
433 .driver_data = (void *)&kempld_platform_data_generic,
434 .callback = kempld_create_platform_device,
438 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
439 DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP6"),
441 .driver_data = (void *)&kempld_platform_data_generic,
442 .callback = kempld_create_platform_device,
446 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
447 DMI_MATCH(DMI_BOARD_NAME, "COMe-cHL6"),
449 .driver_data = (void *)&kempld_platform_data_generic,
450 .callback = kempld_create_platform_device,
454 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
455 DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T2"),
457 .driver_data = (void *)&kempld_platform_data_generic,
458 .callback = kempld_create_platform_device,
462 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
463 DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T2"),
465 .driver_data = (void *)&kempld_platform_data_generic,
466 .callback = kempld_create_platform_device,
470 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
471 DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC2"),
473 .driver_data = (void *)&kempld_platform_data_generic,
474 .callback = kempld_create_platform_device,
478 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
479 DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T6"),
481 .driver_data = (void *)&kempld_platform_data_generic,
482 .callback = kempld_create_platform_device,
486 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
487 DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T6"),
489 .driver_data = (void *)&kempld_platform_data_generic,
490 .callback = kempld_create_platform_device,
494 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
495 DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC6"),
497 .driver_data = (void *)&kempld_platform_data_generic,
498 .callback = kempld_create_platform_device,
502 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
503 DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-PC"),
505 .driver_data = (void *)&kempld_platform_data_generic,
506 .callback = kempld_create_platform_device,
510 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
511 DMI_MATCH(DMI_BOARD_NAME, "COMe-bPC2"),
513 .driver_data = (void *)&kempld_platform_data_generic,
514 .callback = kempld_create_platform_device,
518 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
519 DMI_MATCH(DMI_BOARD_NAME, "PXT"),
521 .driver_data = (void *)&kempld_platform_data_generic,
522 .callback = kempld_create_platform_device,
526 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
527 DMI_MATCH(DMI_BOARD_NAME, "COMe-cBT"),
529 .driver_data = (void *)&kempld_platform_data_generic,
530 .callback = kempld_create_platform_device,
534 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
535 DMI_MATCH(DMI_BIOS_VERSION, "FRI2"),
537 .driver_data = (void *)&kempld_platform_data_generic,
538 .callback = kempld_create_platform_device,
542 DMI_MATCH(DMI_PRODUCT_NAME, "Fish River Island II"),
544 .driver_data = (void *)&kempld_platform_data_generic,
545 .callback = kempld_create_platform_device,
549 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
550 DMI_MATCH(DMI_BOARD_NAME, "ETX-OH"),
552 .driver_data = (void *)&kempld_platform_data_generic,
553 .callback = kempld_create_platform_device,
557 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
558 DMI_MATCH(DMI_BOARD_NAME, "COMe-mBT"),
560 .driver_data = (void *)&kempld_platform_data_generic,
561 .callback = kempld_create_platform_device,
565 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
566 DMI_MATCH(DMI_BOARD_NAME, "nanoETXexpress-TT"),
568 .driver_data = (void *)&kempld_platform_data_generic,
569 .callback = kempld_create_platform_device,
573 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
574 DMI_MATCH(DMI_BOARD_NAME, "nETXe-TT"),
576 .driver_data = (void *)&kempld_platform_data_generic,
577 .callback = kempld_create_platform_device,
581 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
582 DMI_MATCH(DMI_BOARD_NAME, "COMe-mTT"),
584 .driver_data = (void *)&kempld_platform_data_generic,
585 .callback = kempld_create_platform_device,
589 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
590 DMI_MATCH(DMI_BOARD_NAME, "COMe-mCT"),
592 .driver_data = (void *)&kempld_platform_data_generic,
593 .callback = kempld_create_platform_device,
597 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
598 DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-DC"),
600 .driver_data = (void *)&kempld_platform_data_generic,
601 .callback = kempld_create_platform_device,
605 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
606 DMI_MATCH(DMI_BOARD_NAME, "COMe-cDC2"),
608 .driver_data = (void *)&kempld_platform_data_generic,
609 .callback = kempld_create_platform_device,
613 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
614 DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-PC"),
616 .driver_data = (void *)&kempld_platform_data_generic,
617 .callback = kempld_create_platform_device,
621 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
622 DMI_MATCH(DMI_BOARD_NAME, "COMe-cPC2"),
624 .driver_data = (void *)&kempld_platform_data_generic,
625 .callback = kempld_create_platform_device,
629 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
630 DMI_MATCH(DMI_BOARD_NAME, "COMe-cCT6"),
632 .driver_data = (void *)&kempld_platform_data_generic,
633 .callback = kempld_create_platform_device,
638 DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
639 DMI_MATCH(DMI_BOARD_NAME, "COMe-cTH6"),
641 .driver_data = (void *)&kempld_platform_data_generic,
642 .callback = kempld_create_platform_device,
646 MODULE_DEVICE_TABLE(dmi, kempld_dmi_table);
648 static int __init kempld_init(void)
650 const struct dmi_system_id *id;
653 if (force_device_id[0]) {
654 for (id = kempld_dmi_table; id->matches[0].slot != DMI_NONE; id++)
655 if (strstr(id->ident, force_device_id))
656 if (id->callback && id->callback(id))
658 if (id->matches[0].slot == DMI_NONE)
661 if (!dmi_check_system(kempld_dmi_table))
665 ret = platform_driver_register(&kempld_driver);
672 static void __exit kempld_exit(void)
675 platform_device_unregister(kempld_pdev);
677 platform_driver_unregister(&kempld_driver);
680 module_init(kempld_init);
681 module_exit(kempld_exit);
683 MODULE_DESCRIPTION("KEM PLD Core Driver");
684 MODULE_AUTHOR("Michael Brunner <michael.brunner@kontron.com>");
685 MODULE_LICENSE("GPL");
686 MODULE_ALIAS("platform:kempld-core");