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
= pld
->dev
->platform_data
;
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
= pld
->dev
->platform_data
;
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
= pld
->dev
->platform_data
;
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
= pld
->dev
->platform_data
;
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 aquired */
326 if (!(index_reg
& KEMPLD_MUTEX_KEY
))
327 iowrite8(KEMPLD_MUTEX_KEY
, pld
->io_index
);
329 mutex_unlock(&pld
->lock
);
331 ret
= kempld_get_info(pld
);
335 switch (pld
->info
.type
) {
337 version_type
= "release";
340 version_type
= "debug";
343 version_type
= "custom";
346 version_type
= "unspecified";
349 dev_info(pld
->dev
, "Found Kontron PLD %d\n", pld
->info
.number
);
350 dev_info(pld
->dev
, "%s version %d.%d build %d, specification %d.%d\n",
351 version_type
, pld
->info
.major
, pld
->info
.minor
,
352 pld
->info
.buildnr
, pld
->info
.spec_major
,
353 pld
->info
.spec_minor
);
355 return kempld_register_cells(pld
);
358 static int kempld_probe(struct platform_device
*pdev
)
360 struct kempld_platform_data
*pdata
= pdev
->dev
.platform_data
;
361 struct device
*dev
= &pdev
->dev
;
362 struct kempld_device_data
*pld
;
363 struct resource
*ioport
;
366 pld
= devm_kzalloc(dev
, sizeof(*pld
), GFP_KERNEL
);
370 ioport
= platform_get_resource(pdev
, IORESOURCE_IO
, 0);
374 pld
->io_base
= devm_ioport_map(dev
, ioport
->start
,
375 ioport
->end
- ioport
->start
);
379 pld
->io_index
= pld
->io_base
;
380 pld
->io_data
= pld
->io_base
+ 1;
381 pld
->pld_clock
= pdata
->pld_clock
;
384 mutex_init(&pld
->lock
);
385 platform_set_drvdata(pdev
, pld
);
387 ret
= kempld_detect_device(pld
);
394 static int kempld_remove(struct platform_device
*pdev
)
396 struct kempld_device_data
*pld
= platform_get_drvdata(pdev
);
397 struct kempld_platform_data
*pdata
= pld
->dev
->platform_data
;
399 mfd_remove_devices(&pdev
->dev
);
400 pdata
->release_hardware_mutex(pld
);
405 static struct platform_driver kempld_driver
= {
408 .owner
= THIS_MODULE
,
410 .probe
= kempld_probe
,
411 .remove
= kempld_remove
,
414 static struct dmi_system_id __initdata kempld_dmi_table
[] = {
418 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
419 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bIP2"),
421 .driver_data
= (void *)&kempld_platform_data_generic
,
422 .callback
= kempld_create_platform_device
,
426 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
427 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bIP6"),
429 .driver_data
= (void *)&kempld_platform_data_generic
,
430 .callback
= kempld_create_platform_device
,
434 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
435 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-SC T2"),
437 .driver_data
= (void *)&kempld_platform_data_generic
,
438 .callback
= kempld_create_platform_device
,
442 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
443 DMI_MATCH(DMI_BOARD_NAME
, "ETXe-SC T2"),
445 .driver_data
= (void *)&kempld_platform_data_generic
,
446 .callback
= kempld_create_platform_device
,
450 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
451 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bSC2"),
453 .driver_data
= (void *)&kempld_platform_data_generic
,
454 .callback
= kempld_create_platform_device
,
458 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
459 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-SC T6"),
461 .driver_data
= (void *)&kempld_platform_data_generic
,
462 .callback
= kempld_create_platform_device
,
466 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
467 DMI_MATCH(DMI_BOARD_NAME
, "ETXe-SC T6"),
469 .driver_data
= (void *)&kempld_platform_data_generic
,
470 .callback
= kempld_create_platform_device
,
474 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
475 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bSC6"),
477 .driver_data
= (void *)&kempld_platform_data_generic
,
478 .callback
= kempld_create_platform_device
,
482 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
483 DMI_MATCH(DMI_BOARD_NAME
, "ETXexpress-PC"),
485 .driver_data
= (void *)&kempld_platform_data_generic
,
486 .callback
= kempld_create_platform_device
,
490 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
491 DMI_MATCH(DMI_BOARD_NAME
, "COMe-bPC2"),
493 .driver_data
= (void *)&kempld_platform_data_generic
,
494 .callback
= kempld_create_platform_device
,
498 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
499 DMI_MATCH(DMI_BOARD_NAME
, "PXT"),
501 .driver_data
= (void *)&kempld_platform_data_generic
,
502 .callback
= kempld_create_platform_device
,
506 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
507 DMI_MATCH(DMI_BIOS_VERSION
, "FRI2"),
509 .driver_data
= (void *)&kempld_platform_data_generic
,
510 .callback
= kempld_create_platform_device
,
514 DMI_MATCH(DMI_PRODUCT_NAME
, "Fish River Island II"),
516 .driver_data
= (void *)&kempld_platform_data_generic
,
517 .callback
= kempld_create_platform_device
,
521 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
522 DMI_MATCH(DMI_BOARD_NAME
, "ETX-OH"),
524 .driver_data
= (void *)&kempld_platform_data_generic
,
525 .callback
= kempld_create_platform_device
,
529 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
530 DMI_MATCH(DMI_BOARD_NAME
, "nanoETXexpress-TT"),
532 .driver_data
= (void *)&kempld_platform_data_generic
,
533 .callback
= kempld_create_platform_device
,
537 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
538 DMI_MATCH(DMI_BOARD_NAME
, "nETXe-TT"),
540 .driver_data
= (void *)&kempld_platform_data_generic
,
541 .callback
= kempld_create_platform_device
,
545 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
546 DMI_MATCH(DMI_BOARD_NAME
, "COMe-mTT"),
548 .driver_data
= (void *)&kempld_platform_data_generic
,
549 .callback
= kempld_create_platform_device
,
553 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
554 DMI_MATCH(DMI_BOARD_NAME
, "COMe-mCT"),
556 .driver_data
= (void *)&kempld_platform_data_generic
,
557 .callback
= kempld_create_platform_device
,
561 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
562 DMI_MATCH(DMI_BOARD_NAME
, "microETXexpress-DC"),
564 .driver_data
= (void *)&kempld_platform_data_generic
,
565 .callback
= kempld_create_platform_device
,
569 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
570 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cDC2"),
572 .driver_data
= (void *)&kempld_platform_data_generic
,
573 .callback
= kempld_create_platform_device
,
577 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
578 DMI_MATCH(DMI_BOARD_NAME
, "microETXexpress-PC"),
580 .driver_data
= (void *)&kempld_platform_data_generic
,
581 .callback
= kempld_create_platform_device
,
585 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
586 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cPC2"),
588 .driver_data
= (void *)&kempld_platform_data_generic
,
589 .callback
= kempld_create_platform_device
,
593 DMI_MATCH(DMI_BOARD_VENDOR
, "Kontron"),
594 DMI_MATCH(DMI_BOARD_NAME
, "COMe-cCT6"),
596 .driver_data
= (void *)&kempld_platform_data_generic
,
597 .callback
= kempld_create_platform_device
,
601 MODULE_DEVICE_TABLE(dmi
, kempld_dmi_table
);
603 static int __init
kempld_init(void)
605 const struct dmi_system_id
*id
;
608 if (force_device_id
[0]) {
609 for (id
= kempld_dmi_table
; id
->matches
[0].slot
!= DMI_NONE
; id
++)
610 if (strstr(id
->ident
, force_device_id
))
611 if (id
->callback
&& id
->callback(id
))
613 if (id
->matches
[0].slot
== DMI_NONE
)
616 if (!dmi_check_system(kempld_dmi_table
))
620 ret
= platform_driver_register(&kempld_driver
);
627 static void __exit
kempld_exit(void)
630 platform_device_unregister(kempld_pdev
);
632 platform_driver_unregister(&kempld_driver
);
635 module_init(kempld_init
);
636 module_exit(kempld_exit
);
638 MODULE_DESCRIPTION("KEM PLD Core Driver");
639 MODULE_AUTHOR("Michael Brunner <michael.brunner@kontron.com>");
640 MODULE_LICENSE("GPL");
641 MODULE_ALIAS("platform:kempld-core");