1 #ifndef __SPI_BITBANG_H
2 #define __SPI_BITBANG_H
5 * Mix this utility code with some glue code to get one of several types of
6 * simple SPI master driver. Two do polled word-at-a-time I/O:
8 * - GPIO/parport bitbangers. Provide chipselect() and txrx_word[](),
9 * expanding the per-word routines from the inline templates below.
11 * - Drivers for controllers resembling bare shift registers. Provide
12 * chipselect() and txrx_word[](), with custom setup()/cleanup() methods
13 * that use your controller's clock and chipselect registers.
15 * Some hardware works well with requests at spi_transfer scope:
17 * - Drivers leveraging smarter hardware, with fifos or DMA; or for half
18 * duplex (MicroWire) controllers. Provide chipslect() and txrx_bufs(),
19 * and custom setup()/cleanup() methods.
22 struct workqueue_struct *workqueue;
23 struct work_struct work;
26 struct list_head queue;
31 struct spi_master *master;
33 void (*chipselect)(struct spi_device *spi, int is_on);
35 int (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);
36 u32 (*txrx_word[4])(struct spi_device *spi,
41 /* you can call these default bitbang->master methods from your custom
42 * methods, if you like.
44 extern int spi_bitbang_setup(struct spi_device *spi);
45 extern void spi_bitbang_cleanup(const struct spi_device *spi);
46 extern int spi_bitbang_transfer(struct spi_device *spi, struct spi_message *m);
48 /* start or stop queue processing */
49 extern int spi_bitbang_start(struct spi_bitbang *spi);
50 extern int spi_bitbang_stop(struct spi_bitbang *spi);
52 #endif /* __SPI_BITBANG_H */
54 /*-------------------------------------------------------------------------*/
56 #ifdef EXPAND_BITBANG_TXRX
59 * The code that knows what GPIO pins do what should have declared four
60 * functions, ideally as inlines, before #defining EXPAND_BITBANG_TXRX
61 * and including this header:
63 * void setsck(struct spi_device *, int is_on);
64 * void setmosi(struct spi_device *, int is_on);
65 * int getmiso(struct spi_device *);
66 * void spidelay(unsigned);
68 * A non-inlined routine would call bitbang_txrx_*() routines. The
69 * main loop could easily compile down to a handful of instructions,
70 * especially if the delay is a NOP (to run at peak speed).
72 * Since this is software, the timings may not be exactly what your board's
73 * chips need ... there may be several reasons you'd need to tweak timings
74 * in these routines, not just make to make it faster or slower to match a
75 * particular CPU clock rate.
79 bitbang_txrx_be_cpha0(struct spi_device *spi,
80 unsigned nsecs, unsigned cpol,
83 /* if (cpol == 0) this is SPI_MODE_0; else this is SPI_MODE_2 */
85 /* clock starts at inactive polarity */
86 for (word <<= (32 - bits); likely(bits); bits--) {
88 /* setup MSB (to slave) on trailing edge */
89 setmosi(spi, word & (1 << 31));
90 spidelay(nsecs); /* T(setup) */
95 /* sample MSB (from slave) on leading edge */
104 bitbang_txrx_be_cpha1(struct spi_device *spi,
105 unsigned nsecs, unsigned cpol,
108 /* if (cpol == 0) this is SPI_MODE_1; else this is SPI_MODE_3 */
110 /* clock starts at inactive polarity */
111 for (word <<= (32 - bits); likely(bits); bits--) {
113 /* setup MSB (to slave) on leading edge */
115 setmosi(spi, word & (1 << 31));
116 spidelay(nsecs); /* T(setup) */
121 /* sample MSB (from slave) on trailing edge */
123 word |= getmiso(spi);
128 #endif /* EXPAND_BITBANG_TXRX */