brcm80211: fmac: stop referencing brcmf_sdio in common layer
[deliverable/linux.git] / drivers / net / wireless / brcm80211 / brcmfmac / sdio_host.h
CommitLineData
5b435de0
AS
1/*
2 * Copyright (c) 2010 Broadcom Corporation
3 *
4 * Permission to use, copy, modify, and/or distribute this software for any
5 * purpose with or without fee is hereby granted, provided that the above
6 * copyright notice and this permission notice appear in all copies.
7 *
8 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
11 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION
13 * OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
14 * CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15 */
16
17#ifndef _BRCM_SDH_H_
18#define _BRCM_SDH_H_
19
20#include <linux/skbuff.h>
21
22#define SDIO_FUNC_0 0
23#define SDIO_FUNC_1 1
24#define SDIO_FUNC_2 2
25
26#define SDIOD_FBR_SIZE 0x100
27
28/* io_en */
29#define SDIO_FUNC_ENABLE_1 0x02
30#define SDIO_FUNC_ENABLE_2 0x04
31
32/* io_rdys */
33#define SDIO_FUNC_READY_1 0x02
34#define SDIO_FUNC_READY_2 0x04
35
36/* intr_status */
37#define INTR_STATUS_FUNC1 0x2
38#define INTR_STATUS_FUNC2 0x4
39
40/* Maximum number of I/O funcs */
41#define SDIOD_MAX_IOFUNCS 7
42
43/* as of sdiod rev 0, supports 3 functions */
44#define SBSDIO_NUM_FUNCTION 3
45
46/* function 1 miscellaneous registers */
47
48/* sprom command and status */
49#define SBSDIO_SPROM_CS 0x10000
50/* sprom info register */
51#define SBSDIO_SPROM_INFO 0x10001
52/* sprom indirect access data byte 0 */
53#define SBSDIO_SPROM_DATA_LOW 0x10002
54/* sprom indirect access data byte 1 */
55#define SBSDIO_SPROM_DATA_HIGH 0x10003
56/* sprom indirect access addr byte 0 */
57#define SBSDIO_SPROM_ADDR_LOW 0x10004
58/* sprom indirect access addr byte 0 */
59#define SBSDIO_SPROM_ADDR_HIGH 0x10005
60/* xtal_pu (gpio) output */
61#define SBSDIO_CHIP_CTRL_DATA 0x10006
62/* xtal_pu (gpio) enable */
63#define SBSDIO_CHIP_CTRL_EN 0x10007
64/* rev < 7, watermark for sdio device */
65#define SBSDIO_WATERMARK 0x10008
66/* control busy signal generation */
67#define SBSDIO_DEVICE_CTL 0x10009
68
69/* SB Address Window Low (b15) */
70#define SBSDIO_FUNC1_SBADDRLOW 0x1000A
71/* SB Address Window Mid (b23:b16) */
72#define SBSDIO_FUNC1_SBADDRMID 0x1000B
73/* SB Address Window High (b31:b24) */
74#define SBSDIO_FUNC1_SBADDRHIGH 0x1000C
75/* Frame Control (frame term/abort) */
76#define SBSDIO_FUNC1_FRAMECTRL 0x1000D
77/* ChipClockCSR (ALP/HT ctl/status) */
78#define SBSDIO_FUNC1_CHIPCLKCSR 0x1000E
79/* SdioPullUp (on cmd, d0-d2) */
80#define SBSDIO_FUNC1_SDIOPULLUP 0x1000F
81/* Write Frame Byte Count Low */
82#define SBSDIO_FUNC1_WFRAMEBCLO 0x10019
83/* Write Frame Byte Count High */
84#define SBSDIO_FUNC1_WFRAMEBCHI 0x1001A
85/* Read Frame Byte Count Low */
86#define SBSDIO_FUNC1_RFRAMEBCLO 0x1001B
87/* Read Frame Byte Count High */
88#define SBSDIO_FUNC1_RFRAMEBCHI 0x1001C
89
90#define SBSDIO_FUNC1_MISC_REG_START 0x10000 /* f1 misc register start */
91#define SBSDIO_FUNC1_MISC_REG_LIMIT 0x1001C /* f1 misc register end */
92
93/* function 1 OCP space */
94
95/* sb offset addr is <= 15 bits, 32k */
96#define SBSDIO_SB_OFT_ADDR_MASK 0x07FFF
97#define SBSDIO_SB_OFT_ADDR_LIMIT 0x08000
98/* with b15, maps to 32-bit SB access */
99#define SBSDIO_SB_ACCESS_2_4B_FLAG 0x08000
100
101/* valid bits in SBSDIO_FUNC1_SBADDRxxx regs */
102
103#define SBSDIO_SBADDRLOW_MASK 0x80 /* Valid bits in SBADDRLOW */
104#define SBSDIO_SBADDRMID_MASK 0xff /* Valid bits in SBADDRMID */
105#define SBSDIO_SBADDRHIGH_MASK 0xffU /* Valid bits in SBADDRHIGH */
106/* Address bits from SBADDR regs */
107#define SBSDIO_SBWINDOW_MASK 0xffff8000
108
109#define SDIOH_READ 0 /* Read request */
110#define SDIOH_WRITE 1 /* Write request */
111
112#define SDIOH_DATA_FIX 0 /* Fixed addressing */
113#define SDIOH_DATA_INC 1 /* Incremental addressing */
114
115/* internal return code */
116#define SUCCESS 0
117#define ERROR 1
118
119struct brcmf_sdreg {
120 int func;
121 int offset;
122 int value;
123};
124
2447ffb0
FL
125struct brcmf_sdio;
126
5b435de0
AS
127struct brcmf_sdio_dev {
128 struct sdio_func *func[SDIO_MAX_FUNCS];
129 u8 num_funcs; /* Supported funcs on client */
130 u32 func_cis_ptr[SDIOD_MAX_IOFUNCS];
131 u32 sbwad; /* Save backplane window address */
132 bool regfail; /* status of last reg_r/w call */
133 void *bus;
134 atomic_t suspend; /* suspend flag */
135 wait_queue_head_t request_byte_wait;
136 wait_queue_head_t request_word_wait;
a52dd17d 137 wait_queue_head_t request_chain_wait;
5b435de0 138 wait_queue_head_t request_buffer_wait;
655713be 139 struct device *dev;
d76d1c8c 140 struct brcmf_bus *bus_if;
5b435de0
AS
141};
142
143/* Register/deregister device interrupt handler. */
144extern int
145brcmf_sdcard_intr_reg(struct brcmf_sdio_dev *sdiodev);
146
147extern int brcmf_sdcard_intr_dereg(struct brcmf_sdio_dev *sdiodev);
148
149/* Access SDIO address space (e.g. CCCR) using CMD52 (single-byte interface).
150 * fn: function number
151 * addr: unmodified SDIO-space address
152 * data: data byte to write
153 * err: pointer to error code (or NULL)
154 */
155extern u8 brcmf_sdcard_cfg_read(struct brcmf_sdio_dev *sdiodev, uint func,
156 u32 addr, int *err);
157extern void brcmf_sdcard_cfg_write(struct brcmf_sdio_dev *sdiodev, uint func,
158 u32 addr, u8 data, int *err);
159
160/* Synchronous access to device (client) core registers via CMD53 to F1.
161 * addr: backplane address (i.e. >= regsva from attach)
162 * size: register width in bytes (2 or 4)
163 * data: data for register write
164 */
165extern u32
166brcmf_sdcard_reg_read(struct brcmf_sdio_dev *sdiodev, u32 addr, uint size);
167
168extern u32
169brcmf_sdcard_reg_write(struct brcmf_sdio_dev *sdiodev, u32 addr, uint size,
170 u32 data);
171
172/* Indicate if last reg read/write failed */
173extern bool brcmf_sdcard_regfail(struct brcmf_sdio_dev *sdiodev);
174
175/* Buffer transfer to/from device (client) core via cmd53.
176 * fn: function number
177 * addr: backplane address (i.e. >= regsva from attach)
178 * flags: backplane width, address increment, sync/async
179 * buf: pointer to memory data buffer
180 * nbytes: number of bytes to transfer to/from buf
181 * pkt: pointer to packet associated with buf (if any)
182 * complete: callback function for command completion (async only)
183 * handle: handle for completion callback (first arg in callback)
184 * Returns 0 or error code.
185 * NOTE: Async operation is not currently supported.
186 */
187extern int
5adfeb63
AS
188brcmf_sdcard_send_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
189 uint flags, struct sk_buff *pkt);
190extern int
5b435de0 191brcmf_sdcard_send_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
5adfeb63
AS
192 uint flags, u8 *buf, uint nbytes);
193
194extern int
195brcmf_sdcard_recv_pkt(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
196 uint flags, struct sk_buff *pkt);
5b435de0
AS
197extern int
198brcmf_sdcard_recv_buf(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
5adfeb63
AS
199 uint flags, u8 *buf, uint nbytes);
200extern int
201brcmf_sdcard_recv_chain(struct brcmf_sdio_dev *sdiodev, u32 addr, uint fn,
202 uint flags, struct sk_buff_head *pktq);
5b435de0
AS
203
204/* Flags bits */
205
206/* Four-byte target (backplane) width (vs. two-byte) */
207#define SDIO_REQ_4BYTE 0x1
208/* Fixed address (FIFO) (vs. incrementing address) */
209#define SDIO_REQ_FIXED 0x2
210/* Async request (vs. sync request) */
211#define SDIO_REQ_ASYNC 0x4
212
213/* Read/write to memory block (F1, no FIFO) via CMD53 (sync only).
214 * rw: read or write (0/1)
215 * addr: direct SDIO address
216 * buf: pointer to memory data buffer
217 * nbytes: number of bytes to transfer to/from buf
218 * Returns 0 or error code.
219 */
220extern int brcmf_sdcard_rwdata(struct brcmf_sdio_dev *sdiodev, uint rw,
221 u32 addr, u8 *buf, uint nbytes);
222
223/* Issue an abort to the specified function */
224extern int brcmf_sdcard_abort(struct brcmf_sdio_dev *sdiodev, uint fn);
225
226/* platform specific/high level functions */
227extern int brcmf_sdio_probe(struct brcmf_sdio_dev *sdiodev);
228extern int brcmf_sdio_remove(struct brcmf_sdio_dev *sdiodev);
229
230extern int brcmf_sdcard_set_sbaddr_window(struct brcmf_sdio_dev *sdiodev,
231 u32 address);
232
233/* attach, return handler on success, NULL if failed.
234 * The handler shall be provided by all subsequent calls. No local cache
235 * cfghdl points to the starting address of pci device mapped memory
236 */
237extern int brcmf_sdioh_attach(struct brcmf_sdio_dev *sdiodev);
238extern void brcmf_sdioh_detach(struct brcmf_sdio_dev *sdiodev);
239
240/* read or write one byte using cmd52 */
241extern int brcmf_sdioh_request_byte(struct brcmf_sdio_dev *sdiodev, uint rw,
242 uint fnc, uint addr, u8 *byte);
243
244/* read or write 2/4 bytes using cmd53 */
245extern int
246brcmf_sdioh_request_word(struct brcmf_sdio_dev *sdiodev,
247 uint rw, uint fnc, uint addr,
248 u32 *word, uint nbyte);
249
250/* read or write any buffer using cmd53 */
251extern int
252brcmf_sdioh_request_buffer(struct brcmf_sdio_dev *sdiodev,
5e8e13b9 253 uint fix_inc, uint rw, uint fnc_num, u32 addr,
4c6e869d 254 struct sk_buff *pkt);
5adfeb63
AS
255extern int
256brcmf_sdioh_request_chain(struct brcmf_sdio_dev *sdiodev, uint fix_inc,
257 uint write, uint func, uint addr,
258 struct sk_buff_head *pktq);
5b435de0
AS
259
260/* Watchdog timer interface for pm ops */
261extern void brcmf_sdio_wdtmr_enable(struct brcmf_sdio_dev *sdiodev,
262 bool enable);
263
4175b88b 264extern void *brcmf_sdbrcm_probe(u32 regsva, struct brcmf_sdio_dev *sdiodev);
5b435de0
AS
265extern void brcmf_sdbrcm_disconnect(void *ptr);
266extern void brcmf_sdbrcm_isr(void *arg);
2447ffb0
FL
267
268extern void brcmf_sdbrcm_wd_timer(struct brcmf_sdio *bus, uint wdtick);
5b435de0 269#endif /* _BRCM_SDH_H_ */
This page took 0.056674 seconds and 5 git commands to generate.