blob: 842a08d1f1063427a1550062c436b62e2fde8701 [file] [log] [blame]
Holger Schurig27590d02007-10-03 17:25:41 -07001/*
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>
25#include <linux/delay.h>
26#include <linux/moduleparam.h>
27#include <linux/firmware.h>
28#include <linux/netdevice.h>
29
30#include <pcmcia/cs_types.h>
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
48MODULE_AUTHOR("Holger Schurig <hs4233@mail.mn-solutions.de>");
49MODULE_DESCRIPTION("Driver for Marvell 83xx compact flash WLAN cards");
50MODULE_LICENSE("GPL");
51
52
53
54/********************************************************************/
55/* Data structures */
56/********************************************************************/
57
58struct if_cs_card {
59 struct pcmcia_device *p_dev;
Holger Schurig69f90322007-11-23 15:43:44 +010060 struct lbs_private *priv;
Holger Schurig27590d02007-10-03 17:25:41 -070061 void __iomem *iobase;
62};
63
64
65
66/********************************************************************/
67/* Hardware access */
68/********************************************************************/
69
70/* This define enables wrapper functions which allow you
71 to dump all register accesses. You normally won't this,
72 except for development */
73/* #define DEBUG_IO */
74
75#ifdef DEBUG_IO
76static int debug_output = 0;
77#else
78/* This way the compiler optimizes the printk's away */
79#define debug_output 0
80#endif
81
82static inline unsigned int if_cs_read8(struct if_cs_card *card, uint reg)
83{
84 unsigned int val = ioread8(card->iobase + reg);
85 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +020086 printk(KERN_INFO "inb %08x<%02x\n", reg, val);
Holger Schurig27590d02007-10-03 17:25:41 -070087 return val;
88}
89static inline unsigned int if_cs_read16(struct if_cs_card *card, uint reg)
90{
91 unsigned int val = ioread16(card->iobase + reg);
92 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +020093 printk(KERN_INFO "inw %08x<%04x\n", reg, val);
Holger Schurig27590d02007-10-03 17:25:41 -070094 return val;
95}
96static inline void if_cs_read16_rep(
97 struct if_cs_card *card,
98 uint reg,
99 void *buf,
100 unsigned long count)
101{
102 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +0200103 printk(KERN_INFO "insw %08x<(0x%lx words)\n",
Holger Schurig27590d02007-10-03 17:25:41 -0700104 reg, count);
105 ioread16_rep(card->iobase + reg, buf, count);
106}
107
108static inline void if_cs_write8(struct if_cs_card *card, uint reg, u8 val)
109{
110 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +0200111 printk(KERN_INFO "outb %08x>%02x\n", reg, val);
Holger Schurig27590d02007-10-03 17:25:41 -0700112 iowrite8(val, card->iobase + reg);
113}
114
115static inline void if_cs_write16(struct if_cs_card *card, uint reg, u16 val)
116{
117 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +0200118 printk(KERN_INFO "outw %08x>%04x\n", reg, val);
Holger Schurig27590d02007-10-03 17:25:41 -0700119 iowrite16(val, card->iobase + reg);
120}
121
122static inline void if_cs_write16_rep(
123 struct if_cs_card *card,
124 uint reg,
David Woodhouse6dfff892008-05-23 18:37:51 +0100125 const void *buf,
Holger Schurig27590d02007-10-03 17:25:41 -0700126 unsigned long count)
127{
128 if (debug_output)
Holger Schurig7919b892008-04-01 14:50:43 +0200129 printk(KERN_INFO "outsw %08x>(0x%lx words)\n",
Holger Schurig27590d02007-10-03 17:25:41 -0700130 reg, count);
131 iowrite16_rep(card->iobase + reg, buf, count);
132}
133
134
135/*
136 * I know that polling/delaying is frowned upon. However, this procedure
137 * with polling is needed while downloading the firmware. At this stage,
138 * the hardware does unfortunately not create any interrupts.
139 *
140 * Fortunately, this function is never used once the firmware is in
141 * the card. :-)
142 *
143 * As a reference, see the "Firmware Specification v5.1", page 18
144 * and 19. I did not follow their suggested timing to the word,
145 * but this works nice & fast anyway.
146 */
147static int if_cs_poll_while_fw_download(struct if_cs_card *card, uint addr, u8 reg)
148{
149 int i;
150
Holger Schurig93416c82008-05-23 10:18:26 +0200151 for (i = 0; i < 100000; i++) {
Holger Schurig27590d02007-10-03 17:25:41 -0700152 u8 val = if_cs_read8(card, addr);
153 if (val == reg)
154 return i;
Holger Schurig93416c82008-05-23 10:18:26 +0200155 udelay(5);
Holger Schurig27590d02007-10-03 17:25:41 -0700156 }
157 return -ETIME;
158}
159
160
161
Holger Schurig53143252008-06-05 13:07:04 +0200162/*
163 * First the bitmasks for the host/card interrupt/status registers:
164 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200165#define IF_CS_BIT_TX 0x0001
166#define IF_CS_BIT_RX 0x0002
167#define IF_CS_BIT_COMMAND 0x0004
168#define IF_CS_BIT_RESP 0x0008
169#define IF_CS_BIT_EVENT 0x0010
170#define IF_CS_BIT_MASK 0x001f
Holger Schurig27590d02007-10-03 17:25:41 -0700171
Holger Schurig53143252008-06-05 13:07:04 +0200172
173
174/*
175 * It's not really clear to me what the host status register is for. It
176 * needs to be set almost in union with "host int cause". The following
177 * bits from above are used:
178 *
179 * IF_CS_BIT_TX driver downloaded a data packet
180 * IF_CS_BIT_RX driver got a data packet
181 * IF_CS_BIT_COMMAND driver downloaded a command
182 * IF_CS_BIT_RESP not used (has some meaning with powerdown)
183 * IF_CS_BIT_EVENT driver read a host event
184 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200185#define IF_CS_HOST_STATUS 0x00000000
Holger Schurig27590d02007-10-03 17:25:41 -0700186
Holger Schurig53143252008-06-05 13:07:04 +0200187/*
188 * With the host int cause register can the host (that is, Linux) cause
189 * an interrupt in the firmware, to tell the firmware about those events:
190 *
191 * IF_CS_BIT_TX a data packet has been downloaded
192 * IF_CS_BIT_RX a received data packet has retrieved
193 * IF_CS_BIT_COMMAND a firmware block or a command has been downloaded
194 * IF_CS_BIT_RESP not used (has some meaning with powerdown)
195 * IF_CS_BIT_EVENT a host event (link lost etc) has been retrieved
196 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200197#define IF_CS_HOST_INT_CAUSE 0x00000002
Holger Schurig27590d02007-10-03 17:25:41 -0700198
Holger Schurig53143252008-06-05 13:07:04 +0200199/*
200 * The host int mask register is used to enable/disable interrupt. However,
201 * I have the suspicion that disabled interrupts are lost.
202 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200203#define IF_CS_HOST_INT_MASK 0x00000004
Holger Schurig27590d02007-10-03 17:25:41 -0700204
Holger Schurig53143252008-06-05 13:07:04 +0200205/*
206 * Used to send or receive data packets:
207 */
Holger Schuriga78a8322008-06-05 13:09:50 +0200208#define IF_CS_WRITE 0x00000016
209#define IF_CS_WRITE_LEN 0x00000014
Holger Schurig78cf0742008-06-02 09:25:05 +0200210#define IF_CS_READ 0x00000010
211#define IF_CS_READ_LEN 0x00000024
Holger Schurig27590d02007-10-03 17:25:41 -0700212
Holger Schurig53143252008-06-05 13:07:04 +0200213/*
214 * Used to send commands (and to send firmware block) and to
215 * receive command responses:
216 */
Holger Schuriga78a8322008-06-05 13:09:50 +0200217#define IF_CS_CMD 0x0000001A
218#define IF_CS_CMD_LEN 0x00000018
219#define IF_CS_RESP 0x00000012
220#define IF_CS_RESP_LEN 0x00000030
Holger Schurig27590d02007-10-03 17:25:41 -0700221
Holger Schurig53143252008-06-05 13:07:04 +0200222/*
223 * The card status registers shows what the card/firmware actually
224 * accepts:
225 *
226 * IF_CS_BIT_TX you may send a data packet
227 * IF_CS_BIT_RX you may retrieve a data packet
228 * IF_CS_BIT_COMMAND you may send a command
229 * IF_CS_BIT_RESP you may retrieve a command response
230 * IF_CS_BIT_EVENT the card has a event for use (link lost, snr low etc)
231 *
232 * When reading this register several times, you will get back the same
233 * results --- with one exception: the IF_CS_BIT_EVENT clear itself
234 * automatically.
235 *
236 * Not that we don't rely on BIT_RX,_BIT_RESP or BIT_EVENT because
237 * we handle this via the card int cause register.
238 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200239#define IF_CS_CARD_STATUS 0x00000020
240#define IF_CS_CARD_STATUS_MASK 0x7f00
Holger Schurig27590d02007-10-03 17:25:41 -0700241
Holger Schurig53143252008-06-05 13:07:04 +0200242/*
243 * The card int cause register is used by the card/firmware to notify us
244 * about the following events:
245 *
246 * IF_CS_BIT_TX a data packet has successfully been sentx
247 * IF_CS_BIT_RX a data packet has been received and can be retrieved
248 * IF_CS_BIT_COMMAND not used
249 * IF_CS_BIT_RESP the firmware has a command response for us
250 * IF_CS_BIT_EVENT the card has a event for use (link lost, snr low etc)
251 */
Holger Schurig78cf0742008-06-02 09:25:05 +0200252#define IF_CS_CARD_INT_CAUSE 0x00000022
Holger Schurig27590d02007-10-03 17:25:41 -0700253
Holger Schurig53143252008-06-05 13:07:04 +0200254/*
255 * This is used to for handshaking with the card's bootloader/helper image
256 * to synchronize downloading of firmware blocks.
257 */
Holger Schuriga78a8322008-06-05 13:09:50 +0200258#define IF_CS_SQ_READ_LOW 0x00000028
259#define IF_CS_SQ_HELPER_OK 0x10
Holger Schurig27590d02007-10-03 17:25:41 -0700260
Holger Schurig53143252008-06-05 13:07:04 +0200261/*
262 * The scratch register tells us ...
263 *
264 * IF_CS_SCRATCH_BOOT_OK the bootloader runs
265 * IF_CS_SCRATCH_HELPER_OK the helper firmware already runs
266 */
Holger Schurig27590d02007-10-03 17:25:41 -0700267#define IF_CS_SCRATCH 0x0000003F
Holger Schurig53143252008-06-05 13:07:04 +0200268#define IF_CS_SCRATCH_BOOT_OK 0x00
269#define IF_CS_SCRATCH_HELPER_OK 0x5a
Holger Schurig27590d02007-10-03 17:25:41 -0700270
Holger Schurig4c555232008-06-05 13:08:35 +0200271/*
272 * Used to detect ancient chips:
273 */
274#define IF_CS_PRODUCT_ID 0x0000001C
275#define IF_CS_CF8385_B1_REV 0x12
276
Holger Schurig27590d02007-10-03 17:25:41 -0700277
278/********************************************************************/
Holger Schurig43d01c52008-05-26 12:50:23 +0200279/* I/O and interrupt handling */
Holger Schurig27590d02007-10-03 17:25:41 -0700280/********************************************************************/
281
Holger Schurig43d01c52008-05-26 12:50:23 +0200282static inline void if_cs_enable_ints(struct if_cs_card *card)
283{
284 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig78cf0742008-06-02 09:25:05 +0200285 if_cs_write16(card, IF_CS_HOST_INT_MASK, 0);
Holger Schurig43d01c52008-05-26 12:50:23 +0200286}
287
288static inline void if_cs_disable_ints(struct if_cs_card *card)
289{
290 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig78cf0742008-06-02 09:25:05 +0200291 if_cs_write16(card, IF_CS_HOST_INT_MASK, IF_CS_BIT_MASK);
Holger Schurig43d01c52008-05-26 12:50:23 +0200292}
293
Holger Schurig27590d02007-10-03 17:25:41 -0700294/*
295 * Called from if_cs_host_to_card to send a command to the hardware
296 */
Holger Schurig69f90322007-11-23 15:43:44 +0100297static int if_cs_send_cmd(struct lbs_private *priv, u8 *buf, u16 nb)
Holger Schurig27590d02007-10-03 17:25:41 -0700298{
299 struct if_cs_card *card = (struct if_cs_card *)priv->card;
300 int ret = -1;
301 int loops = 0;
302
303 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig43d01c52008-05-26 12:50:23 +0200304 if_cs_disable_ints(card);
Holger Schurig27590d02007-10-03 17:25:41 -0700305
306 /* Is hardware ready? */
307 while (1) {
Holger Schuriga78a8322008-06-05 13:09:50 +0200308 u16 status = if_cs_read16(card, IF_CS_CARD_STATUS);
309 if (status & IF_CS_BIT_COMMAND)
Holger Schurig27590d02007-10-03 17:25:41 -0700310 break;
311 if (++loops > 100) {
312 lbs_pr_err("card not ready for commands\n");
313 goto done;
314 }
315 mdelay(1);
316 }
317
Holger Schuriga78a8322008-06-05 13:09:50 +0200318 if_cs_write16(card, IF_CS_CMD_LEN, nb);
Holger Schurig27590d02007-10-03 17:25:41 -0700319
Holger Schuriga78a8322008-06-05 13:09:50 +0200320 if_cs_write16_rep(card, IF_CS_CMD, buf, nb / 2);
Holger Schurig27590d02007-10-03 17:25:41 -0700321 /* Are we supposed to transfer an odd amount of bytes? */
322 if (nb & 1)
Holger Schuriga78a8322008-06-05 13:09:50 +0200323 if_cs_write8(card, IF_CS_CMD, buf[nb-1]);
Holger Schurig27590d02007-10-03 17:25:41 -0700324
325 /* "Assert the download over interrupt command in the Host
326 * status register" */
Holger Schurig78cf0742008-06-02 09:25:05 +0200327 if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700328
329 /* "Assert the download over interrupt command in the Card
330 * interrupt case register" */
Holger Schurig78cf0742008-06-02 09:25:05 +0200331 if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700332 ret = 0;
333
334done:
Holger Schurig43d01c52008-05-26 12:50:23 +0200335 if_cs_enable_ints(card);
Holger Schurig27590d02007-10-03 17:25:41 -0700336 lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
337 return ret;
338}
339
Holger Schurig27590d02007-10-03 17:25:41 -0700340/*
341 * Called from if_cs_host_to_card to send a data to the hardware
342 */
Holger Schurig69f90322007-11-23 15:43:44 +0100343static void if_cs_send_data(struct lbs_private *priv, u8 *buf, u16 nb)
Holger Schurig27590d02007-10-03 17:25:41 -0700344{
345 struct if_cs_card *card = (struct if_cs_card *)priv->card;
Holger Schurig43d01c52008-05-26 12:50:23 +0200346 u16 status;
Holger Schurig27590d02007-10-03 17:25:41 -0700347
348 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig43d01c52008-05-26 12:50:23 +0200349 if_cs_disable_ints(card);
350
Holger Schurig78cf0742008-06-02 09:25:05 +0200351 status = if_cs_read16(card, IF_CS_CARD_STATUS);
352 BUG_ON((status & IF_CS_BIT_TX) == 0);
Holger Schurig27590d02007-10-03 17:25:41 -0700353
Holger Schuriga78a8322008-06-05 13:09:50 +0200354 if_cs_write16(card, IF_CS_WRITE_LEN, nb);
Holger Schurig27590d02007-10-03 17:25:41 -0700355
356 /* write even number of bytes, then odd byte if necessary */
Holger Schuriga78a8322008-06-05 13:09:50 +0200357 if_cs_write16_rep(card, IF_CS_WRITE, buf, nb / 2);
Holger Schurig27590d02007-10-03 17:25:41 -0700358 if (nb & 1)
Holger Schuriga78a8322008-06-05 13:09:50 +0200359 if_cs_write8(card, IF_CS_WRITE, buf[nb-1]);
Holger Schurig27590d02007-10-03 17:25:41 -0700360
Holger Schurig78cf0742008-06-02 09:25:05 +0200361 if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_TX);
362 if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_TX);
Holger Schurig43d01c52008-05-26 12:50:23 +0200363 if_cs_enable_ints(card);
Holger Schurig27590d02007-10-03 17:25:41 -0700364
365 lbs_deb_leave(LBS_DEB_CS);
366}
367
Holger Schurig27590d02007-10-03 17:25:41 -0700368/*
369 * Get the command result out of the card.
370 */
Holger Schurig69f90322007-11-23 15:43:44 +0100371static int if_cs_receive_cmdres(struct lbs_private *priv, u8 *data, u32 *len)
Holger Schurig27590d02007-10-03 17:25:41 -0700372{
Holger Schurig7919b892008-04-01 14:50:43 +0200373 unsigned long flags;
Holger Schurig27590d02007-10-03 17:25:41 -0700374 int ret = -1;
Holger Schurig78cf0742008-06-02 09:25:05 +0200375 u16 status;
Holger Schurig27590d02007-10-03 17:25:41 -0700376
377 lbs_deb_enter(LBS_DEB_CS);
378
379 /* is hardware ready? */
Holger Schurig78cf0742008-06-02 09:25:05 +0200380 status = if_cs_read16(priv->card, IF_CS_CARD_STATUS);
381 if ((status & IF_CS_BIT_RESP) == 0) {
382 lbs_pr_err("no cmd response in card\n");
383 *len = 0;
Holger Schurig27590d02007-10-03 17:25:41 -0700384 goto out;
385 }
386
Holger Schuriga78a8322008-06-05 13:09:50 +0200387 *len = if_cs_read16(priv->card, IF_CS_RESP_LEN);
Dan Williamsddac4522007-12-11 13:49:39 -0500388 if ((*len == 0) || (*len > LBS_CMD_BUFFER_SIZE)) {
Holger Schurig27590d02007-10-03 17:25:41 -0700389 lbs_pr_err("card cmd buffer has invalid # of bytes (%d)\n", *len);
390 goto out;
391 }
392
393 /* read even number of bytes, then odd byte if necessary */
Holger Schuriga78a8322008-06-05 13:09:50 +0200394 if_cs_read16_rep(priv->card, IF_CS_RESP, data, *len/sizeof(u16));
Holger Schurig27590d02007-10-03 17:25:41 -0700395 if (*len & 1)
Holger Schuriga78a8322008-06-05 13:09:50 +0200396 data[*len-1] = if_cs_read8(priv->card, IF_CS_RESP);
Holger Schurig27590d02007-10-03 17:25:41 -0700397
Holger Schurig09d4fad2007-12-06 13:50:30 +0100398 /* This is a workaround for a firmware that reports too much
399 * bytes */
400 *len -= 8;
Holger Schurig27590d02007-10-03 17:25:41 -0700401 ret = 0;
Holger Schurig7919b892008-04-01 14:50:43 +0200402
403 /* Clear this flag again */
404 spin_lock_irqsave(&priv->driver_lock, flags);
405 priv->dnld_sent = DNLD_RES_RECEIVED;
406 spin_unlock_irqrestore(&priv->driver_lock, flags);
407
Holger Schurig27590d02007-10-03 17:25:41 -0700408out:
409 lbs_deb_leave_args(LBS_DEB_CS, "ret %d, len %d", ret, *len);
410 return ret;
411}
412
Holger Schurig69f90322007-11-23 15:43:44 +0100413static struct sk_buff *if_cs_receive_data(struct lbs_private *priv)
Holger Schurig27590d02007-10-03 17:25:41 -0700414{
415 struct sk_buff *skb = NULL;
416 u16 len;
417 u8 *data;
418
419 lbs_deb_enter(LBS_DEB_CS);
420
Holger Schurig78cf0742008-06-02 09:25:05 +0200421 len = if_cs_read16(priv->card, IF_CS_READ_LEN);
Holger Schurig27590d02007-10-03 17:25:41 -0700422 if (len == 0 || len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
423 lbs_pr_err("card data buffer has invalid # of bytes (%d)\n", len);
424 priv->stats.rx_dropped++;
Holger Schurig27590d02007-10-03 17:25:41 -0700425 goto dat_err;
426 }
427
Vladimir Davydovf31ce76b2007-09-06 21:41:02 -0400428 skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + 2);
Holger Schurig27590d02007-10-03 17:25:41 -0700429 if (!skb)
430 goto out;
Vladimir Davydovf31ce76b2007-09-06 21:41:02 -0400431 skb_put(skb, len);
432 skb_reserve(skb, 2);/* 16 byte align */
433 data = skb->data;
Holger Schurig27590d02007-10-03 17:25:41 -0700434
435 /* read even number of bytes, then odd byte if necessary */
Holger Schurig78cf0742008-06-02 09:25:05 +0200436 if_cs_read16_rep(priv->card, IF_CS_READ, data, len/sizeof(u16));
Holger Schurig27590d02007-10-03 17:25:41 -0700437 if (len & 1)
Holger Schurig78cf0742008-06-02 09:25:05 +0200438 data[len-1] = if_cs_read8(priv->card, IF_CS_READ);
Holger Schurig27590d02007-10-03 17:25:41 -0700439
440dat_err:
Holger Schurig78cf0742008-06-02 09:25:05 +0200441 if_cs_write16(priv->card, IF_CS_HOST_STATUS, IF_CS_BIT_RX);
442 if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_RX);
Holger Schurig27590d02007-10-03 17:25:41 -0700443
444out:
445 lbs_deb_leave_args(LBS_DEB_CS, "ret %p", skb);
446 return skb;
447}
448
Holger Schurig7919b892008-04-01 14:50:43 +0200449static irqreturn_t if_cs_interrupt(int irq, void *data)
450{
451 struct if_cs_card *card = data;
452 struct lbs_private *priv = card->priv;
453 u16 cause;
454
455 lbs_deb_enter(LBS_DEB_CS);
456
Holger Schurig43d01c52008-05-26 12:50:23 +0200457 /* Ask card interrupt cause register if there is something for us */
Holger Schurig78cf0742008-06-02 09:25:05 +0200458 cause = if_cs_read16(card, IF_CS_CARD_INT_CAUSE);
Holger Schurig30735562008-06-05 13:06:15 +0200459 lbs_deb_cs("cause 0x%04x\n", cause);
460
Holger Schurig7919b892008-04-01 14:50:43 +0200461 if (cause == 0) {
462 /* Not for us */
463 return IRQ_NONE;
464 }
465
466 if (cause == 0xffff) {
467 /* Read in junk, the card has probably been removed */
468 card->priv->surpriseremoved = 1;
469 return IRQ_HANDLED;
470 }
471
Holger Schurig78cf0742008-06-02 09:25:05 +0200472 if (cause & IF_CS_BIT_RX) {
Holger Schurig7919b892008-04-01 14:50:43 +0200473 struct sk_buff *skb;
474 lbs_deb_cs("rx packet\n");
475 skb = if_cs_receive_data(priv);
476 if (skb)
477 lbs_process_rxed_packet(priv, skb);
478 }
479
Holger Schurig78cf0742008-06-02 09:25:05 +0200480 if (cause & IF_CS_BIT_TX) {
Holger Schurig43d01c52008-05-26 12:50:23 +0200481 lbs_deb_cs("tx done\n");
Holger Schurig7919b892008-04-01 14:50:43 +0200482 lbs_host_to_card_done(priv);
483 }
484
Holger Schurig78cf0742008-06-02 09:25:05 +0200485 if (cause & IF_CS_BIT_RESP) {
Holger Schurig7919b892008-04-01 14:50:43 +0200486 unsigned long flags;
487 u8 i;
488
Holger Schurig43d01c52008-05-26 12:50:23 +0200489 lbs_deb_cs("cmd resp\n");
Holger Schurig7919b892008-04-01 14:50:43 +0200490 spin_lock_irqsave(&priv->driver_lock, flags);
491 i = (priv->resp_idx == 0) ? 1 : 0;
492 spin_unlock_irqrestore(&priv->driver_lock, flags);
493
494 BUG_ON(priv->resp_len[i]);
495 if_cs_receive_cmdres(priv, priv->resp_buf[i],
496 &priv->resp_len[i]);
497
498 spin_lock_irqsave(&priv->driver_lock, flags);
499 lbs_notify_command_response(priv, i);
500 spin_unlock_irqrestore(&priv->driver_lock, flags);
501 }
502
Holger Schurig78cf0742008-06-02 09:25:05 +0200503 if (cause & IF_CS_BIT_EVENT) {
Holger Schuriga78a8322008-06-05 13:09:50 +0200504 u16 status = if_cs_read16(priv->card, IF_CS_CARD_STATUS);
Holger Schurig78cf0742008-06-02 09:25:05 +0200505 if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE,
506 IF_CS_BIT_EVENT);
Holger Schuriga78a8322008-06-05 13:09:50 +0200507 lbs_queue_event(priv, (status & IF_CS_CARD_STATUS_MASK) >> 8);
Holger Schurig7919b892008-04-01 14:50:43 +0200508 }
509
Holger Schurig30735562008-06-05 13:06:15 +0200510 /* Clear interrupt cause */
511 if_cs_write16(card, IF_CS_CARD_INT_CAUSE, cause & IF_CS_BIT_MASK);
512
Holger Schurig43d01c52008-05-26 12:50:23 +0200513 lbs_deb_leave(LBS_DEB_CS);
Holger Schurig7919b892008-04-01 14:50:43 +0200514 return IRQ_HANDLED;
515}
516
517
518
519
520/********************************************************************/
Holger Schurig27590d02007-10-03 17:25:41 -0700521/* Firmware */
522/********************************************************************/
523
524/*
525 * Tries to program the helper firmware.
526 *
527 * Return 0 on success
528 */
529static int if_cs_prog_helper(struct if_cs_card *card)
530{
531 int ret = 0;
532 int sent = 0;
533 u8 scratch;
534 const struct firmware *fw;
535
536 lbs_deb_enter(LBS_DEB_CS);
537
538 scratch = if_cs_read8(card, IF_CS_SCRATCH);
539
540 /* "If the value is 0x5a, the firmware is already
541 * downloaded successfully"
542 */
Holger Schurig53143252008-06-05 13:07:04 +0200543 if (scratch == IF_CS_SCRATCH_HELPER_OK)
Holger Schurig27590d02007-10-03 17:25:41 -0700544 goto done;
545
546 /* "If the value is != 00, it is invalid value of register */
Holger Schurig53143252008-06-05 13:07:04 +0200547 if (scratch != IF_CS_SCRATCH_BOOT_OK) {
Holger Schurig27590d02007-10-03 17:25:41 -0700548 ret = -ENODEV;
549 goto done;
550 }
551
552 /* TODO: make firmware file configurable */
553 ret = request_firmware(&fw, "libertas_cs_helper.fw",
554 &handle_to_dev(card->p_dev));
555 if (ret) {
556 lbs_pr_err("can't load helper firmware\n");
557 ret = -ENODEV;
558 goto done;
559 }
Andrew Morton4ecd41b2007-08-21 02:15:45 -0700560 lbs_deb_cs("helper size %td\n", fw->size);
Holger Schurig27590d02007-10-03 17:25:41 -0700561
562 /* "Set the 5 bytes of the helper image to 0" */
563 /* Not needed, this contains an ARM branch instruction */
564
565 for (;;) {
566 /* "the number of bytes to send is 256" */
567 int count = 256;
568 int remain = fw->size - sent;
569
570 if (remain < count)
571 count = remain;
Holger Schurig27590d02007-10-03 17:25:41 -0700572
573 /* "write the number of bytes to be sent to the I/O Command
574 * write length register" */
Holger Schuriga78a8322008-06-05 13:09:50 +0200575 if_cs_write16(card, IF_CS_CMD_LEN, count);
Holger Schurig27590d02007-10-03 17:25:41 -0700576
577 /* "write this to I/O Command port register as 16 bit writes */
578 if (count)
Holger Schuriga78a8322008-06-05 13:09:50 +0200579 if_cs_write16_rep(card, IF_CS_CMD,
Holger Schurig27590d02007-10-03 17:25:41 -0700580 &fw->data[sent],
581 count >> 1);
582
583 /* "Assert the download over interrupt command in the Host
584 * status register" */
Holger Schurig78cf0742008-06-02 09:25:05 +0200585 if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700586
587 /* "Assert the download over interrupt command in the Card
588 * interrupt case register" */
Holger Schurig78cf0742008-06-02 09:25:05 +0200589 if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700590
591 /* "The host polls the Card Status register ... for 50 ms before
592 declaring a failure */
Holger Schurig78cf0742008-06-02 09:25:05 +0200593 ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS,
594 IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700595 if (ret < 0) {
596 lbs_pr_err("can't download helper at 0x%x, ret %d\n",
597 sent, ret);
Adrian Bunk9a520282008-08-28 01:05:08 +0300598 goto err_release;
Holger Schurig27590d02007-10-03 17:25:41 -0700599 }
600
601 if (count == 0)
602 break;
603
604 sent += count;
605 }
606
Adrian Bunk9a520282008-08-28 01:05:08 +0300607err_release:
Holger Schurig27590d02007-10-03 17:25:41 -0700608 release_firmware(fw);
Holger Schurig27590d02007-10-03 17:25:41 -0700609done:
610 lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
611 return ret;
612}
613
614
615static int if_cs_prog_real(struct if_cs_card *card)
616{
617 const struct firmware *fw;
618 int ret = 0;
619 int retry = 0;
620 int len = 0;
621 int sent;
622
623 lbs_deb_enter(LBS_DEB_CS);
624
625 /* TODO: make firmware file configurable */
626 ret = request_firmware(&fw, "libertas_cs.fw",
627 &handle_to_dev(card->p_dev));
628 if (ret) {
629 lbs_pr_err("can't load firmware\n");
630 ret = -ENODEV;
631 goto done;
632 }
Andrew Morton4ecd41b2007-08-21 02:15:45 -0700633 lbs_deb_cs("fw size %td\n", fw->size);
Holger Schurig27590d02007-10-03 17:25:41 -0700634
Holger Schuriga78a8322008-06-05 13:09:50 +0200635 ret = if_cs_poll_while_fw_download(card, IF_CS_SQ_READ_LOW,
636 IF_CS_SQ_HELPER_OK);
Holger Schurig27590d02007-10-03 17:25:41 -0700637 if (ret < 0) {
Holger Schurig27590d02007-10-03 17:25:41 -0700638 lbs_pr_err("helper firmware doesn't answer\n");
Holger Schurig27590d02007-10-03 17:25:41 -0700639 goto err_release;
640 }
641
642 for (sent = 0; sent < fw->size; sent += len) {
Holger Schuriga78a8322008-06-05 13:09:50 +0200643 len = if_cs_read16(card, IF_CS_SQ_READ_LOW);
Holger Schurig27590d02007-10-03 17:25:41 -0700644 if (len & 1) {
645 retry++;
646 lbs_pr_info("odd, need to retry this firmware block\n");
647 } else {
648 retry = 0;
649 }
650
651 if (retry > 20) {
652 lbs_pr_err("could not download firmware\n");
653 ret = -ENODEV;
654 goto err_release;
655 }
656 if (retry) {
657 sent -= len;
658 }
659
660
Holger Schuriga78a8322008-06-05 13:09:50 +0200661 if_cs_write16(card, IF_CS_CMD_LEN, len);
Holger Schurig27590d02007-10-03 17:25:41 -0700662
Holger Schuriga78a8322008-06-05 13:09:50 +0200663 if_cs_write16_rep(card, IF_CS_CMD,
Holger Schurig27590d02007-10-03 17:25:41 -0700664 &fw->data[sent],
665 (len+1) >> 1);
Holger Schurig78cf0742008-06-02 09:25:05 +0200666 if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
667 if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700668
Holger Schurig78cf0742008-06-02 09:25:05 +0200669 ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS,
670 IF_CS_BIT_COMMAND);
Holger Schurig27590d02007-10-03 17:25:41 -0700671 if (ret < 0) {
672 lbs_pr_err("can't download firmware at 0x%x\n", sent);
673 goto err_release;
674 }
675 }
676
677 ret = if_cs_poll_while_fw_download(card, IF_CS_SCRATCH, 0x5a);
Adrian Bunk9a520282008-08-28 01:05:08 +0300678 if (ret < 0)
Holger Schurig27590d02007-10-03 17:25:41 -0700679 lbs_pr_err("firmware download failed\n");
Holger Schurig27590d02007-10-03 17:25:41 -0700680
681err_release:
682 release_firmware(fw);
683
684done:
685 lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
686 return ret;
687}
688
689
690
691/********************************************************************/
692/* Callback functions for libertas.ko */
693/********************************************************************/
694
Holger Schurig27590d02007-10-03 17:25:41 -0700695/* Send commands or data packets to the card */
Holger Schurig69f90322007-11-23 15:43:44 +0100696static int if_cs_host_to_card(struct lbs_private *priv,
697 u8 type,
698 u8 *buf,
699 u16 nb)
Holger Schurig27590d02007-10-03 17:25:41 -0700700{
701 int ret = -1;
702
703 lbs_deb_enter_args(LBS_DEB_CS, "type %d, bytes %d", type, nb);
704
705 switch (type) {
706 case MVMS_DAT:
Ryan Mallon6f05cbe2007-09-06 21:30:32 -0400707 priv->dnld_sent = DNLD_DATA_SENT;
Holger Schurig27590d02007-10-03 17:25:41 -0700708 if_cs_send_data(priv, buf, nb);
709 ret = 0;
710 break;
711 case MVMS_CMD:
Ryan Mallon6f05cbe2007-09-06 21:30:32 -0400712 priv->dnld_sent = DNLD_CMD_SENT;
Holger Schurig27590d02007-10-03 17:25:41 -0700713 ret = if_cs_send_cmd(priv, buf, nb);
714 break;
715 default:
Harvey Harrisonc94c93d2008-07-28 23:01:34 -0700716 lbs_pr_err("%s: unsupported type %d\n", __func__, type);
Holger Schurig27590d02007-10-03 17:25:41 -0700717 }
718
719 lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
720 return ret;
721}
722
723
Holger Schurig27590d02007-10-03 17:25:41 -0700724/********************************************************************/
725/* Card Services */
726/********************************************************************/
727
728/*
729 * After a card is removed, if_cs_release() will unregister the
730 * device, and release the PCMCIA configuration. If the device is
731 * still open, this will be postponed until it is closed.
732 */
733static void if_cs_release(struct pcmcia_device *p_dev)
734{
735 struct if_cs_card *card = p_dev->priv;
736
737 lbs_deb_enter(LBS_DEB_CS);
738
Holger Schurig27590d02007-10-03 17:25:41 -0700739 free_irq(p_dev->irq.AssignedIRQ, card);
Holger Schurigfdfb92e2008-01-25 14:15:48 +0100740 pcmcia_disable_device(p_dev);
Holger Schurig27590d02007-10-03 17:25:41 -0700741 if (card->iobase)
742 ioport_unmap(card->iobase);
743
744 lbs_deb_leave(LBS_DEB_CS);
745}
746
747
748/*
749 * This creates an "instance" of the driver, allocating local data
750 * structures for one device. The device is registered with Card
751 * Services.
752 *
753 * The dev_link structure is initialized, but we don't actually
754 * configure the card at this point -- we wait until we receive a card
755 * insertion event.
756 */
757static int if_cs_probe(struct pcmcia_device *p_dev)
758{
759 int ret = -ENOMEM;
Holger Schurig69f90322007-11-23 15:43:44 +0100760 struct lbs_private *priv;
Holger Schurig27590d02007-10-03 17:25:41 -0700761 struct if_cs_card *card;
762 /* CIS parsing */
763 tuple_t tuple;
764 cisparse_t parse;
765 cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
766 cistpl_io_t *io = &cfg->io;
767 u_char buf[64];
768
769 lbs_deb_enter(LBS_DEB_CS);
770
771 card = kzalloc(sizeof(struct if_cs_card), GFP_KERNEL);
772 if (!card) {
773 lbs_pr_err("error in kzalloc\n");
774 goto out;
775 }
776 card->p_dev = p_dev;
777 p_dev->priv = card;
778
779 p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
780 p_dev->irq.Handler = NULL;
781 p_dev->irq.IRQInfo1 = IRQ_INFO2_VALID | IRQ_LEVEL_ID;
782
783 p_dev->conf.Attributes = 0;
784 p_dev->conf.IntType = INT_MEMORY_AND_IO;
785
786 tuple.Attributes = 0;
787 tuple.TupleData = buf;
788 tuple.TupleDataMax = sizeof(buf);
789 tuple.TupleOffset = 0;
790
791 tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
792 if ((ret = pcmcia_get_first_tuple(p_dev, &tuple)) != 0 ||
793 (ret = pcmcia_get_tuple_data(p_dev, &tuple)) != 0 ||
Dominik Brodowski2f3061e2008-08-31 15:50:33 +0200794 (ret = pcmcia_parse_tuple(&tuple, &parse)) != 0)
Holger Schurig27590d02007-10-03 17:25:41 -0700795 {
796 lbs_pr_err("error in pcmcia_get_first_tuple etc\n");
797 goto out1;
798 }
799
800 p_dev->conf.ConfigIndex = cfg->index;
801
802 /* Do we need to allocate an interrupt? */
803 if (cfg->irq.IRQInfo1) {
804 p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
805 }
806
807 /* IO window settings */
808 if (cfg->io.nwin != 1) {
809 lbs_pr_err("wrong CIS (check number of IO windows)\n");
810 ret = -ENODEV;
811 goto out1;
812 }
813 p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
814 p_dev->io.BasePort1 = io->win[0].base;
815 p_dev->io.NumPorts1 = io->win[0].len;
816
817 /* This reserves IO space but doesn't actually enable it */
818 ret = pcmcia_request_io(p_dev, &p_dev->io);
819 if (ret) {
820 lbs_pr_err("error in pcmcia_request_io\n");
821 goto out1;
822 }
823
824 /*
825 * Allocate an interrupt line. Note that this does not assign
826 * a handler to the interrupt, unless the 'Handler' member of
827 * the irq structure is initialized.
828 */
829 if (p_dev->conf.Attributes & CONF_ENABLE_IRQ) {
830 ret = pcmcia_request_irq(p_dev, &p_dev->irq);
831 if (ret) {
832 lbs_pr_err("error in pcmcia_request_irq\n");
833 goto out1;
834 }
835 }
836
837 /* Initialize io access */
838 card->iobase = ioport_map(p_dev->io.BasePort1, p_dev->io.NumPorts1);
839 if (!card->iobase) {
840 lbs_pr_err("error in ioport_map\n");
841 ret = -EIO;
842 goto out1;
843 }
844
845 /*
846 * This actually configures the PCMCIA socket -- setting up
847 * the I/O windows and the interrupt mapping, and putting the
848 * card and host interface into "Memory and IO" mode.
849 */
850 ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
851 if (ret) {
852 lbs_pr_err("error in pcmcia_request_configuration\n");
853 goto out2;
854 }
855
856 /* Finally, report what we've done */
857 lbs_deb_cs("irq %d, io 0x%04x-0x%04x\n",
858 p_dev->irq.AssignedIRQ, p_dev->io.BasePort1,
859 p_dev->io.BasePort1 + p_dev->io.NumPorts1 - 1);
860
Holger Schurig4c555232008-06-05 13:08:35 +0200861 /* Check if we have a current silicon */
862 if (if_cs_read8(card, IF_CS_PRODUCT_ID) < IF_CS_CF8385_B1_REV) {
863 lbs_pr_err("old chips like 8385 rev B1 aren't supported\n");
864 ret = -ENODEV;
865 goto out2;
866 }
Holger Schurig27590d02007-10-03 17:25:41 -0700867
868 /* Load the firmware early, before calling into libertas.ko */
869 ret = if_cs_prog_helper(card);
870 if (ret == 0)
871 ret = if_cs_prog_real(card);
872 if (ret)
873 goto out2;
874
875 /* Make this card known to the libertas driver */
Holger Schurig10078322007-11-15 18:05:47 -0500876 priv = lbs_add_card(card, &p_dev->dev);
Holger Schurig27590d02007-10-03 17:25:41 -0700877 if (!priv) {
878 ret = -ENOMEM;
879 goto out2;
880 }
881
Holger Schurig7919b892008-04-01 14:50:43 +0200882 /* Finish setting up fields in lbs_private */
Dan Williams954ee162007-08-20 11:43:25 -0400883 card->priv = priv;
Holger Schurig27590d02007-10-03 17:25:41 -0700884 priv->card = card;
Holger Schurig7919b892008-04-01 14:50:43 +0200885 priv->hw_host_to_card = if_cs_host_to_card;
David Woodhouseaa21c002007-12-08 20:04:36 +0000886 priv->fw_ready = 1;
Dan Williams954ee162007-08-20 11:43:25 -0400887
Holger Schurig27590d02007-10-03 17:25:41 -0700888 /* Now actually get the IRQ */
889 ret = request_irq(p_dev->irq.AssignedIRQ, if_cs_interrupt,
890 IRQF_SHARED, DRV_NAME, card);
891 if (ret) {
892 lbs_pr_err("error in request_irq\n");
893 goto out3;
894 }
895
Holger Schurig4ef31702007-10-09 10:41:57 +0200896 /* Clear any interrupt cause that happend while sending
897 * firmware/initializing card */
Holger Schurig78cf0742008-06-02 09:25:05 +0200898 if_cs_write16(card, IF_CS_CARD_INT_CAUSE, IF_CS_BIT_MASK);
Ryan Mallon28de0b32007-09-06 21:32:42 -0400899 if_cs_enable_ints(card);
900
Holger Schurig27590d02007-10-03 17:25:41 -0700901 /* And finally bring the card up */
Holger Schurig10078322007-11-15 18:05:47 -0500902 if (lbs_start_card(priv) != 0) {
Holger Schurig27590d02007-10-03 17:25:41 -0700903 lbs_pr_err("could not activate card\n");
904 goto out3;
905 }
906
Holger Schurigd4ff0ef2008-03-19 14:25:18 +0100907 /* The firmware for the CF card supports powersave */
908 priv->ps_supported = 1;
909
Holger Schurig27590d02007-10-03 17:25:41 -0700910 ret = 0;
911 goto out;
912
913out3:
Holger Schurig10078322007-11-15 18:05:47 -0500914 lbs_remove_card(priv);
Holger Schurig27590d02007-10-03 17:25:41 -0700915out2:
916 ioport_unmap(card->iobase);
917out1:
918 pcmcia_disable_device(p_dev);
919out:
920 lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
921 return ret;
922}
923
924
925/*
926 * This deletes a driver "instance". The device is de-registered with
927 * Card Services. If it has been released, all local data structures
928 * are freed. Otherwise, the structures will be freed when the device
929 * is released.
930 */
931static void if_cs_detach(struct pcmcia_device *p_dev)
932{
933 struct if_cs_card *card = p_dev->priv;
934
935 lbs_deb_enter(LBS_DEB_CS);
936
Holger Schurig10078322007-11-15 18:05:47 -0500937 lbs_stop_card(card->priv);
938 lbs_remove_card(card->priv);
Ryan Mallon28de0b32007-09-06 21:32:42 -0400939 if_cs_disable_ints(card);
Holger Schurig27590d02007-10-03 17:25:41 -0700940 if_cs_release(p_dev);
941 kfree(card);
942
943 lbs_deb_leave(LBS_DEB_CS);
944}
945
946
947
948/********************************************************************/
949/* Module initialization */
950/********************************************************************/
951
952static struct pcmcia_device_id if_cs_ids[] = {
953 PCMCIA_DEVICE_MANF_CARD(0x02df, 0x8103),
954 PCMCIA_DEVICE_NULL,
955};
956MODULE_DEVICE_TABLE(pcmcia, if_cs_ids);
957
958
Holger Schurig10078322007-11-15 18:05:47 -0500959static struct pcmcia_driver lbs_driver = {
Holger Schurig27590d02007-10-03 17:25:41 -0700960 .owner = THIS_MODULE,
961 .drv = {
962 .name = DRV_NAME,
963 },
964 .probe = if_cs_probe,
965 .remove = if_cs_detach,
966 .id_table = if_cs_ids,
967};
968
969
970static int __init if_cs_init(void)
971{
972 int ret;
973
974 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig10078322007-11-15 18:05:47 -0500975 ret = pcmcia_register_driver(&lbs_driver);
Holger Schurig27590d02007-10-03 17:25:41 -0700976 lbs_deb_leave(LBS_DEB_CS);
977 return ret;
978}
979
980
981static void __exit if_cs_exit(void)
982{
983 lbs_deb_enter(LBS_DEB_CS);
Holger Schurig10078322007-11-15 18:05:47 -0500984 pcmcia_unregister_driver(&lbs_driver);
Holger Schurig27590d02007-10-03 17:25:41 -0700985 lbs_deb_leave(LBS_DEB_CS);
986}
987
988
989module_init(if_cs_init);
990module_exit(if_cs_exit);