1 // SPDX-License-Identifier: ISC
2 /*
3  * Copyright (c) 2010 Broadcom Corporation
4  */
5 
6 #ifndef	BRCMFMAC_SDIO_H
7 #define	BRCMFMAC_SDIO_H
8 
9 #include <linux/skbuff.h>
10 #include <linux/firmware.h>
11 #include "firmware.h"
12 
13 #define SDIOD_FBR_SIZE		0x100
14 
15 /* io_en */
16 #define SDIO_FUNC_ENABLE_1	0x02
17 #define SDIO_FUNC_ENABLE_2	0x04
18 
19 /* io_rdys */
20 #define SDIO_FUNC_READY_1	0x02
21 #define SDIO_FUNC_READY_2	0x04
22 
23 /* intr_status */
24 #define INTR_STATUS_FUNC1	0x2
25 #define INTR_STATUS_FUNC2	0x4
26 
27 /* mask of register map */
28 #define REG_F0_REG_MASK		0x7FF
29 #define REG_F1_MISC_MASK	0x1FFFF
30 
31 /* function 0 vendor specific CCCR registers */
32 
33 #define SDIO_CCCR_BRCM_CARDCAP			0xf0
34 #define SDIO_CCCR_BRCM_CARDCAP_CMD14_SUPPORT	BIT(1)
35 #define SDIO_CCCR_BRCM_CARDCAP_CMD14_EXT	BIT(2)
36 #define SDIO_CCCR_BRCM_CARDCAP_CMD_NODEC	BIT(3)
37 
38 /* Interrupt enable bits for each function */
39 #define SDIO_CCCR_IEN_FUNC0			BIT(0)
40 #define SDIO_CCCR_IEN_FUNC1			BIT(1)
41 #define SDIO_CCCR_IEN_FUNC2			BIT(2)
42 
43 #define SDIO_CCCR_BRCM_CARDCTRL			0xf1
44 #define SDIO_CCCR_BRCM_CARDCTRL_WLANRESET	BIT(1)
45 
46 #define SDIO_CCCR_BRCM_SEPINT			0xf2
47 #define SDIO_CCCR_BRCM_SEPINT_MASK		BIT(0)
48 #define SDIO_CCCR_BRCM_SEPINT_OE		BIT(1)
49 #define SDIO_CCCR_BRCM_SEPINT_ACT_HI		BIT(2)
50 
51 /* function 1 miscellaneous registers */
52 
53 /* sprom command and status */
54 #define SBSDIO_SPROM_CS			0x10000
55 /* sprom info register */
56 #define SBSDIO_SPROM_INFO		0x10001
57 /* sprom indirect access data byte 0 */
58 #define SBSDIO_SPROM_DATA_LOW		0x10002
59 /* sprom indirect access data byte 1 */
60 #define SBSDIO_SPROM_DATA_HIGH		0x10003
61 /* sprom indirect access addr byte 0 */
62 #define SBSDIO_SPROM_ADDR_LOW		0x10004
63 /* gpio select */
64 #define SBSDIO_GPIO_SELECT		0x10005
65 /* gpio output */
66 #define SBSDIO_GPIO_OUT			0x10006
67 /* gpio enable */
68 #define SBSDIO_GPIO_EN			0x10007
69 /* rev < 7, watermark for sdio device TX path */
70 #define SBSDIO_WATERMARK		0x10008
71 /* control busy signal generation */
72 #define SBSDIO_DEVICE_CTL		0x10009
73 
74 /* SB Address Window Low (b15) */
75 #define SBSDIO_FUNC1_SBADDRLOW		0x1000A
76 /* SB Address Window Mid (b23:b16) */
77 #define SBSDIO_FUNC1_SBADDRMID		0x1000B
78 /* SB Address Window High (b31:b24)    */
79 #define SBSDIO_FUNC1_SBADDRHIGH		0x1000C
80 /* Frame Control (frame term/abort) */
81 #define SBSDIO_FUNC1_FRAMECTRL		0x1000D
82 /* ChipClockCSR (ALP/HT ctl/status) */
83 #define SBSDIO_FUNC1_CHIPCLKCSR		0x1000E
84 /* SdioPullUp (on cmd, d0-d2) */
85 #define SBSDIO_FUNC1_SDIOPULLUP		0x1000F
86 /* Write Frame Byte Count Low */
87 #define SBSDIO_FUNC1_WFRAMEBCLO		0x10019
88 /* Write Frame Byte Count High */
89 #define SBSDIO_FUNC1_WFRAMEBCHI		0x1001A
90 /* Read Frame Byte Count Low */
91 #define SBSDIO_FUNC1_RFRAMEBCLO		0x1001B
92 /* Read Frame Byte Count High */
93 #define SBSDIO_FUNC1_RFRAMEBCHI		0x1001C
94 /* MesBusyCtl (rev 11) */
95 #define SBSDIO_FUNC1_MESBUSYCTRL	0x1001D
96 /* Watermark for sdio device RX path */
97 #define SBSDIO_MESBUSY_RXFIFO_WM_MASK	0x7F
98 #define SBSDIO_MESBUSY_RXFIFO_WM_SHIFT	0
99 /* Enable busy capability for MES access */
100 #define SBSDIO_MESBUSYCTRL_ENAB		0x80
101 #define SBSDIO_MESBUSYCTRL_ENAB_SHIFT	7
102 
103 /* Sdio Core Rev 12 */
104 #define SBSDIO_FUNC1_WAKEUPCTRL		0x1001E
105 #define SBSDIO_FUNC1_WCTRL_ALPWAIT_MASK		0x1
106 #define SBSDIO_FUNC1_WCTRL_ALPWAIT_SHIFT	0
107 #define SBSDIO_FUNC1_WCTRL_HTWAIT_MASK		0x2
108 #define SBSDIO_FUNC1_WCTRL_HTWAIT_SHIFT		1
109 #define SBSDIO_FUNC1_SLEEPCSR		0x1001F
110 #define SBSDIO_FUNC1_SLEEPCSR_KSO_MASK		0x1
111 #define SBSDIO_FUNC1_SLEEPCSR_KSO_SHIFT		0
112 #define SBSDIO_FUNC1_SLEEPCSR_KSO_EN		1
113 #define SBSDIO_FUNC1_SLEEPCSR_DEVON_MASK	0x2
114 #define SBSDIO_FUNC1_SLEEPCSR_DEVON_SHIFT	1
115 
116 #define SBSDIO_FUNC1_MISC_REG_START	0x10000	/* f1 misc register start */
117 #define SBSDIO_FUNC1_MISC_REG_LIMIT	0x1001F	/* f1 misc register end */
118 
119 /* function 1 OCP space */
120 
121 /* sb offset addr is <= 15 bits, 32k */
122 #define SBSDIO_SB_OFT_ADDR_MASK		0x07FFF
123 #define SBSDIO_SB_OFT_ADDR_LIMIT	0x08000
124 /* with b15, maps to 32-bit SB access */
125 #define SBSDIO_SB_ACCESS_2_4B_FLAG	0x08000
126 
127 /* Address bits from SBADDR regs */
128 #define SBSDIO_SBWINDOW_MASK		0xffff8000
129 
130 #define SDIOH_READ              0	/* Read request */
131 #define SDIOH_WRITE             1	/* Write request */
132 
133 #define SDIOH_DATA_FIX          0	/* Fixed addressing */
134 #define SDIOH_DATA_INC          1	/* Incremental addressing */
135 
136 /* internal return code */
137 #define SUCCESS	0
138 #define ERROR	1
139 
140 /* Packet alignment for most efficient SDIO (can change based on platform) */
141 #define BRCMF_SDALIGN	(1 << 6)
142 
143 /* watchdog polling interval */
144 #define BRCMF_WD_POLL	msecs_to_jiffies(10)
145 
146 /**
147  * enum brcmf_sdiod_state - the state of the bus.
148  *
149  * @BRCMF_SDIOD_DOWN: Device can be accessed, no DPC.
150  * @BRCMF_SDIOD_DATA: Ready for data transfers, DPC enabled.
151  * @BRCMF_SDIOD_NOMEDIUM: No medium access to dongle possible.
152  */
153 enum brcmf_sdiod_state {
154 	BRCMF_SDIOD_DOWN,
155 	BRCMF_SDIOD_DATA,
156 	BRCMF_SDIOD_NOMEDIUM
157 };
158 
159 struct brcmf_sdreg {
160 	int func;
161 	int offset;
162 	int value;
163 };
164 
165 struct brcmf_sdio;
166 struct brcmf_sdiod_freezer;
167 
168 struct brcmf_sdio_dev {
169 	struct sdio_func *func1;
170 	struct sdio_func *func2;
171 	u32 sbwad;			/* Save backplane window address */
172 	struct brcmf_core *cc_core;	/* chipcommon core info struct */
173 	struct brcmf_sdio *bus;
174 	struct device *dev;
175 	struct brcmf_bus *bus_if;
176 	struct brcmf_mp_device *settings;
177 	bool oob_irq_requested;
178 	bool sd_irq_requested;
179 	bool irq_en;			/* irq enable flags */
180 	spinlock_t irq_en_lock;
181 	bool sg_support;
182 	uint max_request_size;
183 	ushort max_segment_count;
184 	uint max_segment_size;
185 	uint txglomsz;
186 	struct sg_table sgtable;
187 	char fw_name[BRCMF_FW_NAME_LEN];
188 	char nvram_name[BRCMF_FW_NAME_LEN];
189 	bool wowl_enabled;
190 	enum brcmf_sdiod_state state;
191 	struct brcmf_sdiod_freezer *freezer;
192 };
193 
194 /* sdio core registers */
195 struct sdpcmd_regs {
196 	u32 corecontrol;		/* 0x00, rev8 */
197 	u32 corestatus;			/* rev8 */
198 	u32 PAD[1];
199 	u32 biststatus;			/* rev8 */
200 
201 	/* PCMCIA access */
202 	u16 pcmciamesportaladdr;	/* 0x010, rev8 */
203 	u16 PAD[1];
204 	u16 pcmciamesportalmask;	/* rev8 */
205 	u16 PAD[1];
206 	u16 pcmciawrframebc;		/* rev8 */
207 	u16 PAD[1];
208 	u16 pcmciaunderflowtimer;	/* rev8 */
209 	u16 PAD[1];
210 
211 	/* interrupt */
212 	u32 intstatus;			/* 0x020, rev8 */
213 	u32 hostintmask;		/* rev8 */
214 	u32 intmask;			/* rev8 */
215 	u32 sbintstatus;		/* rev8 */
216 	u32 sbintmask;			/* rev8 */
217 	u32 funcintmask;		/* rev4 */
218 	u32 PAD[2];
219 	u32 tosbmailbox;		/* 0x040, rev8 */
220 	u32 tohostmailbox;		/* rev8 */
221 	u32 tosbmailboxdata;		/* rev8 */
222 	u32 tohostmailboxdata;		/* rev8 */
223 
224 	/* synchronized access to registers in SDIO clock domain */
225 	u32 sdioaccess;			/* 0x050, rev8 */
226 	u32 PAD[3];
227 
228 	/* PCMCIA frame control */
229 	u8 pcmciaframectrl;		/* 0x060, rev8 */
230 	u8 PAD[3];
231 	u8 pcmciawatermark;		/* rev8 */
232 	u8 PAD[155];
233 
234 	/* interrupt batching control */
235 	u32 intrcvlazy;			/* 0x100, rev8 */
236 	u32 PAD[3];
237 
238 	/* counters */
239 	u32 cmd52rd;			/* 0x110, rev8 */
240 	u32 cmd52wr;			/* rev8 */
241 	u32 cmd53rd;			/* rev8 */
242 	u32 cmd53wr;			/* rev8 */
243 	u32 abort;			/* rev8 */
244 	u32 datacrcerror;		/* rev8 */
245 	u32 rdoutofsync;		/* rev8 */
246 	u32 wroutofsync;		/* rev8 */
247 	u32 writebusy;			/* rev8 */
248 	u32 readwait;			/* rev8 */
249 	u32 readterm;			/* rev8 */
250 	u32 writeterm;			/* rev8 */
251 	u32 PAD[40];
252 	u32 clockctlstatus;		/* rev8 */
253 	u32 PAD[7];
254 
255 	u32 PAD[128];			/* DMA engines */
256 
257 	/* SDIO/PCMCIA CIS region */
258 	char cis[512];			/* 0x400-0x5ff, rev6 */
259 
260 	/* PCMCIA function control registers */
261 	char pcmciafcr[256];		/* 0x600-6ff, rev6 */
262 	u16 PAD[55];
263 
264 	/* PCMCIA backplane access */
265 	u16 backplanecsr;		/* 0x76E, rev6 */
266 	u16 backplaneaddr0;		/* rev6 */
267 	u16 backplaneaddr1;		/* rev6 */
268 	u16 backplaneaddr2;		/* rev6 */
269 	u16 backplaneaddr3;		/* rev6 */
270 	u16 backplanedata0;		/* rev6 */
271 	u16 backplanedata1;		/* rev6 */
272 	u16 backplanedata2;		/* rev6 */
273 	u16 backplanedata3;		/* rev6 */
274 	u16 PAD[31];
275 
276 	/* sprom "size" & "blank" info */
277 	u16 spromstatus;		/* 0x7BE, rev2 */
278 	u32 PAD[464];
279 
280 	u16 PAD[0x80];
281 };
282 
283 /* Register/deregister interrupt handler. */
284 int brcmf_sdiod_intr_register(struct brcmf_sdio_dev *sdiodev);
285 void brcmf_sdiod_intr_unregister(struct brcmf_sdio_dev *sdiodev);
286 
287 /* SDIO device register access interface */
288 /* Accessors for SDIO Function 0 */
289 #define brcmf_sdiod_func0_rb(sdiodev, addr, r) \
290 	sdio_f0_readb((sdiodev)->func1, (addr), (r))
291 
292 #define brcmf_sdiod_func0_wb(sdiodev, addr, v, ret) \
293 	sdio_f0_writeb((sdiodev)->func1, (v), (addr), (ret))
294 
295 /* Accessors for SDIO Function 1 */
296 #define brcmf_sdiod_readb(sdiodev, addr, r) \
297 	sdio_readb((sdiodev)->func1, (addr), (r))
298 
299 #define brcmf_sdiod_writeb(sdiodev, addr, v, ret) \
300 	sdio_writeb((sdiodev)->func1, (v), (addr), (ret))
301 
302 u32 brcmf_sdiod_readl(struct brcmf_sdio_dev *sdiodev, u32 addr, int *ret);
303 void brcmf_sdiod_writel(struct brcmf_sdio_dev *sdiodev, u32 addr, u32 data,
304 			int *ret);
305 
306 /* Buffer transfer to/from device (client) core via cmd53.
307  *   fn:       function number
308  *   flags:    backplane width, address increment, sync/async
309  *   buf:      pointer to memory data buffer
310  *   nbytes:   number of bytes to transfer to/from buf
311  *   pkt:      pointer to packet associated with buf (if any)
312  *   complete: callback function for command completion (async only)
313  *   handle:   handle for completion callback (first arg in callback)
314  * Returns 0 or error code.
315  * NOTE: Async operation is not currently supported.
316  */
317 int brcmf_sdiod_send_pkt(struct brcmf_sdio_dev *sdiodev,
318 			 struct sk_buff_head *pktq);
319 int brcmf_sdiod_send_buf(struct brcmf_sdio_dev *sdiodev, u8 *buf, uint nbytes);
320 
321 int brcmf_sdiod_recv_pkt(struct brcmf_sdio_dev *sdiodev, struct sk_buff *pkt);
322 int brcmf_sdiod_recv_buf(struct brcmf_sdio_dev *sdiodev, u8 *buf, uint nbytes);
323 int brcmf_sdiod_recv_chain(struct brcmf_sdio_dev *sdiodev,
324 			   struct sk_buff_head *pktq, uint totlen);
325 
326 /* Flags bits */
327 
328 /* Four-byte target (backplane) width (vs. two-byte) */
329 #define SDIO_REQ_4BYTE	0x1
330 /* Fixed address (FIFO) (vs. incrementing address) */
331 #define SDIO_REQ_FIXED	0x2
332 
333 /* Read/write to memory block (F1, no FIFO) via CMD53 (sync only).
334  *   rw:       read or write (0/1)
335  *   addr:     direct SDIO address
336  *   buf:      pointer to memory data buffer
337  *   nbytes:   number of bytes to transfer to/from buf
338  * Returns 0 or error code.
339  */
340 int brcmf_sdiod_ramrw(struct brcmf_sdio_dev *sdiodev, bool write, u32 address,
341 		      u8 *data, uint size);
342 
343 /* Issue an abort to the specified function */
344 int brcmf_sdiod_abort(struct brcmf_sdio_dev *sdiodev, struct sdio_func *func);
345 
346 void brcmf_sdiod_sgtable_alloc(struct brcmf_sdio_dev *sdiodev);
347 void brcmf_sdiod_change_state(struct brcmf_sdio_dev *sdiodev,
348 			      enum brcmf_sdiod_state state);
349 bool brcmf_sdiod_freezing(struct brcmf_sdio_dev *sdiodev);
350 void brcmf_sdiod_try_freeze(struct brcmf_sdio_dev *sdiodev);
351 void brcmf_sdiod_freezer_count(struct brcmf_sdio_dev *sdiodev);
352 void brcmf_sdiod_freezer_uncount(struct brcmf_sdio_dev *sdiodev);
353 
354 int brcmf_sdiod_probe(struct brcmf_sdio_dev *sdiodev);
355 int brcmf_sdiod_remove(struct brcmf_sdio_dev *sdiodev);
356 
357 struct brcmf_sdio *brcmf_sdio_probe(struct brcmf_sdio_dev *sdiodev);
358 void brcmf_sdio_remove(struct brcmf_sdio *bus);
359 void brcmf_sdio_isr(struct brcmf_sdio *bus, bool in_isr);
360 
361 void brcmf_sdio_wd_timer(struct brcmf_sdio *bus, bool active);
362 void brcmf_sdio_wowl_config(struct device *dev, bool enabled);
363 int brcmf_sdio_sleep(struct brcmf_sdio *bus, bool sleep);
364 void brcmf_sdio_trigger_dpc(struct brcmf_sdio *bus);
365 
366 #endif /* BRCMFMAC_SDIO_H */
367