2 * Common SPI Interface: Controller-specific definitions
5 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
7 * SPDX-License-Identifier: GPL-2.0+
14 #define SPI_CPHA 0x01 /* clock phase */
15 #define SPI_CPOL 0x02 /* clock polarity */
16 #define SPI_MODE_0 (0|0) /* (original MicroWire) */
17 #define SPI_MODE_1 (0|SPI_CPHA)
18 #define SPI_MODE_2 (SPI_CPOL|0)
19 #define SPI_MODE_3 (SPI_CPOL|SPI_CPHA)
20 #define SPI_CS_HIGH 0x04 /* CS active high */
21 #define SPI_LSB_FIRST 0x08 /* per-word bits-on-wire */
22 #define SPI_3WIRE 0x10 /* SI/SO signals shared */
23 #define SPI_LOOP 0x20 /* loopback mode */
24 #define SPI_SLAVE 0x40 /* slave mode */
25 #define SPI_PREAMBLE 0x80 /* Skip preamble bytes */
26 #define SPI_TX_BYTE 0x100 /* transmit with 1 wire byte */
27 #define SPI_TX_QUAD 0x200 /* transmit with 4 wires */
29 /* SPI transfer flags */
30 #define SPI_XFER_BEGIN 0x01 /* Assert CS before transfer */
31 #define SPI_XFER_END 0x02 /* Deassert CS after transfer */
32 #define SPI_XFER_MMAP 0x08 /* Memory Mapped start */
33 #define SPI_XFER_MMAP_END 0x10 /* Memory Mapped End */
34 #define SPI_XFER_ONCE (SPI_XFER_BEGIN | SPI_XFER_END)
35 #define SPI_XFER_U_PAGE (1 << 5)
37 /* SPI RX operation modes */
38 #define SPI_OPM_RX_AS (1 << 0)
39 #define SPI_OPM_RX_AF (1 << 1)
40 #define SPI_OPM_RX_DOUT (1 << 2)
41 #define SPI_OPM_RX_DIO (1 << 3)
42 #define SPI_OPM_RX_QOF (1 << 4)
43 #define SPI_OPM_RX_QIOF (1 << 5)
44 #define SPI_OPM_RX_EXTN (SPI_OPM_RX_AS | SPI_OPM_RX_AF | SPI_OPM_RX_DOUT | \
45 SPI_OPM_RX_DIO | SPI_OPM_RX_QOF | \
48 /* SPI bus connection options - see enum spi_dual_flash */
49 #define SPI_CONN_DUAL_SHARED (1 << 0)
50 #define SPI_CONN_DUAL_SEPARATED (1 << 1)
52 /* Header byte that marks the start of the message */
53 #define SPI_PREAMBLE_END_BYTE 0xec
55 #define SPI_DEFAULT_WORDLEN 8
58 /* TODO(sjg@chromium.org): Remove this and use max_hz from struct spi_slave */
64 * struct dm_spi_platdata - platform data for all SPI slaves
66 * This describes a SPI slave, a child device of the SPI bus. To obtain this
67 * struct from a spi_slave, use dev_get_parent_platdata(dev) or
68 * dev_get_parent_platdata(slave->dev).
70 * This data is immuatable. Each time the device is probed, @max_hz and @mode
71 * will be copied to struct spi_slave.
73 * @cs: Chip select number (0..n-1)
74 * @max_hz: Maximum bus speed that this slave can tolerate
75 * @mode: SPI mode to use for this device (see SPI mode flags)
77 struct dm_spi_slave_platdata {
83 #endif /* CONFIG_DM_SPI */
86 * struct spi_slave - Representation of a SPI slave
88 * For driver model this is the per-child data used by the SPI bus. It can
89 * be accessed using dev_get_parent_priv() on the slave device. The SPI uclass
90 * sets uip per_child_auto_alloc_size to sizeof(struct spi_slave), and the
91 * driver should not override it. Two platform data fields (max_hz and mode)
92 * are copied into this structure to provide an initial value. This allows
93 * them to be changed, since we should never change platform data in drivers.
95 * If not using driver model, drivers are expected to extend this with
96 * controller-specific data.
98 * @dev: SPI slave device
99 * @max_hz: Maximum speed for this slave
100 * @speed: Current bus speed. This is 0 until the bus is first
102 * @bus: ID of the bus that the slave is attached to. For
103 * driver model this is the sequence number of the SPI
104 * bus (bus->seq) so does not need to be stored
105 * @cs: ID of the chip select connected to the slave.
106 * @mode: SPI mode to use for this slave (see SPI mode flags)
107 * @op_mode_rx: SPI RX operation mode.
108 * @wordlen: Size of SPI word in number of bits
109 * @max_write_size: If non-zero, the maximum number of bytes which can
110 * be written at once, excluding command bytes.
111 * @memory_map: Address of read-only SPI flash access.
112 * @option: Varies SPI bus options - separate, shared bus.
113 * @flags: Indication of SPI flags.
117 struct udevice *dev; /* struct spi_slave is dev->parentdata */
126 unsigned int wordlen;
127 unsigned int max_write_size;
134 * Initialization, must be called once on start up.
136 * TODO: I don't think we really need this.
141 * spi_do_alloc_slave - Allocate a new SPI slave (internal)
143 * Allocate and zero all fields in the spi slave, and set the bus/chip
144 * select. Use the helper macro spi_alloc_slave() to call this.
146 * @offset: Offset of struct spi_slave within slave structure.
147 * @size: Size of slave structure.
148 * @bus: Bus ID of the slave chip.
149 * @cs: Chip select ID of the slave chip on the specified bus.
151 void *spi_do_alloc_slave(int offset, int size, unsigned int bus,
155 * spi_alloc_slave - Allocate a new SPI slave
157 * Allocate and zero all fields in the spi slave, and set the bus/chip
160 * @_struct: Name of structure to allocate (e.g. struct tegra_spi).
161 * This structure must contain a member 'struct spi_slave *slave'.
162 * @bus: Bus ID of the slave chip.
163 * @cs: Chip select ID of the slave chip on the specified bus.
165 #define spi_alloc_slave(_struct, bus, cs) \
166 spi_do_alloc_slave(offsetof(_struct, slave), \
167 sizeof(_struct), bus, cs)
170 * spi_alloc_slave_base - Allocate a new SPI slave with no private data
172 * Allocate and zero all fields in the spi slave, and set the bus/chip
175 * @bus: Bus ID of the slave chip.
176 * @cs: Chip select ID of the slave chip on the specified bus.
178 #define spi_alloc_slave_base(bus, cs) \
179 spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs)
182 * Set up communications parameters for a SPI slave.
184 * This must be called once for each slave. Note that this function
185 * usually doesn't touch any actual hardware, it only initializes the
186 * contents of spi_slave so that the hardware can be easily
189 * @bus: Bus ID of the slave chip.
190 * @cs: Chip select ID of the slave chip on the specified bus.
191 * @max_hz: Maximum SCK rate in Hz.
192 * @mode: Clock polarity, clock phase and other parameters.
194 * Returns: A spi_slave reference that can be used in subsequent SPI
195 * calls, or NULL if one or more of the parameters are not supported.
197 struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
198 unsigned int max_hz, unsigned int mode);
201 * Free any memory associated with a SPI slave.
203 * @slave: The SPI slave
205 void spi_free_slave(struct spi_slave *slave);
208 * Claim the bus and prepare it for communication with a given slave.
210 * This must be called before doing any transfers with a SPI slave. It
211 * will enable and initialize any SPI hardware as necessary, and make
212 * sure that the SCK line is in the correct idle state. It is not
213 * allowed to claim the same bus for several slaves without releasing
214 * the bus in between.
216 * @slave: The SPI slave
218 * Returns: 0 if the bus was claimed successfully, or a negative value
221 int spi_claim_bus(struct spi_slave *slave);
224 * Release the SPI bus
226 * This must be called once for every call to spi_claim_bus() after
227 * all transfers have finished. It may disable any SPI hardware as
230 * @slave: The SPI slave
232 void spi_release_bus(struct spi_slave *slave);
235 * Set the word length for SPI transactions
237 * Set the word length (number of bits per word) for SPI transactions.
239 * @slave: The SPI slave
240 * @wordlen: The number of bits in a word
242 * Returns: 0 on success, -1 on failure.
244 int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen);
249 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
250 * "bitlen" bits in the SPI MISO port. That's just the way SPI works.
252 * The source of the outgoing bits is the "dout" parameter and the
253 * destination of the input bits is the "din" parameter. Note that "dout"
254 * and "din" can point to the same memory location, in which case the
255 * input data overwrites the output data (since both are buffered by
256 * temporary variables, this is OK).
258 * spi_xfer() interface:
259 * @slave: The SPI slave which will be sending/receiving the data.
260 * @bitlen: How many bits to write and read.
261 * @dout: Pointer to a string of bits to send out. The bits are
262 * held in a byte array and are sent MSB first.
263 * @din: Pointer to a string of bits that will be filled in.
264 * @flags: A bitwise combination of SPI_XFER_* flags.
266 * Returns: 0 on success, not 0 on failure
268 int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
269 void *din, unsigned long flags);
271 /* Copy memory mapped data */
272 void spi_flash_copy_mmap(void *data, void *offset, size_t len);
275 * Determine if a SPI chipselect is valid.
276 * This function is provided by the board if the low-level SPI driver
277 * needs it to determine if a given chipselect is actually valid.
279 * Returns: 1 if bus:cs identifies a valid chip on this board, 0
282 int spi_cs_is_valid(unsigned int bus, unsigned int cs);
284 #ifndef CONFIG_DM_SPI
286 * Activate a SPI chipselect.
287 * This function is provided by the board code when using a driver
288 * that can't control its chipselects automatically (e.g.
289 * common/soft_spi.c). When called, it should activate the chip select
290 * to the device identified by "slave".
292 void spi_cs_activate(struct spi_slave *slave);
295 * Deactivate a SPI chipselect.
296 * This function is provided by the board code when using a driver
297 * that can't control its chipselects automatically (e.g.
298 * common/soft_spi.c). When called, it should deactivate the chip
299 * select to the device identified by "slave".
301 void spi_cs_deactivate(struct spi_slave *slave);
304 * Set transfer speed.
305 * This sets a new speed to be applied for next spi_xfer().
306 * @slave: The SPI slave
307 * @hz: The transfer speed
309 void spi_set_speed(struct spi_slave *slave, uint hz);
313 * Write 8 bits, then read 8 bits.
314 * @slave: The SPI slave we're communicating with
315 * @byte: Byte to be written
317 * Returns: The value that was read, or a negative value on error.
319 * TODO: This function probably shouldn't be inlined.
321 static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte)
323 unsigned char dout[2];
324 unsigned char din[2];
330 ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END);
331 return ret < 0 ? ret : din[1];
335 * Set up a SPI slave for a particular device tree node
337 * This calls spi_setup_slave() with the correct bus number. Call
338 * spi_free_slave() to free it later.
340 * @param blob: Device tree blob
341 * @param slave_node: Slave node to use
342 * @param spi_node: SPI peripheral node to use
343 * @return pointer to new spi_slave structure
345 struct spi_slave *spi_setup_slave_fdt(const void *blob, int slave_node,
349 * spi_base_setup_slave_fdt() - helper function to set up a SPI slace
351 * This decodes SPI properties from the slave node to determine the
352 * chip select and SPI parameters.
354 * @blob: Device tree blob
355 * @busnum: Bus number to use
356 * @node: Device tree node for the SPI bus
358 struct spi_slave *spi_base_setup_slave_fdt(const void *blob, int busnum,
364 * struct spi_cs_info - Information about a bus chip select
366 * @dev: Connected device, or NULL if none
373 * struct struct dm_spi_ops - Driver model SPI operations
375 * The uclass interface is implemented by all SPI devices which use
380 * Claim the bus and prepare it for communication.
382 * The device provided is the slave device. It's parent controller
383 * will be used to provide the communication.
385 * This must be called before doing any transfers with a SPI slave. It
386 * will enable and initialize any SPI hardware as necessary, and make
387 * sure that the SCK line is in the correct idle state. It is not
388 * allowed to claim the same bus for several slaves without releasing
389 * the bus in between.
391 * @dev: The SPI slave
393 * Returns: 0 if the bus was claimed successfully, or a negative value
396 int (*claim_bus)(struct udevice *dev);
399 * Release the SPI bus
401 * This must be called once for every call to spi_claim_bus() after
402 * all transfers have finished. It may disable any SPI hardware as
405 * @dev: The SPI slave
407 int (*release_bus)(struct udevice *dev);
410 * Set the word length for SPI transactions
412 * Set the word length (number of bits per word) for SPI transactions.
414 * @bus: The SPI slave
415 * @wordlen: The number of bits in a word
417 * Returns: 0 on success, -ve on failure.
419 int (*set_wordlen)(struct udevice *dev, unsigned int wordlen);
424 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
425 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI
428 * The source of the outgoing bits is the "dout" parameter and the
429 * destination of the input bits is the "din" parameter. Note that
430 * "dout" and "din" can point to the same memory location, in which
431 * case the input data overwrites the output data (since both are
432 * buffered by temporary variables, this is OK).
434 * spi_xfer() interface:
435 * @dev: The slave device to communicate with
436 * @bitlen: How many bits to write and read.
437 * @dout: Pointer to a string of bits to send out. The bits are
438 * held in a byte array and are sent MSB first.
439 * @din: Pointer to a string of bits that will be filled in.
440 * @flags: A bitwise combination of SPI_XFER_* flags.
442 * Returns: 0 on success, not -1 on failure
444 int (*xfer)(struct udevice *dev, unsigned int bitlen, const void *dout,
445 void *din, unsigned long flags);
448 * Set transfer speed.
449 * This sets a new speed to be applied for next spi_xfer().
451 * @hz: The transfer speed
452 * @return 0 if OK, -ve on error
454 int (*set_speed)(struct udevice *bus, uint hz);
457 * Set the SPI mode/flags
459 * It is unclear if we want to set speed and mode together instead
463 * @mode: Requested SPI mode (SPI_... flags)
464 * @return 0 if OK, -ve on error
466 int (*set_mode)(struct udevice *bus, uint mode);
469 * Get information on a chip select
471 * This is only called when the SPI uclass does not know about a
472 * chip select, i.e. it has no attached device. It gives the driver
473 * a chance to allow activity on that chip select even so.
476 * @cs: The chip select (0..n-1)
477 * @info: Returns information about the chip select, if valid.
478 * On entry info->dev is NULL
479 * @return 0 if OK (and @info is set up), -ENODEV if the chip select
480 * is invalid, other -ve value on error
482 int (*cs_info)(struct udevice *bus, uint cs, struct spi_cs_info *info);
485 struct dm_spi_emul_ops {
489 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
490 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI
491 * works. Here the device is a slave.
493 * The source of the outgoing bits is the "dout" parameter and the
494 * destination of the input bits is the "din" parameter. Note that
495 * "dout" and "din" can point to the same memory location, in which
496 * case the input data overwrites the output data (since both are
497 * buffered by temporary variables, this is OK).
499 * spi_xfer() interface:
500 * @slave: The SPI slave which will be sending/receiving the data.
501 * @bitlen: How many bits to write and read.
502 * @dout: Pointer to a string of bits sent to the device. The
503 * bits are held in a byte array and are sent MSB first.
504 * @din: Pointer to a string of bits that will be sent back to
506 * @flags: A bitwise combination of SPI_XFER_* flags.
508 * Returns: 0 on success, not -1 on failure
510 int (*xfer)(struct udevice *slave, unsigned int bitlen,
511 const void *dout, void *din, unsigned long flags);
515 * spi_find_bus_and_cs() - Find bus and slave devices by number
517 * Given a bus number and chip select, this finds the corresponding bus
518 * device and slave device. Neither device is activated by this function,
519 * although they may have been activated previously.
521 * @busnum: SPI bus number
522 * @cs: Chip select to look for
523 * @busp: Returns bus device
524 * @devp: Return slave device
525 * @return 0 if found, -ENODEV on error
527 int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
528 struct udevice **devp);
531 * spi_get_bus_and_cs() - Find and activate bus and slave devices by number
533 * Given a bus number and chip select, this finds the corresponding bus
534 * device and slave device.
536 * If no such slave exists, and drv_name is not NULL, then a new slave device
537 * is automatically bound on this chip select.
539 * Ths new slave device is probed ready for use with the given speed and mode.
541 * @busnum: SPI bus number
542 * @cs: Chip select to look for
543 * @speed: SPI speed to use for this slave
544 * @mode: SPI mode to use for this slave
545 * @drv_name: Name of driver to attach to this chip select
546 * @dev_name: Name of the new device thus created
547 * @busp: Returns bus device
548 * @devp: Return slave device
549 * @return 0 if found, -ve on error
551 int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
552 const char *drv_name, const char *dev_name,
553 struct udevice **busp, struct spi_slave **devp);
556 * spi_chip_select() - Get the chip select for a slave
558 * @return the chip select this slave is attached to
560 int spi_chip_select(struct udevice *slave);
563 * spi_find_chip_select() - Find the slave attached to chip select
565 * @bus: SPI bus to search
566 * @cs: Chip select to look for
567 * @devp: Returns the slave device if found
568 * @return 0 if found, -ENODEV on error
570 int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp);
573 * spi_slave_ofdata_to_platdata() - decode standard SPI platform data
575 * This decodes the speed and mode for a slave from a device tree node
577 * @blob: Device tree blob
578 * @node: Node offset to read from
579 * @plat: Place to put the decoded information
581 int spi_slave_ofdata_to_platdata(const void *blob, int node,
582 struct dm_spi_slave_platdata *plat);
585 * spi_cs_info() - Check information on a chip select
587 * This checks a particular chip select on a bus to see if it has a device
588 * attached, or is even valid.
591 * @cs: The chip select (0..n-1)
592 * @info: Returns information about the chip select, if valid
593 * @return 0 if OK (and @info is set up), -ENODEV if the chip select
594 * is invalid, other -ve value on error
596 int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info);
598 struct sandbox_state;
601 * sandbox_spi_get_emul() - get an emulator for a SPI slave
603 * This provides a way to attach an emulated SPI device to a particular SPI
604 * slave, so that xfer() operations on the slave will be handled by the
605 * emulator. If a emulator already exists on that chip select it is returned.
606 * Otherwise one is created.
608 * @state: Sandbox state
609 * @bus: SPI bus requesting the emulator
610 * @slave: SPI slave device requesting the emulator
611 * @emuip: Returns pointer to emulator
612 * @return 0 if OK, -ve on error
614 int sandbox_spi_get_emul(struct sandbox_state *state,
615 struct udevice *bus, struct udevice *slave,
616 struct udevice **emulp);
618 /* Access the operations for a SPI device */
619 #define spi_get_ops(dev) ((struct dm_spi_ops *)(dev)->driver->ops)
620 #define spi_emul_get_ops(dev) ((struct dm_spi_emul_ops *)(dev)->driver->ops)
621 #endif /* CONFIG_DM_SPI */