blob: c8a9d87b5f9b0a2b9a9bcd126ffc48490830a725 [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)
wdenk77f85582002-09-26 02:01:47 +000033
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053034/* SPI TX operation modes */
35#define SPI_OPM_TX_QPP 1 << 0
36
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053037/* SPI RX operation modes */
38#define SPI_OPM_RX_AS 1 << 0
39#define SPI_OPM_RX_DOUT 1 << 1
40#define SPI_OPM_RX_DIO 1 << 2
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053041#define SPI_OPM_RX_QOF 1 << 3
Jagannadha Sutradharudu Tekic4ba0d82013-12-24 15:24:31 +053042#define SPI_OPM_RX_QIOF 1 << 4
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053043#define SPI_OPM_RX_EXTN SPI_OPM_RX_AS | SPI_OPM_RX_DOUT | \
Jagannadha Sutradharudu Tekic4ba0d82013-12-24 15:24:31 +053044 SPI_OPM_RX_DIO | SPI_OPM_RX_QOF | \
45 SPI_OPM_RX_QIOF
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053046
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000047/* Header byte that marks the start of the message */
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053048#define SPI_PREAMBLE_END_BYTE 0xec
Rajeshwari Shindebb786b82013-05-28 20:10:37 +000049
Nikita Kiryanov5753d092013-10-16 17:23:25 +030050#define SPI_DEFAULT_WORDLEN 8
51
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053052/**
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053053 * struct spi_slave - Representation of a SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020054 *
55 * Drivers are expected to extend this with controller-specific data.
56 *
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053057 * @bus: ID of the bus that the slave is attached to.
58 * @cs: ID of the chip select connected to the slave.
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053059 * @op_mode_rx: SPI RX operation mode.
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053060 * @op_mode_tx: SPI TX operation mode.
Nikita Kiryanov5753d092013-10-16 17:23:25 +030061 * @wordlen: Size of SPI word in number of bits
Jagannadha Sutradharudu Tekice22b922013-10-07 19:34:56 +053062 * @max_write_size: If non-zero, the maximum number of bytes which can
63 * be written at once, excluding command bytes.
64 * @memory_map: Address of read-only SPI flash access.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020065 */
66struct spi_slave {
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053067 unsigned int bus;
68 unsigned int cs;
Jagannadha Sutradharudu Teki4e09cc12014-01-11 15:10:28 +053069 u8 op_mode_rx;
Jagannadha Sutradharudu Teki3163aaa2014-01-11 15:13:11 +053070 u8 op_mode_tx;
Nikita Kiryanov5753d092013-10-16 17:23:25 +030071 unsigned int wordlen;
Simon Glass0c456ce2013-03-11 06:08:05 +000072 unsigned int max_write_size;
Poddar, Sourav004f15b2013-10-07 15:53:01 +053073 void *memory_map;
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020074};
wdenk77f85582002-09-26 02:01:47 +000075
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053076/**
wdenk77f85582002-09-26 02:01:47 +000077 * Initialization, must be called once on start up.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +020078 *
79 * TODO: I don't think we really need this.
wdenk77f85582002-09-26 02:01:47 +000080 */
81void spi_init(void);
82
Simon Glassba6c3ce2013-03-11 06:08:00 +000083/**
84 * spi_do_alloc_slave - Allocate a new SPI slave (internal)
85 *
86 * Allocate and zero all fields in the spi slave, and set the bus/chip
87 * select. Use the helper macro spi_alloc_slave() to call this.
88 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +053089 * @offset: Offset of struct spi_slave within slave structure.
90 * @size: Size of slave structure.
91 * @bus: Bus ID of the slave chip.
92 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +000093 */
94void *spi_do_alloc_slave(int offset, int size, unsigned int bus,
95 unsigned int cs);
96
97/**
98 * spi_alloc_slave - Allocate a new SPI slave
99 *
100 * Allocate and zero all fields in the spi slave, and set the bus/chip
101 * select.
102 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530103 * @_struct: Name of structure to allocate (e.g. struct tegra_spi).
104 * This structure must contain a member 'struct spi_slave *slave'.
105 * @bus: Bus ID of the slave chip.
106 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000107 */
108#define spi_alloc_slave(_struct, bus, cs) \
109 spi_do_alloc_slave(offsetof(_struct, slave), \
110 sizeof(_struct), bus, cs)
111
112/**
113 * spi_alloc_slave_base - Allocate a new SPI slave with no private data
114 *
115 * Allocate and zero all fields in the spi slave, and set the bus/chip
116 * select.
117 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530118 * @bus: Bus ID of the slave chip.
119 * @cs: Chip select ID of the slave chip on the specified bus.
Simon Glassba6c3ce2013-03-11 06:08:00 +0000120 */
121#define spi_alloc_slave_base(bus, cs) \
122 spi_do_alloc_slave(0, sizeof(struct spi_slave), bus, cs)
123
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530124/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200125 * Set up communications parameters for a SPI slave.
126 *
127 * This must be called once for each slave. Note that this function
128 * usually doesn't touch any actual hardware, it only initializes the
129 * contents of spi_slave so that the hardware can be easily
130 * initialized later.
131 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530132 * @bus: Bus ID of the slave chip.
133 * @cs: Chip select ID of the slave chip on the specified bus.
134 * @max_hz: Maximum SCK rate in Hz.
135 * @mode: Clock polarity, clock phase and other parameters.
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200136 *
137 * Returns: A spi_slave reference that can be used in subsequent SPI
138 * calls, or NULL if one or more of the parameters are not supported.
139 */
140struct spi_slave *spi_setup_slave(unsigned int bus, unsigned int cs,
141 unsigned int max_hz, unsigned int mode);
142
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530143/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200144 * Free any memory associated with a SPI slave.
145 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530146 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200147 */
148void spi_free_slave(struct spi_slave *slave);
149
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530150/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200151 * Claim the bus and prepare it for communication with a given slave.
152 *
153 * This must be called before doing any transfers with a SPI slave. It
154 * will enable and initialize any SPI hardware as necessary, and make
155 * sure that the SCK line is in the correct idle state. It is not
156 * allowed to claim the same bus for several slaves without releasing
157 * the bus in between.
158 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530159 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200160 *
161 * Returns: 0 if the bus was claimed successfully, or a negative value
162 * if it wasn't.
163 */
164int spi_claim_bus(struct spi_slave *slave);
165
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530166/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200167 * Release the SPI bus
168 *
169 * This must be called once for every call to spi_claim_bus() after
170 * all transfers have finished. It may disable any SPI hardware as
171 * appropriate.
172 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530173 * @slave: The SPI slave
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200174 */
175void spi_release_bus(struct spi_slave *slave);
wdenk77f85582002-09-26 02:01:47 +0000176
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530177/**
Nikita Kiryanov5753d092013-10-16 17:23:25 +0300178 * Set the word length for SPI transactions
179 *
180 * Set the word length (number of bits per word) for SPI transactions.
181 *
182 * @slave: The SPI slave
183 * @wordlen: The number of bits in a word
184 *
185 * Returns: 0 on success, -1 on failure.
186 */
187int spi_set_wordlen(struct spi_slave *slave, unsigned int wordlen);
188
189/**
wdenk77f85582002-09-26 02:01:47 +0000190 * SPI transfer
191 *
192 * This writes "bitlen" bits out the SPI MOSI port and simultaneously clocks
193 * "bitlen" bits in the SPI MISO port. That's just the way SPI works.
194 *
195 * The source of the outgoing bits is the "dout" parameter and the
196 * destination of the input bits is the "din" parameter. Note that "dout"
197 * and "din" can point to the same memory location, in which case the
198 * input data overwrites the output data (since both are buffered by
199 * temporary variables, this is OK).
200 *
wdenk77f85582002-09-26 02:01:47 +0000201 * spi_xfer() interface:
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530202 * @slave: The SPI slave which will be sending/receiving the data.
203 * @bitlen: How many bits to write and read.
204 * @dout: Pointer to a string of bits to send out. The bits are
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200205 * held in a byte array and are sent MSB first.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530206 * @din: Pointer to a string of bits that will be filled in.
207 * @flags: A bitwise combination of SPI_XFER_* flags.
wdenk77f85582002-09-26 02:01:47 +0000208 *
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530209 * Returns: 0 on success, not 0 on failure
wdenk77f85582002-09-26 02:01:47 +0000210 */
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200211int spi_xfer(struct spi_slave *slave, unsigned int bitlen, const void *dout,
212 void *din, unsigned long flags);
Guennadi Liakhovetski38254f42008-04-15 14:14:25 +0200213
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530214/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200215 * Determine if a SPI chipselect is valid.
216 * This function is provided by the board if the low-level SPI driver
217 * needs it to determine if a given chipselect is actually valid.
218 *
219 * Returns: 1 if bus:cs identifies a valid chip on this board, 0
220 * otherwise.
221 */
222int spi_cs_is_valid(unsigned int bus, unsigned int cs);
223
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530224/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200225 * Activate a SPI chipselect.
226 * This function is provided by the board code when using a driver
227 * that can't control its chipselects automatically (e.g.
228 * common/soft_spi.c). When called, it should activate the chip select
229 * to the device identified by "slave".
230 */
231void spi_cs_activate(struct spi_slave *slave);
232
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530233/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200234 * Deactivate 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 deactivate the chip
238 * select to the device identified by "slave".
239 */
240void spi_cs_deactivate(struct spi_slave *slave);
241
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530242/**
Thomas Choufa1423e2010-12-24 15:16:07 +0800243 * Set transfer speed.
244 * This sets a new speed to be applied for next spi_xfer().
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530245 * @slave: The SPI slave
246 * @hz: The transfer speed
Thomas Choufa1423e2010-12-24 15:16:07 +0800247 */
248void spi_set_speed(struct spi_slave *slave, uint hz);
249
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530250/**
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200251 * Write 8 bits, then read 8 bits.
Jagannadha Sutradharudu Teki1b1bd9a2013-09-25 15:47:36 +0530252 * @slave: The SPI slave we're communicating with
253 * @byte: Byte to be written
Haavard Skinnemoend255bb02008-05-16 11:10:31 +0200254 *
255 * Returns: The value that was read, or a negative value on error.
256 *
257 * TODO: This function probably shouldn't be inlined.
258 */
259static inline int spi_w8r8(struct spi_slave *slave, unsigned char byte)
260{
261 unsigned char dout[2];
262 unsigned char din[2];
263 int ret;
264
265 dout[0] = byte;
266 dout[1] = 0;
267
268 ret = spi_xfer(slave, 16, dout, din, SPI_XFER_BEGIN | SPI_XFER_END);
269 return ret < 0 ? ret : din[1];
270}
wdenk77f85582002-09-26 02:01:47 +0000271
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800272/**
273 * Set up a SPI slave for a particular device tree node
274 *
275 * This calls spi_setup_slave() with the correct bus number. Call
276 * spi_free_slave() to free it later.
277 *
Jagannadha Sutradharudu Teki469146c2013-10-10 22:14:09 +0530278 * @param blob: Device tree blob
Simon Glass0efc0242013-12-03 16:43:24 -0700279 * @param slave_node: Slave node to use
280 * @param spi_node: SPI peripheral node to use
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800281 * @return pointer to new spi_slave structure
282 */
Simon Glass0efc0242013-12-03 16:43:24 -0700283struct spi_slave *spi_setup_slave_fdt(const void *blob, int slave_node,
284 int spi_node);
285
286/**
287 * spi_base_setup_slave_fdt() - helper function to set up a SPI slace
288 *
289 * This decodes SPI properties from the slave node to determine the
290 * chip select and SPI parameters.
291 *
292 * @blob: Device tree blob
293 * @busnum: Bus number to use
294 * @node: Device tree node for the SPI bus
295 */
296struct spi_slave *spi_base_setup_slave_fdt(const void *blob, int busnum,
297 int node);
Hung-ying Tyanf3424c52013-05-15 18:27:30 +0800298
wdenk77f85582002-09-26 02:01:47 +0000299#endif /* _SPI_H_ */