spi.h 26 KB

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