1 // SPDX-License-Identifier: GPL-2.0-only 2 /* 3 * Driver for the Diolan DLN-2 USB-GPIO adapter 4 * 5 * Copyright (c) 2014 Intel Corporation 6 */ 7 8 #include <linux/kernel.h> 9 #include <linux/module.h> 10 #include <linux/slab.h> 11 #include <linux/types.h> 12 #include <linux/irqdomain.h> 13 #include <linux/irq.h> 14 #include <linux/irqchip/chained_irq.h> 15 #include <linux/gpio/driver.h> 16 #include <linux/platform_device.h> 17 #include <linux/mfd/dln2.h> 18 19 #define DLN2_GPIO_ID 0x01 20 21 #define DLN2_GPIO_GET_PIN_COUNT DLN2_CMD(0x01, DLN2_GPIO_ID) 22 #define DLN2_GPIO_SET_DEBOUNCE DLN2_CMD(0x04, DLN2_GPIO_ID) 23 #define DLN2_GPIO_GET_DEBOUNCE DLN2_CMD(0x05, DLN2_GPIO_ID) 24 #define DLN2_GPIO_PORT_GET_VAL DLN2_CMD(0x06, DLN2_GPIO_ID) 25 #define DLN2_GPIO_PIN_GET_VAL DLN2_CMD(0x0B, DLN2_GPIO_ID) 26 #define DLN2_GPIO_PIN_SET_OUT_VAL DLN2_CMD(0x0C, DLN2_GPIO_ID) 27 #define DLN2_GPIO_PIN_GET_OUT_VAL DLN2_CMD(0x0D, DLN2_GPIO_ID) 28 #define DLN2_GPIO_CONDITION_MET_EV DLN2_CMD(0x0F, DLN2_GPIO_ID) 29 #define DLN2_GPIO_PIN_ENABLE DLN2_CMD(0x10, DLN2_GPIO_ID) 30 #define DLN2_GPIO_PIN_DISABLE DLN2_CMD(0x11, DLN2_GPIO_ID) 31 #define DLN2_GPIO_PIN_SET_DIRECTION DLN2_CMD(0x13, DLN2_GPIO_ID) 32 #define DLN2_GPIO_PIN_GET_DIRECTION DLN2_CMD(0x14, DLN2_GPIO_ID) 33 #define DLN2_GPIO_PIN_SET_EVENT_CFG DLN2_CMD(0x1E, DLN2_GPIO_ID) 34 #define DLN2_GPIO_PIN_GET_EVENT_CFG DLN2_CMD(0x1F, DLN2_GPIO_ID) 35 36 #define DLN2_GPIO_EVENT_NONE 0 37 #define DLN2_GPIO_EVENT_CHANGE 1 38 #define DLN2_GPIO_EVENT_LVL_HIGH 2 39 #define DLN2_GPIO_EVENT_LVL_LOW 3 40 #define DLN2_GPIO_EVENT_CHANGE_RISING 0x11 41 #define DLN2_GPIO_EVENT_CHANGE_FALLING 0x21 42 #define DLN2_GPIO_EVENT_MASK 0x0F 43 44 #define DLN2_GPIO_MAX_PINS 32 45 46 struct dln2_gpio { 47 struct platform_device *pdev; 48 struct gpio_chip gpio; 49 50 /* 51 * Cache pin direction to save us one transfer, since the hardware has 52 * separate commands to read the in and out values. 53 */ 54 DECLARE_BITMAP(output_enabled, DLN2_GPIO_MAX_PINS); 55 56 /* active IRQs - not synced to hardware */ 57 DECLARE_BITMAP(unmasked_irqs, DLN2_GPIO_MAX_PINS); 58 /* active IRQS - synced to hardware */ 59 DECLARE_BITMAP(enabled_irqs, DLN2_GPIO_MAX_PINS); 60 int irq_type[DLN2_GPIO_MAX_PINS]; 61 struct mutex irq_lock; 62 }; 63 64 struct dln2_gpio_pin { 65 __le16 pin; 66 }; 67 68 struct dln2_gpio_pin_val { 69 __le16 pin __packed; 70 u8 value; 71 }; 72 73 static int dln2_gpio_get_pin_count(struct platform_device *pdev) 74 { 75 int ret; 76 __le16 count; 77 int len = sizeof(count); 78 79 ret = dln2_transfer_rx(pdev, DLN2_GPIO_GET_PIN_COUNT, &count, &len); 80 if (ret < 0) 81 return ret; 82 if (len < sizeof(count)) 83 return -EPROTO; 84 85 return le16_to_cpu(count); 86 } 87 88 static int dln2_gpio_pin_cmd(struct dln2_gpio *dln2, int cmd, unsigned pin) 89 { 90 struct dln2_gpio_pin req = { 91 .pin = cpu_to_le16(pin), 92 }; 93 94 return dln2_transfer_tx(dln2->pdev, cmd, &req, sizeof(req)); 95 } 96 97 static int dln2_gpio_pin_val(struct dln2_gpio *dln2, int cmd, unsigned int pin) 98 { 99 int ret; 100 struct dln2_gpio_pin req = { 101 .pin = cpu_to_le16(pin), 102 }; 103 struct dln2_gpio_pin_val rsp; 104 int len = sizeof(rsp); 105 106 ret = dln2_transfer(dln2->pdev, cmd, &req, sizeof(req), &rsp, &len); 107 if (ret < 0) 108 return ret; 109 if (len < sizeof(rsp) || req.pin != rsp.pin) 110 return -EPROTO; 111 112 return rsp.value; 113 } 114 115 static int dln2_gpio_pin_get_in_val(struct dln2_gpio *dln2, unsigned int pin) 116 { 117 int ret; 118 119 ret = dln2_gpio_pin_val(dln2, DLN2_GPIO_PIN_GET_VAL, pin); 120 if (ret < 0) 121 return ret; 122 return !!ret; 123 } 124 125 static int dln2_gpio_pin_get_out_val(struct dln2_gpio *dln2, unsigned int pin) 126 { 127 int ret; 128 129 ret = dln2_gpio_pin_val(dln2, DLN2_GPIO_PIN_GET_OUT_VAL, pin); 130 if (ret < 0) 131 return ret; 132 return !!ret; 133 } 134 135 static int dln2_gpio_pin_set_out_val(struct dln2_gpio *dln2, 136 unsigned int pin, int value) 137 { 138 struct dln2_gpio_pin_val req = { 139 .pin = cpu_to_le16(pin), 140 .value = value, 141 }; 142 143 return dln2_transfer_tx(dln2->pdev, DLN2_GPIO_PIN_SET_OUT_VAL, &req, 144 sizeof(req)); 145 } 146 147 #define DLN2_GPIO_DIRECTION_IN 0 148 #define DLN2_GPIO_DIRECTION_OUT 1 149 150 static int dln2_gpio_request(struct gpio_chip *chip, unsigned offset) 151 { 152 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 153 struct dln2_gpio_pin req = { 154 .pin = cpu_to_le16(offset), 155 }; 156 struct dln2_gpio_pin_val rsp; 157 int len = sizeof(rsp); 158 int ret; 159 160 ret = dln2_gpio_pin_cmd(dln2, DLN2_GPIO_PIN_ENABLE, offset); 161 if (ret < 0) 162 return ret; 163 164 /* cache the pin direction */ 165 ret = dln2_transfer(dln2->pdev, DLN2_GPIO_PIN_GET_DIRECTION, 166 &req, sizeof(req), &rsp, &len); 167 if (ret < 0) 168 return ret; 169 if (len < sizeof(rsp) || req.pin != rsp.pin) { 170 ret = -EPROTO; 171 goto out_disable; 172 } 173 174 switch (rsp.value) { 175 case DLN2_GPIO_DIRECTION_IN: 176 clear_bit(offset, dln2->output_enabled); 177 return 0; 178 case DLN2_GPIO_DIRECTION_OUT: 179 set_bit(offset, dln2->output_enabled); 180 return 0; 181 default: 182 ret = -EPROTO; 183 goto out_disable; 184 } 185 186 out_disable: 187 dln2_gpio_pin_cmd(dln2, DLN2_GPIO_PIN_DISABLE, offset); 188 return ret; 189 } 190 191 static void dln2_gpio_free(struct gpio_chip *chip, unsigned offset) 192 { 193 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 194 195 dln2_gpio_pin_cmd(dln2, DLN2_GPIO_PIN_DISABLE, offset); 196 } 197 198 static int dln2_gpio_get_direction(struct gpio_chip *chip, unsigned offset) 199 { 200 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 201 202 if (test_bit(offset, dln2->output_enabled)) 203 return GPIO_LINE_DIRECTION_OUT; 204 205 return GPIO_LINE_DIRECTION_IN; 206 } 207 208 static int dln2_gpio_get(struct gpio_chip *chip, unsigned int offset) 209 { 210 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 211 int dir; 212 213 dir = dln2_gpio_get_direction(chip, offset); 214 if (dir < 0) 215 return dir; 216 217 if (dir == GPIO_LINE_DIRECTION_IN) 218 return dln2_gpio_pin_get_in_val(dln2, offset); 219 220 return dln2_gpio_pin_get_out_val(dln2, offset); 221 } 222 223 static int dln2_gpio_set(struct gpio_chip *chip, unsigned int offset, 224 int value) 225 { 226 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 227 228 return dln2_gpio_pin_set_out_val(dln2, offset, value); 229 } 230 231 static int dln2_gpio_set_direction(struct gpio_chip *chip, unsigned offset, 232 unsigned dir) 233 { 234 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 235 struct dln2_gpio_pin_val req = { 236 .pin = cpu_to_le16(offset), 237 .value = dir, 238 }; 239 int ret; 240 241 ret = dln2_transfer_tx(dln2->pdev, DLN2_GPIO_PIN_SET_DIRECTION, 242 &req, sizeof(req)); 243 if (ret < 0) 244 return ret; 245 246 assign_bit(offset, dln2->output_enabled, 247 dir == DLN2_GPIO_DIRECTION_OUT); 248 249 return ret; 250 } 251 252 static int dln2_gpio_direction_input(struct gpio_chip *chip, unsigned offset) 253 { 254 return dln2_gpio_set_direction(chip, offset, DLN2_GPIO_DIRECTION_IN); 255 } 256 257 static int dln2_gpio_direction_output(struct gpio_chip *chip, unsigned offset, 258 int value) 259 { 260 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 261 int ret; 262 263 ret = dln2_gpio_pin_set_out_val(dln2, offset, value); 264 if (ret < 0) 265 return ret; 266 267 return dln2_gpio_set_direction(chip, offset, DLN2_GPIO_DIRECTION_OUT); 268 } 269 270 static int dln2_gpio_set_config(struct gpio_chip *chip, unsigned offset, 271 unsigned long config) 272 { 273 struct dln2_gpio *dln2 = gpiochip_get_data(chip); 274 __le32 duration; 275 276 if (pinconf_to_config_param(config) != PIN_CONFIG_INPUT_DEBOUNCE) 277 return -ENOTSUPP; 278 279 duration = cpu_to_le32(pinconf_to_config_argument(config)); 280 return dln2_transfer_tx(dln2->pdev, DLN2_GPIO_SET_DEBOUNCE, 281 &duration, sizeof(duration)); 282 } 283 284 static int dln2_gpio_set_event_cfg(struct dln2_gpio *dln2, unsigned pin, 285 unsigned type, unsigned period) 286 { 287 struct { 288 __le16 pin; 289 u8 type; 290 __le16 period; 291 } __packed req = { 292 .pin = cpu_to_le16(pin), 293 .type = type, 294 .period = cpu_to_le16(period), 295 }; 296 297 return dln2_transfer_tx(dln2->pdev, DLN2_GPIO_PIN_SET_EVENT_CFG, 298 &req, sizeof(req)); 299 } 300 301 static void dln2_irq_unmask(struct irq_data *irqd) 302 { 303 struct gpio_chip *gc = irq_data_get_irq_chip_data(irqd); 304 struct dln2_gpio *dln2 = gpiochip_get_data(gc); 305 int pin = irqd_to_hwirq(irqd); 306 307 gpiochip_enable_irq(gc, pin); 308 set_bit(pin, dln2->unmasked_irqs); 309 } 310 311 static void dln2_irq_mask(struct irq_data *irqd) 312 { 313 struct gpio_chip *gc = irq_data_get_irq_chip_data(irqd); 314 struct dln2_gpio *dln2 = gpiochip_get_data(gc); 315 int pin = irqd_to_hwirq(irqd); 316 317 clear_bit(pin, dln2->unmasked_irqs); 318 gpiochip_disable_irq(gc, pin); 319 } 320 321 static int dln2_irq_set_type(struct irq_data *irqd, unsigned type) 322 { 323 struct gpio_chip *gc = irq_data_get_irq_chip_data(irqd); 324 struct dln2_gpio *dln2 = gpiochip_get_data(gc); 325 int pin = irqd_to_hwirq(irqd); 326 327 switch (type) { 328 case IRQ_TYPE_LEVEL_HIGH: 329 dln2->irq_type[pin] = DLN2_GPIO_EVENT_LVL_HIGH; 330 break; 331 case IRQ_TYPE_LEVEL_LOW: 332 dln2->irq_type[pin] = DLN2_GPIO_EVENT_LVL_LOW; 333 break; 334 case IRQ_TYPE_EDGE_BOTH: 335 dln2->irq_type[pin] = DLN2_GPIO_EVENT_CHANGE; 336 break; 337 case IRQ_TYPE_EDGE_RISING: 338 dln2->irq_type[pin] = DLN2_GPIO_EVENT_CHANGE_RISING; 339 break; 340 case IRQ_TYPE_EDGE_FALLING: 341 dln2->irq_type[pin] = DLN2_GPIO_EVENT_CHANGE_FALLING; 342 break; 343 default: 344 return -EINVAL; 345 } 346 347 return 0; 348 } 349 350 static void dln2_irq_bus_lock(struct irq_data *irqd) 351 { 352 struct gpio_chip *gc = irq_data_get_irq_chip_data(irqd); 353 struct dln2_gpio *dln2 = gpiochip_get_data(gc); 354 355 mutex_lock(&dln2->irq_lock); 356 } 357 358 static void dln2_irq_bus_unlock(struct irq_data *irqd) 359 { 360 struct gpio_chip *gc = irq_data_get_irq_chip_data(irqd); 361 struct dln2_gpio *dln2 = gpiochip_get_data(gc); 362 int pin = irqd_to_hwirq(irqd); 363 int enabled, unmasked; 364 unsigned type; 365 int ret; 366 367 enabled = test_bit(pin, dln2->enabled_irqs); 368 unmasked = test_bit(pin, dln2->unmasked_irqs); 369 370 if (enabled != unmasked) { 371 if (unmasked) { 372 type = dln2->irq_type[pin] & DLN2_GPIO_EVENT_MASK; 373 set_bit(pin, dln2->enabled_irqs); 374 } else { 375 type = DLN2_GPIO_EVENT_NONE; 376 clear_bit(pin, dln2->enabled_irqs); 377 } 378 379 ret = dln2_gpio_set_event_cfg(dln2, pin, type, 0); 380 if (ret) 381 dev_err(dln2->gpio.parent, "failed to set event\n"); 382 } 383 384 mutex_unlock(&dln2->irq_lock); 385 } 386 387 static const struct irq_chip dln2_irqchip = { 388 .name = "dln2-irq", 389 .irq_mask = dln2_irq_mask, 390 .irq_unmask = dln2_irq_unmask, 391 .irq_set_type = dln2_irq_set_type, 392 .irq_bus_lock = dln2_irq_bus_lock, 393 .irq_bus_sync_unlock = dln2_irq_bus_unlock, 394 .flags = IRQCHIP_IMMUTABLE, 395 GPIOCHIP_IRQ_RESOURCE_HELPERS, 396 }; 397 398 static void dln2_gpio_event(struct platform_device *pdev, u16 echo, 399 const void *data, int len) 400 { 401 int pin, ret; 402 403 const struct { 404 __le16 count; 405 __u8 type; 406 __le16 pin; 407 __u8 value; 408 } __packed *event = data; 409 struct dln2_gpio *dln2 = platform_get_drvdata(pdev); 410 411 if (len < sizeof(*event)) { 412 dev_err(dln2->gpio.parent, "short event message\n"); 413 return; 414 } 415 416 pin = le16_to_cpu(event->pin); 417 if (pin >= dln2->gpio.ngpio) { 418 dev_err(dln2->gpio.parent, "out of bounds pin %d\n", pin); 419 return; 420 } 421 422 switch (dln2->irq_type[pin]) { 423 case DLN2_GPIO_EVENT_CHANGE_RISING: 424 if (!event->value) 425 return; 426 break; 427 case DLN2_GPIO_EVENT_CHANGE_FALLING: 428 if (event->value) 429 return; 430 break; 431 } 432 433 ret = generic_handle_domain_irq(dln2->gpio.irq.domain, pin); 434 if (unlikely(ret)) 435 dev_err(dln2->gpio.parent, "pin %d not mapped to IRQ\n", pin); 436 } 437 438 static int dln2_gpio_probe(struct platform_device *pdev) 439 { 440 struct dln2_gpio *dln2; 441 struct device *dev = &pdev->dev; 442 struct gpio_irq_chip *girq; 443 int pins; 444 int ret; 445 446 pins = dln2_gpio_get_pin_count(pdev); 447 if (pins < 0) { 448 dev_err(dev, "failed to get pin count: %d\n", pins); 449 return pins; 450 } 451 if (pins > DLN2_GPIO_MAX_PINS) { 452 pins = DLN2_GPIO_MAX_PINS; 453 dev_warn(dev, "clamping pins to %d\n", DLN2_GPIO_MAX_PINS); 454 } 455 456 dln2 = devm_kzalloc(&pdev->dev, sizeof(*dln2), GFP_KERNEL); 457 if (!dln2) 458 return -ENOMEM; 459 460 mutex_init(&dln2->irq_lock); 461 462 dln2->pdev = pdev; 463 464 dln2->gpio.label = "dln2"; 465 dln2->gpio.parent = dev; 466 dln2->gpio.owner = THIS_MODULE; 467 dln2->gpio.base = -1; 468 dln2->gpio.ngpio = pins; 469 dln2->gpio.can_sleep = true; 470 dln2->gpio.set = dln2_gpio_set; 471 dln2->gpio.get = dln2_gpio_get; 472 dln2->gpio.request = dln2_gpio_request; 473 dln2->gpio.free = dln2_gpio_free; 474 dln2->gpio.get_direction = dln2_gpio_get_direction; 475 dln2->gpio.direction_input = dln2_gpio_direction_input; 476 dln2->gpio.direction_output = dln2_gpio_direction_output; 477 dln2->gpio.set_config = dln2_gpio_set_config; 478 479 girq = &dln2->gpio.irq; 480 gpio_irq_chip_set_chip(girq, &dln2_irqchip); 481 /* The event comes from the outside so no parent handler */ 482 girq->parent_handler = NULL; 483 girq->num_parents = 0; 484 girq->parents = NULL; 485 girq->default_type = IRQ_TYPE_NONE; 486 girq->handler = handle_simple_irq; 487 488 platform_set_drvdata(pdev, dln2); 489 490 ret = devm_gpiochip_add_data(dev, &dln2->gpio, dln2); 491 if (ret < 0) { 492 dev_err(dev, "failed to add gpio chip: %d\n", ret); 493 return ret; 494 } 495 496 ret = dln2_register_event_cb(pdev, DLN2_GPIO_CONDITION_MET_EV, 497 dln2_gpio_event); 498 if (ret) { 499 dev_err(dev, "failed to register event cb: %d\n", ret); 500 return ret; 501 } 502 503 return 0; 504 } 505 506 static void dln2_gpio_remove(struct platform_device *pdev) 507 { 508 dln2_unregister_event_cb(pdev, DLN2_GPIO_CONDITION_MET_EV); 509 } 510 511 static struct platform_driver dln2_gpio_driver = { 512 .driver.name = "dln2-gpio", 513 .probe = dln2_gpio_probe, 514 .remove = dln2_gpio_remove, 515 }; 516 517 module_platform_driver(dln2_gpio_driver); 518 519 MODULE_AUTHOR("Daniel Baluta <daniel.baluta@intel.com"); 520 MODULE_DESCRIPTION("Driver for the Diolan DLN2 GPIO interface"); 521 MODULE_LICENSE("GPL v2"); 522 MODULE_ALIAS("platform:dln2-gpio"); 523