Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * SPI host driver using generic bitbanged GPIO
4 *
5 * Copyright (C) 2006,2008 David Brownell
6 * Copyright (C) 2017 Linus Walleij
7 */
8#include <linux/gpio/consumer.h>
9#include <linux/kernel.h>
10#include <linux/mod_devicetable.h>
11#include <linux/module.h>
12#include <linux/platform_device.h>
13#include <linux/property.h>
14
15#include <linux/spi/spi.h>
16#include <linux/spi/spi_bitbang.h>
17#include <linux/spi/spi_gpio.h>
18
19/*
20 * This bitbanging SPI host driver should help make systems usable
21 * when a native hardware SPI engine is not available, perhaps because
22 * its driver isn't yet working or because the I/O pins it requires
23 * are used for other purposes.
24 *
25 * platform_device->driver_data ... points to spi_gpio
26 *
27 * spi->controller_state ... reserved for bitbang framework code
28 *
29 * spi->controller->dev.driver_data ... points to spi_gpio->bitbang
30 */
31
32struct spi_gpio {
33 struct spi_bitbang bitbang;
34 struct gpio_desc *sck;
35 struct gpio_desc *miso;
36 struct gpio_desc *mosi;
37 struct gpio_desc **cs_gpios;
38};
39
40/*----------------------------------------------------------------------*/
41
42/*
43 * Because the overhead of going through four GPIO procedure calls
44 * per transferred bit can make performance a problem, this code
45 * is set up so that you can use it in either of two ways:
46 *
47 * - The slow generic way: set up platform_data to hold the GPIO
48 * numbers used for MISO/MOSI/SCK, and issue procedure calls for
49 * each of them. This driver can handle several such busses.
50 *
51 * - The quicker inlined way: only helps with platform GPIO code
52 * that inlines operations for constant GPIOs. This can give
53 * you tight (fast!) inner loops, but each such bus needs a
54 * new driver. You'll define a new C file, with Makefile and
55 * Kconfig support; the C code can be a total of six lines:
56 *
57 * #define DRIVER_NAME "myboard_spi2"
58 * #define SPI_MISO_GPIO 119
59 * #define SPI_MOSI_GPIO 120
60 * #define SPI_SCK_GPIO 121
61 * #define SPI_N_CHIPSEL 4
62 * #include "spi-gpio.c"
63 */
64
65#ifndef DRIVER_NAME
66#define DRIVER_NAME "spi_gpio"
67
68#define GENERIC_BITBANG /* vs tight inlines */
69
70#endif
71
72/*----------------------------------------------------------------------*/
73
74static inline struct spi_gpio *__pure
75spi_to_spi_gpio(const struct spi_device *spi)
76{
77 const struct spi_bitbang *bang;
78 struct spi_gpio *spi_gpio;
79
80 bang = spi_controller_get_devdata(spi->controller);
81 spi_gpio = container_of(bang, struct spi_gpio, bitbang);
82 return spi_gpio;
83}
84
85/* These helpers are in turn called by the bitbang inlines */
86static inline void setsck(const struct spi_device *spi, int is_on)
87{
88 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
89
90 gpiod_set_value_cansleep(spi_gpio->sck, is_on);
91}
92
93static inline void setmosi(const struct spi_device *spi, int is_on)
94{
95 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
96
97 gpiod_set_value_cansleep(spi_gpio->mosi, is_on);
98}
99
100static inline int getmiso(const struct spi_device *spi)
101{
102 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
103
104 if (spi->mode & SPI_3WIRE)
105 return !!gpiod_get_value_cansleep(spi_gpio->mosi);
106 else
107 return !!gpiod_get_value_cansleep(spi_gpio->miso);
108}
109
110/*
111 * NOTE: this clocks "as fast as we can". It "should" be a function of the
112 * requested device clock. Software overhead means we usually have trouble
113 * reaching even one Mbit/sec (except when we can inline bitops), so for now
114 * we'll just assume we never need additional per-bit slowdowns.
115 */
116#define spidelay(nsecs) do {} while (0)
117
118#include "spi-bitbang-txrx.h"
119
120/*
121 * These functions can leverage inline expansion of GPIO calls to shrink
122 * costs for a txrx bit, often by factors of around ten (by instruction
123 * count). That is particularly visible for larger word sizes, but helps
124 * even with default 8-bit words.
125 *
126 * REVISIT overheads calling these functions for each word also have
127 * significant performance costs. Having txrx_bufs() calls that inline
128 * the txrx_word() logic would help performance, e.g. on larger blocks
129 * used with flash storage or MMC/SD. There should also be ways to make
130 * GCC be less stupid about reloading registers inside the I/O loops,
131 * even without inlined GPIO calls; __attribute__((hot)) on GCC 4.3?
132 */
133
134static u32 spi_gpio_txrx_word_mode0(struct spi_device *spi,
135 unsigned nsecs, u32 word, u8 bits, unsigned flags)
136{
137 if (unlikely(spi->mode & SPI_LSB_FIRST))
138 return bitbang_txrx_le_cpha0(spi, nsecs, 0, flags, word, bits);
139 else
140 return bitbang_txrx_be_cpha0(spi, nsecs, 0, flags, word, bits);
141}
142
143static u32 spi_gpio_txrx_word_mode1(struct spi_device *spi,
144 unsigned nsecs, u32 word, u8 bits, unsigned flags)
145{
146 if (unlikely(spi->mode & SPI_LSB_FIRST))
147 return bitbang_txrx_le_cpha1(spi, nsecs, 0, flags, word, bits);
148 else
149 return bitbang_txrx_be_cpha1(spi, nsecs, 0, flags, word, bits);
150}
151
152static u32 spi_gpio_txrx_word_mode2(struct spi_device *spi,
153 unsigned nsecs, u32 word, u8 bits, unsigned flags)
154{
155 if (unlikely(spi->mode & SPI_LSB_FIRST))
156 return bitbang_txrx_le_cpha0(spi, nsecs, 1, flags, word, bits);
157 else
158 return bitbang_txrx_be_cpha0(spi, nsecs, 1, flags, word, bits);
159}
160
161static u32 spi_gpio_txrx_word_mode3(struct spi_device *spi,
162 unsigned nsecs, u32 word, u8 bits, unsigned flags)
163{
164 if (unlikely(spi->mode & SPI_LSB_FIRST))
165 return bitbang_txrx_le_cpha1(spi, nsecs, 1, flags, word, bits);
166 else
167 return bitbang_txrx_be_cpha1(spi, nsecs, 1, flags, word, bits);
168}
169
170/*
171 * These functions do not call setmosi or getmiso if respective flag
172 * (SPI_CONTROLLER_NO_RX or SPI_CONTROLLER_NO_TX) is set, so they are safe to
173 * call when such pin is not present or defined in the controller.
174 * A separate set of callbacks is defined to get highest possible
175 * speed in the generic case (when both MISO and MOSI lines are
176 * available), as optimiser will remove the checks when argument is
177 * constant.
178 */
179
180static u32 spi_gpio_spec_txrx_word_mode0(struct spi_device *spi,
181 unsigned nsecs, u32 word, u8 bits, unsigned flags)
182{
183 flags = spi->controller->flags;
184 if (unlikely(spi->mode & SPI_LSB_FIRST))
185 return bitbang_txrx_le_cpha0(spi, nsecs, 0, flags, word, bits);
186 else
187 return bitbang_txrx_be_cpha0(spi, nsecs, 0, flags, word, bits);
188}
189
190static u32 spi_gpio_spec_txrx_word_mode1(struct spi_device *spi,
191 unsigned nsecs, u32 word, u8 bits, unsigned flags)
192{
193 flags = spi->controller->flags;
194 if (unlikely(spi->mode & SPI_LSB_FIRST))
195 return bitbang_txrx_le_cpha1(spi, nsecs, 0, flags, word, bits);
196 else
197 return bitbang_txrx_be_cpha1(spi, nsecs, 0, flags, word, bits);
198}
199
200static u32 spi_gpio_spec_txrx_word_mode2(struct spi_device *spi,
201 unsigned nsecs, u32 word, u8 bits, unsigned flags)
202{
203 flags = spi->controller->flags;
204 if (unlikely(spi->mode & SPI_LSB_FIRST))
205 return bitbang_txrx_le_cpha0(spi, nsecs, 1, flags, word, bits);
206 else
207 return bitbang_txrx_be_cpha0(spi, nsecs, 1, flags, word, bits);
208}
209
210static u32 spi_gpio_spec_txrx_word_mode3(struct spi_device *spi,
211 unsigned nsecs, u32 word, u8 bits, unsigned flags)
212{
213 flags = spi->controller->flags;
214 if (unlikely(spi->mode & SPI_LSB_FIRST))
215 return bitbang_txrx_le_cpha1(spi, nsecs, 1, flags, word, bits);
216 else
217 return bitbang_txrx_be_cpha1(spi, nsecs, 1, flags, word, bits);
218}
219
220/*----------------------------------------------------------------------*/
221
222static void spi_gpio_chipselect(struct spi_device *spi, int is_active)
223{
224 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
225
226 /* set initial clock line level */
227 if (is_active)
228 gpiod_set_value_cansleep(spi_gpio->sck, spi->mode & SPI_CPOL);
229
230 /* Drive chip select line, if we have one */
231 if (spi_gpio->cs_gpios) {
232 struct gpio_desc *cs = spi_gpio->cs_gpios[spi_get_chipselect(spi, 0)];
233
234 /* SPI chip selects are normally active-low */
235 gpiod_set_value_cansleep(cs, (spi->mode & SPI_CS_HIGH) ? is_active : !is_active);
236 }
237}
238
239static void spi_gpio_set_mosi_idle(struct spi_device *spi)
240{
241 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
242
243 gpiod_set_value_cansleep(spi_gpio->mosi,
244 !!(spi->mode & SPI_MOSI_IDLE_HIGH));
245}
246
247static int spi_gpio_setup(struct spi_device *spi)
248{
249 struct gpio_desc *cs;
250 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
251 int ret;
252
253 /*
254 * The CS GPIOs have already been
255 * initialized from the descriptor lookup.
256 */
257 if (spi_gpio->cs_gpios) {
258 cs = spi_gpio->cs_gpios[spi_get_chipselect(spi, 0)];
259 if (!spi->controller_state && cs) {
260 ret = gpiod_direction_output(cs, !(spi->mode & SPI_CS_HIGH));
261 if (ret)
262 return ret;
263 }
264 }
265
266 return spi_bitbang_setup(spi);
267}
268
269static int spi_gpio_set_direction(struct spi_device *spi, bool output)
270{
271 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
272 int ret;
273
274 if (output)
275 return gpiod_direction_output(spi_gpio->mosi, 1);
276
277 /*
278 * Only change MOSI to an input if using 3WIRE mode.
279 * Otherwise, MOSI could be left floating if there is
280 * no pull resistor connected to the I/O pin, or could
281 * be left logic high if there is a pull-up. Transmitting
282 * logic high when only clocking MISO data in can put some
283 * SPI devices in to a bad state.
284 */
285 if (spi->mode & SPI_3WIRE) {
286 ret = gpiod_direction_input(spi_gpio->mosi);
287 if (ret)
288 return ret;
289 }
290 /*
291 * Send a turnaround high impedance cycle when switching
292 * from output to input. Theoretically there should be
293 * a clock delay here, but as has been noted above, the
294 * nsec delay function for bit-banged GPIO is simply
295 * {} because bit-banging just doesn't get fast enough
296 * anyway.
297 */
298 if (spi->mode & SPI_3WIRE_HIZ) {
299 gpiod_set_value_cansleep(spi_gpio->sck,
300 !(spi->mode & SPI_CPOL));
301 gpiod_set_value_cansleep(spi_gpio->sck,
302 !!(spi->mode & SPI_CPOL));
303 }
304 return 0;
305}
306
307static void spi_gpio_cleanup(struct spi_device *spi)
308{
309 spi_bitbang_cleanup(spi);
310}
311
312/*
313 * It can be convenient to use this driver with pins that have alternate
314 * functions associated with a "native" SPI controller if a driver for that
315 * controller is not available, or is missing important functionality.
316 *
317 * On platforms which can do so, configure MISO with a weak pullup unless
318 * there's an external pullup on that signal. That saves power by avoiding
319 * floating signals. (A weak pulldown would save power too, but many
320 * drivers expect to see all-ones data as the no target "response".)
321 */
322static int spi_gpio_request(struct device *dev, struct spi_gpio *spi_gpio)
323{
324 spi_gpio->mosi = devm_gpiod_get_optional(dev, "mosi", GPIOD_OUT_LOW);
325 if (IS_ERR(spi_gpio->mosi))
326 return PTR_ERR(spi_gpio->mosi);
327
328 spi_gpio->miso = devm_gpiod_get_optional(dev, "miso", GPIOD_IN);
329 if (IS_ERR(spi_gpio->miso))
330 return PTR_ERR(spi_gpio->miso);
331
332 spi_gpio->sck = devm_gpiod_get(dev, "sck", GPIOD_OUT_LOW);
333 return PTR_ERR_OR_ZERO(spi_gpio->sck);
334}
335
336static int spi_gpio_probe_pdata(struct platform_device *pdev,
337 struct spi_controller *host)
338{
339 struct device *dev = &pdev->dev;
340 struct spi_gpio_platform_data *pdata = dev_get_platdata(dev);
341 struct spi_gpio *spi_gpio = spi_controller_get_devdata(host);
342 int i;
343
344#ifdef GENERIC_BITBANG
345 if (!pdata || !pdata->num_chipselect)
346 return -ENODEV;
347#endif
348 /*
349 * The host needs to think there is a chipselect even if not
350 * connected
351 */
352 host->num_chipselect = pdata->num_chipselect ?: 1;
353
354 spi_gpio->cs_gpios = devm_kcalloc(dev, host->num_chipselect,
355 sizeof(*spi_gpio->cs_gpios),
356 GFP_KERNEL);
357 if (!spi_gpio->cs_gpios)
358 return -ENOMEM;
359
360 for (i = 0; i < host->num_chipselect; i++) {
361 spi_gpio->cs_gpios[i] = devm_gpiod_get_index(dev, "cs", i,
362 GPIOD_OUT_HIGH);
363 if (IS_ERR(spi_gpio->cs_gpios[i]))
364 return PTR_ERR(spi_gpio->cs_gpios[i]);
365 }
366
367 return 0;
368}
369
370static int spi_gpio_probe(struct platform_device *pdev)
371{
372 int status;
373 struct spi_controller *host;
374 struct spi_gpio *spi_gpio;
375 struct device *dev = &pdev->dev;
376 struct fwnode_handle *fwnode = dev_fwnode(dev);
377 struct spi_bitbang *bb;
378
379 host = devm_spi_alloc_host(dev, sizeof(*spi_gpio));
380 if (!host)
381 return -ENOMEM;
382
383 if (fwnode) {
384 device_set_node(&host->dev, fwnode);
385 host->use_gpio_descriptors = true;
386 } else {
387 status = spi_gpio_probe_pdata(pdev, host);
388 if (status)
389 return status;
390 }
391
392 spi_gpio = spi_controller_get_devdata(host);
393
394 status = spi_gpio_request(dev, spi_gpio);
395 if (status)
396 return status;
397
398 host->bits_per_word_mask = SPI_BPW_RANGE_MASK(1, 32);
399 host->mode_bits = SPI_3WIRE | SPI_3WIRE_HIZ | SPI_CPHA | SPI_CPOL |
400 SPI_CS_HIGH | SPI_LSB_FIRST | SPI_MOSI_IDLE_LOW |
401 SPI_MOSI_IDLE_HIGH;
402 if (!spi_gpio->mosi) {
403 /* HW configuration without MOSI pin
404 *
405 * No setting SPI_CONTROLLER_NO_RX here - if there is only
406 * a MOSI pin connected the host can still do RX by
407 * changing the direction of the line.
408 */
409 host->flags = SPI_CONTROLLER_NO_TX;
410 }
411
412 host->bus_num = pdev->id;
413 host->setup = spi_gpio_setup;
414 host->cleanup = spi_gpio_cleanup;
415
416 bb = &spi_gpio->bitbang;
417 bb->ctlr = host;
418 /*
419 * There is some additional business, apart from driving the CS GPIO
420 * line, that we need to do on selection. This makes the local
421 * callback for chipselect always get called.
422 */
423 host->flags |= SPI_CONTROLLER_GPIO_SS;
424 bb->chipselect = spi_gpio_chipselect;
425 bb->set_line_direction = spi_gpio_set_direction;
426 bb->set_mosi_idle = spi_gpio_set_mosi_idle;
427
428 if (host->flags & SPI_CONTROLLER_NO_TX) {
429 bb->txrx_word[SPI_MODE_0] = spi_gpio_spec_txrx_word_mode0;
430 bb->txrx_word[SPI_MODE_1] = spi_gpio_spec_txrx_word_mode1;
431 bb->txrx_word[SPI_MODE_2] = spi_gpio_spec_txrx_word_mode2;
432 bb->txrx_word[SPI_MODE_3] = spi_gpio_spec_txrx_word_mode3;
433 } else {
434 bb->txrx_word[SPI_MODE_0] = spi_gpio_txrx_word_mode0;
435 bb->txrx_word[SPI_MODE_1] = spi_gpio_txrx_word_mode1;
436 bb->txrx_word[SPI_MODE_2] = spi_gpio_txrx_word_mode2;
437 bb->txrx_word[SPI_MODE_3] = spi_gpio_txrx_word_mode3;
438 }
439 bb->setup_transfer = spi_bitbang_setup_transfer;
440
441 status = spi_bitbang_init(&spi_gpio->bitbang);
442 if (status)
443 return status;
444
445 return devm_spi_register_controller(&pdev->dev, host);
446}
447
448MODULE_ALIAS("platform:" DRIVER_NAME);
449
450static const struct of_device_id spi_gpio_dt_ids[] = {
451 { .compatible = "spi-gpio" },
452 {}
453};
454MODULE_DEVICE_TABLE(of, spi_gpio_dt_ids);
455
456static struct platform_driver spi_gpio_driver = {
457 .driver = {
458 .name = DRIVER_NAME,
459 .of_match_table = spi_gpio_dt_ids,
460 },
461 .probe = spi_gpio_probe,
462};
463module_platform_driver(spi_gpio_driver);
464
465MODULE_DESCRIPTION("SPI host driver using generic bitbanged GPIO ");
466MODULE_AUTHOR("David Brownell");
467MODULE_LICENSE("GPL");
1/*
2 * SPI master driver using generic bitbanged GPIO
3 *
4 * Copyright (C) 2006,2008 David Brownell
5 * Copyright (C) 2017 Linus Walleij
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 as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 */
17#include <linux/kernel.h>
18#include <linux/module.h>
19#include <linux/platform_device.h>
20#include <linux/gpio/consumer.h>
21#include <linux/of.h>
22#include <linux/of_device.h>
23
24#include <linux/spi/spi.h>
25#include <linux/spi/spi_bitbang.h>
26#include <linux/spi/spi_gpio.h>
27
28
29/*
30 * This bitbanging SPI master driver should help make systems usable
31 * when a native hardware SPI engine is not available, perhaps because
32 * its driver isn't yet working or because the I/O pins it requires
33 * are used for other purposes.
34 *
35 * platform_device->driver_data ... points to spi_gpio
36 *
37 * spi->controller_state ... reserved for bitbang framework code
38 * spi->controller_data ... holds chipselect GPIO
39 *
40 * spi->master->dev.driver_data ... points to spi_gpio->bitbang
41 */
42
43struct spi_gpio {
44 struct spi_bitbang bitbang;
45 struct spi_gpio_platform_data pdata;
46 struct platform_device *pdev;
47 struct gpio_desc *sck;
48 struct gpio_desc *miso;
49 struct gpio_desc *mosi;
50 struct gpio_desc **cs_gpios;
51 bool has_cs;
52};
53
54/*----------------------------------------------------------------------*/
55
56/*
57 * Because the overhead of going through four GPIO procedure calls
58 * per transferred bit can make performance a problem, this code
59 * is set up so that you can use it in either of two ways:
60 *
61 * - The slow generic way: set up platform_data to hold the GPIO
62 * numbers used for MISO/MOSI/SCK, and issue procedure calls for
63 * each of them. This driver can handle several such busses.
64 *
65 * - The quicker inlined way: only helps with platform GPIO code
66 * that inlines operations for constant GPIOs. This can give
67 * you tight (fast!) inner loops, but each such bus needs a
68 * new driver. You'll define a new C file, with Makefile and
69 * Kconfig support; the C code can be a total of six lines:
70 *
71 * #define DRIVER_NAME "myboard_spi2"
72 * #define SPI_MISO_GPIO 119
73 * #define SPI_MOSI_GPIO 120
74 * #define SPI_SCK_GPIO 121
75 * #define SPI_N_CHIPSEL 4
76 * #include "spi-gpio.c"
77 */
78
79#ifndef DRIVER_NAME
80#define DRIVER_NAME "spi_gpio"
81
82#define GENERIC_BITBANG /* vs tight inlines */
83
84#endif
85
86/*----------------------------------------------------------------------*/
87
88static inline struct spi_gpio *__pure
89spi_to_spi_gpio(const struct spi_device *spi)
90{
91 const struct spi_bitbang *bang;
92 struct spi_gpio *spi_gpio;
93
94 bang = spi_master_get_devdata(spi->master);
95 spi_gpio = container_of(bang, struct spi_gpio, bitbang);
96 return spi_gpio;
97}
98
99static inline struct spi_gpio_platform_data *__pure
100spi_to_pdata(const struct spi_device *spi)
101{
102 return &spi_to_spi_gpio(spi)->pdata;
103}
104
105/* These helpers are in turn called by the bitbang inlines */
106static inline void setsck(const struct spi_device *spi, int is_on)
107{
108 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
109
110 gpiod_set_value_cansleep(spi_gpio->sck, is_on);
111}
112
113static inline void setmosi(const struct spi_device *spi, int is_on)
114{
115 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
116
117 gpiod_set_value_cansleep(spi_gpio->mosi, is_on);
118}
119
120static inline int getmiso(const struct spi_device *spi)
121{
122 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
123
124 return !!gpiod_get_value_cansleep(spi_gpio->miso);
125}
126
127/*
128 * NOTE: this clocks "as fast as we can". It "should" be a function of the
129 * requested device clock. Software overhead means we usually have trouble
130 * reaching even one Mbit/sec (except when we can inline bitops), so for now
131 * we'll just assume we never need additional per-bit slowdowns.
132 */
133#define spidelay(nsecs) do {} while (0)
134
135#include "spi-bitbang-txrx.h"
136
137/*
138 * These functions can leverage inline expansion of GPIO calls to shrink
139 * costs for a txrx bit, often by factors of around ten (by instruction
140 * count). That is particularly visible for larger word sizes, but helps
141 * even with default 8-bit words.
142 *
143 * REVISIT overheads calling these functions for each word also have
144 * significant performance costs. Having txrx_bufs() calls that inline
145 * the txrx_word() logic would help performance, e.g. on larger blocks
146 * used with flash storage or MMC/SD. There should also be ways to make
147 * GCC be less stupid about reloading registers inside the I/O loops,
148 * even without inlined GPIO calls; __attribute__((hot)) on GCC 4.3?
149 */
150
151static u32 spi_gpio_txrx_word_mode0(struct spi_device *spi,
152 unsigned nsecs, u32 word, u8 bits)
153{
154 return bitbang_txrx_be_cpha0(spi, nsecs, 0, 0, word, bits);
155}
156
157static u32 spi_gpio_txrx_word_mode1(struct spi_device *spi,
158 unsigned nsecs, u32 word, u8 bits)
159{
160 return bitbang_txrx_be_cpha1(spi, nsecs, 0, 0, word, bits);
161}
162
163static u32 spi_gpio_txrx_word_mode2(struct spi_device *spi,
164 unsigned nsecs, u32 word, u8 bits)
165{
166 return bitbang_txrx_be_cpha0(spi, nsecs, 1, 0, word, bits);
167}
168
169static u32 spi_gpio_txrx_word_mode3(struct spi_device *spi,
170 unsigned nsecs, u32 word, u8 bits)
171{
172 return bitbang_txrx_be_cpha1(spi, nsecs, 1, 0, word, bits);
173}
174
175/*
176 * These functions do not call setmosi or getmiso if respective flag
177 * (SPI_MASTER_NO_RX or SPI_MASTER_NO_TX) is set, so they are safe to
178 * call when such pin is not present or defined in the controller.
179 * A separate set of callbacks is defined to get highest possible
180 * speed in the generic case (when both MISO and MOSI lines are
181 * available), as optimiser will remove the checks when argument is
182 * constant.
183 */
184
185static u32 spi_gpio_spec_txrx_word_mode0(struct spi_device *spi,
186 unsigned nsecs, u32 word, u8 bits)
187{
188 unsigned flags = spi->master->flags;
189 return bitbang_txrx_be_cpha0(spi, nsecs, 0, flags, word, bits);
190}
191
192static u32 spi_gpio_spec_txrx_word_mode1(struct spi_device *spi,
193 unsigned nsecs, u32 word, u8 bits)
194{
195 unsigned flags = spi->master->flags;
196 return bitbang_txrx_be_cpha1(spi, nsecs, 0, flags, word, bits);
197}
198
199static u32 spi_gpio_spec_txrx_word_mode2(struct spi_device *spi,
200 unsigned nsecs, u32 word, u8 bits)
201{
202 unsigned flags = spi->master->flags;
203 return bitbang_txrx_be_cpha0(spi, nsecs, 1, flags, word, bits);
204}
205
206static u32 spi_gpio_spec_txrx_word_mode3(struct spi_device *spi,
207 unsigned nsecs, u32 word, u8 bits)
208{
209 unsigned flags = spi->master->flags;
210 return bitbang_txrx_be_cpha1(spi, nsecs, 1, flags, word, bits);
211}
212
213/*----------------------------------------------------------------------*/
214
215static void spi_gpio_chipselect(struct spi_device *spi, int is_active)
216{
217 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
218
219 /* set initial clock line level */
220 if (is_active)
221 gpiod_set_value_cansleep(spi_gpio->sck, spi->mode & SPI_CPOL);
222
223 /* Drive chip select line, if we have one */
224 if (spi_gpio->has_cs) {
225 struct gpio_desc *cs = spi_gpio->cs_gpios[spi->chip_select];
226
227 /* SPI chip selects are normally active-low */
228 gpiod_set_value_cansleep(cs, (spi->mode & SPI_CS_HIGH) ? is_active : !is_active);
229 }
230}
231
232static int spi_gpio_setup(struct spi_device *spi)
233{
234 struct gpio_desc *cs;
235 int status = 0;
236 struct spi_gpio *spi_gpio = spi_to_spi_gpio(spi);
237
238 /*
239 * The CS GPIOs have already been
240 * initialized from the descriptor lookup.
241 */
242 cs = spi_gpio->cs_gpios[spi->chip_select];
243 if (!spi->controller_state && cs)
244 status = gpiod_direction_output(cs,
245 !(spi->mode & SPI_CS_HIGH));
246
247 if (!status)
248 status = spi_bitbang_setup(spi);
249
250 return status;
251}
252
253static void spi_gpio_cleanup(struct spi_device *spi)
254{
255 spi_bitbang_cleanup(spi);
256}
257
258/*
259 * It can be convenient to use this driver with pins that have alternate
260 * functions associated with a "native" SPI controller if a driver for that
261 * controller is not available, or is missing important functionality.
262 *
263 * On platforms which can do so, configure MISO with a weak pullup unless
264 * there's an external pullup on that signal. That saves power by avoiding
265 * floating signals. (A weak pulldown would save power too, but many
266 * drivers expect to see all-ones data as the no slave "response".)
267 */
268static int spi_gpio_request(struct device *dev,
269 struct spi_gpio *spi_gpio,
270 unsigned int num_chipselects,
271 u16 *mflags)
272{
273 int i;
274
275 spi_gpio->mosi = devm_gpiod_get_optional(dev, "mosi", GPIOD_OUT_LOW);
276 if (IS_ERR(spi_gpio->mosi))
277 return PTR_ERR(spi_gpio->mosi);
278 if (!spi_gpio->mosi)
279 /* HW configuration without MOSI pin */
280 *mflags |= SPI_MASTER_NO_TX;
281
282 spi_gpio->miso = devm_gpiod_get_optional(dev, "miso", GPIOD_IN);
283 if (IS_ERR(spi_gpio->miso))
284 return PTR_ERR(spi_gpio->miso);
285 if (!spi_gpio->miso)
286 /* HW configuration without MISO pin */
287 *mflags |= SPI_MASTER_NO_RX;
288
289 spi_gpio->sck = devm_gpiod_get(dev, "sck", GPIOD_OUT_LOW);
290 if (IS_ERR(spi_gpio->mosi))
291 return PTR_ERR(spi_gpio->mosi);
292
293 for (i = 0; i < num_chipselects; i++) {
294 spi_gpio->cs_gpios[i] = devm_gpiod_get_index(dev, "cs",
295 i, GPIOD_OUT_HIGH);
296 if (IS_ERR(spi_gpio->cs_gpios[i]))
297 return PTR_ERR(spi_gpio->cs_gpios[i]);
298 }
299
300 return 0;
301}
302
303#ifdef CONFIG_OF
304static const struct of_device_id spi_gpio_dt_ids[] = {
305 { .compatible = "spi-gpio" },
306 {}
307};
308MODULE_DEVICE_TABLE(of, spi_gpio_dt_ids);
309
310static int spi_gpio_probe_dt(struct platform_device *pdev)
311{
312 int ret;
313 u32 tmp;
314 struct spi_gpio_platform_data *pdata;
315 struct device_node *np = pdev->dev.of_node;
316 const struct of_device_id *of_id =
317 of_match_device(spi_gpio_dt_ids, &pdev->dev);
318
319 if (!of_id)
320 return 0;
321
322 pdata = devm_kzalloc(&pdev->dev, sizeof(*pdata), GFP_KERNEL);
323 if (!pdata)
324 return -ENOMEM;
325
326
327 ret = of_property_read_u32(np, "num-chipselects", &tmp);
328 if (ret < 0) {
329 dev_err(&pdev->dev, "num-chipselects property not found\n");
330 goto error_free;
331 }
332
333 pdata->num_chipselect = tmp;
334 pdev->dev.platform_data = pdata;
335
336 return 1;
337
338error_free:
339 devm_kfree(&pdev->dev, pdata);
340 return ret;
341}
342#else
343static inline int spi_gpio_probe_dt(struct platform_device *pdev)
344{
345 return 0;
346}
347#endif
348
349static int spi_gpio_probe(struct platform_device *pdev)
350{
351 int status;
352 struct spi_master *master;
353 struct spi_gpio *spi_gpio;
354 struct spi_gpio_platform_data *pdata;
355 u16 master_flags = 0;
356 bool use_of = 0;
357
358 status = spi_gpio_probe_dt(pdev);
359 if (status < 0)
360 return status;
361 if (status > 0)
362 use_of = 1;
363
364 pdata = dev_get_platdata(&pdev->dev);
365#ifdef GENERIC_BITBANG
366 if (!pdata || (!use_of && !pdata->num_chipselect))
367 return -ENODEV;
368#endif
369
370 master = spi_alloc_master(&pdev->dev, sizeof(*spi_gpio));
371 if (!master)
372 return -ENOMEM;
373
374 spi_gpio = spi_master_get_devdata(master);
375
376 spi_gpio->cs_gpios = devm_kzalloc(&pdev->dev,
377 pdata->num_chipselect * sizeof(*spi_gpio->cs_gpios),
378 GFP_KERNEL);
379 if (!spi_gpio->cs_gpios)
380 return -ENOMEM;
381
382 platform_set_drvdata(pdev, spi_gpio);
383
384 /* Determine if we have chip selects connected */
385 spi_gpio->has_cs = !!pdata->num_chipselect;
386
387 spi_gpio->pdev = pdev;
388 if (pdata)
389 spi_gpio->pdata = *pdata;
390
391 status = spi_gpio_request(&pdev->dev, spi_gpio,
392 pdata->num_chipselect, &master_flags);
393 if (status)
394 return status;
395
396 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(1, 32);
397 master->flags = master_flags;
398 master->bus_num = pdev->id;
399 /* The master needs to think there is a chipselect even if not connected */
400 master->num_chipselect = spi_gpio->has_cs ? pdata->num_chipselect : 1;
401 master->setup = spi_gpio_setup;
402 master->cleanup = spi_gpio_cleanup;
403#ifdef CONFIG_OF
404 master->dev.of_node = pdev->dev.of_node;
405#endif
406
407 spi_gpio->bitbang.master = master;
408 spi_gpio->bitbang.chipselect = spi_gpio_chipselect;
409
410 if ((master_flags & (SPI_MASTER_NO_TX | SPI_MASTER_NO_RX)) == 0) {
411 spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_txrx_word_mode0;
412 spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_txrx_word_mode1;
413 spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_txrx_word_mode2;
414 spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_txrx_word_mode3;
415 } else {
416 spi_gpio->bitbang.txrx_word[SPI_MODE_0] = spi_gpio_spec_txrx_word_mode0;
417 spi_gpio->bitbang.txrx_word[SPI_MODE_1] = spi_gpio_spec_txrx_word_mode1;
418 spi_gpio->bitbang.txrx_word[SPI_MODE_2] = spi_gpio_spec_txrx_word_mode2;
419 spi_gpio->bitbang.txrx_word[SPI_MODE_3] = spi_gpio_spec_txrx_word_mode3;
420 }
421 spi_gpio->bitbang.setup_transfer = spi_bitbang_setup_transfer;
422 spi_gpio->bitbang.flags = SPI_CS_HIGH;
423
424 status = spi_bitbang_start(&spi_gpio->bitbang);
425 if (status)
426 spi_master_put(master);
427
428 return status;
429}
430
431static int spi_gpio_remove(struct platform_device *pdev)
432{
433 struct spi_gpio *spi_gpio;
434 struct spi_gpio_platform_data *pdata;
435
436 spi_gpio = platform_get_drvdata(pdev);
437 pdata = dev_get_platdata(&pdev->dev);
438
439 /* stop() unregisters child devices too */
440 spi_bitbang_stop(&spi_gpio->bitbang);
441
442 spi_master_put(spi_gpio->bitbang.master);
443
444 return 0;
445}
446
447MODULE_ALIAS("platform:" DRIVER_NAME);
448
449static struct platform_driver spi_gpio_driver = {
450 .driver = {
451 .name = DRIVER_NAME,
452 .of_match_table = of_match_ptr(spi_gpio_dt_ids),
453 },
454 .probe = spi_gpio_probe,
455 .remove = spi_gpio_remove,
456};
457module_platform_driver(spi_gpio_driver);
458
459MODULE_DESCRIPTION("SPI master driver using generic bitbanged GPIO ");
460MODULE_AUTHOR("David Brownell");
461MODULE_LICENSE("GPL");