]> err.no Git - linux-2.6/blob - include/linux/spi/spi.h
e180615ed25a013e32e7ec65a050bc59c1e07925
[linux-2.6] / include / linux / spi / spi.h
1 /*
2  * Copyright (C) 2005 David Brownell
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., 675 Mass Ave, Cambridge, MA 02139, USA.
17  */
18
19 #ifndef __LINUX_SPI_H
20 #define __LINUX_SPI_H
21
22 /*
23  * INTERFACES between SPI master-side drivers and SPI infrastructure.
24  * (There's no SPI slave support for Linux yet...)
25  */
26 extern struct bus_type spi_bus_type;
27
28 /**
29  * struct spi_device - Master side proxy for an SPI slave device
30  * @dev: Driver model representation of the device.
31  * @master: SPI controller used with the device.
32  * @max_speed_hz: Maximum clock rate to be used with this chip
33  *      (on this board); may be changed by the device's driver.
34  *      The spi_transfer.speed_hz can override this for each transfer.
35  * @chip_select: Chipselect, distinguishing chips handled by @master.
36  * @mode: The spi mode defines how data is clocked out and in.
37  *      This may be changed by the device's driver.
38  *      The "active low" default for chipselect mode can be overridden
39  *      (by specifying SPI_CS_HIGH) as can the "MSB first" default for
40  *      each word in a transfer (by specifying SPI_LSB_FIRST).
41  * @bits_per_word: Data transfers involve one or more words; word sizes
42  *      like eight or 12 bits are common.  In-memory wordsizes are
43  *      powers of two bytes (e.g. 20 bit samples use 32 bits).
44  *      This may be changed by the device's driver, or left at the
45  *      default (0) indicating protocol words are eight bit bytes.
46  *      The spi_transfer.bits_per_word can override this for each transfer.
47  * @irq: Negative, or the number passed to request_irq() to receive
48  *      interrupts from this device.
49  * @controller_state: Controller's runtime state
50  * @controller_data: Board-specific definitions for controller, such as
51  *      FIFO initialization parameters; from board_info.controller_data
52  * @modalias: Name of the driver to use with this device, or an alias
53  *      for that name.  This appears in the sysfs "modalias" attribute
54  *      for driver coldplugging, and in uevents used for hotplugging
55  *
56  * A @spi_device is used to interchange data between an SPI slave
57  * (usually a discrete chip) and CPU memory.
58  *
59  * In @dev, the platform_data is used to hold information about this
60  * device that's meaningful to the device's protocol driver, but not
61  * to its controller.  One example might be an identifier for a chip
62  * variant with slightly different functionality; another might be
63  * information about how this particular board wires the chip's pins.
64  */
65 struct spi_device {
66         struct device           dev;
67         struct spi_master       *master;
68         u32                     max_speed_hz;
69         u8                      chip_select;
70         u8                      mode;
71 #define SPI_CPHA        0x01                    /* clock phase */
72 #define SPI_CPOL        0x02                    /* clock polarity */
73 #define SPI_MODE_0      (0|0)                   /* (original MicroWire) */
74 #define SPI_MODE_1      (0|SPI_CPHA)
75 #define SPI_MODE_2      (SPI_CPOL|0)
76 #define SPI_MODE_3      (SPI_CPOL|SPI_CPHA)
77 #define SPI_CS_HIGH     0x04                    /* chipselect active high? */
78 #define SPI_LSB_FIRST   0x08                    /* per-word bits-on-wire */
79 #define SPI_3WIRE       0x10                    /* SI/SO signals shared */
80 #define SPI_LOOP        0x20                    /* loopback mode */
81         u8                      bits_per_word;
82         int                     irq;
83         void                    *controller_state;
84         void                    *controller_data;
85         const char              *modalias;
86
87         /*
88          * likely need more hooks for more protocol options affecting how
89          * the controller talks to each chip, like:
90          *  - memory packing (12 bit samples into low bits, others zeroed)
91          *  - priority
92          *  - drop chipselect after each word
93          *  - chipselect delays
94          *  - ...
95          */
96 };
97
98 static inline struct spi_device *to_spi_device(struct device *dev)
99 {
100         return dev ? container_of(dev, struct spi_device, dev) : NULL;
101 }
102
103 /* most drivers won't need to care about device refcounting */
104 static inline struct spi_device *spi_dev_get(struct spi_device *spi)
105 {
106         return (spi && get_device(&spi->dev)) ? spi : NULL;
107 }
108
109 static inline void spi_dev_put(struct spi_device *spi)
110 {
111         if (spi)
112                 put_device(&spi->dev);
113 }
114
115 /* ctldata is for the bus_master driver's runtime state */
116 static inline void *spi_get_ctldata(struct spi_device *spi)
117 {
118         return spi->controller_state;
119 }
120
121 static inline void spi_set_ctldata(struct spi_device *spi, void *state)
122 {
123         spi->controller_state = state;
124 }
125
126 /* device driver data */
127
128 static inline void spi_set_drvdata(struct spi_device *spi, void *data)
129 {
130         dev_set_drvdata(&spi->dev, data);
131 }
132
133 static inline void *spi_get_drvdata(struct spi_device *spi)
134 {
135         return dev_get_drvdata(&spi->dev);
136 }
137
138 struct spi_message;
139
140
141
142 struct spi_driver {
143         int                     (*probe)(struct spi_device *spi);
144         int                     (*remove)(struct spi_device *spi);
145         void                    (*shutdown)(struct spi_device *spi);
146         int                     (*suspend)(struct spi_device *spi, pm_message_t mesg);
147         int                     (*resume)(struct spi_device *spi);
148         struct device_driver    driver;
149 };
150
151 static inline struct spi_driver *to_spi_driver(struct device_driver *drv)
152 {
153         return drv ? container_of(drv, struct spi_driver, driver) : NULL;
154 }
155
156 extern int spi_register_driver(struct spi_driver *sdrv);
157
158 /**
159  * spi_unregister_driver - reverse effect of spi_register_driver
160  * @sdrv: the driver to unregister
161  * Context: can sleep
162  */
163 static inline void spi_unregister_driver(struct spi_driver *sdrv)
164 {
165         if (sdrv)
166                 driver_unregister(&sdrv->driver);
167 }
168
169
170 /**
171  * struct spi_master - interface to SPI master controller
172  * @cdev: class interface to this driver
173  * @bus_num: board-specific (and often SOC-specific) identifier for a
174  *      given SPI controller.
175  * @num_chipselect: chipselects are used to distinguish individual
176  *      SPI slaves, and are numbered from zero to num_chipselects.
177  *      each slave has a chipselect signal, but it's common that not
178  *      every chipselect is connected to a slave.
179  * @setup: updates the device mode and clocking records used by a
180  *      device's SPI controller; protocol code may call this.  This
181  *      must fail if an unrecognized or unsupported mode is requested.
182  *      It's always safe to call this unless transfers are pending on
183  *      the device whose settings are being modified.
184  * @transfer: adds a message to the controller's transfer queue.
185  * @cleanup: frees controller-specific state
186  *
187  * Each SPI master controller can communicate with one or more @spi_device
188  * children.  These make a small bus, sharing MOSI, MISO and SCK signals
189  * but not chip select signals.  Each device may be configured to use a
190  * different clock rate, since those shared signals are ignored unless
191  * the chip is selected.
192  *
193  * The driver for an SPI controller manages access to those devices through
194  * a queue of spi_message transactions, copying data between CPU memory and
195  * an SPI slave device.  For each such message it queues, it calls the
196  * message's completion function when the transaction completes.
197  */
198 struct spi_master {
199         struct class_device     cdev;
200
201         /* other than negative (== assign one dynamically), bus_num is fully
202          * board-specific.  usually that simplifies to being SOC-specific.
203          * example:  one SOC has three SPI controllers, numbered 0..2,
204          * and one board's schematics might show it using SPI-2.  software
205          * would normally use bus_num=2 for that controller.
206          */
207         s16                     bus_num;
208
209         /* chipselects will be integral to many controllers; some others
210          * might use board-specific GPIOs.
211          */
212         u16                     num_chipselect;
213
214         /* setup mode and clock, etc (spi driver may call many times) */
215         int                     (*setup)(struct spi_device *spi);
216
217         /* bidirectional bulk transfers
218          *
219          * + The transfer() method may not sleep; its main role is
220          *   just to add the message to the queue.
221          * + For now there's no remove-from-queue operation, or
222          *   any other request management
223          * + To a given spi_device, message queueing is pure fifo
224          *
225          * + The master's main job is to process its message queue,
226          *   selecting a chip then transferring data
227          * + If there are multiple spi_device children, the i/o queue
228          *   arbitration algorithm is unspecified (round robin, fifo,
229          *   priority, reservations, preemption, etc)
230          *
231          * + Chipselect stays active during the entire message
232          *   (unless modified by spi_transfer.cs_change != 0).
233          * + The message transfers use clock and SPI mode parameters
234          *   previously established by setup() for this device
235          */
236         int                     (*transfer)(struct spi_device *spi,
237                                                 struct spi_message *mesg);
238
239         /* called on release() to free memory provided by spi_master */
240         void                    (*cleanup)(struct spi_device *spi);
241 };
242
243 static inline void *spi_master_get_devdata(struct spi_master *master)
244 {
245         return class_get_devdata(&master->cdev);
246 }
247
248 static inline void spi_master_set_devdata(struct spi_master *master, void *data)
249 {
250         class_set_devdata(&master->cdev, data);
251 }
252
253 static inline struct spi_master *spi_master_get(struct spi_master *master)
254 {
255         if (!master || !class_device_get(&master->cdev))
256                 return NULL;
257         return master;
258 }
259
260 static inline void spi_master_put(struct spi_master *master)
261 {
262         if (master)
263                 class_device_put(&master->cdev);
264 }
265
266
267 /* the spi driver core manages memory for the spi_master classdev */
268 extern struct spi_master *
269 spi_alloc_master(struct device *host, unsigned size);
270
271 extern int spi_register_master(struct spi_master *master);
272 extern void spi_unregister_master(struct spi_master *master);
273
274 extern struct spi_master *spi_busnum_to_master(u16 busnum);
275
276 /*---------------------------------------------------------------------------*/
277
278 /*
279  * I/O INTERFACE between SPI controller and protocol drivers
280  *
281  * Protocol drivers use a queue of spi_messages, each transferring data
282  * between the controller and memory buffers.
283  *
284  * The spi_messages themselves consist of a series of read+write transfer
285  * segments.  Those segments always read the same number of bits as they
286  * write; but one or the other is easily ignored by passing a null buffer
287  * pointer.  (This is unlike most types of I/O API, because SPI hardware
288  * is full duplex.)
289  *
290  * NOTE:  Allocation of spi_transfer and spi_message memory is entirely
291  * up to the protocol driver, which guarantees the integrity of both (as
292  * well as the data buffers) for as long as the message is queued.
293  */
294
295 /**
296  * struct spi_transfer - a read/write buffer pair
297  * @tx_buf: data to be written (dma-safe memory), or NULL
298  * @rx_buf: data to be read (dma-safe memory), or NULL
299  * @tx_dma: DMA address of tx_buf, if @spi_message.is_dma_mapped
300  * @rx_dma: DMA address of rx_buf, if @spi_message.is_dma_mapped
301  * @len: size of rx and tx buffers (in bytes)
302  * @speed_hz: Select a speed other then the device default for this
303  *      transfer. If 0 the default (from @spi_device) is used.
304  * @bits_per_word: select a bits_per_word other then the device default
305  *      for this transfer. If 0 the default (from @spi_device) is used.
306  * @cs_change: affects chipselect after this transfer completes
307  * @delay_usecs: microseconds to delay after this transfer before
308  *      (optionally) changing the chipselect status, then starting
309  *      the next transfer or completing this @spi_message.
310  * @transfer_list: transfers are sequenced through @spi_message.transfers
311  *
312  * SPI transfers always write the same number of bytes as they read.
313  * Protocol drivers should always provide @rx_buf and/or @tx_buf.
314  * In some cases, they may also want to provide DMA addresses for
315  * the data being transferred; that may reduce overhead, when the
316  * underlying driver uses dma.
317  *
318  * If the transmit buffer is null, zeroes will be shifted out
319  * while filling @rx_buf.  If the receive buffer is null, the data
320  * shifted in will be discarded.  Only "len" bytes shift out (or in).
321  * It's an error to try to shift out a partial word.  (For example, by
322  * shifting out three bytes with word size of sixteen or twenty bits;
323  * the former uses two bytes per word, the latter uses four bytes.)
324  *
325  * In-memory data values are always in native CPU byte order, translated
326  * from the wire byte order (big-endian except with SPI_LSB_FIRST).  So
327  * for example when bits_per_word is sixteen, buffers are 2N bytes long
328  * (@len = 2N) and hold N sixteen bit words in CPU byte order.
329  *
330  * When the word size of the SPI transfer is not a power-of-two multiple
331  * of eight bits, those in-memory words include extra bits.  In-memory
332  * words are always seen by protocol drivers as right-justified, so the
333  * undefined (rx) or unused (tx) bits are always the most significant bits.
334  *
335  * All SPI transfers start with the relevant chipselect active.  Normally
336  * it stays selected until after the last transfer in a message.  Drivers
337  * can affect the chipselect signal using cs_change.
338  *
339  * (i) If the transfer isn't the last one in the message, this flag is
340  * used to make the chipselect briefly go inactive in the middle of the
341  * message.  Toggling chipselect in this way may be needed to terminate
342  * a chip command, letting a single spi_message perform all of group of
343  * chip transactions together.
344  *
345  * (ii) When the transfer is the last one in the message, the chip may
346  * stay selected until the next transfer.  On multi-device SPI busses
347  * with nothing blocking messages going to other devices, this is just
348  * a performance hint; starting a message to another device deselects
349  * this one.  But in other cases, this can be used to ensure correctness.
350  * Some devices need protocol transactions to be built from a series of
351  * spi_message submissions, where the content of one message is determined
352  * by the results of previous messages and where the whole transaction
353  * ends when the chipselect goes intactive.
354  *
355  * The code that submits an spi_message (and its spi_transfers)
356  * to the lower layers is responsible for managing its memory.
357  * Zero-initialize every field you don't set up explicitly, to
358  * insulate against future API updates.  After you submit a message
359  * and its transfers, ignore them until its completion callback.
360  */
361 struct spi_transfer {
362         /* it's ok if tx_buf == rx_buf (right?)
363          * for MicroWire, one buffer must be null
364          * buffers must work with dma_*map_single() calls, unless
365          *   spi_message.is_dma_mapped reports a pre-existing mapping
366          */
367         const void      *tx_buf;
368         void            *rx_buf;
369         unsigned        len;
370
371         dma_addr_t      tx_dma;
372         dma_addr_t      rx_dma;
373
374         unsigned        cs_change:1;
375         u8              bits_per_word;
376         u16             delay_usecs;
377         u32             speed_hz;
378
379         struct list_head transfer_list;
380 };
381
382 /**
383  * struct spi_message - one multi-segment SPI transaction
384  * @transfers: list of transfer segments in this transaction
385  * @spi: SPI device to which the transaction is queued
386  * @is_dma_mapped: if true, the caller provided both dma and cpu virtual
387  *      addresses for each transfer buffer
388  * @complete: called to report transaction completions
389  * @context: the argument to complete() when it's called
390  * @actual_length: the total number of bytes that were transferred in all
391  *      successful segments
392  * @status: zero for success, else negative errno
393  * @queue: for use by whichever driver currently owns the message
394  * @state: for use by whichever driver currently owns the message
395  *
396  * A @spi_message is used to execute an atomic sequence of data transfers,
397  * each represented by a struct spi_transfer.  The sequence is "atomic"
398  * in the sense that no other spi_message may use that SPI bus until that
399  * sequence completes.  On some systems, many such sequences can execute as
400  * as single programmed DMA transfer.  On all systems, these messages are
401  * queued, and might complete after transactions to other devices.  Messages
402  * sent to a given spi_device are alway executed in FIFO order.
403  *
404  * The code that submits an spi_message (and its spi_transfers)
405  * to the lower layers is responsible for managing its memory.
406  * Zero-initialize every field you don't set up explicitly, to
407  * insulate against future API updates.  After you submit a message
408  * and its transfers, ignore them until its completion callback.
409  */
410 struct spi_message {
411         struct list_head        transfers;
412
413         struct spi_device       *spi;
414
415         unsigned                is_dma_mapped:1;
416
417         /* REVISIT:  we might want a flag affecting the behavior of the
418          * last transfer ... allowing things like "read 16 bit length L"
419          * immediately followed by "read L bytes".  Basically imposing
420          * a specific message scheduling algorithm.
421          *
422          * Some controller drivers (message-at-a-time queue processing)
423          * could provide that as their default scheduling algorithm.  But
424          * others (with multi-message pipelines) could need a flag to
425          * tell them about such special cases.
426          */
427
428         /* completion is reported through a callback */
429         void                    (*complete)(void *context);
430         void                    *context;
431         unsigned                actual_length;
432         int                     status;
433
434         /* for optional use by whatever driver currently owns the
435          * spi_message ...  between calls to spi_async and then later
436          * complete(), that's the spi_master controller driver.
437          */
438         struct list_head        queue;
439         void                    *state;
440 };
441
442 static inline void spi_message_init(struct spi_message *m)
443 {
444         memset(m, 0, sizeof *m);
445         INIT_LIST_HEAD(&m->transfers);
446 }
447
448 static inline void
449 spi_message_add_tail(struct spi_transfer *t, struct spi_message *m)
450 {
451         list_add_tail(&t->transfer_list, &m->transfers);
452 }
453
454 static inline void
455 spi_transfer_del(struct spi_transfer *t)
456 {
457         list_del(&t->transfer_list);
458 }
459
460 /* It's fine to embed message and transaction structures in other data
461  * structures so long as you don't free them while they're in use.
462  */
463
464 static inline struct spi_message *spi_message_alloc(unsigned ntrans, gfp_t flags)
465 {
466         struct spi_message *m;
467
468         m = kzalloc(sizeof(struct spi_message)
469                         + ntrans * sizeof(struct spi_transfer),
470                         flags);
471         if (m) {
472                 int i;
473                 struct spi_transfer *t = (struct spi_transfer *)(m + 1);
474
475                 INIT_LIST_HEAD(&m->transfers);
476                 for (i = 0; i < ntrans; i++, t++)
477                         spi_message_add_tail(t, m);
478         }
479         return m;
480 }
481
482 static inline void spi_message_free(struct spi_message *m)
483 {
484         kfree(m);
485 }
486
487 /**
488  * spi_setup - setup SPI mode and clock rate
489  * @spi: the device whose settings are being modified
490  * Context: can sleep, and no requests are queued to the device
491  *
492  * SPI protocol drivers may need to update the transfer mode if the
493  * device doesn't work with its default.  They may likewise need
494  * to update clock rates or word sizes from initial values.  This function
495  * changes those settings, and must be called from a context that can sleep.
496  * Except for SPI_CS_HIGH, which takes effect immediately, the changes take
497  * effect the next time the device is selected and data is transferred to
498  * or from it.  When this function returns, the spi device is deselected.
499  *
500  * Note that this call will fail if the protocol driver specifies an option
501  * that the underlying controller or its driver does not support.  For
502  * example, not all hardware supports wire transfers using nine bit words,
503  * LSB-first wire encoding, or active-high chipselects.
504  */
505 static inline int
506 spi_setup(struct spi_device *spi)
507 {
508         return spi->master->setup(spi);
509 }
510
511
512 /**
513  * spi_async - asynchronous SPI transfer
514  * @spi: device with which data will be exchanged
515  * @message: describes the data transfers, including completion callback
516  * Context: any (irqs may be blocked, etc)
517  *
518  * This call may be used in_irq and other contexts which can't sleep,
519  * as well as from task contexts which can sleep.
520  *
521  * The completion callback is invoked in a context which can't sleep.
522  * Before that invocation, the value of message->status is undefined.
523  * When the callback is issued, message->status holds either zero (to
524  * indicate complete success) or a negative error code.  After that
525  * callback returns, the driver which issued the transfer request may
526  * deallocate the associated memory; it's no longer in use by any SPI
527  * core or controller driver code.
528  *
529  * Note that although all messages to a spi_device are handled in
530  * FIFO order, messages may go to different devices in other orders.
531  * Some device might be higher priority, or have various "hard" access
532  * time requirements, for example.
533  *
534  * On detection of any fault during the transfer, processing of
535  * the entire message is aborted, and the device is deselected.
536  * Until returning from the associated message completion callback,
537  * no other spi_message queued to that device will be processed.
538  * (This rule applies equally to all the synchronous transfer calls,
539  * which are wrappers around this core asynchronous primitive.)
540  */
541 static inline int
542 spi_async(struct spi_device *spi, struct spi_message *message)
543 {
544         message->spi = spi;
545         return spi->master->transfer(spi, message);
546 }
547
548 /*---------------------------------------------------------------------------*/
549
550 /* All these synchronous SPI transfer routines are utilities layered
551  * over the core async transfer primitive.  Here, "synchronous" means
552  * they will sleep uninterruptibly until the async transfer completes.
553  */
554
555 extern int spi_sync(struct spi_device *spi, struct spi_message *message);
556
557 /**
558  * spi_write - SPI synchronous write
559  * @spi: device to which data will be written
560  * @buf: data buffer
561  * @len: data buffer size
562  * Context: can sleep
563  *
564  * This writes the buffer and returns zero or a negative error code.
565  * Callable only from contexts that can sleep.
566  */
567 static inline int
568 spi_write(struct spi_device *spi, const u8 *buf, size_t len)
569 {
570         struct spi_transfer     t = {
571                         .tx_buf         = buf,
572                         .len            = len,
573                 };
574         struct spi_message      m;
575
576         spi_message_init(&m);
577         spi_message_add_tail(&t, &m);
578         return spi_sync(spi, &m);
579 }
580
581 /**
582  * spi_read - SPI synchronous read
583  * @spi: device from which data will be read
584  * @buf: data buffer
585  * @len: data buffer size
586  * Context: can sleep
587  *
588  * This reads the buffer and returns zero or a negative error code.
589  * Callable only from contexts that can sleep.
590  */
591 static inline int
592 spi_read(struct spi_device *spi, u8 *buf, size_t len)
593 {
594         struct spi_transfer     t = {
595                         .rx_buf         = buf,
596                         .len            = len,
597                 };
598         struct spi_message      m;
599
600         spi_message_init(&m);
601         spi_message_add_tail(&t, &m);
602         return spi_sync(spi, &m);
603 }
604
605 /* this copies txbuf and rxbuf data; for small transfers only! */
606 extern int spi_write_then_read(struct spi_device *spi,
607                 const u8 *txbuf, unsigned n_tx,
608                 u8 *rxbuf, unsigned n_rx);
609
610 /**
611  * spi_w8r8 - SPI synchronous 8 bit write followed by 8 bit read
612  * @spi: device with which data will be exchanged
613  * @cmd: command to be written before data is read back
614  * Context: can sleep
615  *
616  * This returns the (unsigned) eight bit number returned by the
617  * device, or else a negative error code.  Callable only from
618  * contexts that can sleep.
619  */
620 static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
621 {
622         ssize_t                 status;
623         u8                      result;
624
625         status = spi_write_then_read(spi, &cmd, 1, &result, 1);
626
627         /* return negative errno or unsigned value */
628         return (status < 0) ? status : result;
629 }
630
631 /**
632  * spi_w8r16 - SPI synchronous 8 bit write followed by 16 bit read
633  * @spi: device with which data will be exchanged
634  * @cmd: command to be written before data is read back
635  * Context: can sleep
636  *
637  * This returns the (unsigned) sixteen bit number returned by the
638  * device, or else a negative error code.  Callable only from
639  * contexts that can sleep.
640  *
641  * The number is returned in wire-order, which is at least sometimes
642  * big-endian.
643  */
644 static inline ssize_t spi_w8r16(struct spi_device *spi, u8 cmd)
645 {
646         ssize_t                 status;
647         u16                     result;
648
649         status = spi_write_then_read(spi, &cmd, 1, (u8 *) &result, 2);
650
651         /* return negative errno or unsigned value */
652         return (status < 0) ? status : result;
653 }
654
655 /*---------------------------------------------------------------------------*/
656
657 /*
658  * INTERFACE between board init code and SPI infrastructure.
659  *
660  * No SPI driver ever sees these SPI device table segments, but
661  * it's how the SPI core (or adapters that get hotplugged) grows
662  * the driver model tree.
663  *
664  * As a rule, SPI devices can't be probed.  Instead, board init code
665  * provides a table listing the devices which are present, with enough
666  * information to bind and set up the device's driver.  There's basic
667  * support for nonstatic configurations too; enough to handle adding
668  * parport adapters, or microcontrollers acting as USB-to-SPI bridges.
669  */
670
671 /* board-specific information about each SPI device */
672 struct spi_board_info {
673         /* the device name and module name are coupled, like platform_bus;
674          * "modalias" is normally the driver name.
675          *
676          * platform_data goes to spi_device.dev.platform_data,
677          * controller_data goes to spi_device.controller_data,
678          * irq is copied too
679          */
680         char            modalias[KOBJ_NAME_LEN];
681         const void      *platform_data;
682         void            *controller_data;
683         int             irq;
684
685         /* slower signaling on noisy or low voltage boards */
686         u32             max_speed_hz;
687
688
689         /* bus_num is board specific and matches the bus_num of some
690          * spi_master that will probably be registered later.
691          *
692          * chip_select reflects how this chip is wired to that master;
693          * it's less than num_chipselect.
694          */
695         u16             bus_num;
696         u16             chip_select;
697
698         /* mode becomes spi_device.mode, and is essential for chips
699          * where the default of SPI_CS_HIGH = 0 is wrong.
700          */
701         u8              mode;
702
703         /* ... may need additional spi_device chip config data here.
704          * avoid stuff protocol drivers can set; but include stuff
705          * needed to behave without being bound to a driver:
706          *  - quirks like clock rate mattering when not selected
707          */
708 };
709
710 #ifdef  CONFIG_SPI
711 extern int
712 spi_register_board_info(struct spi_board_info const *info, unsigned n);
713 #else
714 /* board init code may ignore whether SPI is configured or not */
715 static inline int
716 spi_register_board_info(struct spi_board_info const *info, unsigned n)
717         { return 0; }
718 #endif
719
720
721 /* If you're hotplugging an adapter with devices (parport, usb, etc)
722  * use spi_new_device() to describe each device.  You can also call
723  * spi_unregister_device() to start making that device vanish, but
724  * normally that would be handled by spi_unregister_master().
725  */
726 extern struct spi_device *
727 spi_new_device(struct spi_master *, struct spi_board_info *);
728
729 static inline void
730 spi_unregister_device(struct spi_device *spi)
731 {
732         if (spi)
733                 device_unregister(&spi->dev);
734 }
735
736 #endif /* __LINUX_SPI_H */