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