Loading...
1/*
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>
15#include <linux/spi/74x164.h>
16#include <linux/gpio.h>
17#include <linux/slab.h>
18
19struct gen_74x164_chip {
20 struct spi_device *spi;
21 struct gpio_chip gpio_chip;
22 struct mutex lock;
23 u8 port_config;
24};
25
26static struct gen_74x164_chip *gpio_to_74x164_chip(struct gpio_chip *gc)
27{
28 return container_of(gc, struct gen_74x164_chip, gpio_chip);
29}
30
31static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
32{
33 return spi_write(chip->spi,
34 &chip->port_config, sizeof(chip->port_config));
35}
36
37static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
38{
39 struct gen_74x164_chip *chip = gpio_to_74x164_chip(gc);
40 int ret;
41
42 mutex_lock(&chip->lock);
43 ret = (chip->port_config >> offset) & 0x1;
44 mutex_unlock(&chip->lock);
45
46 return ret;
47}
48
49static void gen_74x164_set_value(struct gpio_chip *gc,
50 unsigned offset, int val)
51{
52 struct gen_74x164_chip *chip = gpio_to_74x164_chip(gc);
53
54 mutex_lock(&chip->lock);
55 if (val)
56 chip->port_config |= (1 << offset);
57 else
58 chip->port_config &= ~(1 << offset);
59
60 __gen_74x164_write_config(chip);
61 mutex_unlock(&chip->lock);
62}
63
64static int gen_74x164_direction_output(struct gpio_chip *gc,
65 unsigned offset, int val)
66{
67 gen_74x164_set_value(gc, offset, val);
68 return 0;
69}
70
71static int __devinit gen_74x164_probe(struct spi_device *spi)
72{
73 struct gen_74x164_chip *chip;
74 struct gen_74x164_chip_platform_data *pdata;
75 int ret;
76
77 pdata = spi->dev.platform_data;
78 if (!pdata || !pdata->base) {
79 dev_dbg(&spi->dev, "incorrect or missing platform data\n");
80 return -EINVAL;
81 }
82
83 /*
84 * bits_per_word cannot be configured in platform data
85 */
86 spi->bits_per_word = 8;
87
88 ret = spi_setup(spi);
89 if (ret < 0)
90 return ret;
91
92 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
93 if (!chip)
94 return -ENOMEM;
95
96 mutex_init(&chip->lock);
97
98 dev_set_drvdata(&spi->dev, chip);
99
100 chip->spi = spi;
101
102 chip->gpio_chip.label = spi->modalias;
103 chip->gpio_chip.direction_output = gen_74x164_direction_output;
104 chip->gpio_chip.get = gen_74x164_get_value;
105 chip->gpio_chip.set = gen_74x164_set_value;
106 chip->gpio_chip.base = pdata->base;
107 chip->gpio_chip.ngpio = 8;
108 chip->gpio_chip.can_sleep = 1;
109 chip->gpio_chip.dev = &spi->dev;
110 chip->gpio_chip.owner = THIS_MODULE;
111
112 ret = __gen_74x164_write_config(chip);
113 if (ret) {
114 dev_err(&spi->dev, "Failed writing: %d\n", ret);
115 goto exit_destroy;
116 }
117
118 ret = gpiochip_add(&chip->gpio_chip);
119 if (ret)
120 goto exit_destroy;
121
122 return ret;
123
124exit_destroy:
125 dev_set_drvdata(&spi->dev, NULL);
126 mutex_destroy(&chip->lock);
127 kfree(chip);
128 return ret;
129}
130
131static int __devexit gen_74x164_remove(struct spi_device *spi)
132{
133 struct gen_74x164_chip *chip;
134 int ret;
135
136 chip = dev_get_drvdata(&spi->dev);
137 if (chip == NULL)
138 return -ENODEV;
139
140 dev_set_drvdata(&spi->dev, NULL);
141
142 ret = gpiochip_remove(&chip->gpio_chip);
143 if (!ret) {
144 mutex_destroy(&chip->lock);
145 kfree(chip);
146 } else
147 dev_err(&spi->dev, "Failed to remove the GPIO controller: %d\n",
148 ret);
149
150 return ret;
151}
152
153static struct spi_driver gen_74x164_driver = {
154 .driver = {
155 .name = "74x164",
156 .owner = THIS_MODULE,
157 },
158 .probe = gen_74x164_probe,
159 .remove = __devexit_p(gen_74x164_remove),
160};
161
162static int __init gen_74x164_init(void)
163{
164 return spi_register_driver(&gen_74x164_driver);
165}
166subsys_initcall(gen_74x164_init);
167
168static void __exit gen_74x164_exit(void)
169{
170 spi_unregister_driver(&gen_74x164_driver);
171}
172module_exit(gen_74x164_exit);
173
174MODULE_AUTHOR("Gabor Juhos <juhosg@openwrt.org>");
175MODULE_AUTHOR("Miguel Gaio <miguel.gaio@efixo.com>");
176MODULE_DESCRIPTION("GPIO expander driver for 74X164 8-bits shift register");
177MODULE_LICENSE("GPL v2");
1/*
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>
15#include <linux/gpio.h>
16#include <linux/of_gpio.h>
17#include <linux/slab.h>
18#include <linux/module.h>
19
20#define GEN_74X164_NUMBER_GPIOS 8
21
22struct gen_74x164_chip {
23 struct gpio_chip gpio_chip;
24 struct mutex lock;
25 u32 registers;
26 /*
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 */
33 u8 buffer[0];
34};
35
36static int __gen_74x164_write_config(struct gen_74x164_chip *chip)
37{
38 return spi_write(to_spi_device(chip->gpio_chip.parent), chip->buffer,
39 chip->registers);
40}
41
42static int gen_74x164_get_value(struct gpio_chip *gc, unsigned offset)
43{
44 struct gen_74x164_chip *chip = gpiochip_get_data(gc);
45 u8 bank = chip->registers - 1 - offset / 8;
46 u8 pin = offset % 8;
47 int ret;
48
49 mutex_lock(&chip->lock);
50 ret = (chip->buffer[bank] >> pin) & 0x1;
51 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{
59 struct gen_74x164_chip *chip = gpiochip_get_data(gc);
60 u8 bank = chip->registers - 1 - offset / 8;
61 u8 pin = offset % 8;
62
63 mutex_lock(&chip->lock);
64 if (val)
65 chip->buffer[bank] |= (1 << pin);
66 else
67 chip->buffer[bank] &= ~(1 << pin);
68
69 __gen_74x164_write_config(chip);
70 mutex_unlock(&chip->lock);
71}
72
73static 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
96static 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
103static int gen_74x164_probe(struct spi_device *spi)
104{
105 struct gen_74x164_chip *chip;
106 u32 nregs;
107 int ret;
108
109 /*
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
118 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);
126 if (!chip)
127 return -ENOMEM;
128
129 spi_set_drvdata(spi, chip);
130
131 chip->gpio_chip.label = spi->modalias;
132 chip->gpio_chip.direction_output = gen_74x164_direction_output;
133 chip->gpio_chip.get = gen_74x164_get_value;
134 chip->gpio_chip.set = gen_74x164_set_value;
135 chip->gpio_chip.set_multiple = gen_74x164_set_multiple;
136 chip->gpio_chip.base = -1;
137
138 chip->registers = nregs;
139 chip->gpio_chip.ngpio = GEN_74X164_NUMBER_GPIOS * chip->registers;
140
141 chip->gpio_chip.can_sleep = true;
142 chip->gpio_chip.parent = &spi->dev;
143 chip->gpio_chip.owner = THIS_MODULE;
144
145 mutex_init(&chip->lock);
146
147 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
153 ret = gpiochip_add_data(&chip->gpio_chip, chip);
154 if (!ret)
155 return 0;
156
157exit_destroy:
158 mutex_destroy(&chip->lock);
159
160 return ret;
161}
162
163static int gen_74x164_remove(struct spi_device *spi)
164{
165 struct gen_74x164_chip *chip = spi_get_drvdata(spi);
166
167 gpiochip_remove(&chip->gpio_chip);
168 mutex_destroy(&chip->lock);
169
170 return 0;
171}
172
173static const struct of_device_id gen_74x164_dt_ids[] = {
174 { .compatible = "fairchild,74hc595" },
175 { .compatible = "nxp,74lvc594" },
176 {},
177};
178MODULE_DEVICE_TABLE(of, gen_74x164_dt_ids);
179
180static struct spi_driver gen_74x164_driver = {
181 .driver = {
182 .name = "74x164",
183 .of_match_table = gen_74x164_dt_ids,
184 },
185 .probe = gen_74x164_probe,
186 .remove = gen_74x164_remove,
187};
188module_spi_driver(gen_74x164_driver);
189
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");