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 const 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
)
292 struct kempld_platform_data
*pdata
= dev_get_platdata(pld
->dev
);
295 ret
= pdata
->get_info(pld
);
299 /* The Kontron PLD firmware version string has the following format:
302 * w: PLD number - 1 hex digit
303 * x: Major version - 1 alphanumerical digit (0-9A-V)
304 * y: Minor version - 1 alphanumerical digit (0-9A-V)
305 * zzzz: Build number - 4 zero padded hex digits */
307 if (pld
->info
.major
< 10)
308 major
= pld
->info
.major
+ '0';
310 major
= (pld
->info
.major
- 10) + 'A';
311 if (pld
->info
.minor
< 10)
312 minor
= pld
->info
.minor
+ '0';
314 minor
= (pld
->info
.minor
- 10) + 'A';
316 ret
= scnprintf(pld
->info
.version
, sizeof(pld
->info
.version
),
317 "P%X%c%c.%04X", pld
->info
.number
, major
, minor
,
326 * kempld_register_cells - register cell drivers
328 * This function registers cell drivers for the detected hardware by calling
329 * the configured kempld_register_cells_XXXX function which is responsible
330 * to detect and register the needed cell drivers.
332 static int kempld_register_cells(struct kempld_device_data
*pld
)
334 struct kempld_platform_data
*pdata
= dev_get_platdata(pld
->dev
);
336 return pdata
->register_cells(pld
);
339 static const char *kempld_get_type_string(struct kempld_device_data
*pld
)
341 const char *version_type
;
343 switch (pld
->info
.type
) {
345 version_type
= "release";
348 version_type
= "debug";
351 version_type
= "custom";
354 version_type
= "unspecified";
361 static ssize_t
kempld_version_show(struct device
*dev
,
362 struct device_attribute
*attr
, char *buf
)
364 struct kempld_device_data
*pld
= dev_get_drvdata(dev
);
366 return scnprintf(buf
, PAGE_SIZE
, "%s\n", pld
->info
.version
);
369 static ssize_t
kempld_specification_show(struct device
*dev
,
370 struct device_attribute
*attr
, char *buf
)
372 struct kempld_device_data
*pld
= dev_get_drvdata(dev
);
374 return scnprintf(buf
, PAGE_SIZE
, "%d.%d\n", pld
->info
.spec_major
,
375 pld
->info
.spec_minor
);
378 static ssize_t
kempld_type_show(struct device
*dev
,
379 struct device_attribute
*attr
, char *buf
)
381 struct kempld_device_data
*pld
= dev_get_drvdata(dev
);
383 return scnprintf(buf
, PAGE_SIZE
, "%s\n", kempld_get_type_string(pld
));
386 static DEVICE_ATTR(pld_version
, S_IRUGO
, kempld_version_show
, NULL
);
387 static DEVICE_ATTR(pld_specification
, S_IRUGO
, kempld_specification_show
,
389 static DEVICE_ATTR(pld_type
, S_IRUGO
, kempld_type_show
, NULL
);
391 static struct attribute
*pld_attributes
[] = {
392 &dev_attr_pld_version
.attr
,
393 &dev_attr_pld_specification
.attr
,
394 &dev_attr_pld_type
.attr
,
398 static const struct attribute_group pld_attr_group
= {
399 .attrs
= pld_attributes
,
402 static int kempld_detect_device(struct kempld_device_data
*pld
)
407 mutex_lock(&pld
->lock
);
409 /* Check for empty IO space */
410 index_reg
= ioread8(pld
->io_index
);
411 if (index_reg
== 0xff && ioread8(pld
->io_data
) == 0xff) {
412 mutex_unlock(&pld
->lock
);
416 /* Release hardware mutex if acquired */
417 if (!(index_reg
& KEMPLD_MUTEX_KEY
)) {
418 iowrite8(KEMPLD_MUTEX_KEY
, pld
->io_index
);
419 /* PXT and COMe-cPC2 boards may require a second release */
420 iowrite8(KEMPLD_MUTEX_KEY
, pld
->io_index
);
423 mutex_unlock(&pld
->lock
);
425 ret
= kempld_get_info(pld
);
429 dev_info(pld
->dev
, "Found Kontron PLD - %s (%s), spec %d.%d\n",
430 pld
->info
.version
, kempld_get_type_string(pld
),
431 pld
->info
.spec_major
, pld
->info
.spec_minor
);
433 ret
= sysfs_create_group(&pld
->dev
->kobj
, &pld_attr_group
);
437 ret
= kempld_register_cells(pld
);
439 sysfs_remove_group(&pld
->dev
->kobj
, &pld_attr_group
);
444 static int kempld_probe(struct platform_device
*pdev
)
446 struct kempld_platform_data
*pdata
= dev_get_platdata(&pdev
->dev
);
447 struct device
*dev
= &pdev
->dev
;
448 struct kempld_device_data
*pld
;
449 struct resource
*ioport
;
452 pld
= devm_kzalloc(dev
, sizeof(*pld
), GFP_KERNEL
);
456 ioport
= platform_get_resource(pdev
, IORESOURCE_IO
, 0);
460 pld
->io_base
= devm_ioport_map(dev
, ioport
->start
,
461 ioport
->end
- ioport
->start
);
465 pld
->io_index
= pld
->io_base
;
466 pld
->io_data
= pld
->io_base
+ 1;
467 pld
->pld_clock
= pdata
->pld_clock
;
470 mutex_init(&pld
->lock
);
471 platform_set_drvdata(pdev
, pld
);
473 ret
= kempld_detect_device(pld
);
480 static int kempld_remove(struct platform_device
*pdev
)
482 struct kempld_device_data
*pld
= platform_get_drvdata(pdev
);
483 struct kempld_platform_data
*pdata
= dev_get_platdata(pld
->dev
);
485 sysfs_remove_group(&pld
->dev
->kobj
, &pld_attr_group
);
487 mfd_remove_devices(&pdev
->dev
);
488 pdata
->release_hardware_mutex(pld
);
493 static struct platform_driver kempld_driver
= {
496 .owner
= THIS_MODULE
,
498 .probe
= kempld_probe
,
499 .remove
= kempld_remove
,
502 static struct dmi_system_id __initdata kempld_dmi_table
[] = {
506 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
507 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bHL6"),
509 .driver_data
= (void *)&kempld_platform_data_generic
,
510 .callback
= kempld_create_platform_device
,
515 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
516 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bIP2"),
518 .driver_data
= (void *)&kempld_platform_data_generic
,
519 .callback
= kempld_create_platform_device
,
523 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
524 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bIP6"),
526 .driver_data
= (void *)&kempld_platform_data_generic
,
527 .callback
= kempld_create_platform_device
,
531 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
532 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cHL6"),
534 .driver_data
= (void *)&kempld_platform_data_generic
,
535 .callback
= kempld_create_platform_device
,
539 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
540 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-SC T2"),
542 .driver_data
= (void *)&kempld_platform_data_generic
,
543 .callback
= kempld_create_platform_device
,
547 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
548 DMI_MATCH(DMI_BOARD_NAME
, "ETXe-SC T2"),
550 .driver_data
= (void *)&kempld_platform_data_generic
,
551 .callback
= kempld_create_platform_device
,
555 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
556 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bSC2"),
558 .driver_data
= (void *)&kempld_platform_data_generic
,
559 .callback
= kempld_create_platform_device
,
563 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
564 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-SC T6"),
566 .driver_data
= (void *)&kempld_platform_data_generic
,
567 .callback
= kempld_create_platform_device
,
571 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
572 DMI_MATCH(DMI_BOARD_NAME
, "ETXe-SC T6"),
574 .driver_data
= (void *)&kempld_platform_data_generic
,
575 .callback
= kempld_create_platform_device
,
579 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
580 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bSC6"),
582 .driver_data
= (void *)&kempld_platform_data_generic
,
583 .callback
= kempld_create_platform_device
,
587 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
588 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-PC"),
590 .driver_data
= (void *)&kempld_platform_data_generic
,
591 .callback
= kempld_create_platform_device
,
595 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
596 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bPC2"),
598 .driver_data
= (void *)&kempld_platform_data_generic
,
599 .callback
= kempld_create_platform_device
,
603 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
604 DMI_MATCH(DMI_BOARD_NAME
, "PXT"),
606 .driver_data
= (void *)&kempld_platform_data_generic
,
607 .callback
= kempld_create_platform_device
,
611 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
612 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cBT"),
614 .driver_data
= (void *)&kempld_platform_data_generic
,
615 .callback
= kempld_create_platform_device
,
619 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
620 DMI_MATCH(DMI_BIOS_VERSION
, "FRI2"),
622 .driver_data
= (void *)&kempld_platform_data_generic
,
623 .callback
= kempld_create_platform_device
,
627 DMI_MATCH(DMI_PRODUCT_NAME
, "Fish River Island II"),
629 .driver_data
= (void *)&kempld_platform_data_generic
,
630 .callback
= kempld_create_platform_device
,
634 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
635 DMI_MATCH(DMI_BOARD_NAME
, "ETX-OH"),
637 .driver_data
= (void *)&kempld_platform_data_generic
,
638 .callback
= kempld_create_platform_device
,
642 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
643 DMI_MATCH(DMI_BOARD_NAME
, "COMe-mBT"),
645 .driver_data
= (void *)&kempld_platform_data_generic
,
646 .callback
= kempld_create_platform_device
,
650 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
651 DMI_MATCH(DMI_BOARD_NAME
, "nanoETXexpress-TT"),
653 .driver_data
= (void *)&kempld_platform_data_generic
,
654 .callback
= kempld_create_platform_device
,
658 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
659 DMI_MATCH(DMI_BOARD_NAME
, "nETXe-TT"),
661 .driver_data
= (void *)&kempld_platform_data_generic
,
662 .callback
= kempld_create_platform_device
,
666 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
667 DMI_MATCH(DMI_BOARD_NAME
, "COMe-mTT"),
669 .driver_data
= (void *)&kempld_platform_data_generic
,
670 .callback
= kempld_create_platform_device
,
674 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
675 DMI_MATCH(DMI_BOARD_NAME
, "COMe-mCT"),
677 .driver_data
= (void *)&kempld_platform_data_generic
,
678 .callback
= kempld_create_platform_device
,
682 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
683 DMI_MATCH(DMI_BOARD_NAME
, "microETXexpress-DC"),
685 .driver_data
= (void *)&kempld_platform_data_generic
,
686 .callback
= kempld_create_platform_device
,
690 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
691 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cDC2"),
693 .driver_data
= (void *)&kempld_platform_data_generic
,
694 .callback
= kempld_create_platform_device
,
698 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
699 DMI_MATCH(DMI_BOARD_NAME
, "microETXexpress-PC"),
701 .driver_data
= (void *)&kempld_platform_data_generic
,
702 .callback
= kempld_create_platform_device
,
706 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
707 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cPC2"),
709 .driver_data
= (void *)&kempld_platform_data_generic
,
710 .callback
= kempld_create_platform_device
,
714 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
715 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cCT6"),
717 .driver_data
= (void *)&kempld_platform_data_generic
,
718 .callback
= kempld_create_platform_device
,
723 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
724 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cTH6"),
726 .driver_data
= (void *)&kempld_platform_data_generic
,
727 .callback
= kempld_create_platform_device
,
731 MODULE_DEVICE_TABLE(dmi
, kempld_dmi_table
);
733 static int __init
kempld_init(void)
735 const struct dmi_system_id
*id
;
738 if (force_device_id
[0]) {
739 for (id
= kempld_dmi_table
; id
->matches
[0].slot
!= DMI_NONE
; id
++)
740 if (strstr(id
->ident
, force_device_id
))
741 if (id
->callback
&& id
->callback(id
))
743 if (id
->matches
[0].slot
== DMI_NONE
)
746 if (!dmi_check_system(kempld_dmi_table
))
750 ret
= platform_driver_register(&kempld_driver
);
757 static void __exit
kempld_exit(void)
760 platform_device_unregister(kempld_pdev
);
762 platform_driver_unregister(&kempld_driver
);
765 module_init(kempld_init
);
766 module_exit(kempld_exit
);
768 MODULE_DESCRIPTION("KEM PLD Core Driver");
769 MODULE_AUTHOR("Michael Brunner <michael.brunner@kontron.com>");
770 MODULE_LICENSE("GPL");
771 MODULE_ALIAS("platform:kempld-core");