Linux Audio

Check our new training course

Yocto / OpenEmbedded training

Feb 10-13, 2025
Register
Loading...
v6.8
  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Kontron PLD MFD core driver
  4 *
  5 * Copyright (c) 2010-2013 Kontron Europe GmbH
  6 * Author: Michael Brunner <michael.brunner@kontron.com>
  7 */
  8
  9#include <linux/platform_device.h>
 10#include <linux/mfd/core.h>
 11#include <linux/mfd/kempld.h>
 12#include <linux/module.h>
 13#include <linux/dmi.h>
 14#include <linux/io.h>
 15#include <linux/delay.h>
 16#include <linux/acpi.h>
 17
 18#define MAX_ID_LEN 4
 19static char force_device_id[MAX_ID_LEN + 1] = "";
 20module_param_string(force_device_id, force_device_id,
 21		    sizeof(force_device_id), 0);
 22MODULE_PARM_DESC(force_device_id, "Override detected product");
 23
 24/*
 25 * Get hardware mutex to block firmware from accessing the pld.
 26 * It is possible for the firmware may hold the mutex for an extended length of
 27 * time. This function will block until access has been granted.
 28 */
 29static void kempld_get_hardware_mutex(struct kempld_device_data *pld)
 30{
 31	/* The mutex bit will read 1 until access has been granted */
 32	while (ioread8(pld->io_index) & KEMPLD_MUTEX_KEY)
 33		usleep_range(1000, 3000);
 34}
 35
 36static void kempld_release_hardware_mutex(struct kempld_device_data *pld)
 37{
 38	/* The harware mutex is released when 1 is written to the mutex bit. */
 39	iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
 40}
 41
 42static int kempld_get_info_generic(struct kempld_device_data *pld)
 43{
 44	u16 version;
 45	u8 spec;
 46
 47	kempld_get_mutex(pld);
 48
 49	version = kempld_read16(pld, KEMPLD_VERSION);
 50	spec = kempld_read8(pld, KEMPLD_SPEC);
 51	pld->info.buildnr = kempld_read16(pld, KEMPLD_BUILDNR);
 52
 53	pld->info.minor = KEMPLD_VERSION_GET_MINOR(version);
 54	pld->info.major = KEMPLD_VERSION_GET_MAJOR(version);
 55	pld->info.number = KEMPLD_VERSION_GET_NUMBER(version);
 56	pld->info.type = KEMPLD_VERSION_GET_TYPE(version);
 57
 58	if (spec == 0xff) {
 59		pld->info.spec_minor = 0;
 60		pld->info.spec_major = 1;
 61	} else {
 62		pld->info.spec_minor = KEMPLD_SPEC_GET_MINOR(spec);
 63		pld->info.spec_major = KEMPLD_SPEC_GET_MAJOR(spec);
 64	}
 65
 66	if (pld->info.spec_major > 0)
 67		pld->feature_mask = kempld_read16(pld, KEMPLD_FEATURE);
 68	else
 69		pld->feature_mask = 0;
 70
 71	kempld_release_mutex(pld);
 72
 73	return 0;
 74}
 75
 76enum kempld_cells {
 77	KEMPLD_I2C = 0,
 78	KEMPLD_WDT,
 79	KEMPLD_GPIO,
 80	KEMPLD_UART,
 81};
 82
 83static const char *kempld_dev_names[] = {
 84	[KEMPLD_I2C] = "kempld-i2c",
 85	[KEMPLD_WDT] = "kempld-wdt",
 86	[KEMPLD_GPIO] = "kempld-gpio",
 87	[KEMPLD_UART] = "kempld-uart",
 88};
 89
 90#define KEMPLD_MAX_DEVS	ARRAY_SIZE(kempld_dev_names)
 91
 92static int kempld_register_cells_generic(struct kempld_device_data *pld)
 93{
 94	struct mfd_cell devs[KEMPLD_MAX_DEVS] = {};
 95	int i = 0;
 96
 97	if (pld->feature_mask & KEMPLD_FEATURE_BIT_I2C)
 98		devs[i++].name = kempld_dev_names[KEMPLD_I2C];
 99
100	if (pld->feature_mask & KEMPLD_FEATURE_BIT_WATCHDOG)
101		devs[i++].name = kempld_dev_names[KEMPLD_WDT];
102
103	if (pld->feature_mask & KEMPLD_FEATURE_BIT_GPIO)
104		devs[i++].name = kempld_dev_names[KEMPLD_GPIO];
105
106	if (pld->feature_mask & KEMPLD_FEATURE_MASK_UART)
107		devs[i++].name = kempld_dev_names[KEMPLD_UART];
108
109	return mfd_add_devices(pld->dev, -1, devs, i, NULL, 0, NULL);
110}
111
112static struct resource kempld_ioresource = {
113	.start	= KEMPLD_IOINDEX,
114	.end	= KEMPLD_IODATA,
115	.flags	= IORESOURCE_IO,
116};
117
118static const struct kempld_platform_data kempld_platform_data_generic = {
119	.pld_clock		= KEMPLD_CLK,
120	.ioresource		= &kempld_ioresource,
121	.get_hardware_mutex	= kempld_get_hardware_mutex,
122	.release_hardware_mutex	= kempld_release_hardware_mutex,
123	.get_info		= kempld_get_info_generic,
124	.register_cells		= kempld_register_cells_generic,
125};
126
127static struct platform_device *kempld_pdev;
128
129static int kempld_create_platform_device(const struct dmi_system_id *id)
130{
131	const struct kempld_platform_data *pdata = id->driver_data;
132	int ret;
133
134	kempld_pdev = platform_device_alloc("kempld", -1);
135	if (!kempld_pdev)
136		return -ENOMEM;
137
138	ret = platform_device_add_data(kempld_pdev, pdata, sizeof(*pdata));
139	if (ret)
140		goto err;
141
142	ret = platform_device_add_resources(kempld_pdev, pdata->ioresource, 1);
143	if (ret)
144		goto err;
145
146	ret = platform_device_add(kempld_pdev);
147	if (ret)
148		goto err;
149
150	return 0;
151err:
152	platform_device_put(kempld_pdev);
153	return ret;
154}
155
156/**
157 * kempld_read8 - read 8 bit register
158 * @pld: kempld_device_data structure describing the PLD
159 * @index: register index on the chip
160 *
161 * kempld_get_mutex must be called prior to calling this function.
162 */
163u8 kempld_read8(struct kempld_device_data *pld, u8 index)
164{
165	iowrite8(index, pld->io_index);
166	return ioread8(pld->io_data);
167}
168EXPORT_SYMBOL_GPL(kempld_read8);
169
170/**
171 * kempld_write8 - write 8 bit register
172 * @pld: kempld_device_data structure describing the PLD
173 * @index: register index on the chip
174 * @data: new register value
175 *
176 * kempld_get_mutex must be called prior to calling this function.
177 */
178void kempld_write8(struct kempld_device_data *pld, u8 index, u8 data)
179{
180	iowrite8(index, pld->io_index);
181	iowrite8(data, pld->io_data);
182}
183EXPORT_SYMBOL_GPL(kempld_write8);
184
185/**
186 * kempld_read16 - read 16 bit register
187 * @pld: kempld_device_data structure describing the PLD
188 * @index: register index on the chip
189 *
190 * kempld_get_mutex must be called prior to calling this function.
191 */
192u16 kempld_read16(struct kempld_device_data *pld, u8 index)
193{
194	return kempld_read8(pld, index) | kempld_read8(pld, index + 1) << 8;
195}
196EXPORT_SYMBOL_GPL(kempld_read16);
197
198/**
199 * kempld_write16 - write 16 bit register
200 * @pld: kempld_device_data structure describing the PLD
201 * @index: register index on the chip
202 * @data: new register value
203 *
204 * kempld_get_mutex must be called prior to calling this function.
205 */
206void kempld_write16(struct kempld_device_data *pld, u8 index, u16 data)
207{
208	kempld_write8(pld, index, (u8)data);
209	kempld_write8(pld, index + 1, (u8)(data >> 8));
210}
211EXPORT_SYMBOL_GPL(kempld_write16);
212
213/**
214 * kempld_read32 - read 32 bit register
215 * @pld: kempld_device_data structure describing the PLD
216 * @index: register index on the chip
217 *
218 * kempld_get_mutex must be called prior to calling this function.
219 */
220u32 kempld_read32(struct kempld_device_data *pld, u8 index)
221{
222	return kempld_read16(pld, index) | kempld_read16(pld, index + 2) << 16;
223}
224EXPORT_SYMBOL_GPL(kempld_read32);
225
226/**
227 * kempld_write32 - write 32 bit register
228 * @pld: kempld_device_data structure describing the PLD
229 * @index: register index on the chip
230 * @data: new register value
231 *
232 * kempld_get_mutex must be called prior to calling this function.
233 */
234void kempld_write32(struct kempld_device_data *pld, u8 index, u32 data)
235{
236	kempld_write16(pld, index, (u16)data);
237	kempld_write16(pld, index + 2, (u16)(data >> 16));
238}
239EXPORT_SYMBOL_GPL(kempld_write32);
240
241/**
242 * kempld_get_mutex - acquire PLD mutex
243 * @pld: kempld_device_data structure describing the PLD
244 */
245void kempld_get_mutex(struct kempld_device_data *pld)
246{
247	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
248
249	mutex_lock(&pld->lock);
250	pdata->get_hardware_mutex(pld);
251}
252EXPORT_SYMBOL_GPL(kempld_get_mutex);
253
254/**
255 * kempld_release_mutex - release PLD mutex
256 * @pld: kempld_device_data structure describing the PLD
257 */
258void kempld_release_mutex(struct kempld_device_data *pld)
259{
260	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
261
262	pdata->release_hardware_mutex(pld);
263	mutex_unlock(&pld->lock);
264}
265EXPORT_SYMBOL_GPL(kempld_release_mutex);
266
267/**
268 * kempld_get_info - update device specific information
269 * @pld: kempld_device_data structure describing the PLD
270 *
271 * This function calls the configured board specific kempld_get_info_XXXX
272 * function which is responsible for gathering information about the specific
273 * hardware. The information is then stored within the pld structure.
274 */
275static int kempld_get_info(struct kempld_device_data *pld)
276{
277	int ret;
278	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
279	char major, minor;
280
281	ret = pdata->get_info(pld);
282	if (ret)
283		return ret;
284
285	/* The Kontron PLD firmware version string has the following format:
286	 * Pwxy.zzzz
287	 *   P:    Fixed
288	 *   w:    PLD number    - 1 hex digit
289	 *   x:    Major version - 1 alphanumerical digit (0-9A-V)
290	 *   y:    Minor version - 1 alphanumerical digit (0-9A-V)
291	 *   zzzz: Build number  - 4 zero padded hex digits */
292
293	if (pld->info.major < 10)
294		major = pld->info.major + '0';
295	else
296		major = (pld->info.major - 10) + 'A';
297	if (pld->info.minor < 10)
298		minor = pld->info.minor + '0';
299	else
300		minor = (pld->info.minor - 10) + 'A';
301
302	ret = scnprintf(pld->info.version, sizeof(pld->info.version),
303			"P%X%c%c.%04X", pld->info.number, major, minor,
304			pld->info.buildnr);
305	if (ret < 0)
306		return ret;
307
308	return 0;
309}
310
311/*
312 * kempld_register_cells - register cell drivers
313 *
314 * This function registers cell drivers for the detected hardware by calling
315 * the configured kempld_register_cells_XXXX function which is responsible
316 * to detect and register the needed cell drivers.
317 */
318static int kempld_register_cells(struct kempld_device_data *pld)
319{
320	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
321
322	return pdata->register_cells(pld);
323}
324
325static const char *kempld_get_type_string(struct kempld_device_data *pld)
326{
327	const char *version_type;
328
329	switch (pld->info.type) {
330	case 0:
331		version_type = "release";
332		break;
333	case 1:
334		version_type = "debug";
335		break;
336	case 2:
337		version_type = "custom";
338		break;
339	default:
340		version_type = "unspecified";
341		break;
342	}
343
344	return version_type;
345}
346
347static ssize_t pld_version_show(struct device *dev,
348				struct device_attribute *attr, char *buf)
349{
350	struct kempld_device_data *pld = dev_get_drvdata(dev);
351
352	return sysfs_emit(buf, "%s\n", pld->info.version);
353}
354
355static ssize_t pld_specification_show(struct device *dev,
356				      struct device_attribute *attr, char *buf)
357{
358	struct kempld_device_data *pld = dev_get_drvdata(dev);
359
360	return sysfs_emit(buf, "%d.%d\n", pld->info.spec_major, pld->info.spec_minor);
 
361}
362
363static ssize_t pld_type_show(struct device *dev,
364			     struct device_attribute *attr, char *buf)
365{
366	struct kempld_device_data *pld = dev_get_drvdata(dev);
367
368	return sysfs_emit(buf, "%s\n", kempld_get_type_string(pld));
369}
370
371static DEVICE_ATTR_RO(pld_version);
372static DEVICE_ATTR_RO(pld_specification);
373static DEVICE_ATTR_RO(pld_type);
 
374
375static struct attribute *pld_attributes[] = {
376	&dev_attr_pld_version.attr,
377	&dev_attr_pld_specification.attr,
378	&dev_attr_pld_type.attr,
379	NULL
380};
381
382static const struct attribute_group pld_attr_group = {
383	.attrs = pld_attributes,
384};
385
386static int kempld_detect_device(struct kempld_device_data *pld)
387{
388	u8 index_reg;
389	int ret;
390
391	mutex_lock(&pld->lock);
392
393	/* Check for empty IO space */
394	index_reg = ioread8(pld->io_index);
395	if (index_reg == 0xff && ioread8(pld->io_data) == 0xff) {
396		mutex_unlock(&pld->lock);
397		return -ENODEV;
398	}
399
400	/* Release hardware mutex if acquired */
401	if (!(index_reg & KEMPLD_MUTEX_KEY)) {
402		iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
403		/* PXT and COMe-cPC2 boards may require a second release */
404		iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
405	}
406
407	mutex_unlock(&pld->lock);
408
409	ret = kempld_get_info(pld);
410	if (ret)
411		return ret;
412
413	dev_info(pld->dev, "Found Kontron PLD - %s (%s), spec %d.%d\n",
414		 pld->info.version, kempld_get_type_string(pld),
415		 pld->info.spec_major, pld->info.spec_minor);
416
417	ret = sysfs_create_group(&pld->dev->kobj, &pld_attr_group);
418	if (ret)
419		return ret;
420
421	ret = kempld_register_cells(pld);
422	if (ret)
423		sysfs_remove_group(&pld->dev->kobj, &pld_attr_group);
424
425	return ret;
426}
427
428#ifdef CONFIG_ACPI
429static int kempld_get_acpi_data(struct platform_device *pdev)
430{
431	struct list_head resource_list;
432	struct resource *resources;
433	struct resource_entry *rentry;
434	struct device *dev = &pdev->dev;
435	struct acpi_device *acpi_dev = ACPI_COMPANION(dev);
436	const struct kempld_platform_data *pdata;
437	int ret;
438	int count;
439
440	pdata = acpi_device_get_match_data(dev);
441	ret = platform_device_add_data(pdev, pdata,
442				       sizeof(struct kempld_platform_data));
443	if (ret)
444		return ret;
445
446	INIT_LIST_HEAD(&resource_list);
447	ret = acpi_dev_get_resources(acpi_dev, &resource_list, NULL, NULL);
448	if (ret < 0)
449		goto out;
450
451	count = ret;
452
453	if (count == 0) {
454		ret = platform_device_add_resources(pdev, pdata->ioresource, 1);
455		goto out;
456	}
457
458	resources = devm_kcalloc(&acpi_dev->dev, count, sizeof(*resources),
459				 GFP_KERNEL);
460	if (!resources) {
461		ret = -ENOMEM;
462		goto out;
463	}
464
465	count = 0;
466	list_for_each_entry(rentry, &resource_list, node) {
467		memcpy(&resources[count], rentry->res,
468		       sizeof(*resources));
469		count++;
470	}
471	ret = platform_device_add_resources(pdev, resources, count);
472
473out:
474	acpi_dev_free_resource_list(&resource_list);
475
476	return ret;
477}
478#else
479static int kempld_get_acpi_data(struct platform_device *pdev)
480{
481	return -ENODEV;
482}
483#endif /* CONFIG_ACPI */
484
485static int kempld_probe(struct platform_device *pdev)
486{
487	const struct kempld_platform_data *pdata;
 
488	struct device *dev = &pdev->dev;
489	struct kempld_device_data *pld;
490	struct resource *ioport;
491	int ret;
492
493	if (kempld_pdev == NULL) {
494		/*
495		 * No kempld_pdev device has been registered in kempld_init,
496		 * so we seem to be probing an ACPI platform device.
497		 */
498		ret = kempld_get_acpi_data(pdev);
499		if (ret)
500			return ret;
501	} else if (kempld_pdev != pdev) {
502		/*
503		 * The platform device we are probing is not the one we
504		 * registered in kempld_init using the DMI table, so this one
505		 * comes from ACPI.
506		 * As we can only probe one - abort here and use the DMI
507		 * based one instead.
508		 */
509		dev_notice(dev, "platform device exists - not using ACPI\n");
510		return -ENODEV;
511	}
512	pdata = dev_get_platdata(dev);
513
514	pld = devm_kzalloc(dev, sizeof(*pld), GFP_KERNEL);
515	if (!pld)
516		return -ENOMEM;
517
518	ioport = platform_get_resource(pdev, IORESOURCE_IO, 0);
519	if (!ioport)
520		return -EINVAL;
521
522	pld->io_base = devm_ioport_map(dev, ioport->start,
523					resource_size(ioport));
524	if (!pld->io_base)
525		return -ENOMEM;
526
527	pld->io_index = pld->io_base;
528	pld->io_data = pld->io_base + 1;
529	pld->pld_clock = pdata->pld_clock;
530	pld->dev = dev;
531
532	mutex_init(&pld->lock);
533	platform_set_drvdata(pdev, pld);
534
535	return kempld_detect_device(pld);
536}
537
538static void kempld_remove(struct platform_device *pdev)
539{
540	struct kempld_device_data *pld = platform_get_drvdata(pdev);
541	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
542
543	sysfs_remove_group(&pld->dev->kobj, &pld_attr_group);
544
545	mfd_remove_devices(&pdev->dev);
546	pdata->release_hardware_mutex(pld);
547}
548
549#ifdef CONFIG_ACPI
550static const struct acpi_device_id kempld_acpi_table[] = {
551	{ "KEM0000", (kernel_ulong_t)&kempld_platform_data_generic },
552	{ "KEM0001", (kernel_ulong_t)&kempld_platform_data_generic },
553	{}
554};
555MODULE_DEVICE_TABLE(acpi, kempld_acpi_table);
556#endif
557
558static struct platform_driver kempld_driver = {
559	.driver		= {
560		.name	= "kempld",
561		.acpi_match_table = ACPI_PTR(kempld_acpi_table),
562	},
563	.probe		= kempld_probe,
564	.remove_new	= kempld_remove,
565};
566
567static const struct dmi_system_id kempld_dmi_table[] __initconst = {
568	{
569		.ident = "BBD6",
570		.matches = {
571			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
572			DMI_MATCH(DMI_BOARD_NAME, "COMe-bBD"),
573		},
574		.driver_data = (void *)&kempld_platform_data_generic,
575		.callback = kempld_create_platform_device,
576	}, {
577		.ident = "BBL6",
578		.matches = {
579			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
580			DMI_MATCH(DMI_BOARD_NAME, "COMe-bBL6"),
581		},
582		.driver_data = (void *)&kempld_platform_data_generic,
583		.callback = kempld_create_platform_device,
584	}, {
585		.ident = "BDV7",
586		.matches = {
587			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
588			DMI_MATCH(DMI_BOARD_NAME, "COMe-bDV7"),
589		},
590		.driver_data = (void *)&kempld_platform_data_generic,
591		.callback = kempld_create_platform_device,
592	}, {
593		.ident = "BHL6",
594		.matches = {
595			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
596			DMI_MATCH(DMI_BOARD_NAME, "COMe-bHL6"),
597		},
598		.driver_data = (void *)&kempld_platform_data_generic,
599		.callback = kempld_create_platform_device,
600	}, {
601		.ident = "BKL6",
602		.matches = {
603			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
604			DMI_MATCH(DMI_BOARD_NAME, "COMe-bKL6"),
605		},
606		.driver_data = (void *)&kempld_platform_data_generic,
607		.callback = kempld_create_platform_device,
608	}, {
609		.ident = "BSL6",
610		.matches = {
611			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
612			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSL6"),
613		},
614		.driver_data = (void *)&kempld_platform_data_generic,
615		.callback = kempld_create_platform_device,
616	}, {
617		.ident = "CAL6",
618		.matches = {
619			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
620			DMI_MATCH(DMI_BOARD_NAME, "COMe-cAL"),
621		},
622		.driver_data = (void *)&kempld_platform_data_generic,
623		.callback = kempld_create_platform_device,
624	}, {
625		.ident = "CBL6",
626		.matches = {
627			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
628			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBL6"),
629		},
630		.driver_data = (void *)&kempld_platform_data_generic,
631		.callback = kempld_create_platform_device,
632	}, {
633		.ident = "CBW6",
634		.matches = {
635			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
636			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBW6"),
637		},
638		.driver_data = (void *)&kempld_platform_data_generic,
639		.callback = kempld_create_platform_device,
640	}, {
641		.ident = "CCR2",
642		.matches = {
643			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
644			DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP2"),
645		},
646		.driver_data = (void *)&kempld_platform_data_generic,
647		.callback = kempld_create_platform_device,
648	}, {
649		.ident = "CCR6",
650		.matches = {
651			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
652			DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP6"),
653		},
654		.driver_data = (void *)&kempld_platform_data_generic,
655		.callback = kempld_create_platform_device,
656	}, {
657		.ident = "CDV7",
658		.matches = {
659			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
660			DMI_MATCH(DMI_BOARD_NAME, "COMe-cDV7"),
661		},
662		.driver_data = (void *)&kempld_platform_data_generic,
663		.callback = kempld_create_platform_device,
664	}, {
665		.ident = "CHL6",
666		.matches = {
667			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
668			DMI_MATCH(DMI_BOARD_NAME, "COMe-cHL6"),
669		},
670		.driver_data = (void *)&kempld_platform_data_generic,
671		.callback = kempld_create_platform_device,
672	}, {
673		.ident = "CHR2",
674		.matches = {
675			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
676			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T2"),
677		},
678		.driver_data = (void *)&kempld_platform_data_generic,
679		.callback = kempld_create_platform_device,
680	}, {
681		.ident = "CHR2",
682		.matches = {
683			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
684			DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T2"),
685		},
686		.driver_data = (void *)&kempld_platform_data_generic,
687		.callback = kempld_create_platform_device,
688	}, {
689		.ident = "CHR2",
690		.matches = {
691			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
692			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC2"),
693		},
694		.driver_data = (void *)&kempld_platform_data_generic,
695		.callback = kempld_create_platform_device,
696	}, {
697		.ident = "CHR6",
698		.matches = {
699			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
700			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T6"),
701		},
702		.driver_data = (void *)&kempld_platform_data_generic,
703		.callback = kempld_create_platform_device,
704	}, {
705		.ident = "CHR6",
706		.matches = {
707			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
708			DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T6"),
709		},
710		.driver_data = (void *)&kempld_platform_data_generic,
711		.callback = kempld_create_platform_device,
712	}, {
713		.ident = "CHR6",
714		.matches = {
715			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
716			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC6"),
717		},
718		.driver_data = (void *)&kempld_platform_data_generic,
719		.callback = kempld_create_platform_device,
720	}, {
721		.ident = "CKL6",
722		.matches = {
723			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
724			DMI_MATCH(DMI_BOARD_NAME, "COMe-cKL6"),
725		},
726		.driver_data = (void *)&kempld_platform_data_generic,
727		.callback = kempld_create_platform_device,
728	}, {
729		.ident = "CNTG",
730		.matches = {
731			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
732			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-PC"),
733		},
734		.driver_data = (void *)&kempld_platform_data_generic,
735		.callback = kempld_create_platform_device,
736	}, {
737		.ident = "CNTG",
738		.matches = {
739			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
740			DMI_MATCH(DMI_BOARD_NAME, "COMe-bPC2"),
741		},
742		.driver_data = (void *)&kempld_platform_data_generic,
743		.callback = kempld_create_platform_device,
744	}, {
745		.ident = "CNTX",
746		.matches = {
747			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
748			DMI_MATCH(DMI_BOARD_NAME, "PXT"),
749		},
750		.driver_data = (void *)&kempld_platform_data_generic,
751		.callback = kempld_create_platform_device,
752	}, {
753		.ident = "CSL6",
754		.matches = {
755			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
756			DMI_MATCH(DMI_BOARD_NAME, "COMe-cSL6"),
757		},
758		.driver_data = (void *)&kempld_platform_data_generic,
759		.callback = kempld_create_platform_device,
760	}, {
761		.ident = "CVV6",
762		.matches = {
763			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
764			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBT"),
765		},
766		.driver_data = (void *)&kempld_platform_data_generic,
767		.callback = kempld_create_platform_device,
768	}, {
769		.ident = "FRI2",
770		.matches = {
771			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
772			DMI_MATCH(DMI_BIOS_VERSION, "FRI2"),
773		},
774		.driver_data = (void *)&kempld_platform_data_generic,
775		.callback = kempld_create_platform_device,
776	}, {
777		.ident = "FRI2",
778		.matches = {
779			DMI_MATCH(DMI_PRODUCT_NAME, "Fish River Island II"),
780		},
781		.driver_data = (void *)&kempld_platform_data_generic,
782		.callback = kempld_create_platform_device,
783	}, {
784		.ident = "A203",
785		.matches = {
786			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
787			DMI_MATCH(DMI_BOARD_NAME, "KBox A-203"),
788		},
789		.driver_data = (void *)&kempld_platform_data_generic,
790		.callback = kempld_create_platform_device,
791	}, {
792		.ident = "M4A1",
793		.matches = {
794			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
795			DMI_MATCH(DMI_BOARD_NAME, "COMe-m4AL"),
796		},
797		.driver_data = (void *)&kempld_platform_data_generic,
798		.callback = kempld_create_platform_device,
799	}, {
800		.ident = "MAL1",
801		.matches = {
802			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
803			DMI_MATCH(DMI_BOARD_NAME, "COMe-mAL10"),
804		},
805		.driver_data = (void *)&kempld_platform_data_generic,
806		.callback = kempld_create_platform_device,
807	}, {
808		.ident = "MAPL",
809		.matches = {
810			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
811			DMI_MATCH(DMI_BOARD_NAME, "mITX-APL"),
812		},
813		.driver_data = (void *)&kempld_platform_data_generic,
814		.callback = kempld_create_platform_device,
815	}, {
816		.ident = "MBR1",
817		.matches = {
818			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
819			DMI_MATCH(DMI_BOARD_NAME, "ETX-OH"),
820		},
821		.driver_data = (void *)&kempld_platform_data_generic,
822		.callback = kempld_create_platform_device,
823	}, {
824		.ident = "MVV1",
825		.matches = {
826			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
827			DMI_MATCH(DMI_BOARD_NAME, "COMe-mBT"),
828		},
829		.driver_data = (void *)&kempld_platform_data_generic,
830		.callback = kempld_create_platform_device,
831	}, {
832		.ident = "NTC1",
833		.matches = {
834			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
835			DMI_MATCH(DMI_BOARD_NAME, "nanoETXexpress-TT"),
836		},
837		.driver_data = (void *)&kempld_platform_data_generic,
838		.callback = kempld_create_platform_device,
839	}, {
840		.ident = "NTC1",
841		.matches = {
842			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
843			DMI_MATCH(DMI_BOARD_NAME, "nETXe-TT"),
844		},
845		.driver_data = (void *)&kempld_platform_data_generic,
846		.callback = kempld_create_platform_device,
847	}, {
848		.ident = "NTC1",
849		.matches = {
850			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
851			DMI_MATCH(DMI_BOARD_NAME, "COMe-mTT"),
852		},
853		.driver_data = (void *)&kempld_platform_data_generic,
854		.callback = kempld_create_platform_device,
855	}, {
856		.ident = "NUP1",
857		.matches = {
858			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
859			DMI_MATCH(DMI_BOARD_NAME, "COMe-mCT"),
860		},
861		.driver_data = (void *)&kempld_platform_data_generic,
862		.callback = kempld_create_platform_device,
863	}, {
864		.ident = "PAPL",
865		.matches = {
866			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
867			DMI_MATCH(DMI_BOARD_NAME, "pITX-APL"),
868		},
869		.driver_data = (void *)&kempld_platform_data_generic,
870		.callback = kempld_create_platform_device,
871	}, {
872		.ident = "SXAL",
873		.matches = {
874			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
875			DMI_MATCH(DMI_BOARD_NAME, "SMARC-sXAL"),
876		},
877		.driver_data = (void *)&kempld_platform_data_generic,
878		.callback = kempld_create_platform_device,
879	}, {
880		.ident = "SXAL4",
881		.matches = {
882			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
883			DMI_MATCH(DMI_BOARD_NAME, "SMARC-sXA4"),
884		},
885		.driver_data = (void *)&kempld_platform_data_generic,
886		.callback = kempld_create_platform_device,
887	}, {
888		.ident = "UNP1",
889		.matches = {
890			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
891			DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-DC"),
892		},
893		.driver_data = (void *)&kempld_platform_data_generic,
894		.callback = kempld_create_platform_device,
895	}, {
896		.ident = "UNP1",
897		.matches = {
898			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
899			DMI_MATCH(DMI_BOARD_NAME, "COMe-cDC2"),
900		},
901		.driver_data = (void *)&kempld_platform_data_generic,
902		.callback = kempld_create_platform_device,
903	}, {
904		.ident = "UNTG",
905		.matches = {
906			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
907			DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-PC"),
908		},
909		.driver_data = (void *)&kempld_platform_data_generic,
910		.callback = kempld_create_platform_device,
911	}, {
912		.ident = "UNTG",
913		.matches = {
914			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
915			DMI_MATCH(DMI_BOARD_NAME, "COMe-cPC2"),
916		},
917		.driver_data = (void *)&kempld_platform_data_generic,
918		.callback = kempld_create_platform_device,
919	}, {
920		.ident = "UUP6",
921		.matches = {
922			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
923			DMI_MATCH(DMI_BOARD_NAME, "COMe-cCT6"),
924		},
925		.driver_data = (void *)&kempld_platform_data_generic,
926		.callback = kempld_create_platform_device,
927	}, {
 
928		.ident = "UTH6",
929		.matches = {
930			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
931			DMI_MATCH(DMI_BOARD_NAME, "COMe-cTH6"),
932		},
933		.driver_data = (void *)&kempld_platform_data_generic,
934		.callback = kempld_create_platform_device,
935	}, {
936		.ident = "Q7AL",
937		.matches = {
938			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
939			DMI_MATCH(DMI_BOARD_NAME, "Qseven-Q7AL"),
940		},
941		.driver_data = (void *)&kempld_platform_data_generic,
942		.callback = kempld_create_platform_device,
943	},
944	{}
945};
946MODULE_DEVICE_TABLE(dmi, kempld_dmi_table);
947
948static int __init kempld_init(void)
949{
950	const struct dmi_system_id *id;
951
952	if (force_device_id[0]) {
953		for (id = kempld_dmi_table;
954		     id->matches[0].slot != DMI_NONE; id++)
955			if (strstr(id->ident, force_device_id))
956				if (id->callback && !id->callback(id))
957					break;
958		if (id->matches[0].slot == DMI_NONE)
959			return -ENODEV;
960	} else {
961		dmi_check_system(kempld_dmi_table);
 
962	}
963
964	return platform_driver_register(&kempld_driver);
965}
966
967static void __exit kempld_exit(void)
968{
969	if (kempld_pdev)
970		platform_device_unregister(kempld_pdev);
971
972	platform_driver_unregister(&kempld_driver);
973}
974
975module_init(kempld_init);
976module_exit(kempld_exit);
977
978MODULE_DESCRIPTION("KEM PLD Core Driver");
979MODULE_AUTHOR("Michael Brunner <michael.brunner@kontron.com>");
980MODULE_LICENSE("GPL");
981MODULE_ALIAS("platform:kempld-core");
v5.9
  1// SPDX-License-Identifier: GPL-2.0-only
  2/*
  3 * Kontron PLD MFD core driver
  4 *
  5 * Copyright (c) 2010-2013 Kontron Europe GmbH
  6 * Author: Michael Brunner <michael.brunner@kontron.com>
  7 */
  8
  9#include <linux/platform_device.h>
 10#include <linux/mfd/core.h>
 11#include <linux/mfd/kempld.h>
 12#include <linux/module.h>
 13#include <linux/dmi.h>
 14#include <linux/io.h>
 15#include <linux/delay.h>
 
 16
 17#define MAX_ID_LEN 4
 18static char force_device_id[MAX_ID_LEN + 1] = "";
 19module_param_string(force_device_id, force_device_id,
 20		    sizeof(force_device_id), 0);
 21MODULE_PARM_DESC(force_device_id, "Override detected product");
 22
 23/*
 24 * Get hardware mutex to block firmware from accessing the pld.
 25 * It is possible for the firmware may hold the mutex for an extended length of
 26 * time. This function will block until access has been granted.
 27 */
 28static void kempld_get_hardware_mutex(struct kempld_device_data *pld)
 29{
 30	/* The mutex bit will read 1 until access has been granted */
 31	while (ioread8(pld->io_index) & KEMPLD_MUTEX_KEY)
 32		usleep_range(1000, 3000);
 33}
 34
 35static void kempld_release_hardware_mutex(struct kempld_device_data *pld)
 36{
 37	/* The harware mutex is released when 1 is written to the mutex bit. */
 38	iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
 39}
 40
 41static int kempld_get_info_generic(struct kempld_device_data *pld)
 42{
 43	u16 version;
 44	u8 spec;
 45
 46	kempld_get_mutex(pld);
 47
 48	version = kempld_read16(pld, KEMPLD_VERSION);
 49	spec = kempld_read8(pld, KEMPLD_SPEC);
 50	pld->info.buildnr = kempld_read16(pld, KEMPLD_BUILDNR);
 51
 52	pld->info.minor = KEMPLD_VERSION_GET_MINOR(version);
 53	pld->info.major = KEMPLD_VERSION_GET_MAJOR(version);
 54	pld->info.number = KEMPLD_VERSION_GET_NUMBER(version);
 55	pld->info.type = KEMPLD_VERSION_GET_TYPE(version);
 56
 57	if (spec == 0xff) {
 58		pld->info.spec_minor = 0;
 59		pld->info.spec_major = 1;
 60	} else {
 61		pld->info.spec_minor = KEMPLD_SPEC_GET_MINOR(spec);
 62		pld->info.spec_major = KEMPLD_SPEC_GET_MAJOR(spec);
 63	}
 64
 65	if (pld->info.spec_major > 0)
 66		pld->feature_mask = kempld_read16(pld, KEMPLD_FEATURE);
 67	else
 68		pld->feature_mask = 0;
 69
 70	kempld_release_mutex(pld);
 71
 72	return 0;
 73}
 74
 75enum kempld_cells {
 76	KEMPLD_I2C = 0,
 77	KEMPLD_WDT,
 78	KEMPLD_GPIO,
 79	KEMPLD_UART,
 80};
 81
 82static const char *kempld_dev_names[] = {
 83	[KEMPLD_I2C] = "kempld-i2c",
 84	[KEMPLD_WDT] = "kempld-wdt",
 85	[KEMPLD_GPIO] = "kempld-gpio",
 86	[KEMPLD_UART] = "kempld-uart",
 87};
 88
 89#define KEMPLD_MAX_DEVS	ARRAY_SIZE(kempld_dev_names)
 90
 91static int kempld_register_cells_generic(struct kempld_device_data *pld)
 92{
 93	struct mfd_cell devs[KEMPLD_MAX_DEVS] = {};
 94	int i = 0;
 95
 96	if (pld->feature_mask & KEMPLD_FEATURE_BIT_I2C)
 97		devs[i++].name = kempld_dev_names[KEMPLD_I2C];
 98
 99	if (pld->feature_mask & KEMPLD_FEATURE_BIT_WATCHDOG)
100		devs[i++].name = kempld_dev_names[KEMPLD_WDT];
101
102	if (pld->feature_mask & KEMPLD_FEATURE_BIT_GPIO)
103		devs[i++].name = kempld_dev_names[KEMPLD_GPIO];
104
105	if (pld->feature_mask & KEMPLD_FEATURE_MASK_UART)
106		devs[i++].name = kempld_dev_names[KEMPLD_UART];
107
108	return mfd_add_devices(pld->dev, -1, devs, i, NULL, 0, NULL);
109}
110
111static struct resource kempld_ioresource = {
112	.start	= KEMPLD_IOINDEX,
113	.end	= KEMPLD_IODATA,
114	.flags	= IORESOURCE_IO,
115};
116
117static const struct kempld_platform_data kempld_platform_data_generic = {
118	.pld_clock		= KEMPLD_CLK,
119	.ioresource		= &kempld_ioresource,
120	.get_hardware_mutex	= kempld_get_hardware_mutex,
121	.release_hardware_mutex	= kempld_release_hardware_mutex,
122	.get_info		= kempld_get_info_generic,
123	.register_cells		= kempld_register_cells_generic,
124};
125
126static struct platform_device *kempld_pdev;
127
128static int kempld_create_platform_device(const struct dmi_system_id *id)
129{
130	const struct kempld_platform_data *pdata = id->driver_data;
131	int ret;
132
133	kempld_pdev = platform_device_alloc("kempld", -1);
134	if (!kempld_pdev)
135		return -ENOMEM;
136
137	ret = platform_device_add_data(kempld_pdev, pdata, sizeof(*pdata));
138	if (ret)
139		goto err;
140
141	ret = platform_device_add_resources(kempld_pdev, pdata->ioresource, 1);
142	if (ret)
143		goto err;
144
145	ret = platform_device_add(kempld_pdev);
146	if (ret)
147		goto err;
148
149	return 0;
150err:
151	platform_device_put(kempld_pdev);
152	return ret;
153}
154
155/**
156 * kempld_read8 - read 8 bit register
157 * @pld: kempld_device_data structure describing the PLD
158 * @index: register index on the chip
159 *
160 * kempld_get_mutex must be called prior to calling this function.
161 */
162u8 kempld_read8(struct kempld_device_data *pld, u8 index)
163{
164	iowrite8(index, pld->io_index);
165	return ioread8(pld->io_data);
166}
167EXPORT_SYMBOL_GPL(kempld_read8);
168
169/**
170 * kempld_write8 - write 8 bit register
171 * @pld: kempld_device_data structure describing the PLD
172 * @index: register index on the chip
173 * @data: new register value
174 *
175 * kempld_get_mutex must be called prior to calling this function.
176 */
177void kempld_write8(struct kempld_device_data *pld, u8 index, u8 data)
178{
179	iowrite8(index, pld->io_index);
180	iowrite8(data, pld->io_data);
181}
182EXPORT_SYMBOL_GPL(kempld_write8);
183
184/**
185 * kempld_read16 - read 16 bit register
186 * @pld: kempld_device_data structure describing the PLD
187 * @index: register index on the chip
188 *
189 * kempld_get_mutex must be called prior to calling this function.
190 */
191u16 kempld_read16(struct kempld_device_data *pld, u8 index)
192{
193	return kempld_read8(pld, index) | kempld_read8(pld, index + 1) << 8;
194}
195EXPORT_SYMBOL_GPL(kempld_read16);
196
197/**
198 * kempld_write16 - write 16 bit register
199 * @pld: kempld_device_data structure describing the PLD
200 * @index: register index on the chip
201 * @data: new register value
202 *
203 * kempld_get_mutex must be called prior to calling this function.
204 */
205void kempld_write16(struct kempld_device_data *pld, u8 index, u16 data)
206{
207	kempld_write8(pld, index, (u8)data);
208	kempld_write8(pld, index + 1, (u8)(data >> 8));
209}
210EXPORT_SYMBOL_GPL(kempld_write16);
211
212/**
213 * kempld_read32 - read 32 bit register
214 * @pld: kempld_device_data structure describing the PLD
215 * @index: register index on the chip
216 *
217 * kempld_get_mutex must be called prior to calling this function.
218 */
219u32 kempld_read32(struct kempld_device_data *pld, u8 index)
220{
221	return kempld_read16(pld, index) | kempld_read16(pld, index + 2) << 16;
222}
223EXPORT_SYMBOL_GPL(kempld_read32);
224
225/**
226 * kempld_write32 - write 32 bit register
227 * @pld: kempld_device_data structure describing the PLD
228 * @index: register index on the chip
229 * @data: new register value
230 *
231 * kempld_get_mutex must be called prior to calling this function.
232 */
233void kempld_write32(struct kempld_device_data *pld, u8 index, u32 data)
234{
235	kempld_write16(pld, index, (u16)data);
236	kempld_write16(pld, index + 2, (u16)(data >> 16));
237}
238EXPORT_SYMBOL_GPL(kempld_write32);
239
240/**
241 * kempld_get_mutex - acquire PLD mutex
242 * @pld: kempld_device_data structure describing the PLD
243 */
244void kempld_get_mutex(struct kempld_device_data *pld)
245{
246	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
247
248	mutex_lock(&pld->lock);
249	pdata->get_hardware_mutex(pld);
250}
251EXPORT_SYMBOL_GPL(kempld_get_mutex);
252
253/**
254 * kempld_release_mutex - release PLD mutex
255 * @pld: kempld_device_data structure describing the PLD
256 */
257void kempld_release_mutex(struct kempld_device_data *pld)
258{
259	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
260
261	pdata->release_hardware_mutex(pld);
262	mutex_unlock(&pld->lock);
263}
264EXPORT_SYMBOL_GPL(kempld_release_mutex);
265
266/**
267 * kempld_get_info - update device specific information
268 * @pld: kempld_device_data structure describing the PLD
269 *
270 * This function calls the configured board specific kempld_get_info_XXXX
271 * function which is responsible for gathering information about the specific
272 * hardware. The information is then stored within the pld structure.
273 */
274static int kempld_get_info(struct kempld_device_data *pld)
275{
276	int ret;
277	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
278	char major, minor;
279
280	ret = pdata->get_info(pld);
281	if (ret)
282		return ret;
283
284	/* The Kontron PLD firmware version string has the following format:
285	 * Pwxy.zzzz
286	 *   P:    Fixed
287	 *   w:    PLD number    - 1 hex digit
288	 *   x:    Major version - 1 alphanumerical digit (0-9A-V)
289	 *   y:    Minor version - 1 alphanumerical digit (0-9A-V)
290	 *   zzzz: Build number  - 4 zero padded hex digits */
291
292	if (pld->info.major < 10)
293		major = pld->info.major + '0';
294	else
295		major = (pld->info.major - 10) + 'A';
296	if (pld->info.minor < 10)
297		minor = pld->info.minor + '0';
298	else
299		minor = (pld->info.minor - 10) + 'A';
300
301	ret = scnprintf(pld->info.version, sizeof(pld->info.version),
302			"P%X%c%c.%04X", pld->info.number, major, minor,
303			pld->info.buildnr);
304	if (ret < 0)
305		return ret;
306
307	return 0;
308}
309
310/*
311 * kempld_register_cells - register cell drivers
312 *
313 * This function registers cell drivers for the detected hardware by calling
314 * the configured kempld_register_cells_XXXX function which is responsible
315 * to detect and register the needed cell drivers.
316 */
317static int kempld_register_cells(struct kempld_device_data *pld)
318{
319	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
320
321	return pdata->register_cells(pld);
322}
323
324static const char *kempld_get_type_string(struct kempld_device_data *pld)
325{
326	const char *version_type;
327
328	switch (pld->info.type) {
329	case 0:
330		version_type = "release";
331		break;
332	case 1:
333		version_type = "debug";
334		break;
335	case 2:
336		version_type = "custom";
337		break;
338	default:
339		version_type = "unspecified";
340		break;
341	}
342
343	return version_type;
344}
345
346static ssize_t kempld_version_show(struct device *dev,
347		struct device_attribute *attr, char *buf)
348{
349	struct kempld_device_data *pld = dev_get_drvdata(dev);
350
351	return scnprintf(buf, PAGE_SIZE, "%s\n", pld->info.version);
352}
353
354static ssize_t kempld_specification_show(struct device *dev,
355		struct device_attribute *attr, char *buf)
356{
357	struct kempld_device_data *pld = dev_get_drvdata(dev);
358
359	return scnprintf(buf, PAGE_SIZE, "%d.%d\n", pld->info.spec_major,
360		       pld->info.spec_minor);
361}
362
363static ssize_t kempld_type_show(struct device *dev,
364		struct device_attribute *attr, char *buf)
365{
366	struct kempld_device_data *pld = dev_get_drvdata(dev);
367
368	return scnprintf(buf, PAGE_SIZE, "%s\n", kempld_get_type_string(pld));
369}
370
371static DEVICE_ATTR(pld_version, S_IRUGO, kempld_version_show, NULL);
372static DEVICE_ATTR(pld_specification, S_IRUGO, kempld_specification_show,
373		   NULL);
374static DEVICE_ATTR(pld_type, S_IRUGO, kempld_type_show, NULL);
375
376static struct attribute *pld_attributes[] = {
377	&dev_attr_pld_version.attr,
378	&dev_attr_pld_specification.attr,
379	&dev_attr_pld_type.attr,
380	NULL
381};
382
383static const struct attribute_group pld_attr_group = {
384	.attrs = pld_attributes,
385};
386
387static int kempld_detect_device(struct kempld_device_data *pld)
388{
389	u8 index_reg;
390	int ret;
391
392	mutex_lock(&pld->lock);
393
394	/* Check for empty IO space */
395	index_reg = ioread8(pld->io_index);
396	if (index_reg == 0xff && ioread8(pld->io_data) == 0xff) {
397		mutex_unlock(&pld->lock);
398		return -ENODEV;
399	}
400
401	/* Release hardware mutex if acquired */
402	if (!(index_reg & KEMPLD_MUTEX_KEY)) {
403		iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
404		/* PXT and COMe-cPC2 boards may require a second release */
405		iowrite8(KEMPLD_MUTEX_KEY, pld->io_index);
406	}
407
408	mutex_unlock(&pld->lock);
409
410	ret = kempld_get_info(pld);
411	if (ret)
412		return ret;
413
414	dev_info(pld->dev, "Found Kontron PLD - %s (%s), spec %d.%d\n",
415		 pld->info.version, kempld_get_type_string(pld),
416		 pld->info.spec_major, pld->info.spec_minor);
417
418	ret = sysfs_create_group(&pld->dev->kobj, &pld_attr_group);
419	if (ret)
420		return ret;
421
422	ret = kempld_register_cells(pld);
423	if (ret)
424		sysfs_remove_group(&pld->dev->kobj, &pld_attr_group);
425
426	return ret;
427}
428
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
429static int kempld_probe(struct platform_device *pdev)
430{
431	const struct kempld_platform_data *pdata =
432		dev_get_platdata(&pdev->dev);
433	struct device *dev = &pdev->dev;
434	struct kempld_device_data *pld;
435	struct resource *ioport;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
436
437	pld = devm_kzalloc(dev, sizeof(*pld), GFP_KERNEL);
438	if (!pld)
439		return -ENOMEM;
440
441	ioport = platform_get_resource(pdev, IORESOURCE_IO, 0);
442	if (!ioport)
443		return -EINVAL;
444
445	pld->io_base = devm_ioport_map(dev, ioport->start,
446					resource_size(ioport));
447	if (!pld->io_base)
448		return -ENOMEM;
449
450	pld->io_index = pld->io_base;
451	pld->io_data = pld->io_base + 1;
452	pld->pld_clock = pdata->pld_clock;
453	pld->dev = dev;
454
455	mutex_init(&pld->lock);
456	platform_set_drvdata(pdev, pld);
457
458	return kempld_detect_device(pld);
459}
460
461static int kempld_remove(struct platform_device *pdev)
462{
463	struct kempld_device_data *pld = platform_get_drvdata(pdev);
464	const struct kempld_platform_data *pdata = dev_get_platdata(pld->dev);
465
466	sysfs_remove_group(&pld->dev->kobj, &pld_attr_group);
467
468	mfd_remove_devices(&pdev->dev);
469	pdata->release_hardware_mutex(pld);
 
470
471	return 0;
472}
 
 
 
 
 
 
473
474static struct platform_driver kempld_driver = {
475	.driver		= {
476		.name	= "kempld",
 
477	},
478	.probe		= kempld_probe,
479	.remove		= kempld_remove,
480};
481
482static const struct dmi_system_id kempld_dmi_table[] __initconst = {
483	{
484		.ident = "BBD6",
485		.matches = {
486			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
487			DMI_MATCH(DMI_BOARD_NAME, "COMe-bBD"),
488		},
489		.driver_data = (void *)&kempld_platform_data_generic,
490		.callback = kempld_create_platform_device,
491	}, {
492		.ident = "BBL6",
493		.matches = {
494			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
495			DMI_MATCH(DMI_BOARD_NAME, "COMe-bBL6"),
496		},
497		.driver_data = (void *)&kempld_platform_data_generic,
498		.callback = kempld_create_platform_device,
499	}, {
 
 
 
 
 
 
 
 
500		.ident = "BHL6",
501		.matches = {
502			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
503			DMI_MATCH(DMI_BOARD_NAME, "COMe-bHL6"),
504		},
505		.driver_data = (void *)&kempld_platform_data_generic,
506		.callback = kempld_create_platform_device,
507	}, {
508		.ident = "BKL6",
509		.matches = {
510			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
511			DMI_MATCH(DMI_BOARD_NAME, "COMe-bKL6"),
512		},
513		.driver_data = (void *)&kempld_platform_data_generic,
514		.callback = kempld_create_platform_device,
515	}, {
516		.ident = "BSL6",
517		.matches = {
518			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
519			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSL6"),
520		},
521		.driver_data = (void *)&kempld_platform_data_generic,
522		.callback = kempld_create_platform_device,
523	}, {
524		.ident = "CAL6",
525		.matches = {
526			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
527			DMI_MATCH(DMI_BOARD_NAME, "COMe-cAL"),
528		},
529		.driver_data = (void *)&kempld_platform_data_generic,
530		.callback = kempld_create_platform_device,
531	}, {
532		.ident = "CBL6",
533		.matches = {
534			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
535			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBL6"),
536		},
537		.driver_data = (void *)&kempld_platform_data_generic,
538		.callback = kempld_create_platform_device,
539	}, {
540		.ident = "CBW6",
541		.matches = {
542			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
543			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBW6"),
544		},
545		.driver_data = (void *)&kempld_platform_data_generic,
546		.callback = kempld_create_platform_device,
547	}, {
548		.ident = "CCR2",
549		.matches = {
550			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
551			DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP2"),
552		},
553		.driver_data = (void *)&kempld_platform_data_generic,
554		.callback = kempld_create_platform_device,
555	}, {
556		.ident = "CCR6",
557		.matches = {
558			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
559			DMI_MATCH(DMI_BOARD_NAME, "COMe-bIP6"),
560		},
561		.driver_data = (void *)&kempld_platform_data_generic,
562		.callback = kempld_create_platform_device,
563	}, {
 
 
 
 
 
 
 
 
564		.ident = "CHL6",
565		.matches = {
566			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
567			DMI_MATCH(DMI_BOARD_NAME, "COMe-cHL6"),
568		},
569		.driver_data = (void *)&kempld_platform_data_generic,
570		.callback = kempld_create_platform_device,
571	}, {
572		.ident = "CHR2",
573		.matches = {
574			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
575			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T2"),
576		},
577		.driver_data = (void *)&kempld_platform_data_generic,
578		.callback = kempld_create_platform_device,
579	}, {
580		.ident = "CHR2",
581		.matches = {
582			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
583			DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T2"),
584		},
585		.driver_data = (void *)&kempld_platform_data_generic,
586		.callback = kempld_create_platform_device,
587	}, {
588		.ident = "CHR2",
589		.matches = {
590			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
591			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC2"),
592		},
593		.driver_data = (void *)&kempld_platform_data_generic,
594		.callback = kempld_create_platform_device,
595	}, {
596		.ident = "CHR6",
597		.matches = {
598			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
599			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-SC T6"),
600		},
601		.driver_data = (void *)&kempld_platform_data_generic,
602		.callback = kempld_create_platform_device,
603	}, {
604		.ident = "CHR6",
605		.matches = {
606			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
607			DMI_MATCH(DMI_BOARD_NAME, "ETXe-SC T6"),
608		},
609		.driver_data = (void *)&kempld_platform_data_generic,
610		.callback = kempld_create_platform_device,
611	}, {
612		.ident = "CHR6",
613		.matches = {
614			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
615			DMI_MATCH(DMI_BOARD_NAME, "COMe-bSC6"),
616		},
617		.driver_data = (void *)&kempld_platform_data_generic,
618		.callback = kempld_create_platform_device,
619	}, {
620		.ident = "CKL6",
621		.matches = {
622			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
623			DMI_MATCH(DMI_BOARD_NAME, "COMe-cKL6"),
624		},
625		.driver_data = (void *)&kempld_platform_data_generic,
626		.callback = kempld_create_platform_device,
627	}, {
628		.ident = "CNTG",
629		.matches = {
630			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
631			DMI_MATCH(DMI_BOARD_NAME, "ETXexpress-PC"),
632		},
633		.driver_data = (void *)&kempld_platform_data_generic,
634		.callback = kempld_create_platform_device,
635	}, {
636		.ident = "CNTG",
637		.matches = {
638			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
639			DMI_MATCH(DMI_BOARD_NAME, "COMe-bPC2"),
640		},
641		.driver_data = (void *)&kempld_platform_data_generic,
642		.callback = kempld_create_platform_device,
643	}, {
644		.ident = "CNTX",
645		.matches = {
646			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
647			DMI_MATCH(DMI_BOARD_NAME, "PXT"),
648		},
649		.driver_data = (void *)&kempld_platform_data_generic,
650		.callback = kempld_create_platform_device,
651	}, {
652		.ident = "CSL6",
653		.matches = {
654			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
655			DMI_MATCH(DMI_BOARD_NAME, "COMe-cSL6"),
656		},
657		.driver_data = (void *)&kempld_platform_data_generic,
658		.callback = kempld_create_platform_device,
659	}, {
660		.ident = "CVV6",
661		.matches = {
662			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
663			DMI_MATCH(DMI_BOARD_NAME, "COMe-cBT"),
664		},
665		.driver_data = (void *)&kempld_platform_data_generic,
666		.callback = kempld_create_platform_device,
667	}, {
668		.ident = "FRI2",
669		.matches = {
670			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
671			DMI_MATCH(DMI_BIOS_VERSION, "FRI2"),
672		},
673		.driver_data = (void *)&kempld_platform_data_generic,
674		.callback = kempld_create_platform_device,
675	}, {
676		.ident = "FRI2",
677		.matches = {
678			DMI_MATCH(DMI_PRODUCT_NAME, "Fish River Island II"),
679		},
680		.driver_data = (void *)&kempld_platform_data_generic,
681		.callback = kempld_create_platform_device,
682	}, {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
683		.ident = "MAL1",
684		.matches = {
685			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
686			DMI_MATCH(DMI_BOARD_NAME, "COMe-mAL10"),
687		},
688		.driver_data = (void *)&kempld_platform_data_generic,
689		.callback = kempld_create_platform_device,
690	}, {
 
 
 
 
 
 
 
 
691		.ident = "MBR1",
692		.matches = {
693			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
694			DMI_MATCH(DMI_BOARD_NAME, "ETX-OH"),
695		},
696		.driver_data = (void *)&kempld_platform_data_generic,
697		.callback = kempld_create_platform_device,
698	}, {
699		.ident = "MVV1",
700		.matches = {
701			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
702			DMI_MATCH(DMI_BOARD_NAME, "COMe-mBT"),
703		},
704		.driver_data = (void *)&kempld_platform_data_generic,
705		.callback = kempld_create_platform_device,
706	}, {
707		.ident = "NTC1",
708		.matches = {
709			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
710			DMI_MATCH(DMI_BOARD_NAME, "nanoETXexpress-TT"),
711		},
712		.driver_data = (void *)&kempld_platform_data_generic,
713		.callback = kempld_create_platform_device,
714	}, {
715		.ident = "NTC1",
716		.matches = {
717			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
718			DMI_MATCH(DMI_BOARD_NAME, "nETXe-TT"),
719		},
720		.driver_data = (void *)&kempld_platform_data_generic,
721		.callback = kempld_create_platform_device,
722	}, {
723		.ident = "NTC1",
724		.matches = {
725			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
726			DMI_MATCH(DMI_BOARD_NAME, "COMe-mTT"),
727		},
728		.driver_data = (void *)&kempld_platform_data_generic,
729		.callback = kempld_create_platform_device,
730	}, {
731		.ident = "NUP1",
732		.matches = {
733			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
734			DMI_MATCH(DMI_BOARD_NAME, "COMe-mCT"),
735		},
736		.driver_data = (void *)&kempld_platform_data_generic,
737		.callback = kempld_create_platform_device,
738	}, {
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
739		.ident = "UNP1",
740		.matches = {
741			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
742			DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-DC"),
743		},
744		.driver_data = (void *)&kempld_platform_data_generic,
745		.callback = kempld_create_platform_device,
746	}, {
747		.ident = "UNP1",
748		.matches = {
749			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
750			DMI_MATCH(DMI_BOARD_NAME, "COMe-cDC2"),
751		},
752		.driver_data = (void *)&kempld_platform_data_generic,
753		.callback = kempld_create_platform_device,
754	}, {
755		.ident = "UNTG",
756		.matches = {
757			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
758			DMI_MATCH(DMI_BOARD_NAME, "microETXexpress-PC"),
759		},
760		.driver_data = (void *)&kempld_platform_data_generic,
761		.callback = kempld_create_platform_device,
762	}, {
763		.ident = "UNTG",
764		.matches = {
765			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
766			DMI_MATCH(DMI_BOARD_NAME, "COMe-cPC2"),
767		},
768		.driver_data = (void *)&kempld_platform_data_generic,
769		.callback = kempld_create_platform_device,
770	}, {
771		.ident = "UUP6",
772		.matches = {
773			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
774			DMI_MATCH(DMI_BOARD_NAME, "COMe-cCT6"),
775		},
776		.driver_data = (void *)&kempld_platform_data_generic,
777		.callback = kempld_create_platform_device,
778	},
779	{
780		.ident = "UTH6",
781		.matches = {
782			DMI_MATCH(DMI_BOARD_VENDOR, "Kontron"),
783			DMI_MATCH(DMI_BOARD_NAME, "COMe-cTH6"),
784		},
785		.driver_data = (void *)&kempld_platform_data_generic,
786		.callback = kempld_create_platform_device,
 
 
 
 
 
 
 
 
787	},
788	{}
789};
790MODULE_DEVICE_TABLE(dmi, kempld_dmi_table);
791
792static int __init kempld_init(void)
793{
794	const struct dmi_system_id *id;
795
796	if (force_device_id[0]) {
797		for (id = kempld_dmi_table;
798		     id->matches[0].slot != DMI_NONE; id++)
799			if (strstr(id->ident, force_device_id))
800				if (id->callback && !id->callback(id))
801					break;
802		if (id->matches[0].slot == DMI_NONE)
803			return -ENODEV;
804	} else {
805		if (!dmi_check_system(kempld_dmi_table))
806			return -ENODEV;
807	}
808
809	return platform_driver_register(&kempld_driver);
810}
811
812static void __exit kempld_exit(void)
813{
814	if (kempld_pdev)
815		platform_device_unregister(kempld_pdev);
816
817	platform_driver_unregister(&kempld_driver);
818}
819
820module_init(kempld_init);
821module_exit(kempld_exit);
822
823MODULE_DESCRIPTION("KEM PLD Core Driver");
824MODULE_AUTHOR("Michael Brunner <michael.brunner@kontron.com>");
825MODULE_LICENSE("GPL");
826MODULE_ALIAS("platform:kempld-core");