Commit | Line | Data |
---|---|---|
9904f22a DB |
1 | /* |
2 | * spi_bitbang.c - polling/bitbanging SPI master controller driver utilities | |
3 | * | |
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 | ||
9904f22a DB |
19 | #include <linux/init.h> |
20 | #include <linux/spinlock.h> | |
21 | #include <linux/workqueue.h> | |
22 | #include <linux/interrupt.h> | |
23 | #include <linux/delay.h> | |
24 | #include <linux/errno.h> | |
25 | #include <linux/platform_device.h> | |
26 | ||
27 | #include <linux/spi/spi.h> | |
28 | #include <linux/spi/spi_bitbang.h> | |
29 | ||
30 | ||
31 | /*----------------------------------------------------------------------*/ | |
32 | ||
33 | /* | |
34 | * FIRST PART (OPTIONAL): word-at-a-time spi_transfer support. | |
35 | * Use this for GPIO or shift-register level hardware APIs. | |
36 | * | |
37 | * spi_bitbang_cs is in spi_device->controller_state, which is unavailable | |
38 | * to glue code. These bitbang setup() and cleanup() routines are always | |
39 | * used, though maybe they're called from controller-aware code. | |
40 | * | |
41 | * chipselect() and friends may use use spi_device->controller_data and | |
42 | * controller registers as appropriate. | |
43 | * | |
44 | * | |
45 | * NOTE: SPI controller pins can often be used as GPIO pins instead, | |
46 | * which means you could use a bitbang driver either to get hardware | |
47 | * working quickly, or testing for differences that aren't speed related. | |
48 | */ | |
49 | ||
50 | struct spi_bitbang_cs { | |
51 | unsigned nsecs; /* (clock cycle time)/2 */ | |
52 | u32 (*txrx_word)(struct spi_device *spi, unsigned nsecs, | |
53 | u32 word, u8 bits); | |
54 | unsigned (*txrx_bufs)(struct spi_device *, | |
55 | u32 (*txrx_word)( | |
56 | struct spi_device *spi, | |
57 | unsigned nsecs, | |
58 | u32 word, u8 bits), | |
59 | unsigned, struct spi_transfer *); | |
60 | }; | |
61 | ||
62 | static unsigned bitbang_txrx_8( | |
63 | struct spi_device *spi, | |
64 | u32 (*txrx_word)(struct spi_device *spi, | |
65 | unsigned nsecs, | |
66 | u32 word, u8 bits), | |
67 | unsigned ns, | |
68 | struct spi_transfer *t | |
69 | ) { | |
70 | unsigned bits = spi->bits_per_word; | |
71 | unsigned count = t->len; | |
72 | const u8 *tx = t->tx_buf; | |
73 | u8 *rx = t->rx_buf; | |
74 | ||
75 | while (likely(count > 0)) { | |
76 | u8 word = 0; | |
77 | ||
78 | if (tx) | |
79 | word = *tx++; | |
80 | word = txrx_word(spi, ns, word, bits); | |
81 | if (rx) | |
82 | *rx++ = word; | |
83 | count -= 1; | |
84 | } | |
85 | return t->len - count; | |
86 | } | |
87 | ||
88 | static unsigned bitbang_txrx_16( | |
89 | struct spi_device *spi, | |
90 | u32 (*txrx_word)(struct spi_device *spi, | |
91 | unsigned nsecs, | |
92 | u32 word, u8 bits), | |
93 | unsigned ns, | |
94 | struct spi_transfer *t | |
95 | ) { | |
96 | unsigned bits = spi->bits_per_word; | |
97 | unsigned count = t->len; | |
98 | const u16 *tx = t->tx_buf; | |
99 | u16 *rx = t->rx_buf; | |
100 | ||
101 | while (likely(count > 1)) { | |
102 | u16 word = 0; | |
103 | ||
104 | if (tx) | |
105 | word = *tx++; | |
106 | word = txrx_word(spi, ns, word, bits); | |
107 | if (rx) | |
108 | *rx++ = word; | |
109 | count -= 2; | |
110 | } | |
111 | return t->len - count; | |
112 | } | |
113 | ||
114 | static unsigned bitbang_txrx_32( | |
115 | struct spi_device *spi, | |
116 | u32 (*txrx_word)(struct spi_device *spi, | |
117 | unsigned nsecs, | |
118 | u32 word, u8 bits), | |
119 | unsigned ns, | |
120 | struct spi_transfer *t | |
121 | ) { | |
122 | unsigned bits = spi->bits_per_word; | |
123 | unsigned count = t->len; | |
124 | const u32 *tx = t->tx_buf; | |
125 | u32 *rx = t->rx_buf; | |
126 | ||
127 | while (likely(count > 3)) { | |
128 | u32 word = 0; | |
129 | ||
130 | if (tx) | |
131 | word = *tx++; | |
132 | word = txrx_word(spi, ns, word, bits); | |
133 | if (rx) | |
134 | *rx++ = word; | |
135 | count -= 4; | |
136 | } | |
137 | return t->len - count; | |
138 | } | |
139 | ||
ff9f4771 | 140 | int spi_bitbang_setup_transfer(struct spi_device *spi, struct spi_transfer *t) |
4cff33f9 ID |
141 | { |
142 | struct spi_bitbang_cs *cs = spi->controller_state; | |
143 | u8 bits_per_word; | |
144 | u32 hz; | |
145 | ||
146 | if (t) { | |
147 | bits_per_word = t->bits_per_word; | |
148 | hz = t->speed_hz; | |
149 | } else { | |
150 | bits_per_word = 0; | |
151 | hz = 0; | |
152 | } | |
153 | ||
154 | /* spi_transfer level calls that work per-word */ | |
155 | if (!bits_per_word) | |
156 | bits_per_word = spi->bits_per_word; | |
157 | if (bits_per_word <= 8) | |
158 | cs->txrx_bufs = bitbang_txrx_8; | |
159 | else if (bits_per_word <= 16) | |
160 | cs->txrx_bufs = bitbang_txrx_16; | |
161 | else if (bits_per_word <= 32) | |
162 | cs->txrx_bufs = bitbang_txrx_32; | |
163 | else | |
164 | return -EINVAL; | |
165 | ||
166 | /* nsecs = (clock period)/2 */ | |
167 | if (!hz) | |
168 | hz = spi->max_speed_hz; | |
1e316d75 DB |
169 | if (hz) { |
170 | cs->nsecs = (1000000000/2) / hz; | |
171 | if (cs->nsecs > (MAX_UDELAY_MS * 1000 * 1000)) | |
172 | return -EINVAL; | |
173 | } | |
4cff33f9 ID |
174 | |
175 | return 0; | |
176 | } | |
ff9f4771 | 177 | EXPORT_SYMBOL_GPL(spi_bitbang_setup_transfer); |
4cff33f9 | 178 | |
9904f22a DB |
179 | /** |
180 | * spi_bitbang_setup - default setup for per-word I/O loops | |
181 | */ | |
182 | int spi_bitbang_setup(struct spi_device *spi) | |
183 | { | |
184 | struct spi_bitbang_cs *cs = spi->controller_state; | |
185 | struct spi_bitbang *bitbang; | |
4cff33f9 | 186 | int retval; |
d52df2e2 | 187 | unsigned long flags; |
9904f22a | 188 | |
ccf77cc4 DB |
189 | bitbang = spi_master_get_devdata(spi->master); |
190 | ||
9904f22a | 191 | if (!cs) { |
e94b1766 | 192 | cs = kzalloc(sizeof *cs, GFP_KERNEL); |
9904f22a DB |
193 | if (!cs) |
194 | return -ENOMEM; | |
195 | spi->controller_state = cs; | |
196 | } | |
9904f22a | 197 | |
9904f22a DB |
198 | /* per-word shift register access, in hardware or bitbanging */ |
199 | cs->txrx_word = bitbang->txrx_word[spi->mode & (SPI_CPOL|SPI_CPHA)]; | |
200 | if (!cs->txrx_word) | |
201 | return -EINVAL; | |
202 | ||
7f8c7619 | 203 | retval = bitbang->setup_transfer(spi, NULL); |
4cff33f9 ID |
204 | if (retval < 0) |
205 | return retval; | |
9904f22a | 206 | |
7d077197 | 207 | dev_dbg(&spi->dev, "%s, %u nsec/bit\n", __func__, 2 * cs->nsecs); |
9904f22a DB |
208 | |
209 | /* NOTE we _need_ to call chipselect() early, ideally with adapter | |
210 | * setup, unless the hardware defaults cooperate to avoid confusion | |
211 | * between normal (active low) and inverted chipselects. | |
212 | */ | |
213 | ||
214 | /* deselect chip (low or high) */ | |
d52df2e2 | 215 | spin_lock_irqsave(&bitbang->lock, flags); |
9904f22a | 216 | if (!bitbang->busy) { |
8275c642 | 217 | bitbang->chipselect(spi, BITBANG_CS_INACTIVE); |
9904f22a DB |
218 | ndelay(cs->nsecs); |
219 | } | |
d52df2e2 | 220 | spin_unlock_irqrestore(&bitbang->lock, flags); |
9904f22a DB |
221 | |
222 | return 0; | |
223 | } | |
224 | EXPORT_SYMBOL_GPL(spi_bitbang_setup); | |
225 | ||
226 | /** | |
227 | * spi_bitbang_cleanup - default cleanup for per-word I/O loops | |
228 | */ | |
0ffa0285 | 229 | void spi_bitbang_cleanup(struct spi_device *spi) |
9904f22a DB |
230 | { |
231 | kfree(spi->controller_state); | |
232 | } | |
233 | EXPORT_SYMBOL_GPL(spi_bitbang_cleanup); | |
234 | ||
235 | static int spi_bitbang_bufs(struct spi_device *spi, struct spi_transfer *t) | |
236 | { | |
237 | struct spi_bitbang_cs *cs = spi->controller_state; | |
238 | unsigned nsecs = cs->nsecs; | |
239 | ||
240 | return cs->txrx_bufs(spi, cs->txrx_word, nsecs, t); | |
241 | } | |
242 | ||
243 | /*----------------------------------------------------------------------*/ | |
244 | ||
245 | /* | |
246 | * SECOND PART ... simple transfer queue runner. | |
247 | * | |
248 | * This costs a task context per controller, running the queue by | |
249 | * performing each transfer in sequence. Smarter hardware can queue | |
250 | * several DMA transfers at once, and process several controller queues | |
251 | * in parallel; this driver doesn't match such hardware very well. | |
252 | * | |
253 | * Drivers can provide word-at-a-time i/o primitives, or provide | |
254 | * transfer-at-a-time ones to leverage dma or fifo hardware. | |
255 | */ | |
c4028958 | 256 | static void bitbang_work(struct work_struct *work) |
9904f22a | 257 | { |
c4028958 DH |
258 | struct spi_bitbang *bitbang = |
259 | container_of(work, struct spi_bitbang, work); | |
9904f22a | 260 | unsigned long flags; |
529ba0d9 DB |
261 | int do_setup = -1; |
262 | int (*setup_transfer)(struct spi_device *, | |
263 | struct spi_transfer *); | |
264 | ||
265 | setup_transfer = bitbang->setup_transfer; | |
9904f22a DB |
266 | |
267 | spin_lock_irqsave(&bitbang->lock, flags); | |
268 | bitbang->busy = 1; | |
269 | while (!list_empty(&bitbang->queue)) { | |
270 | struct spi_message *m; | |
271 | struct spi_device *spi; | |
272 | unsigned nsecs; | |
8275c642 | 273 | struct spi_transfer *t = NULL; |
9904f22a | 274 | unsigned tmp; |
8275c642 | 275 | unsigned cs_change; |
9904f22a DB |
276 | int status; |
277 | ||
278 | m = container_of(bitbang->queue.next, struct spi_message, | |
279 | queue); | |
280 | list_del_init(&m->queue); | |
281 | spin_unlock_irqrestore(&bitbang->lock, flags); | |
282 | ||
8275c642 VW |
283 | /* FIXME this is made-up ... the correct value is known to |
284 | * word-at-a-time bitbang code, and presumably chipselect() | |
285 | * should enforce these requirements too? | |
286 | */ | |
287 | nsecs = 100; | |
9904f22a DB |
288 | |
289 | spi = m->spi; | |
9904f22a | 290 | tmp = 0; |
8275c642 | 291 | cs_change = 1; |
9904f22a DB |
292 | status = 0; |
293 | ||
8275c642 | 294 | list_for_each_entry (t, &m->transfers, transfer_list) { |
9904f22a | 295 | |
529ba0d9 DB |
296 | /* override speed or wordsize? */ |
297 | if (t->speed_hz || t->bits_per_word) | |
298 | do_setup = 1; | |
299 | ||
300 | /* init (-1) or override (1) transfer params */ | |
301 | if (do_setup != 0) { | |
4cff33f9 ID |
302 | if (!setup_transfer) { |
303 | status = -ENOPROTOOPT; | |
304 | break; | |
305 | } | |
4cff33f9 ID |
306 | status = setup_transfer(spi, t); |
307 | if (status < 0) | |
308 | break; | |
309 | } | |
310 | ||
8275c642 VW |
311 | /* set up default clock polarity, and activate chip; |
312 | * this implicitly updates clock and spi modes as | |
313 | * previously recorded for this device via setup(). | |
314 | * (and also deselects any other chip that might be | |
315 | * selected ...) | |
316 | */ | |
317 | if (cs_change) { | |
318 | bitbang->chipselect(spi, BITBANG_CS_ACTIVE); | |
9904f22a DB |
319 | ndelay(nsecs); |
320 | } | |
8275c642 | 321 | cs_change = t->cs_change; |
9904f22a DB |
322 | if (!t->tx_buf && !t->rx_buf && t->len) { |
323 | status = -EINVAL; | |
324 | break; | |
325 | } | |
326 | ||
8275c642 VW |
327 | /* transfer data. the lower level code handles any |
328 | * new dma mappings it needs. our caller always gave | |
329 | * us dma-safe buffers. | |
330 | */ | |
9904f22a | 331 | if (t->len) { |
8275c642 VW |
332 | /* REVISIT dma API still needs a designated |
333 | * DMA_ADDR_INVALID; ~0 might be better. | |
9904f22a | 334 | */ |
8275c642 VW |
335 | if (!m->is_dma_mapped) |
336 | t->rx_dma = t->tx_dma = 0; | |
9904f22a DB |
337 | status = bitbang->txrx_bufs(spi, t); |
338 | } | |
2cfb8ce8 JN |
339 | if (status > 0) |
340 | m->actual_length += status; | |
9904f22a | 341 | if (status != t->len) { |
2cfb8ce8 JN |
342 | /* always report some kind of error */ |
343 | if (status >= 0) | |
344 | status = -EREMOTEIO; | |
9904f22a DB |
345 | break; |
346 | } | |
9904f22a DB |
347 | status = 0; |
348 | ||
349 | /* protocol tweaks before next transfer */ | |
350 | if (t->delay_usecs) | |
351 | udelay(t->delay_usecs); | |
352 | ||
8275c642 | 353 | if (!cs_change) |
9904f22a | 354 | continue; |
8275c642 VW |
355 | if (t->transfer_list.next == &m->transfers) |
356 | break; | |
9904f22a | 357 | |
8275c642 VW |
358 | /* sometimes a short mid-message deselect of the chip |
359 | * may be needed to terminate a mode or command | |
360 | */ | |
361 | ndelay(nsecs); | |
362 | bitbang->chipselect(spi, BITBANG_CS_INACTIVE); | |
363 | ndelay(nsecs); | |
9904f22a DB |
364 | } |
365 | ||
9904f22a DB |
366 | m->status = status; |
367 | m->complete(m->context); | |
368 | ||
529ba0d9 DB |
369 | /* restore speed and wordsize if it was overridden */ |
370 | if (do_setup == 1) | |
4cff33f9 | 371 | setup_transfer(spi, NULL); |
529ba0d9 | 372 | do_setup = 0; |
4cff33f9 | 373 | |
8275c642 VW |
374 | /* normally deactivate chipselect ... unless no error and |
375 | * cs_change has hinted that the next message will probably | |
376 | * be for this chip too. | |
377 | */ | |
378 | if (!(status == 0 && cs_change)) { | |
379 | ndelay(nsecs); | |
380 | bitbang->chipselect(spi, BITBANG_CS_INACTIVE); | |
381 | ndelay(nsecs); | |
382 | } | |
9904f22a DB |
383 | |
384 | spin_lock_irqsave(&bitbang->lock, flags); | |
385 | } | |
386 | bitbang->busy = 0; | |
387 | spin_unlock_irqrestore(&bitbang->lock, flags); | |
388 | } | |
389 | ||
390 | /** | |
391 | * spi_bitbang_transfer - default submit to transfer queue | |
392 | */ | |
393 | int spi_bitbang_transfer(struct spi_device *spi, struct spi_message *m) | |
394 | { | |
395 | struct spi_bitbang *bitbang; | |
396 | unsigned long flags; | |
1e316d75 | 397 | int status = 0; |
9904f22a DB |
398 | |
399 | m->actual_length = 0; | |
400 | m->status = -EINPROGRESS; | |
401 | ||
402 | bitbang = spi_master_get_devdata(spi->master); | |
9904f22a DB |
403 | |
404 | spin_lock_irqsave(&bitbang->lock, flags); | |
1e316d75 DB |
405 | if (!spi->max_speed_hz) |
406 | status = -ENETDOWN; | |
407 | else { | |
408 | list_add_tail(&m->queue, &bitbang->queue); | |
409 | queue_work(bitbang->workqueue, &bitbang->work); | |
410 | } | |
9904f22a DB |
411 | spin_unlock_irqrestore(&bitbang->lock, flags); |
412 | ||
1e316d75 | 413 | return status; |
9904f22a DB |
414 | } |
415 | EXPORT_SYMBOL_GPL(spi_bitbang_transfer); | |
416 | ||
417 | /*----------------------------------------------------------------------*/ | |
418 | ||
419 | /** | |
420 | * spi_bitbang_start - start up a polled/bitbanging SPI master driver | |
421 | * @bitbang: driver handle | |
422 | * | |
423 | * Caller should have zero-initialized all parts of the structure, and then | |
424 | * provided callbacks for chip selection and I/O loops. If the master has | |
425 | * a transfer method, its final step should call spi_bitbang_transfer; or, | |
426 | * that's the default if the transfer routine is not initialized. It should | |
427 | * also set up the bus number and number of chipselects. | |
428 | * | |
429 | * For i/o loops, provide callbacks either per-word (for bitbanging, or for | |
430 | * hardware that basically exposes a shift register) or per-spi_transfer | |
431 | * (which takes better advantage of hardware like fifos or DMA engines). | |
432 | * | |
7f8c7619 HPN |
433 | * Drivers using per-word I/O loops should use (or call) spi_bitbang_setup, |
434 | * spi_bitbang_cleanup and spi_bitbang_setup_transfer to handle those spi | |
435 | * master methods. Those methods are the defaults if the bitbang->txrx_bufs | |
436 | * routine isn't initialized. | |
9904f22a DB |
437 | * |
438 | * This routine registers the spi_master, which will process requests in a | |
439 | * dedicated task, keeping IRQs unblocked most of the time. To stop | |
440 | * processing those requests, call spi_bitbang_stop(). | |
441 | */ | |
442 | int spi_bitbang_start(struct spi_bitbang *bitbang) | |
443 | { | |
444 | int status; | |
445 | ||
446 | if (!bitbang->master || !bitbang->chipselect) | |
447 | return -EINVAL; | |
448 | ||
c4028958 | 449 | INIT_WORK(&bitbang->work, bitbang_work); |
9904f22a DB |
450 | spin_lock_init(&bitbang->lock); |
451 | INIT_LIST_HEAD(&bitbang->queue); | |
452 | ||
e7db06b5 DB |
453 | if (!bitbang->master->mode_bits) |
454 | bitbang->master->mode_bits = SPI_CPOL | SPI_CPHA | bitbang->flags; | |
455 | ||
9904f22a DB |
456 | if (!bitbang->master->transfer) |
457 | bitbang->master->transfer = spi_bitbang_transfer; | |
458 | if (!bitbang->txrx_bufs) { | |
459 | bitbang->use_dma = 0; | |
460 | bitbang->txrx_bufs = spi_bitbang_bufs; | |
461 | if (!bitbang->master->setup) { | |
ff9f4771 KG |
462 | if (!bitbang->setup_transfer) |
463 | bitbang->setup_transfer = | |
464 | spi_bitbang_setup_transfer; | |
9904f22a DB |
465 | bitbang->master->setup = spi_bitbang_setup; |
466 | bitbang->master->cleanup = spi_bitbang_cleanup; | |
467 | } | |
468 | } else if (!bitbang->master->setup) | |
469 | return -EINVAL; | |
470 | ||
471 | /* this task is the only thing to touch the SPI bits */ | |
472 | bitbang->busy = 0; | |
473 | bitbang->workqueue = create_singlethread_workqueue( | |
35f74fca | 474 | dev_name(bitbang->master->dev.parent)); |
9904f22a DB |
475 | if (bitbang->workqueue == NULL) { |
476 | status = -EBUSY; | |
477 | goto err1; | |
478 | } | |
479 | ||
480 | /* driver may get busy before register() returns, especially | |
481 | * if someone registered boardinfo for devices | |
482 | */ | |
483 | status = spi_register_master(bitbang->master); | |
484 | if (status < 0) | |
485 | goto err2; | |
486 | ||
487 | return status; | |
488 | ||
489 | err2: | |
490 | destroy_workqueue(bitbang->workqueue); | |
491 | err1: | |
492 | return status; | |
493 | } | |
494 | EXPORT_SYMBOL_GPL(spi_bitbang_start); | |
495 | ||
496 | /** | |
497 | * spi_bitbang_stop - stops the task providing spi communication | |
498 | */ | |
499 | int spi_bitbang_stop(struct spi_bitbang *bitbang) | |
500 | { | |
a836f585 | 501 | spi_unregister_master(bitbang->master); |
9904f22a | 502 | |
a836f585 | 503 | WARN_ON(!list_empty(&bitbang->queue)); |
9904f22a DB |
504 | |
505 | destroy_workqueue(bitbang->workqueue); | |
506 | ||
9904f22a DB |
507 | return 0; |
508 | } | |
509 | EXPORT_SYMBOL_GPL(spi_bitbang_stop); | |
510 | ||
511 | MODULE_LICENSE("GPL"); | |
512 |