xref: /linux/drivers/gpio/gpio-f7188x.c (revision e58e871becec2d3b04ed91c0c16fe8deac9c9dfa) 
1 /*
2  * GPIO driver for Fintek Super-I/O F71869, F71869A, F71882, F71889 and F81866
3  *
4  * Copyright (C) 2010-2013 LaCie
5  *
6  * Author: Simon Guinot <simon.guinot@sequanux.org>
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  */
13 
14 #include <linux/module.h>
15 #include <linux/init.h>
16 #include <linux/platform_device.h>
17 #include <linux/io.h>
18 #include <linux/gpio/driver.h>
19 #include <linux/bitops.h>
20 
21 #define DRVNAME "gpio-f7188x"
22 
23 /*
24  * Super-I/O registers
25  */
26 #define SIO_LDSEL		0x07	/* Logical device select */
27 #define SIO_DEVID		0x20	/* Device ID (2 bytes) */
28 #define SIO_DEVREV		0x22	/* Device revision */
29 #define SIO_MANID		0x23	/* Fintek ID (2 bytes) */
30 
31 #define SIO_LD_GPIO		0x06	/* GPIO logical device */
32 #define SIO_UNLOCK_KEY		0x87	/* Key to enable Super-I/O */
33 #define SIO_LOCK_KEY		0xAA	/* Key to disable Super-I/O */
34 
35 #define SIO_FINTEK_ID		0x1934	/* Manufacturer ID */
36 #define SIO_F71869_ID		0x0814	/* F71869 chipset ID */
37 #define SIO_F71869A_ID		0x1007	/* F71869A chipset ID */
38 #define SIO_F71882_ID		0x0541	/* F71882 chipset ID */
39 #define SIO_F71889_ID		0x0909	/* F71889 chipset ID */
40 #define SIO_F71889A_ID		0x1005	/* F71889A chipset ID */
41 #define SIO_F81866_ID		0x1010	/* F81866 chipset ID */
42 
43 enum chips { f71869, f71869a, f71882fg, f71889a, f71889f, f81866 };
44 
45 static const char * const f7188x_names[] = {
46 	"f71869",
47 	"f71869a",
48 	"f71882fg",
49 	"f71889a",
50 	"f71889f",
51 	"f81866",
52 };
53 
54 struct f7188x_sio {
55 	int addr;
56 	enum chips type;
57 };
58 
59 struct f7188x_gpio_bank {
60 	struct gpio_chip chip;
61 	unsigned int regbase;
62 	struct f7188x_gpio_data *data;
63 };
64 
65 struct f7188x_gpio_data {
66 	struct f7188x_sio *sio;
67 	int nr_bank;
68 	struct f7188x_gpio_bank *bank;
69 };
70 
71 /*
72  * Super-I/O functions.
73  */
74 
75 static inline int superio_inb(int base, int reg)
76 {
77 	outb(reg, base);
78 	return inb(base + 1);
79 }
80 
81 static int superio_inw(int base, int reg)
82 {
83 	int val;
84 
85 	outb(reg++, base);
86 	val = inb(base + 1) << 8;
87 	outb(reg, base);
88 	val |= inb(base + 1);
89 
90 	return val;
91 }
92 
93 static inline void superio_outb(int base, int reg, int val)
94 {
95 	outb(reg, base);
96 	outb(val, base + 1);
97 }
98 
99 static inline int superio_enter(int base)
100 {
101 	/* Don't step on other drivers' I/O space by accident. */
102 	if (!request_muxed_region(base, 2, DRVNAME)) {
103 		pr_err(DRVNAME "I/O address 0x%04x already in use\n", base);
104 		return -EBUSY;
105 	}
106 
107 	/* According to the datasheet the key must be send twice. */
108 	outb(SIO_UNLOCK_KEY, base);
109 	outb(SIO_UNLOCK_KEY, base);
110 
111 	return 0;
112 }
113 
114 static inline void superio_select(int base, int ld)
115 {
116 	outb(SIO_LDSEL, base);
117 	outb(ld, base + 1);
118 }
119 
120 static inline void superio_exit(int base)
121 {
122 	outb(SIO_LOCK_KEY, base);
123 	release_region(base, 2);
124 }
125 
126 /*
127  * GPIO chip.
128  */
129 
130 static int f7188x_gpio_get_direction(struct gpio_chip *chip, unsigned offset);
131 static int f7188x_gpio_direction_in(struct gpio_chip *chip, unsigned offset);
132 static int f7188x_gpio_get(struct gpio_chip *chip, unsigned offset);
133 static int f7188x_gpio_direction_out(struct gpio_chip *chip,
134 				     unsigned offset, int value);
135 static void f7188x_gpio_set(struct gpio_chip *chip, unsigned offset, int value);
136 static int f7188x_gpio_set_config(struct gpio_chip *chip, unsigned offset,
137 				  unsigned long config);
138 
139 #define F7188X_GPIO_BANK(_base, _ngpio, _regbase)			\
140 	{								\
141 		.chip = {						\
142 			.label            = DRVNAME,			\
143 			.owner            = THIS_MODULE,		\
144 			.get_direction    = f7188x_gpio_get_direction,	\
145 			.direction_input  = f7188x_gpio_direction_in,	\
146 			.get              = f7188x_gpio_get,		\
147 			.direction_output = f7188x_gpio_direction_out,	\
148 			.set              = f7188x_gpio_set,		\
149 			.set_config	  = f7188x_gpio_set_config,	\
150 			.base             = _base,			\
151 			.ngpio            = _ngpio,			\
152 			.can_sleep        = true,			\
153 		},							\
154 		.regbase = _regbase,					\
155 	}
156 
157 #define gpio_dir(base) (base + 0)
158 #define gpio_data_out(base) (base + 1)
159 #define gpio_data_in(base) (base + 2)
160 /* Output mode register (0:open drain 1:push-pull). */
161 #define gpio_out_mode(base) (base + 3)
162 
163 static struct f7188x_gpio_bank f71869_gpio_bank[] = {
164 	F7188X_GPIO_BANK(0, 6, 0xF0),
165 	F7188X_GPIO_BANK(10, 8, 0xE0),
166 	F7188X_GPIO_BANK(20, 8, 0xD0),
167 	F7188X_GPIO_BANK(30, 8, 0xC0),
168 	F7188X_GPIO_BANK(40, 8, 0xB0),
169 	F7188X_GPIO_BANK(50, 5, 0xA0),
170 	F7188X_GPIO_BANK(60, 6, 0x90),
171 };
172 
173 static struct f7188x_gpio_bank f71869a_gpio_bank[] = {
174 	F7188X_GPIO_BANK(0, 6, 0xF0),
175 	F7188X_GPIO_BANK(10, 8, 0xE0),
176 	F7188X_GPIO_BANK(20, 8, 0xD0),
177 	F7188X_GPIO_BANK(30, 8, 0xC0),
178 	F7188X_GPIO_BANK(40, 8, 0xB0),
179 	F7188X_GPIO_BANK(50, 5, 0xA0),
180 	F7188X_GPIO_BANK(60, 8, 0x90),
181 	F7188X_GPIO_BANK(70, 8, 0x80),
182 };
183 
184 static struct f7188x_gpio_bank f71882_gpio_bank[] = {
185 	F7188X_GPIO_BANK(0, 8, 0xF0),
186 	F7188X_GPIO_BANK(10, 8, 0xE0),
187 	F7188X_GPIO_BANK(20, 8, 0xD0),
188 	F7188X_GPIO_BANK(30, 4, 0xC0),
189 	F7188X_GPIO_BANK(40, 4, 0xB0),
190 };
191 
192 static struct f7188x_gpio_bank f71889a_gpio_bank[] = {
193 	F7188X_GPIO_BANK(0, 7, 0xF0),
194 	F7188X_GPIO_BANK(10, 7, 0xE0),
195 	F7188X_GPIO_BANK(20, 8, 0xD0),
196 	F7188X_GPIO_BANK(30, 8, 0xC0),
197 	F7188X_GPIO_BANK(40, 8, 0xB0),
198 	F7188X_GPIO_BANK(50, 5, 0xA0),
199 	F7188X_GPIO_BANK(60, 8, 0x90),
200 	F7188X_GPIO_BANK(70, 8, 0x80),
201 };
202 
203 static struct f7188x_gpio_bank f71889_gpio_bank[] = {
204 	F7188X_GPIO_BANK(0, 7, 0xF0),
205 	F7188X_GPIO_BANK(10, 7, 0xE0),
206 	F7188X_GPIO_BANK(20, 8, 0xD0),
207 	F7188X_GPIO_BANK(30, 8, 0xC0),
208 	F7188X_GPIO_BANK(40, 8, 0xB0),
209 	F7188X_GPIO_BANK(50, 5, 0xA0),
210 	F7188X_GPIO_BANK(60, 8, 0x90),
211 	F7188X_GPIO_BANK(70, 8, 0x80),
212 };
213 
214 static struct f7188x_gpio_bank f81866_gpio_bank[] = {
215 	F7188X_GPIO_BANK(0, 8, 0xF0),
216 	F7188X_GPIO_BANK(10, 8, 0xE0),
217 	F7188X_GPIO_BANK(20, 8, 0xD0),
218 	F7188X_GPIO_BANK(30, 8, 0xC0),
219 	F7188X_GPIO_BANK(40, 8, 0xB0),
220 	F7188X_GPIO_BANK(50, 8, 0xA0),
221 	F7188X_GPIO_BANK(60, 8, 0x90),
222 	F7188X_GPIO_BANK(70, 8, 0x80),
223 	F7188X_GPIO_BANK(80, 8, 0x88),
224 };
225 
226 static int f7188x_gpio_get_direction(struct gpio_chip *chip, unsigned offset)
227 {
228 	int err;
229 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
230 	struct f7188x_sio *sio = bank->data->sio;
231 	u8 dir;
232 
233 	err = superio_enter(sio->addr);
234 	if (err)
235 		return err;
236 	superio_select(sio->addr, SIO_LD_GPIO);
237 
238 	dir = superio_inb(sio->addr, gpio_dir(bank->regbase));
239 
240 	superio_exit(sio->addr);
241 
242 	return !(dir & 1 << offset);
243 }
244 
245 static int f7188x_gpio_direction_in(struct gpio_chip *chip, unsigned offset)
246 {
247 	int err;
248 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
249 	struct f7188x_sio *sio = bank->data->sio;
250 	u8 dir;
251 
252 	err = superio_enter(sio->addr);
253 	if (err)
254 		return err;
255 	superio_select(sio->addr, SIO_LD_GPIO);
256 
257 	dir = superio_inb(sio->addr, gpio_dir(bank->regbase));
258 	dir &= ~BIT(offset);
259 	superio_outb(sio->addr, gpio_dir(bank->regbase), dir);
260 
261 	superio_exit(sio->addr);
262 
263 	return 0;
264 }
265 
266 static int f7188x_gpio_get(struct gpio_chip *chip, unsigned offset)
267 {
268 	int err;
269 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
270 	struct f7188x_sio *sio = bank->data->sio;
271 	u8 dir, data;
272 
273 	err = superio_enter(sio->addr);
274 	if (err)
275 		return err;
276 	superio_select(sio->addr, SIO_LD_GPIO);
277 
278 	dir = superio_inb(sio->addr, gpio_dir(bank->regbase));
279 	dir = !!(dir & BIT(offset));
280 	if (dir)
281 		data = superio_inb(sio->addr, gpio_data_out(bank->regbase));
282 	else
283 		data = superio_inb(sio->addr, gpio_data_in(bank->regbase));
284 
285 	superio_exit(sio->addr);
286 
287 	return !!(data & BIT(offset));
288 }
289 
290 static int f7188x_gpio_direction_out(struct gpio_chip *chip,
291 				     unsigned offset, int value)
292 {
293 	int err;
294 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
295 	struct f7188x_sio *sio = bank->data->sio;
296 	u8 dir, data_out;
297 
298 	err = superio_enter(sio->addr);
299 	if (err)
300 		return err;
301 	superio_select(sio->addr, SIO_LD_GPIO);
302 
303 	data_out = superio_inb(sio->addr, gpio_data_out(bank->regbase));
304 	if (value)
305 		data_out |= BIT(offset);
306 	else
307 		data_out &= ~BIT(offset);
308 	superio_outb(sio->addr, gpio_data_out(bank->regbase), data_out);
309 
310 	dir = superio_inb(sio->addr, gpio_dir(bank->regbase));
311 	dir |= BIT(offset);
312 	superio_outb(sio->addr, gpio_dir(bank->regbase), dir);
313 
314 	superio_exit(sio->addr);
315 
316 	return 0;
317 }
318 
319 static void f7188x_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
320 {
321 	int err;
322 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
323 	struct f7188x_sio *sio = bank->data->sio;
324 	u8 data_out;
325 
326 	err = superio_enter(sio->addr);
327 	if (err)
328 		return;
329 	superio_select(sio->addr, SIO_LD_GPIO);
330 
331 	data_out = superio_inb(sio->addr, gpio_data_out(bank->regbase));
332 	if (value)
333 		data_out |= BIT(offset);
334 	else
335 		data_out &= ~BIT(offset);
336 	superio_outb(sio->addr, gpio_data_out(bank->regbase), data_out);
337 
338 	superio_exit(sio->addr);
339 }
340 
341 static int f7188x_gpio_set_config(struct gpio_chip *chip, unsigned offset,
342 				  unsigned long config)
343 {
344 	int err;
345 	enum pin_config_param param = pinconf_to_config_param(config);
346 	struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
347 	struct f7188x_sio *sio = bank->data->sio;
348 	u8 data;
349 
350 	if (param != PIN_CONFIG_DRIVE_OPEN_DRAIN &&
351 	    param != PIN_CONFIG_DRIVE_PUSH_PULL)
352 		return -ENOTSUPP;
353 
354 	err = superio_enter(sio->addr);
355 	if (err)
356 		return err;
357 	superio_select(sio->addr, SIO_LD_GPIO);
358 
359 	data = superio_inb(sio->addr, gpio_out_mode(bank->regbase));
360 	if (param == PIN_CONFIG_DRIVE_OPEN_DRAIN)
361 		data &= ~BIT(offset);
362 	else
363 		data |= BIT(offset);
364 	superio_outb(sio->addr, gpio_out_mode(bank->regbase), data);
365 
366 	superio_exit(sio->addr);
367 	return 0;
368 }
369 
370 /*
371  * Platform device and driver.
372  */
373 
374 static int f7188x_gpio_probe(struct platform_device *pdev)
375 {
376 	int err;
377 	int i;
378 	struct f7188x_sio *sio = dev_get_platdata(&pdev->dev);
379 	struct f7188x_gpio_data *data;
380 
381 	data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
382 	if (!data)
383 		return -ENOMEM;
384 
385 	switch (sio->type) {
386 	case f71869:
387 		data->nr_bank = ARRAY_SIZE(f71869_gpio_bank);
388 		data->bank = f71869_gpio_bank;
389 		break;
390 	case f71869a:
391 		data->nr_bank = ARRAY_SIZE(f71869a_gpio_bank);
392 		data->bank = f71869a_gpio_bank;
393 		break;
394 	case f71882fg:
395 		data->nr_bank = ARRAY_SIZE(f71882_gpio_bank);
396 		data->bank = f71882_gpio_bank;
397 		break;
398 	case f71889a:
399 		data->nr_bank = ARRAY_SIZE(f71889a_gpio_bank);
400 		data->bank = f71889a_gpio_bank;
401 		break;
402 	case f71889f:
403 		data->nr_bank = ARRAY_SIZE(f71889_gpio_bank);
404 		data->bank = f71889_gpio_bank;
405 		break;
406 	case f81866:
407 		data->nr_bank = ARRAY_SIZE(f81866_gpio_bank);
408 		data->bank = f81866_gpio_bank;
409 		break;
410 	default:
411 		return -ENODEV;
412 	}
413 	data->sio = sio;
414 
415 	platform_set_drvdata(pdev, data);
416 
417 	/* For each GPIO bank, register a GPIO chip. */
418 	for (i = 0; i < data->nr_bank; i++) {
419 		struct f7188x_gpio_bank *bank = &data->bank[i];
420 
421 		bank->chip.parent = &pdev->dev;
422 		bank->data = data;
423 
424 		err = devm_gpiochip_add_data(&pdev->dev, &bank->chip, bank);
425 		if (err) {
426 			dev_err(&pdev->dev,
427 				"Failed to register gpiochip %d: %d\n",
428 				i, err);
429 			return err;
430 		}
431 	}
432 
433 	return 0;
434 }
435 
436 static int __init f7188x_find(int addr, struct f7188x_sio *sio)
437 {
438 	int err;
439 	u16 devid;
440 
441 	err = superio_enter(addr);
442 	if (err)
443 		return err;
444 
445 	err = -ENODEV;
446 	devid = superio_inw(addr, SIO_MANID);
447 	if (devid != SIO_FINTEK_ID) {
448 		pr_debug(DRVNAME ": Not a Fintek device at 0x%08x\n", addr);
449 		goto err;
450 	}
451 
452 	devid = superio_inw(addr, SIO_DEVID);
453 	switch (devid) {
454 	case SIO_F71869_ID:
455 		sio->type = f71869;
456 		break;
457 	case SIO_F71869A_ID:
458 		sio->type = f71869a;
459 		break;
460 	case SIO_F71882_ID:
461 		sio->type = f71882fg;
462 		break;
463 	case SIO_F71889A_ID:
464 		sio->type = f71889a;
465 		break;
466 	case SIO_F71889_ID:
467 		sio->type = f71889f;
468 		break;
469 	case SIO_F81866_ID:
470 		sio->type = f81866;
471 		break;
472 	default:
473 		pr_info(DRVNAME ": Unsupported Fintek device 0x%04x\n", devid);
474 		goto err;
475 	}
476 	sio->addr = addr;
477 	err = 0;
478 
479 	pr_info(DRVNAME ": Found %s at %#x, revision %d\n",
480 		f7188x_names[sio->type],
481 		(unsigned int) addr,
482 		(int) superio_inb(addr, SIO_DEVREV));
483 
484 err:
485 	superio_exit(addr);
486 	return err;
487 }
488 
489 static struct platform_device *f7188x_gpio_pdev;
490 
491 static int __init
492 f7188x_gpio_device_add(const struct f7188x_sio *sio)
493 {
494 	int err;
495 
496 	f7188x_gpio_pdev = platform_device_alloc(DRVNAME, -1);
497 	if (!f7188x_gpio_pdev)
498 		return -ENOMEM;
499 
500 	err = platform_device_add_data(f7188x_gpio_pdev,
501 				       sio, sizeof(*sio));
502 	if (err) {
503 		pr_err(DRVNAME "Platform data allocation failed\n");
504 		goto err;
505 	}
506 
507 	err = platform_device_add(f7188x_gpio_pdev);
508 	if (err) {
509 		pr_err(DRVNAME "Device addition failed\n");
510 		goto err;
511 	}
512 
513 	return 0;
514 
515 err:
516 	platform_device_put(f7188x_gpio_pdev);
517 
518 	return err;
519 }
520 
521 /*
522  * Try to match a supported Fintek device by reading the (hard-wired)
523  * configuration I/O ports. If available, then register both the platform
524  * device and driver to support the GPIOs.
525  */
526 
527 static struct platform_driver f7188x_gpio_driver = {
528 	.driver = {
529 		.name	= DRVNAME,
530 	},
531 	.probe		= f7188x_gpio_probe,
532 };
533 
534 static int __init f7188x_gpio_init(void)
535 {
536 	int err;
537 	struct f7188x_sio sio;
538 
539 	if (f7188x_find(0x2e, &sio) &&
540 	    f7188x_find(0x4e, &sio))
541 		return -ENODEV;
542 
543 	err = platform_driver_register(&f7188x_gpio_driver);
544 	if (!err) {
545 		err = f7188x_gpio_device_add(&sio);
546 		if (err)
547 			platform_driver_unregister(&f7188x_gpio_driver);
548 	}
549 
550 	return err;
551 }
552 subsys_initcall(f7188x_gpio_init);
553 
554 static void __exit f7188x_gpio_exit(void)
555 {
556 	platform_device_unregister(f7188x_gpio_pdev);
557 	platform_driver_unregister(&f7188x_gpio_driver);
558 }
559 module_exit(f7188x_gpio_exit);
560 
561 MODULE_DESCRIPTION("GPIO driver for Super-I/O chips F71869, F71869A, F71882FG, F71889A, F71889F and F81866");
562 MODULE_AUTHOR("Simon Guinot <simon.guinot@sequanux.org>");
563 MODULE_LICENSE("GPL");
564