xref: /openbmc/linux/drivers/spi/spi-dw.h (revision b89e9c87)
1 #ifndef DW_SPI_HEADER_H
2 #define DW_SPI_HEADER_H
3 
4 #include <linux/io.h>
5 #include <linux/scatterlist.h>
6 #include <linux/gpio.h>
7 
8 /* Register offsets */
9 #define DW_SPI_CTRL0			0x00
10 #define DW_SPI_CTRL1			0x04
11 #define DW_SPI_SSIENR			0x08
12 #define DW_SPI_MWCR			0x0c
13 #define DW_SPI_SER			0x10
14 #define DW_SPI_BAUDR			0x14
15 #define DW_SPI_TXFLTR			0x18
16 #define DW_SPI_RXFLTR			0x1c
17 #define DW_SPI_TXFLR			0x20
18 #define DW_SPI_RXFLR			0x24
19 #define DW_SPI_SR			0x28
20 #define DW_SPI_IMR			0x2c
21 #define DW_SPI_ISR			0x30
22 #define DW_SPI_RISR			0x34
23 #define DW_SPI_TXOICR			0x38
24 #define DW_SPI_RXOICR			0x3c
25 #define DW_SPI_RXUICR			0x40
26 #define DW_SPI_MSTICR			0x44
27 #define DW_SPI_ICR			0x48
28 #define DW_SPI_DMACR			0x4c
29 #define DW_SPI_DMATDLR			0x50
30 #define DW_SPI_DMARDLR			0x54
31 #define DW_SPI_IDR			0x58
32 #define DW_SPI_VERSION			0x5c
33 #define DW_SPI_DR			0x60
34 
35 /* Bit fields in CTRLR0 */
36 #define SPI_DFS_OFFSET			0
37 
38 #define SPI_FRF_OFFSET			4
39 #define SPI_FRF_SPI			0x0
40 #define SPI_FRF_SSP			0x1
41 #define SPI_FRF_MICROWIRE		0x2
42 #define SPI_FRF_RESV			0x3
43 
44 #define SPI_MODE_OFFSET			6
45 #define SPI_SCPH_OFFSET			6
46 #define SPI_SCOL_OFFSET			7
47 
48 #define SPI_TMOD_OFFSET			8
49 #define SPI_TMOD_MASK			(0x3 << SPI_TMOD_OFFSET)
50 #define	SPI_TMOD_TR			0x0		/* xmit & recv */
51 #define SPI_TMOD_TO			0x1		/* xmit only */
52 #define SPI_TMOD_RO			0x2		/* recv only */
53 #define SPI_TMOD_EPROMREAD		0x3		/* eeprom read mode */
54 
55 #define SPI_SLVOE_OFFSET		10
56 #define SPI_SRL_OFFSET			11
57 #define SPI_CFS_OFFSET			12
58 
59 /* Bit fields in SR, 7 bits */
60 #define SR_MASK				0x7f		/* cover 7 bits */
61 #define SR_BUSY				(1 << 0)
62 #define SR_TF_NOT_FULL			(1 << 1)
63 #define SR_TF_EMPT			(1 << 2)
64 #define SR_RF_NOT_EMPT			(1 << 3)
65 #define SR_RF_FULL			(1 << 4)
66 #define SR_TX_ERR			(1 << 5)
67 #define SR_DCOL				(1 << 6)
68 
69 /* Bit fields in ISR, IMR, RISR, 7 bits */
70 #define SPI_INT_TXEI			(1 << 0)
71 #define SPI_INT_TXOI			(1 << 1)
72 #define SPI_INT_RXUI			(1 << 2)
73 #define SPI_INT_RXOI			(1 << 3)
74 #define SPI_INT_RXFI			(1 << 4)
75 #define SPI_INT_MSTI			(1 << 5)
76 
77 /* TX RX interrupt level threshold, max can be 256 */
78 #define SPI_INT_THRESHOLD		32
79 
80 enum dw_ssi_type {
81 	SSI_MOTO_SPI = 0,
82 	SSI_TI_SSP,
83 	SSI_NS_MICROWIRE,
84 };
85 
86 struct dw_spi;
87 struct dw_spi_dma_ops {
88 	int (*dma_init)(struct dw_spi *dws);
89 	void (*dma_exit)(struct dw_spi *dws);
90 	int (*dma_transfer)(struct dw_spi *dws, int cs_change);
91 };
92 
93 struct dw_spi {
94 	struct spi_master	*master;
95 	struct spi_device	*cur_dev;
96 	enum dw_ssi_type	type;
97 	char			name[16];
98 
99 	void __iomem		*regs;
100 	unsigned long		paddr;
101 	int			irq;
102 	u32			fifo_len;	/* depth of the FIFO buffer */
103 	u32			max_freq;	/* max bus freq supported */
104 
105 	u16			bus_num;
106 	u16			num_cs;		/* supported slave numbers */
107 
108 	/* Message Transfer pump */
109 	struct tasklet_struct	pump_transfers;
110 
111 	/* Current message transfer state info */
112 	struct spi_message	*cur_msg;
113 	struct spi_transfer	*cur_transfer;
114 	struct chip_data	*cur_chip;
115 	struct chip_data	*prev_chip;
116 	size_t			len;
117 	void			*tx;
118 	void			*tx_end;
119 	void			*rx;
120 	void			*rx_end;
121 	int			dma_mapped;
122 	dma_addr_t		rx_dma;
123 	dma_addr_t		tx_dma;
124 	size_t			rx_map_len;
125 	size_t			tx_map_len;
126 	u8			n_bytes;	/* current is a 1/2 bytes op */
127 	u8			max_bits_per_word;	/* maxim is 16b */
128 	u32			dma_width;
129 	irqreturn_t		(*transfer_handler)(struct dw_spi *dws);
130 	void			(*cs_control)(u32 command);
131 
132 	/* Dma info */
133 	int			dma_inited;
134 	struct dma_chan		*txchan;
135 	struct scatterlist	tx_sgl;
136 	struct dma_chan		*rxchan;
137 	struct scatterlist	rx_sgl;
138 	int			dma_chan_done;
139 	struct device		*dma_dev;
140 	dma_addr_t		dma_addr; /* phy address of the Data register */
141 	struct dw_spi_dma_ops	*dma_ops;
142 	void			*dma_priv; /* platform relate info */
143 
144 	/* Bus interface info */
145 	void			*priv;
146 #ifdef CONFIG_DEBUG_FS
147 	struct dentry *debugfs;
148 #endif
149 };
150 
151 static inline u32 dw_readl(struct dw_spi *dws, u32 offset)
152 {
153 	return __raw_readl(dws->regs + offset);
154 }
155 
156 static inline void dw_writel(struct dw_spi *dws, u32 offset, u32 val)
157 {
158 	__raw_writel(val, dws->regs + offset);
159 }
160 
161 static inline u16 dw_readw(struct dw_spi *dws, u32 offset)
162 {
163 	return __raw_readw(dws->regs + offset);
164 }
165 
166 static inline void dw_writew(struct dw_spi *dws, u32 offset, u16 val)
167 {
168 	__raw_writew(val, dws->regs + offset);
169 }
170 
171 static inline void spi_enable_chip(struct dw_spi *dws, int enable)
172 {
173 	dw_writel(dws, DW_SPI_SSIENR, (enable ? 1 : 0));
174 }
175 
176 static inline void spi_set_clk(struct dw_spi *dws, u16 div)
177 {
178 	dw_writel(dws, DW_SPI_BAUDR, div);
179 }
180 
181 static inline void spi_chip_sel(struct dw_spi *dws, struct spi_device *spi,
182 		int active)
183 {
184 	u16 cs = spi->chip_select;
185 	int gpio_val = active ? (spi->mode & SPI_CS_HIGH) :
186 		!(spi->mode & SPI_CS_HIGH);
187 
188 	if (dws->cs_control)
189 		dws->cs_control(active);
190 	if (gpio_is_valid(spi->cs_gpio))
191 		gpio_set_value(spi->cs_gpio, gpio_val);
192 
193 	if (active)
194 		dw_writel(dws, DW_SPI_SER, 1 << cs);
195 }
196 
197 /* Disable IRQ bits */
198 static inline void spi_mask_intr(struct dw_spi *dws, u32 mask)
199 {
200 	u32 new_mask;
201 
202 	new_mask = dw_readl(dws, DW_SPI_IMR) & ~mask;
203 	dw_writel(dws, DW_SPI_IMR, new_mask);
204 }
205 
206 /* Enable IRQ bits */
207 static inline void spi_umask_intr(struct dw_spi *dws, u32 mask)
208 {
209 	u32 new_mask;
210 
211 	new_mask = dw_readl(dws, DW_SPI_IMR) | mask;
212 	dw_writel(dws, DW_SPI_IMR, new_mask);
213 }
214 
215 /*
216  * Each SPI slave device to work with dw_api controller should
217  * has such a structure claiming its working mode (PIO/DMA etc),
218  * which can be save in the "controller_data" member of the
219  * struct spi_device.
220  */
221 struct dw_spi_chip {
222 	u8 poll_mode;	/* 1 for controller polling mode */
223 	u8 type;	/* SPI/SSP/MicroWire */
224 	u8 enable_dma;
225 	void (*cs_control)(u32 command);
226 };
227 
228 extern int dw_spi_add_host(struct device *dev, struct dw_spi *dws);
229 extern void dw_spi_remove_host(struct dw_spi *dws);
230 extern int dw_spi_suspend_host(struct dw_spi *dws);
231 extern int dw_spi_resume_host(struct dw_spi *dws);
232 extern void dw_spi_xfer_done(struct dw_spi *dws);
233 
234 /* platform related setup */
235 extern int dw_spi_mid_init(struct dw_spi *dws); /* Intel MID platforms */
236 #endif /* DW_SPI_HEADER_H */
237