1df6df93cSAndrew F. Davis /* 2df6df93cSAndrew F. Davis * Copyright (C) 2015 Texas Instruments Incorporated - http://www.ti.com/ 3df6df93cSAndrew F. Davis * Andrew F. Davis <afd@ti.com> 4df6df93cSAndrew F. Davis * 5df6df93cSAndrew F. Davis * This program is free software; you can redistribute it and/or 6df6df93cSAndrew F. Davis * modify it under the terms of the GNU General Public License version 2 as 7df6df93cSAndrew F. Davis * published by the Free Software Foundation. 8df6df93cSAndrew F. Davis * 9df6df93cSAndrew F. Davis * This program is distributed "as is" WITHOUT ANY WARRANTY of any 10df6df93cSAndrew F. Davis * kind, whether expressed or implied; without even the implied warranty 11df6df93cSAndrew F. Davis * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 12df6df93cSAndrew F. Davis * GNU General Public License version 2 for more details. 13df6df93cSAndrew F. Davis */ 14df6df93cSAndrew F. Davis 1540bb5d72SMorten Hein Tiljeset #include <linux/bitmap.h> 1640bb5d72SMorten Hein Tiljeset #include <linux/bitops.h> 17df6df93cSAndrew F. Davis #include <linux/delay.h> 18df6df93cSAndrew F. Davis #include <linux/gpio/consumer.h> 19df6df93cSAndrew F. Davis #include <linux/gpio/driver.h> 20df6df93cSAndrew F. Davis #include <linux/module.h> 21df6df93cSAndrew F. Davis #include <linux/mutex.h> 22df6df93cSAndrew F. Davis #include <linux/spi/spi.h> 23df6df93cSAndrew F. Davis 24df6df93cSAndrew F. Davis #define DEFAULT_NGPIO 8 25df6df93cSAndrew F. Davis 26df6df93cSAndrew F. Davis /** 27df6df93cSAndrew F. Davis * struct pisosr_gpio - GPIO driver data 28df6df93cSAndrew F. Davis * @chip: GPIO controller chip 29df6df93cSAndrew F. Davis * @spi: SPI device pointer 30df6df93cSAndrew F. Davis * @buffer: Buffer for device reads 31df6df93cSAndrew F. Davis * @buffer_size: Size of buffer 32df6df93cSAndrew F. Davis * @load_gpio: GPIO pin used to load input into device 33df6df93cSAndrew F. Davis * @lock: Protects read sequences 34df6df93cSAndrew F. Davis */ 35df6df93cSAndrew F. Davis struct pisosr_gpio { 36df6df93cSAndrew F. Davis struct gpio_chip chip; 37df6df93cSAndrew F. Davis struct spi_device *spi; 38df6df93cSAndrew F. Davis u8 *buffer; 39df6df93cSAndrew F. Davis size_t buffer_size; 40df6df93cSAndrew F. Davis struct gpio_desc *load_gpio; 41df6df93cSAndrew F. Davis struct mutex lock; 42df6df93cSAndrew F. Davis }; 43df6df93cSAndrew F. Davis 44df6df93cSAndrew F. Davis static int pisosr_gpio_refresh(struct pisosr_gpio *gpio) 45df6df93cSAndrew F. Davis { 46df6df93cSAndrew F. Davis int ret; 47df6df93cSAndrew F. Davis 48df6df93cSAndrew F. Davis mutex_lock(&gpio->lock); 49df6df93cSAndrew F. Davis 50df6df93cSAndrew F. Davis if (gpio->load_gpio) { 51ea04a7caSAxel Lin gpiod_set_value_cansleep(gpio->load_gpio, 1); 52df6df93cSAndrew F. Davis udelay(1); /* registers load time (~10ns) */ 53ea04a7caSAxel Lin gpiod_set_value_cansleep(gpio->load_gpio, 0); 54df6df93cSAndrew F. Davis udelay(1); /* registers recovery time (~5ns) */ 55df6df93cSAndrew F. Davis } 56df6df93cSAndrew F. Davis 57df6df93cSAndrew F. Davis ret = spi_read(gpio->spi, gpio->buffer, gpio->buffer_size); 58df6df93cSAndrew F. Davis 59df6df93cSAndrew F. Davis mutex_unlock(&gpio->lock); 60df6df93cSAndrew F. Davis 613e089d9fSSudip Mukherjee return ret; 62df6df93cSAndrew F. Davis } 63df6df93cSAndrew F. Davis 64df6df93cSAndrew F. Davis static int pisosr_gpio_get_direction(struct gpio_chip *chip, 65df6df93cSAndrew F. Davis unsigned offset) 66df6df93cSAndrew F. Davis { 67df6df93cSAndrew F. Davis /* This device always input */ 68df6df93cSAndrew F. Davis return 1; 69df6df93cSAndrew F. Davis } 70df6df93cSAndrew F. Davis 71df6df93cSAndrew F. Davis static int pisosr_gpio_direction_input(struct gpio_chip *chip, 72df6df93cSAndrew F. Davis unsigned offset) 73df6df93cSAndrew F. Davis { 74df6df93cSAndrew F. Davis /* This device always input */ 75df6df93cSAndrew F. Davis return 0; 76df6df93cSAndrew F. Davis } 77df6df93cSAndrew F. Davis 78df6df93cSAndrew F. Davis static int pisosr_gpio_direction_output(struct gpio_chip *chip, 79df6df93cSAndrew F. Davis unsigned offset, int value) 80df6df93cSAndrew F. Davis { 81df6df93cSAndrew F. Davis /* This device is input only */ 82df6df93cSAndrew F. Davis return -EINVAL; 83df6df93cSAndrew F. Davis } 84df6df93cSAndrew F. Davis 85df6df93cSAndrew F. Davis static int pisosr_gpio_get(struct gpio_chip *chip, unsigned offset) 86df6df93cSAndrew F. Davis { 87df6df93cSAndrew F. Davis struct pisosr_gpio *gpio = gpiochip_get_data(chip); 88df6df93cSAndrew F. Davis 89df6df93cSAndrew F. Davis /* Refresh may not always be needed */ 90df6df93cSAndrew F. Davis pisosr_gpio_refresh(gpio); 91df6df93cSAndrew F. Davis 92df6df93cSAndrew F. Davis return (gpio->buffer[offset / 8] >> (offset % 8)) & 0x1; 93df6df93cSAndrew F. Davis } 94df6df93cSAndrew F. Davis 9540bb5d72SMorten Hein Tiljeset static int pisosr_gpio_get_multiple(struct gpio_chip *chip, 9640bb5d72SMorten Hein Tiljeset unsigned long *mask, unsigned long *bits) 9740bb5d72SMorten Hein Tiljeset { 9840bb5d72SMorten Hein Tiljeset struct pisosr_gpio *gpio = gpiochip_get_data(chip); 9940bb5d72SMorten Hein Tiljeset unsigned int nbytes = DIV_ROUND_UP(chip->ngpio, 8); 10040bb5d72SMorten Hein Tiljeset unsigned int i, j; 10140bb5d72SMorten Hein Tiljeset 10240bb5d72SMorten Hein Tiljeset pisosr_gpio_refresh(gpio); 10340bb5d72SMorten Hein Tiljeset 10440bb5d72SMorten Hein Tiljeset bitmap_zero(bits, chip->ngpio); 10540bb5d72SMorten Hein Tiljeset for (i = 0; i < nbytes; i++) { 10640bb5d72SMorten Hein Tiljeset j = i / sizeof(unsigned long); 10740bb5d72SMorten Hein Tiljeset bits[j] |= ((unsigned long) gpio->buffer[i]) 10840bb5d72SMorten Hein Tiljeset << (8 * (i % sizeof(unsigned long))); 10940bb5d72SMorten Hein Tiljeset } 11040bb5d72SMorten Hein Tiljeset 11140bb5d72SMorten Hein Tiljeset return 0; 11240bb5d72SMorten Hein Tiljeset } 11340bb5d72SMorten Hein Tiljeset 114e35b5ab0SJulia Lawall static const struct gpio_chip template_chip = { 115df6df93cSAndrew F. Davis .label = "pisosr-gpio", 116df6df93cSAndrew F. Davis .owner = THIS_MODULE, 117df6df93cSAndrew F. Davis .get_direction = pisosr_gpio_get_direction, 118df6df93cSAndrew F. Davis .direction_input = pisosr_gpio_direction_input, 119df6df93cSAndrew F. Davis .direction_output = pisosr_gpio_direction_output, 120df6df93cSAndrew F. Davis .get = pisosr_gpio_get, 12140bb5d72SMorten Hein Tiljeset .get_multiple = pisosr_gpio_get_multiple, 122df6df93cSAndrew F. Davis .base = -1, 123df6df93cSAndrew F. Davis .ngpio = DEFAULT_NGPIO, 124df6df93cSAndrew F. Davis .can_sleep = true, 125df6df93cSAndrew F. Davis }; 126df6df93cSAndrew F. Davis 127df6df93cSAndrew F. Davis static int pisosr_gpio_probe(struct spi_device *spi) 128df6df93cSAndrew F. Davis { 129df6df93cSAndrew F. Davis struct device *dev = &spi->dev; 130df6df93cSAndrew F. Davis struct pisosr_gpio *gpio; 131df6df93cSAndrew F. Davis int ret; 132df6df93cSAndrew F. Davis 133df6df93cSAndrew F. Davis gpio = devm_kzalloc(dev, sizeof(*gpio), GFP_KERNEL); 134df6df93cSAndrew F. Davis if (!gpio) 135df6df93cSAndrew F. Davis return -ENOMEM; 136df6df93cSAndrew F. Davis 137df6df93cSAndrew F. Davis spi_set_drvdata(spi, gpio); 138df6df93cSAndrew F. Davis 139df6df93cSAndrew F. Davis gpio->chip = template_chip; 140df6df93cSAndrew F. Davis gpio->chip.parent = dev; 141df6df93cSAndrew F. Davis of_property_read_u16(dev->of_node, "ngpios", &gpio->chip.ngpio); 142df6df93cSAndrew F. Davis 143df6df93cSAndrew F. Davis gpio->spi = spi; 144df6df93cSAndrew F. Davis 145df6df93cSAndrew F. Davis gpio->buffer_size = DIV_ROUND_UP(gpio->chip.ngpio, 8); 146df6df93cSAndrew F. Davis gpio->buffer = devm_kzalloc(dev, gpio->buffer_size, GFP_KERNEL); 147df6df93cSAndrew F. Davis if (!gpio->buffer) 148df6df93cSAndrew F. Davis return -ENOMEM; 149df6df93cSAndrew F. Davis 15021d08ab9SAxel Lin gpio->load_gpio = devm_gpiod_get_optional(dev, "load", GPIOD_OUT_LOW); 151df6df93cSAndrew F. Davis if (IS_ERR(gpio->load_gpio)) { 152df6df93cSAndrew F. Davis ret = PTR_ERR(gpio->load_gpio); 153df6df93cSAndrew F. Davis if (ret != -EPROBE_DEFER) 154df6df93cSAndrew F. Davis dev_err(dev, "Unable to allocate load GPIO\n"); 155df6df93cSAndrew F. Davis return ret; 156df6df93cSAndrew F. Davis } 157df6df93cSAndrew F. Davis 158df6df93cSAndrew F. Davis mutex_init(&gpio->lock); 159df6df93cSAndrew F. Davis 160df6df93cSAndrew F. Davis ret = gpiochip_add_data(&gpio->chip, gpio); 161df6df93cSAndrew F. Davis if (ret < 0) { 162df6df93cSAndrew F. Davis dev_err(dev, "Unable to register gpiochip\n"); 163df6df93cSAndrew F. Davis return ret; 164df6df93cSAndrew F. Davis } 165df6df93cSAndrew F. Davis 166df6df93cSAndrew F. Davis return 0; 167df6df93cSAndrew F. Davis } 168df6df93cSAndrew F. Davis 169df6df93cSAndrew F. Davis static int pisosr_gpio_remove(struct spi_device *spi) 170df6df93cSAndrew F. Davis { 171df6df93cSAndrew F. Davis struct pisosr_gpio *gpio = spi_get_drvdata(spi); 172df6df93cSAndrew F. Davis 173df6df93cSAndrew F. Davis gpiochip_remove(&gpio->chip); 174df6df93cSAndrew F. Davis 175df6df93cSAndrew F. Davis mutex_destroy(&gpio->lock); 176df6df93cSAndrew F. Davis 177df6df93cSAndrew F. Davis return 0; 178df6df93cSAndrew F. Davis } 179df6df93cSAndrew F. Davis 180df6df93cSAndrew F. Davis static const struct spi_device_id pisosr_gpio_id_table[] = { 181df6df93cSAndrew F. Davis { "pisosr-gpio", }, 182df6df93cSAndrew F. Davis { /* sentinel */ } 183df6df93cSAndrew F. Davis }; 184df6df93cSAndrew F. Davis MODULE_DEVICE_TABLE(spi, pisosr_gpio_id_table); 185df6df93cSAndrew F. Davis 186df6df93cSAndrew F. Davis static const struct of_device_id pisosr_gpio_of_match_table[] = { 187df6df93cSAndrew F. Davis { .compatible = "pisosr-gpio", }, 188df6df93cSAndrew F. Davis { /* sentinel */ } 189df6df93cSAndrew F. Davis }; 190df6df93cSAndrew F. Davis MODULE_DEVICE_TABLE(of, pisosr_gpio_of_match_table); 191df6df93cSAndrew F. Davis 192df6df93cSAndrew F. Davis static struct spi_driver pisosr_gpio_driver = { 193df6df93cSAndrew F. Davis .driver = { 194df6df93cSAndrew F. Davis .name = "pisosr-gpio", 195df6df93cSAndrew F. Davis .of_match_table = pisosr_gpio_of_match_table, 196df6df93cSAndrew F. Davis }, 197df6df93cSAndrew F. Davis .probe = pisosr_gpio_probe, 198df6df93cSAndrew F. Davis .remove = pisosr_gpio_remove, 199df6df93cSAndrew F. Davis .id_table = pisosr_gpio_id_table, 200df6df93cSAndrew F. Davis }; 201df6df93cSAndrew F. Davis module_spi_driver(pisosr_gpio_driver); 202df6df93cSAndrew F. Davis 203df6df93cSAndrew F. Davis MODULE_AUTHOR("Andrew F. Davis <afd@ti.com>"); 204df6df93cSAndrew F. Davis MODULE_DESCRIPTION("SPI Compatible PISO Shift Register GPIO Driver"); 205df6df93cSAndrew F. Davis MODULE_LICENSE("GPL v2"); 206