blob: bd222f6b677d0c775dbd608a66356554adefa660 [file] [log] [blame]
David Brownell9904f222006-01-08 13:34:26 -08001/*
Grant Likelyca632f52011-06-06 01:16:30 -06002 * polling/bitbanging SPI master controller driver utilities
David Brownell9904f222006-01-08 13:34:26 -08003 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 */
18
David Brownell9904f222006-01-08 13:34:26 -080019#include <linux/init.h>
20#include <linux/spinlock.h>
21#include <linux/workqueue.h>
22#include <linux/interrupt.h>
Paul Gortmakerd7614de2011-07-03 15:44:29 -040023#include <linux/module.h>
David Brownell9904f222006-01-08 13:34:26 -080024#include <linux/delay.h>
25#include <linux/errno.h>
26#include <linux/platform_device.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090027#include <linux/slab.h>
David Brownell9904f222006-01-08 13:34:26 -080028
29#include <linux/spi/spi.h>
30#include <linux/spi/spi_bitbang.h>
31
32
33/*----------------------------------------------------------------------*/
34
35/*
36 * FIRST PART (OPTIONAL): word-at-a-time spi_transfer support.
37 * Use this for GPIO or shift-register level hardware APIs.
38 *
39 * spi_bitbang_cs is in spi_device->controller_state, which is unavailable
40 * to glue code. These bitbang setup() and cleanup() routines are always
41 * used, though maybe they're called from controller-aware code.
42 *
Uwe Kleine-König03ddcbc2013-08-07 21:22:20 +020043 * chipselect() and friends may use spi_device->controller_data and
David Brownell9904f222006-01-08 13:34:26 -080044 * controller registers as appropriate.
45 *
46 *
47 * NOTE: SPI controller pins can often be used as GPIO pins instead,
48 * which means you could use a bitbang driver either to get hardware
49 * working quickly, or testing for differences that aren't speed related.
50 */
51
52struct spi_bitbang_cs {
53 unsigned nsecs; /* (clock cycle time)/2 */
54 u32 (*txrx_word)(struct spi_device *spi, unsigned nsecs,
55 u32 word, u8 bits);
56 unsigned (*txrx_bufs)(struct spi_device *,
57 u32 (*txrx_word)(
58 struct spi_device *spi,
59 unsigned nsecs,
60 u32 word, u8 bits),
61 unsigned, struct spi_transfer *);
62};
63
64static unsigned bitbang_txrx_8(
65 struct spi_device *spi,
66 u32 (*txrx_word)(struct spi_device *spi,
67 unsigned nsecs,
68 u32 word, u8 bits),
69 unsigned ns,
70 struct spi_transfer *t
71) {
Laxman Dewangan766ed702012-12-18 14:25:43 +053072 unsigned bits = t->bits_per_word;
David Brownell9904f222006-01-08 13:34:26 -080073 unsigned count = t->len;
74 const u8 *tx = t->tx_buf;
75 u8 *rx = t->rx_buf;
76
77 while (likely(count > 0)) {
78 u8 word = 0;
79
80 if (tx)
81 word = *tx++;
82 word = txrx_word(spi, ns, word, bits);
83 if (rx)
84 *rx++ = word;
85 count -= 1;
86 }
87 return t->len - count;
88}
89
90static unsigned bitbang_txrx_16(
91 struct spi_device *spi,
92 u32 (*txrx_word)(struct spi_device *spi,
93 unsigned nsecs,
94 u32 word, u8 bits),
95 unsigned ns,
96 struct spi_transfer *t
97) {
Laxman Dewangan766ed702012-12-18 14:25:43 +053098 unsigned bits = t->bits_per_word;
David Brownell9904f222006-01-08 13:34:26 -080099 unsigned count = t->len;
100 const u16 *tx = t->tx_buf;
101 u16 *rx = t->rx_buf;
102
103 while (likely(count > 1)) {
104 u16 word = 0;
105
106 if (tx)
107 word = *tx++;
108 word = txrx_word(spi, ns, word, bits);
109 if (rx)
110 *rx++ = word;
111 count -= 2;
112 }
113 return t->len - count;
114}
115
116static unsigned bitbang_txrx_32(
117 struct spi_device *spi,
118 u32 (*txrx_word)(struct spi_device *spi,
119 unsigned nsecs,
120 u32 word, u8 bits),
121 unsigned ns,
122 struct spi_transfer *t
123) {
Laxman Dewangan766ed702012-12-18 14:25:43 +0530124 unsigned bits = t->bits_per_word;
David Brownell9904f222006-01-08 13:34:26 -0800125 unsigned count = t->len;
126 const u32 *tx = t->tx_buf;
127 u32 *rx = t->rx_buf;
128
129 while (likely(count > 3)) {
130 u32 word = 0;
131
132 if (tx)
133 word = *tx++;
134 word = txrx_word(spi, ns, word, bits);
135 if (rx)
136 *rx++ = word;
137 count -= 4;
138 }
139 return t->len - count;
140}
141
Kumar Galaff9f4772006-04-02 16:06:35 -0500142int spi_bitbang_setup_transfer(struct spi_device *spi, struct spi_transfer *t)
Imre Deak4cff33f2006-02-17 10:02:18 -0800143{
144 struct spi_bitbang_cs *cs = spi->controller_state;
145 u8 bits_per_word;
146 u32 hz;
147
148 if (t) {
149 bits_per_word = t->bits_per_word;
150 hz = t->speed_hz;
151 } else {
152 bits_per_word = 0;
153 hz = 0;
154 }
155
156 /* spi_transfer level calls that work per-word */
157 if (!bits_per_word)
158 bits_per_word = spi->bits_per_word;
159 if (bits_per_word <= 8)
160 cs->txrx_bufs = bitbang_txrx_8;
161 else if (bits_per_word <= 16)
162 cs->txrx_bufs = bitbang_txrx_16;
163 else if (bits_per_word <= 32)
164 cs->txrx_bufs = bitbang_txrx_32;
165 else
166 return -EINVAL;
167
168 /* nsecs = (clock period)/2 */
169 if (!hz)
170 hz = spi->max_speed_hz;
David Brownell1e316d72006-04-06 22:25:56 -0700171 if (hz) {
172 cs->nsecs = (1000000000/2) / hz;
173 if (cs->nsecs > (MAX_UDELAY_MS * 1000 * 1000))
174 return -EINVAL;
175 }
Imre Deak4cff33f2006-02-17 10:02:18 -0800176
177 return 0;
178}
Kumar Galaff9f4772006-04-02 16:06:35 -0500179EXPORT_SYMBOL_GPL(spi_bitbang_setup_transfer);
Imre Deak4cff33f2006-02-17 10:02:18 -0800180
David Brownell9904f222006-01-08 13:34:26 -0800181/**
182 * spi_bitbang_setup - default setup for per-word I/O loops
183 */
184int spi_bitbang_setup(struct spi_device *spi)
185{
186 struct spi_bitbang_cs *cs = spi->controller_state;
187 struct spi_bitbang *bitbang;
Imre Deak4cff33f2006-02-17 10:02:18 -0800188 int retval;
David Brownelld52df2e2008-01-08 15:32:40 -0800189 unsigned long flags;
David Brownell9904f222006-01-08 13:34:26 -0800190
David Brownellccf77cc2006-04-03 15:46:22 -0700191 bitbang = spi_master_get_devdata(spi->master);
192
David Brownell9904f222006-01-08 13:34:26 -0800193 if (!cs) {
Jingoo Hancff93c52013-10-14 10:33:38 +0900194 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
David Brownell9904f222006-01-08 13:34:26 -0800195 if (!cs)
196 return -ENOMEM;
197 spi->controller_state = cs;
198 }
David Brownell9904f222006-01-08 13:34:26 -0800199
David Brownell9904f222006-01-08 13:34:26 -0800200 /* per-word shift register access, in hardware or bitbanging */
201 cs->txrx_word = bitbang->txrx_word[spi->mode & (SPI_CPOL|SPI_CPHA)];
202 if (!cs->txrx_word)
203 return -EINVAL;
204
Hans-Peter Nilsson7f8c7612007-02-12 00:52:44 -0800205 retval = bitbang->setup_transfer(spi, NULL);
Imre Deak4cff33f2006-02-17 10:02:18 -0800206 if (retval < 0)
207 return retval;
David Brownell9904f222006-01-08 13:34:26 -0800208
David Brownell7d077192009-06-17 16:26:03 -0700209 dev_dbg(&spi->dev, "%s, %u nsec/bit\n", __func__, 2 * cs->nsecs);
David Brownell9904f222006-01-08 13:34:26 -0800210
211 /* NOTE we _need_ to call chipselect() early, ideally with adapter
212 * setup, unless the hardware defaults cooperate to avoid confusion
213 * between normal (active low) and inverted chipselects.
214 */
215
216 /* deselect chip (low or high) */
David Brownelld52df2e2008-01-08 15:32:40 -0800217 spin_lock_irqsave(&bitbang->lock, flags);
David Brownell9904f222006-01-08 13:34:26 -0800218 if (!bitbang->busy) {
Vitaly Wool8275c642006-01-08 13:34:28 -0800219 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
David Brownell9904f222006-01-08 13:34:26 -0800220 ndelay(cs->nsecs);
221 }
David Brownelld52df2e2008-01-08 15:32:40 -0800222 spin_unlock_irqrestore(&bitbang->lock, flags);
David Brownell9904f222006-01-08 13:34:26 -0800223
224 return 0;
225}
226EXPORT_SYMBOL_GPL(spi_bitbang_setup);
227
228/**
229 * spi_bitbang_cleanup - default cleanup for per-word I/O loops
230 */
Hans-Peter Nilsson0ffa0282007-02-12 00:52:45 -0800231void spi_bitbang_cleanup(struct spi_device *spi)
David Brownell9904f222006-01-08 13:34:26 -0800232{
233 kfree(spi->controller_state);
234}
235EXPORT_SYMBOL_GPL(spi_bitbang_cleanup);
236
237static int spi_bitbang_bufs(struct spi_device *spi, struct spi_transfer *t)
238{
239 struct spi_bitbang_cs *cs = spi->controller_state;
240 unsigned nsecs = cs->nsecs;
241
242 return cs->txrx_bufs(spi, cs->txrx_word, nsecs, t);
243}
244
245/*----------------------------------------------------------------------*/
246
247/*
248 * SECOND PART ... simple transfer queue runner.
249 *
250 * This costs a task context per controller, running the queue by
251 * performing each transfer in sequence. Smarter hardware can queue
252 * several DMA transfers at once, and process several controller queues
253 * in parallel; this driver doesn't match such hardware very well.
254 *
255 * Drivers can provide word-at-a-time i/o primitives, or provide
256 * transfer-at-a-time ones to leverage dma or fifo hardware.
257 */
Mark Brown20251722013-07-05 20:07:27 +0100258
259static int spi_bitbang_prepare_hardware(struct spi_master *spi)
260{
Jingoo Hancff93c52013-10-14 10:33:38 +0900261 struct spi_bitbang *bitbang;
Mark Brown20251722013-07-05 20:07:27 +0100262 unsigned long flags;
263
264 bitbang = spi_master_get_devdata(spi);
265
266 spin_lock_irqsave(&bitbang->lock, flags);
267 bitbang->busy = 1;
268 spin_unlock_irqrestore(&bitbang->lock, flags);
269
270 return 0;
271}
272
Fabio Estevamd60990d52013-07-17 15:49:54 -0300273static int spi_bitbang_transfer_one(struct spi_master *master,
Mark Brown91b30852013-07-05 12:06:44 +0100274 struct spi_message *m)
275{
Jingoo Hancff93c52013-10-14 10:33:38 +0900276 struct spi_bitbang *bitbang;
Mark Brown91b30852013-07-05 12:06:44 +0100277 unsigned nsecs;
278 struct spi_transfer *t = NULL;
Mark Brown91b30852013-07-05 12:06:44 +0100279 unsigned cs_change;
280 int status;
281 int do_setup = -1;
Fabio Estevamd60990d52013-07-17 15:49:54 -0300282 struct spi_device *spi = m->spi;
Mark Brown91b30852013-07-05 12:06:44 +0100283
Fabio Estevamd60990d52013-07-17 15:49:54 -0300284 bitbang = spi_master_get_devdata(master);
Mark Brown91b30852013-07-05 12:06:44 +0100285
286 /* FIXME this is made-up ... the correct value is known to
287 * word-at-a-time bitbang code, and presumably chipselect()
288 * should enforce these requirements too?
289 */
290 nsecs = 100;
291
Mark Brown91b30852013-07-05 12:06:44 +0100292 cs_change = 1;
293 status = 0;
294
Jingoo Hancff93c52013-10-14 10:33:38 +0900295 list_for_each_entry(t, &m->transfers, transfer_list) {
Mark Brown91b30852013-07-05 12:06:44 +0100296
297 /* override speed or wordsize? */
298 if (t->speed_hz || t->bits_per_word)
299 do_setup = 1;
300
301 /* init (-1) or override (1) transfer params */
302 if (do_setup != 0) {
303 status = bitbang->setup_transfer(spi, t);
304 if (status < 0)
305 break;
306 if (do_setup == -1)
307 do_setup = 0;
308 }
309
310 /* set up default clock polarity, and activate chip;
311 * this implicitly updates clock and spi modes as
312 * previously recorded for this device via setup().
313 * (and also deselects any other chip that might be
314 * selected ...)
315 */
316 if (cs_change) {
317 bitbang->chipselect(spi, BITBANG_CS_ACTIVE);
318 ndelay(nsecs);
319 }
320 cs_change = t->cs_change;
321 if (!t->tx_buf && !t->rx_buf && t->len) {
322 status = -EINVAL;
323 break;
324 }
325
326 /* transfer data. the lower level code handles any
327 * new dma mappings it needs. our caller always gave
328 * us dma-safe buffers.
329 */
330 if (t->len) {
331 /* REVISIT dma API still needs a designated
332 * DMA_ADDR_INVALID; ~0 might be better.
333 */
334 if (!m->is_dma_mapped)
335 t->rx_dma = t->tx_dma = 0;
336 status = bitbang->txrx_bufs(spi, t);
337 }
338 if (status > 0)
339 m->actual_length += status;
340 if (status != t->len) {
341 /* always report some kind of error */
342 if (status >= 0)
343 status = -EREMOTEIO;
344 break;
345 }
346 status = 0;
347
348 /* protocol tweaks before next transfer */
349 if (t->delay_usecs)
350 udelay(t->delay_usecs);
351
Jingoo Hancff93c52013-10-14 10:33:38 +0900352 if (cs_change &&
353 !list_is_last(&t->transfer_list, &m->transfers)) {
Mark Brown91b30852013-07-05 12:06:44 +0100354 /* sometimes a short mid-message deselect of the chip
355 * may be needed to terminate a mode or command
356 */
357 ndelay(nsecs);
358 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
359 ndelay(nsecs);
360 }
361 }
362
363 m->status = status;
Mark Brown91b30852013-07-05 12:06:44 +0100364
365 /* normally deactivate chipselect ... unless no error and
366 * cs_change has hinted that the next message will probably
367 * be for this chip too.
368 */
369 if (!(status == 0 && cs_change)) {
370 ndelay(nsecs);
371 bitbang->chipselect(spi, BITBANG_CS_INACTIVE);
372 ndelay(nsecs);
373 }
374
Fabio Estevamd60990d52013-07-17 15:49:54 -0300375 spi_finalize_current_message(master);
Mark Brown20251722013-07-05 20:07:27 +0100376
Mark Brown91b30852013-07-05 12:06:44 +0100377 return status;
378}
379
Mark Brown20251722013-07-05 20:07:27 +0100380static int spi_bitbang_unprepare_hardware(struct spi_master *spi)
David Brownell9904f222006-01-08 13:34:26 -0800381{
Jingoo Hancff93c52013-10-14 10:33:38 +0900382 struct spi_bitbang *bitbang;
David Brownell9904f222006-01-08 13:34:26 -0800383 unsigned long flags;
Mark Brown20251722013-07-05 20:07:27 +0100384
385 bitbang = spi_master_get_devdata(spi);
David Brownell9904f222006-01-08 13:34:26 -0800386
387 spin_lock_irqsave(&bitbang->lock, flags);
David Brownell9904f222006-01-08 13:34:26 -0800388 bitbang->busy = 0;
389 spin_unlock_irqrestore(&bitbang->lock, flags);
David Brownell9904f222006-01-08 13:34:26 -0800390
Mark Brown20251722013-07-05 20:07:27 +0100391 return 0;
David Brownell9904f222006-01-08 13:34:26 -0800392}
David Brownell9904f222006-01-08 13:34:26 -0800393
394/*----------------------------------------------------------------------*/
395
396/**
397 * spi_bitbang_start - start up a polled/bitbanging SPI master driver
398 * @bitbang: driver handle
399 *
400 * Caller should have zero-initialized all parts of the structure, and then
401 * provided callbacks for chip selection and I/O loops. If the master has
402 * a transfer method, its final step should call spi_bitbang_transfer; or,
403 * that's the default if the transfer routine is not initialized. It should
404 * also set up the bus number and number of chipselects.
405 *
406 * For i/o loops, provide callbacks either per-word (for bitbanging, or for
407 * hardware that basically exposes a shift register) or per-spi_transfer
408 * (which takes better advantage of hardware like fifos or DMA engines).
409 *
Hans-Peter Nilsson7f8c7612007-02-12 00:52:44 -0800410 * Drivers using per-word I/O loops should use (or call) spi_bitbang_setup,
411 * spi_bitbang_cleanup and spi_bitbang_setup_transfer to handle those spi
412 * master methods. Those methods are the defaults if the bitbang->txrx_bufs
413 * routine isn't initialized.
David Brownell9904f222006-01-08 13:34:26 -0800414 *
415 * This routine registers the spi_master, which will process requests in a
416 * dedicated task, keeping IRQs unblocked most of the time. To stop
417 * processing those requests, call spi_bitbang_stop().
Axel Lin702a4872013-09-10 15:43:41 +0800418 *
419 * On success, this routine will take a reference to master. The caller is
420 * responsible for calling spi_bitbang_stop() to decrement the reference and
421 * spi_master_put() as counterpart of spi_alloc_master() to prevent a memory
422 * leak.
David Brownell9904f222006-01-08 13:34:26 -0800423 */
424int spi_bitbang_start(struct spi_bitbang *bitbang)
425{
Guennadi Liakhovetski7a5d8ca2013-01-10 13:13:56 +0100426 struct spi_master *master = bitbang->master;
Axel Lin702a4872013-09-10 15:43:41 +0800427 int ret;
David Brownell9904f222006-01-08 13:34:26 -0800428
Guennadi Liakhovetski7a5d8ca2013-01-10 13:13:56 +0100429 if (!master || !bitbang->chipselect)
David Brownell9904f222006-01-08 13:34:26 -0800430 return -EINVAL;
431
David Brownell9904f222006-01-08 13:34:26 -0800432 spin_lock_init(&bitbang->lock);
David Brownell9904f222006-01-08 13:34:26 -0800433
Guennadi Liakhovetski7a5d8ca2013-01-10 13:13:56 +0100434 if (!master->mode_bits)
435 master->mode_bits = SPI_CPOL | SPI_CPHA | bitbang->flags;
David Brownelle7db06b2009-06-17 16:26:04 -0700436
Mark Brown20251722013-07-05 20:07:27 +0100437 if (master->transfer || master->transfer_one_message)
438 return -EINVAL;
439
440 master->prepare_transfer_hardware = spi_bitbang_prepare_hardware;
441 master->unprepare_transfer_hardware = spi_bitbang_unprepare_hardware;
442 master->transfer_one_message = spi_bitbang_transfer_one;
443
David Brownell9904f222006-01-08 13:34:26 -0800444 if (!bitbang->txrx_bufs) {
445 bitbang->use_dma = 0;
446 bitbang->txrx_bufs = spi_bitbang_bufs;
Guennadi Liakhovetski7a5d8ca2013-01-10 13:13:56 +0100447 if (!master->setup) {
Kumar Galaff9f4772006-04-02 16:06:35 -0500448 if (!bitbang->setup_transfer)
449 bitbang->setup_transfer =
450 spi_bitbang_setup_transfer;
Guennadi Liakhovetski7a5d8ca2013-01-10 13:13:56 +0100451 master->setup = spi_bitbang_setup;
452 master->cleanup = spi_bitbang_cleanup;
David Brownell9904f222006-01-08 13:34:26 -0800453 }
Uwe Kleine-König52ade732013-08-08 16:09:49 +0200454 }
David Brownell9904f222006-01-08 13:34:26 -0800455
456 /* driver may get busy before register() returns, especially
457 * if someone registered boardinfo for devices
458 */
Axel Lin702a4872013-09-10 15:43:41 +0800459 ret = spi_register_master(spi_master_get(master));
460 if (ret)
461 spi_master_put(master);
462
463 return 0;
David Brownell9904f222006-01-08 13:34:26 -0800464}
465EXPORT_SYMBOL_GPL(spi_bitbang_start);
466
467/**
468 * spi_bitbang_stop - stops the task providing spi communication
469 */
470int spi_bitbang_stop(struct spi_bitbang *bitbang)
471{
Chris Lesiaka836f582007-03-16 13:38:13 -0800472 spi_unregister_master(bitbang->master);
David Brownell9904f222006-01-08 13:34:26 -0800473
David Brownell9904f222006-01-08 13:34:26 -0800474 return 0;
475}
476EXPORT_SYMBOL_GPL(spi_bitbang_stop);
477
478MODULE_LICENSE("GPL");
479