if_cs.c 26 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
/*

  Driver for the Marvell 8385 based compact flash WLAN cards.

  (C) 2007 by Holger Schurig <hs4233@mail.mn-solutions.de>

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; see the file COPYING.  If not, write to
  the Free Software Foundation, Inc., 51 Franklin Steet, Fifth Floor,
  Boston, MA 02110-1301, USA.

*/

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/moduleparam.h>
#include <linux/firmware.h>
#include <linux/netdevice.h>

#include <pcmcia/cs_types.h>
#include <pcmcia/cs.h>
#include <pcmcia/cistpl.h>
#include <pcmcia/ds.h>

#include <linux/io.h>

#define DRV_NAME "libertas_cs"

#include "decl.h"
#include "defs.h"
#include "dev.h"


/********************************************************************/
/* Module stuff                                                     */
/********************************************************************/

MODULE_AUTHOR("Holger Schurig <hs4233@mail.mn-solutions.de>");
MODULE_DESCRIPTION("Driver for Marvell 83xx compact flash WLAN cards");
MODULE_LICENSE("GPL");



/********************************************************************/
/* Data structures                                                  */
/********************************************************************/

struct if_cs_card {
	struct pcmcia_device *p_dev;
60
	struct lbs_private *priv;
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
	void __iomem *iobase;
};



/********************************************************************/
/* Hardware access                                                  */
/********************************************************************/

/* This define enables wrapper functions which allow you
   to dump all register accesses. You normally won't this,
   except for development */
/* #define DEBUG_IO */

#ifdef DEBUG_IO
static int debug_output = 0;
#else
/* This way the compiler optimizes the printk's away */
#define debug_output 0
#endif

static inline unsigned int if_cs_read8(struct if_cs_card *card, uint reg)
{
	unsigned int val = ioread8(card->iobase + reg);
	if (debug_output)
86
		printk(KERN_INFO "inb %08x<%02x\n", reg, val);
87
88
89
90
91
92
	return val;
}
static inline unsigned int if_cs_read16(struct if_cs_card *card, uint reg)
{
	unsigned int val = ioread16(card->iobase + reg);
	if (debug_output)
93
		printk(KERN_INFO "inw %08x<%04x\n", reg, val);
94
95
96
97
98
99
100
101
102
	return val;
}
static inline void if_cs_read16_rep(
	struct if_cs_card *card,
	uint reg,
	void *buf,
	unsigned long count)
{
	if (debug_output)
103
		printk(KERN_INFO "insw %08x<(0x%lx words)\n",
104
105
106
107
108
109
110
			reg, count);
	ioread16_rep(card->iobase + reg, buf, count);
}

static inline void if_cs_write8(struct if_cs_card *card, uint reg, u8 val)
{
	if (debug_output)
111
		printk(KERN_INFO "outb %08x>%02x\n", reg, val);
112
113
114
115
116
117
	iowrite8(val, card->iobase + reg);
}

static inline void if_cs_write16(struct if_cs_card *card, uint reg, u16 val)
{
	if (debug_output)
118
		printk(KERN_INFO "outw %08x>%04x\n", reg, val);
119
120
121
122
123
124
	iowrite16(val, card->iobase + reg);
}

static inline void if_cs_write16_rep(
	struct if_cs_card *card,
	uint reg,
125
	const void *buf,
126
127
128
	unsigned long count)
{
	if (debug_output)
129
		printk(KERN_INFO "outsw %08x>(0x%lx words)\n",
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
			reg, count);
	iowrite16_rep(card->iobase + reg, buf, count);
}


/*
 * I know that polling/delaying is frowned upon. However, this procedure
 * with polling is needed while downloading the firmware. At this stage,
 * the hardware does unfortunately not create any interrupts.
 *
 * Fortunately, this function is never used once the firmware is in
 * the card. :-)
 *
 * As a reference, see the "Firmware Specification v5.1", page 18
 * and 19. I did not follow their suggested timing to the word,
 * but this works nice & fast anyway.
 */
static int if_cs_poll_while_fw_download(struct if_cs_card *card, uint addr, u8 reg)
{
	int i;

151
	for (i = 0; i < 100000; i++) {
152
153
		u8 val = if_cs_read8(card, addr);
		if (val == reg)
154
			return 0;
155
		udelay(5);
156
157
158
159
160
161
	}
	return -ETIME;
}



162
163
164
/*
 * First the bitmasks for the host/card interrupt/status registers:
 */
165
166
167
168
169
170
#define IF_CS_BIT_TX			0x0001
#define IF_CS_BIT_RX			0x0002
#define IF_CS_BIT_COMMAND		0x0004
#define IF_CS_BIT_RESP			0x0008
#define IF_CS_BIT_EVENT			0x0010
#define	IF_CS_BIT_MASK			0x001f
171

172
173
174
175
176
177
178
179
180
181
182
183
184


/*
 * It's not really clear to me what the host status register is for. It
 * needs to be set almost in union with "host int cause". The following
 * bits from above are used:
 *
 *   IF_CS_BIT_TX         driver downloaded a data packet
 *   IF_CS_BIT_RX         driver got a data packet
 *   IF_CS_BIT_COMMAND    driver downloaded a command
 *   IF_CS_BIT_RESP       not used (has some meaning with powerdown)
 *   IF_CS_BIT_EVENT      driver read a host event
 */
185
#define IF_CS_HOST_STATUS		0x00000000
186

187
188
189
190
191
192
193
194
195
196
/*
 * With the host int cause register can the host (that is, Linux) cause
 * an interrupt in the firmware, to tell the firmware about those events:
 *
 *   IF_CS_BIT_TX         a data packet has been downloaded
 *   IF_CS_BIT_RX         a received data packet has retrieved
 *   IF_CS_BIT_COMMAND    a firmware block or a command has been downloaded
 *   IF_CS_BIT_RESP       not used (has some meaning with powerdown)
 *   IF_CS_BIT_EVENT      a host event (link lost etc) has been retrieved
 */
197
#define IF_CS_HOST_INT_CAUSE		0x00000002
198

199
200
201
202
/*
 * The host int mask register is used to enable/disable interrupt.  However,
 * I have the suspicion that disabled interrupts are lost.
 */
203
#define IF_CS_HOST_INT_MASK		0x00000004
204

205
206
207
/*
 * Used to send or receive data packets:
 */
208
209
#define IF_CS_WRITE			0x00000016
#define IF_CS_WRITE_LEN			0x00000014
210
211
#define IF_CS_READ			0x00000010
#define IF_CS_READ_LEN			0x00000024
212

213
214
215
216
/*
 * Used to send commands (and to send firmware block) and to
 * receive command responses:
 */
217
218
219
220
#define IF_CS_CMD			0x0000001A
#define IF_CS_CMD_LEN			0x00000018
#define IF_CS_RESP			0x00000012
#define IF_CS_RESP_LEN			0x00000030
221

222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
/*
 * The card status registers shows what the card/firmware actually
 * accepts:
 *
 *   IF_CS_BIT_TX        you may send a data packet
 *   IF_CS_BIT_RX        you may retrieve a data packet
 *   IF_CS_BIT_COMMAND   you may send a command
 *   IF_CS_BIT_RESP      you may retrieve a command response
 *   IF_CS_BIT_EVENT     the card has a event for use (link lost, snr low etc)
 *
 * When reading this register several times, you will get back the same
 * results --- with one exception: the IF_CS_BIT_EVENT clear itself
 * automatically.
 *
 * Not that we don't rely on BIT_RX,_BIT_RESP or BIT_EVENT because
 * we handle this via the card int cause register.
 */
239
240
#define IF_CS_CARD_STATUS		0x00000020
#define IF_CS_CARD_STATUS_MASK		0x7f00
241

242
243
244
245
246
247
248
249
250
251
/*
 * The card int cause register is used by the card/firmware to notify us
 * about the following events:
 *
 *   IF_CS_BIT_TX        a data packet has successfully been sentx
 *   IF_CS_BIT_RX        a data packet has been received and can be retrieved
 *   IF_CS_BIT_COMMAND   not used
 *   IF_CS_BIT_RESP      the firmware has a command response for us
 *   IF_CS_BIT_EVENT     the card has a event for use (link lost, snr low etc)
 */
252
#define IF_CS_CARD_INT_CAUSE		0x00000022
253

254
255
256
257
/*
 * This is used to for handshaking with the card's bootloader/helper image
 * to synchronize downloading of firmware blocks.
 */
258
259
#define IF_CS_SQ_READ_LOW		0x00000028
#define IF_CS_SQ_HELPER_OK		0x10
260

261
262
263
264
265
266
/*
 * The scratch register tells us ...
 *
 * IF_CS_SCRATCH_BOOT_OK     the bootloader runs
 * IF_CS_SCRATCH_HELPER_OK   the helper firmware already runs
 */
267
#define IF_CS_SCRATCH			0x0000003F
268
269
#define IF_CS_SCRATCH_BOOT_OK		0x00
#define IF_CS_SCRATCH_HELPER_OK		0x5a
270

271
272
273
274
275
/*
 * Used to detect ancient chips:
 */
#define IF_CS_PRODUCT_ID		0x0000001C
#define IF_CS_CF8385_B1_REV		0x12
276
#define IF_CS_CF8381_B3_REV		0x04
277

278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
/*
 * Used to detect other cards than CF8385 since their revisions of silicon
 * doesn't match those from CF8385, eg. CF8381 B3 works with this driver.
 */
#define CF8381_MANFID		0x02db
#define CF8381_CARDID		0x6064
#define CF8385_MANFID		0x02df
#define CF8385_CARDID		0x8103

static inline int if_cs_hw_is_cf8381(struct pcmcia_device *p_dev)
{
	return (p_dev->manf_id == CF8381_MANFID &&
		p_dev->card_id == CF8381_CARDID);
}

static inline int if_cs_hw_is_cf8385(struct pcmcia_device *p_dev)
{
	return (p_dev->manf_id == CF8385_MANFID &&
		p_dev->card_id == CF8385_CARDID);
}
298
299

/********************************************************************/
300
/* I/O and interrupt handling                                       */
301
302
/********************************************************************/

303
304
305
static inline void if_cs_enable_ints(struct if_cs_card *card)
{
	lbs_deb_enter(LBS_DEB_CS);
306
	if_cs_write16(card, IF_CS_HOST_INT_MASK, 0);
307
308
309
310
311
}

static inline void if_cs_disable_ints(struct if_cs_card *card)
{
	lbs_deb_enter(LBS_DEB_CS);
312
	if_cs_write16(card, IF_CS_HOST_INT_MASK, IF_CS_BIT_MASK);
313
314
}

315
316
317
/*
 * Called from if_cs_host_to_card to send a command to the hardware
 */
318
static int if_cs_send_cmd(struct lbs_private *priv, u8 *buf, u16 nb)
319
320
321
322
323
324
{
	struct if_cs_card *card = (struct if_cs_card *)priv->card;
	int ret = -1;
	int loops = 0;

	lbs_deb_enter(LBS_DEB_CS);
325
	if_cs_disable_ints(card);
326
327
328

	/* Is hardware ready? */
	while (1) {
329
330
		u16 status = if_cs_read16(card, IF_CS_CARD_STATUS);
		if (status & IF_CS_BIT_COMMAND)
331
332
333
334
335
336
337
338
			break;
		if (++loops > 100) {
			lbs_pr_err("card not ready for commands\n");
			goto done;
		}
		mdelay(1);
	}

339
	if_cs_write16(card, IF_CS_CMD_LEN, nb);
340

341
	if_cs_write16_rep(card, IF_CS_CMD, buf, nb / 2);
342
343
	/* Are we supposed to transfer an odd amount of bytes? */
	if (nb & 1)
344
		if_cs_write8(card, IF_CS_CMD, buf[nb-1]);
345
346
347

	/* "Assert the download over interrupt command in the Host
	 * status register" */
348
	if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
349
350
351

	/* "Assert the download over interrupt command in the Card
	 * interrupt case register" */
352
	if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
353
354
355
	ret = 0;

done:
356
	if_cs_enable_ints(card);
357
358
359
360
361
362
363
	lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
	return ret;
}

/*
 * Called from if_cs_host_to_card to send a data to the hardware
 */
364
static void if_cs_send_data(struct lbs_private *priv, u8 *buf, u16 nb)
365
366
{
	struct if_cs_card *card = (struct if_cs_card *)priv->card;
367
	u16 status;
368
369

	lbs_deb_enter(LBS_DEB_CS);
370
371
	if_cs_disable_ints(card);

372
373
	status = if_cs_read16(card, IF_CS_CARD_STATUS);
	BUG_ON((status & IF_CS_BIT_TX) == 0);
374

375
	if_cs_write16(card, IF_CS_WRITE_LEN, nb);
376
377

	/* write even number of bytes, then odd byte if necessary */
378
	if_cs_write16_rep(card, IF_CS_WRITE, buf, nb / 2);
379
	if (nb & 1)
380
		if_cs_write8(card, IF_CS_WRITE, buf[nb-1]);
381

382
383
	if_cs_write16(card, IF_CS_HOST_STATUS, IF_CS_BIT_TX);
	if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_TX);
384
	if_cs_enable_ints(card);
385
386
387
388
389
390
391

	lbs_deb_leave(LBS_DEB_CS);
}

/*
 * Get the command result out of the card.
 */
392
static int if_cs_receive_cmdres(struct lbs_private *priv, u8 *data, u32 *len)
393
{
394
	unsigned long flags;
395
	int ret = -1;
396
	u16 status;
397
398
399
400

	lbs_deb_enter(LBS_DEB_CS);

	/* is hardware ready? */
401
402
403
404
	status = if_cs_read16(priv->card, IF_CS_CARD_STATUS);
	if ((status & IF_CS_BIT_RESP) == 0) {
		lbs_pr_err("no cmd response in card\n");
		*len = 0;
405
406
407
		goto out;
	}

408
	*len = if_cs_read16(priv->card, IF_CS_RESP_LEN);
409
	if ((*len == 0) || (*len > LBS_CMD_BUFFER_SIZE)) {
410
411
412
413
414
		lbs_pr_err("card cmd buffer has invalid # of bytes (%d)\n", *len);
		goto out;
	}

	/* read even number of bytes, then odd byte if necessary */
415
	if_cs_read16_rep(priv->card, IF_CS_RESP, data, *len/sizeof(u16));
416
	if (*len & 1)
417
		data[*len-1] = if_cs_read8(priv->card, IF_CS_RESP);
418

419
420
421
	/* This is a workaround for a firmware that reports too much
	 * bytes */
	*len -= 8;
422
	ret = 0;
423
424
425
426
427
428

	/* Clear this flag again */
	spin_lock_irqsave(&priv->driver_lock, flags);
	priv->dnld_sent = DNLD_RES_RECEIVED;
	spin_unlock_irqrestore(&priv->driver_lock, flags);

429
430
431
432
433
out:
	lbs_deb_leave_args(LBS_DEB_CS, "ret %d, len %d", ret, *len);
	return ret;
}

434
static struct sk_buff *if_cs_receive_data(struct lbs_private *priv)
435
436
437
438
439
440
441
{
	struct sk_buff *skb = NULL;
	u16 len;
	u8 *data;

	lbs_deb_enter(LBS_DEB_CS);

442
	len = if_cs_read16(priv->card, IF_CS_READ_LEN);
443
444
	if (len == 0 || len > MRVDRV_ETH_RX_PACKET_BUFFER_SIZE) {
		lbs_pr_err("card data buffer has invalid # of bytes (%d)\n", len);
445
		priv->dev->stats.rx_dropped++;
446
447
448
		goto dat_err;
	}

449
	skb = dev_alloc_skb(MRVDRV_ETH_RX_PACKET_BUFFER_SIZE + 2);
450
451
	if (!skb)
		goto out;
452
453
454
	skb_put(skb, len);
	skb_reserve(skb, 2);/* 16 byte align */
	data = skb->data;
455
456

	/* read even number of bytes, then odd byte if necessary */
457
	if_cs_read16_rep(priv->card, IF_CS_READ, data, len/sizeof(u16));
458
	if (len & 1)
459
		data[len-1] = if_cs_read8(priv->card, IF_CS_READ);
460
461

dat_err:
462
463
	if_cs_write16(priv->card, IF_CS_HOST_STATUS, IF_CS_BIT_RX);
	if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_RX);
464
465
466
467
468
469

out:
	lbs_deb_leave_args(LBS_DEB_CS, "ret %p", skb);
	return skb;
}

470
471
472
473
474
475
476
477
static irqreturn_t if_cs_interrupt(int irq, void *data)
{
	struct if_cs_card *card = data;
	struct lbs_private *priv = card->priv;
	u16 cause;

	lbs_deb_enter(LBS_DEB_CS);

478
	/* Ask card interrupt cause register if there is something for us */
479
	cause = if_cs_read16(card, IF_CS_CARD_INT_CAUSE);
Holger Schurig's avatar
Holger Schurig committed
480
481
	lbs_deb_cs("cause 0x%04x\n", cause);

482
483
484
485
486
487
488
489
490
491
492
	if (cause == 0) {
		/* Not for us */
		return IRQ_NONE;
	}

	if (cause == 0xffff) {
		/* Read in junk, the card has probably been removed */
		card->priv->surpriseremoved = 1;
		return IRQ_HANDLED;
	}

493
	if (cause & IF_CS_BIT_RX) {
494
495
496
497
498
499
500
		struct sk_buff *skb;
		lbs_deb_cs("rx packet\n");
		skb = if_cs_receive_data(priv);
		if (skb)
			lbs_process_rxed_packet(priv, skb);
	}

501
	if (cause & IF_CS_BIT_TX) {
502
		lbs_deb_cs("tx done\n");
503
504
505
		lbs_host_to_card_done(priv);
	}

506
	if (cause & IF_CS_BIT_RESP) {
507
508
509
		unsigned long flags;
		u8 i;

510
		lbs_deb_cs("cmd resp\n");
511
512
513
514
515
516
517
518
519
520
521
522
523
		spin_lock_irqsave(&priv->driver_lock, flags);
		i = (priv->resp_idx == 0) ? 1 : 0;
		spin_unlock_irqrestore(&priv->driver_lock, flags);

		BUG_ON(priv->resp_len[i]);
		if_cs_receive_cmdres(priv, priv->resp_buf[i],
			&priv->resp_len[i]);

		spin_lock_irqsave(&priv->driver_lock, flags);
		lbs_notify_command_response(priv, i);
		spin_unlock_irqrestore(&priv->driver_lock, flags);
	}

524
	if (cause & IF_CS_BIT_EVENT) {
525
		u16 status = if_cs_read16(priv->card, IF_CS_CARD_STATUS);
526
527
		if_cs_write16(priv->card, IF_CS_HOST_INT_CAUSE,
			IF_CS_BIT_EVENT);
528
		lbs_queue_event(priv, (status & IF_CS_CARD_STATUS_MASK) >> 8);
529
530
	}

Holger Schurig's avatar
Holger Schurig committed
531
532
533
	/* Clear interrupt cause */
	if_cs_write16(card, IF_CS_CARD_INT_CAUSE, cause & IF_CS_BIT_MASK);

534
	lbs_deb_leave(LBS_DEB_CS);
535
536
537
538
539
540
	return IRQ_HANDLED;
}




541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
/********************************************************************/
/* Firmware                                                         */
/********************************************************************/

/*
 * Tries to program the helper firmware.
 *
 * Return 0 on success
 */
static int if_cs_prog_helper(struct if_cs_card *card)
{
	int ret = 0;
	int sent = 0;
	u8  scratch;
	const struct firmware *fw;

	lbs_deb_enter(LBS_DEB_CS);

	scratch = if_cs_read8(card, IF_CS_SCRATCH);

	/* "If the value is 0x5a, the firmware is already
	 * downloaded successfully"
	 */
564
	if (scratch == IF_CS_SCRATCH_HELPER_OK)
565
566
567
		goto done;

	/* "If the value is != 00, it is invalid value of register */
568
	if (scratch != IF_CS_SCRATCH_BOOT_OK) {
569
570
571
572
573
574
575
576
577
578
579
580
		ret = -ENODEV;
		goto done;
	}

	/* TODO: make firmware file configurable */
	ret = request_firmware(&fw, "libertas_cs_helper.fw",
		&handle_to_dev(card->p_dev));
	if (ret) {
		lbs_pr_err("can't load helper firmware\n");
		ret = -ENODEV;
		goto done;
	}
581
	lbs_deb_cs("helper size %td\n", fw->size);
582
583
584
585
586
587
588
589
590
591
592
593
594
595

	/* "Set the 5 bytes of the helper image to 0" */
	/* Not needed, this contains an ARM branch instruction */

	for (;;) {
		/* "the number of bytes to send is 256" */
		int count = 256;
		int remain = fw->size - sent;

		if (remain < count)
			count = remain;

		/* "write the number of bytes to be sent to the I/O Command
		 * write length register" */
596
		if_cs_write16(card, IF_CS_CMD_LEN, count);
597
598
599

		/* "write this to I/O Command port register as 16 bit writes */
		if (count)
600
			if_cs_write16_rep(card, IF_CS_CMD,
601
602
603
604
605
				&fw->data[sent],
				count >> 1);

		/* "Assert the download over interrupt command in the Host
		 * status register" */
606
		if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
607
608
609

		/* "Assert the download over interrupt command in the Card
		 * interrupt case register" */
610
		if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
611
612
613

		/* "The host polls the Card Status register ... for 50 ms before
		   declaring a failure */
614
615
		ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS,
			IF_CS_BIT_COMMAND);
616
617
618
		if (ret < 0) {
			lbs_pr_err("can't download helper at 0x%x, ret %d\n",
				sent, ret);
619
			goto err_release;
620
621
622
623
624
625
626
627
		}

		if (count == 0)
			break;

		sent += count;
	}

628
err_release:
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
	release_firmware(fw);
done:
	lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
	return ret;
}


static int if_cs_prog_real(struct if_cs_card *card)
{
	const struct firmware *fw;
	int ret = 0;
	int retry = 0;
	int len = 0;
	int sent;

	lbs_deb_enter(LBS_DEB_CS);

	/* TODO: make firmware file configurable */
	ret = request_firmware(&fw, "libertas_cs.fw",
		&handle_to_dev(card->p_dev));
	if (ret) {
		lbs_pr_err("can't load firmware\n");
		ret = -ENODEV;
		goto done;
	}
654
	lbs_deb_cs("fw size %td\n", fw->size);
655

656
657
	ret = if_cs_poll_while_fw_download(card, IF_CS_SQ_READ_LOW,
		IF_CS_SQ_HELPER_OK);
658
659
660
661
662
663
	if (ret < 0) {
		lbs_pr_err("helper firmware doesn't answer\n");
		goto err_release;
	}

	for (sent = 0; sent < fw->size; sent += len) {
664
		len = if_cs_read16(card, IF_CS_SQ_READ_LOW);
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
		if (len & 1) {
			retry++;
			lbs_pr_info("odd, need to retry this firmware block\n");
		} else {
			retry = 0;
		}

		if (retry > 20) {
			lbs_pr_err("could not download firmware\n");
			ret = -ENODEV;
			goto err_release;
		}
		if (retry) {
			sent -= len;
		}


682
		if_cs_write16(card, IF_CS_CMD_LEN, len);
683

684
		if_cs_write16_rep(card, IF_CS_CMD,
685
686
			&fw->data[sent],
			(len+1) >> 1);
687
688
		if_cs_write8(card, IF_CS_HOST_STATUS, IF_CS_BIT_COMMAND);
		if_cs_write16(card, IF_CS_HOST_INT_CAUSE, IF_CS_BIT_COMMAND);
689

690
691
		ret = if_cs_poll_while_fw_download(card, IF_CS_CARD_STATUS,
			IF_CS_BIT_COMMAND);
692
693
694
695
696
697
698
		if (ret < 0) {
			lbs_pr_err("can't download firmware at 0x%x\n", sent);
			goto err_release;
		}
	}

	ret = if_cs_poll_while_fw_download(card, IF_CS_SCRATCH, 0x5a);
699
	if (ret < 0)
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
		lbs_pr_err("firmware download failed\n");

err_release:
	release_firmware(fw);

done:
	lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
	return ret;
}



/********************************************************************/
/* Callback functions for libertas.ko                               */
/********************************************************************/

/* Send commands or data packets to the card */
717
718
719
720
static int if_cs_host_to_card(struct lbs_private *priv,
	u8 type,
	u8 *buf,
	u16 nb)
721
722
723
724
725
726
727
{
	int ret = -1;

	lbs_deb_enter_args(LBS_DEB_CS, "type %d, bytes %d", type, nb);

	switch (type) {
	case MVMS_DAT:
728
		priv->dnld_sent = DNLD_DATA_SENT;
729
730
731
732
		if_cs_send_data(priv, buf, nb);
		ret = 0;
		break;
	case MVMS_CMD:
733
		priv->dnld_sent = DNLD_CMD_SENT;
734
735
736
		ret = if_cs_send_cmd(priv, buf, nb);
		break;
	default:
737
		lbs_pr_err("%s: unsupported type %d\n", __func__, type);
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
	}

	lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
	return ret;
}


/********************************************************************/
/* Card Services                                                    */
/********************************************************************/

/*
 * After a card is removed, if_cs_release() will unregister the
 * device, and release the PCMCIA configuration.  If the device is
 * still open, this will be postponed until it is closed.
 */
static void if_cs_release(struct pcmcia_device *p_dev)
{
	struct if_cs_card *card = p_dev->priv;

	lbs_deb_enter(LBS_DEB_CS);

	free_irq(p_dev->irq.AssignedIRQ, card);
761
	pcmcia_disable_device(p_dev);
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
	if (card->iobase)
		ioport_unmap(card->iobase);

	lbs_deb_leave(LBS_DEB_CS);
}


/*
 * This creates an "instance" of the driver, allocating local data
 * structures for one device.  The device is registered with Card
 * Services.
 *
 * The dev_link structure is initialized, but we don't actually
 * configure the card at this point -- we wait until we receive a card
 * insertion event.
 */
static int if_cs_probe(struct pcmcia_device *p_dev)
{
	int ret = -ENOMEM;
781
	unsigned int prod_id;
782
	struct lbs_private *priv;
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
	struct if_cs_card *card;
	/* CIS parsing */
	tuple_t tuple;
	cisparse_t parse;
	cistpl_cftable_entry_t *cfg = &parse.cftable_entry;
	cistpl_io_t *io = &cfg->io;
	u_char buf[64];

	lbs_deb_enter(LBS_DEB_CS);

	card = kzalloc(sizeof(struct if_cs_card), GFP_KERNEL);
	if (!card) {
		lbs_pr_err("error in kzalloc\n");
		goto out;
	}
	card->p_dev = p_dev;
	p_dev->priv = card;

	p_dev->irq.Attributes = IRQ_TYPE_DYNAMIC_SHARING;
	p_dev->irq.Handler = NULL;
	p_dev->irq.IRQInfo1 = IRQ_INFO2_VALID | IRQ_LEVEL_ID;

	p_dev->conf.Attributes = 0;
	p_dev->conf.IntType = INT_MEMORY_AND_IO;

	tuple.Attributes = 0;
	tuple.TupleData = buf;
	tuple.TupleDataMax = sizeof(buf);
	tuple.TupleOffset = 0;

	tuple.DesiredTuple = CISTPL_CFTABLE_ENTRY;
	if ((ret = pcmcia_get_first_tuple(p_dev, &tuple)) != 0 ||
	    (ret = pcmcia_get_tuple_data(p_dev, &tuple)) != 0 ||
816
	    (ret = pcmcia_parse_tuple(&tuple, &parse)) != 0)
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
	{
		lbs_pr_err("error in pcmcia_get_first_tuple etc\n");
		goto out1;
	}

	p_dev->conf.ConfigIndex = cfg->index;

	/* Do we need to allocate an interrupt? */
	if (cfg->irq.IRQInfo1) {
		p_dev->conf.Attributes |= CONF_ENABLE_IRQ;
	}

	/* IO window settings */
	if (cfg->io.nwin != 1) {
		lbs_pr_err("wrong CIS (check number of IO windows)\n");
		ret = -ENODEV;
		goto out1;
	}
	p_dev->io.Attributes1 = IO_DATA_PATH_WIDTH_AUTO;
	p_dev->io.BasePort1 = io->win[0].base;
	p_dev->io.NumPorts1 = io->win[0].len;

	/* This reserves IO space but doesn't actually enable it */
	ret = pcmcia_request_io(p_dev, &p_dev->io);
	if (ret) {
		lbs_pr_err("error in pcmcia_request_io\n");
		goto out1;
	}

	/*
	 * Allocate an interrupt line.  Note that this does not assign
	 * a handler to the interrupt, unless the 'Handler' member of
	 * the irq structure is initialized.
	 */
	if (p_dev->conf.Attributes & CONF_ENABLE_IRQ) {
		ret = pcmcia_request_irq(p_dev, &p_dev->irq);
		if (ret) {
			lbs_pr_err("error in pcmcia_request_irq\n");
			goto out1;
		}
	}

	/* Initialize io access */
	card->iobase = ioport_map(p_dev->io.BasePort1, p_dev->io.NumPorts1);
	if (!card->iobase) {
		lbs_pr_err("error in ioport_map\n");
		ret = -EIO;
		goto out1;
	}

	/*
	 * This actually configures the PCMCIA socket -- setting up
	 * the I/O windows and the interrupt mapping, and putting the
	 * card and host interface into "Memory and IO" mode.
	 */
	ret = pcmcia_request_configuration(p_dev, &p_dev->conf);
	if (ret) {
		lbs_pr_err("error in pcmcia_request_configuration\n");
		goto out2;
	}

	/* Finally, report what we've done */
	lbs_deb_cs("irq %d, io 0x%04x-0x%04x\n",
	       p_dev->irq.AssignedIRQ, p_dev->io.BasePort1,
	       p_dev->io.BasePort1 + p_dev->io.NumPorts1 - 1);

883
	/* Check if we have a current silicon */
884
885
886
887
888
889
890
891
	prod_id = if_cs_read8(card, IF_CS_PRODUCT_ID);
	if (if_cs_hw_is_cf8381(p_dev) && prod_id < IF_CS_CF8381_B3_REV) {
		lbs_pr_err("old chips like 8381 rev B3 aren't supported\n");
		ret = -ENODEV;
		goto out2;
	}

	if (if_cs_hw_is_cf8385(p_dev) && prod_id < IF_CS_CF8385_B1_REV) {
892
893
894
895
		lbs_pr_err("old chips like 8385 rev B1 aren't supported\n");
		ret = -ENODEV;
		goto out2;
	}
896
897
898
899
900
901
902
903
904

	/* Load the firmware early, before calling into libertas.ko */
	ret = if_cs_prog_helper(card);
	if (ret == 0)
		ret = if_cs_prog_real(card);
	if (ret)
		goto out2;

	/* Make this card known to the libertas driver */
905
	priv = lbs_add_card(card, &p_dev->dev);
906
907
908
909
910
	if (!priv) {
		ret = -ENOMEM;
		goto out2;
	}

911
	/* Finish setting up fields in lbs_private */
912
	card->priv = priv;
913
	priv->card = card;
914
	priv->hw_host_to_card = if_cs_host_to_card;
915
	priv->fw_ready = 1;
916

917
918
919
920
921
922
923
924
	/* Now actually get the IRQ */
	ret = request_irq(p_dev->irq.AssignedIRQ, if_cs_interrupt,
		IRQF_SHARED, DRV_NAME, card);
	if (ret) {
		lbs_pr_err("error in request_irq\n");
		goto out3;
	}

925
926
	/* Clear any interrupt cause that happend while sending
	 * firmware/initializing card */
927
	if_cs_write16(card, IF_CS_CARD_INT_CAUSE, IF_CS_BIT_MASK);
928
929
	if_cs_enable_ints(card);

930
	/* And finally bring the card up */
931
	if (lbs_start_card(priv) != 0) {
932
933
934
935
		lbs_pr_err("could not activate card\n");
		goto out3;
	}

936
937
938
	/* The firmware for the CF card supports powersave */
	priv->ps_supported = 1;

939
940
941
942
	ret = 0;
	goto out;

out3:
943
	lbs_remove_card(priv);
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
out2:
	ioport_unmap(card->iobase);
out1:
	pcmcia_disable_device(p_dev);
out:
	lbs_deb_leave_args(LBS_DEB_CS, "ret %d", ret);
	return ret;
}


/*
 * This deletes a driver "instance".  The device is de-registered with
 * Card Services.  If it has been released, all local data structures
 * are freed.  Otherwise, the structures will be freed when the device
 * is released.
 */
static void if_cs_detach(struct pcmcia_device *p_dev)
{
	struct if_cs_card *card = p_dev->priv;

	lbs_deb_enter(LBS_DEB_CS);

966
967
	lbs_stop_card(card->priv);
	lbs_remove_card(card->priv);
968
	if_cs_disable_ints(card);
969
970
971
972
973
974
975
976
977
978
979
980
981
	if_cs_release(p_dev);
	kfree(card);

	lbs_deb_leave(LBS_DEB_CS);
}



/********************************************************************/
/* Module initialization                                            */
/********************************************************************/

static struct pcmcia_device_id if_cs_ids[] = {
982
983
	PCMCIA_DEVICE_MANF_CARD(CF8381_MANFID, CF8381_CARDID),
	PCMCIA_DEVICE_MANF_CARD(CF8385_MANFID, CF8385_CARDID),
984
985
986
987
988
	PCMCIA_DEVICE_NULL,
};
MODULE_DEVICE_TABLE(pcmcia, if_cs_ids);


989
static struct pcmcia_driver lbs_driver = {
990
991
992
993
994
995
996
997
998
999
1000
	.owner		= THIS_MODULE,
	.drv		= {
		.name	= DRV_NAME,
	},
	.probe		= if_cs_probe,
	.remove		= if_cs_detach,
	.id_table       = if_cs_ids,
};


static int __init if_cs_init(void)