blob: a6607faf2fdf822e998d7c67ea60c8745949df76 [file] [log] [blame]
Miguel Gaioead6db082010-10-27 15:33:18 -07001/*
2 * 74Hx164 - Generic serial-in/parallel-out 8-bits shift register GPIO driver
3 *
4 * Copyright (C) 2010 Gabor Juhos <juhosg@openwrt.org>
5 * Copyright (C) 2010 Miguel Gaio <miguel.gaio@efixo.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
10 */
11
12#include <linux/init.h>
13#include <linux/mutex.h>
14#include <linux/spi/spi.h>
Miguel Gaioead6db082010-10-27 15:33:18 -070015#include <linux/gpio.h>
Maxime Ripard20bc4d52012-09-10 22:35:39 +020016#include <linux/of_gpio.h>
Miguel Gaioead6db082010-10-27 15:33:18 -070017#include <linux/slab.h>
Paul Gortmakerbb207ef2011-07-03 13:38:09 -040018#include <linux/module.h>
Miguel Gaioead6db082010-10-27 15:33:18 -070019
Maxime Ripard20bc4d52012-09-10 22:35:39 +020020#define GEN_74X164_NUMBER_GPIOS 8
21
Miguel Gaioead6db082010-10-27 15:33:18 -070022struct gen_74x164_chip {
Miguel Gaioead6db082010-10-27 15:33:18 -070023 struct gpio_chip gpio_chip;
24 struct mutex lock;
Maxime Ripard20bc4d52012-09-10 22:35:39 +020025 u32 registers;
Geert Uytterhoeven902e7e62015-11-30 15:35:26 +010026 /*
27 * Since the registers are chained, every byte sent will make
28 * the previous byte shift to the next register in the
29 * chain. Thus, the first byte sent will end up in the last
30 * register at the end of the transfer. So, to have a logical
31 * numbering, store the bytes in reverse order.
32 */
Geert Uytterhoeven410f4572015-11-30 15:35:25 +010033 u8 buffer[0];
Miguel Gaioead6db082010-10-27 15:33:18 -070034};
35
Miguel Gaioead6db082010-10-27 15:33:18 -070036static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
37{
Geert Uytterhoeven771d8992016-06-17 18:39:28 +020038 return spi_write(to_spi_device(chip->gpio_chip.parent), chip->buffer,
39 chip->registers);
Miguel Gaioead6db082010-10-27 15:33:18 -070040}
41
Miguel Gaioead6db082010-10-27 15:33:18 -070042static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
43{
Linus Walleijb2afc6f2015-12-03 18:20:29 +010044 struct gen_74x164_chip *chip = gpiochip_get_data(gc);
Geert Uytterhoeven902e7e62015-11-30 15:35:26 +010045 u8 bank = chip->registers - 1 - offset / 8;
Maxime Ripard20bc4d52012-09-10 22:35:39 +020046 u8 pin = offset % 8;
Miguel Gaioead6db082010-10-27 15:33:18 -070047 int ret;
48
49 mutex_lock(&chip->lock);
Maxime Ripard20bc4d52012-09-10 22:35:39 +020050 ret = (chip->buffer[bank] >> pin) & 0x1;
Miguel Gaioead6db082010-10-27 15:33:18 -070051 mutex_unlock(&chip->lock);
52
53 return ret;
54}
55
56static void gen_74x164_set_value(struct gpio_chip *gc,
57 unsigned offset, int val)
58{
Linus Walleijb2afc6f2015-12-03 18:20:29 +010059 struct gen_74x164_chip *chip = gpiochip_get_data(gc);
Geert Uytterhoeven902e7e62015-11-30 15:35:26 +010060 u8 bank = chip->registers - 1 - offset / 8;
Maxime Ripard20bc4d52012-09-10 22:35:39 +020061 u8 pin = offset % 8;
Miguel Gaioead6db082010-10-27 15:33:18 -070062
63 mutex_lock(&chip->lock);
64 if (val)
Maxime Ripard20bc4d52012-09-10 22:35:39 +020065 chip->buffer[bank] |= (1 << pin);
Miguel Gaioead6db082010-10-27 15:33:18 -070066 else
Maxime Ripard20bc4d52012-09-10 22:35:39 +020067 chip->buffer[bank] &= ~(1 << pin);
Miguel Gaioead6db082010-10-27 15:33:18 -070068
69 __gen_74x164_write_config(chip);
70 mutex_unlock(&chip->lock);
71}
72
Geert Uytterhoevend46ab682016-03-14 16:19:18 +010073static void gen_74x164_set_multiple(struct gpio_chip *gc, unsigned long *mask,
74 unsigned long *bits)
75{
76 struct gen_74x164_chip *chip = gpiochip_get_data(gc);
77 unsigned int i, idx, shift;
78 u8 bank, bankmask;
79
80 mutex_lock(&chip->lock);
81 for (i = 0, bank = chip->registers - 1; i < chip->registers;
82 i++, bank--) {
83 idx = i / sizeof(*mask);
84 shift = i % sizeof(*mask) * BITS_PER_BYTE;
85 bankmask = mask[idx] >> shift;
86 if (!bankmask)
87 continue;
88
89 chip->buffer[bank] &= ~bankmask;
90 chip->buffer[bank] |= bankmask & (bits[idx] >> shift);
91 }
92 __gen_74x164_write_config(chip);
93 mutex_unlock(&chip->lock);
94}
95
H Hartley Sweetena3cc68c2011-05-27 16:35:59 -070096static int gen_74x164_direction_output(struct gpio_chip *gc,
97 unsigned offset, int val)
98{
99 gen_74x164_set_value(gc, offset, val);
100 return 0;
101}
102
Bill Pemberton38363092012-11-19 13:22:34 -0500103static int gen_74x164_probe(struct spi_device *spi)
Miguel Gaioead6db082010-10-27 15:33:18 -0700104{
105 struct gen_74x164_chip *chip;
Geert Uytterhoeven410f4572015-11-30 15:35:25 +0100106 u32 nregs;
Miguel Gaioead6db082010-10-27 15:33:18 -0700107 int ret;
108
Miguel Gaioead6db082010-10-27 15:33:18 -0700109 /*
110 * bits_per_word cannot be configured in platform data
111 */
112 spi->bits_per_word = 8;
113
114 ret = spi_setup(spi);
115 if (ret < 0)
116 return ret;
117
Geert Uytterhoeven410f4572015-11-30 15:35:25 +0100118 if (of_property_read_u32(spi->dev.of_node, "registers-number",
119 &nregs)) {
120 dev_err(&spi->dev,
121 "Missing registers-number property in the DT.\n");
122 return -EINVAL;
123 }
124
125 chip = devm_kzalloc(&spi->dev, sizeof(*chip) + nregs, GFP_KERNEL);
Miguel Gaioead6db082010-10-27 15:33:18 -0700126 if (!chip)
127 return -ENOMEM;
128
Jingoo Han6c0cf422013-03-15 18:17:18 +0900129 spi_set_drvdata(spi, chip);
Miguel Gaioead6db082010-10-27 15:33:18 -0700130
H Hartley Sweetena3cc68c2011-05-27 16:35:59 -0700131 chip->gpio_chip.label = spi->modalias;
132 chip->gpio_chip.direction_output = gen_74x164_direction_output;
Miguel Gaioead6db082010-10-27 15:33:18 -0700133 chip->gpio_chip.get = gen_74x164_get_value;
134 chip->gpio_chip.set = gen_74x164_set_value;
Geert Uytterhoevend46ab682016-03-14 16:19:18 +0100135 chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
Alexander Shiyan61e73802013-12-07 14:08:22 +0400136 chip->gpio_chip.base = -1;
Maxime Ripard20bc4d52012-09-10 22:35:39 +0200137
Geert Uytterhoeven410f4572015-11-30 15:35:25 +0100138 chip->registers = nregs;
Maxime Ripard20bc4d52012-09-10 22:35:39 +0200139 chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
Maxime Ripard20bc4d52012-09-10 22:35:39 +0200140
Linus Walleij9fb1f392013-12-04 14:42:46 +0100141 chip->gpio_chip.can_sleep = true;
Linus Walleij58383c72015-11-04 09:56:26 +0100142 chip->gpio_chip.parent = &spi->dev;
Miguel Gaioead6db082010-10-27 15:33:18 -0700143 chip->gpio_chip.owner = THIS_MODULE;
144
Alexander Shiyanbcc05622013-12-07 14:08:23 +0400145 mutex_init(&chip->lock);
146
Miguel Gaioead6db082010-10-27 15:33:18 -0700147 ret = __gen_74x164_write_config(chip);
148 if (ret) {
149 dev_err(&spi->dev, "Failed writing: %d\n", ret);
150 goto exit_destroy;
151 }
152
Linus Walleijb2afc6f2015-12-03 18:20:29 +0100153 ret = gpiochip_add_data(&chip->gpio_chip, chip);
Alexander Shiyanbcc05622013-12-07 14:08:23 +0400154 if (!ret)
155 return 0;
Miguel Gaioead6db082010-10-27 15:33:18 -0700156
157exit_destroy:
Miguel Gaioead6db082010-10-27 15:33:18 -0700158 mutex_destroy(&chip->lock);
Alexander Shiyanbcc05622013-12-07 14:08:23 +0400159
Miguel Gaioead6db082010-10-27 15:33:18 -0700160 return ret;
161}
162
Bill Pemberton206210c2012-11-19 13:25:50 -0500163static int gen_74x164_remove(struct spi_device *spi)
Miguel Gaioead6db082010-10-27 15:33:18 -0700164{
Alexander Shiyanbcc05622013-12-07 14:08:23 +0400165 struct gen_74x164_chip *chip = spi_get_drvdata(spi);
Miguel Gaioead6db082010-10-27 15:33:18 -0700166
abdoulaye berthe9f5132a2014-07-12 22:30:12 +0200167 gpiochip_remove(&chip->gpio_chip);
168 mutex_destroy(&chip->lock);
Miguel Gaioead6db082010-10-27 15:33:18 -0700169
abdoulaye berthe9f5132a2014-07-12 22:30:12 +0200170 return 0;
Miguel Gaioead6db082010-10-27 15:33:18 -0700171}
172
Maxime Ripard0a90a9f2012-09-07 14:18:13 +0200173static const struct of_device_id gen_74x164_dt_ids[] = {
174 { .compatible = "fairchild,74hc595" },
Nicolas Saenz Julienne80018bd2016-03-14 23:32:10 +0000175 { .compatible = "nxp,74lvc594" },
Maxime Ripard0a90a9f2012-09-07 14:18:13 +0200176 {},
177};
178MODULE_DEVICE_TABLE(of, gen_74x164_dt_ids);
179
Miguel Gaioead6db082010-10-27 15:33:18 -0700180static struct spi_driver gen_74x164_driver = {
181 .driver = {
H Hartley Sweetena3cc68c2011-05-27 16:35:59 -0700182 .name = "74x164",
Sachin Kamat187a53a2013-09-19 17:28:08 +0530183 .of_match_table = gen_74x164_dt_ids,
Miguel Gaioead6db082010-10-27 15:33:18 -0700184 },
185 .probe = gen_74x164_probe,
Bill Pemberton8283c4f2012-11-19 13:20:08 -0500186 .remove = gen_74x164_remove,
Miguel Gaioead6db082010-10-27 15:33:18 -0700187};
Maxime Ripardab3b8782012-09-05 10:40:50 +0200188module_spi_driver(gen_74x164_driver);
Miguel Gaioead6db082010-10-27 15:33:18 -0700189
190MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
191MODULE_AUTHOR("Miguel Gaio <miguel.gaio@efixo.com>");
192MODULE_DESCRIPTION("GPIO expander driver for 74X164 8-bits shift register");
193MODULE_LICENSE("GPL v2");