2 * Copyright (C) 2005 David Brownell
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.
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.
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.
22 #include <linux/device.h>
25 * INTERFACES between SPI master-side drivers and SPI infrastructure.
26 * (There's no SPI slave support for Linux yet...)
28 extern struct bus_type spi_bus_type;
31 * struct spi_device - Master side proxy for an SPI slave device
32 * @dev: Driver model representation of the device.
33 * @master: SPI controller used with the device.
34 * @max_speed_hz: Maximum clock rate to be used with this chip
35 * (on this board); may be changed by the device's driver.
36 * The spi_transfer.speed_hz can override this for each transfer.
37 * @chip_select: Chipselect, distinguishing chips handled by @master.
38 * @mode: The spi mode defines how data is clocked out and in.
39 * This may be changed by the device's driver.
40 * The "active low" default for chipselect mode can be overridden
41 * (by specifying SPI_CS_HIGH) as can the "MSB first" default for
42 * each word in a transfer (by specifying SPI_LSB_FIRST).
43 * @bits_per_word: Data transfers involve one or more words; word sizes
44 * like eight or 12 bits are common. In-memory wordsizes are
45 * powers of two bytes (e.g. 20 bit samples use 32 bits).
46 * This may be changed by the device's driver, or left at the
47 * default (0) indicating protocol words are eight bit bytes.
48 * The spi_transfer.bits_per_word can override this for each transfer.
49 * @irq: Negative, or the number passed to request_irq() to receive
50 * interrupts from this device.
51 * @controller_state: Controller's runtime state
52 * @controller_data: Board-specific definitions for controller, such as
53 * FIFO initialization parameters; from board_info.controller_data
54 * @modalias: Name of the driver to use with this device, or an alias
55 * for that name. This appears in the sysfs "modalias" attribute
56 * for driver coldplugging, and in uevents used for hotplugging
58 * A @spi_device is used to interchange data between an SPI slave
59 * (usually a discrete chip) and CPU memory.
61 * In @dev, the platform_data is used to hold information about this
62 * device that's meaningful to the device's protocol driver, but not
63 * to its controller. One example might be an identifier for a chip
64 * variant with slightly different functionality; another might be
65 * information about how this particular board wires the chip's pins.
69 struct spi_master *master;
73 #define SPI_CPHA 0x01 /* clock phase */
74 #define SPI_CPOL 0x02 /* clock polarity */
75 #define SPI_MODE_0 (0|0) /* (original MicroWire) */
76 #define SPI_MODE_1 (0|SPI_CPHA)
77 #define SPI_MODE_2 (SPI_CPOL|0)
78 #define SPI_MODE_3 (SPI_CPOL|SPI_CPHA)
79 #define SPI_CS_HIGH 0x04 /* chipselect active high? */
80 #define SPI_LSB_FIRST 0x08 /* per-word bits-on-wire */
81 #define SPI_3WIRE 0x10 /* SI/SO signals shared */
82 #define SPI_LOOP 0x20 /* loopback mode */
83 #define SPI_NO_CS 0x40 /* 1 dev/bus, no chipselect */
84 #define SPI_READY 0x80 /* slave pulls low to pause */
87 void *controller_state;
88 void *controller_data;
92 * likely need more hooks for more protocol options affecting how
93 * the controller talks to each chip, like:
94 * - memory packing (12 bit samples into low bits, others zeroed)
96 * - drop chipselect after each word
102 static inline struct spi_device *to_spi_device(struct device *dev)
104 return dev ? container_of(dev, struct spi_device, dev) : NULL;
107 /* most drivers won't need to care about device refcounting */
108 static inline struct spi_device *spi_dev_get(struct spi_device *spi)
110 return (spi && get_device(&spi->dev)) ? spi : NULL;
113 static inline void spi_dev_put(struct spi_device *spi)
116 put_device(&spi->dev);
119 /* ctldata is for the bus_master driver's runtime state */
120 static inline void *spi_get_ctldata(struct spi_device *spi)
122 return spi->controller_state;
125 static inline void spi_set_ctldata(struct spi_device *spi, void *state)
127 spi->controller_state = state;
130 /* device driver data */
132 static inline void spi_set_drvdata(struct spi_device *spi, void *data)
134 dev_set_drvdata(&spi->dev, data);
137 static inline void *spi_get_drvdata(struct spi_device *spi)
139 return dev_get_drvdata(&spi->dev);
147 * struct spi_driver - Host side "protocol" driver
148 * @probe: Binds this driver to the spi device. Drivers can verify
149 * that the device is actually present, and may need to configure
150 * characteristics (such as bits_per_word) which weren't needed for
151 * the initial configuration done during system setup.
152 * @remove: Unbinds this driver from the spi device
153 * @shutdown: Standard shutdown callback used during system state
154 * transitions such as powerdown/halt and kexec
155 * @suspend: Standard suspend callback used during system state transitions
156 * @resume: Standard resume callback used during system state transitions
157 * @driver: SPI device drivers should initialize the name and owner
158 * field of this structure.
160 * This represents the kind of device driver that uses SPI messages to
161 * interact with the hardware at the other end of a SPI link. It's called
162 * a "protocol" driver because it works through messages rather than talking
163 * directly to SPI hardware (which is what the underlying SPI controller
164 * driver does to pass those messages). These protocols are defined in the
165 * specification for the device(s) supported by the driver.
167 * As a rule, those device protocols represent the lowest level interface
168 * supported by a driver, and it will support upper level interfaces too.
169 * Examples of such upper levels include frameworks like MTD, networking,
170 * MMC, RTC, filesystem character device nodes, and hardware monitoring.
173 int (*probe)(struct spi_device *spi);
174 int (*remove)(struct spi_device *spi);
175 void (*shutdown)(struct spi_device *spi);
176 int (*suspend)(struct spi_device *spi, pm_message_t mesg);
177 int (*resume)(struct spi_device *spi);
178 struct device_driver driver;
181 static inline struct spi_driver *to_spi_driver(struct device_driver *drv)
183 return drv ? container_of(drv, struct spi_driver, driver) : NULL;
186 extern int spi_register_driver(struct spi_driver *sdrv);
189 * spi_unregister_driver - reverse effect of spi_register_driver
190 * @sdrv: the driver to unregister
193 static inline void spi_unregister_driver(struct spi_driver *sdrv)
196 driver_unregister(&sdrv->driver);
201 * struct spi_master - interface to SPI master controller
202 * @dev: device interface to this driver
203 * @bus_num: board-specific (and often SOC-specific) identifier for a
204 * given SPI controller.
205 * @num_chipselect: chipselects are used to distinguish individual
206 * SPI slaves, and are numbered from zero to num_chipselects.
207 * each slave has a chipselect signal, but it's common that not
208 * every chipselect is connected to a slave.
209 * @dma_alignment: SPI controller constraint on DMA buffers alignment.
210 * @mode_bits: flags understood by this controller driver
211 * @flags: other constraints relevant to this driver
212 * @setup: updates the device mode and clocking records used by a
213 * device's SPI controller; protocol code may call this. This
214 * must fail if an unrecognized or unsupported mode is requested.
215 * It's always safe to call this unless transfers are pending on
216 * the device whose settings are being modified.
217 * @transfer: adds a message to the controller's transfer queue.
218 * @cleanup: frees controller-specific state
220 * Each SPI master controller can communicate with one or more @spi_device
221 * children. These make a small bus, sharing MOSI, MISO and SCK signals
222 * but not chip select signals. Each device may be configured to use a
223 * different clock rate, since those shared signals are ignored unless
224 * the chip is selected.
226 * The driver for an SPI controller manages access to those devices through
227 * a queue of spi_message transactions, copying data between CPU memory and
228 * an SPI slave device. For each such message it queues, it calls the
229 * message's completion function when the transaction completes.
234 /* other than negative (== assign one dynamically), bus_num is fully
235 * board-specific. usually that simplifies to being SOC-specific.
236 * example: one SOC has three SPI controllers, numbered 0..2,
237 * and one board's schematics might show it using SPI-2. software
238 * would normally use bus_num=2 for that controller.
242 /* chipselects will be integral to many controllers; some others
243 * might use board-specific GPIOs.
247 /* some SPI controllers pose alignment requirements on DMAable
248 * buffers; let protocol drivers know about these requirements.
252 /* spi_device.mode flags understood by this controller driver */
255 /* other constraints relevant to this driver */
257 #define SPI_MASTER_HALF_DUPLEX BIT(0) /* can't do full duplex */
259 /* Setup mode and clock, etc (spi driver may call many times).
261 * IMPORTANT: this may be called when transfers to another
262 * device are active. DO NOT UPDATE SHARED REGISTERS in ways
263 * which could break those transfers.
265 int (*setup)(struct spi_device *spi);
267 /* bidirectional bulk transfers
269 * + The transfer() method may not sleep; its main role is
270 * just to add the message to the queue.
271 * + For now there's no remove-from-queue operation, or
272 * any other request management
273 * + To a given spi_device, message queueing is pure fifo
275 * + The master's main job is to process its message queue,
276 * selecting a chip then transferring data
277 * + If there are multiple spi_device children, the i/o queue
278 * arbitration algorithm is unspecified (round robin, fifo,
279 * priority, reservations, preemption, etc)
281 * + Chipselect stays active during the entire message
282 * (unless modified by spi_transfer.cs_change != 0).
283 * + The message transfers use clock and SPI mode parameters
284 * previously established by setup() for this device
286 int (*transfer)(struct spi_device *spi,
287 struct spi_message *mesg);
289 /* called on release() to free memory provided by spi_master */
290 void (*cleanup)(struct spi_device *spi);
293 static inline void *spi_master_get_devdata(struct spi_master *master)
295 return dev_get_drvdata(&master->dev);
298 static inline void spi_master_set_devdata(struct spi_master *master, void *data)
300 dev_set_drvdata(&master->dev, data);
303 static inline struct spi_master *spi_master_get(struct spi_master *master)
305 if (!master || !get_device(&master->dev))
310 static inline void spi_master_put(struct spi_master *master)
313 put_device(&master->dev);
317 /* the spi driver core manages memory for the spi_master classdev */
318 extern struct spi_master *
319 spi_alloc_master(struct device *host, unsigned size);
321 extern int spi_register_master(struct spi_master *master);
322 extern void spi_unregister_master(struct spi_master *master);
324 extern struct spi_master *spi_busnum_to_master(u16 busnum);
326 /*---------------------------------------------------------------------------*/
329 * I/O INTERFACE between SPI controller and protocol drivers
331 * Protocol drivers use a queue of spi_messages, each transferring data
332 * between the controller and memory buffers.
334 * The spi_messages themselves consist of a series of read+write transfer
335 * segments. Those segments always read the same number of bits as they
336 * write; but one or the other is easily ignored by passing a null buffer
337 * pointer. (This is unlike most types of I/O API, because SPI hardware
340 * NOTE: Allocation of spi_transfer and spi_message memory is entirely
341 * up to the protocol driver, which guarantees the integrity of both (as
342 * well as the data buffers) for as long as the message is queued.
346 * struct spi_transfer - a read/write buffer pair
347 * @tx_buf: data to be written (dma-safe memory), or NULL
348 * @rx_buf: data to be read (dma-safe memory), or NULL
349 * @tx_dma: DMA address of tx_buf, if @spi_message.is_dma_mapped
350 * @rx_dma: DMA address of rx_buf, if @spi_message.is_dma_mapped
351 * @len: size of rx and tx buffers (in bytes)
352 * @speed_hz: Select a speed other than the device default for this
353 * transfer. If 0 the default (from @spi_device) is used.
354 * @bits_per_word: select a bits_per_word other than the device default
355 * for this transfer. If 0 the default (from @spi_device) is used.
356 * @cs_change: affects chipselect after this transfer completes
357 * @delay_usecs: microseconds to delay after this transfer before
358 * (optionally) changing the chipselect status, then starting
359 * the next transfer or completing this @spi_message.
360 * @transfer_list: transfers are sequenced through @spi_message.transfers
362 * SPI transfers always write the same number of bytes as they read.
363 * Protocol drivers should always provide @rx_buf and/or @tx_buf.
364 * In some cases, they may also want to provide DMA addresses for
365 * the data being transferred; that may reduce overhead, when the
366 * underlying driver uses dma.
368 * If the transmit buffer is null, zeroes will be shifted out
369 * while filling @rx_buf. If the receive buffer is null, the data
370 * shifted in will be discarded. Only "len" bytes shift out (or in).
371 * It's an error to try to shift out a partial word. (For example, by
372 * shifting out three bytes with word size of sixteen or twenty bits;
373 * the former uses two bytes per word, the latter uses four bytes.)
375 * In-memory data values are always in native CPU byte order, translated
376 * from the wire byte order (big-endian except with SPI_LSB_FIRST). So
377 * for example when bits_per_word is sixteen, buffers are 2N bytes long
378 * (@len = 2N) and hold N sixteen bit words in CPU byte order.
380 * When the word size of the SPI transfer is not a power-of-two multiple
381 * of eight bits, those in-memory words include extra bits. In-memory
382 * words are always seen by protocol drivers as right-justified, so the
383 * undefined (rx) or unused (tx) bits are always the most significant bits.
385 * All SPI transfers start with the relevant chipselect active. Normally
386 * it stays selected until after the last transfer in a message. Drivers
387 * can affect the chipselect signal using cs_change.
389 * (i) If the transfer isn't the last one in the message, this flag is
390 * used to make the chipselect briefly go inactive in the middle of the
391 * message. Toggling chipselect in this way may be needed to terminate
392 * a chip command, letting a single spi_message perform all of group of
393 * chip transactions together.
395 * (ii) When the transfer is the last one in the message, the chip may
396 * stay selected until the next transfer. On multi-device SPI busses
397 * with nothing blocking messages going to other devices, this is just
398 * a performance hint; starting a message to another device deselects
399 * this one. But in other cases, this can be used to ensure correctness.
400 * Some devices need protocol transactions to be built from a series of
401 * spi_message submissions, where the content of one message is determined
402 * by the results of previous messages and where the whole transaction
403 * ends when the chipselect goes intactive.
405 * The code that submits an spi_message (and its spi_transfers)
406 * to the lower layers is responsible for managing its memory.
407 * Zero-initialize every field you don't set up explicitly, to
408 * insulate against future API updates. After you submit a message
409 * and its transfers, ignore them until its completion callback.
411 struct spi_transfer {
412 /* it's ok if tx_buf == rx_buf (right?)
413 * for MicroWire, one buffer must be null
414 * buffers must work with dma_*map_single() calls, unless
415 * spi_message.is_dma_mapped reports a pre-existing mapping
424 unsigned cs_change:1;
429 struct list_head transfer_list;
433 * struct spi_message - one multi-segment SPI transaction
434 * @transfers: list of transfer segments in this transaction
435 * @spi: SPI device to which the transaction is queued
436 * @is_dma_mapped: if true, the caller provided both dma and cpu virtual
437 * addresses for each transfer buffer
438 * @complete: called to report transaction completions
439 * @context: the argument to complete() when it's called
440 * @actual_length: the total number of bytes that were transferred in all
441 * successful segments
442 * @status: zero for success, else negative errno
443 * @queue: for use by whichever driver currently owns the message
444 * @state: for use by whichever driver currently owns the message
446 * A @spi_message is used to execute an atomic sequence of data transfers,
447 * each represented by a struct spi_transfer. The sequence is "atomic"
448 * in the sense that no other spi_message may use that SPI bus until that
449 * sequence completes. On some systems, many such sequences can execute as
450 * as single programmed DMA transfer. On all systems, these messages are
451 * queued, and might complete after transactions to other devices. Messages
452 * sent to a given spi_device are alway executed in FIFO order.
454 * The code that submits an spi_message (and its spi_transfers)
455 * to the lower layers is responsible for managing its memory.
456 * Zero-initialize every field you don't set up explicitly, to
457 * insulate against future API updates. After you submit a message
458 * and its transfers, ignore them until its completion callback.
461 struct list_head transfers;
463 struct spi_device *spi;
465 unsigned is_dma_mapped:1;
467 /* REVISIT: we might want a flag affecting the behavior of the
468 * last transfer ... allowing things like "read 16 bit length L"
469 * immediately followed by "read L bytes". Basically imposing
470 * a specific message scheduling algorithm.
472 * Some controller drivers (message-at-a-time queue processing)
473 * could provide that as their default scheduling algorithm. But
474 * others (with multi-message pipelines) could need a flag to
475 * tell them about such special cases.
478 /* completion is reported through a callback */
479 void (*complete)(void *context);
481 unsigned actual_length;
484 /* for optional use by whatever driver currently owns the
485 * spi_message ... between calls to spi_async and then later
486 * complete(), that's the spi_master controller driver.
488 struct list_head queue;
492 static inline void spi_message_init(struct spi_message *m)
494 memset(m, 0, sizeof *m);
495 INIT_LIST_HEAD(&m->transfers);
499 spi_message_add_tail(struct spi_transfer *t, struct spi_message *m)
501 list_add_tail(&t->transfer_list, &m->transfers);
505 spi_transfer_del(struct spi_transfer *t)
507 list_del(&t->transfer_list);
510 /* It's fine to embed message and transaction structures in other data
511 * structures so long as you don't free them while they're in use.
514 static inline struct spi_message *spi_message_alloc(unsigned ntrans, gfp_t flags)
516 struct spi_message *m;
518 m = kzalloc(sizeof(struct spi_message)
519 + ntrans * sizeof(struct spi_transfer),
523 struct spi_transfer *t = (struct spi_transfer *)(m + 1);
525 INIT_LIST_HEAD(&m->transfers);
526 for (i = 0; i < ntrans; i++, t++)
527 spi_message_add_tail(t, m);
532 static inline void spi_message_free(struct spi_message *m)
537 extern int spi_setup(struct spi_device *spi);
540 * spi_async - asynchronous SPI transfer
541 * @spi: device with which data will be exchanged
542 * @message: describes the data transfers, including completion callback
543 * Context: any (irqs may be blocked, etc)
545 * This call may be used in_irq and other contexts which can't sleep,
546 * as well as from task contexts which can sleep.
548 * The completion callback is invoked in a context which can't sleep.
549 * Before that invocation, the value of message->status is undefined.
550 * When the callback is issued, message->status holds either zero (to
551 * indicate complete success) or a negative error code. After that
552 * callback returns, the driver which issued the transfer request may
553 * deallocate the associated memory; it's no longer in use by any SPI
554 * core or controller driver code.
556 * Note that although all messages to a spi_device are handled in
557 * FIFO order, messages may go to different devices in other orders.
558 * Some device might be higher priority, or have various "hard" access
559 * time requirements, for example.
561 * On detection of any fault during the transfer, processing of
562 * the entire message is aborted, and the device is deselected.
563 * Until returning from the associated message completion callback,
564 * no other spi_message queued to that device will be processed.
565 * (This rule applies equally to all the synchronous transfer calls,
566 * which are wrappers around this core asynchronous primitive.)
569 spi_async(struct spi_device *spi, struct spi_message *message)
572 return spi->master->transfer(spi, message);
575 /*---------------------------------------------------------------------------*/
577 /* All these synchronous SPI transfer routines are utilities layered
578 * over the core async transfer primitive. Here, "synchronous" means
579 * they will sleep uninterruptibly until the async transfer completes.
582 extern int spi_sync(struct spi_device *spi, struct spi_message *message);
585 * spi_write - SPI synchronous write
586 * @spi: device to which data will be written
588 * @len: data buffer size
591 * This writes the buffer and returns zero or a negative error code.
592 * Callable only from contexts that can sleep.
595 spi_write(struct spi_device *spi, const u8 *buf, size_t len)
597 struct spi_transfer t = {
601 struct spi_message m;
603 spi_message_init(&m);
604 spi_message_add_tail(&t, &m);
605 return spi_sync(spi, &m);
609 * spi_read - SPI synchronous read
610 * @spi: device from which data will be read
612 * @len: data buffer size
615 * This reads the buffer and returns zero or a negative error code.
616 * Callable only from contexts that can sleep.
619 spi_read(struct spi_device *spi, u8 *buf, size_t len)
621 struct spi_transfer t = {
625 struct spi_message m;
627 spi_message_init(&m);
628 spi_message_add_tail(&t, &m);
629 return spi_sync(spi, &m);
632 /* this copies txbuf and rxbuf data; for small transfers only! */
633 extern int spi_write_then_read(struct spi_device *spi,
634 const u8 *txbuf, unsigned n_tx,
635 u8 *rxbuf, unsigned n_rx);
638 * spi_w8r8 - SPI synchronous 8 bit write followed by 8 bit read
639 * @spi: device with which data will be exchanged
640 * @cmd: command to be written before data is read back
643 * This returns the (unsigned) eight bit number returned by the
644 * device, or else a negative error code. Callable only from
645 * contexts that can sleep.
647 static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd)
652 status = spi_write_then_read(spi, &cmd, 1, &result, 1);
654 /* return negative errno or unsigned value */
655 return (status < 0) ? status : result;
659 * spi_w8r16 - SPI synchronous 8 bit write followed by 16 bit read
660 * @spi: device with which data will be exchanged
661 * @cmd: command to be written before data is read back
664 * This returns the (unsigned) sixteen bit number returned by the
665 * device, or else a negative error code. Callable only from
666 * contexts that can sleep.
668 * The number is returned in wire-order, which is at least sometimes
671 static inline ssize_t spi_w8r16(struct spi_device *spi, u8 cmd)
676 status = spi_write_then_read(spi, &cmd, 1, (u8 *) &result, 2);
678 /* return negative errno or unsigned value */
679 return (status < 0) ? status : result;
682 /*---------------------------------------------------------------------------*/
685 * INTERFACE between board init code and SPI infrastructure.
687 * No SPI driver ever sees these SPI device table segments, but
688 * it's how the SPI core (or adapters that get hotplugged) grows
689 * the driver model tree.
691 * As a rule, SPI devices can't be probed. Instead, board init code
692 * provides a table listing the devices which are present, with enough
693 * information to bind and set up the device's driver. There's basic
694 * support for nonstatic configurations too; enough to handle adding
695 * parport adapters, or microcontrollers acting as USB-to-SPI bridges.
699 * struct spi_board_info - board-specific template for a SPI device
700 * @modalias: Initializes spi_device.modalias; identifies the driver.
701 * @platform_data: Initializes spi_device.platform_data; the particular
702 * data stored there is driver-specific.
703 * @controller_data: Initializes spi_device.controller_data; some
704 * controllers need hints about hardware setup, e.g. for DMA.
705 * @irq: Initializes spi_device.irq; depends on how the board is wired.
706 * @max_speed_hz: Initializes spi_device.max_speed_hz; based on limits
707 * from the chip datasheet and board-specific signal quality issues.
708 * @bus_num: Identifies which spi_master parents the spi_device; unused
709 * by spi_new_device(), and otherwise depends on board wiring.
710 * @chip_select: Initializes spi_device.chip_select; depends on how
711 * the board is wired.
712 * @mode: Initializes spi_device.mode; based on the chip datasheet, board
713 * wiring (some devices support both 3WIRE and standard modes), and
714 * possibly presence of an inverter in the chipselect path.
716 * When adding new SPI devices to the device tree, these structures serve
717 * as a partial device template. They hold information which can't always
718 * be determined by drivers. Information that probe() can establish (such
719 * as the default transfer wordsize) is not included here.
721 * These structures are used in two places. Their primary role is to
722 * be stored in tables of board-specific device descriptors, which are
723 * declared early in board initialization and then used (much later) to
724 * populate a controller's device tree after the that controller's driver
725 * initializes. A secondary (and atypical) role is as a parameter to
726 * spi_new_device() call, which happens after those controller drivers
727 * are active in some dynamic board configuration models.
729 struct spi_board_info {
730 /* the device name and module name are coupled, like platform_bus;
731 * "modalias" is normally the driver name.
733 * platform_data goes to spi_device.dev.platform_data,
734 * controller_data goes to spi_device.controller_data,
738 const void *platform_data;
739 void *controller_data;
742 /* slower signaling on noisy or low voltage boards */
746 /* bus_num is board specific and matches the bus_num of some
747 * spi_master that will probably be registered later.
749 * chip_select reflects how this chip is wired to that master;
750 * it's less than num_chipselect.
755 /* mode becomes spi_device.mode, and is essential for chips
756 * where the default of SPI_CS_HIGH = 0 is wrong.
760 /* ... may need additional spi_device chip config data here.
761 * avoid stuff protocol drivers can set; but include stuff
762 * needed to behave without being bound to a driver:
763 * - quirks like clock rate mattering when not selected
769 spi_register_board_info(struct spi_board_info const *info, unsigned n);
771 /* board init code may ignore whether SPI is configured or not */
773 spi_register_board_info(struct spi_board_info const *info, unsigned n)
778 /* If you're hotplugging an adapter with devices (parport, usb, etc)
779 * use spi_new_device() to describe each device. You can also call
780 * spi_unregister_device() to start making that device vanish, but
781 * normally that would be handled by spi_unregister_master().
783 * You can also use spi_alloc_device() and spi_add_device() to use a two
784 * stage registration sequence for each spi_device. This gives the caller
785 * some more control over the spi_device structure before it is registered,
786 * but requires that caller to initialize fields that would otherwise
787 * be defined using the board info.
789 extern struct spi_device *
790 spi_alloc_device(struct spi_master *master);
793 spi_add_device(struct spi_device *spi);
795 extern struct spi_device *
796 spi_new_device(struct spi_master *, struct spi_board_info *);
799 spi_unregister_device(struct spi_device *spi)
802 device_unregister(&spi->dev);
805 #endif /* __LINUX_SPI_H */