blob: ffd66478b194180e10db2649b96dee8280f77751 [file] [log] [blame]
wdenk77f85582002-09-26 02:01:47 +00001/*
Jagannadha Sutradharudu Teki469146c2013-10-10 22:14:09 +05302 * Common SPI Interface: Controller-specific definitions
3 *
wdenk77f85582002-09-26 02:01:47 +00004 * (C) Copyright 2001
5 * Gerald Van Baren, Custom IDEAS, vanbaren@cideas.com.
6 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02007 * SPDX-License-Identifier: GPL-2.0+
wdenk77f85582002-09-26 02:01:47 +00008 */
9
10#ifndef _SPI_H_
11#define _SPI_H_
12
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +020013/* SPI mode flags */
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)
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020020#define SPI_CS_HIGH 0x04 /* CS active high */
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +020021#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 */
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000024#define SPI_SLAVE 0x40 /* slave mode */
25#define SPI_PREAMBLE 0x80 /* Skip preamble bytes */
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +020026
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020027/* SPI transfer flags */
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053028#define SPI_XFER_BEGIN 0x01 /* Assert CS before transfer */
29#define SPI_XFER_END 0x02 /* Deassert CS after transfer */
30#define SPI_XFER_MMAP 0x08 /* Memory Mapped start */
31#define SPI_XFER_MMAP_END 0x10 /* Memory Mapped End */
Nikita Kiryanov47002192013-10-16 17:23:26 +030032#define SPI_XFER_ONCE (SPI_XFER_BEGIN | SPI_XFER_END)
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053033#define SPI_XFER_U_PAGE (1 << 5)
wdenk77f85582002-09-26 02:01:47 +000034
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053035/* SPI TX operation modes */
36#define SPI_OPM_TX_QPP 1 << 0
37
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053038/* SPI RX operation modes */
39#define SPI_OPM_RX_AS 1 << 0
40#define SPI_OPM_RX_DOUT 1 << 1
41#define SPI_OPM_RX_DIO 1 << 2
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053042#define SPI_OPM_RX_QOF 1 << 3
Jagannadha Sutradharudu Tekic4ba0d82013-12-24 15:24:31 +053043#define SPI_OPM_RX_QIOF 1 << 4
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053044#define SPI_OPM_RX_EXTN SPI_OPM_RX_AS | SPI_OPM_RX_DOUT | \
Jagannadha Sutradharudu Tekic4ba0d82013-12-24 15:24:31 +053045 SPI_OPM_RX_DIO | SPI_OPM_RX_QOF | \
46 SPI_OPM_RX_QIOF
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053047
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053048/* SPI bus connection options */
49#define SPI_CONN_DUAL_SHARED 1 << 0
Jagannadha Sutradharudu Teki056fbc72014-01-07 00:11:35 +053050#define SPI_CONN_DUAL_SEPARATED 1 << 1
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053051
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000052/* Header byte that marks the start of the message */
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053053#define SPI_PREAMBLE_END_BYTE 0xec
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000054
Nikita Kiryanov5753d092013-10-16 17:23:25 +030055#define SPI_DEFAULT_WORDLEN 8
56
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053057/**
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053058 * struct spi_slave - Representation of a SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020059 *
60 * Drivers are expected to extend this with controller-specific data.
61 *
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053062 * @bus: ID of the bus that the slave is attached to.
63 * @cs: ID of the chip select connected to the slave.
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053064 * @op_mode_rx: SPI RX operation mode.
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053065 * @op_mode_tx: SPI TX operation mode.
Nikita Kiryanov5753d092013-10-16 17:23:25 +030066 * @wordlen: Size of SPI word in number of bits
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053067 * @max_write_size: If non-zero, the maximum number of bytes which can
68 * be written at once, excluding command bytes.
69 * @memory_map: Address of read-only SPI flash access.
Jagannadha Sutradharudu Teki056fbc72014-01-07 00:11:35 +053070 * @option: Varies SPI bus options - separate, shared bus.
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053071 * @flags: Indication of SPI flags.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020072 */
73struct spi_slave {
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053074 unsigned int bus;
75 unsigned int cs;
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053076 u8 op_mode_rx;
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053077 u8 op_mode_tx;
Nikita Kiryanov5753d092013-10-16 17:23:25 +030078 unsigned int wordlen;
Simon Glass0c456ce2013-03-11 06:08:05 +000079 unsigned int max_write_size;
Poddar, Sourav004f15b2013-10-07 15:53:01 +053080 void *memory_map;
Jagannadha Sutradharudu Tekif77f4692014-01-12 21:40:11 +053081 u8 option;
82 u8 flags;
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020083};
wdenk77f85582002-09-26 02:01:47 +000084
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053085/**
wdenk77f85582002-09-26 02:01:47 +000086 * Initialization, must be called once on start up.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020087 *
88 * TODO: I don't think we really need this.
wdenk77f85582002-09-26 02:01:47 +000089 */
90void spi_init(void);
91
Simon Glassba6c3ce2013-03-11 06:08:00 +000092/**
93 * spi_do_alloc_slave - Allocate a new SPI slave (internal)
94 *
95 * Allocate and zero all fields in the spi slave, and set the bus/chip
96 * select. Use the helper macro spi_alloc_slave() to call this.
97 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053098 * @offset: Offset of struct spi_slave within slave structure.
99 * @size: Size of slave structure.
100 * @bus: Bus ID of the slave chip.
101 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000102 */
103void *spi_do_alloc_slave(int offset, int size, unsigned int bus,
104 unsigned int cs);
105
106/**
107 * spi_alloc_slave - Allocate a new SPI slave
108 *
109 * Allocate and zero all fields in the spi slave, and set the bus/chip
110 * select.
111 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530112 * @_struct: Name of structure to allocate (e.g. struct tegra_spi).
113 * This structure must contain a member 'struct spi_slave *slave'.
114 * @bus: Bus ID of the slave chip.
115 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000116 */
117#define spi_alloc_slave(_struct, bus, cs) \
118 spi_do_alloc_slave(offsetof(_struct, slave), \
119 sizeof(_struct), bus, cs)
120
121/**
122 * spi_alloc_slave_base - Allocate a new SPI slave with no private data
123 *
124 * Allocate and zero all fields in the spi slave, and set the bus/chip
125 * select.
126 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530127 * @bus: Bus ID of the slave chip.
128 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000129 */
130#define spi_alloc_slave_base(bus, cs) \
131 spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs)
132
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530133/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200134 * Set up communications parameters for a SPI slave.
135 *
136 * This must be called once for each slave. Note that this function
137 * usually doesn't touch any actual hardware, it only initializes the
138 * contents of spi_slave so that the hardware can be easily
139 * initialized later.
140 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530141 * @bus: Bus ID of the slave chip.
142 * @cs: Chip select ID of the slave chip on the specified bus.
143 * @max_hz: Maximum SCK rate in Hz.
144 * @mode: Clock polarity, clock phase and other parameters.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200145 *
146 * Returns: A spi_slave reference that can be used in subsequent SPI
147 * calls, or NULL if one or more of the parameters are not supported.
148 */
149struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
150 unsigned int max_hz, unsigned int mode);
151
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530152/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200153 * Free any memory associated with a SPI slave.
154 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530155 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200156 */
157void spi_free_slave(struct spi_slave *slave);
158
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530159/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200160 * Claim the bus and prepare it for communication with a given slave.
161 *
162 * This must be called before doing any transfers with a SPI slave. It
163 * will enable and initialize any SPI hardware as necessary, and make
164 * sure that the SCK line is in the correct idle state. It is not
165 * allowed to claim the same bus for several slaves without releasing
166 * the bus in between.
167 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530168 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200169 *
170 * Returns: 0 if the bus was claimed successfully, or a negative value
171 * if it wasn't.
172 */
173int spi_claim_bus(struct spi_slave *slave);
174
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530175/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200176 * Release the SPI bus
177 *
178 * This must be called once for every call to spi_claim_bus() after
179 * all transfers have finished. It may disable any SPI hardware as
180 * appropriate.
181 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530182 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200183 */
184void spi_release_bus(struct spi_slave *slave);
wdenk77f85582002-09-26 02:01:47 +0000185
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530186/**
Nikita Kiryanov5753d092013-10-16 17:23:25 +0300187 * Set the word length for SPI transactions
188 *
189 * Set the word length (number of bits per word) for SPI transactions.
190 *
191 * @slave: The SPI slave
192 * @wordlen: The number of bits in a word
193 *
194 * Returns: 0 on success, -1 on failure.
195 */
196int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen);
197
198/**
wdenk77f85582002-09-26 02:01:47 +0000199 * SPI transfer
200 *
201 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
202 * "bitlen" bits in the SPI MISO port. That's just the way SPI works.
203 *
204 * The source of the outgoing bits is the "dout" parameter and the
205 * destination of the input bits is the "din" parameter. Note that "dout"
206 * and "din" can point to the same memory location, in which case the
207 * input data overwrites the output data (since both are buffered by
208 * temporary variables, this is OK).
209 *
wdenk77f85582002-09-26 02:01:47 +0000210 * spi_xfer() interface:
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530211 * @slave: The SPI slave which will be sending/receiving the data.
212 * @bitlen: How many bits to write and read.
213 * @dout: Pointer to a string of bits to send out. The bits are
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200214 * held in a byte array and are sent MSB first.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530215 * @din: Pointer to a string of bits that will be filled in.
216 * @flags: A bitwise combination of SPI_XFER_* flags.
wdenk77f85582002-09-26 02:01:47 +0000217 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530218 * Returns: 0 on success, not 0 on failure
wdenk77f85582002-09-26 02:01:47 +0000219 */
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200220int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
221 void *din, unsigned long flags);
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +0200222
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530223/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200224 * Determine if a SPI chipselect is valid.
225 * This function is provided by the board if the low-level SPI driver
226 * needs it to determine if a given chipselect is actually valid.
227 *
228 * Returns: 1 if bus:cs identifies a valid chip on this board, 0
229 * otherwise.
230 */
231int spi_cs_is_valid(unsigned int bus, unsigned int cs);
232
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530233/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200234 * Activate a SPI chipselect.
235 * This function is provided by the board code when using a driver
236 * that can't control its chipselects automatically (e.g.
237 * common/soft_spi.c). When called, it should activate the chip select
238 * to the device identified by "slave".
239 */
240void spi_cs_activate(struct spi_slave *slave);
241
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530242/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200243 * Deactivate a SPI chipselect.
244 * This function is provided by the board code when using a driver
245 * that can't control its chipselects automatically (e.g.
246 * common/soft_spi.c). When called, it should deactivate the chip
247 * select to the device identified by "slave".
248 */
249void spi_cs_deactivate(struct spi_slave *slave);
250
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530251/**
Thomas Choufa1423e2010-12-24 15:16:07 +0800252 * Set transfer speed.
253 * This sets a new speed to be applied for next spi_xfer().
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530254 * @slave: The SPI slave
255 * @hz: The transfer speed
Thomas Choufa1423e2010-12-24 15:16:07 +0800256 */
257void spi_set_speed(struct spi_slave *slave, uint hz);
258
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530259/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200260 * Write 8 bits, then read 8 bits.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530261 * @slave: The SPI slave we're communicating with
262 * @byte: Byte to be written
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200263 *
264 * Returns: The value that was read, or a negative value on error.
265 *
266 * TODO: This function probably shouldn't be inlined.
267 */
268static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte)
269{
270 unsigned char dout[2];
271 unsigned char din[2];
272 int ret;
273
274 dout[0] = byte;
275 dout[1] = 0;
276
277 ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END);
278 return ret < 0 ? ret : din[1];
279}
wdenk77f85582002-09-26 02:01:47 +0000280
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800281/**
282 * Set up a SPI slave for a particular device tree node
283 *
284 * This calls spi_setup_slave() with the correct bus number. Call
285 * spi_free_slave() to free it later.
286 *
Jagannadha Sutradharudu Teki469146c2013-10-10 22:14:09 +0530287 * @param blob: Device tree blob
Simon Glass0efc0242013-12-03 16:43:24 -0700288 * @param slave_node: Slave node to use
289 * @param spi_node: SPI peripheral node to use
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800290 * @return pointer to new spi_slave structure
291 */
Simon Glass0efc0242013-12-03 16:43:24 -0700292struct spi_slave *spi_setup_slave_fdt(const void *blob, int slave_node,
293 int spi_node);
294
295/**
296 * spi_base_setup_slave_fdt() - helper function to set up a SPI slace
297 *
298 * This decodes SPI properties from the slave node to determine the
299 * chip select and SPI parameters.
300 *
301 * @blob: Device tree blob
302 * @busnum: Bus number to use
303 * @node: Device tree node for the SPI bus
304 */
305struct spi_slave *spi_base_setup_slave_fdt(const void *blob, int busnum,
306 int node);
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800307
wdenk77f85582002-09-26 02:01:47 +0000308#endif /* _SPI_H_ */