1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Copyright (C) 2008, 2009 Provigent Ltd. 4 * 5 * Author: Baruch Siach <baruch@tkos.co.il> 6 * 7 * Driver for the ARM PrimeCell(tm) General Purpose Input/Output (PL061) 8 * 9 * Data sheet: ARM DDI 0190B, September 2000 10 */ 11 #include <linux/spinlock.h> 12 #include <linux/errno.h> 13 #include <linux/init.h> 14 #include <linux/io.h> 15 #include <linux/ioport.h> 16 #include <linux/interrupt.h> 17 #include <linux/irq.h> 18 #include <linux/irqchip/chained_irq.h> 19 #include <linux/bitops.h> 20 #include <linux/gpio/driver.h> 21 #include <linux/device.h> 22 #include <linux/amba/bus.h> 23 #include <linux/slab.h> 24 #include <linux/pinctrl/consumer.h> 25 #include <linux/pm.h> 26 27 #define GPIODIR 0x400 28 #define GPIOIS 0x404 29 #define GPIOIBE 0x408 30 #define GPIOIEV 0x40C 31 #define GPIOIE 0x410 32 #define GPIORIS 0x414 33 #define GPIOMIS 0x418 34 #define GPIOIC 0x41C 35 36 #define PL061_GPIO_NR 8 37 38 #ifdef CONFIG_PM 39 struct pl061_context_save_regs { 40 u8 gpio_data; 41 u8 gpio_dir; 42 u8 gpio_is; 43 u8 gpio_ibe; 44 u8 gpio_iev; 45 u8 gpio_ie; 46 }; 47 #endif 48 49 struct pl061 { 50 raw_spinlock_t lock; 51 52 void __iomem *base; 53 struct gpio_chip gc; 54 struct irq_chip irq_chip; 55 int parent_irq; 56 57 #ifdef CONFIG_PM 58 struct pl061_context_save_regs csave_regs; 59 #endif 60 }; 61 62 static int pl061_get_direction(struct gpio_chip *gc, unsigned offset) 63 { 64 struct pl061 *pl061 = gpiochip_get_data(gc); 65 66 if (readb(pl061->base + GPIODIR) & BIT(offset)) 67 return GPIO_LINE_DIRECTION_OUT; 68 69 return GPIO_LINE_DIRECTION_IN; 70 } 71 72 static int pl061_direction_input(struct gpio_chip *gc, unsigned offset) 73 { 74 struct pl061 *pl061 = gpiochip_get_data(gc); 75 unsigned long flags; 76 unsigned char gpiodir; 77 78 raw_spin_lock_irqsave(&pl061->lock, flags); 79 gpiodir = readb(pl061->base + GPIODIR); 80 gpiodir &= ~(BIT(offset)); 81 writeb(gpiodir, pl061->base + GPIODIR); 82 raw_spin_unlock_irqrestore(&pl061->lock, flags); 83 84 return 0; 85 } 86 87 static int pl061_direction_output(struct gpio_chip *gc, unsigned offset, 88 int value) 89 { 90 struct pl061 *pl061 = gpiochip_get_data(gc); 91 unsigned long flags; 92 unsigned char gpiodir; 93 94 raw_spin_lock_irqsave(&pl061->lock, flags); 95 writeb(!!value << offset, pl061->base + (BIT(offset + 2))); 96 gpiodir = readb(pl061->base + GPIODIR); 97 gpiodir |= BIT(offset); 98 writeb(gpiodir, pl061->base + GPIODIR); 99 100 /* 101 * gpio value is set again, because pl061 doesn't allow to set value of 102 * a gpio pin before configuring it in OUT mode. 103 */ 104 writeb(!!value << offset, pl061->base + (BIT(offset + 2))); 105 raw_spin_unlock_irqrestore(&pl061->lock, flags); 106 107 return 0; 108 } 109 110 static int pl061_get_value(struct gpio_chip *gc, unsigned offset) 111 { 112 struct pl061 *pl061 = gpiochip_get_data(gc); 113 114 return !!readb(pl061->base + (BIT(offset + 2))); 115 } 116 117 static void pl061_set_value(struct gpio_chip *gc, unsigned offset, int value) 118 { 119 struct pl061 *pl061 = gpiochip_get_data(gc); 120 121 writeb(!!value << offset, pl061->base + (BIT(offset + 2))); 122 } 123 124 static int pl061_irq_type(struct irq_data *d, unsigned trigger) 125 { 126 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 127 struct pl061 *pl061 = gpiochip_get_data(gc); 128 int offset = irqd_to_hwirq(d); 129 unsigned long flags; 130 u8 gpiois, gpioibe, gpioiev; 131 u8 bit = BIT(offset); 132 133 if (offset < 0 || offset >= PL061_GPIO_NR) 134 return -EINVAL; 135 136 if ((trigger & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW)) && 137 (trigger & (IRQ_TYPE_EDGE_RISING | IRQ_TYPE_EDGE_FALLING))) 138 { 139 dev_err(gc->parent, 140 "trying to configure line %d for both level and edge " 141 "detection, choose one!\n", 142 offset); 143 return -EINVAL; 144 } 145 146 147 raw_spin_lock_irqsave(&pl061->lock, flags); 148 149 gpioiev = readb(pl061->base + GPIOIEV); 150 gpiois = readb(pl061->base + GPIOIS); 151 gpioibe = readb(pl061->base + GPIOIBE); 152 153 if (trigger & (IRQ_TYPE_LEVEL_HIGH | IRQ_TYPE_LEVEL_LOW)) { 154 bool polarity = trigger & IRQ_TYPE_LEVEL_HIGH; 155 156 /* Disable edge detection */ 157 gpioibe &= ~bit; 158 /* Enable level detection */ 159 gpiois |= bit; 160 /* Select polarity */ 161 if (polarity) 162 gpioiev |= bit; 163 else 164 gpioiev &= ~bit; 165 irq_set_handler_locked(d, handle_level_irq); 166 dev_dbg(gc->parent, "line %d: IRQ on %s level\n", 167 offset, 168 polarity ? "HIGH" : "LOW"); 169 } else if ((trigger & IRQ_TYPE_EDGE_BOTH) == IRQ_TYPE_EDGE_BOTH) { 170 /* Disable level detection */ 171 gpiois &= ~bit; 172 /* Select both edges, setting this makes GPIOEV be ignored */ 173 gpioibe |= bit; 174 irq_set_handler_locked(d, handle_edge_irq); 175 dev_dbg(gc->parent, "line %d: IRQ on both edges\n", offset); 176 } else if ((trigger & IRQ_TYPE_EDGE_RISING) || 177 (trigger & IRQ_TYPE_EDGE_FALLING)) { 178 bool rising = trigger & IRQ_TYPE_EDGE_RISING; 179 180 /* Disable level detection */ 181 gpiois &= ~bit; 182 /* Clear detection on both edges */ 183 gpioibe &= ~bit; 184 /* Select edge */ 185 if (rising) 186 gpioiev |= bit; 187 else 188 gpioiev &= ~bit; 189 irq_set_handler_locked(d, handle_edge_irq); 190 dev_dbg(gc->parent, "line %d: IRQ on %s edge\n", 191 offset, 192 rising ? "RISING" : "FALLING"); 193 } else { 194 /* No trigger: disable everything */ 195 gpiois &= ~bit; 196 gpioibe &= ~bit; 197 gpioiev &= ~bit; 198 irq_set_handler_locked(d, handle_bad_irq); 199 dev_warn(gc->parent, "no trigger selected for line %d\n", 200 offset); 201 } 202 203 writeb(gpiois, pl061->base + GPIOIS); 204 writeb(gpioibe, pl061->base + GPIOIBE); 205 writeb(gpioiev, pl061->base + GPIOIEV); 206 207 raw_spin_unlock_irqrestore(&pl061->lock, flags); 208 209 return 0; 210 } 211 212 static void pl061_irq_handler(struct irq_desc *desc) 213 { 214 unsigned long pending; 215 int offset; 216 struct gpio_chip *gc = irq_desc_get_handler_data(desc); 217 struct pl061 *pl061 = gpiochip_get_data(gc); 218 struct irq_chip *irqchip = irq_desc_get_chip(desc); 219 220 chained_irq_enter(irqchip, desc); 221 222 pending = readb(pl061->base + GPIOMIS); 223 if (pending) { 224 for_each_set_bit(offset, &pending, PL061_GPIO_NR) 225 generic_handle_irq(irq_find_mapping(gc->irq.domain, 226 offset)); 227 } 228 229 chained_irq_exit(irqchip, desc); 230 } 231 232 static void pl061_irq_mask(struct irq_data *d) 233 { 234 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 235 struct pl061 *pl061 = gpiochip_get_data(gc); 236 u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR); 237 u8 gpioie; 238 239 raw_spin_lock(&pl061->lock); 240 gpioie = readb(pl061->base + GPIOIE) & ~mask; 241 writeb(gpioie, pl061->base + GPIOIE); 242 raw_spin_unlock(&pl061->lock); 243 } 244 245 static void pl061_irq_unmask(struct irq_data *d) 246 { 247 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 248 struct pl061 *pl061 = gpiochip_get_data(gc); 249 u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR); 250 u8 gpioie; 251 252 raw_spin_lock(&pl061->lock); 253 gpioie = readb(pl061->base + GPIOIE) | mask; 254 writeb(gpioie, pl061->base + GPIOIE); 255 raw_spin_unlock(&pl061->lock); 256 } 257 258 /** 259 * pl061_irq_ack() - ACK an edge IRQ 260 * @d: IRQ data for this IRQ 261 * 262 * This gets called from the edge IRQ handler to ACK the edge IRQ 263 * in the GPIOIC (interrupt-clear) register. For level IRQs this is 264 * not needed: these go away when the level signal goes away. 265 */ 266 static void pl061_irq_ack(struct irq_data *d) 267 { 268 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 269 struct pl061 *pl061 = gpiochip_get_data(gc); 270 u8 mask = BIT(irqd_to_hwirq(d) % PL061_GPIO_NR); 271 272 raw_spin_lock(&pl061->lock); 273 writeb(mask, pl061->base + GPIOIC); 274 raw_spin_unlock(&pl061->lock); 275 } 276 277 static int pl061_irq_set_wake(struct irq_data *d, unsigned int state) 278 { 279 struct gpio_chip *gc = irq_data_get_irq_chip_data(d); 280 struct pl061 *pl061 = gpiochip_get_data(gc); 281 282 return irq_set_irq_wake(pl061->parent_irq, state); 283 } 284 285 static int pl061_probe(struct amba_device *adev, const struct amba_id *id) 286 { 287 struct device *dev = &adev->dev; 288 struct pl061 *pl061; 289 struct gpio_irq_chip *girq; 290 int ret, irq; 291 292 pl061 = devm_kzalloc(dev, sizeof(*pl061), GFP_KERNEL); 293 if (pl061 == NULL) 294 return -ENOMEM; 295 296 pl061->base = devm_ioremap_resource(dev, &adev->res); 297 if (IS_ERR(pl061->base)) 298 return PTR_ERR(pl061->base); 299 300 raw_spin_lock_init(&pl061->lock); 301 if (of_property_read_bool(dev->of_node, "gpio-ranges")) { 302 pl061->gc.request = gpiochip_generic_request; 303 pl061->gc.free = gpiochip_generic_free; 304 } 305 306 pl061->gc.base = -1; 307 pl061->gc.get_direction = pl061_get_direction; 308 pl061->gc.direction_input = pl061_direction_input; 309 pl061->gc.direction_output = pl061_direction_output; 310 pl061->gc.get = pl061_get_value; 311 pl061->gc.set = pl061_set_value; 312 pl061->gc.ngpio = PL061_GPIO_NR; 313 pl061->gc.label = dev_name(dev); 314 pl061->gc.parent = dev; 315 pl061->gc.owner = THIS_MODULE; 316 317 /* 318 * irq_chip support 319 */ 320 pl061->irq_chip.name = dev_name(dev); 321 pl061->irq_chip.irq_ack = pl061_irq_ack; 322 pl061->irq_chip.irq_mask = pl061_irq_mask; 323 pl061->irq_chip.irq_unmask = pl061_irq_unmask; 324 pl061->irq_chip.irq_set_type = pl061_irq_type; 325 pl061->irq_chip.irq_set_wake = pl061_irq_set_wake; 326 327 writeb(0, pl061->base + GPIOIE); /* disable irqs */ 328 irq = adev->irq[0]; 329 if (irq < 0) { 330 dev_err(&adev->dev, "invalid IRQ\n"); 331 return -ENODEV; 332 } 333 pl061->parent_irq = irq; 334 335 girq = &pl061->gc.irq; 336 girq->chip = &pl061->irq_chip; 337 girq->parent_handler = pl061_irq_handler; 338 girq->num_parents = 1; 339 girq->parents = devm_kcalloc(dev, 1, sizeof(*girq->parents), 340 GFP_KERNEL); 341 if (!girq->parents) 342 return -ENOMEM; 343 girq->parents[0] = irq; 344 girq->default_type = IRQ_TYPE_NONE; 345 girq->handler = handle_bad_irq; 346 347 ret = devm_gpiochip_add_data(dev, &pl061->gc, pl061); 348 if (ret) 349 return ret; 350 351 amba_set_drvdata(adev, pl061); 352 dev_info(dev, "PL061 GPIO chip registered\n"); 353 354 return 0; 355 } 356 357 #ifdef CONFIG_PM 358 static int pl061_suspend(struct device *dev) 359 { 360 struct pl061 *pl061 = dev_get_drvdata(dev); 361 int offset; 362 363 pl061->csave_regs.gpio_data = 0; 364 pl061->csave_regs.gpio_dir = readb(pl061->base + GPIODIR); 365 pl061->csave_regs.gpio_is = readb(pl061->base + GPIOIS); 366 pl061->csave_regs.gpio_ibe = readb(pl061->base + GPIOIBE); 367 pl061->csave_regs.gpio_iev = readb(pl061->base + GPIOIEV); 368 pl061->csave_regs.gpio_ie = readb(pl061->base + GPIOIE); 369 370 for (offset = 0; offset < PL061_GPIO_NR; offset++) { 371 if (pl061->csave_regs.gpio_dir & (BIT(offset))) 372 pl061->csave_regs.gpio_data |= 373 pl061_get_value(&pl061->gc, offset) << offset; 374 } 375 376 return 0; 377 } 378 379 static int pl061_resume(struct device *dev) 380 { 381 struct pl061 *pl061 = dev_get_drvdata(dev); 382 int offset; 383 384 for (offset = 0; offset < PL061_GPIO_NR; offset++) { 385 if (pl061->csave_regs.gpio_dir & (BIT(offset))) 386 pl061_direction_output(&pl061->gc, offset, 387 pl061->csave_regs.gpio_data & 388 (BIT(offset))); 389 else 390 pl061_direction_input(&pl061->gc, offset); 391 } 392 393 writeb(pl061->csave_regs.gpio_is, pl061->base + GPIOIS); 394 writeb(pl061->csave_regs.gpio_ibe, pl061->base + GPIOIBE); 395 writeb(pl061->csave_regs.gpio_iev, pl061->base + GPIOIEV); 396 writeb(pl061->csave_regs.gpio_ie, pl061->base + GPIOIE); 397 398 return 0; 399 } 400 401 static const struct dev_pm_ops pl061_dev_pm_ops = { 402 .suspend = pl061_suspend, 403 .resume = pl061_resume, 404 .freeze = pl061_suspend, 405 .restore = pl061_resume, 406 }; 407 #endif 408 409 static const struct amba_id pl061_ids[] = { 410 { 411 .id = 0x00041061, 412 .mask = 0x000fffff, 413 }, 414 { 0, 0 }, 415 }; 416 417 static struct amba_driver pl061_gpio_driver = { 418 .drv = { 419 .name = "pl061_gpio", 420 #ifdef CONFIG_PM 421 .pm = &pl061_dev_pm_ops, 422 #endif 423 }, 424 .id_table = pl061_ids, 425 .probe = pl061_probe, 426 }; 427 428 static int __init pl061_gpio_init(void) 429 { 430 return amba_driver_register(&pl061_gpio_driver); 431 } 432 device_initcall(pl061_gpio_init); 433