blob: f9dbd503fc40fb0f1bccd0fa8f0995816a06b538 [file] [log] [blame]
Peter Tyser6ed9f9c2012-04-18 09:48:24 -05001/*
2 * Intel ICH6-10, Series 5 and 6 GPIO driver
3 *
4 * Copyright (C) 2010 Extreme Engineering Solutions.
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
19 */
20
21#define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
22
23#include <linux/module.h>
24#include <linux/pci.h>
25#include <linux/gpio.h>
26#include <linux/platform_device.h>
27#include <linux/mfd/lpc_ich.h>
28
29#define DRV_NAME "gpio_ich"
30
31/*
32 * GPIO register offsets in GPIO I/O space.
33 * Each chunk of 32 GPIOs is manipulated via its own USE_SELx, IO_SELx, and
34 * LVLx registers. Logic in the read/write functions takes a register and
35 * an absolute bit number and determines the proper register offset and bit
36 * number in that register. For example, to read the value of GPIO bit 50
37 * the code would access offset ichx_regs[2(=GPIO_LVL)][1(=50/32)],
38 * bit 18 (50%32).
39 */
40enum GPIO_REG {
41 GPIO_USE_SEL = 0,
42 GPIO_IO_SEL,
43 GPIO_LVL,
44};
45
46static const u8 ichx_regs[3][3] = {
47 {0x00, 0x30, 0x40}, /* USE_SEL[1-3] offsets */
48 {0x04, 0x34, 0x44}, /* IO_SEL[1-3] offsets */
49 {0x0c, 0x38, 0x48}, /* LVL[1-3] offsets */
50};
51
Jean Delvare4f600ad2012-07-23 17:34:15 +020052static const u8 ichx_reglen[3] = {
53 0x30, 0x10, 0x10,
54};
55
Peter Tyser6ed9f9c2012-04-18 09:48:24 -050056#define ICHX_WRITE(val, reg, base_res) outl(val, (reg) + (base_res)->start)
57#define ICHX_READ(reg, base_res) inl((reg) + (base_res)->start)
58
59struct ichx_desc {
60 /* Max GPIO pins the chipset can have */
61 uint ngpio;
62
63 /* Whether the chipset has GPIO in GPE0_STS in the PM IO region */
64 bool uses_gpe0;
65
66 /* USE_SEL is bogus on some chipsets, eg 3100 */
67 u32 use_sel_ignore[3];
68
69 /* Some chipsets have quirks, let these use their own request/get */
70 int (*request)(struct gpio_chip *chip, unsigned offset);
71 int (*get)(struct gpio_chip *chip, unsigned offset);
72};
73
74static struct {
75 spinlock_t lock;
76 struct platform_device *dev;
77 struct gpio_chip chip;
78 struct resource *gpio_base; /* GPIO IO base */
79 struct resource *pm_base; /* Power Mangagment IO base */
80 struct ichx_desc *desc; /* Pointer to chipset-specific description */
81 u32 orig_gpio_ctrl; /* Orig CTRL value, used to restore on exit */
Jean Delvare4f600ad2012-07-23 17:34:15 +020082 u8 use_gpio; /* Which GPIO groups are usable */
Peter Tyser6ed9f9c2012-04-18 09:48:24 -050083} ichx_priv;
84
85static int modparam_gpiobase = -1; /* dynamic */
86module_param_named(gpiobase, modparam_gpiobase, int, 0444);
87MODULE_PARM_DESC(gpiobase, "The GPIO number base. -1 means dynamic, "
88 "which is the default.");
89
90static int ichx_write_bit(int reg, unsigned nr, int val, int verify)
91{
92 unsigned long flags;
93 u32 data, tmp;
94 int reg_nr = nr / 32;
95 int bit = nr & 0x1f;
96 int ret = 0;
97
98 spin_lock_irqsave(&ichx_priv.lock, flags);
99
100 data = ICHX_READ(ichx_regs[reg][reg_nr], ichx_priv.gpio_base);
101 if (val)
102 data |= 1 << bit;
103 else
104 data &= ~(1 << bit);
105 ICHX_WRITE(data, ichx_regs[reg][reg_nr], ichx_priv.gpio_base);
106 tmp = ICHX_READ(ichx_regs[reg][reg_nr], ichx_priv.gpio_base);
107 if (verify && data != tmp)
108 ret = -EPERM;
109
110 spin_unlock_irqrestore(&ichx_priv.lock, flags);
111
112 return ret;
113}
114
115static int ichx_read_bit(int reg, unsigned nr)
116{
117 unsigned long flags;
118 u32 data;
119 int reg_nr = nr / 32;
120 int bit = nr & 0x1f;
121
122 spin_lock_irqsave(&ichx_priv.lock, flags);
123
124 data = ICHX_READ(ichx_regs[reg][reg_nr], ichx_priv.gpio_base);
125
126 spin_unlock_irqrestore(&ichx_priv.lock, flags);
127
128 return data & (1 << bit) ? 1 : 0;
129}
130
Mika Westerberge97f9b52013-02-27 17:25:15 +0200131static bool ichx_gpio_check_available(struct gpio_chip *gpio, unsigned nr)
Jean Delvare4f600ad2012-07-23 17:34:15 +0200132{
Mika Westerberge97f9b52013-02-27 17:25:15 +0200133 return ichx_priv.use_gpio & (1 << (nr / 32));
Jean Delvare4f600ad2012-07-23 17:34:15 +0200134}
135
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500136static int ichx_gpio_direction_input(struct gpio_chip *gpio, unsigned nr)
137{
Jean Delvare4f600ad2012-07-23 17:34:15 +0200138 if (!ichx_gpio_check_available(gpio, nr))
139 return -ENXIO;
140
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500141 /*
142 * Try setting pin as an input and verify it worked since many pins
143 * are output-only.
144 */
145 if (ichx_write_bit(GPIO_IO_SEL, nr, 1, 1))
146 return -EINVAL;
147
148 return 0;
149}
150
151static int ichx_gpio_direction_output(struct gpio_chip *gpio, unsigned nr,
152 int val)
153{
Jean Delvare4f600ad2012-07-23 17:34:15 +0200154 if (!ichx_gpio_check_available(gpio, nr))
155 return -ENXIO;
156
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500157 /* Set GPIO output value. */
158 ichx_write_bit(GPIO_LVL, nr, val, 0);
159
160 /*
161 * Try setting pin as an output and verify it worked since many pins
162 * are input-only.
163 */
164 if (ichx_write_bit(GPIO_IO_SEL, nr, 0, 1))
165 return -EINVAL;
166
167 return 0;
168}
169
170static int ichx_gpio_get(struct gpio_chip *chip, unsigned nr)
171{
Jean Delvare4f600ad2012-07-23 17:34:15 +0200172 if (!ichx_gpio_check_available(chip, nr))
173 return -ENXIO;
174
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500175 return ichx_read_bit(GPIO_LVL, nr);
176}
177
178static int ich6_gpio_get(struct gpio_chip *chip, unsigned nr)
179{
180 unsigned long flags;
181 u32 data;
182
Jean Delvare4f600ad2012-07-23 17:34:15 +0200183 if (!ichx_gpio_check_available(chip, nr))
184 return -ENXIO;
185
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500186 /*
187 * GPI 0 - 15 need to be read from the power management registers on
188 * a ICH6/3100 bridge.
189 */
190 if (nr < 16) {
191 if (!ichx_priv.pm_base)
192 return -ENXIO;
193
194 spin_lock_irqsave(&ichx_priv.lock, flags);
195
196 /* GPI 0 - 15 are latched, write 1 to clear*/
197 ICHX_WRITE(1 << (16 + nr), 0, ichx_priv.pm_base);
198 data = ICHX_READ(0, ichx_priv.pm_base);
199
200 spin_unlock_irqrestore(&ichx_priv.lock, flags);
201
202 return (data >> 16) & (1 << nr) ? 1 : 0;
203 } else {
204 return ichx_gpio_get(chip, nr);
205 }
206}
207
208static int ichx_gpio_request(struct gpio_chip *chip, unsigned nr)
209{
210 /*
211 * Note we assume the BIOS properly set a bridge's USE value. Some
212 * chips (eg Intel 3100) have bogus USE values though, so first see if
213 * the chipset's USE value can be trusted for this specific bit.
214 * If it can't be trusted, assume that the pin can be used as a GPIO.
215 */
216 if (ichx_priv.desc->use_sel_ignore[nr / 32] & (1 << (nr & 0x1f)))
217 return 1;
218
219 return ichx_read_bit(GPIO_USE_SEL, nr) ? 0 : -ENODEV;
220}
221
222static int ich6_gpio_request(struct gpio_chip *chip, unsigned nr)
223{
224 /*
225 * Fixups for bits 16 and 17 are necessary on the Intel ICH6/3100
226 * bridge as they are controlled by USE register bits 0 and 1. See
227 * "Table 704 GPIO_USE_SEL1 register" in the i3100 datasheet for
228 * additional info.
229 */
230 if (nr == 16 || nr == 17)
231 nr -= 16;
232
233 return ichx_gpio_request(chip, nr);
234}
235
236static void ichx_gpio_set(struct gpio_chip *chip, unsigned nr, int val)
237{
238 ichx_write_bit(GPIO_LVL, nr, val, 0);
239}
240
Bill Pemberton38363092012-11-19 13:22:34 -0500241static void ichx_gpiolib_setup(struct gpio_chip *chip)
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500242{
243 chip->owner = THIS_MODULE;
244 chip->label = DRV_NAME;
245 chip->dev = &ichx_priv.dev->dev;
246
247 /* Allow chip-specific overrides of request()/get() */
248 chip->request = ichx_priv.desc->request ?
249 ichx_priv.desc->request : ichx_gpio_request;
250 chip->get = ichx_priv.desc->get ?
251 ichx_priv.desc->get : ichx_gpio_get;
252
253 chip->set = ichx_gpio_set;
254 chip->direction_input = ichx_gpio_direction_input;
255 chip->direction_output = ichx_gpio_direction_output;
256 chip->base = modparam_gpiobase;
257 chip->ngpio = ichx_priv.desc->ngpio;
258 chip->can_sleep = 0;
259 chip->dbg_show = NULL;
260}
261
262/* ICH6-based, 631xesb-based */
263static struct ichx_desc ich6_desc = {
264 /* Bridges using the ICH6 controller need fixups for GPIO 0 - 17 */
265 .request = ich6_gpio_request,
266 .get = ich6_gpio_get,
267
268 /* GPIO 0-15 are read in the GPE0_STS PM register */
269 .uses_gpe0 = true,
270
271 .ngpio = 50,
272};
273
274/* Intel 3100 */
275static struct ichx_desc i3100_desc = {
276 /*
277 * Bits 16,17, 20 of USE_SEL and bit 16 of USE_SEL2 always read 0 on
278 * the Intel 3100. See "Table 712. GPIO Summary Table" of 3100
279 * Datasheet for more info.
280 */
281 .use_sel_ignore = {0x00130000, 0x00010000, 0x0},
282
283 /* The 3100 needs fixups for GPIO 0 - 17 */
284 .request = ich6_gpio_request,
285 .get = ich6_gpio_get,
286
287 /* GPIO 0-15 are read in the GPE0_STS PM register */
288 .uses_gpe0 = true,
289
290 .ngpio = 50,
291};
292
293/* ICH7 and ICH8-based */
294static struct ichx_desc ich7_desc = {
295 .ngpio = 50,
296};
297
298/* ICH9-based */
299static struct ichx_desc ich9_desc = {
300 .ngpio = 61,
301};
302
303/* ICH10-based - Consumer/corporate versions have different amount of GPIO */
304static struct ichx_desc ich10_cons_desc = {
305 .ngpio = 61,
306};
307static struct ichx_desc ich10_corp_desc = {
308 .ngpio = 72,
309};
310
311/* Intel 5 series, 6 series, 3400 series, and C200 series */
312static struct ichx_desc intel5_desc = {
313 .ngpio = 76,
314};
315
Bill Pemberton38363092012-11-19 13:22:34 -0500316static int ichx_gpio_request_regions(struct resource *res_base,
Jean Delvare4f600ad2012-07-23 17:34:15 +0200317 const char *name, u8 use_gpio)
318{
319 int i;
320
321 if (!res_base || !res_base->start || !res_base->end)
322 return -ENODEV;
323
324 for (i = 0; i < ARRAY_SIZE(ichx_regs[0]); i++) {
325 if (!(use_gpio & (1 << i)))
326 continue;
327 if (!request_region(res_base->start + ichx_regs[0][i],
328 ichx_reglen[i], name))
329 goto request_err;
330 }
331 return 0;
332
333request_err:
334 /* Clean up: release already requested regions, if any */
335 for (i--; i >= 0; i--) {
336 if (!(use_gpio & (1 << i)))
337 continue;
338 release_region(res_base->start + ichx_regs[0][i],
339 ichx_reglen[i]);
340 }
341 return -EBUSY;
342}
343
344static void ichx_gpio_release_regions(struct resource *res_base, u8 use_gpio)
345{
346 int i;
347
348 for (i = 0; i < ARRAY_SIZE(ichx_regs[0]); i++) {
349 if (!(use_gpio & (1 << i)))
350 continue;
351 release_region(res_base->start + ichx_regs[0][i],
352 ichx_reglen[i]);
353 }
354}
355
Bill Pemberton38363092012-11-19 13:22:34 -0500356static int ichx_gpio_probe(struct platform_device *pdev)
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500357{
358 struct resource *res_base, *res_pm;
359 int err;
360 struct lpc_ich_info *ich_info = pdev->dev.platform_data;
361
362 if (!ich_info)
363 return -ENODEV;
364
365 ichx_priv.dev = pdev;
366
367 switch (ich_info->gpio_version) {
368 case ICH_I3100_GPIO:
369 ichx_priv.desc = &i3100_desc;
370 break;
371 case ICH_V5_GPIO:
372 ichx_priv.desc = &intel5_desc;
373 break;
374 case ICH_V6_GPIO:
375 ichx_priv.desc = &ich6_desc;
376 break;
377 case ICH_V7_GPIO:
378 ichx_priv.desc = &ich7_desc;
379 break;
380 case ICH_V9_GPIO:
381 ichx_priv.desc = &ich9_desc;
382 break;
383 case ICH_V10CORP_GPIO:
384 ichx_priv.desc = &ich10_corp_desc;
385 break;
386 case ICH_V10CONS_GPIO:
387 ichx_priv.desc = &ich10_cons_desc;
388 break;
389 default:
390 return -ENODEV;
391 }
392
Jean Delvared39a9482012-12-16 21:31:40 +0100393 spin_lock_init(&ichx_priv.lock);
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500394 res_base = platform_get_resource(pdev, IORESOURCE_IO, ICH_RES_GPIO);
Jean Delvare4f600ad2012-07-23 17:34:15 +0200395 ichx_priv.use_gpio = ich_info->use_gpio;
396 err = ichx_gpio_request_regions(res_base, pdev->name,
397 ichx_priv.use_gpio);
398 if (err)
399 return err;
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500400
401 ichx_priv.gpio_base = res_base;
402
403 /*
404 * If necessary, determine the I/O address of ACPI/power management
405 * registers which are needed to read the the GPE0 register for GPI pins
406 * 0 - 15 on some chipsets.
407 */
408 if (!ichx_priv.desc->uses_gpe0)
409 goto init;
410
411 res_pm = platform_get_resource(pdev, IORESOURCE_IO, ICH_RES_GPE0);
412 if (!res_pm) {
413 pr_warn("ACPI BAR is unavailable, GPI 0 - 15 unavailable\n");
414 goto init;
415 }
416
417 if (!request_region(res_pm->start, resource_size(res_pm),
418 pdev->name)) {
419 pr_warn("ACPI BAR is busy, GPI 0 - 15 unavailable\n");
420 goto init;
421 }
422
423 ichx_priv.pm_base = res_pm;
424
425init:
426 ichx_gpiolib_setup(&ichx_priv.chip);
427 err = gpiochip_add(&ichx_priv.chip);
428 if (err) {
429 pr_err("Failed to register GPIOs\n");
430 goto add_err;
431 }
432
433 pr_info("GPIO from %d to %d on %s\n", ichx_priv.chip.base,
434 ichx_priv.chip.base + ichx_priv.chip.ngpio - 1, DRV_NAME);
435
436 return 0;
437
438add_err:
Jean Delvare4f600ad2012-07-23 17:34:15 +0200439 ichx_gpio_release_regions(ichx_priv.gpio_base, ichx_priv.use_gpio);
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500440 if (ichx_priv.pm_base)
441 release_region(ichx_priv.pm_base->start,
442 resource_size(ichx_priv.pm_base));
443 return err;
444}
445
Bill Pemberton206210c2012-11-19 13:25:50 -0500446static int ichx_gpio_remove(struct platform_device *pdev)
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500447{
448 int err;
449
450 err = gpiochip_remove(&ichx_priv.chip);
451 if (err) {
452 dev_err(&pdev->dev, "%s failed, %d\n",
453 "gpiochip_remove()", err);
454 return err;
455 }
456
Jean Delvare4f600ad2012-07-23 17:34:15 +0200457 ichx_gpio_release_regions(ichx_priv.gpio_base, ichx_priv.use_gpio);
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500458 if (ichx_priv.pm_base)
459 release_region(ichx_priv.pm_base->start,
460 resource_size(ichx_priv.pm_base));
461
462 return 0;
463}
464
465static struct platform_driver ichx_gpio_driver = {
466 .driver = {
467 .owner = THIS_MODULE,
468 .name = DRV_NAME,
469 },
470 .probe = ichx_gpio_probe,
Bill Pemberton8283c4f2012-11-19 13:20:08 -0500471 .remove = ichx_gpio_remove,
Peter Tyser6ed9f9c2012-04-18 09:48:24 -0500472};
473
474module_platform_driver(ichx_gpio_driver);
475
476MODULE_AUTHOR("Peter Tyser <ptyser@xes-inc.com>");
477MODULE_DESCRIPTION("GPIO interface for Intel ICH series");
478MODULE_LICENSE("GPL");
479MODULE_ALIAS("platform:"DRV_NAME);