Lines Matching +full:spi +full:- +full:slave
1 /* SPDX-License-Identifier: GPL-2.0-or-later
21 #include <uapi/linux/spi/spi.h>
23 /* Max no. of CS supported per spi device */
36 * INTERFACES between SPI master-side drivers and SPI slave protocol handlers,
37 * and SPI infrastructure.
42 * struct spi_statistics - statistics for spi transfers
43 * @syncp: seqcount to protect members in this struct for per-cpu update
44 * on 32-bit systems
46 * @messages: number of spi-messages handled
95 u64_stats_update_begin(&__lstats->syncp); \
96 u64_stats_add(&__lstats->field, count); \
97 u64_stats_update_end(&__lstats->syncp); \
106 u64_stats_update_begin(&__lstats->syncp); \
107 u64_stats_inc(&__lstats->field); \
108 u64_stats_update_end(&__lstats->syncp); \
113 * struct spi_delay - SPI delay information
131 * struct spi_device - Controller side proxy for an SPI slave device
133 * @controller: SPI controller used with the device.
138 * @chip_select: Array of physical chipselect, spi->chipselect[i] gives
140 * @mode: The spi mode defines how data is clocked out and in.
146 * like eight or 12 bits are common. In-memory wordsizes are
155 * @controller_data: Board-specific definitions for controller, such as
176 * A @spi_device is used to interchange data between an SPI slave
196 * TPM specification defines flow control over SPI. Client device
200 * only half-duplex, the wait state detection needs to be implemented
202 * control is expected from SPI controller.
208 * which is defined in 'include/uapi/linux/spi/spi.h'.
214 #define SPI_MODE_KERNEL_MASK (~(BIT(29) - 1))
222 struct spi_delay word_delay; /* Inter-word delay */
241 * - memory packing (12 bit samples into low bits, others zeroed)
242 * - priority
243 * - chipselect delays
244 * - ...
258 static inline struct spi_device *spi_dev_get(struct spi_device *spi) in spi_dev_get() argument
260 return (spi && get_device(&spi->dev)) ? spi : NULL; in spi_dev_get()
263 static inline void spi_dev_put(struct spi_device *spi) in spi_dev_put() argument
265 if (spi) in spi_dev_put()
266 put_device(&spi->dev); in spi_dev_put()
270 static inline void *spi_get_ctldata(const struct spi_device *spi) in spi_get_ctldata() argument
272 return spi->controller_state; in spi_get_ctldata()
275 static inline void spi_set_ctldata(struct spi_device *spi, void *state) in spi_set_ctldata() argument
277 spi->controller_state = state; in spi_set_ctldata()
282 static inline void spi_set_drvdata(struct spi_device *spi, void *data) in spi_set_drvdata() argument
284 dev_set_drvdata(&spi->dev, data); in spi_set_drvdata()
287 static inline void *spi_get_drvdata(const struct spi_device *spi) in spi_get_drvdata() argument
289 return dev_get_drvdata(&spi->dev); in spi_get_drvdata()
292 static inline u8 spi_get_chipselect(const struct spi_device *spi, u8 idx) in spi_get_chipselect() argument
294 return spi->chip_select[idx]; in spi_get_chipselect()
297 static inline void spi_set_chipselect(struct spi_device *spi, u8 idx, u8 chipselect) in spi_set_chipselect() argument
299 spi->chip_select[idx] = chipselect; in spi_set_chipselect()
302 static inline struct gpio_desc *spi_get_csgpiod(const struct spi_device *spi, u8 idx) in spi_get_csgpiod() argument
304 return spi->cs_gpiod[idx]; in spi_get_csgpiod()
307 static inline void spi_set_csgpiod(struct spi_device *spi, u8 idx, struct gpio_desc *csgpiod) in spi_set_csgpiod() argument
309 spi->cs_gpiod[idx] = csgpiod; in spi_set_csgpiod()
312 static inline bool spi_is_csgpiod(struct spi_device *spi) in spi_is_csgpiod() argument
317 if (spi_get_csgpiod(spi, idx)) in spi_is_csgpiod()
324 * struct spi_driver - Host side "protocol" driver
325 * @id_table: List of SPI devices supported by this driver
326 * @probe: Binds this driver to the SPI device. Drivers can verify
330 * @remove: Unbinds this driver from the SPI device
333 * @driver: SPI device drivers should initialize the name and owner
336 * This represents the kind of device driver that uses SPI messages to
337 * interact with the hardware at the other end of a SPI link. It's called
339 * directly to SPI hardware (which is what the underlying SPI controller
350 int (*probe)(struct spi_device *spi);
351 void (*remove)(struct spi_device *spi);
352 void (*shutdown)(struct spi_device *spi);
364 * spi_unregister_driver - reverse effect of spi_register_driver
371 driver_unregister(&sdrv->driver); in spi_unregister_driver()
374 extern struct spi_device *spi_new_ancillary_device(struct spi_device *spi, u8 chip_select);
381 * module_spi_driver() - Helper macro for registering a SPI driver
384 * Helper macro for SPI drivers which do not do anything special in module
393 * struct spi_controller - interface to SPI master or slave controller
396 * @bus_num: board-specific (and often SOC-specific) identifier for a
397 * given SPI controller.
399 * SPI slaves, and are numbered from zero to num_chipselects.
400 * each slave has a chipselect signal, but it's common that not
401 * every chipselect is connected to a slave.
402 * @dma_alignment: SPI controller constraint on DMA buffers alignment.
407 * supported. If set, the SPI core will reject any transfer with an
413 * @slave: indicates that this is an SPI slave controller
414 * @target: indicates that this is an SPI target controller
415 * @devm_allocated: whether the allocation of this struct is devres-managed
422 * @bus_lock_spinlock: spinlock for SPI bus locking
424 * @bus_lock_flag: indicates that the SPI bus is locked for exclusive use
425 * @multi_cs_cap: indicates that the SPI Controller can assert/de-assert
428 * device's SPI controller; protocol code may call this. This
432 * @set_cs_timing: optional hook for SPI devices to request SPI master
436 * @cleanup: frees controller-specific state
446 * @cur_msg: the currently in-flight message
447 * @cur_msg_completion: a completion for the current in-flight message
455 * @last_cs: the last chip_select that is recorded by set_cs, -1 on non chip
485 * - return 0 if the transfer is finished,
486 * - return 1 if the transfer is still in progress. When
491 * spi_transfer->error first, before calling
498 * @mem_ops: optimized/dedicated operations for interactions with SPI memory.
503 * @slave_abort: abort the ongoing transfer request on an SPI slave controller
504 * @target_abort: abort the ongoing transfer request on an SPI target controller
507 * are not GPIOs (driven by the SPI controller itself).
508 * @use_gpio_descriptors: Turns on the code in the SPI core to parse and grab
509 * GPIO descriptors. This will fill in @cs_gpiods and SPI devices will have
512 * fill in this field with the first unused native CS, to be used by SPI
520 * @dummy_rx: dummy receive buffer for full-duplex devices
521 * @dummy_tx: dummy transmit buffer for full-duplex devices
526 * time snapshot in @spi_transfer->ptp_sts as close as possible to the
527 * moment in time when @spi_transfer->ptp_sts_word_pre and
528 * @spi_transfer->ptp_sts_word_post were transmitted.
529 * If the driver does not set this, the SPI core takes the snapshot as
530 * close to the driver hand-over as possible.
538 * Each SPI controller can communicate with one or more @spi_device
544 * The driver for an SPI controller manages access to those devices through
546 * an SPI slave device. For each such message it queues, it calls the
556 * board-specific. Usually that simplifies to being SoC-specific.
557 * example: one SoC has three SPI controllers, numbered 0..2,
558 * and one board's schematics might show it using SPI-2. Software
565 * might use board-specific GPIOs.
569 /* Some SPI controllers pose alignment requirements on DMAable
582 #define SPI_BPW_MASK(bits) BIT((bits) - 1)
583 #define SPI_BPW_RANGE_MASK(min, max) GENMASK((max) - 1, (min) - 1)
596 #define SPI_CONTROLLER_GPIO_SS BIT(5) /* GPIO CS must select slave */
599 * The spi-controller has multi chip select capability and can
600 * assert/de-assert more than one chip select at once.
604 /* Flag indicating if the allocation of this struct is devres-managed */
608 /* Flag indicating this is an SPI slave controller */
609 bool slave; member
610 /* Flag indicating this is an SPI target controller */
618 size_t (*max_transfer_size)(struct spi_device *spi);
619 size_t (*max_message_size)(struct spi_device *spi);
627 /* Lock and mutex for SPI bus locking */
631 /* Flag indicating that the SPI bus is locked for exclusive use */
635 * Setup mode and clock, etc (SPI driver may call many times).
641 int (*setup)(struct spi_device *spi);
644 * set_cs_timing() method is for SPI controllers that supports
647 * This hook allows SPI client drivers to request SPI controllers
651 int (*set_cs_timing)(struct spi_device *spi);
658 * + For now there's no remove-from-queue operation, or
670 * + The message transfers use clock and SPI mode parameters
673 int (*transfer)(struct spi_device *spi,
677 void (*cleanup)(struct spi_device *spi);
687 struct spi_device *spi,
697 * Over time we expect SPI drivers to be phased over to this API.
737 void (*set_cs)(struct spi_device *spi, bool enable);
738 int (*transfer_one)(struct spi_controller *ctlr, struct spi_device *spi,
743 /* Optimized handlers for SPI memory-like operations. */
767 * Driver sets this field to indicate it is able to snapshot SPI
782 return dev_get_drvdata(&ctlr->dev); in spi_controller_get_devdata()
788 dev_set_drvdata(&ctlr->dev, data); in spi_controller_set_devdata()
793 if (!ctlr || !get_device(&ctlr->dev)) in spi_controller_get()
801 put_device(&ctlr->dev); in spi_controller_put()
806 return IS_ENABLED(CONFIG_SPI_SLAVE) && ctlr->slave; in spi_controller_is_slave()
811 return IS_ENABLED(CONFIG_SPI_SLAVE) && ctlr->target; in spi_controller_is_target()
831 /* The SPI driver core manages memory for the spi_controller classdev */
833 unsigned int size, bool slave);
867 bool slave);
913 * SPI resource management while processing a SPI message
921 * struct spi_res - SPI resource management structure
924 * @data: extra data allocated for the specific use-case
926 * This is based on ideas from devres, but focused on life-cycle
935 /*---------------------------------------------------------------------------*/
938 * I/O INTERFACE between SPI controller and protocol drivers
946 * pointer. (This is unlike most types of I/O API, because SPI hardware
955 * struct spi_transfer - a read/write buffer pair
956 * @tx_buf: data to be written (DMA-safe memory), or NULL
957 * @rx_buf: data to be read (DMA-safe memory), or NULL
979 * @effective_speed_hz: the effective SCK-speed that was used to
980 * transfer this transfer. Set to 0 if the SPI bus driver does
986 * within @tx_buf for which the SPI device is requesting that the time
987 * snapshot for this transfer begins. Upon completing the SPI transfer,
996 * purposefully (instead of setting to spi_transfer->len - 1) to denote
997 * that a transfer-level snapshot taken from within the driver may still
999 * @ptp_sts: Pointer to a memory location held by the SPI slave device where a
1004 * The timestamp must represent the time at which the SPI slave device has
1009 * @error: Error status logged by SPI controller driver.
1011 * SPI transfers always write the same number of bytes as they read.
1024 * In-memory data values are always in native CPU byte order, translated
1025 * from the wire byte order (big-endian except with SPI_LSB_FIRST). So
1029 * When the word size of the SPI transfer is not a power-of-two multiple
1030 * of eight bits, those in-memory words include extra bits. In-memory
1031 * words are always seen by protocol drivers as right-justified, so the
1034 * All SPI transfers start with the relevant chipselect active. Normally
1045 * stay selected until the next transfer. On multi-device SPI busses
1054 * When SPI can transfer in 1x,2x or 4x. It can get this transfer information
1055 * from device through @tx_nbits and @rx_nbits. In Bi-direction, these
1061 * Zero-initialize every field you don't set up explicitly, to
1070 * spi_message.is_dma_mapped reports a pre-existing mapping.
1091 #define SPI_NBITS_SINGLE 0x01 /* 1-bit transfer */
1092 #define SPI_NBITS_DUAL 0x02 /* 2-bit transfer */
1093 #define SPI_NBITS_QUAD 0x04 /* 4-bit transfer */
1111 * struct spi_message - one multi-segment SPI transaction
1113 * @spi: SPI device to which the transaction is queued
1124 * @resources: for resource management when the SPI message is processed
1129 * in the sense that no other spi_message may use that SPI bus until that
1137 * Zero-initialize every field you don't set up explicitly, to
1144 struct spi_device *spi; member
1157 * Some controller drivers (message-at-a-time queue processing)
1159 * others (with multi-message pipelines) could need a flag to
1178 /* List of spi_res resources when the SPI message is processed */
1184 INIT_LIST_HEAD(&m->transfers); in spi_message_init_no_memset()
1185 INIT_LIST_HEAD(&m->resources); in spi_message_init_no_memset()
1197 list_add_tail(&t->transfer_list, &m->transfers); in spi_message_add_tail()
1203 list_del(&t->transfer_list); in spi_transfer_del()
1209 return spi_delay_exec(&t->delay, t); in spi_transfer_delay_exec()
1213 * spi_message_init_with_transfers - Initialize spi_message and append transfers
1215 * @xfers: An array of SPI transfers
1248 spi_message_init_no_memset(&mwt->m); in spi_message_alloc()
1250 spi_message_add_tail(&mwt->t[i], &mwt->m); in spi_message_alloc()
1252 return &mwt->m; in spi_message_alloc()
1260 extern int spi_setup(struct spi_device *spi);
1261 extern int spi_async(struct spi_device *spi, struct spi_message *message);
1262 extern int spi_slave_abort(struct spi_device *spi);
1263 extern int spi_target_abort(struct spi_device *spi);
1266 spi_max_message_size(struct spi_device *spi) in spi_max_message_size() argument
1268 struct spi_controller *ctlr = spi->controller; in spi_max_message_size()
1270 if (!ctlr->max_message_size) in spi_max_message_size()
1272 return ctlr->max_message_size(spi); in spi_max_message_size()
1276 spi_max_transfer_size(struct spi_device *spi) in spi_max_transfer_size() argument
1278 struct spi_controller *ctlr = spi->controller; in spi_max_transfer_size()
1280 size_t msg_max = spi_max_message_size(spi); in spi_max_transfer_size()
1282 if (ctlr->max_transfer_size) in spi_max_transfer_size()
1283 tr_max = ctlr->max_transfer_size(spi); in spi_max_transfer_size()
1290 * spi_is_bpw_supported - Check if bits per word is supported
1291 * @spi: SPI device
1294 * This function checks to see if the SPI controller supports @bpw.
1299 static inline bool spi_is_bpw_supported(struct spi_device *spi, u32 bpw) in spi_is_bpw_supported() argument
1301 u32 bpw_mask = spi->master->bits_per_word_mask; in spi_is_bpw_supported()
1310 * spi_controller_xfer_timeout - Compute a suitable timeout value
1311 * @ctlr: SPI device
1323 return max(xfer->len * 8 * 2 / (xfer->speed_hz / 1000), 500U); in spi_controller_xfer_timeout()
1326 /*---------------------------------------------------------------------------*/
1328 /* SPI transfer replacement methods which make use of spi_res */
1335 * struct spi_replaced_transfers - structure describing the spi_transfer
1344 * are to get re-inserted
1346 * @inserted_transfers: array of spi_transfers of array-size @inserted,
1362 /*---------------------------------------------------------------------------*/
1364 /* SPI transfer transformation methods */
1375 /*---------------------------------------------------------------------------*/
1378 * All these synchronous SPI transfer routines are utilities layered
1383 extern int spi_sync(struct spi_device *spi, struct spi_message *message);
1384 extern int spi_sync_locked(struct spi_device *spi, struct spi_message *message);
1389 * spi_sync_transfer - synchronous SPI data transfer
1390 * @spi: device with which data will be exchanged
1395 * Does a synchronous SPI data transfer of the given spi_transfer array.
1402 spi_sync_transfer(struct spi_device *spi, struct spi_transfer *xfers, in spi_sync_transfer() argument
1409 return spi_sync(spi, &msg); in spi_sync_transfer()
1413 * spi_write - SPI synchronous write
1414 * @spi: device to which data will be written
1425 spi_write(struct spi_device *spi, const void *buf, size_t len) in spi_write() argument
1432 return spi_sync_transfer(spi, &t, 1); in spi_write()
1436 * spi_read - SPI synchronous read
1437 * @spi: device from which data will be read
1448 spi_read(struct spi_device *spi, void *buf, size_t len) in spi_read() argument
1455 return spi_sync_transfer(spi, &t, 1); in spi_read()
1459 extern int spi_write_then_read(struct spi_device *spi,
1464 * spi_w8r8 - SPI synchronous 8 bit write followed by 8 bit read
1465 * @spi: device with which data will be exchanged
1474 static inline ssize_t spi_w8r8(struct spi_device *spi, u8 cmd) in spi_w8r8() argument
1479 status = spi_write_then_read(spi, &cmd, 1, &result, 1); in spi_w8r8()
1486 * spi_w8r16 - SPI synchronous 8 bit write followed by 16 bit read
1487 * @spi: device with which data will be exchanged
1491 * The number is returned in wire-order, which is at least sometimes
1492 * big-endian.
1499 static inline ssize_t spi_w8r16(struct spi_device *spi, u8 cmd) in spi_w8r16() argument
1504 status = spi_write_then_read(spi, &cmd, 1, &result, 2); in spi_w8r16()
1511 * spi_w8r16be - SPI synchronous 8 bit write followed by 16 bit big-endian read
1512 * @spi: device with which data will be exchanged
1517 * convert the read 16 bit data word from big-endian to native endianness.
1524 static inline ssize_t spi_w8r16be(struct spi_device *spi, u8 cmd) in spi_w8r16be() argument
1530 status = spi_write_then_read(spi, &cmd, 1, &result, 2); in spi_w8r16be()
1537 /*---------------------------------------------------------------------------*/
1540 * INTERFACE between board init code and SPI infrastructure.
1542 * No SPI driver ever sees these SPI device table segments, but
1543 * it's how the SPI core (or adapters that get hotplugged) grows
1546 * As a rule, SPI devices can't be probed. Instead, board init code
1549 * support for non-static configurations too; enough to handle adding
1550 * parport adapters, or microcontrollers acting as USB-to-SPI bridges.
1554 * struct spi_board_info - board-specific template for a SPI device
1557 * data stored there is driver-specific.
1563 * from the chip datasheet and board-specific signal quality issues.
1572 * When adding new SPI devices to the device tree, these structures serve
1578 * be stored in tables of board-specific device descriptors, which are
1624 * - quirks like clock rate mattering when not selected
1632 /* Board init code may ignore whether SPI is configured or not */
1654 spi_add_device(struct spi_device *spi);
1659 extern void spi_unregister_device(struct spi_device *spi);
1670 return list_is_last(&xfer->transfer_list, &ctlr->cur_msg->transfers); in spi_transfer_is_last()