15704520dSNandor Han /* 25704520dSNandor Han * GPIO driver for EXAR XRA1403 16-bit GPIO expander 35704520dSNandor Han * 45704520dSNandor Han * Copyright (c) 2017, General Electric Company 55704520dSNandor Han * 65704520dSNandor Han * This program is free software; you can redistribute it and/or modify it 75704520dSNandor Han * under the terms and conditions of the GNU General Public License, 85704520dSNandor Han * version 2, as published by the Free Software Foundation. 95704520dSNandor Han * 105704520dSNandor Han * This program is distributed in the hope it will be useful, but WITHOUT 115704520dSNandor Han * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 125704520dSNandor Han * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for 135704520dSNandor Han * more details. 145704520dSNandor Han * 155704520dSNandor Han * You should have received a copy of the GNU General Public License 165704520dSNandor Han * along with this program. If not, see <http://www.gnu.org/licenses/>. 175704520dSNandor Han */ 185704520dSNandor Han 195704520dSNandor Han #include <linux/bitops.h> 205704520dSNandor Han #include <linux/gpio/driver.h> 215704520dSNandor Han #include <linux/kernel.h> 225704520dSNandor Han #include <linux/module.h> 235704520dSNandor Han #include <linux/mutex.h> 245704520dSNandor Han #include <linux/of_device.h> 255704520dSNandor Han #include <linux/of_gpio.h> 265704520dSNandor Han #include <linux/seq_file.h> 275704520dSNandor Han #include <linux/spi/spi.h> 285704520dSNandor Han #include <linux/regmap.h> 295704520dSNandor Han 305704520dSNandor Han /* XRA1403 registers */ 315704520dSNandor Han #define XRA_GSR 0x00 /* GPIO State */ 325704520dSNandor Han #define XRA_OCR 0x02 /* Output Control */ 335704520dSNandor Han #define XRA_PIR 0x04 /* Input Polarity Inversion */ 345704520dSNandor Han #define XRA_GCR 0x06 /* GPIO Configuration */ 355704520dSNandor Han #define XRA_PUR 0x08 /* Input Internal Pull-up Resistor Enable/Disable */ 365704520dSNandor Han #define XRA_IER 0x0A /* Input Interrupt Enable */ 375704520dSNandor Han #define XRA_TSCR 0x0C /* Output Three-State Control */ 385704520dSNandor Han #define XRA_ISR 0x0E /* Input Interrupt Status */ 395704520dSNandor Han #define XRA_REIR 0x10 /* Input Rising Edge Interrupt Enable */ 405704520dSNandor Han #define XRA_FEIR 0x12 /* Input Falling Edge Interrupt Enable */ 415704520dSNandor Han #define XRA_IFR 0x14 /* Input Filter Enable/Disable */ 4212f92cccSLaura Abbott #define XRA_LAST 0x15 /* Bounds */ 435704520dSNandor Han 445704520dSNandor Han struct xra1403 { 455704520dSNandor Han struct gpio_chip chip; 465704520dSNandor Han struct regmap *regmap; 475704520dSNandor Han }; 485704520dSNandor Han 495704520dSNandor Han static const struct regmap_config xra1403_regmap_cfg = { 505704520dSNandor Han .reg_bits = 7, 515704520dSNandor Han .pad_bits = 1, 525704520dSNandor Han .val_bits = 8, 535704520dSNandor Han 5412f92cccSLaura Abbott .max_register = XRA_LAST, 555704520dSNandor Han }; 565704520dSNandor Han 575704520dSNandor Han static unsigned int to_reg(unsigned int reg, unsigned int offset) 585704520dSNandor Han { 595704520dSNandor Han return reg + (offset > 7); 605704520dSNandor Han } 615704520dSNandor Han 625704520dSNandor Han static int xra1403_direction_input(struct gpio_chip *chip, unsigned int offset) 635704520dSNandor Han { 645704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 655704520dSNandor Han 665704520dSNandor Han return regmap_update_bits(xra->regmap, to_reg(XRA_GCR, offset), 675704520dSNandor Han BIT(offset % 8), BIT(offset % 8)); 685704520dSNandor Han } 695704520dSNandor Han 705704520dSNandor Han static int xra1403_direction_output(struct gpio_chip *chip, unsigned int offset, 715704520dSNandor Han int value) 725704520dSNandor Han { 735704520dSNandor Han int ret; 745704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 755704520dSNandor Han 765704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_GCR, offset), 775704520dSNandor Han BIT(offset % 8), 0); 785704520dSNandor Han if (ret) 795704520dSNandor Han return ret; 805704520dSNandor Han 815704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_OCR, offset), 825704520dSNandor Han BIT(offset % 8), value ? BIT(offset % 8) : 0); 835704520dSNandor Han 845704520dSNandor Han return ret; 855704520dSNandor Han } 865704520dSNandor Han 875704520dSNandor Han static int xra1403_get_direction(struct gpio_chip *chip, unsigned int offset) 885704520dSNandor Han { 895704520dSNandor Han int ret; 905704520dSNandor Han unsigned int val; 915704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 925704520dSNandor Han 935704520dSNandor Han ret = regmap_read(xra->regmap, to_reg(XRA_GCR, offset), &val); 945704520dSNandor Han if (ret) 955704520dSNandor Han return ret; 965704520dSNandor Han 975704520dSNandor Han return !!(val & BIT(offset % 8)); 985704520dSNandor Han } 995704520dSNandor Han 1005704520dSNandor Han static int xra1403_get(struct gpio_chip *chip, unsigned int offset) 1015704520dSNandor Han { 1025704520dSNandor Han int ret; 1035704520dSNandor Han unsigned int val; 1045704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 1055704520dSNandor Han 1065704520dSNandor Han ret = regmap_read(xra->regmap, to_reg(XRA_GSR, offset), &val); 1075704520dSNandor Han if (ret) 1085704520dSNandor Han return ret; 1095704520dSNandor Han 1105704520dSNandor Han return !!(val & BIT(offset % 8)); 1115704520dSNandor Han } 1125704520dSNandor Han 1135704520dSNandor Han static void xra1403_set(struct gpio_chip *chip, unsigned int offset, int value) 1145704520dSNandor Han { 1155704520dSNandor Han int ret; 1165704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 1175704520dSNandor Han 1185704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_OCR, offset), 1195704520dSNandor Han BIT(offset % 8), value ? BIT(offset % 8) : 0); 1205704520dSNandor Han if (ret) 1215704520dSNandor Han dev_err(chip->parent, "Failed to set pin: %d, ret: %d\n", 1225704520dSNandor Han offset, ret); 1235704520dSNandor Han } 1245704520dSNandor Han 1255704520dSNandor Han #ifdef CONFIG_DEBUG_FS 1265704520dSNandor Han static void xra1403_dbg_show(struct seq_file *s, struct gpio_chip *chip) 1275704520dSNandor Han { 1285704520dSNandor Han int reg; 1295704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip); 13012f92cccSLaura Abbott int value[XRA_LAST]; 1315704520dSNandor Han int i; 1325704520dSNandor Han unsigned int gcr; 1335704520dSNandor Han unsigned int gsr; 1345704520dSNandor Han 1355704520dSNandor Han seq_puts(s, "xra reg:"); 13612f92cccSLaura Abbott for (reg = 0; reg <= XRA_LAST; reg++) 1375704520dSNandor Han seq_printf(s, " %2.2x", reg); 1385704520dSNandor Han seq_puts(s, "\n value:"); 13912f92cccSLaura Abbott for (reg = 0; reg < XRA_LAST; reg++) { 1405704520dSNandor Han regmap_read(xra->regmap, reg, &value[reg]); 1415704520dSNandor Han seq_printf(s, " %2.2x", value[reg]); 1425704520dSNandor Han } 1435704520dSNandor Han seq_puts(s, "\n"); 1445704520dSNandor Han 1455704520dSNandor Han gcr = value[XRA_GCR + 1] << 8 | value[XRA_GCR]; 1465704520dSNandor Han gsr = value[XRA_GSR + 1] << 8 | value[XRA_GSR]; 1475704520dSNandor Han for (i = 0; i < chip->ngpio; i++) { 1485704520dSNandor Han const char *label = gpiochip_is_requested(chip, i); 1495704520dSNandor Han 1505704520dSNandor Han if (!label) 1515704520dSNandor Han continue; 1525704520dSNandor Han 1535704520dSNandor Han seq_printf(s, " gpio-%-3d (%-12s) %s %s\n", 1545704520dSNandor Han chip->base + i, label, 1555704520dSNandor Han (gcr & BIT(i)) ? "in" : "out", 1565704520dSNandor Han (gsr & BIT(i)) ? "hi" : "lo"); 1575704520dSNandor Han } 1585704520dSNandor Han } 1595704520dSNandor Han #else 1605704520dSNandor Han #define xra1403_dbg_show NULL 1615704520dSNandor Han #endif 1625704520dSNandor Han 1635704520dSNandor Han static int xra1403_probe(struct spi_device *spi) 1645704520dSNandor Han { 1655704520dSNandor Han struct xra1403 *xra; 1665704520dSNandor Han struct gpio_desc *reset_gpio; 1675704520dSNandor Han int ret; 1685704520dSNandor Han 1695704520dSNandor Han xra = devm_kzalloc(&spi->dev, sizeof(*xra), GFP_KERNEL); 1705704520dSNandor Han if (!xra) 1715704520dSNandor Han return -ENOMEM; 1725704520dSNandor Han 1735704520dSNandor Han /* bring the chip out of reset if reset pin is provided*/ 1745704520dSNandor Han reset_gpio = devm_gpiod_get_optional(&spi->dev, "reset", GPIOD_OUT_LOW); 1755704520dSNandor Han if (IS_ERR(reset_gpio)) 1765704520dSNandor Han dev_warn(&spi->dev, "Could not get reset-gpios\n"); 1775704520dSNandor Han 1785704520dSNandor Han xra->chip.direction_input = xra1403_direction_input; 1795704520dSNandor Han xra->chip.direction_output = xra1403_direction_output; 1805704520dSNandor Han xra->chip.get_direction = xra1403_get_direction; 1815704520dSNandor Han xra->chip.get = xra1403_get; 1825704520dSNandor Han xra->chip.set = xra1403_set; 1835704520dSNandor Han 1845704520dSNandor Han xra->chip.dbg_show = xra1403_dbg_show; 1855704520dSNandor Han 1865704520dSNandor Han xra->chip.ngpio = 16; 1875704520dSNandor Han xra->chip.label = "xra1403"; 1885704520dSNandor Han 1895704520dSNandor Han xra->chip.base = -1; 1905704520dSNandor Han xra->chip.can_sleep = true; 1915704520dSNandor Han xra->chip.parent = &spi->dev; 1925704520dSNandor Han xra->chip.owner = THIS_MODULE; 1935704520dSNandor Han 1945704520dSNandor Han xra->regmap = devm_regmap_init_spi(spi, &xra1403_regmap_cfg); 1955704520dSNandor Han if (IS_ERR(xra->regmap)) { 1965704520dSNandor Han ret = PTR_ERR(xra->regmap); 1975704520dSNandor Han dev_err(&spi->dev, "Failed to allocate regmap: %d\n", ret); 1985704520dSNandor Han return ret; 1995704520dSNandor Han } 2005704520dSNandor Han 2015704520dSNandor Han ret = devm_gpiochip_add_data(&spi->dev, &xra->chip, xra); 2025704520dSNandor Han if (ret < 0) { 2035704520dSNandor Han dev_err(&spi->dev, "Unable to register gpiochip\n"); 2045704520dSNandor Han return ret; 2055704520dSNandor Han } 2065704520dSNandor Han 2075704520dSNandor Han spi_set_drvdata(spi, xra); 2085704520dSNandor Han 2095704520dSNandor Han return 0; 2105704520dSNandor Han } 2115704520dSNandor Han 2125704520dSNandor Han static const struct spi_device_id xra1403_ids[] = { 2135704520dSNandor Han { "xra1403" }, 2145704520dSNandor Han {}, 2155704520dSNandor Han }; 2165704520dSNandor Han MODULE_DEVICE_TABLE(spi, xra1403_ids); 2175704520dSNandor Han 2185704520dSNandor Han static const struct of_device_id xra1403_spi_of_match[] = { 2195704520dSNandor Han { .compatible = "exar,xra1403" }, 2205704520dSNandor Han {}, 2215704520dSNandor Han }; 2225704520dSNandor Han MODULE_DEVICE_TABLE(of, xra1403_spi_of_match); 2235704520dSNandor Han 2245704520dSNandor Han static struct spi_driver xra1403_driver = { 2255704520dSNandor Han .probe = xra1403_probe, 2265704520dSNandor Han .id_table = xra1403_ids, 2275704520dSNandor Han .driver = { 2285704520dSNandor Han .name = "xra1403", 2295704520dSNandor Han .of_match_table = of_match_ptr(xra1403_spi_of_match), 2305704520dSNandor Han }, 2315704520dSNandor Han }; 2325704520dSNandor Han 2335704520dSNandor Han module_spi_driver(xra1403_driver); 2345704520dSNandor Han 2355704520dSNandor Han MODULE_AUTHOR("Nandor Han <nandor.han@ge.com>"); 2365704520dSNandor Han MODULE_AUTHOR("Semi Malinen <semi.malinen@ge.com>"); 2375704520dSNandor Han MODULE_DESCRIPTION("GPIO expander driver for EXAR XRA1403"); 2385704520dSNandor Han MODULE_LICENSE("GPL v2"); 239