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