1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * GPIO driver for Fintek and Nuvoton Super-I/O chips
5 * Copyright (C) 2010-2013 LaCie
7 * Author: Simon Guinot <simon.guinot@sequanux.org>
10 #define DRVNAME "gpio-f7188x"
11 #define pr_fmt(fmt) DRVNAME ": " fmt
13 #include <linux/module.h>
14 #include <linux/init.h>
15 #include <linux/platform_device.h>
17 #include <linux/gpio/driver.h>
18 #include <linux/bitops.h>
23 #define SIO_LDSEL 0x07 /* Logical device select */
24 #define SIO_DEVID 0x20 /* Device ID (2 bytes) */
26 #define SIO_UNLOCK_KEY 0x87 /* Key to enable Super-I/O */
27 #define SIO_LOCK_KEY 0xAA /* Key to disable Super-I/O */
32 #define SIO_FINTEK_DEVREV 0x22 /* Fintek Device revision */
33 #define SIO_FINTEK_MANID 0x23 /* Fintek ID (2 bytes) */
35 #define SIO_FINTEK_ID 0x1934 /* Manufacturer ID */
37 #define SIO_F71869_ID 0x0814 /* F71869 chipset ID */
38 #define SIO_F71869A_ID 0x1007 /* F71869A chipset ID */
39 #define SIO_F71882_ID 0x0541 /* F71882 chipset ID */
40 #define SIO_F71889_ID 0x0909 /* F71889 chipset ID */
41 #define SIO_F71889A_ID 0x1005 /* F71889A chipset ID */
42 #define SIO_F81866_ID 0x1010 /* F81866 chipset ID */
43 #define SIO_F81804_ID 0x1502 /* F81804 chipset ID, same for F81966 */
44 #define SIO_F81865_ID 0x0704 /* F81865 chipset ID */
46 #define SIO_LD_GPIO_FINTEK 0x06 /* GPIO logical device */
51 #define SIO_NCT6116D_ID 0xD283 /* NCT6116D chipset ID */
53 #define SIO_LD_GPIO_NUVOTON 0x07 /* GPIO logical device */
68 static const char * const f7188x_names[] = {
86 struct f7188x_gpio_bank {
87 struct gpio_chip chip;
89 struct f7188x_gpio_data *data;
92 struct f7188x_gpio_data {
93 struct f7188x_sio *sio;
95 struct f7188x_gpio_bank *bank;
99 * Super-I/O functions.
102 static inline int superio_inb(int base, int reg)
105 return inb(base + 1);
108 static int superio_inw(int base, int reg)
113 val = inb(base + 1) << 8;
115 val |= inb(base + 1);
120 static inline void superio_outb(int base, int reg, int val)
126 static inline int superio_enter(int base)
128 /* Don't step on other drivers' I/O space by accident. */
129 if (!request_muxed_region(base, 2, DRVNAME)) {
130 pr_err("I/O address 0x%04x already in use\n", base);
134 /* According to the datasheet the key must be send twice. */
135 outb(SIO_UNLOCK_KEY, base);
136 outb(SIO_UNLOCK_KEY, base);
141 static inline void superio_select(int base, int ld)
143 outb(SIO_LDSEL, base);
147 static inline void superio_exit(int base)
149 outb(SIO_LOCK_KEY, base);
150 release_region(base, 2);
157 static int f7188x_gpio_get_direction(struct gpio_chip *chip, unsigned offset);
158 static int f7188x_gpio_direction_in(struct gpio_chip *chip, unsigned offset);
159 static int f7188x_gpio_get(struct gpio_chip *chip, unsigned offset);
160 static int f7188x_gpio_direction_out(struct gpio_chip *chip,
161 unsigned offset, int value);
162 static void f7188x_gpio_set(struct gpio_chip *chip, unsigned offset, int value);
163 static int f7188x_gpio_set_config(struct gpio_chip *chip, unsigned offset,
164 unsigned long config);
166 #define F7188X_GPIO_BANK(_base, _ngpio, _regbase, _label) \
170 .owner = THIS_MODULE, \
171 .get_direction = f7188x_gpio_get_direction, \
172 .direction_input = f7188x_gpio_direction_in, \
173 .get = f7188x_gpio_get, \
174 .direction_output = f7188x_gpio_direction_out, \
175 .set = f7188x_gpio_set, \
176 .set_config = f7188x_gpio_set_config, \
181 .regbase = _regbase, \
184 #define f7188x_gpio_dir(base) ((base) + 0)
185 #define f7188x_gpio_data_out(base) ((base) + 1)
186 #define f7188x_gpio_data_in(base) ((base) + 2)
187 /* Output mode register (0:open drain 1:push-pull). */
188 #define f7188x_gpio_out_mode(base) ((base) + 3)
190 #define f7188x_gpio_dir_invert(type) ((type) == nct6116d)
191 #define f7188x_gpio_data_single(type) ((type) == nct6116d)
193 static struct f7188x_gpio_bank f71869_gpio_bank[] = {
194 F7188X_GPIO_BANK(0, 6, 0xF0, DRVNAME "-0"),
195 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
196 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
197 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
198 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
199 F7188X_GPIO_BANK(50, 5, 0xA0, DRVNAME "-5"),
200 F7188X_GPIO_BANK(60, 6, 0x90, DRVNAME "-6"),
203 static struct f7188x_gpio_bank f71869a_gpio_bank[] = {
204 F7188X_GPIO_BANK(0, 6, 0xF0, DRVNAME "-0"),
205 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
206 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
207 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
208 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
209 F7188X_GPIO_BANK(50, 5, 0xA0, DRVNAME "-5"),
210 F7188X_GPIO_BANK(60, 8, 0x90, DRVNAME "-6"),
211 F7188X_GPIO_BANK(70, 8, 0x80, DRVNAME "-7"),
214 static struct f7188x_gpio_bank f71882_gpio_bank[] = {
215 F7188X_GPIO_BANK(0, 8, 0xF0, DRVNAME "-0"),
216 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
217 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
218 F7188X_GPIO_BANK(30, 4, 0xC0, DRVNAME "-3"),
219 F7188X_GPIO_BANK(40, 4, 0xB0, DRVNAME "-4"),
222 static struct f7188x_gpio_bank f71889a_gpio_bank[] = {
223 F7188X_GPIO_BANK(0, 7, 0xF0, DRVNAME "-0"),
224 F7188X_GPIO_BANK(10, 7, 0xE0, DRVNAME "-1"),
225 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
226 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
227 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
228 F7188X_GPIO_BANK(50, 5, 0xA0, DRVNAME "-5"),
229 F7188X_GPIO_BANK(60, 8, 0x90, DRVNAME "-6"),
230 F7188X_GPIO_BANK(70, 8, 0x80, DRVNAME "-7"),
233 static struct f7188x_gpio_bank f71889_gpio_bank[] = {
234 F7188X_GPIO_BANK(0, 7, 0xF0, DRVNAME "-0"),
235 F7188X_GPIO_BANK(10, 7, 0xE0, DRVNAME "-1"),
236 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
237 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
238 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
239 F7188X_GPIO_BANK(50, 5, 0xA0, DRVNAME "-5"),
240 F7188X_GPIO_BANK(60, 8, 0x90, DRVNAME "-6"),
241 F7188X_GPIO_BANK(70, 8, 0x80, DRVNAME "-7"),
244 static struct f7188x_gpio_bank f81866_gpio_bank[] = {
245 F7188X_GPIO_BANK(0, 8, 0xF0, DRVNAME "-0"),
246 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
247 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
248 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
249 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
250 F7188X_GPIO_BANK(50, 8, 0xA0, DRVNAME "-5"),
251 F7188X_GPIO_BANK(60, 8, 0x90, DRVNAME "-6"),
252 F7188X_GPIO_BANK(70, 8, 0x80, DRVNAME "-7"),
253 F7188X_GPIO_BANK(80, 8, 0x88, DRVNAME "-8"),
257 static struct f7188x_gpio_bank f81804_gpio_bank[] = {
258 F7188X_GPIO_BANK(0, 8, 0xF0, DRVNAME "-0"),
259 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
260 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
261 F7188X_GPIO_BANK(50, 8, 0xA0, DRVNAME "-3"),
262 F7188X_GPIO_BANK(60, 8, 0x90, DRVNAME "-4"),
263 F7188X_GPIO_BANK(70, 8, 0x80, DRVNAME "-5"),
264 F7188X_GPIO_BANK(90, 8, 0x98, DRVNAME "-6"),
267 static struct f7188x_gpio_bank f81865_gpio_bank[] = {
268 F7188X_GPIO_BANK(0, 8, 0xF0, DRVNAME "-0"),
269 F7188X_GPIO_BANK(10, 8, 0xE0, DRVNAME "-1"),
270 F7188X_GPIO_BANK(20, 8, 0xD0, DRVNAME "-2"),
271 F7188X_GPIO_BANK(30, 8, 0xC0, DRVNAME "-3"),
272 F7188X_GPIO_BANK(40, 8, 0xB0, DRVNAME "-4"),
273 F7188X_GPIO_BANK(50, 8, 0xA0, DRVNAME "-5"),
274 F7188X_GPIO_BANK(60, 5, 0x90, DRVNAME "-6"),
277 static struct f7188x_gpio_bank nct6116d_gpio_bank[] = {
278 F7188X_GPIO_BANK(0, 8, 0xE0, DRVNAME "-0"),
279 F7188X_GPIO_BANK(10, 8, 0xE4, DRVNAME "-1"),
280 F7188X_GPIO_BANK(20, 8, 0xE8, DRVNAME "-2"),
281 F7188X_GPIO_BANK(30, 8, 0xEC, DRVNAME "-3"),
282 F7188X_GPIO_BANK(40, 8, 0xF0, DRVNAME "-4"),
283 F7188X_GPIO_BANK(50, 8, 0xF4, DRVNAME "-5"),
284 F7188X_GPIO_BANK(60, 8, 0xF8, DRVNAME "-6"),
285 F7188X_GPIO_BANK(70, 1, 0xFC, DRVNAME "-7"),
288 static int f7188x_gpio_get_direction(struct gpio_chip *chip, unsigned offset)
291 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
292 struct f7188x_sio *sio = bank->data->sio;
295 err = superio_enter(sio->addr);
298 superio_select(sio->addr, sio->device);
300 dir = superio_inb(sio->addr, f7188x_gpio_dir(bank->regbase));
302 superio_exit(sio->addr);
304 if (f7188x_gpio_dir_invert(sio->type))
307 if (dir & BIT(offset))
308 return GPIO_LINE_DIRECTION_OUT;
310 return GPIO_LINE_DIRECTION_IN;
313 static int f7188x_gpio_direction_in(struct gpio_chip *chip, unsigned offset)
316 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
317 struct f7188x_sio *sio = bank->data->sio;
320 err = superio_enter(sio->addr);
323 superio_select(sio->addr, sio->device);
325 dir = superio_inb(sio->addr, f7188x_gpio_dir(bank->regbase));
327 if (f7188x_gpio_dir_invert(sio->type))
331 superio_outb(sio->addr, f7188x_gpio_dir(bank->regbase), dir);
333 superio_exit(sio->addr);
338 static int f7188x_gpio_get(struct gpio_chip *chip, unsigned offset)
341 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
342 struct f7188x_sio *sio = bank->data->sio;
345 err = superio_enter(sio->addr);
348 superio_select(sio->addr, sio->device);
350 dir = superio_inb(sio->addr, f7188x_gpio_dir(bank->regbase));
351 dir = !!(dir & BIT(offset));
352 if (f7188x_gpio_data_single(sio->type) || dir)
353 data = superio_inb(sio->addr, f7188x_gpio_data_out(bank->regbase));
355 data = superio_inb(sio->addr, f7188x_gpio_data_in(bank->regbase));
357 superio_exit(sio->addr);
359 return !!(data & BIT(offset));
362 static int f7188x_gpio_direction_out(struct gpio_chip *chip,
363 unsigned offset, int value)
366 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
367 struct f7188x_sio *sio = bank->data->sio;
370 err = superio_enter(sio->addr);
373 superio_select(sio->addr, sio->device);
375 data_out = superio_inb(sio->addr, f7188x_gpio_data_out(bank->regbase));
377 data_out |= BIT(offset);
379 data_out &= ~BIT(offset);
380 superio_outb(sio->addr, f7188x_gpio_data_out(bank->regbase), data_out);
382 dir = superio_inb(sio->addr, f7188x_gpio_dir(bank->regbase));
383 if (f7188x_gpio_dir_invert(sio->type))
387 superio_outb(sio->addr, f7188x_gpio_dir(bank->regbase), dir);
389 superio_exit(sio->addr);
394 static void f7188x_gpio_set(struct gpio_chip *chip, unsigned offset, int value)
397 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
398 struct f7188x_sio *sio = bank->data->sio;
401 err = superio_enter(sio->addr);
404 superio_select(sio->addr, sio->device);
406 data_out = superio_inb(sio->addr, f7188x_gpio_data_out(bank->regbase));
408 data_out |= BIT(offset);
410 data_out &= ~BIT(offset);
411 superio_outb(sio->addr, f7188x_gpio_data_out(bank->regbase), data_out);
413 superio_exit(sio->addr);
416 static int f7188x_gpio_set_config(struct gpio_chip *chip, unsigned offset,
417 unsigned long config)
420 enum pin_config_param param = pinconf_to_config_param(config);
421 struct f7188x_gpio_bank *bank = gpiochip_get_data(chip);
422 struct f7188x_sio *sio = bank->data->sio;
425 if (param != PIN_CONFIG_DRIVE_OPEN_DRAIN &&
426 param != PIN_CONFIG_DRIVE_PUSH_PULL)
429 err = superio_enter(sio->addr);
432 superio_select(sio->addr, sio->device);
434 data = superio_inb(sio->addr, f7188x_gpio_out_mode(bank->regbase));
435 if (param == PIN_CONFIG_DRIVE_OPEN_DRAIN)
436 data &= ~BIT(offset);
439 superio_outb(sio->addr, f7188x_gpio_out_mode(bank->regbase), data);
441 superio_exit(sio->addr);
446 * Platform device and driver.
449 static int f7188x_gpio_probe(struct platform_device *pdev)
453 struct f7188x_sio *sio = dev_get_platdata(&pdev->dev);
454 struct f7188x_gpio_data *data;
456 data = devm_kzalloc(&pdev->dev, sizeof(*data), GFP_KERNEL);
462 data->nr_bank = ARRAY_SIZE(f71869_gpio_bank);
463 data->bank = f71869_gpio_bank;
466 data->nr_bank = ARRAY_SIZE(f71869a_gpio_bank);
467 data->bank = f71869a_gpio_bank;
470 data->nr_bank = ARRAY_SIZE(f71882_gpio_bank);
471 data->bank = f71882_gpio_bank;
474 data->nr_bank = ARRAY_SIZE(f71889a_gpio_bank);
475 data->bank = f71889a_gpio_bank;
478 data->nr_bank = ARRAY_SIZE(f71889_gpio_bank);
479 data->bank = f71889_gpio_bank;
482 data->nr_bank = ARRAY_SIZE(f81866_gpio_bank);
483 data->bank = f81866_gpio_bank;
486 data->nr_bank = ARRAY_SIZE(f81804_gpio_bank);
487 data->bank = f81804_gpio_bank;
490 data->nr_bank = ARRAY_SIZE(f81865_gpio_bank);
491 data->bank = f81865_gpio_bank;
494 data->nr_bank = ARRAY_SIZE(nct6116d_gpio_bank);
495 data->bank = nct6116d_gpio_bank;
502 platform_set_drvdata(pdev, data);
504 /* For each GPIO bank, register a GPIO chip. */
505 for (i = 0; i < data->nr_bank; i++) {
506 struct f7188x_gpio_bank *bank = &data->bank[i];
508 bank->chip.parent = &pdev->dev;
511 err = devm_gpiochip_add_data(&pdev->dev, &bank->chip, bank);
514 "Failed to register gpiochip %d: %d\n",
523 static int __init f7188x_find(int addr, struct f7188x_sio *sio)
529 err = superio_enter(addr);
535 sio->device = SIO_LD_GPIO_FINTEK;
536 devid = superio_inw(addr, SIO_DEVID);
545 sio->type = f71882fg;
562 case SIO_NCT6116D_ID:
563 sio->device = SIO_LD_GPIO_NUVOTON;
564 sio->type = nct6116d;
567 pr_info("Unsupported Fintek device 0x%04x\n", devid);
571 /* double check manufacturer where possible */
572 if (sio->type != nct6116d) {
573 manid = superio_inw(addr, SIO_FINTEK_MANID);
574 if (manid != SIO_FINTEK_ID) {
575 pr_debug("Not a Fintek device at 0x%08x\n", addr);
583 pr_info("Found %s at %#x\n", f7188x_names[sio->type], (unsigned int)addr);
584 if (sio->type != nct6116d)
585 pr_info(" revision %d\n", superio_inb(addr, SIO_FINTEK_DEVREV));
592 static struct platform_device *f7188x_gpio_pdev;
595 f7188x_gpio_device_add(const struct f7188x_sio *sio)
599 f7188x_gpio_pdev = platform_device_alloc(DRVNAME, -1);
600 if (!f7188x_gpio_pdev)
603 err = platform_device_add_data(f7188x_gpio_pdev,
606 pr_err("Platform data allocation failed\n");
610 err = platform_device_add(f7188x_gpio_pdev);
612 pr_err("Device addition failed\n");
619 platform_device_put(f7188x_gpio_pdev);
625 * Try to match a supported Fintek device by reading the (hard-wired)
626 * configuration I/O ports. If available, then register both the platform
627 * device and driver to support the GPIOs.
630 static struct platform_driver f7188x_gpio_driver = {
634 .probe = f7188x_gpio_probe,
637 static int __init f7188x_gpio_init(void)
640 struct f7188x_sio sio;
642 if (f7188x_find(0x2e, &sio) &&
643 f7188x_find(0x4e, &sio))
646 err = platform_driver_register(&f7188x_gpio_driver);
648 err = f7188x_gpio_device_add(&sio);
650 platform_driver_unregister(&f7188x_gpio_driver);
655 subsys_initcall(f7188x_gpio_init);
657 static void __exit f7188x_gpio_exit(void)
659 platform_device_unregister(f7188x_gpio_pdev);
660 platform_driver_unregister(&f7188x_gpio_driver);
662 module_exit(f7188x_gpio_exit);
664 MODULE_DESCRIPTION("GPIO driver for Super-I/O chips F71869, F71869A, F71882FG, F71889A, F71889F and F81866");
665 MODULE_AUTHOR("Simon Guinot <simon.guinot@sequanux.org>");
666 MODULE_LICENSE("GPL");