blob: ef8c1f6692e23ae930faa5c17d97ffc248785a46 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001/* SPDX-License-Identifier: GPL-2.0+ */
wdenk77f85582002-09-26 02:01:47 +00002/*
Jagannadha Sutradharudu Teki469146c2013-10-10 22:14:09 +05303 * Common SPI Interface: Controller-specific definitions
4 *
wdenk77f85582002-09-26 02:01:47 +00005 * (C) Copyright 2001
6 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
wdenk77f85582002-09-26 02:01:47 +00007 */
8
9#ifndef _SPI_H_
10#define _SPI_H_
11
Boris Brezillond13f5b22018-08-16 17:30:11 +020012#include <common.h>
Simon Glasscd93d622020-05-10 11:40:13 -060013#include <linux/bitops.h>
Boris Brezillond13f5b22018-08-16 17:30:11 +020014
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +020015/* SPI mode flags */
Simon Glass70e5e672020-07-07 13:11:49 -060016#define SPI_CPHA BIT(0) /* clock phase (1 = SPI_CLOCK_PHASE_SECOND) */
17#define SPI_CPOL BIT(1) /* clock polarity (1 = SPI_POLARITY_HIGH) */
Jagan Teki465c00d2015-12-29 12:12:30 +053018#define SPI_MODE_0 (0|0) /* (original MicroWire) */
19#define SPI_MODE_1 (0|SPI_CPHA)
20#define SPI_MODE_2 (SPI_CPOL|0)
21#define SPI_MODE_3 (SPI_CPOL|SPI_CPHA)
22#define SPI_CS_HIGH BIT(2) /* CS active high */
23#define SPI_LSB_FIRST BIT(3) /* per-word bits-on-wire */
24#define SPI_3WIRE BIT(4) /* SI/SO signals shared */
25#define SPI_LOOP BIT(5) /* loopback mode */
26#define SPI_SLAVE BIT(6) /* slave mode */
27#define SPI_PREAMBLE BIT(7) /* Skip preamble bytes */
Jagan Teki29ee0262015-12-28 22:24:08 +053028#define SPI_TX_BYTE BIT(8) /* transmit with 1 wire byte */
Jagan Teki2b11a412015-12-28 22:55:50 +053029#define SPI_TX_DUAL BIT(9) /* transmit with 2 wires */
30#define SPI_TX_QUAD BIT(10) /* transmit with 4 wires */
Jagan Teki08fe9c22016-08-08 17:12:12 +053031#define SPI_RX_SLOW BIT(11) /* receive with 1 wire slow */
Jagan Teki3ac48d02016-08-10 20:48:14 +053032#define SPI_RX_DUAL BIT(12) /* receive with 2 wires */
33#define SPI_RX_QUAD BIT(13) /* receive with 4 wires */
Vignesh Raghavendra658df8b2019-12-05 15:46:05 +053034#define SPI_TX_OCTAL BIT(14) /* transmit with 8 wires */
35#define SPI_RX_OCTAL BIT(15) /* receive with 8 wires */
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053036
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000037/* Header byte that marks the start of the message */
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053038#define SPI_PREAMBLE_END_BYTE 0xec
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000039
Jagan Teki5d69df32015-06-27 00:51:30 +053040#define SPI_DEFAULT_WORDLEN 8
Nikita Kiryanov5753d092013-10-16 17:23:25 +030041
Simon Glassd0cff032015-01-25 08:27:12 -070042/* TODO(sjg@chromium.org): Remove this and use max_hz from struct spi_slave */
Simon Glassd7af6a42014-10-13 23:41:52 -060043struct dm_spi_bus {
44 uint max_hz;
45};
46
Simon Glassd0cff032015-01-25 08:27:12 -070047/**
48 * struct dm_spi_platdata - platform data for all SPI slaves
49 *
50 * This describes a SPI slave, a child device of the SPI bus. To obtain this
51 * struct from a spi_slave, use dev_get_parent_platdata(dev) or
52 * dev_get_parent_platdata(slave->dev).
53 *
54 * This data is immuatable. Each time the device is probed, @max_hz and @mode
55 * will be copied to struct spi_slave.
56 *
57 * @cs: Chip select number (0..n-1)
58 * @max_hz: Maximum bus speed that this slave can tolerate
59 * @mode: SPI mode to use for this device (see SPI mode flags)
60 */
61struct dm_spi_slave_platdata {
62 unsigned int cs;
63 uint max_hz;
64 uint mode;
65};
66
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053067/**
Simon Glassb14ccfc2020-04-08 16:57:21 -060068 * enum spi_clock_phase - indicates the clock phase to use for SPI (CPHA)
69 *
70 * @SPI_CLOCK_PHASE_FIRST: Data sampled on the first phase
71 * @SPI_CLOCK_PHASE_SECOND: Data sampled on the second phase
72 */
73enum spi_clock_phase {
74 SPI_CLOCK_PHASE_FIRST,
75 SPI_CLOCK_PHASE_SECOND,
76};
77
78/**
79 * enum spi_wire_mode - indicates the number of wires used for SPI
80 *
81 * @SPI_4_WIRE_MODE: Normal bidirectional mode with MOSI and MISO
82 * @SPI_3_WIRE_MODE: Unidirectional version with a single data line SISO
83 */
84enum spi_wire_mode {
85 SPI_4_WIRE_MODE,
86 SPI_3_WIRE_MODE,
87};
88
89/**
90 * enum spi_polarity - indicates the polarity of the SPI bus (CPOL)
91 *
92 * @SPI_POLARITY_LOW: Clock is low in idle state
93 * @SPI_POLARITY_HIGH: Clock is high in idle state
94 */
95enum spi_polarity {
96 SPI_POLARITY_LOW,
97 SPI_POLARITY_HIGH,
98};
99
100/**
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +0530101 * struct spi_slave - Representation of a SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200102 *
Simon Glassd7af6a42014-10-13 23:41:52 -0600103 * For driver model this is the per-child data used by the SPI bus. It can
Simon Glassbcbe3d12015-09-28 23:32:01 -0600104 * be accessed using dev_get_parent_priv() on the slave device. The SPI uclass
Simon Glassd0cff032015-01-25 08:27:12 -0700105 * sets uip per_child_auto_alloc_size to sizeof(struct spi_slave), and the
106 * driver should not override it. Two platform data fields (max_hz and mode)
107 * are copied into this structure to provide an initial value. This allows
108 * them to be changed, since we should never change platform data in drivers.
Simon Glassd7af6a42014-10-13 23:41:52 -0600109 *
110 * If not using driver model, drivers are expected to extend this with
111 * controller-specific data.
112 *
113 * @dev: SPI slave device
114 * @max_hz: Maximum speed for this slave
Simon Glass60e28092015-02-17 15:29:35 -0700115 * @speed: Current bus speed. This is 0 until the bus is first
116 * claimed.
Simon Glassd7af6a42014-10-13 23:41:52 -0600117 * @bus: ID of the bus that the slave is attached to. For
118 * driver model this is the sequence number of the SPI
119 * bus (bus->seq) so does not need to be stored
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +0530120 * @cs: ID of the chip select connected to the slave.
Jagan Tekif5c3c032015-12-14 12:15:17 +0530121 * @mode: SPI mode to use for this slave (see SPI mode flags)
Nikita Kiryanov5753d092013-10-16 17:23:25 +0300122 * @wordlen: Size of SPI word in number of bits
Álvaro Fernández Rojas8af74ed2018-01-23 17:14:56 +0100123 * @max_read_size: If non-zero, the maximum number of bytes which can
124 * be read at once.
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +0530125 * @max_write_size: If non-zero, the maximum number of bytes which can
Álvaro Fernández Rojas6c94bd12018-01-23 17:14:57 +0100126 * be written at once.
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +0530127 * @memory_map: Address of read-only SPI flash access.
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +0530128 * @flags: Indication of SPI flags.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200129 */
130struct spi_slave {
Lukasz Majewski56c40462020-06-04 23:11:53 +0800131#if CONFIG_IS_ENABLED(DM_SPI)
Simon Glassd7af6a42014-10-13 23:41:52 -0600132 struct udevice *dev; /* struct spi_slave is dev->parentdata */
133 uint max_hz;
Simon Glass60e28092015-02-17 15:29:35 -0700134 uint speed;
Simon Glassd7af6a42014-10-13 23:41:52 -0600135#else
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530136 unsigned int bus;
137 unsigned int cs;
Simon Glassd0cff032015-01-25 08:27:12 -0700138#endif
Jagan Tekif5c3c032015-12-14 12:15:17 +0530139 uint mode;
Nikita Kiryanov5753d092013-10-16 17:23:25 +0300140 unsigned int wordlen;
Álvaro Fernández Rojas8af74ed2018-01-23 17:14:56 +0100141 unsigned int max_read_size;
Simon Glass0c456ce2013-03-11 06:08:05 +0000142 unsigned int max_write_size;
Poddar, Sourav004f15b2013-10-07 15:53:01 +0530143 void *memory_map;
Jagan Tekic40f6002015-12-28 22:23:14 +0530144
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +0530145 u8 flags;
Jagan Teki29ee0262015-12-28 22:24:08 +0530146#define SPI_XFER_BEGIN BIT(0) /* Assert CS before transfer */
147#define SPI_XFER_END BIT(1) /* Deassert CS after transfer */
Jagan Tekic40f6002015-12-28 22:23:14 +0530148#define SPI_XFER_ONCE (SPI_XFER_BEGIN | SPI_XFER_END)
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200149};
wdenk77f85582002-09-26 02:01:47 +0000150
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530151/**
Simon Glassba6c3ce2013-03-11 06:08:00 +0000152 * spi_do_alloc_slave - Allocate a new SPI slave (internal)
153 *
154 * Allocate and zero all fields in the spi slave, and set the bus/chip
155 * select. Use the helper macro spi_alloc_slave() to call this.
156 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530157 * @offset: Offset of struct spi_slave within slave structure.
158 * @size: Size of slave structure.
159 * @bus: Bus ID of the slave chip.
160 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000161 */
162void *spi_do_alloc_slave(int offset, int size, unsigned int bus,
163 unsigned int cs);
164
165/**
166 * spi_alloc_slave - Allocate a new SPI slave
167 *
168 * Allocate and zero all fields in the spi slave, and set the bus/chip
169 * select.
170 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530171 * @_struct: Name of structure to allocate (e.g. struct tegra_spi).
172 * This structure must contain a member 'struct spi_slave *slave'.
173 * @bus: Bus ID of the slave chip.
174 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000175 */
176#define spi_alloc_slave(_struct, bus, cs) \
177 spi_do_alloc_slave(offsetof(_struct, slave), \
178 sizeof(_struct), bus, cs)
179
180/**
181 * spi_alloc_slave_base - Allocate a new SPI slave with no private data
182 *
183 * Allocate and zero all fields in the spi slave, and set the bus/chip
184 * select.
185 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530186 * @bus: Bus ID of the slave chip.
187 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000188 */
189#define spi_alloc_slave_base(bus, cs) \
190 spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs)
191
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530192/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200193 * Set up communications parameters for a SPI slave.
194 *
195 * This must be called once for each slave. Note that this function
196 * usually doesn't touch any actual hardware, it only initializes the
197 * contents of spi_slave so that the hardware can be easily
198 * initialized later.
199 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530200 * @bus: Bus ID of the slave chip.
201 * @cs: Chip select ID of the slave chip on the specified bus.
202 * @max_hz: Maximum SCK rate in Hz.
203 * @mode: Clock polarity, clock phase and other parameters.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200204 *
205 * Returns: A spi_slave reference that can be used in subsequent SPI
206 * calls, or NULL if one or more of the parameters are not supported.
207 */
208struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
209 unsigned int max_hz, unsigned int mode);
210
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530211/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200212 * Free any memory associated with a SPI slave.
213 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530214 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200215 */
216void spi_free_slave(struct spi_slave *slave);
217
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530218/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200219 * Claim the bus and prepare it for communication with a given slave.
220 *
221 * This must be called before doing any transfers with a SPI slave. It
222 * will enable and initialize any SPI hardware as necessary, and make
223 * sure that the SCK line is in the correct idle state. It is not
224 * allowed to claim the same bus for several slaves without releasing
225 * the bus in between.
226 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530227 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200228 *
229 * Returns: 0 if the bus was claimed successfully, or a negative value
230 * if it wasn't.
231 */
232int spi_claim_bus(struct spi_slave *slave);
233
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530234/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200235 * Release the SPI bus
236 *
237 * This must be called once for every call to spi_claim_bus() after
238 * all transfers have finished. It may disable any SPI hardware as
239 * appropriate.
240 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530241 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200242 */
243void spi_release_bus(struct spi_slave *slave);
wdenk77f85582002-09-26 02:01:47 +0000244
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530245/**
Nikita Kiryanov5753d092013-10-16 17:23:25 +0300246 * Set the word length for SPI transactions
247 *
248 * Set the word length (number of bits per word) for SPI transactions.
249 *
250 * @slave: The SPI slave
251 * @wordlen: The number of bits in a word
252 *
253 * Returns: 0 on success, -1 on failure.
254 */
255int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen);
256
257/**
Simon Glassccdabd82019-12-06 21:42:35 -0700258 * SPI transfer (optional if mem_ops is used)
wdenk77f85582002-09-26 02:01:47 +0000259 *
260 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
261 * "bitlen" bits in the SPI MISO port. That's just the way SPI works.
262 *
263 * The source of the outgoing bits is the "dout" parameter and the
264 * destination of the input bits is the "din" parameter. Note that "dout"
265 * and "din" can point to the same memory location, in which case the
266 * input data overwrites the output data (since both are buffered by
267 * temporary variables, this is OK).
268 *
wdenk77f85582002-09-26 02:01:47 +0000269 * spi_xfer() interface:
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530270 * @slave: The SPI slave which will be sending/receiving the data.
271 * @bitlen: How many bits to write and read.
272 * @dout: Pointer to a string of bits to send out. The bits are
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200273 * held in a byte array and are sent MSB first.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530274 * @din: Pointer to a string of bits that will be filled in.
275 * @flags: A bitwise combination of SPI_XFER_* flags.
wdenk77f85582002-09-26 02:01:47 +0000276 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530277 * Returns: 0 on success, not 0 on failure
wdenk77f85582002-09-26 02:01:47 +0000278 */
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200279int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
280 void *din, unsigned long flags);
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +0200281
Jagan Teki8473b322019-07-22 17:22:56 +0530282/**
283 * spi_write_then_read - SPI synchronous write followed by read
284 *
285 * This performs a half duplex transaction in which the first transaction
286 * is to send the opcode and if the length of buf is non-zero then it start
287 * the second transaction as tx or rx based on the need from respective slave.
288 *
289 * @slave: The SPI slave device with which opcode/data will be exchanged
290 * @opcode: opcode used for specific transfer
291 * @n_opcode: size of opcode, in bytes
292 * @txbuf: buffer into which data to be written
293 * @rxbuf: buffer into which data will be read
294 * @n_buf: size of buf (whether it's [tx|rx]buf), in bytes
295 *
296 * Returns: 0 on success, not 0 on failure
297 */
298int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
299 size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
300 size_t n_buf);
301
Tom Rini146bad92015-08-17 13:29:54 +0530302/* Copy memory mapped data */
303void spi_flash_copy_mmap(void *data, void *offset, size_t len);
304
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530305/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200306 * Determine if a SPI chipselect is valid.
307 * This function is provided by the board if the low-level SPI driver
308 * needs it to determine if a given chipselect is actually valid.
309 *
310 * Returns: 1 if bus:cs identifies a valid chip on this board, 0
311 * otherwise.
312 */
Simon Glassd7af6a42014-10-13 23:41:52 -0600313int spi_cs_is_valid(unsigned int bus, unsigned int cs);
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200314
Simon Glass324ec5d2020-07-08 09:02:14 -0600315/*
316 * These names are used in several drivers and these declarations will be
317 * removed soon as part of the SPI DM migration. Drop them if driver model is
318 * enabled for SPI.
319 */
Lukasz Majewski56c40462020-06-04 23:11:53 +0800320#if !CONFIG_IS_ENABLED(DM_SPI)
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530321/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200322 * Activate a SPI chipselect.
323 * This function is provided by the board code when using a driver
324 * that can't control its chipselects automatically (e.g.
325 * common/soft_spi.c). When called, it should activate the chip select
326 * to the device identified by "slave".
327 */
328void spi_cs_activate(struct spi_slave *slave);
329
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530330/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200331 * Deactivate a SPI chipselect.
332 * This function is provided by the board code when using a driver
333 * that can't control its chipselects automatically (e.g.
334 * common/soft_spi.c). When called, it should deactivate the chip
335 * select to the device identified by "slave".
336 */
337void spi_cs_deactivate(struct spi_slave *slave);
Simon Glass324ec5d2020-07-08 09:02:14 -0600338#endif
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200339
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530340/**
Thomas Choufa1423e2010-12-24 15:16:07 +0800341 * Set transfer speed.
342 * This sets a new speed to be applied for next spi_xfer().
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530343 * @slave: The SPI slave
344 * @hz: The transfer speed
Thomas Choufa1423e2010-12-24 15:16:07 +0800345 */
346void spi_set_speed(struct spi_slave *slave, uint hz);
347
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530348/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200349 * Write 8 bits, then read 8 bits.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530350 * @slave: The SPI slave we're communicating with
351 * @byte: Byte to be written
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200352 *
353 * Returns: The value that was read, or a negative value on error.
354 *
355 * TODO: This function probably shouldn't be inlined.
356 */
357static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte)
358{
359 unsigned char dout[2];
360 unsigned char din[2];
361 int ret;
362
363 dout[0] = byte;
364 dout[1] = 0;
365
366 ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END);
367 return ret < 0 ? ret : din[1];
368}
wdenk77f85582002-09-26 02:01:47 +0000369
Simon Glassd7af6a42014-10-13 23:41:52 -0600370/**
371 * struct spi_cs_info - Information about a bus chip select
372 *
373 * @dev: Connected device, or NULL if none
374 */
375struct spi_cs_info {
376 struct udevice *dev;
377};
378
379/**
380 * struct struct dm_spi_ops - Driver model SPI operations
381 *
382 * The uclass interface is implemented by all SPI devices which use
383 * driver model.
384 */
385struct dm_spi_ops {
386 /**
387 * Claim the bus and prepare it for communication.
388 *
389 * The device provided is the slave device. It's parent controller
390 * will be used to provide the communication.
391 *
392 * This must be called before doing any transfers with a SPI slave. It
393 * will enable and initialize any SPI hardware as necessary, and make
394 * sure that the SCK line is in the correct idle state. It is not
395 * allowed to claim the same bus for several slaves without releasing
396 * the bus in between.
397 *
Simon Glass9694b722015-04-19 09:05:40 -0600398 * @dev: The SPI slave
Simon Glassd7af6a42014-10-13 23:41:52 -0600399 *
400 * Returns: 0 if the bus was claimed successfully, or a negative value
401 * if it wasn't.
402 */
Simon Glass9694b722015-04-19 09:05:40 -0600403 int (*claim_bus)(struct udevice *dev);
Simon Glassd7af6a42014-10-13 23:41:52 -0600404
405 /**
406 * Release the SPI bus
407 *
408 * This must be called once for every call to spi_claim_bus() after
409 * all transfers have finished. It may disable any SPI hardware as
410 * appropriate.
411 *
Simon Glass9694b722015-04-19 09:05:40 -0600412 * @dev: The SPI slave
Simon Glassd7af6a42014-10-13 23:41:52 -0600413 */
Simon Glass9694b722015-04-19 09:05:40 -0600414 int (*release_bus)(struct udevice *dev);
Simon Glassd7af6a42014-10-13 23:41:52 -0600415
416 /**
417 * Set the word length for SPI transactions
418 *
419 * Set the word length (number of bits per word) for SPI transactions.
420 *
421 * @bus: The SPI slave
422 * @wordlen: The number of bits in a word
423 *
424 * Returns: 0 on success, -ve on failure.
425 */
Simon Glass9694b722015-04-19 09:05:40 -0600426 int (*set_wordlen)(struct udevice *dev, unsigned int wordlen);
Simon Glassd7af6a42014-10-13 23:41:52 -0600427
428 /**
429 * SPI transfer
430 *
431 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
432 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI
433 * works.
434 *
435 * The source of the outgoing bits is the "dout" parameter and the
436 * destination of the input bits is the "din" parameter. Note that
437 * "dout" and "din" can point to the same memory location, in which
438 * case the input data overwrites the output data (since both are
439 * buffered by temporary variables, this is OK).
440 *
441 * spi_xfer() interface:
442 * @dev: The slave device to communicate with
443 * @bitlen: How many bits to write and read.
444 * @dout: Pointer to a string of bits to send out. The bits are
445 * held in a byte array and are sent MSB first.
446 * @din: Pointer to a string of bits that will be filled in.
447 * @flags: A bitwise combination of SPI_XFER_* flags.
448 *
449 * Returns: 0 on success, not -1 on failure
450 */
451 int (*xfer)(struct udevice *dev, unsigned int bitlen, const void *dout,
452 void *din, unsigned long flags);
453
454 /**
Boris Brezillond13f5b22018-08-16 17:30:11 +0200455 * Optimized handlers for SPI memory-like operations.
456 *
457 * Optimized/dedicated operations for interactions with SPI memory. This
458 * field is optional and should only be implemented if the controller
459 * has native support for memory like operations.
460 */
461 const struct spi_controller_mem_ops *mem_ops;
462
463 /**
Simon Glassd7af6a42014-10-13 23:41:52 -0600464 * Set transfer speed.
465 * This sets a new speed to be applied for next spi_xfer().
466 * @bus: The SPI bus
467 * @hz: The transfer speed
468 * @return 0 if OK, -ve on error
469 */
470 int (*set_speed)(struct udevice *bus, uint hz);
471
472 /**
473 * Set the SPI mode/flags
474 *
475 * It is unclear if we want to set speed and mode together instead
476 * of separately.
477 *
478 * @bus: The SPI bus
479 * @mode: Requested SPI mode (SPI_... flags)
480 * @return 0 if OK, -ve on error
481 */
482 int (*set_mode)(struct udevice *bus, uint mode);
483
484 /**
485 * Get information on a chip select
486 *
487 * This is only called when the SPI uclass does not know about a
488 * chip select, i.e. it has no attached device. It gives the driver
489 * a chance to allow activity on that chip select even so.
490 *
491 * @bus: The SPI bus
492 * @cs: The chip select (0..n-1)
493 * @info: Returns information about the chip select, if valid.
494 * On entry info->dev is NULL
Bin Meng4b060002019-09-09 06:00:01 -0700495 * @return 0 if OK (and @info is set up), -EINVAL if the chip select
Simon Glassd7af6a42014-10-13 23:41:52 -0600496 * is invalid, other -ve value on error
497 */
498 int (*cs_info)(struct udevice *bus, uint cs, struct spi_cs_info *info);
Simon Glassc53b3182019-10-20 21:31:47 -0600499
500 /**
501 * get_mmap() - Get memory-mapped SPI
502 *
503 * @dev: The SPI flash slave device
504 * @map_basep: Returns base memory address for mapped SPI
505 * @map_sizep: Returns size of mapped SPI
506 * @offsetp: Returns start offset of SPI flash where the map works
507 * correctly (offsets before this are not visible)
508 * @return 0 if OK, -EFAULT if memory mapping is not available
509 */
510 int (*get_mmap)(struct udevice *dev, ulong *map_basep,
511 uint *map_sizep, uint *offsetp);
Simon Glassd7af6a42014-10-13 23:41:52 -0600512};
513
Simon Glassc60e1f22014-10-13 23:41:53 -0600514struct dm_spi_emul_ops {
515 /**
516 * SPI transfer
517 *
518 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
519 * clocks "bitlen" bits in the SPI MISO port. That's just the way SPI
520 * works. Here the device is a slave.
521 *
522 * The source of the outgoing bits is the "dout" parameter and the
523 * destination of the input bits is the "din" parameter. Note that
524 * "dout" and "din" can point to the same memory location, in which
525 * case the input data overwrites the output data (since both are
526 * buffered by temporary variables, this is OK).
527 *
528 * spi_xfer() interface:
529 * @slave: The SPI slave which will be sending/receiving the data.
530 * @bitlen: How many bits to write and read.
531 * @dout: Pointer to a string of bits sent to the device. The
532 * bits are held in a byte array and are sent MSB first.
533 * @din: Pointer to a string of bits that will be sent back to
534 * the master.
535 * @flags: A bitwise combination of SPI_XFER_* flags.
536 *
537 * Returns: 0 on success, not -1 on failure
538 */
539 int (*xfer)(struct udevice *slave, unsigned int bitlen,
540 const void *dout, void *din, unsigned long flags);
541};
542
Simon Glassd7af6a42014-10-13 23:41:52 -0600543/**
544 * spi_find_bus_and_cs() - Find bus and slave devices by number
545 *
546 * Given a bus number and chip select, this finds the corresponding bus
547 * device and slave device. Neither device is activated by this function,
548 * although they may have been activated previously.
549 *
550 * @busnum: SPI bus number
551 * @cs: Chip select to look for
552 * @busp: Returns bus device
553 * @devp: Return slave device
554 * @return 0 if found, -ENODEV on error
555 */
556int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
557 struct udevice **devp);
558
559/**
560 * spi_get_bus_and_cs() - Find and activate bus and slave devices by number
561 *
562 * Given a bus number and chip select, this finds the corresponding bus
563 * device and slave device.
564 *
565 * If no such slave exists, and drv_name is not NULL, then a new slave device
Patrick Delaunayb0cc1b82019-02-27 15:36:44 +0100566 * is automatically bound on this chip select with requested speed and mode.
Simon Glassd7af6a42014-10-13 23:41:52 -0600567 *
Patrick Delaunayb0cc1b82019-02-27 15:36:44 +0100568 * Ths new slave device is probed ready for use with the speed and mode
569 * from platdata when available or the requested values.
Simon Glassd7af6a42014-10-13 23:41:52 -0600570 *
571 * @busnum: SPI bus number
572 * @cs: Chip select to look for
Patrick Delaunayb0cc1b82019-02-27 15:36:44 +0100573 * @speed: SPI speed to use for this slave when not available in platdata
574 * @mode: SPI mode to use for this slave when not available in platdata
Simon Glassd7af6a42014-10-13 23:41:52 -0600575 * @drv_name: Name of driver to attach to this chip select
576 * @dev_name: Name of the new device thus created
577 * @busp: Returns bus device
578 * @devp: Return slave device
579 * @return 0 if found, -ve on error
580 */
581int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
582 const char *drv_name, const char *dev_name,
583 struct udevice **busp, struct spi_slave **devp);
584
585/**
586 * spi_chip_select() - Get the chip select for a slave
587 *
588 * @return the chip select this slave is attached to
589 */
590int spi_chip_select(struct udevice *slave);
591
592/**
Simon Glassff56bba2014-11-11 10:46:22 -0700593 * spi_find_chip_select() - Find the slave attached to chip select
594 *
595 * @bus: SPI bus to search
596 * @cs: Chip select to look for
597 * @devp: Returns the slave device if found
Bin Meng7bacce52019-09-09 06:00:02 -0700598 * @return 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached,
599 * other -ve value on error
Simon Glassff56bba2014-11-11 10:46:22 -0700600 */
601int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp);
602
603/**
Simon Glassd0cff032015-01-25 08:27:12 -0700604 * spi_slave_ofdata_to_platdata() - decode standard SPI platform data
Simon Glassd7af6a42014-10-13 23:41:52 -0600605 *
Simon Glassd0cff032015-01-25 08:27:12 -0700606 * This decodes the speed and mode for a slave from a device tree node
Simon Glassd7af6a42014-10-13 23:41:52 -0600607 *
608 * @blob: Device tree blob
609 * @node: Node offset to read from
Simon Glassd0cff032015-01-25 08:27:12 -0700610 * @plat: Place to put the decoded information
Simon Glassd7af6a42014-10-13 23:41:52 -0600611 */
Simon Glass279e26f2017-05-18 20:09:54 -0600612int spi_slave_ofdata_to_platdata(struct udevice *dev,
Simon Glassd0cff032015-01-25 08:27:12 -0700613 struct dm_spi_slave_platdata *plat);
Simon Glassd7af6a42014-10-13 23:41:52 -0600614
615/**
616 * spi_cs_info() - Check information on a chip select
617 *
618 * This checks a particular chip select on a bus to see if it has a device
619 * attached, or is even valid.
620 *
621 * @bus: The SPI bus
622 * @cs: The chip select (0..n-1)
623 * @info: Returns information about the chip select, if valid
624 * @return 0 if OK (and @info is set up), -ENODEV if the chip select
625 * is invalid, other -ve value on error
626 */
627int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info);
628
629struct sandbox_state;
Simon Glassc60e1f22014-10-13 23:41:53 -0600630
631/**
632 * sandbox_spi_get_emul() - get an emulator for a SPI slave
633 *
634 * This provides a way to attach an emulated SPI device to a particular SPI
635 * slave, so that xfer() operations on the slave will be handled by the
636 * emulator. If a emulator already exists on that chip select it is returned.
637 * Otherwise one is created.
638 *
639 * @state: Sandbox state
640 * @bus: SPI bus requesting the emulator
641 * @slave: SPI slave device requesting the emulator
642 * @emuip: Returns pointer to emulator
643 * @return 0 if OK, -ve on error
644 */
Simon Glassd7af6a42014-10-13 23:41:52 -0600645int sandbox_spi_get_emul(struct sandbox_state *state,
646 struct udevice *bus, struct udevice *slave,
647 struct udevice **emulp);
648
Peng Fan7a3eff42016-05-03 10:02:22 +0800649/**
650 * Claim the bus and prepare it for communication with a given slave.
651 *
652 * This must be called before doing any transfers with a SPI slave. It
653 * will enable and initialize any SPI hardware as necessary, and make
654 * sure that the SCK line is in the correct idle state. It is not
655 * allowed to claim the same bus for several slaves without releasing
656 * the bus in between.
657 *
658 * @dev: The SPI slave device
659 *
660 * Returns: 0 if the bus was claimed successfully, or a negative value
661 * if it wasn't.
662 */
663int dm_spi_claim_bus(struct udevice *dev);
664
665/**
666 * Release the SPI bus
667 *
668 * This must be called once for every call to dm_spi_claim_bus() after
669 * all transfers have finished. It may disable any SPI hardware as
670 * appropriate.
671 *
672 * @slave: The SPI slave device
673 */
674void dm_spi_release_bus(struct udevice *dev);
675
676/**
677 * SPI transfer
678 *
679 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
680 * "bitlen" bits in the SPI MISO port. That's just the way SPI works.
681 *
682 * The source of the outgoing bits is the "dout" parameter and the
683 * destination of the input bits is the "din" parameter. Note that "dout"
684 * and "din" can point to the same memory location, in which case the
685 * input data overwrites the output data (since both are buffered by
686 * temporary variables, this is OK).
687 *
688 * dm_spi_xfer() interface:
689 * @dev: The SPI slave device which will be sending/receiving the data.
690 * @bitlen: How many bits to write and read.
691 * @dout: Pointer to a string of bits to send out. The bits are
692 * held in a byte array and are sent MSB first.
693 * @din: Pointer to a string of bits that will be filled in.
694 * @flags: A bitwise combination of SPI_XFER_* flags.
695 *
696 * Returns: 0 on success, not 0 on failure
697 */
698int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
699 const void *dout, void *din, unsigned long flags);
700
Simon Glassc53b3182019-10-20 21:31:47 -0600701/**
702 * spi_get_mmap() - Get memory-mapped SPI
703 *
704 * @dev: SPI slave device to check
705 * @map_basep: Returns base memory address for mapped SPI
706 * @map_sizep: Returns size of mapped SPI
707 * @offsetp: Returns start offset of SPI flash where the map works
708 * correctly (offsets before this are not visible)
709 * @return 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not
710 * available
711 */
712int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
713 uint *offsetp);
714
Simon Glassbc5701e2015-04-20 12:37:12 -0600715/* Access the operations for a SPI device */
Simon Glassd7af6a42014-10-13 23:41:52 -0600716#define spi_get_ops(dev) ((struct dm_spi_ops *)(dev)->driver->ops)
Simon Glassc60e1f22014-10-13 23:41:53 -0600717#define spi_emul_get_ops(dev) ((struct dm_spi_emul_ops *)(dev)->driver->ops)
Simon Glassd7af6a42014-10-13 23:41:52 -0600718
wdenk77f85582002-09-26 02:01:47 +0000719#endif /* _SPI_H_ */