2 * GPIO driver for the SMSC SCH311x Super-I/O chips
4 * Copyright (C) 2013 Bruno Randolf <br1@einfach.org>
6 * SuperIO functions and chip detection:
7 * (c) Copyright 2008 Wim Van Sebroeck <wim@iguana.be>.
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
15 #include <linux/module.h>
16 #include <linux/kernel.h>
17 #include <linux/init.h>
18 #include <linux/platform_device.h>
19 #include <linux/gpio.h>
20 #include <linux/bitops.h>
23 #define DRV_NAME "gpio-sch311x"
25 #define SCH311X_GPIO_CONF_OUT 0x00
26 #define SCH311X_GPIO_CONF_IN 0x01
27 #define SCH311X_GPIO_CONF_INVERT 0x02
28 #define SCH311X_GPIO_CONF_OPEN_DRAIN 0x80
30 #define SIO_CONFIG_KEY_ENTER 0x55
31 #define SIO_CONFIG_KEY_EXIT 0xaa
35 static int sch311x_ioports[] = { 0x2e, 0x4e, 0x162e, 0x164e };
37 static struct platform_device *sch311x_gpio_pdev;
39 struct sch311x_pdev_data { /* platform device data */
40 unsigned short runtime_reg; /* runtime register base address */
43 struct sch311x_gpio_block { /* one GPIO block runtime data */
44 struct gpio_chip chip;
45 unsigned short data_reg; /* from definition below */
46 unsigned short *config_regs; /* pointer to definition below */
47 unsigned short runtime_reg; /* runtime register */
48 spinlock_t lock; /* lock for this GPIO block */
51 struct sch311x_gpio_priv { /* driver private data */
52 struct sch311x_gpio_block blocks[6];
55 struct sch311x_gpio_block_def { /* register address definitions */
56 unsigned short data_reg;
57 unsigned short config_regs[8];
61 /* Note: some GPIOs are not available, these are marked with 0x00 */
63 static struct sch311x_gpio_block_def sch311x_gpio_blocks[] = {
65 .data_reg = 0x4b, /* GP1 */
66 .config_regs = {0x23, 0x24, 0x25, 0x26, 0x27, 0x29, 0x2a, 0x2b},
70 .data_reg = 0x4c, /* GP2 */
71 .config_regs = {0x00, 0x2c, 0x2d, 0x00, 0x00, 0x00, 0x00, 0x32},
75 .data_reg = 0x4d, /* GP3 */
76 .config_regs = {0x33, 0x34, 0x35, 0x36, 0x37, 0x00, 0x39, 0x3a},
80 .data_reg = 0x4e, /* GP4 */
81 .config_regs = {0x3b, 0x00, 0x3d, 0x00, 0x6e, 0x6f, 0x72, 0x73},
85 .data_reg = 0x4f, /* GP5 */
86 .config_regs = {0x3f, 0x40, 0x41, 0x42, 0x43, 0x44, 0x45, 0x46},
90 .data_reg = 0x50, /* GP6 */
91 .config_regs = {0x47, 0x48, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59},
100 static inline int sch311x_sio_enter(int sio_config_port)
102 /* Don't step on other drivers' I/O space by accident. */
103 if (!request_muxed_region(sio_config_port, 2, DRV_NAME)) {
104 pr_err(DRV_NAME "I/O address 0x%04x already in use\n",
109 outb(SIO_CONFIG_KEY_ENTER, sio_config_port);
113 static inline void sch311x_sio_exit(int sio_config_port)
115 outb(SIO_CONFIG_KEY_EXIT, sio_config_port);
116 release_region(sio_config_port, 2);
119 static inline int sch311x_sio_inb(int sio_config_port, int reg)
121 outb(reg, sio_config_port);
122 return inb(sio_config_port + 1);
125 static inline void sch311x_sio_outb(int sio_config_port, int reg, int val)
127 outb(reg, sio_config_port);
128 outb(val, sio_config_port + 1);
136 static int sch311x_gpio_request(struct gpio_chip *chip, unsigned offset)
138 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
140 if (block->config_regs[offset] == 0) /* GPIO is not available */
143 if (!request_region(block->runtime_reg + block->config_regs[offset],
145 dev_err(chip->parent, "Failed to request region 0x%04x.\n",
146 block->runtime_reg + block->config_regs[offset]);
152 static void sch311x_gpio_free(struct gpio_chip *chip, unsigned offset)
154 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
156 if (block->config_regs[offset] == 0) /* GPIO is not available */
159 release_region(block->runtime_reg + block->config_regs[offset], 1);
162 static int sch311x_gpio_get(struct gpio_chip *chip, unsigned offset)
164 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
167 spin_lock(&block->lock);
168 data = inb(block->runtime_reg + block->data_reg);
169 spin_unlock(&block->lock);
171 return !!(data & BIT(offset));
174 static void __sch311x_gpio_set(struct sch311x_gpio_block *block,
175 unsigned offset, int value)
177 unsigned char data = inb(block->runtime_reg + block->data_reg);
181 data &= ~BIT(offset);
182 outb(data, block->runtime_reg + block->data_reg);
185 static void sch311x_gpio_set(struct gpio_chip *chip, unsigned offset,
188 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
190 spin_lock(&block->lock);
191 __sch311x_gpio_set(block, offset, value);
192 spin_unlock(&block->lock);
195 static int sch311x_gpio_direction_in(struct gpio_chip *chip, unsigned offset)
197 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
199 spin_lock(&block->lock);
200 outb(SCH311X_GPIO_CONF_IN, block->runtime_reg +
201 block->config_regs[offset]);
202 spin_unlock(&block->lock);
207 static int sch311x_gpio_direction_out(struct gpio_chip *chip, unsigned offset,
210 struct sch311x_gpio_block *block = gpiochip_get_data(chip);
212 spin_lock(&block->lock);
214 outb(SCH311X_GPIO_CONF_OUT, block->runtime_reg +
215 block->config_regs[offset]);
217 __sch311x_gpio_set(block, offset, value);
219 spin_unlock(&block->lock);
223 static int sch311x_gpio_probe(struct platform_device *pdev)
225 struct sch311x_pdev_data *pdata = dev_get_platdata(&pdev->dev);
226 struct sch311x_gpio_priv *priv;
227 struct sch311x_gpio_block *block;
230 /* we can register all GPIO data registers at once */
231 if (!request_region(pdata->runtime_reg + GP1, 6, DRV_NAME)) {
232 dev_err(&pdev->dev, "Failed to request region 0x%04x-0x%04x.\n",
233 pdata->runtime_reg + GP1, pdata->runtime_reg + GP1 + 5);
237 priv = devm_kzalloc(&pdev->dev, sizeof(*priv), GFP_KERNEL);
241 platform_set_drvdata(pdev, priv);
243 for (i = 0; i < ARRAY_SIZE(priv->blocks); i++) {
244 block = &priv->blocks[i];
246 spin_lock_init(&block->lock);
248 block->chip.label = DRV_NAME;
249 block->chip.owner = THIS_MODULE;
250 block->chip.request = sch311x_gpio_request;
251 block->chip.free = sch311x_gpio_free;
252 block->chip.direction_input = sch311x_gpio_direction_in;
253 block->chip.direction_output = sch311x_gpio_direction_out;
254 block->chip.get = sch311x_gpio_get;
255 block->chip.set = sch311x_gpio_set;
256 block->chip.ngpio = 8;
257 block->chip.parent = &pdev->dev;
258 block->chip.base = sch311x_gpio_blocks[i].base;
259 block->config_regs = sch311x_gpio_blocks[i].config_regs;
260 block->data_reg = sch311x_gpio_blocks[i].data_reg;
261 block->runtime_reg = pdata->runtime_reg;
263 err = gpiochip_add_data(&block->chip, block);
266 "Could not register gpiochip, %d\n", err);
270 "SMSC SCH311x GPIO block %d registered.\n", i);
276 release_region(pdata->runtime_reg + GP1, 6);
277 /* release already registered chips */
278 for (--i; i >= 0; i--)
279 gpiochip_remove(&priv->blocks[i].chip);
283 static int sch311x_gpio_remove(struct platform_device *pdev)
285 struct sch311x_pdev_data *pdata = dev_get_platdata(&pdev->dev);
286 struct sch311x_gpio_priv *priv = platform_get_drvdata(pdev);
289 release_region(pdata->runtime_reg + GP1, 6);
291 for (i = 0; i < ARRAY_SIZE(priv->blocks); i++) {
292 gpiochip_remove(&priv->blocks[i].chip);
294 "SMSC SCH311x GPIO block %d unregistered.\n", i);
299 static struct platform_driver sch311x_gpio_driver = {
300 .driver.name = DRV_NAME,
301 .driver.owner = THIS_MODULE,
302 .probe = sch311x_gpio_probe,
303 .remove = sch311x_gpio_remove,
308 * Init & exit routines
311 static int __init sch311x_detect(int sio_config_port, unsigned short *addr)
314 unsigned short base_addr;
315 unsigned char dev_id;
317 err = sch311x_sio_enter(sio_config_port);
321 /* Check device ID. */
322 reg = sch311x_sio_inb(sio_config_port, 0x20);
324 case 0x7c: /* SCH3112 */
327 case 0x7d: /* SCH3114 */
330 case 0x7f: /* SCH3116 */
338 /* Select logical device A (runtime registers) */
339 sch311x_sio_outb(sio_config_port, 0x07, 0x0a);
341 /* Check if Logical Device Register is currently active */
342 if ((sch311x_sio_inb(sio_config_port, 0x30) & 0x01) == 0)
343 pr_info("Seems that LDN 0x0a is not active...\n");
345 /* Get the base address of the runtime registers */
346 base_addr = (sch311x_sio_inb(sio_config_port, 0x60) << 8) |
347 sch311x_sio_inb(sio_config_port, 0x61);
349 pr_err("Base address not set\n");
355 pr_info("Found an SMSC SCH311%d chip at 0x%04x\n", dev_id, base_addr);
358 sch311x_sio_exit(sio_config_port);
362 static int __init sch311x_gpio_pdev_add(const unsigned short addr)
364 struct sch311x_pdev_data pdata;
367 pdata.runtime_reg = addr;
369 sch311x_gpio_pdev = platform_device_alloc(DRV_NAME, -1);
370 if (!sch311x_gpio_pdev)
373 err = platform_device_add_data(sch311x_gpio_pdev,
374 &pdata, sizeof(pdata));
376 pr_err(DRV_NAME "Platform data allocation failed\n");
380 err = platform_device_add(sch311x_gpio_pdev);
382 pr_err(DRV_NAME "Device addition failed\n");
388 platform_device_put(sch311x_gpio_pdev);
392 static int __init sch311x_gpio_init(void)
395 unsigned short addr = 0;
397 for (i = 0; i < ARRAY_SIZE(sch311x_ioports); i++)
398 if (sch311x_detect(sch311x_ioports[i], &addr) == 0)
404 err = platform_driver_register(&sch311x_gpio_driver);
408 err = sch311x_gpio_pdev_add(addr);
410 goto unreg_platform_driver;
414 unreg_platform_driver:
415 platform_driver_unregister(&sch311x_gpio_driver);
419 static void __exit sch311x_gpio_exit(void)
421 platform_device_unregister(sch311x_gpio_pdev);
422 platform_driver_unregister(&sch311x_gpio_driver);
425 module_init(sch311x_gpio_init);
426 module_exit(sch311x_gpio_exit);
428 MODULE_AUTHOR("Bruno Randolf <br1@einfach.org>");
429 MODULE_DESCRIPTION("SMSC SCH311x GPIO Driver");
430 MODULE_LICENSE("GPL");
431 MODULE_ALIAS("platform:gpio-sch311x");