19952f691SThomas Gleixner // SPDX-License-Identifier: GPL-2.0-only
25704520dSNandor Han /*
35704520dSNandor Han * GPIO driver for EXAR XRA1403 16-bit GPIO expander
45704520dSNandor Han *
55704520dSNandor Han * Copyright (c) 2017, General Electric Company
65704520dSNandor Han */
75704520dSNandor Han
85704520dSNandor Han #include <linux/bitops.h>
95704520dSNandor Han #include <linux/gpio/driver.h>
105704520dSNandor Han #include <linux/kernel.h>
11e91d0f05SRob Herring #include <linux/mod_devicetable.h>
125704520dSNandor Han #include <linux/module.h>
135704520dSNandor Han #include <linux/mutex.h>
145704520dSNandor Han #include <linux/seq_file.h>
155704520dSNandor Han #include <linux/spi/spi.h>
165704520dSNandor Han #include <linux/regmap.h>
175704520dSNandor Han
185704520dSNandor Han /* XRA1403 registers */
195704520dSNandor Han #define XRA_GSR 0x00 /* GPIO State */
205704520dSNandor Han #define XRA_OCR 0x02 /* Output Control */
215704520dSNandor Han #define XRA_PIR 0x04 /* Input Polarity Inversion */
225704520dSNandor Han #define XRA_GCR 0x06 /* GPIO Configuration */
235704520dSNandor Han #define XRA_PUR 0x08 /* Input Internal Pull-up Resistor Enable/Disable */
245704520dSNandor Han #define XRA_IER 0x0A /* Input Interrupt Enable */
255704520dSNandor Han #define XRA_TSCR 0x0C /* Output Three-State Control */
265704520dSNandor Han #define XRA_ISR 0x0E /* Input Interrupt Status */
275704520dSNandor Han #define XRA_REIR 0x10 /* Input Rising Edge Interrupt Enable */
285704520dSNandor Han #define XRA_FEIR 0x12 /* Input Falling Edge Interrupt Enable */
295704520dSNandor Han #define XRA_IFR 0x14 /* Input Filter Enable/Disable */
3012f92cccSLaura Abbott #define XRA_LAST 0x15 /* Bounds */
315704520dSNandor Han
325704520dSNandor Han struct xra1403 {
335704520dSNandor Han struct gpio_chip chip;
345704520dSNandor Han struct regmap *regmap;
355704520dSNandor Han };
365704520dSNandor Han
375704520dSNandor Han static const struct regmap_config xra1403_regmap_cfg = {
385704520dSNandor Han .reg_bits = 7,
395704520dSNandor Han .pad_bits = 1,
405704520dSNandor Han .val_bits = 8,
415704520dSNandor Han
4212f92cccSLaura Abbott .max_register = XRA_LAST,
435704520dSNandor Han };
445704520dSNandor Han
to_reg(unsigned int reg,unsigned int offset)455704520dSNandor Han static unsigned int to_reg(unsigned int reg, unsigned int offset)
465704520dSNandor Han {
475704520dSNandor Han return reg + (offset > 7);
485704520dSNandor Han }
495704520dSNandor Han
xra1403_direction_input(struct gpio_chip * chip,unsigned int offset)505704520dSNandor Han static int xra1403_direction_input(struct gpio_chip *chip, unsigned int offset)
515704520dSNandor Han {
525704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
535704520dSNandor Han
545704520dSNandor Han return regmap_update_bits(xra->regmap, to_reg(XRA_GCR, offset),
555704520dSNandor Han BIT(offset % 8), BIT(offset % 8));
565704520dSNandor Han }
575704520dSNandor Han
xra1403_direction_output(struct gpio_chip * chip,unsigned int offset,int value)585704520dSNandor Han static int xra1403_direction_output(struct gpio_chip *chip, unsigned int offset,
595704520dSNandor Han int value)
605704520dSNandor Han {
615704520dSNandor Han int ret;
625704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
635704520dSNandor Han
645704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_GCR, offset),
655704520dSNandor Han BIT(offset % 8), 0);
665704520dSNandor Han if (ret)
675704520dSNandor Han return ret;
685704520dSNandor Han
695704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_OCR, offset),
705704520dSNandor Han BIT(offset % 8), value ? BIT(offset % 8) : 0);
715704520dSNandor Han
725704520dSNandor Han return ret;
735704520dSNandor Han }
745704520dSNandor Han
xra1403_get_direction(struct gpio_chip * chip,unsigned int offset)755704520dSNandor Han static int xra1403_get_direction(struct gpio_chip *chip, unsigned int offset)
765704520dSNandor Han {
775704520dSNandor Han int ret;
785704520dSNandor Han unsigned int val;
795704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
805704520dSNandor Han
815704520dSNandor Han ret = regmap_read(xra->regmap, to_reg(XRA_GCR, offset), &val);
825704520dSNandor Han if (ret)
835704520dSNandor Han return ret;
845704520dSNandor Han
85e42615ecSMatti Vaittinen if (val & BIT(offset % 8))
86e42615ecSMatti Vaittinen return GPIO_LINE_DIRECTION_IN;
87e42615ecSMatti Vaittinen
88e42615ecSMatti Vaittinen return GPIO_LINE_DIRECTION_OUT;
895704520dSNandor Han }
905704520dSNandor Han
xra1403_get(struct gpio_chip * chip,unsigned int offset)915704520dSNandor Han static int xra1403_get(struct gpio_chip *chip, unsigned int offset)
925704520dSNandor Han {
935704520dSNandor Han int ret;
945704520dSNandor Han unsigned int val;
955704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
965704520dSNandor Han
975704520dSNandor Han ret = regmap_read(xra->regmap, to_reg(XRA_GSR, offset), &val);
985704520dSNandor Han if (ret)
995704520dSNandor Han return ret;
1005704520dSNandor Han
1015704520dSNandor Han return !!(val & BIT(offset % 8));
1025704520dSNandor Han }
1035704520dSNandor Han
xra1403_set(struct gpio_chip * chip,unsigned int offset,int value)1045704520dSNandor Han static void xra1403_set(struct gpio_chip *chip, unsigned int offset, int value)
1055704520dSNandor Han {
1065704520dSNandor Han int ret;
1075704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
1085704520dSNandor Han
1095704520dSNandor Han ret = regmap_update_bits(xra->regmap, to_reg(XRA_OCR, offset),
1105704520dSNandor Han BIT(offset % 8), value ? BIT(offset % 8) : 0);
1115704520dSNandor Han if (ret)
1125704520dSNandor Han dev_err(chip->parent, "Failed to set pin: %d, ret: %d\n",
1135704520dSNandor Han offset, ret);
1145704520dSNandor Han }
1155704520dSNandor Han
1165704520dSNandor Han #ifdef CONFIG_DEBUG_FS
xra1403_dbg_show(struct seq_file * s,struct gpio_chip * chip)1175704520dSNandor Han static void xra1403_dbg_show(struct seq_file *s, struct gpio_chip *chip)
1185704520dSNandor Han {
1195704520dSNandor Han int reg;
1205704520dSNandor Han struct xra1403 *xra = gpiochip_get_data(chip);
12112f92cccSLaura Abbott int value[XRA_LAST];
1225704520dSNandor Han int i;
1237796cdc9SAndy Shevchenko const char *label;
1245704520dSNandor Han unsigned int gcr;
1255704520dSNandor Han unsigned int gsr;
1265704520dSNandor Han
1275704520dSNandor Han seq_puts(s, "xra reg:");
12812f92cccSLaura Abbott for (reg = 0; reg <= XRA_LAST; reg++)
1295704520dSNandor Han seq_printf(s, " %2.2x", reg);
1305704520dSNandor Han seq_puts(s, "\n value:");
13112f92cccSLaura Abbott for (reg = 0; reg < XRA_LAST; reg++) {
1325704520dSNandor Han regmap_read(xra->regmap, reg, &value[reg]);
1335704520dSNandor Han seq_printf(s, " %2.2x", value[reg]);
1345704520dSNandor Han }
1355704520dSNandor Han seq_puts(s, "\n");
1365704520dSNandor Han
1375704520dSNandor Han gcr = value[XRA_GCR + 1] << 8 | value[XRA_GCR];
1385704520dSNandor Han gsr = value[XRA_GSR + 1] << 8 | value[XRA_GSR];
1397796cdc9SAndy Shevchenko for_each_requested_gpio(chip, i, label) {
1405704520dSNandor Han seq_printf(s, " gpio-%-3d (%-12s) %s %s\n",
1415704520dSNandor Han chip->base + i, label,
1425704520dSNandor Han (gcr & BIT(i)) ? "in" : "out",
1435704520dSNandor Han (gsr & BIT(i)) ? "hi" : "lo");
1445704520dSNandor Han }
1455704520dSNandor Han }
1465704520dSNandor Han #else
1475704520dSNandor Han #define xra1403_dbg_show NULL
1485704520dSNandor Han #endif
1495704520dSNandor Han
xra1403_probe(struct spi_device * spi)1505704520dSNandor Han static int xra1403_probe(struct spi_device *spi)
1515704520dSNandor Han {
1525704520dSNandor Han struct xra1403 *xra;
1535704520dSNandor Han struct gpio_desc *reset_gpio;
1545704520dSNandor Han int ret;
1555704520dSNandor Han
1565704520dSNandor Han xra = devm_kzalloc(&spi->dev, sizeof(*xra), GFP_KERNEL);
1575704520dSNandor Han if (!xra)
1585704520dSNandor Han return -ENOMEM;
1595704520dSNandor Han
1605704520dSNandor Han /* bring the chip out of reset if reset pin is provided*/
1615704520dSNandor Han reset_gpio = devm_gpiod_get_optional(&spi->dev, "reset", GPIOD_OUT_LOW);
1625704520dSNandor Han if (IS_ERR(reset_gpio))
1635704520dSNandor Han dev_warn(&spi->dev, "Could not get reset-gpios\n");
1645704520dSNandor Han
1655704520dSNandor Han xra->chip.direction_input = xra1403_direction_input;
1665704520dSNandor Han xra->chip.direction_output = xra1403_direction_output;
1675704520dSNandor Han xra->chip.get_direction = xra1403_get_direction;
1685704520dSNandor Han xra->chip.get = xra1403_get;
1695704520dSNandor Han xra->chip.set = xra1403_set;
1705704520dSNandor Han
1715704520dSNandor Han xra->chip.dbg_show = xra1403_dbg_show;
1725704520dSNandor Han
1735704520dSNandor Han xra->chip.ngpio = 16;
1745704520dSNandor Han xra->chip.label = "xra1403";
1755704520dSNandor Han
1765704520dSNandor Han xra->chip.base = -1;
1775704520dSNandor Han xra->chip.can_sleep = true;
1785704520dSNandor Han xra->chip.parent = &spi->dev;
1795704520dSNandor Han xra->chip.owner = THIS_MODULE;
1805704520dSNandor Han
1815704520dSNandor Han xra->regmap = devm_regmap_init_spi(spi, &xra1403_regmap_cfg);
1825704520dSNandor Han if (IS_ERR(xra->regmap)) {
1835704520dSNandor Han ret = PTR_ERR(xra->regmap);
1845704520dSNandor Han dev_err(&spi->dev, "Failed to allocate regmap: %d\n", ret);
1855704520dSNandor Han return ret;
1865704520dSNandor Han }
1875704520dSNandor Han
1880aa42370SAlexandru Ardelean return devm_gpiochip_add_data(&spi->dev, &xra->chip, xra);
1895704520dSNandor Han }
1905704520dSNandor Han
1915704520dSNandor Han static const struct spi_device_id xra1403_ids[] = {
1925704520dSNandor Han { "xra1403" },
1935704520dSNandor Han {},
1945704520dSNandor Han };
1955704520dSNandor Han MODULE_DEVICE_TABLE(spi, xra1403_ids);
1965704520dSNandor Han
197*87d06884SZhu Wang static const struct of_device_id xra1403_spi_of_match[] = {
1985704520dSNandor Han { .compatible = "exar,xra1403" },
1995704520dSNandor Han {},
2005704520dSNandor Han };
2015704520dSNandor Han MODULE_DEVICE_TABLE(of, xra1403_spi_of_match);
2025704520dSNandor Han
2035704520dSNandor Han static struct spi_driver xra1403_driver = {
2045704520dSNandor Han .probe = xra1403_probe,
2055704520dSNandor Han .id_table = xra1403_ids,
2065704520dSNandor Han .driver = {
2075704520dSNandor Han .name = "xra1403",
208*87d06884SZhu Wang .of_match_table = xra1403_spi_of_match,
2095704520dSNandor Han },
2105704520dSNandor Han };
2115704520dSNandor Han
2125704520dSNandor Han module_spi_driver(xra1403_driver);
2135704520dSNandor Han
2145704520dSNandor Han MODULE_AUTHOR("Nandor Han <nandor.han@ge.com>");
2155704520dSNandor Han MODULE_AUTHOR("Semi Malinen <semi.malinen@ge.com>");
2165704520dSNandor Han MODULE_DESCRIPTION("GPIO expander driver for EXAR XRA1403");
2175704520dSNandor Han MODULE_LICENSE("GPL v2");
218