xref: /rk3399_rockchip-uboot/include/spi.h (revision 305d7e6eb355be2c9fdd766a19e8873f59ce6378)
177f85581Swdenk /*
2469146c0SJagannadha Sutradharudu Teki  * Common SPI Interface: Controller-specific definitions
3469146c0SJagannadha Sutradharudu Teki  *
477f85581Swdenk  * (C) Copyright 2001
577f85581Swdenk  * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
677f85581Swdenk  *
71a459660SWolfgang Denk  * SPDX-License-Identifier:	GPL-2.0+
877f85581Swdenk  */
977f85581Swdenk 
1077f85581Swdenk #ifndef _SPI_H_
1177f85581Swdenk #define _SPI_H_
1277f85581Swdenk 
13967efcaeSBoris Brezillon #include <common.h>
14967efcaeSBoris Brezillon 
1538254f45SGuennadi Liakhovetski /* SPI mode flags */
1629ee0262SJagan Teki #define SPI_CPHA	BIT(0)			/* clock phase */
1729ee0262SJagan Teki #define SPI_CPOL	BIT(1)			/* clock polarity */
1838254f45SGuennadi Liakhovetski #define SPI_MODE_0	(0|0)			/* (original MicroWire) */
1938254f45SGuennadi Liakhovetski #define SPI_MODE_1	(0|SPI_CPHA)
2038254f45SGuennadi Liakhovetski #define SPI_MODE_2	(SPI_CPOL|0)
2138254f45SGuennadi Liakhovetski #define SPI_MODE_3	(SPI_CPOL|SPI_CPHA)
2229ee0262SJagan Teki #define SPI_CS_HIGH	BIT(2)			/* CS active high */
2329ee0262SJagan Teki #define SPI_LSB_FIRST	BIT(3)			/* per-word bits-on-wire */
2429ee0262SJagan Teki #define SPI_3WIRE	BIT(4)			/* SI/SO signals shared */
2529ee0262SJagan Teki #define SPI_LOOP	BIT(5)			/* loopback mode */
2629ee0262SJagan Teki #define SPI_SLAVE	BIT(6)			/* slave mode */
2729ee0262SJagan Teki #define SPI_PREAMBLE	BIT(7)			/* Skip preamble bytes */
2829ee0262SJagan Teki #define SPI_TX_BYTE	BIT(8)			/* transmit with 1 wire byte */
292b11a41cSJagan Teki #define SPI_TX_DUAL	BIT(9)			/* transmit with 2 wires */
302b11a41cSJagan Teki #define SPI_TX_QUAD	BIT(10)			/* transmit with 4 wires */
3108fe9c29SJagan Teki #define SPI_RX_SLOW	BIT(11)			/* receive with 1 wire slow */
323ac48d0eSJagan Teki #define SPI_RX_DUAL	BIT(12)			/* receive with 2 wires */
333ac48d0eSJagan Teki #define SPI_RX_QUAD	BIT(13)			/* receive with 4 wires */
34*305d7e6eSVignesh Raghavendra #define SPI_TX_OCTAL	BIT(14)			/* transmit with 8 wires */
35*305d7e6eSVignesh Raghavendra #define SPI_RX_OCTAL	BIT(15)			/* receive with 8 wires */
36f5a32af5SJon Lin #define SPI_DMA_PREPARE	BIT(24)			/* dma transfer skip waiting idle */
374e09cc1eSJagannadha Sutradharudu Teki 
38bb786b84SRajeshwari Shinde /* Header byte that marks the start of the message */
39bb786b84SRajeshwari Shinde #define SPI_PREAMBLE_END_BYTE	0xec
40bb786b84SRajeshwari Shinde 
415753d09bSNikita Kiryanov #define SPI_DEFAULT_WORDLEN	8
425753d09bSNikita Kiryanov 
43d7af6a48SSimon Glass #ifdef CONFIG_DM_SPI
44d0cff03eSSimon Glass /* TODO(sjg@chromium.org): Remove this and use max_hz from struct spi_slave */
45d7af6a48SSimon Glass struct dm_spi_bus {
46d7af6a48SSimon Glass 	uint max_hz;
47d7af6a48SSimon Glass };
48d7af6a48SSimon Glass 
49d0cff03eSSimon Glass /**
50d0cff03eSSimon Glass  * struct dm_spi_platdata - platform data for all SPI slaves
51d0cff03eSSimon Glass  *
52d0cff03eSSimon Glass  * This describes a SPI slave, a child device of the SPI bus. To obtain this
53d0cff03eSSimon Glass  * struct from a spi_slave, use dev_get_parent_platdata(dev) or
54d0cff03eSSimon Glass  * dev_get_parent_platdata(slave->dev).
55d0cff03eSSimon Glass  *
56d0cff03eSSimon Glass  * This data is immuatable. Each time the device is probed, @max_hz and @mode
57d0cff03eSSimon Glass  * will be copied to struct spi_slave.
58d0cff03eSSimon Glass  *
59d0cff03eSSimon Glass  * @cs:		Chip select number (0..n-1)
60d0cff03eSSimon Glass  * @max_hz:	Maximum bus speed that this slave can tolerate
61d0cff03eSSimon Glass  * @mode:	SPI mode to use for this device (see SPI mode flags)
62d0cff03eSSimon Glass  */
63d0cff03eSSimon Glass struct dm_spi_slave_platdata {
64d0cff03eSSimon Glass 	unsigned int cs;
65d0cff03eSSimon Glass 	uint max_hz;
66d0cff03eSSimon Glass 	uint mode;
67d0cff03eSSimon Glass };
68d0cff03eSSimon Glass 
69d7af6a48SSimon Glass #endif /* CONFIG_DM_SPI */
70d7af6a48SSimon Glass 
711b1bd9a7SJagannadha Sutradharudu Teki /**
72ce22b922SJagannadha Sutradharudu Teki  * struct spi_slave - Representation of a SPI slave
73d255bb0eSHaavard Skinnemoen  *
74d7af6a48SSimon Glass  * For driver model this is the per-child data used by the SPI bus. It can
75bcbe3d15SSimon Glass  * be accessed using dev_get_parent_priv() on the slave device. The SPI uclass
76d0cff03eSSimon Glass  * sets uip per_child_auto_alloc_size to sizeof(struct spi_slave), and the
77d0cff03eSSimon Glass  * driver should not override it. Two platform data fields (max_hz and mode)
78d0cff03eSSimon Glass  * are copied into this structure to provide an initial value. This allows
79d0cff03eSSimon Glass  * them to be changed, since we should never change platform data in drivers.
80d7af6a48SSimon Glass  *
81d7af6a48SSimon Glass  * If not using driver model, drivers are expected to extend this with
82d7af6a48SSimon Glass  * controller-specific data.
83d7af6a48SSimon Glass  *
84d7af6a48SSimon Glass  * @dev:		SPI slave device
85d7af6a48SSimon Glass  * @max_hz:		Maximum speed for this slave
8660e2809aSSimon Glass  * @speed:		Current bus speed. This is 0 until the bus is first
8760e2809aSSimon Glass  *			claimed.
88d7af6a48SSimon Glass  * @bus:		ID of the bus that the slave is attached to. For
89d7af6a48SSimon Glass  *			driver model this is the sequence number of the SPI
90d7af6a48SSimon Glass  *			bus (bus->seq) so does not need to be stored
91ce22b922SJagannadha Sutradharudu Teki  * @cs:			ID of the chip select connected to the slave.
92f5c3c033SJagan Teki  * @mode:		SPI mode to use for this slave (see SPI mode flags)
935753d09bSNikita Kiryanov  * @wordlen:		Size of SPI word in number of bits
94d68b9b84SÁlvaro Fernández Rojas  * @max_read_size:	If non-zero, the maximum number of bytes which can
95d68b9b84SÁlvaro Fernández Rojas  *			be read at once.
96ce22b922SJagannadha Sutradharudu Teki  * @max_write_size:	If non-zero, the maximum number of bytes which can
97d2a88c91SÁlvaro Fernández Rojas  *			be written at once.
98ce22b922SJagannadha Sutradharudu Teki  * @memory_map:		Address of read-only SPI flash access.
99f77f4691SJagannadha Sutradharudu Teki  * @flags:		Indication of SPI flags.
100d255bb0eSHaavard Skinnemoen  */
101d255bb0eSHaavard Skinnemoen struct spi_slave {
102d7af6a48SSimon Glass #ifdef CONFIG_DM_SPI
103d7af6a48SSimon Glass 	struct udevice *dev;	/* struct spi_slave is dev->parentdata */
104d7af6a48SSimon Glass 	uint max_hz;
10560e2809aSSimon Glass 	uint speed;
106d7af6a48SSimon Glass #else
107d255bb0eSHaavard Skinnemoen 	unsigned int bus;
108d255bb0eSHaavard Skinnemoen 	unsigned int cs;
109d0cff03eSSimon Glass #endif
110f5c3c033SJagan Teki 	uint mode;
1115753d09bSNikita Kiryanov 	unsigned int wordlen;
112d68b9b84SÁlvaro Fernández Rojas 	unsigned int max_read_size;
1130c456ceeSSimon Glass 	unsigned int max_write_size;
114004f15b6SPoddar, Sourav 	void *memory_map;
115f77f4691SJagannadha Sutradharudu Teki 	u8 option;
116c40f6003SJagan Teki 
117f77f4691SJagannadha Sutradharudu Teki 	u8 flags;
11829ee0262SJagan Teki #define SPI_XFER_BEGIN		BIT(0)	/* Assert CS before transfer */
11929ee0262SJagan Teki #define SPI_XFER_END		BIT(1)	/* Deassert CS after transfer */
120c40f6003SJagan Teki #define SPI_XFER_ONCE		(SPI_XFER_BEGIN | SPI_XFER_END)
12129ee0262SJagan Teki #define SPI_XFER_MMAP		BIT(2)	/* Memory Mapped start */
12229ee0262SJagan Teki #define SPI_XFER_MMAP_END	BIT(3)	/* Memory Mapped End */
123f5a32af5SJon Lin #define SPI_XFER_PREPARE	BIT(7)	/* Transfer skip waiting idle */
124d255bb0eSHaavard Skinnemoen };
12577f85581Swdenk 
1261b1bd9a7SJagannadha Sutradharudu Teki /**
12777f85581Swdenk  * Initialization, must be called once on start up.
128d255bb0eSHaavard Skinnemoen  *
129d255bb0eSHaavard Skinnemoen  * TODO: I don't think we really need this.
13077f85581Swdenk  */
13177f85581Swdenk void spi_init(void);
13277f85581Swdenk 
133ba6c3ce9SSimon Glass /**
134ba6c3ce9SSimon Glass  * spi_do_alloc_slave - Allocate a new SPI slave (internal)
135ba6c3ce9SSimon Glass  *
136ba6c3ce9SSimon Glass  * Allocate and zero all fields in the spi slave, and set the bus/chip
137ba6c3ce9SSimon Glass  * select. Use the helper macro spi_alloc_slave() to call this.
138ba6c3ce9SSimon Glass  *
1391b1bd9a7SJagannadha Sutradharudu Teki  * @offset:	Offset of struct spi_slave within slave structure.
1401b1bd9a7SJagannadha Sutradharudu Teki  * @size:	Size of slave structure.
141ba6c3ce9SSimon Glass  * @bus:	Bus ID of the slave chip.
142ba6c3ce9SSimon Glass  * @cs:		Chip select ID of the slave chip on the specified bus.
143ba6c3ce9SSimon Glass  */
144ba6c3ce9SSimon Glass void *spi_do_alloc_slave(int offset, int size, unsigned int bus,
145ba6c3ce9SSimon Glass 			 unsigned int cs);
146ba6c3ce9SSimon Glass 
147ba6c3ce9SSimon Glass /**
148ba6c3ce9SSimon Glass  * spi_alloc_slave - Allocate a new SPI slave
149ba6c3ce9SSimon Glass  *
150ba6c3ce9SSimon Glass  * Allocate and zero all fields in the spi slave, and set the bus/chip
151ba6c3ce9SSimon Glass  * select.
152ba6c3ce9SSimon Glass  *
1531b1bd9a7SJagannadha Sutradharudu Teki  * @_struct:	Name of structure to allocate (e.g. struct tegra_spi).
1541b1bd9a7SJagannadha Sutradharudu Teki  *		This structure must contain a member 'struct spi_slave *slave'.
155ba6c3ce9SSimon Glass  * @bus:	Bus ID of the slave chip.
156ba6c3ce9SSimon Glass  * @cs:		Chip select ID of the slave chip on the specified bus.
157ba6c3ce9SSimon Glass  */
158ba6c3ce9SSimon Glass #define spi_alloc_slave(_struct, bus, cs) \
159ba6c3ce9SSimon Glass 	spi_do_alloc_slave(offsetof(_struct, slave), \
160ba6c3ce9SSimon Glass 			    sizeof(_struct), bus, cs)
161ba6c3ce9SSimon Glass 
162ba6c3ce9SSimon Glass /**
163ba6c3ce9SSimon Glass  * spi_alloc_slave_base - Allocate a new SPI slave with no private data
164ba6c3ce9SSimon Glass  *
165ba6c3ce9SSimon Glass  * Allocate and zero all fields in the spi slave, and set the bus/chip
166ba6c3ce9SSimon Glass  * select.
167ba6c3ce9SSimon Glass  *
168ba6c3ce9SSimon Glass  * @bus:	Bus ID of the slave chip.
169ba6c3ce9SSimon Glass  * @cs:		Chip select ID of the slave chip on the specified bus.
170ba6c3ce9SSimon Glass  */
171ba6c3ce9SSimon Glass #define spi_alloc_slave_base(bus, cs) \
172ba6c3ce9SSimon Glass 	spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs)
173ba6c3ce9SSimon Glass 
1741b1bd9a7SJagannadha Sutradharudu Teki /**
175d255bb0eSHaavard Skinnemoen  * Set up communications parameters for a SPI slave.
176d255bb0eSHaavard Skinnemoen  *
177d255bb0eSHaavard Skinnemoen  * This must be called once for each slave. Note that this function
178d255bb0eSHaavard Skinnemoen  * usually doesn't touch any actual hardware, it only initializes the
179d255bb0eSHaavard Skinnemoen  * contents of spi_slave so that the hardware can be easily
180d255bb0eSHaavard Skinnemoen  * initialized later.
181d255bb0eSHaavard Skinnemoen  *
1821b1bd9a7SJagannadha Sutradharudu Teki  * @bus:	Bus ID of the slave chip.
1831b1bd9a7SJagannadha Sutradharudu Teki  * @cs:		Chip select ID of the slave chip on the specified bus.
1841b1bd9a7SJagannadha Sutradharudu Teki  * @max_hz:	Maximum SCK rate in Hz.
1851b1bd9a7SJagannadha Sutradharudu Teki  * @mode:	Clock polarity, clock phase and other parameters.
186d255bb0eSHaavard Skinnemoen  *
187d255bb0eSHaavard Skinnemoen  * Returns: A spi_slave reference that can be used in subsequent SPI
188d255bb0eSHaavard Skinnemoen  * calls, or NULL if one or more of the parameters are not supported.
189d255bb0eSHaavard Skinnemoen  */
190d255bb0eSHaavard Skinnemoen struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
191d255bb0eSHaavard Skinnemoen 		unsigned int max_hz, unsigned int mode);
192d255bb0eSHaavard Skinnemoen 
1931b1bd9a7SJagannadha Sutradharudu Teki /**
194d255bb0eSHaavard Skinnemoen  * Free any memory associated with a SPI slave.
195d255bb0eSHaavard Skinnemoen  *
1961b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave
197d255bb0eSHaavard Skinnemoen  */
198d255bb0eSHaavard Skinnemoen void spi_free_slave(struct spi_slave *slave);
199d255bb0eSHaavard Skinnemoen 
2001b1bd9a7SJagannadha Sutradharudu Teki /**
201d255bb0eSHaavard Skinnemoen  * Claim the bus and prepare it for communication with a given slave.
202d255bb0eSHaavard Skinnemoen  *
203d255bb0eSHaavard Skinnemoen  * This must be called before doing any transfers with a SPI slave. It
204d255bb0eSHaavard Skinnemoen  * will enable and initialize any SPI hardware as necessary, and make
205d255bb0eSHaavard Skinnemoen  * sure that the SCK line is in the correct idle state. It is not
206d255bb0eSHaavard Skinnemoen  * allowed to claim the same bus for several slaves without releasing
207d255bb0eSHaavard Skinnemoen  * the bus in between.
208d255bb0eSHaavard Skinnemoen  *
2091b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave
210d255bb0eSHaavard Skinnemoen  *
211d255bb0eSHaavard Skinnemoen  * Returns: 0 if the bus was claimed successfully, or a negative value
212d255bb0eSHaavard Skinnemoen  * if it wasn't.
213d255bb0eSHaavard Skinnemoen  */
214d255bb0eSHaavard Skinnemoen int spi_claim_bus(struct spi_slave *slave);
215d255bb0eSHaavard Skinnemoen 
2161b1bd9a7SJagannadha Sutradharudu Teki /**
217d255bb0eSHaavard Skinnemoen  * Release the SPI bus
218d255bb0eSHaavard Skinnemoen  *
219d255bb0eSHaavard Skinnemoen  * This must be called once for every call to spi_claim_bus() after
220d255bb0eSHaavard Skinnemoen  * all transfers have finished. It may disable any SPI hardware as
221d255bb0eSHaavard Skinnemoen  * appropriate.
222d255bb0eSHaavard Skinnemoen  *
2231b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave
224d255bb0eSHaavard Skinnemoen  */
225d255bb0eSHaavard Skinnemoen void spi_release_bus(struct spi_slave *slave);
22677f85581Swdenk 
2271b1bd9a7SJagannadha Sutradharudu Teki /**
2285753d09bSNikita Kiryanov  * Set the word length for SPI transactions
2295753d09bSNikita Kiryanov  *
2305753d09bSNikita Kiryanov  * Set the word length (number of bits per word) for SPI transactions.
2315753d09bSNikita Kiryanov  *
2325753d09bSNikita Kiryanov  * @slave:	The SPI slave
2335753d09bSNikita Kiryanov  * @wordlen:	The number of bits in a word
2345753d09bSNikita Kiryanov  *
2355753d09bSNikita Kiryanov  * Returns: 0 on success, -1 on failure.
2365753d09bSNikita Kiryanov  */
2375753d09bSNikita Kiryanov int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen);
2385753d09bSNikita Kiryanov 
2395753d09bSNikita Kiryanov /**
240f75b9e50SSimon Glass  * SPI transfer (optional if mem_ops is used)
24177f85581Swdenk  *
24277f85581Swdenk  * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
24377f85581Swdenk  * "bitlen" bits in the SPI MISO port.  That's just the way SPI works.
24477f85581Swdenk  *
24577f85581Swdenk  * The source of the outgoing bits is the "dout" parameter and the
24677f85581Swdenk  * destination of the input bits is the "din" parameter.  Note that "dout"
24777f85581Swdenk  * and "din" can point to the same memory location, in which case the
24877f85581Swdenk  * input data overwrites the output data (since both are buffered by
24977f85581Swdenk  * temporary variables, this is OK).
25077f85581Swdenk  *
25177f85581Swdenk  * spi_xfer() interface:
2521b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave which will be sending/receiving the data.
2531b1bd9a7SJagannadha Sutradharudu Teki  * @bitlen:	How many bits to write and read.
2541b1bd9a7SJagannadha Sutradharudu Teki  * @dout:	Pointer to a string of bits to send out.  The bits are
25577f85581Swdenk  *		held in a byte array and are sent MSB first.
2561b1bd9a7SJagannadha Sutradharudu Teki  * @din:	Pointer to a string of bits that will be filled in.
2571b1bd9a7SJagannadha Sutradharudu Teki  * @flags:	A bitwise combination of SPI_XFER_* flags.
25877f85581Swdenk  *
25977f85581Swdenk  * Returns: 0 on success, not 0 on failure
26077f85581Swdenk  */
261d255bb0eSHaavard Skinnemoen int  spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
262d255bb0eSHaavard Skinnemoen 		void *din, unsigned long flags);
26377f85581Swdenk 
264a3171fa3SJagan Teki /**
265a3171fa3SJagan Teki  * spi_write_then_read - SPI synchronous write followed by read
266a3171fa3SJagan Teki  *
267a3171fa3SJagan Teki  * This performs a half duplex transaction in which the first transaction
268a3171fa3SJagan Teki  * is to send the opcode and if the length of buf is non-zero then it start
269a3171fa3SJagan Teki  * the second transaction as tx or rx based on the need from respective slave.
270a3171fa3SJagan Teki  *
271a3171fa3SJagan Teki  * @slave:	The SPI slave device with which opcode/data will be exchanged
272a3171fa3SJagan Teki  * @opcode:	opcode used for specific transfer
273a3171fa3SJagan Teki  * @n_opcode:	size of opcode, in bytes
274a3171fa3SJagan Teki  * @txbuf:	buffer into which data to be written
275a3171fa3SJagan Teki  * @rxbuf:	buffer into which data will be read
276a3171fa3SJagan Teki  * @n_buf:	size of buf (whether it's [tx|rx]buf), in bytes
277a3171fa3SJagan Teki  *
278a3171fa3SJagan Teki  * Returns: 0 on success, not 0 on failure
279a3171fa3SJagan Teki  */
280a3171fa3SJagan Teki int spi_write_then_read(struct spi_slave *slave, const u8 *opcode,
281a3171fa3SJagan Teki 			size_t n_opcode, const u8 *txbuf, u8 *rxbuf,
282a3171fa3SJagan Teki 			size_t n_buf);
283a3171fa3SJagan Teki 
284146bad96STom Rini /* Copy memory mapped data */
285146bad96STom Rini void spi_flash_copy_mmap(void *data, void *offset, size_t len);
286146bad96STom Rini 
2871b1bd9a7SJagannadha Sutradharudu Teki /**
288d255bb0eSHaavard Skinnemoen  * Determine if a SPI chipselect is valid.
289d255bb0eSHaavard Skinnemoen  * This function is provided by the board if the low-level SPI driver
290d255bb0eSHaavard Skinnemoen  * needs it to determine if a given chipselect is actually valid.
291d255bb0eSHaavard Skinnemoen  *
292d255bb0eSHaavard Skinnemoen  * Returns: 1 if bus:cs identifies a valid chip on this board, 0
293d255bb0eSHaavard Skinnemoen  * otherwise.
294d255bb0eSHaavard Skinnemoen  */
295d255bb0eSHaavard Skinnemoen int spi_cs_is_valid(unsigned int bus, unsigned int cs);
296d255bb0eSHaavard Skinnemoen 
297d7af6a48SSimon Glass #ifndef CONFIG_DM_SPI
2981b1bd9a7SJagannadha Sutradharudu Teki /**
299d255bb0eSHaavard Skinnemoen  * Activate a SPI chipselect.
300d255bb0eSHaavard Skinnemoen  * This function is provided by the board code when using a driver
301d255bb0eSHaavard Skinnemoen  * that can't control its chipselects automatically (e.g.
302d255bb0eSHaavard Skinnemoen  * common/soft_spi.c). When called, it should activate the chip select
303d255bb0eSHaavard Skinnemoen  * to the device identified by "slave".
304d255bb0eSHaavard Skinnemoen  */
305d255bb0eSHaavard Skinnemoen void spi_cs_activate(struct spi_slave *slave);
306d255bb0eSHaavard Skinnemoen 
3071b1bd9a7SJagannadha Sutradharudu Teki /**
308d255bb0eSHaavard Skinnemoen  * Deactivate a SPI chipselect.
309d255bb0eSHaavard Skinnemoen  * This function is provided by the board code when using a driver
310d255bb0eSHaavard Skinnemoen  * that can't control its chipselects automatically (e.g.
311d255bb0eSHaavard Skinnemoen  * common/soft_spi.c). When called, it should deactivate the chip
312d255bb0eSHaavard Skinnemoen  * select to the device identified by "slave".
313d255bb0eSHaavard Skinnemoen  */
314d255bb0eSHaavard Skinnemoen void spi_cs_deactivate(struct spi_slave *slave);
315d255bb0eSHaavard Skinnemoen 
3161b1bd9a7SJagannadha Sutradharudu Teki /**
317fa1423e7SThomas Chou  * Set transfer speed.
318fa1423e7SThomas Chou  * This sets a new speed to be applied for next spi_xfer().
3191b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave
3201b1bd9a7SJagannadha Sutradharudu Teki  * @hz:		The transfer speed
321fa1423e7SThomas Chou  */
322fa1423e7SThomas Chou void spi_set_speed(struct spi_slave *slave, uint hz);
323d7af6a48SSimon Glass #endif
324fa1423e7SThomas Chou 
3251b1bd9a7SJagannadha Sutradharudu Teki /**
326d255bb0eSHaavard Skinnemoen  * Write 8 bits, then read 8 bits.
3271b1bd9a7SJagannadha Sutradharudu Teki  * @slave:	The SPI slave we're communicating with
3281b1bd9a7SJagannadha Sutradharudu Teki  * @byte:	Byte to be written
329d255bb0eSHaavard Skinnemoen  *
330d255bb0eSHaavard Skinnemoen  * Returns: The value that was read, or a negative value on error.
331d255bb0eSHaavard Skinnemoen  *
332d255bb0eSHaavard Skinnemoen  * TODO: This function probably shouldn't be inlined.
333d255bb0eSHaavard Skinnemoen  */
334d255bb0eSHaavard Skinnemoen static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte)
335d255bb0eSHaavard Skinnemoen {
336d255bb0eSHaavard Skinnemoen 	unsigned char dout[2];
337d255bb0eSHaavard Skinnemoen 	unsigned char din[2];
338d255bb0eSHaavard Skinnemoen 	int ret;
339d255bb0eSHaavard Skinnemoen 
340d255bb0eSHaavard Skinnemoen 	dout[0] = byte;
341d255bb0eSHaavard Skinnemoen 	dout[1] = 0;
342d255bb0eSHaavard Skinnemoen 
343d255bb0eSHaavard Skinnemoen 	ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END);
344d255bb0eSHaavard Skinnemoen 	return ret < 0 ? ret : din[1];
345d255bb0eSHaavard Skinnemoen }
34638254f45SGuennadi Liakhovetski 
347d7af6a48SSimon Glass #ifdef CONFIG_DM_SPI
348d7af6a48SSimon Glass 
349d7af6a48SSimon Glass /**
350d7af6a48SSimon Glass  * struct spi_cs_info - Information about a bus chip select
351d7af6a48SSimon Glass  *
352d7af6a48SSimon Glass  * @dev:	Connected device, or NULL if none
353d7af6a48SSimon Glass  */
354d7af6a48SSimon Glass struct spi_cs_info {
355d7af6a48SSimon Glass 	struct udevice *dev;
356d7af6a48SSimon Glass };
357d7af6a48SSimon Glass 
358d7af6a48SSimon Glass /**
359d7af6a48SSimon Glass  * struct struct dm_spi_ops - Driver model SPI operations
360d7af6a48SSimon Glass  *
361d7af6a48SSimon Glass  * The uclass interface is implemented by all SPI devices which use
362d7af6a48SSimon Glass  * driver model.
363d7af6a48SSimon Glass  */
364d7af6a48SSimon Glass struct dm_spi_ops {
365d7af6a48SSimon Glass 	/**
366d7af6a48SSimon Glass 	 * Claim the bus and prepare it for communication.
367d7af6a48SSimon Glass 	 *
368d7af6a48SSimon Glass 	 * The device provided is the slave device. It's parent controller
369d7af6a48SSimon Glass 	 * will be used to provide the communication.
370d7af6a48SSimon Glass 	 *
371d7af6a48SSimon Glass 	 * This must be called before doing any transfers with a SPI slave. It
372d7af6a48SSimon Glass 	 * will enable and initialize any SPI hardware as necessary, and make
373d7af6a48SSimon Glass 	 * sure that the SCK line is in the correct idle state. It is not
374d7af6a48SSimon Glass 	 * allowed to claim the same bus for several slaves without releasing
375d7af6a48SSimon Glass 	 * the bus in between.
376d7af6a48SSimon Glass 	 *
3779694b724SSimon Glass 	 * @dev:	The SPI slave
378d7af6a48SSimon Glass 	 *
379d7af6a48SSimon Glass 	 * Returns: 0 if the bus was claimed successfully, or a negative value
380d7af6a48SSimon Glass 	 * if it wasn't.
381d7af6a48SSimon Glass 	 */
3829694b724SSimon Glass 	int (*claim_bus)(struct udevice *dev);
383d7af6a48SSimon Glass 
384d7af6a48SSimon Glass 	/**
385d7af6a48SSimon Glass 	 * Release the SPI bus
386d7af6a48SSimon Glass 	 *
387d7af6a48SSimon Glass 	 * This must be called once for every call to spi_claim_bus() after
388d7af6a48SSimon Glass 	 * all transfers have finished. It may disable any SPI hardware as
389d7af6a48SSimon Glass 	 * appropriate.
390d7af6a48SSimon Glass 	 *
3919694b724SSimon Glass 	 * @dev:	The SPI slave
392d7af6a48SSimon Glass 	 */
3939694b724SSimon Glass 	int (*release_bus)(struct udevice *dev);
394d7af6a48SSimon Glass 
395d7af6a48SSimon Glass 	/**
396d7af6a48SSimon Glass 	 * Set the word length for SPI transactions
397d7af6a48SSimon Glass 	 *
398d7af6a48SSimon Glass 	 * Set the word length (number of bits per word) for SPI transactions.
399d7af6a48SSimon Glass 	 *
400d7af6a48SSimon Glass 	 * @bus:	The SPI slave
401d7af6a48SSimon Glass 	 * @wordlen:	The number of bits in a word
402d7af6a48SSimon Glass 	 *
403d7af6a48SSimon Glass 	 * Returns: 0 on success, -ve on failure.
404d7af6a48SSimon Glass 	 */
4059694b724SSimon Glass 	int (*set_wordlen)(struct udevice *dev, unsigned int wordlen);
406d7af6a48SSimon Glass 
407d7af6a48SSimon Glass 	/**
408d7af6a48SSimon Glass 	 * SPI transfer
409d7af6a48SSimon Glass 	 *
410d7af6a48SSimon Glass 	 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
411d7af6a48SSimon Glass 	 * clocks "bitlen" bits in the SPI MISO port.  That's just the way SPI
412d7af6a48SSimon Glass 	 * works.
413d7af6a48SSimon Glass 	 *
414d7af6a48SSimon Glass 	 * The source of the outgoing bits is the "dout" parameter and the
415d7af6a48SSimon Glass 	 * destination of the input bits is the "din" parameter.  Note that
416d7af6a48SSimon Glass 	 * "dout" and "din" can point to the same memory location, in which
417d7af6a48SSimon Glass 	 * case the input data overwrites the output data (since both are
418d7af6a48SSimon Glass 	 * buffered by temporary variables, this is OK).
419d7af6a48SSimon Glass 	 *
420d7af6a48SSimon Glass 	 * spi_xfer() interface:
421d7af6a48SSimon Glass 	 * @dev:	The slave device to communicate with
422d7af6a48SSimon Glass 	 * @bitlen:	How many bits to write and read.
423d7af6a48SSimon Glass 	 * @dout:	Pointer to a string of bits to send out.  The bits are
424d7af6a48SSimon Glass 	 *		held in a byte array and are sent MSB first.
425d7af6a48SSimon Glass 	 * @din:	Pointer to a string of bits that will be filled in.
426d7af6a48SSimon Glass 	 * @flags:	A bitwise combination of SPI_XFER_* flags.
427d7af6a48SSimon Glass 	 *
428d7af6a48SSimon Glass 	 * Returns: 0 on success, not -1 on failure
429d7af6a48SSimon Glass 	 */
430d7af6a48SSimon Glass 	int (*xfer)(struct udevice *dev, unsigned int bitlen, const void *dout,
431d7af6a48SSimon Glass 		    void *din, unsigned long flags);
432d7af6a48SSimon Glass 
433d7af6a48SSimon Glass 	/**
434967efcaeSBoris Brezillon 	 * Optimized handlers for SPI memory-like operations.
435967efcaeSBoris Brezillon 	 *
436967efcaeSBoris Brezillon 	 * Optimized/dedicated operations for interactions with SPI memory. This
437967efcaeSBoris Brezillon 	 * field is optional and should only be implemented if the controller
438967efcaeSBoris Brezillon 	 * has native support for memory like operations.
439967efcaeSBoris Brezillon 	 */
440967efcaeSBoris Brezillon 	const struct spi_controller_mem_ops *mem_ops;
441967efcaeSBoris Brezillon 
442967efcaeSBoris Brezillon 	/**
443d7af6a48SSimon Glass 	 * Set transfer speed.
444d7af6a48SSimon Glass 	 * This sets a new speed to be applied for next spi_xfer().
445d7af6a48SSimon Glass 	 * @bus:	The SPI bus
446d7af6a48SSimon Glass 	 * @hz:		The transfer speed
447d7af6a48SSimon Glass 	 * @return 0 if OK, -ve on error
448d7af6a48SSimon Glass 	 */
449d7af6a48SSimon Glass 	int (*set_speed)(struct udevice *bus, uint hz);
450d7af6a48SSimon Glass 
451d7af6a48SSimon Glass 	/**
452d7af6a48SSimon Glass 	 * Set the SPI mode/flags
453d7af6a48SSimon Glass 	 *
454d7af6a48SSimon Glass 	 * It is unclear if we want to set speed and mode together instead
455d7af6a48SSimon Glass 	 * of separately.
456d7af6a48SSimon Glass 	 *
457d7af6a48SSimon Glass 	 * @bus:	The SPI bus
458d7af6a48SSimon Glass 	 * @mode:	Requested SPI mode (SPI_... flags)
459d7af6a48SSimon Glass 	 * @return 0 if OK, -ve on error
460d7af6a48SSimon Glass 	 */
461d7af6a48SSimon Glass 	int (*set_mode)(struct udevice *bus, uint mode);
462d7af6a48SSimon Glass 
463d7af6a48SSimon Glass 	/**
464d7af6a48SSimon Glass 	 * Get information on a chip select
465d7af6a48SSimon Glass 	 *
466d7af6a48SSimon Glass 	 * This is only called when the SPI uclass does not know about a
467d7af6a48SSimon Glass 	 * chip select, i.e. it has no attached device. It gives the driver
468d7af6a48SSimon Glass 	 * a chance to allow activity on that chip select even so.
469d7af6a48SSimon Glass 	 *
470d7af6a48SSimon Glass 	 * @bus:	The SPI bus
471d7af6a48SSimon Glass 	 * @cs:		The chip select (0..n-1)
472d7af6a48SSimon Glass 	 * @info:	Returns information about the chip select, if valid.
473d7af6a48SSimon Glass 	 *		On entry info->dev is NULL
474d7af6a48SSimon Glass 	 * @return 0 if OK (and @info is set up), -ENODEV if the chip select
475d7af6a48SSimon Glass 	 *	   is invalid, other -ve value on error
476d7af6a48SSimon Glass 	 */
477d7af6a48SSimon Glass 	int (*cs_info)(struct udevice *bus, uint cs, struct spi_cs_info *info);
4787ac3b0edSSimon Glass 
4797ac3b0edSSimon Glass 	/**
4807ac3b0edSSimon Glass 	 * get_mmap() - Get memory-mapped SPI
4817ac3b0edSSimon Glass 	 *
4827ac3b0edSSimon Glass 	 * @dev:	The SPI flash slave device
4837ac3b0edSSimon Glass 	 * @map_basep:	Returns base memory address for mapped SPI
4847ac3b0edSSimon Glass 	 * @map_sizep:	Returns size of mapped SPI
4857ac3b0edSSimon Glass 	 * @offsetp:	Returns start offset of SPI flash where the map works
4867ac3b0edSSimon Glass 	 *	correctly (offsets before this are not visible)
4877ac3b0edSSimon Glass 	 * @return 0 if OK, -EFAULT if memory mapping is not available
4887ac3b0edSSimon Glass 	 */
4897ac3b0edSSimon Glass 	int (*get_mmap)(struct udevice *dev, ulong *map_basep,
4907ac3b0edSSimon Glass 			uint *map_sizep, uint *offsetp);
491d7af6a48SSimon Glass };
492d7af6a48SSimon Glass 
493c60e1f25SSimon Glass struct dm_spi_emul_ops {
494c60e1f25SSimon Glass 	/**
495c60e1f25SSimon Glass 	 * SPI transfer
496c60e1f25SSimon Glass 	 *
497c60e1f25SSimon Glass 	 * This writes "bitlen" bits out the SPI MOSI port and simultaneously
498c60e1f25SSimon Glass 	 * clocks "bitlen" bits in the SPI MISO port.  That's just the way SPI
499c60e1f25SSimon Glass 	 * works. Here the device is a slave.
500c60e1f25SSimon Glass 	 *
501c60e1f25SSimon Glass 	 * The source of the outgoing bits is the "dout" parameter and the
502c60e1f25SSimon Glass 	 * destination of the input bits is the "din" parameter.  Note that
503c60e1f25SSimon Glass 	 * "dout" and "din" can point to the same memory location, in which
504c60e1f25SSimon Glass 	 * case the input data overwrites the output data (since both are
505c60e1f25SSimon Glass 	 * buffered by temporary variables, this is OK).
506c60e1f25SSimon Glass 	 *
507c60e1f25SSimon Glass 	 * spi_xfer() interface:
508c60e1f25SSimon Glass 	 * @slave:	The SPI slave which will be sending/receiving the data.
509c60e1f25SSimon Glass 	 * @bitlen:	How many bits to write and read.
510c60e1f25SSimon Glass 	 * @dout:	Pointer to a string of bits sent to the device. The
511c60e1f25SSimon Glass 	 *		bits are held in a byte array and are sent MSB first.
512c60e1f25SSimon Glass 	 * @din:	Pointer to a string of bits that will be sent back to
513c60e1f25SSimon Glass 	 *		the master.
514c60e1f25SSimon Glass 	 * @flags:	A bitwise combination of SPI_XFER_* flags.
515c60e1f25SSimon Glass 	 *
516c60e1f25SSimon Glass 	 * Returns: 0 on success, not -1 on failure
517c60e1f25SSimon Glass 	 */
518c60e1f25SSimon Glass 	int (*xfer)(struct udevice *slave, unsigned int bitlen,
519c60e1f25SSimon Glass 		    const void *dout, void *din, unsigned long flags);
520c60e1f25SSimon Glass };
521c60e1f25SSimon Glass 
522d7af6a48SSimon Glass /**
523d7af6a48SSimon Glass  * spi_find_bus_and_cs() - Find bus and slave devices by number
524d7af6a48SSimon Glass  *
525d7af6a48SSimon Glass  * Given a bus number and chip select, this finds the corresponding bus
526d7af6a48SSimon Glass  * device and slave device. Neither device is activated by this function,
527d7af6a48SSimon Glass  * although they may have been activated previously.
528d7af6a48SSimon Glass  *
529d7af6a48SSimon Glass  * @busnum:	SPI bus number
530d7af6a48SSimon Glass  * @cs:		Chip select to look for
531d7af6a48SSimon Glass  * @busp:	Returns bus device
532d7af6a48SSimon Glass  * @devp:	Return slave device
533d7af6a48SSimon Glass  * @return 0 if found, -ENODEV on error
534d7af6a48SSimon Glass  */
535d7af6a48SSimon Glass int spi_find_bus_and_cs(int busnum, int cs, struct udevice **busp,
536d7af6a48SSimon Glass 			struct udevice **devp);
537d7af6a48SSimon Glass 
538d7af6a48SSimon Glass /**
539d7af6a48SSimon Glass  * spi_get_bus_and_cs() - Find and activate bus and slave devices by number
540d7af6a48SSimon Glass  *
541d7af6a48SSimon Glass  * Given a bus number and chip select, this finds the corresponding bus
542d7af6a48SSimon Glass  * device and slave device.
543d7af6a48SSimon Glass  *
544d7af6a48SSimon Glass  * If no such slave exists, and drv_name is not NULL, then a new slave device
545ee9b3572SPatrick Delaunay  * is automatically bound on this chip select with requested speed and mode.
546d7af6a48SSimon Glass  *
547ee9b3572SPatrick Delaunay  * Ths new slave device is probed ready for use with the speed and mode
548ee9b3572SPatrick Delaunay  * from platdata when available or the requested values.
549d7af6a48SSimon Glass  *
550d7af6a48SSimon Glass  * @busnum:	SPI bus number
551d7af6a48SSimon Glass  * @cs:		Chip select to look for
552ee9b3572SPatrick Delaunay  * @speed:	SPI speed to use for this slave when not available in platdata
553ee9b3572SPatrick Delaunay  * @mode:	SPI mode to use for this slave when not available in platdata
554d7af6a48SSimon Glass  * @drv_name:	Name of driver to attach to this chip select
555d7af6a48SSimon Glass  * @dev_name:	Name of the new device thus created
556d7af6a48SSimon Glass  * @busp:	Returns bus device
557d7af6a48SSimon Glass  * @devp:	Return slave device
558d7af6a48SSimon Glass  * @return 0 if found, -ve on error
559d7af6a48SSimon Glass  */
560d7af6a48SSimon Glass int spi_get_bus_and_cs(int busnum, int cs, int speed, int mode,
561d7af6a48SSimon Glass 			const char *drv_name, const char *dev_name,
562d7af6a48SSimon Glass 			struct udevice **busp, struct spi_slave **devp);
563d7af6a48SSimon Glass 
564d7af6a48SSimon Glass /**
565d7af6a48SSimon Glass  * spi_chip_select() - Get the chip select for a slave
566d7af6a48SSimon Glass  *
567d7af6a48SSimon Glass  * @return the chip select this slave is attached to
568d7af6a48SSimon Glass  */
569d7af6a48SSimon Glass int spi_chip_select(struct udevice *slave);
570d7af6a48SSimon Glass 
571d7af6a48SSimon Glass /**
572ff56bba2SSimon Glass  * spi_find_chip_select() - Find the slave attached to chip select
573ff56bba2SSimon Glass  *
574ff56bba2SSimon Glass  * @bus:	SPI bus to search
575ff56bba2SSimon Glass  * @cs:		Chip select to look for
576ff56bba2SSimon Glass  * @devp:	Returns the slave device if found
5775a1c4376SBin Meng  * @return 0 if found, -EINVAL if cs is invalid, -ENODEV if no device attached,
5785a1c4376SBin Meng  *	   other -ve value on error
579ff56bba2SSimon Glass  */
580ff56bba2SSimon Glass int spi_find_chip_select(struct udevice *bus, int cs, struct udevice **devp);
581ff56bba2SSimon Glass 
582ff56bba2SSimon Glass /**
583d0cff03eSSimon Glass  * spi_slave_ofdata_to_platdata() - decode standard SPI platform data
584d7af6a48SSimon Glass  *
585d0cff03eSSimon Glass  * This decodes the speed and mode for a slave from a device tree node
586d7af6a48SSimon Glass  *
587d7af6a48SSimon Glass  * @blob:	Device tree blob
588d7af6a48SSimon Glass  * @node:	Node offset to read from
589d0cff03eSSimon Glass  * @plat:	Place to put the decoded information
590d7af6a48SSimon Glass  */
591279e26f5SSimon Glass int spi_slave_ofdata_to_platdata(struct udevice *dev,
592d0cff03eSSimon Glass 				 struct dm_spi_slave_platdata *plat);
593d7af6a48SSimon Glass 
594d7af6a48SSimon Glass /**
595d7af6a48SSimon Glass  * spi_cs_info() - Check information on a chip select
596d7af6a48SSimon Glass  *
597d7af6a48SSimon Glass  * This checks a particular chip select on a bus to see if it has a device
598d7af6a48SSimon Glass  * attached, or is even valid.
599d7af6a48SSimon Glass  *
600d7af6a48SSimon Glass  * @bus:	The SPI bus
601d7af6a48SSimon Glass  * @cs:		The chip select (0..n-1)
602d7af6a48SSimon Glass  * @info:	Returns information about the chip select, if valid
603d7af6a48SSimon Glass  * @return 0 if OK (and @info is set up), -ENODEV if the chip select
604d7af6a48SSimon Glass  *	   is invalid, other -ve value on error
605d7af6a48SSimon Glass  */
606d7af6a48SSimon Glass int spi_cs_info(struct udevice *bus, uint cs, struct spi_cs_info *info);
607d7af6a48SSimon Glass 
608d7af6a48SSimon Glass struct sandbox_state;
609c60e1f25SSimon Glass 
610c60e1f25SSimon Glass /**
611c60e1f25SSimon Glass  * sandbox_spi_get_emul() - get an emulator for a SPI slave
612c60e1f25SSimon Glass  *
613c60e1f25SSimon Glass  * This provides a way to attach an emulated SPI device to a particular SPI
614c60e1f25SSimon Glass  * slave, so that xfer() operations on the slave will be handled by the
615c60e1f25SSimon Glass  * emulator. If a emulator already exists on that chip select it is returned.
616c60e1f25SSimon Glass  * Otherwise one is created.
617c60e1f25SSimon Glass  *
618c60e1f25SSimon Glass  * @state:	Sandbox state
619c60e1f25SSimon Glass  * @bus:	SPI bus requesting the emulator
620c60e1f25SSimon Glass  * @slave:	SPI slave device requesting the emulator
621c60e1f25SSimon Glass  * @emuip:	Returns pointer to emulator
622c60e1f25SSimon Glass  * @return 0 if OK, -ve on error
623c60e1f25SSimon Glass  */
624d7af6a48SSimon Glass int sandbox_spi_get_emul(struct sandbox_state *state,
625d7af6a48SSimon Glass 			 struct udevice *bus, struct udevice *slave,
626d7af6a48SSimon Glass 			 struct udevice **emulp);
627d7af6a48SSimon Glass 
6287a3eff4cSPeng Fan /**
6297a3eff4cSPeng Fan  * Claim the bus and prepare it for communication with a given slave.
6307a3eff4cSPeng Fan  *
6317a3eff4cSPeng Fan  * This must be called before doing any transfers with a SPI slave. It
6327a3eff4cSPeng Fan  * will enable and initialize any SPI hardware as necessary, and make
6337a3eff4cSPeng Fan  * sure that the SCK line is in the correct idle state. It is not
6347a3eff4cSPeng Fan  * allowed to claim the same bus for several slaves without releasing
6357a3eff4cSPeng Fan  * the bus in between.
6367a3eff4cSPeng Fan  *
6377a3eff4cSPeng Fan  * @dev:	The SPI slave device
6387a3eff4cSPeng Fan  *
6397a3eff4cSPeng Fan  * Returns: 0 if the bus was claimed successfully, or a negative value
6407a3eff4cSPeng Fan  * if it wasn't.
6417a3eff4cSPeng Fan  */
6427a3eff4cSPeng Fan int dm_spi_claim_bus(struct udevice *dev);
6437a3eff4cSPeng Fan 
6447a3eff4cSPeng Fan /**
6457a3eff4cSPeng Fan  * Release the SPI bus
6467a3eff4cSPeng Fan  *
6477a3eff4cSPeng Fan  * This must be called once for every call to dm_spi_claim_bus() after
6487a3eff4cSPeng Fan  * all transfers have finished. It may disable any SPI hardware as
6497a3eff4cSPeng Fan  * appropriate.
6507a3eff4cSPeng Fan  *
6517a3eff4cSPeng Fan  * @slave:	The SPI slave device
6527a3eff4cSPeng Fan  */
6537a3eff4cSPeng Fan void dm_spi_release_bus(struct udevice *dev);
6547a3eff4cSPeng Fan 
6557a3eff4cSPeng Fan /**
6567a3eff4cSPeng Fan  * SPI transfer
6577a3eff4cSPeng Fan  *
6587a3eff4cSPeng Fan  * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
6597a3eff4cSPeng Fan  * "bitlen" bits in the SPI MISO port.  That's just the way SPI works.
6607a3eff4cSPeng Fan  *
6617a3eff4cSPeng Fan  * The source of the outgoing bits is the "dout" parameter and the
6627a3eff4cSPeng Fan  * destination of the input bits is the "din" parameter.  Note that "dout"
6637a3eff4cSPeng Fan  * and "din" can point to the same memory location, in which case the
6647a3eff4cSPeng Fan  * input data overwrites the output data (since both are buffered by
6657a3eff4cSPeng Fan  * temporary variables, this is OK).
6667a3eff4cSPeng Fan  *
6677a3eff4cSPeng Fan  * dm_spi_xfer() interface:
6687a3eff4cSPeng Fan  * @dev:	The SPI slave device which will be sending/receiving the data.
6697a3eff4cSPeng Fan  * @bitlen:	How many bits to write and read.
6707a3eff4cSPeng Fan  * @dout:	Pointer to a string of bits to send out.  The bits are
6717a3eff4cSPeng Fan  *		held in a byte array and are sent MSB first.
6727a3eff4cSPeng Fan  * @din:	Pointer to a string of bits that will be filled in.
6737a3eff4cSPeng Fan  * @flags:	A bitwise combination of SPI_XFER_* flags.
6747a3eff4cSPeng Fan  *
6757a3eff4cSPeng Fan  * Returns: 0 on success, not 0 on failure
6767a3eff4cSPeng Fan  */
6777a3eff4cSPeng Fan int dm_spi_xfer(struct udevice *dev, unsigned int bitlen,
6787a3eff4cSPeng Fan 		const void *dout, void *din, unsigned long flags);
6797a3eff4cSPeng Fan 
6807ac3b0edSSimon Glass /**
6817ac3b0edSSimon Glass  * spi_get_mmap() - Get memory-mapped SPI
6827ac3b0edSSimon Glass  *
6837ac3b0edSSimon Glass  * @dev:	SPI slave device to check
6847ac3b0edSSimon Glass  * @map_basep:	Returns base memory address for mapped SPI
6857ac3b0edSSimon Glass  * @map_sizep:	Returns size of mapped SPI
6867ac3b0edSSimon Glass  * @offsetp:	Returns start offset of SPI flash where the map works
6877ac3b0edSSimon Glass  *	correctly (offsets before this are not visible)
6887ac3b0edSSimon Glass  * @return 0 if OK, -ENOSYS if no operation, -EFAULT if memory mapping is not
6897ac3b0edSSimon Glass  *	available
6907ac3b0edSSimon Glass  */
6917ac3b0edSSimon Glass int dm_spi_get_mmap(struct udevice *dev, ulong *map_basep, uint *map_sizep,
6927ac3b0edSSimon Glass 		    uint *offsetp);
6937ac3b0edSSimon Glass 
694bc5701e1SSimon Glass /* Access the operations for a SPI device */
695d7af6a48SSimon Glass #define spi_get_ops(dev)	((struct dm_spi_ops *)(dev)->driver->ops)
696c60e1f25SSimon Glass #define spi_emul_get_ops(dev)	((struct dm_spi_emul_ops *)(dev)->driver->ops)
697d7af6a48SSimon Glass #endif /* CONFIG_DM_SPI */
698d7af6a48SSimon Glass 
69977f85581Swdenk #endif	/* _SPI_H_ */
700