Commit | Line | Data |
---|---|---|
27590d06 HS |
1 | /* |
2 | ||
3 | Driver for the Marvell 8385 based compact flash WLAN cards. | |
4 | ||
5 | (C) 2007 by Holger Schurig <hs4233@mail.mn-solutions.de> | |
6 | ||
7 | This program is free software; you can redistribute it and/or modify | |
8 | it under the terms of the GNU General Public License as published by | |
9 | the Free Software Foundation; either version 2 of the License, or | |
10 | (at your option) any later version. | |
11 | ||
12 | This program is distributed in the hope that it will be useful, | |
13 | but WITHOUT ANY WARRANTY; without even the implied warranty of | |
14 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
15 | GNU General Public License for more details. | |
16 | ||
17 | You should have received a copy of the GNU General Public License | |
18 | along with this program; see the file COPYING. If not, write to | |
19 | the Free Software Foundation, Inc., 51 Franklin Steet, Fifth Floor, | |
20 | Boston, MA 02110-1301, USA. | |
21 | ||
22 | */ | |
23 | ||
24 | #include <linux/module.h> | |
5a0e3ad6 | 25 | #include <linux/slab.h> |
27590d06 HS |
26 | #include <linux/delay.h> |
27 | #include <linux/moduleparam.h> | |
28 | #include <linux/firmware.h> | |
29 | #include <linux/netdevice.h> | |
30 | ||
27590d06 HS |
31 | #include <pcmcia/cs.h> |
32 | #include <pcmcia/cistpl.h> | |
33 | #include <pcmcia/ds.h> | |
34 | ||
35 | #include <linux/io.h> | |
36 | ||
37 | #define DRV_NAME "libertas_cs" | |
38 | ||
39 | #include "decl.h" | |
40 | #include "defs.h" | |
41 | #include "dev.h" | |
42 | ||
43 | ||
44 | /********************************************************************/ | |
45 | /* Module stuff */ | |
46 | /********************************************************************/ | |
47 | ||
48 | MODULE_AUTHOR("Holger Schurig <hs4233@mail.mn-solutions.de>"); | |
49 | MODULE_DESCRIPTION("Driver for Marvell 83xx compact flash WLAN cards"); | |
50 | MODULE_LICENSE("GPL"); | |
a974a4bb | 51 | MODULE_FIRMWARE("libertas_cs_helper.fw"); |
27590d06 HS |
52 | |
53 | ||
54 | ||
55 | /********************************************************************/ | |
56 | /* Data structures */ | |
57 | /********************************************************************/ | |
58 | ||
59 | struct if_cs_card { | |
60 | struct pcmcia_device *p_dev; | |
69f9032d | 61 | struct lbs_private *priv; |
27590d06 | 62 | void __iomem *iobase; |
9d45368a | 63 | bool align_regs; |
27590d06 HS |
64 | }; |
65 | ||
66 | ||
67 | ||
68 | /********************************************************************/ | |
69 | /* Hardware access */ | |
70 | /********************************************************************/ | |
71 | ||
72 | /* This define enables wrapper functions which allow you | |
73 | to dump all register accesses. You normally won't this, | |
74 | except for development */ | |
75 | /* #define DEBUG_IO */ | |
76 | ||
77 | #ifdef DEBUG_IO | |
78 | static int debug_output = 0; | |
79 | #else | |
80 | /* This way the compiler optimizes the printk's away */ | |
81 | #define debug_output 0 | |
82 | #endif | |
83 | ||
84 | static inline unsigned int if_cs_read8(struct if_cs_card *card, uint reg) | |
85 | { | |
86 | unsigned int val = ioread8(card->iobase + reg); | |
87 | if (debug_output) | |
7919b89c | 88 | printk(KERN_INFO "inb %08x<%02x\n", reg, val); |
27590d06 HS |
89 | return val; |
90 | } | |
91 | static inline unsigned int if_cs_read16(struct if_cs_card *card, uint reg) | |
92 | { | |
93 | unsigned int val = ioread16(card->iobase + reg); | |
94 | if (debug_output) | |
7919b89c | 95 | printk(KERN_INFO "inw %08x<%04x\n", reg, val); |
27590d06 HS |
96 | return val; |
97 | } | |
98 | static inline void if_cs_read16_rep( | |
99 | struct if_cs_card *card, | |
100 | uint reg, | |
101 | void *buf, | |
102 | unsigned long count) | |
103 | { | |
104 | if (debug_output) | |
7919b89c | 105 | printk(KERN_INFO "insw %08x<(0x%lx words)\n", |
27590d06 HS |
106 | reg, count); |
107 | ioread16_rep(card->iobase + reg, buf, count); | |
108 | } | |
109 | ||
110 | static inline void if_cs_write8(struct if_cs_card *card, uint reg, u8 val) | |
111 | { | |
112 | if (debug_output) | |
7919b89c | 113 | printk(KERN_INFO "outb %08x>%02x\n", reg, val); |
27590d06 HS |
114 | iowrite8(val, card->iobase + reg); |
115 | } | |
116 | ||
117 | static inline void if_cs_write16(struct if_cs_card *card, uint reg, u16 val) | |
118 | { | |
119 | if (debug_output) | |
7919b89c | 120 | printk(KERN_INFO "outw %08x>%04x\n", reg, val); |
27590d06 HS |
121 | iowrite16(val, card->iobase + reg); |
122 | } | |
123 | ||
124 | static inline void if_cs_write16_rep( | |
125 | struct if_cs_card *card, | |
126 | uint reg, | |
6dfff895 | 127 | const void *buf, |
27590d06 HS |
128 | unsigned long count) |
129 | { | |
130 | if (debug_output) | |
7919b89c | 131 | printk(KERN_INFO "outsw %08x>(0x%lx words)\n", |
27590d06 HS |
132 | reg, count); |
133 | iowrite16_rep(card->iobase + reg, buf, count); | |
134 | } | |
135 | ||
136 | ||
137 | /* | |
138 | * I know that polling/delaying is frowned upon. However, this procedure | |
139 | * with polling is needed while downloading the firmware. At this stage, | |
140 | * the hardware does unfortunately not create any interrupts. | |
141 | * | |
142 | * Fortunately, this function is never used once the firmware is in | |
143 | * the card. :-) | |
144 | * | |
145 | * As a reference, see the "Firmware Specification v5.1", page 18 | |
146 | * and 19. I did not follow their suggested timing to the word, | |
147 | * but this works nice & fast anyway. | |
148 | */ | |
149 | static int if_cs_poll_while_fw_download(struct if_cs_card *card, uint addr, u8 reg) | |
150 | { | |
151 | int i; | |
152 | ||
93416c87 | 153 | for (i = 0; i < 100000; i++) { |
27590d06 HS |
154 | u8 val = if_cs_read8(card, addr); |
155 | if (val == reg) | |
1fac36ee | 156 | return 0; |
93416c87 | 157 | udelay(5); |
27590d06 HS |
158 | } |
159 | return -ETIME; | |
160 | } | |
161 | ||
162 | ||
163 | ||
53143256 HS |
164 | /* |
165 | * First the bitmasks for the host/card interrupt/status registers: | |
166 | */ | |
78cf0747 HS |
167 | #define IF_CS_BIT_TX 0x0001 |
168 | #define IF_CS_BIT_RX 0x0002 | |
169 | #define IF_CS_BIT_COMMAND 0x0004 | |
170 | #define IF_CS_BIT_RESP 0x0008 | |
171 | #define IF_CS_BIT_EVENT 0x0010 | |
172 | #define IF_CS_BIT_MASK 0x001f | |
27590d06 | 173 | |
53143256 HS |
174 | |
175 | ||
176 | /* | |
177 | * It's not really clear to me what the host status register is for. It | |
178 | * needs to be set almost in union with "host int cause". The following | |
179 | * bits from above are used: | |
180 | * | |
181 | * IF_CS_BIT_TX driver downloaded a data packet | |
182 | * IF_CS_BIT_RX driver got a data packet | |
183 | * IF_CS_BIT_COMMAND driver downloaded a command | |
184 | * IF_CS_BIT_RESP not used (has some meaning with powerdown) | |
185 | * IF_CS_BIT_EVENT driver read a host event | |
186 | */ | |
78cf0747 | 187 | #define IF_CS_HOST_STATUS 0x00000000 |
27590d06 | 188 | |
53143256 HS |
189 | /* |
190 | * With the host int cause register can the host (that is, Linux) cause | |
191 | * an interrupt in the firmware, to tell the firmware about those events: | |
192 | * | |
193 | * IF_CS_BIT_TX a data packet has been downloaded | |
194 | * IF_CS_BIT_RX a received data packet has retrieved | |
195 | * IF_CS_BIT_COMMAND a firmware block or a command has been downloaded | |
196 | * IF_CS_BIT_RESP not used (has some meaning with powerdown) | |
197 | * IF_CS_BIT_EVENT a host event (link lost etc) has been retrieved | |
198 | */ | |
78cf0747 | 199 | #define IF_CS_HOST_INT_CAUSE 0x00000002 |
27590d06 | 200 | |
53143256 HS |
201 | /* |
202 | * The host int mask register is used to enable/disable interrupt. However, | |
203 | * I have the suspicion that disabled interrupts are lost. | |
204 | */ | |
78cf0747 | 205 | #define IF_CS_HOST_INT_MASK 0x00000004 |
27590d06 | 206 | |
53143256 HS |
207 | /* |
208 | * Used to send or receive data packets: | |
209 | */ | |
a78a8325 HS |
210 | #define IF_CS_WRITE 0x00000016 |
211 | #define IF_CS_WRITE_LEN 0x00000014 | |
78cf0747 HS |
212 | #define IF_CS_READ 0x00000010 |
213 | #define IF_CS_READ_LEN 0x00000024 | |
27590d06 | 214 | |
53143256 HS |
215 | /* |
216 | * Used to send commands (and to send firmware block) and to | |
217 | * receive command responses: | |
218 | */ | |
a78a8325 HS |
219 | #define IF_CS_CMD 0x0000001A |
220 | #define IF_CS_CMD_LEN 0x00000018 | |
221 | #define IF_CS_RESP 0x00000012 | |
222 | #define IF_CS_RESP_LEN 0x00000030 | |
27590d06 | 223 | |
53143256 HS |
224 | /* |
225 | * The card status registers shows what the card/firmware actually | |
226 | * accepts: | |
227 | * | |
228 | * IF_CS_BIT_TX you may send a data packet | |
229 | * IF_CS_BIT_RX you may retrieve a data packet | |
230 | * IF_CS_BIT_COMMAND you may send a command | |
231 | * IF_CS_BIT_RESP you may retrieve a command response | |
232 | * IF_CS_BIT_EVENT the card has a event for use (link lost, snr low etc) | |
233 | * | |
234 | * When reading this register several times, you will get back the same | |
235 | * results --- with one exception: the IF_CS_BIT_EVENT clear itself | |
236 | * automatically. | |
237 | * | |
238 | * Not that we don't rely on BIT_RX,_BIT_RESP or BIT_EVENT because | |
239 | * we handle this via the card int cause register. | |
240 | */ | |
78cf0747 HS |
241 | #define IF_CS_CARD_STATUS 0x00000020 |
242 | #define IF_CS_CARD_STATUS_MASK 0x7f00 | |
27590d06 | 243 | |
53143256 HS |
244 | /* |
245 | * The card int cause register is used by the card/firmware to notify us | |
246 | * about the following events: | |
247 | * | |
248 | * IF_CS_BIT_TX a data packet has successfully been sentx | |
249 | * IF_CS_BIT_RX a data packet has been received and can be retrieved | |
250 | * IF_CS_BIT_COMMAND not used | |
251 | * IF_CS_BIT_RESP the firmware has a command response for us | |
252 | * IF_CS_BIT_EVENT the card has a event for use (link lost, snr low etc) | |
253 | */ | |
78cf0747 | 254 | #define IF_CS_CARD_INT_CAUSE 0x00000022 |
27590d06 | 255 | |
53143256 HS |
256 | /* |
257 | * This is used to for handshaking with the card's bootloader/helper image | |
258 | * to synchronize downloading of firmware blocks. | |
259 | */ | |
a78a8325 HS |
260 | #define IF_CS_SQ_READ_LOW 0x00000028 |
261 | #define IF_CS_SQ_HELPER_OK 0x10 | |
27590d06 | 262 | |
53143256 HS |
263 | /* |
264 | * The scratch register tells us ... | |
265 | * | |
266 | * IF_CS_SCRATCH_BOOT_OK the bootloader runs | |
267 | * IF_CS_SCRATCH_HELPER_OK the helper firmware already runs | |
268 | */ | |
27590d06 | 269 | #define IF_CS_SCRATCH 0x0000003F |
53143256 HS |
270 | #define IF_CS_SCRATCH_BOOT_OK 0x00 |
271 | #define IF_CS_SCRATCH_HELPER_OK 0x5a | |
27590d06 | 272 | |
4c55523e HS |
273 | /* |
274 | * Used to detect ancient chips: | |
275 | */ | |
276 | #define IF_CS_PRODUCT_ID 0x0000001C | |
277 | #define IF_CS_CF8385_B1_REV 0x12 | |
dc7d243d | 278 | #define IF_CS_CF8381_B3_REV 0x04 |
9d45368a | 279 | #define IF_CS_CF8305_B1_REV 0x03 |
4c55523e | 280 | |
dc7d243d MV |
281 | /* |
282 | * Used to detect other cards than CF8385 since their revisions of silicon | |
283 | * doesn't match those from CF8385, eg. CF8381 B3 works with this driver. | |
284 | */ | |
9d45368a MV |
285 | #define CF8305_MANFID 0x02db |
286 | #define CF8305_CARDID 0x8103 | |
dc7d243d MV |
287 | #define CF8381_MANFID 0x02db |
288 | #define CF8381_CARDID 0x6064 | |
289 | #define CF8385_MANFID 0x02df | |
290 | #define CF8385_CARDID 0x8103 | |
291 | ||
9d45368a MV |
292 | static inline int if_cs_hw_is_cf8305(struct pcmcia_device *p_dev) |
293 | { | |
294 | return (p_dev->manf_id == CF8305_MANFID && | |
295 | p_dev->card_id == CF8305_CARDID); | |
296 | } | |
297 | ||
dc7d243d MV |
298 | static inline int if_cs_hw_is_cf8381(struct pcmcia_device *p_dev) |
299 | { | |
300 | return (p_dev->manf_id == CF8381_MANFID && | |
301 | p_dev->card_id == CF8381_CARDID); | |
302 | } | |
303 | ||
304 | static inline int if_cs_hw_is_cf8385(struct pcmcia_device *p_dev) | |
305 | { | |
306 | return (p_dev->manf_id == CF8385_MANFID && | |
307 | p_dev->card_id == CF8385_CARDID); | |
308 | } | |
27590d06 | 309 | |
27590d06 | 310 | /********************************************************************/ |
43d01c56 | 311 | /* I/O and interrupt handling */ |
27590d06 HS |
312 | /********************************************************************/ |
313 | ||
43d01c56 HS |
314 | static inline void if_cs_enable_ints(struct if_cs_card *card) |
315 | { | |
316 | lbs_deb_enter(LBS_DEB_CS); | |
78cf0747 | 317 | if_cs_write16(card, IF_CS_HOST_INT_MASK, 0); |
43d01c56 HS |
318 | } |
319 | ||
320 | static inline void if_cs_disable_ints(struct if_cs_card *card) | |
321 | { | |
322 | lbs_deb_enter(LBS_DEB_CS); | |
78cf0747 | 323 | if_cs_write16(card, IF_CS_HOST_INT_MASK, IF_CS_BIT_MASK); |
43d01c56 HS |
324 | } |
325 | ||
27590d06 HS |
326 | /* |
327 | * Called from if_cs_host_to_card to send a command to the hardware | |
328 | */ | |
69f9032d | 329 | static int if_cs_send_cmd(struct lbs_private *priv, u8 *buf, u16 nb) |
27590d06 HS |
330 | { |
331 | struct if_cs_card *card = (struct if_cs_card *)priv->card; | |
332 | int ret = -1; | |
333 | int loops = 0; | |
334 | ||
335 | lbs_deb_enter(LBS_DEB_CS); | |
43d01c56 | 336 | if_cs_disable_ints(card); |
27590d06 HS |
337 | |
338 | /* Is hardware ready? */ | |
339 | while (1) { | |
a78a8325 HS |
340 | u16 status = if_cs_read16(card, IF_CS_CARD_STATUS); |
341 | if (status & IF_CS_BIT_COMMAND) | |
27590d06 HS |
342 | break; |
343 | if (++loops > 100) { | |
344 | lbs_pr_err("card not ready for commands\n"); | |
345 | goto done; | |
346 | } | |
347 | mdelay(1); | |
348 | } | |
349 | ||
a78a8325 | 350 | if_cs_write16(card, IF_CS_CMD_LEN, nb); |
27590d06 | 351 | |
a78a8325 | 352 | if_cs_write16_rep(card, IF_CS_CMD, buf, nb / 2); |
27590d06 HS |
353 | /* Are we supposed to transfer an odd amount of bytes? */ |
354 | if (nb & 1) | |
a78a8325 | 355 | if_cs_write8(card, IF_CS_CMD, buf[nb-1]); |
27590d06 HS |
356 | |
357 | /* "Assert the download over interrupt command in the Host | |
358 | * status register" */ | |
78cf0747 | 359 | if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND); |
27590d06 HS |
360 | |
361 | /* "Assert the download over interrupt command in the Card | |
362 | * interrupt case register" */ | |
78cf0747 | 363 | if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND); |
27590d06 HS |
364 | ret = 0; |
365 | ||
366 | done: | |
43d01c56 | 367 | if_cs_enable_ints(card); |
27590d06 HS |
368 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret); |
369 | return ret; | |
370 | } | |
371 | ||
27590d06 HS |
372 | /* |
373 | * Called from if_cs_host_to_card to send a data to the hardware | |
374 | */ | |
69f9032d | 375 | static void if_cs_send_data(struct lbs_private *priv, u8 *buf, u16 nb) |
27590d06 HS |
376 | { |
377 | struct if_cs_card *card = (struct if_cs_card *)priv->card; | |
43d01c56 | 378 | u16 status; |
27590d06 HS |
379 | |
380 | lbs_deb_enter(LBS_DEB_CS); | |
43d01c56 HS |
381 | if_cs_disable_ints(card); |
382 | ||
78cf0747 HS |
383 | status = if_cs_read16(card, IF_CS_CARD_STATUS); |
384 | BUG_ON((status & IF_CS_BIT_TX) == 0); | |
27590d06 | 385 | |
a78a8325 | 386 | if_cs_write16(card, IF_CS_WRITE_LEN, nb); |
27590d06 HS |
387 | |
388 | /* write even number of bytes, then odd byte if necessary */ | |
a78a8325 | 389 | if_cs_write16_rep(card, IF_CS_WRITE, buf, nb / 2); |
27590d06 | 390 | if (nb & 1) |
a78a8325 | 391 | if_cs_write8(card, IF_CS_WRITE, buf[nb-1]); |
27590d06 | 392 | |
78cf0747 HS |
393 | if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_TX); |
394 | if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_TX); | |
43d01c56 | 395 | if_cs_enable_ints(card); |
27590d06 HS |
396 | |
397 | lbs_deb_leave(LBS_DEB_CS); | |
398 | } | |
399 | ||
27590d06 HS |
400 | /* |
401 | * Get the command result out of the card. | |
402 | */ | |
69f9032d | 403 | static int if_cs_receive_cmdres(struct lbs_private *priv, u8 *data, u32 *len) |
27590d06 | 404 | { |
7919b89c | 405 | unsigned long flags; |
27590d06 | 406 | int ret = -1; |
78cf0747 | 407 | u16 status; |
27590d06 HS |
408 | |
409 | lbs_deb_enter(LBS_DEB_CS); | |
410 | ||
411 | /* is hardware ready? */ | |
78cf0747 HS |
412 | status = if_cs_read16(priv->card, IF_CS_CARD_STATUS); |
413 | if ((status & IF_CS_BIT_RESP) == 0) { | |
414 | lbs_pr_err("no cmd response in card\n"); | |
415 | *len = 0; | |
27590d06 HS |
416 | goto out; |
417 | } | |
418 | ||
a78a8325 | 419 | *len = if_cs_read16(priv->card, IF_CS_RESP_LEN); |
ddac4526 | 420 | if ((*len == 0) || (*len > LBS_CMD_BUFFER_SIZE)) { |
27590d06 HS |
421 | lbs_pr_err("card cmd buffer has invalid # of bytes (%d)\n", *len); |
422 | goto out; | |
423 | } | |
424 | ||
425 | /* read even number of bytes, then odd byte if necessary */ | |
a78a8325 | 426 | if_cs_read16_rep(priv->card, IF_CS_RESP, data, *len/sizeof(u16)); |
27590d06 | 427 | if (*len & 1) |
a78a8325 | 428 | data[*len-1] = if_cs_read8(priv->card, IF_CS_RESP); |
27590d06 | 429 | |
09d4fad6 HS |
430 | /* This is a workaround for a firmware that reports too much |
431 | * bytes */ | |
432 | *len -= 8; | |
27590d06 | 433 | ret = 0; |
7919b89c HS |
434 | |
435 | /* Clear this flag again */ | |
436 | spin_lock_irqsave(&priv->driver_lock, flags); | |
437 | priv->dnld_sent = DNLD_RES_RECEIVED; | |
438 | spin_unlock_irqrestore(&priv->driver_lock, flags); | |
439 | ||
27590d06 HS |
440 | out: |
441 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d, len %d", ret, *len); | |
442 | return ret; | |
443 | } | |
444 | ||
69f9032d | 445 | static struct sk_buff *if_cs_receive_data(struct lbs_private *priv) |
27590d06 HS |
446 | { |
447 | struct sk_buff *skb = NULL; | |
448 | u16 len; | |
449 | u8 *data; | |
450 | ||
451 | lbs_deb_enter(LBS_DEB_CS); | |
452 | ||
78cf0747 | 453 | len = if_cs_read16(priv->card, IF_CS_READ_LEN); |
27590d06 HS |
454 | if (len == 0 || len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) { |
455 | lbs_pr_err("card data buffer has invalid # of bytes (%d)\n", len); | |
bbfc6b78 | 456 | priv->dev->stats.rx_dropped++; |
27590d06 HS |
457 | goto dat_err; |
458 | } | |
459 | ||
f31ce76b | 460 | skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + 2); |
27590d06 HS |
461 | if (!skb) |
462 | goto out; | |
f31ce76b VD |
463 | skb_put(skb, len); |
464 | skb_reserve(skb, 2);/* 16 byte align */ | |
465 | data = skb->data; | |
27590d06 HS |
466 | |
467 | /* read even number of bytes, then odd byte if necessary */ | |
78cf0747 | 468 | if_cs_read16_rep(priv->card, IF_CS_READ, data, len/sizeof(u16)); |
27590d06 | 469 | if (len & 1) |
78cf0747 | 470 | data[len-1] = if_cs_read8(priv->card, IF_CS_READ); |
27590d06 HS |
471 | |
472 | dat_err: | |
78cf0747 HS |
473 | if_cs_write16(priv->card, IF_CS_HOST_STATUS, IF_CS_BIT_RX); |
474 | if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_RX); | |
27590d06 HS |
475 | |
476 | out: | |
477 | lbs_deb_leave_args(LBS_DEB_CS, "ret %p", skb); | |
478 | return skb; | |
479 | } | |
480 | ||
7919b89c HS |
481 | static irqreturn_t if_cs_interrupt(int irq, void *data) |
482 | { | |
483 | struct if_cs_card *card = data; | |
484 | struct lbs_private *priv = card->priv; | |
485 | u16 cause; | |
486 | ||
487 | lbs_deb_enter(LBS_DEB_CS); | |
488 | ||
43d01c56 | 489 | /* Ask card interrupt cause register if there is something for us */ |
78cf0747 | 490 | cause = if_cs_read16(card, IF_CS_CARD_INT_CAUSE); |
30735561 HS |
491 | lbs_deb_cs("cause 0x%04x\n", cause); |
492 | ||
7919b89c HS |
493 | if (cause == 0) { |
494 | /* Not for us */ | |
495 | return IRQ_NONE; | |
496 | } | |
497 | ||
498 | if (cause == 0xffff) { | |
499 | /* Read in junk, the card has probably been removed */ | |
500 | card->priv->surpriseremoved = 1; | |
501 | return IRQ_HANDLED; | |
502 | } | |
503 | ||
78cf0747 | 504 | if (cause & IF_CS_BIT_RX) { |
7919b89c HS |
505 | struct sk_buff *skb; |
506 | lbs_deb_cs("rx packet\n"); | |
507 | skb = if_cs_receive_data(priv); | |
508 | if (skb) | |
509 | lbs_process_rxed_packet(priv, skb); | |
510 | } | |
511 | ||
78cf0747 | 512 | if (cause & IF_CS_BIT_TX) { |
43d01c56 | 513 | lbs_deb_cs("tx done\n"); |
7919b89c HS |
514 | lbs_host_to_card_done(priv); |
515 | } | |
516 | ||
78cf0747 | 517 | if (cause & IF_CS_BIT_RESP) { |
7919b89c HS |
518 | unsigned long flags; |
519 | u8 i; | |
520 | ||
43d01c56 | 521 | lbs_deb_cs("cmd resp\n"); |
7919b89c HS |
522 | spin_lock_irqsave(&priv->driver_lock, flags); |
523 | i = (priv->resp_idx == 0) ? 1 : 0; | |
524 | spin_unlock_irqrestore(&priv->driver_lock, flags); | |
525 | ||
526 | BUG_ON(priv->resp_len[i]); | |
527 | if_cs_receive_cmdres(priv, priv->resp_buf[i], | |
528 | &priv->resp_len[i]); | |
529 | ||
530 | spin_lock_irqsave(&priv->driver_lock, flags); | |
531 | lbs_notify_command_response(priv, i); | |
532 | spin_unlock_irqrestore(&priv->driver_lock, flags); | |
533 | } | |
534 | ||
78cf0747 | 535 | if (cause & IF_CS_BIT_EVENT) { |
a78a8325 | 536 | u16 status = if_cs_read16(priv->card, IF_CS_CARD_STATUS); |
78cf0747 HS |
537 | if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE, |
538 | IF_CS_BIT_EVENT); | |
a78a8325 | 539 | lbs_queue_event(priv, (status & IF_CS_CARD_STATUS_MASK) >> 8); |
7919b89c HS |
540 | } |
541 | ||
30735561 HS |
542 | /* Clear interrupt cause */ |
543 | if_cs_write16(card, IF_CS_CARD_INT_CAUSE, cause & IF_CS_BIT_MASK); | |
544 | ||
43d01c56 | 545 | lbs_deb_leave(LBS_DEB_CS); |
7919b89c HS |
546 | return IRQ_HANDLED; |
547 | } | |
548 | ||
549 | ||
550 | ||
551 | ||
27590d06 HS |
552 | /********************************************************************/ |
553 | /* Firmware */ | |
554 | /********************************************************************/ | |
555 | ||
556 | /* | |
557 | * Tries to program the helper firmware. | |
558 | * | |
559 | * Return 0 on success | |
560 | */ | |
561 | static int if_cs_prog_helper(struct if_cs_card *card) | |
562 | { | |
563 | int ret = 0; | |
564 | int sent = 0; | |
565 | u8 scratch; | |
566 | const struct firmware *fw; | |
567 | ||
568 | lbs_deb_enter(LBS_DEB_CS); | |
569 | ||
9d45368a MV |
570 | /* |
571 | * This is the only place where an unaligned register access happens on | |
572 | * the CF8305 card, therefore for the sake of speed of the driver, we do | |
573 | * the alignment correction here. | |
574 | */ | |
575 | if (card->align_regs) | |
576 | scratch = if_cs_read16(card, IF_CS_SCRATCH) >> 8; | |
577 | else | |
578 | scratch = if_cs_read8(card, IF_CS_SCRATCH); | |
27590d06 HS |
579 | |
580 | /* "If the value is 0x5a, the firmware is already | |
581 | * downloaded successfully" | |
582 | */ | |
53143256 | 583 | if (scratch == IF_CS_SCRATCH_HELPER_OK) |
27590d06 HS |
584 | goto done; |
585 | ||
586 | /* "If the value is != 00, it is invalid value of register */ | |
53143256 | 587 | if (scratch != IF_CS_SCRATCH_BOOT_OK) { |
27590d06 HS |
588 | ret = -ENODEV; |
589 | goto done; | |
590 | } | |
591 | ||
592 | /* TODO: make firmware file configurable */ | |
593 | ret = request_firmware(&fw, "libertas_cs_helper.fw", | |
dd2e5a15 | 594 | &card->p_dev->dev); |
27590d06 HS |
595 | if (ret) { |
596 | lbs_pr_err("can't load helper firmware\n"); | |
597 | ret = -ENODEV; | |
598 | goto done; | |
599 | } | |
4ecd41bd | 600 | lbs_deb_cs("helper size %td\n", fw->size); |
27590d06 HS |
601 | |
602 | /* "Set the 5 bytes of the helper image to 0" */ | |
603 | /* Not needed, this contains an ARM branch instruction */ | |
604 | ||
605 | for (;;) { | |
606 | /* "the number of bytes to send is 256" */ | |
607 | int count = 256; | |
608 | int remain = fw->size - sent; | |
609 | ||
610 | if (remain < count) | |
611 | count = remain; | |
27590d06 HS |
612 | |
613 | /* "write the number of bytes to be sent to the I/O Command | |
614 | * write length register" */ | |
a78a8325 | 615 | if_cs_write16(card, IF_CS_CMD_LEN, count); |
27590d06 HS |
616 | |
617 | /* "write this to I/O Command port register as 16 bit writes */ | |
618 | if (count) | |
a78a8325 | 619 | if_cs_write16_rep(card, IF_CS_CMD, |
27590d06 HS |
620 | &fw->data[sent], |
621 | count >> 1); | |
622 | ||
623 | /* "Assert the download over interrupt command in the Host | |
624 | * status register" */ | |
78cf0747 | 625 | if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND); |
27590d06 HS |
626 | |
627 | /* "Assert the download over interrupt command in the Card | |
628 | * interrupt case register" */ | |
78cf0747 | 629 | if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND); |
27590d06 HS |
630 | |
631 | /* "The host polls the Card Status register ... for 50 ms before | |
632 | declaring a failure */ | |
78cf0747 HS |
633 | ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS, |
634 | IF_CS_BIT_COMMAND); | |
27590d06 HS |
635 | if (ret < 0) { |
636 | lbs_pr_err("can't download helper at 0x%x, ret %d\n", | |
637 | sent, ret); | |
9a52028e | 638 | goto err_release; |
27590d06 HS |
639 | } |
640 | ||
641 | if (count == 0) | |
642 | break; | |
643 | ||
644 | sent += count; | |
645 | } | |
646 | ||
9a52028e | 647 | err_release: |
27590d06 | 648 | release_firmware(fw); |
27590d06 HS |
649 | done: |
650 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret); | |
651 | return ret; | |
652 | } | |
653 | ||
654 | ||
655 | static int if_cs_prog_real(struct if_cs_card *card) | |
656 | { | |
657 | const struct firmware *fw; | |
658 | int ret = 0; | |
659 | int retry = 0; | |
660 | int len = 0; | |
661 | int sent; | |
662 | ||
663 | lbs_deb_enter(LBS_DEB_CS); | |
664 | ||
665 | /* TODO: make firmware file configurable */ | |
666 | ret = request_firmware(&fw, "libertas_cs.fw", | |
dd2e5a15 | 667 | &card->p_dev->dev); |
27590d06 HS |
668 | if (ret) { |
669 | lbs_pr_err("can't load firmware\n"); | |
670 | ret = -ENODEV; | |
671 | goto done; | |
672 | } | |
4ecd41bd | 673 | lbs_deb_cs("fw size %td\n", fw->size); |
27590d06 | 674 | |
a78a8325 HS |
675 | ret = if_cs_poll_while_fw_download(card, IF_CS_SQ_READ_LOW, |
676 | IF_CS_SQ_HELPER_OK); | |
27590d06 | 677 | if (ret < 0) { |
27590d06 | 678 | lbs_pr_err("helper firmware doesn't answer\n"); |
27590d06 HS |
679 | goto err_release; |
680 | } | |
681 | ||
682 | for (sent = 0; sent < fw->size; sent += len) { | |
a78a8325 | 683 | len = if_cs_read16(card, IF_CS_SQ_READ_LOW); |
27590d06 HS |
684 | if (len & 1) { |
685 | retry++; | |
686 | lbs_pr_info("odd, need to retry this firmware block\n"); | |
687 | } else { | |
688 | retry = 0; | |
689 | } | |
690 | ||
691 | if (retry > 20) { | |
692 | lbs_pr_err("could not download firmware\n"); | |
693 | ret = -ENODEV; | |
694 | goto err_release; | |
695 | } | |
696 | if (retry) { | |
697 | sent -= len; | |
698 | } | |
699 | ||
700 | ||
a78a8325 | 701 | if_cs_write16(card, IF_CS_CMD_LEN, len); |
27590d06 | 702 | |
a78a8325 | 703 | if_cs_write16_rep(card, IF_CS_CMD, |
27590d06 HS |
704 | &fw->data[sent], |
705 | (len+1) >> 1); | |
78cf0747 HS |
706 | if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND); |
707 | if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND); | |
27590d06 | 708 | |
78cf0747 HS |
709 | ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS, |
710 | IF_CS_BIT_COMMAND); | |
27590d06 HS |
711 | if (ret < 0) { |
712 | lbs_pr_err("can't download firmware at 0x%x\n", sent); | |
713 | goto err_release; | |
714 | } | |
715 | } | |
716 | ||
717 | ret = if_cs_poll_while_fw_download(card, IF_CS_SCRATCH, 0x5a); | |
9a52028e | 718 | if (ret < 0) |
27590d06 | 719 | lbs_pr_err("firmware download failed\n"); |
27590d06 HS |
720 | |
721 | err_release: | |
722 | release_firmware(fw); | |
723 | ||
724 | done: | |
725 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret); | |
726 | return ret; | |
727 | } | |
728 | ||
729 | ||
730 | ||
731 | /********************************************************************/ | |
732 | /* Callback functions for libertas.ko */ | |
733 | /********************************************************************/ | |
734 | ||
27590d06 | 735 | /* Send commands or data packets to the card */ |
69f9032d HS |
736 | static int if_cs_host_to_card(struct lbs_private *priv, |
737 | u8 type, | |
738 | u8 *buf, | |
739 | u16 nb) | |
27590d06 HS |
740 | { |
741 | int ret = -1; | |
742 | ||
743 | lbs_deb_enter_args(LBS_DEB_CS, "type %d, bytes %d", type, nb); | |
744 | ||
745 | switch (type) { | |
746 | case MVMS_DAT: | |
6f05cbe5 | 747 | priv->dnld_sent = DNLD_DATA_SENT; |
27590d06 HS |
748 | if_cs_send_data(priv, buf, nb); |
749 | ret = 0; | |
750 | break; | |
751 | case MVMS_CMD: | |
6f05cbe5 | 752 | priv->dnld_sent = DNLD_CMD_SENT; |
27590d06 HS |
753 | ret = if_cs_send_cmd(priv, buf, nb); |
754 | break; | |
755 | default: | |
c94c93da | 756 | lbs_pr_err("%s: unsupported type %d\n", __func__, type); |
27590d06 HS |
757 | } |
758 | ||
759 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret); | |
760 | return ret; | |
761 | } | |
762 | ||
763 | ||
27590d06 HS |
764 | /********************************************************************/ |
765 | /* Card Services */ | |
766 | /********************************************************************/ | |
767 | ||
768 | /* | |
769 | * After a card is removed, if_cs_release() will unregister the | |
770 | * device, and release the PCMCIA configuration. If the device is | |
771 | * still open, this will be postponed until it is closed. | |
772 | */ | |
773 | static void if_cs_release(struct pcmcia_device *p_dev) | |
774 | { | |
775 | struct if_cs_card *card = p_dev->priv; | |
776 | ||
777 | lbs_deb_enter(LBS_DEB_CS); | |
778 | ||
eb14120f | 779 | free_irq(p_dev->irq, card); |
fdfb92ea | 780 | pcmcia_disable_device(p_dev); |
27590d06 HS |
781 | if (card->iobase) |
782 | ioport_unmap(card->iobase); | |
783 | ||
784 | lbs_deb_leave(LBS_DEB_CS); | |
785 | } | |
786 | ||
787 | ||
788 | /* | |
789 | * This creates an "instance" of the driver, allocating local data | |
790 | * structures for one device. The device is registered with Card | |
791 | * Services. | |
792 | * | |
793 | * The dev_link structure is initialized, but we don't actually | |
794 | * configure the card at this point -- we wait until we receive a card | |
795 | * insertion event. | |
796 | */ | |
aaa8cfda DB |
797 | |
798 | static int if_cs_ioprobe(struct pcmcia_device *p_dev, | |
799 | cistpl_cftable_entry_t *cfg, | |
800 | cistpl_cftable_entry_t *dflt, | |
801 | unsigned int vcc, | |
802 | void *priv_data) | |
803 | { | |
90abdc3b DB |
804 | p_dev->resource[0]->flags |= IO_DATA_PATH_WIDTH_AUTO; |
805 | p_dev->resource[0]->start = cfg->io.win[0].base; | |
806 | p_dev->resource[0]->end = cfg->io.win[0].len; | |
aaa8cfda DB |
807 | |
808 | /* Do we need to allocate an interrupt? */ | |
eb14120f | 809 | p_dev->conf.Attributes |= CONF_ENABLE_IRQ; |
aaa8cfda DB |
810 | |
811 | /* IO window settings */ | |
812 | if (cfg->io.nwin != 1) { | |
813 | lbs_pr_err("wrong CIS (check number of IO windows)\n"); | |
814 | return -ENODEV; | |
815 | } | |
816 | ||
817 | /* This reserves IO space but doesn't actually enable it */ | |
90abdc3b | 818 | return pcmcia_request_io(p_dev); |
aaa8cfda DB |
819 | } |
820 | ||
27590d06 HS |
821 | static int if_cs_probe(struct pcmcia_device *p_dev) |
822 | { | |
823 | int ret = -ENOMEM; | |
dc7d243d | 824 | unsigned int prod_id; |
69f9032d | 825 | struct lbs_private *priv; |
27590d06 | 826 | struct if_cs_card *card; |
27590d06 HS |
827 | |
828 | lbs_deb_enter(LBS_DEB_CS); | |
829 | ||
830 | card = kzalloc(sizeof(struct if_cs_card), GFP_KERNEL); | |
831 | if (!card) { | |
832 | lbs_pr_err("error in kzalloc\n"); | |
833 | goto out; | |
834 | } | |
835 | card->p_dev = p_dev; | |
836 | p_dev->priv = card; | |
837 | ||
27590d06 | 838 | p_dev->conf.Attributes = 0; |
27590d06 | 839 | |
aaa8cfda DB |
840 | if (pcmcia_loop_config(p_dev, if_cs_ioprobe, NULL)) { |
841 | lbs_pr_err("error in pcmcia_loop_config\n"); | |
27590d06 HS |
842 | goto out1; |
843 | } | |
27590d06 | 844 | |
27590d06 HS |
845 | |
846 | /* | |
847 | * Allocate an interrupt line. Note that this does not assign | |
848 | * a handler to the interrupt, unless the 'Handler' member of | |
849 | * the irq structure is initialized. | |
850 | */ | |
eb14120f DB |
851 | if (!p_dev->irq) |
852 | goto out1; | |
27590d06 HS |
853 | |
854 | /* Initialize io access */ | |
9a017a91 DB |
855 | card->iobase = ioport_map(p_dev->resource[0]->start, |
856 | resource_size(p_dev->resource[0])); | |
27590d06 HS |
857 | if (!card->iobase) { |
858 | lbs_pr_err("error in ioport_map\n"); | |
859 | ret = -EIO; | |
860 | goto out1; | |
861 | } | |
862 | ||
863 | /* | |
864 | * This actually configures the PCMCIA socket -- setting up | |
865 | * the I/O windows and the interrupt mapping, and putting the | |
866 | * card and host interface into "Memory and IO" mode. | |
867 | */ | |
868 | ret = pcmcia_request_configuration(p_dev, &p_dev->conf); | |
869 | if (ret) { | |
870 | lbs_pr_err("error in pcmcia_request_configuration\n"); | |
871 | goto out2; | |
872 | } | |
873 | ||
874 | /* Finally, report what we've done */ | |
9a017a91 | 875 | lbs_deb_cs("irq %d, io %pR", p_dev->irq, p_dev->resource[0]); |
27590d06 | 876 | |
9d45368a MV |
877 | /* |
878 | * Most of the libertas cards can do unaligned register access, but some | |
879 | * weird ones can not. That's especially true for the CF8305 card. | |
880 | */ | |
881 | card->align_regs = 0; | |
882 | ||
4c55523e | 883 | /* Check if we have a current silicon */ |
dc7d243d | 884 | prod_id = if_cs_read8(card, IF_CS_PRODUCT_ID); |
9d45368a MV |
885 | if (if_cs_hw_is_cf8305(p_dev)) { |
886 | card->align_regs = 1; | |
887 | if (prod_id < IF_CS_CF8305_B1_REV) { | |
888 | lbs_pr_err("old chips like 8305 rev B3 " | |
889 | "aren't supported\n"); | |
890 | ret = -ENODEV; | |
891 | goto out2; | |
892 | } | |
893 | } | |
894 | ||
dc7d243d MV |
895 | if (if_cs_hw_is_cf8381(p_dev) && prod_id < IF_CS_CF8381_B3_REV) { |
896 | lbs_pr_err("old chips like 8381 rev B3 aren't supported\n"); | |
897 | ret = -ENODEV; | |
898 | goto out2; | |
899 | } | |
900 | ||
901 | if (if_cs_hw_is_cf8385(p_dev) && prod_id < IF_CS_CF8385_B1_REV) { | |
4c55523e HS |
902 | lbs_pr_err("old chips like 8385 rev B1 aren't supported\n"); |
903 | ret = -ENODEV; | |
904 | goto out2; | |
905 | } | |
27590d06 HS |
906 | |
907 | /* Load the firmware early, before calling into libertas.ko */ | |
908 | ret = if_cs_prog_helper(card); | |
9d45368a | 909 | if (ret == 0 && !if_cs_hw_is_cf8305(p_dev)) |
27590d06 HS |
910 | ret = if_cs_prog_real(card); |
911 | if (ret) | |
912 | goto out2; | |
913 | ||
914 | /* Make this card known to the libertas driver */ | |
10078321 | 915 | priv = lbs_add_card(card, &p_dev->dev); |
27590d06 HS |
916 | if (!priv) { |
917 | ret = -ENOMEM; | |
918 | goto out2; | |
919 | } | |
920 | ||
7919b89c | 921 | /* Finish setting up fields in lbs_private */ |
954ee164 | 922 | card->priv = priv; |
27590d06 | 923 | priv->card = card; |
7919b89c | 924 | priv->hw_host_to_card = if_cs_host_to_card; |
49125454 AK |
925 | priv->enter_deep_sleep = NULL; |
926 | priv->exit_deep_sleep = NULL; | |
927 | priv->reset_deep_sleep_wakeup = NULL; | |
aa21c004 | 928 | priv->fw_ready = 1; |
954ee164 | 929 | |
27590d06 | 930 | /* Now actually get the IRQ */ |
eb14120f | 931 | ret = request_irq(p_dev->irq, if_cs_interrupt, |
27590d06 HS |
932 | IRQF_SHARED, DRV_NAME, card); |
933 | if (ret) { | |
934 | lbs_pr_err("error in request_irq\n"); | |
935 | goto out3; | |
936 | } | |
937 | ||
4ef31702 HS |
938 | /* Clear any interrupt cause that happend while sending |
939 | * firmware/initializing card */ | |
78cf0747 | 940 | if_cs_write16(card, IF_CS_CARD_INT_CAUSE, IF_CS_BIT_MASK); |
28de0b36 RM |
941 | if_cs_enable_ints(card); |
942 | ||
27590d06 | 943 | /* And finally bring the card up */ |
10078321 | 944 | if (lbs_start_card(priv) != 0) { |
27590d06 HS |
945 | lbs_pr_err("could not activate card\n"); |
946 | goto out3; | |
947 | } | |
948 | ||
949 | ret = 0; | |
950 | goto out; | |
951 | ||
952 | out3: | |
10078321 | 953 | lbs_remove_card(priv); |
27590d06 HS |
954 | out2: |
955 | ioport_unmap(card->iobase); | |
956 | out1: | |
957 | pcmcia_disable_device(p_dev); | |
958 | out: | |
959 | lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret); | |
960 | return ret; | |
961 | } | |
962 | ||
963 | ||
964 | /* | |
965 | * This deletes a driver "instance". The device is de-registered with | |
966 | * Card Services. If it has been released, all local data structures | |
967 | * are freed. Otherwise, the structures will be freed when the device | |
968 | * is released. | |
969 | */ | |
970 | static void if_cs_detach(struct pcmcia_device *p_dev) | |
971 | { | |
972 | struct if_cs_card *card = p_dev->priv; | |
973 | ||
974 | lbs_deb_enter(LBS_DEB_CS); | |
975 | ||
10078321 HS |
976 | lbs_stop_card(card->priv); |
977 | lbs_remove_card(card->priv); | |
28de0b36 | 978 | if_cs_disable_ints(card); |
27590d06 HS |
979 | if_cs_release(p_dev); |
980 | kfree(card); | |
981 | ||
982 | lbs_deb_leave(LBS_DEB_CS); | |
983 | } | |
984 | ||
985 | ||
986 | ||
987 | /********************************************************************/ | |
988 | /* Module initialization */ | |
989 | /********************************************************************/ | |
990 | ||
991 | static struct pcmcia_device_id if_cs_ids[] = { | |
9d45368a | 992 | PCMCIA_DEVICE_MANF_CARD(CF8305_MANFID, CF8305_CARDID), |
dc7d243d MV |
993 | PCMCIA_DEVICE_MANF_CARD(CF8381_MANFID, CF8381_CARDID), |
994 | PCMCIA_DEVICE_MANF_CARD(CF8385_MANFID, CF8385_CARDID), | |
27590d06 HS |
995 | PCMCIA_DEVICE_NULL, |
996 | }; | |
997 | MODULE_DEVICE_TABLE(pcmcia, if_cs_ids); | |
998 | ||
999 | ||
10078321 | 1000 | static struct pcmcia_driver lbs_driver = { |
27590d06 HS |
1001 | .owner = THIS_MODULE, |
1002 | .drv = { | |
1003 | .name = DRV_NAME, | |
1004 | }, | |
1005 | .probe = if_cs_probe, | |
1006 | .remove = if_cs_detach, | |
1007 | .id_table = if_cs_ids, | |
1008 | }; | |
1009 | ||
1010 | ||
1011 | static int __init if_cs_init(void) | |
1012 | { | |
1013 | int ret; | |
1014 | ||
1015 | lbs_deb_enter(LBS_DEB_CS); | |
10078321 | 1016 | ret = pcmcia_register_driver(&lbs_driver); |
27590d06 HS |
1017 | lbs_deb_leave(LBS_DEB_CS); |
1018 | return ret; | |
1019 | } | |
1020 | ||
1021 | ||
1022 | static void __exit if_cs_exit(void) | |
1023 | { | |
1024 | lbs_deb_enter(LBS_DEB_CS); | |
10078321 | 1025 | pcmcia_unregister_driver(&lbs_driver); |
27590d06 HS |
1026 | lbs_deb_leave(LBS_DEB_CS); |
1027 | } | |
1028 | ||
1029 | ||
1030 | module_init(if_cs_init); | |
1031 | module_exit(if_cs_exit); |