1 /*
2  * USB Orinoco driver
3  *
4  * Copyright (c) 2003 Manuel Estrada Sainz
5  *
6  * The contents of this file are subject to the Mozilla Public License
7  * Version 1.1 (the "License"); you may not use this file except in
8  * compliance with the License. You may obtain a copy of the License
9  * at http://www.mozilla.org/MPL/
10  *
11  * Software distributed under the License is distributed on an "AS IS"
12  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
13  * the License for the specific language governing rights and
14  * limitations under the License.
15  *
16  * Alternatively, the contents of this file may be used under the
17  * terms of the GNU General Public License version 2 (the "GPL"), in
18  * which case the provisions of the GPL are applicable instead of the
19  * above.  If you wish to allow the use of your version of this file
20  * only under the terms of the GPL and not to allow others to use your
21  * version of this file under the MPL, indicate your decision by
22  * deleting the provisions above and replace them with the notice and
23  * other provisions required by the GPL.  If you do not delete the
24  * provisions above, a recipient may use your version of this file
25  * under either the MPL or the GPL.
26  *
27  * Queueing code based on linux-wlan-ng 0.2.1-pre5
28  *
29  * Copyright (C) 1999 AbsoluteValue Systems, Inc.  All Rights Reserved.
30  *
31  *	The license is the same as above.
32  *
33  * Initialy based on USB Skeleton driver - 0.7
34  *
35  * Copyright (c) 2001 Greg Kroah-Hartman (greg@kroah.com)
36  *
37  *	This program is free software; you can redistribute it and/or
38  *	modify it under the terms of the GNU General Public License as
39  *	published by the Free Software Foundation; either version 2 of
40  *	the License, or (at your option) any later version.
41  *
42  * NOTE: The original USB Skeleton driver is GPL, but all that code is
43  * gone so MPL/GPL applies.
44  */
45 
46 #define DRIVER_NAME "orinoco_usb"
47 #define PFX DRIVER_NAME ": "
48 
49 #include <linux/module.h>
50 #include <linux/kernel.h>
51 #include <linux/sched.h>
52 #include <linux/signal.h>
53 #include <linux/errno.h>
54 #include <linux/poll.h>
55 #include <linux/slab.h>
56 #include <linux/fcntl.h>
57 #include <linux/spinlock.h>
58 #include <linux/list.h>
59 #include <linux/usb.h>
60 #include <linux/timer.h>
61 
62 #include <linux/netdevice.h>
63 #include <linux/if_arp.h>
64 #include <linux/etherdevice.h>
65 #include <linux/wireless.h>
66 #include <linux/firmware.h>
67 
68 #include "mic.h"
69 #include "orinoco.h"
70 
71 #ifndef URB_ASYNC_UNLINK
72 #define URB_ASYNC_UNLINK 0
73 #endif
74 
75 /* 802.2 LLC/SNAP header used for Ethernet encapsulation over 802.11 */
76 static const u8 encaps_hdr[] = {0xaa, 0xaa, 0x03, 0x00, 0x00, 0x00};
77 #define ENCAPS_OVERHEAD		(sizeof(encaps_hdr) + 2)
78 
79 struct header_struct {
80 	/* 802.3 */
81 	u8 dest[ETH_ALEN];
82 	u8 src[ETH_ALEN];
83 	__be16 len;
84 	/* 802.2 */
85 	u8 dsap;
86 	u8 ssap;
87 	u8 ctrl;
88 	/* SNAP */
89 	u8 oui[3];
90 	__be16 ethertype;
91 } __packed;
92 
93 struct ez_usb_fw {
94 	u16 size;
95 	const u8 *code;
96 };
97 
98 static struct ez_usb_fw firmware = {
99 	.size = 0,
100 	.code = NULL,
101 };
102 
103 /* Debugging macros */
104 #undef err
105 #define err(format, arg...) \
106 	do { printk(KERN_ERR PFX format "\n", ## arg); } while (0)
107 
108 MODULE_FIRMWARE("orinoco_ezusb_fw");
109 
110 /*
111  * Under some conditions, the card gets stuck and stops paying attention
112  * to the world (i.e. data communication stalls) until we do something to
113  * it.  Sending an INQ_TALLIES command seems to be enough and should be
114  * harmless otherwise.  This behaviour has been observed when using the
115  * driver on a systemimager client during installation.  In the past a
116  * timer was used to send INQ_TALLIES commands when there was no other
117  * activity, but it was troublesome and was removed.
118  */
119 
120 #define USB_COMPAQ_VENDOR_ID     0x049f /* Compaq Computer Corp. */
121 #define USB_COMPAQ_WL215_ID      0x001f /* Compaq WL215 USB Adapter */
122 #define USB_COMPAQ_W200_ID       0x0076 /* Compaq W200 USB Adapter */
123 #define USB_HP_WL215_ID          0x0082 /* Compaq WL215 USB Adapter */
124 
125 #define USB_MELCO_VENDOR_ID      0x0411
126 #define USB_BUFFALO_L11_ID       0x0006 /* BUFFALO WLI-USB-L11 */
127 #define USB_BUFFALO_L11G_WR_ID   0x000B /* BUFFALO WLI-USB-L11G-WR */
128 #define USB_BUFFALO_L11G_ID      0x000D /* BUFFALO WLI-USB-L11G */
129 
130 #define USB_LUCENT_VENDOR_ID     0x047E /* Lucent Technologies */
131 #define USB_LUCENT_ORINOCO_ID    0x0300 /* Lucent/Agere Orinoco USB Client */
132 
133 #define USB_AVAYA8_VENDOR_ID     0x0D98
134 #define USB_AVAYAE_VENDOR_ID     0x0D9E
135 #define USB_AVAYA_WIRELESS_ID    0x0300 /* Avaya Wireless USB Card */
136 
137 #define USB_AGERE_VENDOR_ID      0x0D4E /* Agere Systems */
138 #define USB_AGERE_MODEL0801_ID   0x1000 /* Wireless USB Card Model 0801 */
139 #define USB_AGERE_MODEL0802_ID   0x1001 /* Wireless USB Card Model 0802 */
140 #define USB_AGERE_REBRANDED_ID   0x047A /* WLAN USB Card */
141 
142 #define USB_ELSA_VENDOR_ID       0x05CC
143 #define USB_ELSA_AIRLANCER_ID    0x3100 /* ELSA AirLancer USB-11 */
144 
145 #define USB_LEGEND_VENDOR_ID     0x0E7C
146 #define USB_LEGEND_JOYNET_ID     0x0300 /* Joynet WLAN USB Card */
147 
148 #define USB_SAMSUNG_VENDOR_ID    0x04E8
149 #define USB_SAMSUNG_SEW2001U1_ID 0x5002 /* Samsung SEW-2001u Card */
150 #define USB_SAMSUNG_SEW2001U2_ID 0x5B11 /* Samsung SEW-2001u Card */
151 #define USB_SAMSUNG_SEW2003U_ID  0x7011 /* Samsung SEW-2003U Card */
152 
153 #define USB_IGATE_VENDOR_ID      0x0681
154 #define USB_IGATE_IGATE_11M_ID   0x0012 /* I-GATE 11M USB Card */
155 
156 #define USB_FUJITSU_VENDOR_ID    0x0BF8
157 #define USB_FUJITSU_E1100_ID     0x1002 /* connect2AIR WLAN E-1100 USB */
158 
159 #define USB_2WIRE_VENDOR_ID      0x1630
160 #define USB_2WIRE_WIRELESS_ID    0xff81 /* 2Wire Wireless USB adapter */
161 
162 
163 #define EZUSB_REQUEST_FW_TRANS		0xA0
164 #define EZUSB_REQUEST_TRIGER		0xAA
165 #define EZUSB_REQUEST_TRIG_AC		0xAC
166 #define EZUSB_CPUCS_REG			0x7F92
167 
168 #define EZUSB_RID_TX			0x0700
169 #define EZUSB_RID_RX			0x0701
170 #define EZUSB_RID_INIT1			0x0702
171 #define EZUSB_RID_ACK			0x0710
172 #define EZUSB_RID_READ_PDA		0x0800
173 #define EZUSB_RID_PROG_INIT		0x0852
174 #define EZUSB_RID_PROG_SET_ADDR		0x0853
175 #define EZUSB_RID_PROG_BYTES		0x0854
176 #define EZUSB_RID_PROG_END		0x0855
177 #define EZUSB_RID_DOCMD			0x0860
178 
179 /* Recognize info frames */
180 #define EZUSB_IS_INFO(id)		((id >= 0xF000) && (id <= 0xF2FF))
181 
182 #define EZUSB_MAGIC			0x0210
183 
184 #define EZUSB_FRAME_DATA		1
185 #define EZUSB_FRAME_CONTROL		2
186 
187 #define DEF_TIMEOUT			(3 * HZ)
188 
189 #define BULK_BUF_SIZE			2048
190 
191 #define MAX_DL_SIZE (BULK_BUF_SIZE - sizeof(struct ezusb_packet))
192 
193 #define FW_BUF_SIZE			64
194 #define FW_VAR_OFFSET_PTR		0x359
195 #define FW_VAR_VALUE			0
196 #define FW_HOLE_START			0x100
197 #define FW_HOLE_END			0x300
198 
199 struct ezusb_packet {
200 	__le16 magic;		/* 0x0210 */
201 	u8 req_reply_count;
202 	u8 ans_reply_count;
203 	__le16 frame_type;	/* 0x01 for data frames, 0x02 otherwise */
204 	__le16 size;		/* transport size */
205 	__le16 crc;		/* CRC up to here */
206 	__le16 hermes_len;
207 	__le16 hermes_rid;
208 	u8 data[0];
209 } __packed;
210 
211 /* Table of devices that work or may work with this driver */
212 static struct usb_device_id ezusb_table[] = {
213 	{USB_DEVICE(USB_COMPAQ_VENDOR_ID, USB_COMPAQ_WL215_ID)},
214 	{USB_DEVICE(USB_COMPAQ_VENDOR_ID, USB_HP_WL215_ID)},
215 	{USB_DEVICE(USB_COMPAQ_VENDOR_ID, USB_COMPAQ_W200_ID)},
216 	{USB_DEVICE(USB_MELCO_VENDOR_ID, USB_BUFFALO_L11_ID)},
217 	{USB_DEVICE(USB_MELCO_VENDOR_ID, USB_BUFFALO_L11G_WR_ID)},
218 	{USB_DEVICE(USB_MELCO_VENDOR_ID, USB_BUFFALO_L11G_ID)},
219 	{USB_DEVICE(USB_LUCENT_VENDOR_ID, USB_LUCENT_ORINOCO_ID)},
220 	{USB_DEVICE(USB_AVAYA8_VENDOR_ID, USB_AVAYA_WIRELESS_ID)},
221 	{USB_DEVICE(USB_AVAYAE_VENDOR_ID, USB_AVAYA_WIRELESS_ID)},
222 	{USB_DEVICE(USB_AGERE_VENDOR_ID, USB_AGERE_MODEL0801_ID)},
223 	{USB_DEVICE(USB_AGERE_VENDOR_ID, USB_AGERE_MODEL0802_ID)},
224 	{USB_DEVICE(USB_ELSA_VENDOR_ID, USB_ELSA_AIRLANCER_ID)},
225 	{USB_DEVICE(USB_LEGEND_VENDOR_ID, USB_LEGEND_JOYNET_ID)},
226 	{USB_DEVICE_VER(USB_SAMSUNG_VENDOR_ID, USB_SAMSUNG_SEW2001U1_ID,
227 			0, 0)},
228 	{USB_DEVICE(USB_SAMSUNG_VENDOR_ID, USB_SAMSUNG_SEW2001U2_ID)},
229 	{USB_DEVICE(USB_SAMSUNG_VENDOR_ID, USB_SAMSUNG_SEW2003U_ID)},
230 	{USB_DEVICE(USB_IGATE_VENDOR_ID, USB_IGATE_IGATE_11M_ID)},
231 	{USB_DEVICE(USB_FUJITSU_VENDOR_ID, USB_FUJITSU_E1100_ID)},
232 	{USB_DEVICE(USB_2WIRE_VENDOR_ID, USB_2WIRE_WIRELESS_ID)},
233 	{USB_DEVICE(USB_AGERE_VENDOR_ID, USB_AGERE_REBRANDED_ID)},
234 	{}			/* Terminating entry */
235 };
236 
237 MODULE_DEVICE_TABLE(usb, ezusb_table);
238 
239 /* Structure to hold all of our device specific stuff */
240 struct ezusb_priv {
241 	struct usb_device *udev;
242 	struct net_device *dev;
243 	struct mutex mtx;
244 	spinlock_t req_lock;
245 	struct list_head req_pending;
246 	struct list_head req_active;
247 	spinlock_t reply_count_lock;
248 	u16 hermes_reg_fake[0x40];
249 	u8 *bap_buf;
250 	struct urb *read_urb;
251 	int read_pipe;
252 	int write_pipe;
253 	u8 reply_count;
254 };
255 
256 enum ezusb_state {
257 	EZUSB_CTX_START,
258 	EZUSB_CTX_QUEUED,
259 	EZUSB_CTX_REQ_SUBMITTED,
260 	EZUSB_CTX_REQ_COMPLETE,
261 	EZUSB_CTX_RESP_RECEIVED,
262 	EZUSB_CTX_REQ_TIMEOUT,
263 	EZUSB_CTX_REQ_FAILED,
264 	EZUSB_CTX_RESP_TIMEOUT,
265 	EZUSB_CTX_REQSUBMIT_FAIL,
266 	EZUSB_CTX_COMPLETE,
267 };
268 
269 struct request_context {
270 	struct list_head list;
271 	atomic_t refcount;
272 	struct completion done;	/* Signals that CTX is dead */
273 	int killed;
274 	struct urb *outurb;	/* OUT for req pkt */
275 	struct ezusb_priv *upriv;
276 	struct ezusb_packet *buf;
277 	int buf_length;
278 	struct timer_list timer;	/* Timeout handling */
279 	enum ezusb_state state;	/* Current state */
280 	/* the RID that we will wait for */
281 	u16 out_rid;
282 	u16 in_rid;
283 };
284 
285 
286 /* Forward declarations */
287 static void ezusb_ctx_complete(struct request_context *ctx);
288 static void ezusb_req_queue_run(struct ezusb_priv *upriv);
289 static void ezusb_bulk_in_callback(struct urb *urb);
290 
291 static inline u8 ezusb_reply_inc(u8 count)
292 {
293 	if (count < 0x7F)
294 		return count + 1;
295 	else
296 		return 1;
297 }
298 
299 static void ezusb_request_context_put(struct request_context *ctx)
300 {
301 	if (!atomic_dec_and_test(&ctx->refcount))
302 		return;
303 
304 	WARN_ON(!ctx->done.done);
305 	BUG_ON(ctx->outurb->status == -EINPROGRESS);
306 	BUG_ON(timer_pending(&ctx->timer));
307 	usb_free_urb(ctx->outurb);
308 	kfree(ctx->buf);
309 	kfree(ctx);
310 }
311 
312 static inline void ezusb_mod_timer(struct ezusb_priv *upriv,
313 				   struct timer_list *timer,
314 				   unsigned long expire)
315 {
316 	if (!upriv->udev)
317 		return;
318 	mod_timer(timer, expire);
319 }
320 
321 static void ezusb_request_timerfn(u_long _ctx)
322 {
323 	struct request_context *ctx = (void *) _ctx;
324 
325 	ctx->outurb->transfer_flags |= URB_ASYNC_UNLINK;
326 	if (usb_unlink_urb(ctx->outurb) == -EINPROGRESS) {
327 		ctx->state = EZUSB_CTX_REQ_TIMEOUT;
328 	} else {
329 		ctx->state = EZUSB_CTX_RESP_TIMEOUT;
330 		dev_dbg(&ctx->outurb->dev->dev, "couldn't unlink\n");
331 		atomic_inc(&ctx->refcount);
332 		ctx->killed = 1;
333 		ezusb_ctx_complete(ctx);
334 		ezusb_request_context_put(ctx);
335 	}
336 };
337 
338 static struct request_context *ezusb_alloc_ctx(struct ezusb_priv *upriv,
339 					       u16 out_rid, u16 in_rid)
340 {
341 	struct request_context *ctx;
342 
343 	ctx = kzalloc(sizeof(*ctx), GFP_ATOMIC);
344 	if (!ctx)
345 		return NULL;
346 
347 	ctx->buf = kmalloc(BULK_BUF_SIZE, GFP_ATOMIC);
348 	if (!ctx->buf) {
349 		kfree(ctx);
350 		return NULL;
351 	}
352 	ctx->outurb = usb_alloc_urb(0, GFP_ATOMIC);
353 	if (!ctx->outurb) {
354 		kfree(ctx->buf);
355 		kfree(ctx);
356 		return NULL;
357 	}
358 
359 	ctx->upriv = upriv;
360 	ctx->state = EZUSB_CTX_START;
361 	ctx->out_rid = out_rid;
362 	ctx->in_rid = in_rid;
363 
364 	atomic_set(&ctx->refcount, 1);
365 	init_completion(&ctx->done);
366 
367 	setup_timer(&ctx->timer, ezusb_request_timerfn, (u_long)ctx);
368 	return ctx;
369 }
370 
371 
372 /* Hopefully the real complete_all will soon be exported, in the mean
373  * while this should work. */
374 static inline void ezusb_complete_all(struct completion *comp)
375 {
376 	complete(comp);
377 	complete(comp);
378 	complete(comp);
379 	complete(comp);
380 }
381 
382 static void ezusb_ctx_complete(struct request_context *ctx)
383 {
384 	struct ezusb_priv *upriv = ctx->upriv;
385 	unsigned long flags;
386 
387 	spin_lock_irqsave(&upriv->req_lock, flags);
388 
389 	list_del_init(&ctx->list);
390 	if (upriv->udev) {
391 		spin_unlock_irqrestore(&upriv->req_lock, flags);
392 		ezusb_req_queue_run(upriv);
393 		spin_lock_irqsave(&upriv->req_lock, flags);
394 	}
395 
396 	switch (ctx->state) {
397 	case EZUSB_CTX_COMPLETE:
398 	case EZUSB_CTX_REQSUBMIT_FAIL:
399 	case EZUSB_CTX_REQ_FAILED:
400 	case EZUSB_CTX_REQ_TIMEOUT:
401 	case EZUSB_CTX_RESP_TIMEOUT:
402 		spin_unlock_irqrestore(&upriv->req_lock, flags);
403 
404 		if ((ctx->out_rid == EZUSB_RID_TX) && upriv->dev) {
405 			struct net_device *dev = upriv->dev;
406 			struct net_device_stats *stats = &dev->stats;
407 
408 			if (ctx->state != EZUSB_CTX_COMPLETE)
409 				stats->tx_errors++;
410 			else
411 				stats->tx_packets++;
412 
413 			netif_wake_queue(dev);
414 		}
415 		ezusb_complete_all(&ctx->done);
416 		ezusb_request_context_put(ctx);
417 		break;
418 
419 	default:
420 		spin_unlock_irqrestore(&upriv->req_lock, flags);
421 		if (!upriv->udev) {
422 			/* This is normal, as all request contexts get flushed
423 			 * when the device is disconnected */
424 			err("Called, CTX not terminating, but device gone");
425 			ezusb_complete_all(&ctx->done);
426 			ezusb_request_context_put(ctx);
427 			break;
428 		}
429 
430 		err("Called, CTX not in terminating state.");
431 		/* Things are really bad if this happens. Just leak
432 		 * the CTX because it may still be linked to the
433 		 * queue or the OUT urb may still be active.
434 		 * Just leaking at least prevents an Oops or Panic.
435 		 */
436 		break;
437 	}
438 }
439 
440 /**
441  * ezusb_req_queue_run:
442  * Description:
443  *	Note: Only one active CTX at any one time, because there's no
444  *	other (reliable) way to match the response URB to the correct
445  *	CTX.
446  **/
447 static void ezusb_req_queue_run(struct ezusb_priv *upriv)
448 {
449 	unsigned long flags;
450 	struct request_context *ctx;
451 	int result;
452 
453 	spin_lock_irqsave(&upriv->req_lock, flags);
454 
455 	if (!list_empty(&upriv->req_active))
456 		goto unlock;
457 
458 	if (list_empty(&upriv->req_pending))
459 		goto unlock;
460 
461 	ctx =
462 	    list_entry(upriv->req_pending.next, struct request_context,
463 		       list);
464 
465 	if (!ctx->upriv->udev)
466 		goto unlock;
467 
468 	/* We need to split this off to avoid a race condition */
469 	list_move_tail(&ctx->list, &upriv->req_active);
470 
471 	if (ctx->state == EZUSB_CTX_QUEUED) {
472 		atomic_inc(&ctx->refcount);
473 		result = usb_submit_urb(ctx->outurb, GFP_ATOMIC);
474 		if (result) {
475 			ctx->state = EZUSB_CTX_REQSUBMIT_FAIL;
476 
477 			spin_unlock_irqrestore(&upriv->req_lock, flags);
478 
479 			err("Fatal, failed to submit command urb."
480 			    " error=%d\n", result);
481 
482 			ezusb_ctx_complete(ctx);
483 			ezusb_request_context_put(ctx);
484 			goto done;
485 		}
486 
487 		ctx->state = EZUSB_CTX_REQ_SUBMITTED;
488 		ezusb_mod_timer(ctx->upriv, &ctx->timer,
489 				jiffies + DEF_TIMEOUT);
490 	}
491 
492  unlock:
493 	spin_unlock_irqrestore(&upriv->req_lock, flags);
494 
495  done:
496 	return;
497 }
498 
499 static void ezusb_req_enqueue_run(struct ezusb_priv *upriv,
500 				  struct request_context *ctx)
501 {
502 	unsigned long flags;
503 
504 	spin_lock_irqsave(&upriv->req_lock, flags);
505 
506 	if (!ctx->upriv->udev) {
507 		spin_unlock_irqrestore(&upriv->req_lock, flags);
508 		goto done;
509 	}
510 	atomic_inc(&ctx->refcount);
511 	list_add_tail(&ctx->list, &upriv->req_pending);
512 	spin_unlock_irqrestore(&upriv->req_lock, flags);
513 
514 	ctx->state = EZUSB_CTX_QUEUED;
515 	ezusb_req_queue_run(upriv);
516 
517  done:
518 	return;
519 }
520 
521 static void ezusb_request_out_callback(struct urb *urb)
522 {
523 	unsigned long flags;
524 	enum ezusb_state state;
525 	struct request_context *ctx = urb->context;
526 	struct ezusb_priv *upriv = ctx->upriv;
527 
528 	spin_lock_irqsave(&upriv->req_lock, flags);
529 
530 	del_timer(&ctx->timer);
531 
532 	if (ctx->killed) {
533 		spin_unlock_irqrestore(&upriv->req_lock, flags);
534 		pr_warn("interrupt called with dead ctx\n");
535 		goto out;
536 	}
537 
538 	state = ctx->state;
539 
540 	if (urb->status == 0) {
541 		switch (state) {
542 		case EZUSB_CTX_REQ_SUBMITTED:
543 			if (ctx->in_rid) {
544 				ctx->state = EZUSB_CTX_REQ_COMPLETE;
545 				/* reply URB still pending */
546 				ezusb_mod_timer(upriv, &ctx->timer,
547 						jiffies + DEF_TIMEOUT);
548 				spin_unlock_irqrestore(&upriv->req_lock,
549 						       flags);
550 				break;
551 			}
552 			/* fall through */
553 		case EZUSB_CTX_RESP_RECEIVED:
554 			/* IN already received before this OUT-ACK */
555 			ctx->state = EZUSB_CTX_COMPLETE;
556 			spin_unlock_irqrestore(&upriv->req_lock, flags);
557 			ezusb_ctx_complete(ctx);
558 			break;
559 
560 		default:
561 			spin_unlock_irqrestore(&upriv->req_lock, flags);
562 			err("Unexpected state(0x%x, %d) in OUT URB",
563 			    state, urb->status);
564 			break;
565 		}
566 	} else {
567 		/* If someone cancels the OUT URB then its status
568 		 * should be either -ECONNRESET or -ENOENT.
569 		 */
570 		switch (state) {
571 		case EZUSB_CTX_REQ_SUBMITTED:
572 		case EZUSB_CTX_RESP_RECEIVED:
573 			ctx->state = EZUSB_CTX_REQ_FAILED;
574 			/* fall through */
575 
576 		case EZUSB_CTX_REQ_FAILED:
577 		case EZUSB_CTX_REQ_TIMEOUT:
578 			spin_unlock_irqrestore(&upriv->req_lock, flags);
579 
580 			ezusb_ctx_complete(ctx);
581 			break;
582 
583 		default:
584 			spin_unlock_irqrestore(&upriv->req_lock, flags);
585 
586 			err("Unexpected state(0x%x, %d) in OUT URB",
587 			    state, urb->status);
588 			break;
589 		}
590 	}
591  out:
592 	ezusb_request_context_put(ctx);
593 }
594 
595 static void ezusb_request_in_callback(struct ezusb_priv *upriv,
596 				      struct urb *urb)
597 {
598 	struct ezusb_packet *ans = urb->transfer_buffer;
599 	struct request_context *ctx = NULL;
600 	enum ezusb_state state;
601 	unsigned long flags;
602 
603 	/* Find the CTX on the active queue that requested this URB */
604 	spin_lock_irqsave(&upriv->req_lock, flags);
605 	if (upriv->udev) {
606 		struct list_head *item;
607 
608 		list_for_each(item, &upriv->req_active) {
609 			struct request_context *c;
610 			int reply_count;
611 
612 			c = list_entry(item, struct request_context, list);
613 			reply_count =
614 			    ezusb_reply_inc(c->buf->req_reply_count);
615 			if ((ans->ans_reply_count == reply_count)
616 			    && (le16_to_cpu(ans->hermes_rid) == c->in_rid)) {
617 				ctx = c;
618 				break;
619 			}
620 			netdev_dbg(upriv->dev, "Skipped (0x%x/0x%x) (%d/%d)\n",
621 				   le16_to_cpu(ans->hermes_rid), c->in_rid,
622 				   ans->ans_reply_count, reply_count);
623 		}
624 	}
625 
626 	if (ctx == NULL) {
627 		spin_unlock_irqrestore(&upriv->req_lock, flags);
628 		err("%s: got unexpected RID: 0x%04X", __func__,
629 		    le16_to_cpu(ans->hermes_rid));
630 		ezusb_req_queue_run(upriv);
631 		return;
632 	}
633 
634 	/* The data we want is in the in buffer, exchange */
635 	urb->transfer_buffer = ctx->buf;
636 	ctx->buf = (void *) ans;
637 	ctx->buf_length = urb->actual_length;
638 
639 	state = ctx->state;
640 	switch (state) {
641 	case EZUSB_CTX_REQ_SUBMITTED:
642 		/* We have received our response URB before
643 		 * our request has been acknowledged. Do NOT
644 		 * destroy our CTX yet, because our OUT URB
645 		 * is still alive ...
646 		 */
647 		ctx->state = EZUSB_CTX_RESP_RECEIVED;
648 		spin_unlock_irqrestore(&upriv->req_lock, flags);
649 
650 		/* Let the machine continue running. */
651 		break;
652 
653 	case EZUSB_CTX_REQ_COMPLETE:
654 		/* This is the usual path: our request
655 		 * has already been acknowledged, and
656 		 * we have now received the reply.
657 		 */
658 		ctx->state = EZUSB_CTX_COMPLETE;
659 
660 		/* Stop the intimer */
661 		del_timer(&ctx->timer);
662 		spin_unlock_irqrestore(&upriv->req_lock, flags);
663 
664 		/* Call the completion handler */
665 		ezusb_ctx_complete(ctx);
666 		break;
667 
668 	default:
669 		spin_unlock_irqrestore(&upriv->req_lock, flags);
670 
671 		pr_warn("Matched IN URB, unexpected context state(0x%x)\n",
672 			state);
673 		/* Throw this CTX away and try submitting another */
674 		del_timer(&ctx->timer);
675 		ctx->outurb->transfer_flags |= URB_ASYNC_UNLINK;
676 		usb_unlink_urb(ctx->outurb);
677 		ezusb_req_queue_run(upriv);
678 		break;
679 	}			/* switch */
680 }
681 
682 
683 static void ezusb_req_ctx_wait(struct ezusb_priv *upriv,
684 			       struct request_context *ctx)
685 {
686 	switch (ctx->state) {
687 	case EZUSB_CTX_QUEUED:
688 	case EZUSB_CTX_REQ_SUBMITTED:
689 	case EZUSB_CTX_REQ_COMPLETE:
690 	case EZUSB_CTX_RESP_RECEIVED:
691 		if (in_softirq()) {
692 			/* If we get called from a timer, timeout timers don't
693 			 * get the chance to run themselves. So we make sure
694 			 * that we don't sleep for ever */
695 			int msecs = DEF_TIMEOUT * (1000 / HZ);
696 			while (!ctx->done.done && msecs--)
697 				udelay(1000);
698 		} else {
699 			wait_event_interruptible(ctx->done.wait,
700 						 ctx->done.done);
701 		}
702 		break;
703 	default:
704 		/* Done or failed - nothing to wait for */
705 		break;
706 	}
707 }
708 
709 static inline u16 build_crc(struct ezusb_packet *data)
710 {
711 	u16 crc = 0;
712 	u8 *bytes = (u8 *)data;
713 	int i;
714 
715 	for (i = 0; i < 8; i++)
716 		crc = (crc << 1) + bytes[i];
717 
718 	return crc;
719 }
720 
721 /**
722  * ezusb_fill_req:
723  *
724  * if data == NULL and length > 0 the data is assumed to be already in
725  * the target buffer and only the header is filled.
726  *
727  */
728 static int ezusb_fill_req(struct ezusb_packet *req, u16 length, u16 rid,
729 			  const void *data, u16 frame_type, u8 reply_count)
730 {
731 	int total_size = sizeof(*req) + length;
732 
733 	BUG_ON(total_size > BULK_BUF_SIZE);
734 
735 	req->magic = cpu_to_le16(EZUSB_MAGIC);
736 	req->req_reply_count = reply_count;
737 	req->ans_reply_count = 0;
738 	req->frame_type = cpu_to_le16(frame_type);
739 	req->size = cpu_to_le16(length + 4);
740 	req->crc = cpu_to_le16(build_crc(req));
741 	req->hermes_len = cpu_to_le16(HERMES_BYTES_TO_RECLEN(length));
742 	req->hermes_rid = cpu_to_le16(rid);
743 	if (data)
744 		memcpy(req->data, data, length);
745 	return total_size;
746 }
747 
748 static int ezusb_submit_in_urb(struct ezusb_priv *upriv)
749 {
750 	int retval = 0;
751 	void *cur_buf = upriv->read_urb->transfer_buffer;
752 
753 	if (upriv->read_urb->status == -EINPROGRESS) {
754 		netdev_dbg(upriv->dev, "urb busy, not resubmiting\n");
755 		retval = -EBUSY;
756 		goto exit;
757 	}
758 	usb_fill_bulk_urb(upriv->read_urb, upriv->udev, upriv->read_pipe,
759 			  cur_buf, BULK_BUF_SIZE,
760 			  ezusb_bulk_in_callback, upriv);
761 	upriv->read_urb->transfer_flags = 0;
762 	retval = usb_submit_urb(upriv->read_urb, GFP_ATOMIC);
763 	if (retval)
764 		err("%s submit failed %d", __func__, retval);
765 
766  exit:
767 	return retval;
768 }
769 
770 static inline int ezusb_8051_cpucs(struct ezusb_priv *upriv, int reset)
771 {
772 	u8 res_val = reset;	/* avoid argument promotion */
773 
774 	if (!upriv->udev) {
775 		err("%s: !upriv->udev", __func__);
776 		return -EFAULT;
777 	}
778 	return usb_control_msg(upriv->udev,
779 			       usb_sndctrlpipe(upriv->udev, 0),
780 			       EZUSB_REQUEST_FW_TRANS,
781 			       USB_TYPE_VENDOR | USB_RECIP_DEVICE |
782 			       USB_DIR_OUT, EZUSB_CPUCS_REG, 0, &res_val,
783 			       sizeof(res_val), DEF_TIMEOUT);
784 }
785 
786 static int ezusb_firmware_download(struct ezusb_priv *upriv,
787 				   struct ez_usb_fw *fw)
788 {
789 	u8 *fw_buffer;
790 	int retval, addr;
791 	int variant_offset;
792 
793 	fw_buffer = kmalloc(FW_BUF_SIZE, GFP_KERNEL);
794 	if (!fw_buffer) {
795 		printk(KERN_ERR PFX "Out of memory for firmware buffer.\n");
796 		return -ENOMEM;
797 	}
798 	/*
799 	 * This byte is 1 and should be replaced with 0.  The offset is
800 	 * 0x10AD in version 0.0.6.  The byte in question should follow
801 	 * the end of the code pointed to by the jump in the beginning
802 	 * of the firmware.  Also, it is read by code located at 0x358.
803 	 */
804 	variant_offset = be16_to_cpup((__be16 *) &fw->code[FW_VAR_OFFSET_PTR]);
805 	if (variant_offset >= fw->size) {
806 		printk(KERN_ERR PFX "Invalid firmware variant offset: "
807 		       "0x%04x\n", variant_offset);
808 		retval = -EINVAL;
809 		goto fail;
810 	}
811 
812 	retval = ezusb_8051_cpucs(upriv, 1);
813 	if (retval < 0)
814 		goto fail;
815 	for (addr = 0; addr < fw->size; addr += FW_BUF_SIZE) {
816 		/* 0x100-0x300 should be left alone, it contains card
817 		 * specific data, like USB enumeration information */
818 		if ((addr >= FW_HOLE_START) && (addr < FW_HOLE_END))
819 			continue;
820 
821 		memcpy(fw_buffer, &fw->code[addr], FW_BUF_SIZE);
822 		if (variant_offset >= addr &&
823 		    variant_offset < addr + FW_BUF_SIZE) {
824 			netdev_dbg(upriv->dev,
825 				   "Patching card_variant byte at 0x%04X\n",
826 				   variant_offset);
827 			fw_buffer[variant_offset - addr] = FW_VAR_VALUE;
828 		}
829 		retval = usb_control_msg(upriv->udev,
830 					 usb_sndctrlpipe(upriv->udev, 0),
831 					 EZUSB_REQUEST_FW_TRANS,
832 					 USB_TYPE_VENDOR | USB_RECIP_DEVICE
833 					 | USB_DIR_OUT,
834 					 addr, 0x0,
835 					 fw_buffer, FW_BUF_SIZE,
836 					 DEF_TIMEOUT);
837 
838 		if (retval < 0)
839 			goto fail;
840 	}
841 	retval = ezusb_8051_cpucs(upriv, 0);
842 	if (retval < 0)
843 		goto fail;
844 
845 	goto exit;
846  fail:
847 	printk(KERN_ERR PFX "Firmware download failed, error %d\n",
848 	       retval);
849  exit:
850 	kfree(fw_buffer);
851 	return retval;
852 }
853 
854 static int ezusb_access_ltv(struct ezusb_priv *upriv,
855 			    struct request_context *ctx,
856 			    u16 length, const void *data, u16 frame_type,
857 			    void *ans_buff, unsigned ans_size, u16 *ans_length)
858 {
859 	int req_size;
860 	int retval = 0;
861 	enum ezusb_state state;
862 
863 	BUG_ON(in_irq());
864 
865 	if (!upriv->udev) {
866 		retval = -ENODEV;
867 		goto exit;
868 	}
869 
870 	if (upriv->read_urb->status != -EINPROGRESS)
871 		err("%s: in urb not pending", __func__);
872 
873 	/* protect upriv->reply_count, guarantee sequential numbers */
874 	spin_lock_bh(&upriv->reply_count_lock);
875 	req_size = ezusb_fill_req(ctx->buf, length, ctx->out_rid, data,
876 				  frame_type, upriv->reply_count);
877 	usb_fill_bulk_urb(ctx->outurb, upriv->udev, upriv->write_pipe,
878 			  ctx->buf, req_size,
879 			  ezusb_request_out_callback, ctx);
880 
881 	if (ctx->in_rid)
882 		upriv->reply_count = ezusb_reply_inc(upriv->reply_count);
883 
884 	ezusb_req_enqueue_run(upriv, ctx);
885 
886 	spin_unlock_bh(&upriv->reply_count_lock);
887 
888 	if (ctx->in_rid)
889 		ezusb_req_ctx_wait(upriv, ctx);
890 
891 	state = ctx->state;
892 	switch (state) {
893 	case EZUSB_CTX_COMPLETE:
894 		retval = ctx->outurb->status;
895 		break;
896 
897 	case EZUSB_CTX_QUEUED:
898 	case EZUSB_CTX_REQ_SUBMITTED:
899 		if (!ctx->in_rid)
900 			break;
901 	default:
902 		err("%s: Unexpected context state %d", __func__,
903 		    state);
904 		/* fall though */
905 	case EZUSB_CTX_REQ_TIMEOUT:
906 	case EZUSB_CTX_REQ_FAILED:
907 	case EZUSB_CTX_RESP_TIMEOUT:
908 	case EZUSB_CTX_REQSUBMIT_FAIL:
909 		printk(KERN_ERR PFX "Access failed, resetting (state %d,"
910 		       " reply_count %d)\n", state, upriv->reply_count);
911 		upriv->reply_count = 0;
912 		if (state == EZUSB_CTX_REQ_TIMEOUT
913 		    || state == EZUSB_CTX_RESP_TIMEOUT) {
914 			printk(KERN_ERR PFX "ctx timed out\n");
915 			retval = -ETIMEDOUT;
916 		} else {
917 			printk(KERN_ERR PFX "ctx failed\n");
918 			retval = -EFAULT;
919 		}
920 		goto exit;
921 	}
922 	if (ctx->in_rid) {
923 		struct ezusb_packet *ans = ctx->buf;
924 		unsigned exp_len;
925 
926 		if (ans->hermes_len != 0)
927 			exp_len = le16_to_cpu(ans->hermes_len) * 2 + 12;
928 		else
929 			exp_len = 14;
930 
931 		if (exp_len != ctx->buf_length) {
932 			err("%s: length mismatch for RID 0x%04x: "
933 			    "expected %d, got %d", __func__,
934 			    ctx->in_rid, exp_len, ctx->buf_length);
935 			retval = -EIO;
936 			goto exit;
937 		}
938 
939 		if (ans_buff)
940 			memcpy(ans_buff, ans->data, min(exp_len, ans_size));
941 		if (ans_length)
942 			*ans_length = le16_to_cpu(ans->hermes_len);
943 	}
944  exit:
945 	ezusb_request_context_put(ctx);
946 	return retval;
947 }
948 
949 static int ezusb_write_ltv(struct hermes *hw, int bap, u16 rid,
950 			   u16 length, const void *data)
951 {
952 	struct ezusb_priv *upriv = hw->priv;
953 	u16 frame_type;
954 	struct request_context *ctx;
955 
956 	if (length == 0)
957 		return -EINVAL;
958 
959 	length = HERMES_RECLEN_TO_BYTES(length);
960 
961 	/* On memory mapped devices HERMES_RID_CNFGROUPADDRESSES can be
962 	 * set to be empty, but the USB bridge doesn't like it */
963 	if (length == 0)
964 		return 0;
965 
966 	ctx = ezusb_alloc_ctx(upriv, rid, EZUSB_RID_ACK);
967 	if (!ctx)
968 		return -ENOMEM;
969 
970 	if (rid == EZUSB_RID_TX)
971 		frame_type = EZUSB_FRAME_DATA;
972 	else
973 		frame_type = EZUSB_FRAME_CONTROL;
974 
975 	return ezusb_access_ltv(upriv, ctx, length, data, frame_type,
976 				NULL, 0, NULL);
977 }
978 
979 static int ezusb_read_ltv(struct hermes *hw, int bap, u16 rid,
980 			  unsigned bufsize, u16 *length, void *buf)
981 {
982 	struct ezusb_priv *upriv = hw->priv;
983 	struct request_context *ctx;
984 
985 	if (bufsize % 2)
986 		return -EINVAL;
987 
988 	ctx = ezusb_alloc_ctx(upriv, rid, rid);
989 	if (!ctx)
990 		return -ENOMEM;
991 
992 	return ezusb_access_ltv(upriv, ctx, 0, NULL, EZUSB_FRAME_CONTROL,
993 				buf, bufsize, length);
994 }
995 
996 static int ezusb_doicmd_wait(struct hermes *hw, u16 cmd, u16 parm0, u16 parm1,
997 			     u16 parm2, struct hermes_response *resp)
998 {
999 	struct ezusb_priv *upriv = hw->priv;
1000 	struct request_context *ctx;
1001 
1002 	__le16 data[4] = {
1003 		cpu_to_le16(cmd),
1004 		cpu_to_le16(parm0),
1005 		cpu_to_le16(parm1),
1006 		cpu_to_le16(parm2),
1007 	};
1008 	netdev_dbg(upriv->dev,
1009 		   "0x%04X, parm0 0x%04X, parm1 0x%04X, parm2 0x%04X\n", cmd,
1010 		   parm0, parm1, parm2);
1011 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_DOCMD, EZUSB_RID_ACK);
1012 	if (!ctx)
1013 		return -ENOMEM;
1014 
1015 	return ezusb_access_ltv(upriv, ctx, sizeof(data), &data,
1016 				EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1017 }
1018 
1019 static int ezusb_docmd_wait(struct hermes *hw, u16 cmd, u16 parm0,
1020 			    struct hermes_response *resp)
1021 {
1022 	struct ezusb_priv *upriv = hw->priv;
1023 	struct request_context *ctx;
1024 
1025 	__le16 data[4] = {
1026 		cpu_to_le16(cmd),
1027 		cpu_to_le16(parm0),
1028 		0,
1029 		0,
1030 	};
1031 	netdev_dbg(upriv->dev, "0x%04X, parm0 0x%04X\n", cmd, parm0);
1032 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_DOCMD, EZUSB_RID_ACK);
1033 	if (!ctx)
1034 		return -ENOMEM;
1035 
1036 	return ezusb_access_ltv(upriv, ctx, sizeof(data), &data,
1037 				EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1038 }
1039 
1040 static int ezusb_bap_pread(struct hermes *hw, int bap,
1041 			   void *buf, int len, u16 id, u16 offset)
1042 {
1043 	struct ezusb_priv *upriv = hw->priv;
1044 	struct ezusb_packet *ans = (void *) upriv->read_urb->transfer_buffer;
1045 	int actual_length = upriv->read_urb->actual_length;
1046 
1047 	if (id == EZUSB_RID_RX) {
1048 		if ((sizeof(*ans) + offset + len) > actual_length) {
1049 			printk(KERN_ERR PFX "BAP read beyond buffer end "
1050 			       "in rx frame\n");
1051 			return -EINVAL;
1052 		}
1053 		memcpy(buf, ans->data + offset, len);
1054 		return 0;
1055 	}
1056 
1057 	if (EZUSB_IS_INFO(id)) {
1058 		/* Include 4 bytes for length/type */
1059 		if ((sizeof(*ans) + offset + len - 4) > actual_length) {
1060 			printk(KERN_ERR PFX "BAP read beyond buffer end "
1061 			       "in info frame\n");
1062 			return -EFAULT;
1063 		}
1064 		memcpy(buf, ans->data + offset - 4, len);
1065 	} else {
1066 		printk(KERN_ERR PFX "Unexpected fid 0x%04x\n", id);
1067 		return -EINVAL;
1068 	}
1069 
1070 	return 0;
1071 }
1072 
1073 static int ezusb_read_pda(struct hermes *hw, __le16 *pda,
1074 			  u32 pda_addr, u16 pda_len)
1075 {
1076 	struct ezusb_priv *upriv = hw->priv;
1077 	struct request_context *ctx;
1078 	__le16 data[] = {
1079 		cpu_to_le16(pda_addr & 0xffff),
1080 		cpu_to_le16(pda_len - 4)
1081 	};
1082 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_READ_PDA, EZUSB_RID_READ_PDA);
1083 	if (!ctx)
1084 		return -ENOMEM;
1085 
1086 	/* wl_lkm does not include PDA size in the PDA area.
1087 	 * We will pad the information into pda, so other routines
1088 	 * don't have to be modified */
1089 	pda[0] = cpu_to_le16(pda_len - 2);
1090 	/* Includes CFG_PROD_DATA but not itself */
1091 	pda[1] = cpu_to_le16(0x0800); /* CFG_PROD_DATA */
1092 
1093 	return ezusb_access_ltv(upriv, ctx, sizeof(data), &data,
1094 				EZUSB_FRAME_CONTROL, &pda[2], pda_len - 4,
1095 				NULL);
1096 }
1097 
1098 static int ezusb_program_init(struct hermes *hw, u32 entry_point)
1099 {
1100 	struct ezusb_priv *upriv = hw->priv;
1101 	struct request_context *ctx;
1102 	__le32 data = cpu_to_le32(entry_point);
1103 
1104 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_PROG_INIT, EZUSB_RID_ACK);
1105 	if (!ctx)
1106 		return -ENOMEM;
1107 
1108 	return ezusb_access_ltv(upriv, ctx, sizeof(data), &data,
1109 				EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1110 }
1111 
1112 static int ezusb_program_end(struct hermes *hw)
1113 {
1114 	struct ezusb_priv *upriv = hw->priv;
1115 	struct request_context *ctx;
1116 
1117 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_PROG_END, EZUSB_RID_ACK);
1118 	if (!ctx)
1119 		return -ENOMEM;
1120 
1121 	return ezusb_access_ltv(upriv, ctx, 0, NULL,
1122 				EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1123 }
1124 
1125 static int ezusb_program_bytes(struct hermes *hw, const char *buf,
1126 			       u32 addr, u32 len)
1127 {
1128 	struct ezusb_priv *upriv = hw->priv;
1129 	struct request_context *ctx;
1130 	__le32 data = cpu_to_le32(addr);
1131 	int err;
1132 
1133 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_PROG_SET_ADDR, EZUSB_RID_ACK);
1134 	if (!ctx)
1135 		return -ENOMEM;
1136 
1137 	err = ezusb_access_ltv(upriv, ctx, sizeof(data), &data,
1138 			       EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1139 	if (err)
1140 		return err;
1141 
1142 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_PROG_BYTES, EZUSB_RID_ACK);
1143 	if (!ctx)
1144 		return -ENOMEM;
1145 
1146 	return ezusb_access_ltv(upriv, ctx, len, buf,
1147 				EZUSB_FRAME_CONTROL, NULL, 0, NULL);
1148 }
1149 
1150 static int ezusb_program(struct hermes *hw, const char *buf,
1151 			 u32 addr, u32 len)
1152 {
1153 	u32 ch_addr;
1154 	u32 ch_len;
1155 	int err = 0;
1156 
1157 	/* We can only send 2048 bytes out of the bulk xmit at a time,
1158 	 * so we have to split any programming into chunks of <2048
1159 	 * bytes. */
1160 
1161 	ch_len = (len < MAX_DL_SIZE) ? len : MAX_DL_SIZE;
1162 	ch_addr = addr;
1163 
1164 	while (ch_addr < (addr + len)) {
1165 		pr_debug("Programming subblock of length %d "
1166 			 "to address 0x%08x. Data @ %p\n",
1167 			 ch_len, ch_addr, &buf[ch_addr - addr]);
1168 
1169 		err = ezusb_program_bytes(hw, &buf[ch_addr - addr],
1170 					  ch_addr, ch_len);
1171 		if (err)
1172 			break;
1173 
1174 		ch_addr += ch_len;
1175 		ch_len = ((addr + len - ch_addr) < MAX_DL_SIZE) ?
1176 			(addr + len - ch_addr) : MAX_DL_SIZE;
1177 	}
1178 
1179 	return err;
1180 }
1181 
1182 static netdev_tx_t ezusb_xmit(struct sk_buff *skb, struct net_device *dev)
1183 {
1184 	struct orinoco_private *priv = ndev_priv(dev);
1185 	struct net_device_stats *stats = &dev->stats;
1186 	struct ezusb_priv *upriv = priv->card;
1187 	u8 mic[MICHAEL_MIC_LEN + 1];
1188 	int err = 0;
1189 	int tx_control;
1190 	unsigned long flags;
1191 	struct request_context *ctx;
1192 	u8 *buf;
1193 	int tx_size;
1194 
1195 	if (!netif_running(dev)) {
1196 		printk(KERN_ERR "%s: Tx on stopped device!\n",
1197 		       dev->name);
1198 		return NETDEV_TX_BUSY;
1199 	}
1200 
1201 	if (netif_queue_stopped(dev)) {
1202 		printk(KERN_DEBUG "%s: Tx while transmitter busy!\n",
1203 		       dev->name);
1204 		return NETDEV_TX_BUSY;
1205 	}
1206 
1207 	if (orinoco_lock(priv, &flags) != 0) {
1208 		printk(KERN_ERR
1209 		       "%s: ezusb_xmit() called while hw_unavailable\n",
1210 		       dev->name);
1211 		return NETDEV_TX_BUSY;
1212 	}
1213 
1214 	if (!netif_carrier_ok(dev) ||
1215 	    (priv->iw_mode == NL80211_IFTYPE_MONITOR)) {
1216 		/* Oops, the firmware hasn't established a connection,
1217 		   silently drop the packet (this seems to be the
1218 		   safest approach). */
1219 		goto drop;
1220 	}
1221 
1222 	/* Check packet length */
1223 	if (skb->len < ETH_HLEN)
1224 		goto drop;
1225 
1226 	ctx = ezusb_alloc_ctx(upriv, EZUSB_RID_TX, 0);
1227 	if (!ctx)
1228 		goto busy;
1229 
1230 	memset(ctx->buf, 0, BULK_BUF_SIZE);
1231 	buf = ctx->buf->data;
1232 
1233 	tx_control = 0;
1234 
1235 	err = orinoco_process_xmit_skb(skb, dev, priv, &tx_control,
1236 				       &mic[0]);
1237 	if (err)
1238 		goto drop;
1239 
1240 	{
1241 		__le16 *tx_cntl = (__le16 *)buf;
1242 		*tx_cntl = cpu_to_le16(tx_control);
1243 		buf += sizeof(*tx_cntl);
1244 	}
1245 
1246 	memcpy(buf, skb->data, skb->len);
1247 	buf += skb->len;
1248 
1249 	if (tx_control & HERMES_TXCTRL_MIC) {
1250 		u8 *m = mic;
1251 		/* Mic has been offset so it can be copied to an even
1252 		 * address. We're copying eveything anyway, so we
1253 		 * don't need to copy that first byte. */
1254 		if (skb->len % 2)
1255 			m++;
1256 		memcpy(buf, m, MICHAEL_MIC_LEN);
1257 		buf += MICHAEL_MIC_LEN;
1258 	}
1259 
1260 	/* Finally, we actually initiate the send */
1261 	netif_stop_queue(dev);
1262 
1263 	/* The card may behave better if we send evenly sized usb transfers */
1264 	tx_size = ALIGN(buf - ctx->buf->data, 2);
1265 
1266 	err = ezusb_access_ltv(upriv, ctx, tx_size, NULL,
1267 			       EZUSB_FRAME_DATA, NULL, 0, NULL);
1268 
1269 	if (err) {
1270 		netif_start_queue(dev);
1271 		if (net_ratelimit())
1272 			printk(KERN_ERR "%s: Error %d transmitting packet\n",
1273 				dev->name, err);
1274 		goto busy;
1275 	}
1276 
1277 	netif_trans_update(dev);
1278 	stats->tx_bytes += skb->len;
1279 	goto ok;
1280 
1281  drop:
1282 	stats->tx_errors++;
1283 	stats->tx_dropped++;
1284 
1285  ok:
1286 	orinoco_unlock(priv, &flags);
1287 	dev_kfree_skb(skb);
1288 	return NETDEV_TX_OK;
1289 
1290  busy:
1291 	orinoco_unlock(priv, &flags);
1292 	return NETDEV_TX_BUSY;
1293 }
1294 
1295 static int ezusb_allocate(struct hermes *hw, u16 size, u16 *fid)
1296 {
1297 	*fid = EZUSB_RID_TX;
1298 	return 0;
1299 }
1300 
1301 
1302 static int ezusb_hard_reset(struct orinoco_private *priv)
1303 {
1304 	struct ezusb_priv *upriv = priv->card;
1305 	int retval = ezusb_8051_cpucs(upriv, 1);
1306 
1307 	if (retval < 0) {
1308 		err("Failed to reset");
1309 		return retval;
1310 	}
1311 
1312 	retval = ezusb_8051_cpucs(upriv, 0);
1313 	if (retval < 0) {
1314 		err("Failed to unreset");
1315 		return retval;
1316 	}
1317 
1318 	netdev_dbg(upriv->dev, "sending control message\n");
1319 	retval = usb_control_msg(upriv->udev,
1320 				 usb_sndctrlpipe(upriv->udev, 0),
1321 				 EZUSB_REQUEST_TRIGER,
1322 				 USB_TYPE_VENDOR | USB_RECIP_DEVICE |
1323 				 USB_DIR_OUT, 0x0, 0x0, NULL, 0,
1324 				 DEF_TIMEOUT);
1325 	if (retval < 0) {
1326 		err("EZUSB_REQUEST_TRIGER failed retval %d", retval);
1327 		return retval;
1328 	}
1329 #if 0
1330 	dbg("Sending EZUSB_REQUEST_TRIG_AC");
1331 	retval = usb_control_msg(upriv->udev,
1332 				 usb_sndctrlpipe(upriv->udev, 0),
1333 				 EZUSB_REQUEST_TRIG_AC,
1334 				 USB_TYPE_VENDOR | USB_RECIP_DEVICE |
1335 				 USB_DIR_OUT, 0x00FA, 0x0, NULL, 0,
1336 				 DEF_TIMEOUT);
1337 	if (retval < 0) {
1338 		err("EZUSB_REQUEST_TRIG_AC failed retval %d", retval);
1339 		return retval;
1340 	}
1341 #endif
1342 
1343 	return 0;
1344 }
1345 
1346 
1347 static int ezusb_init(struct hermes *hw)
1348 {
1349 	struct ezusb_priv *upriv = hw->priv;
1350 	int retval;
1351 
1352 	BUG_ON(in_interrupt());
1353 	BUG_ON(!upriv);
1354 
1355 	upriv->reply_count = 0;
1356 	/* Write the MAGIC number on the simulated registers to keep
1357 	 * orinoco.c happy */
1358 	hermes_write_regn(hw, SWSUPPORT0, HERMES_MAGIC);
1359 	hermes_write_regn(hw, RXFID, EZUSB_RID_RX);
1360 
1361 	usb_kill_urb(upriv->read_urb);
1362 	ezusb_submit_in_urb(upriv);
1363 
1364 	retval = ezusb_write_ltv(hw, 0, EZUSB_RID_INIT1,
1365 				 HERMES_BYTES_TO_RECLEN(2), "\x10\x00");
1366 	if (retval < 0) {
1367 		printk(KERN_ERR PFX "EZUSB_RID_INIT1 error %d\n", retval);
1368 		return retval;
1369 	}
1370 
1371 	retval = ezusb_docmd_wait(hw, HERMES_CMD_INIT, 0, NULL);
1372 	if (retval < 0) {
1373 		printk(KERN_ERR PFX "HERMES_CMD_INIT error %d\n", retval);
1374 		return retval;
1375 	}
1376 
1377 	return 0;
1378 }
1379 
1380 static void ezusb_bulk_in_callback(struct urb *urb)
1381 {
1382 	struct ezusb_priv *upriv = (struct ezusb_priv *) urb->context;
1383 	struct ezusb_packet *ans = urb->transfer_buffer;
1384 	u16 crc;
1385 	u16 hermes_rid;
1386 
1387 	if (upriv->udev == NULL)
1388 		return;
1389 
1390 	if (urb->status == -ETIMEDOUT) {
1391 		/* When a device gets unplugged we get this every time
1392 		 * we resubmit, flooding the logs.  Since we don't use
1393 		 * USB timeouts, it shouldn't happen any other time*/
1394 		pr_warn("%s: urb timed out, not resubmitting\n", __func__);
1395 		return;
1396 	}
1397 	if (urb->status == -ECONNABORTED) {
1398 		pr_warn("%s: connection abort, resubmitting urb\n",
1399 			__func__);
1400 		goto resubmit;
1401 	}
1402 	if ((urb->status == -EILSEQ)
1403 	    || (urb->status == -ENOENT)
1404 	    || (urb->status == -ECONNRESET)) {
1405 		netdev_dbg(upriv->dev, "status %d, not resubmiting\n",
1406 			   urb->status);
1407 		return;
1408 	}
1409 	if (urb->status)
1410 		netdev_dbg(upriv->dev, "status: %d length: %d\n",
1411 			   urb->status, urb->actual_length);
1412 	if (urb->actual_length < sizeof(*ans)) {
1413 		err("%s: short read, ignoring", __func__);
1414 		goto resubmit;
1415 	}
1416 	crc = build_crc(ans);
1417 	if (le16_to_cpu(ans->crc) != crc) {
1418 		err("CRC error, ignoring packet");
1419 		goto resubmit;
1420 	}
1421 
1422 	hermes_rid = le16_to_cpu(ans->hermes_rid);
1423 	if ((hermes_rid != EZUSB_RID_RX) && !EZUSB_IS_INFO(hermes_rid)) {
1424 		ezusb_request_in_callback(upriv, urb);
1425 	} else if (upriv->dev) {
1426 		struct net_device *dev = upriv->dev;
1427 		struct orinoco_private *priv = ndev_priv(dev);
1428 		struct hermes *hw = &priv->hw;
1429 
1430 		if (hermes_rid == EZUSB_RID_RX) {
1431 			__orinoco_ev_rx(dev, hw);
1432 		} else {
1433 			hermes_write_regn(hw, INFOFID,
1434 					  le16_to_cpu(ans->hermes_rid));
1435 			__orinoco_ev_info(dev, hw);
1436 		}
1437 	}
1438 
1439  resubmit:
1440 	if (upriv->udev)
1441 		ezusb_submit_in_urb(upriv);
1442 }
1443 
1444 static inline void ezusb_delete(struct ezusb_priv *upriv)
1445 {
1446 	struct net_device *dev;
1447 	struct list_head *item;
1448 	struct list_head *tmp_item;
1449 	unsigned long flags;
1450 
1451 	BUG_ON(in_interrupt());
1452 	BUG_ON(!upriv);
1453 
1454 	dev = upriv->dev;
1455 	mutex_lock(&upriv->mtx);
1456 
1457 	upriv->udev = NULL;	/* No timer will be rearmed from here */
1458 
1459 	usb_kill_urb(upriv->read_urb);
1460 
1461 	spin_lock_irqsave(&upriv->req_lock, flags);
1462 	list_for_each_safe(item, tmp_item, &upriv->req_active) {
1463 		struct request_context *ctx;
1464 		int err;
1465 
1466 		ctx = list_entry(item, struct request_context, list);
1467 		atomic_inc(&ctx->refcount);
1468 
1469 		ctx->outurb->transfer_flags |= URB_ASYNC_UNLINK;
1470 		err = usb_unlink_urb(ctx->outurb);
1471 
1472 		spin_unlock_irqrestore(&upriv->req_lock, flags);
1473 		if (err == -EINPROGRESS)
1474 			wait_for_completion(&ctx->done);
1475 
1476 		del_timer_sync(&ctx->timer);
1477 		/* FIXME: there is an slight chance for the irq handler to
1478 		 * be running */
1479 		if (!list_empty(&ctx->list))
1480 			ezusb_ctx_complete(ctx);
1481 
1482 		ezusb_request_context_put(ctx);
1483 		spin_lock_irqsave(&upriv->req_lock, flags);
1484 	}
1485 	spin_unlock_irqrestore(&upriv->req_lock, flags);
1486 
1487 	list_for_each_safe(item, tmp_item, &upriv->req_pending)
1488 	    ezusb_ctx_complete(list_entry(item,
1489 					  struct request_context, list));
1490 
1491 	if (upriv->read_urb && upriv->read_urb->status == -EINPROGRESS)
1492 		printk(KERN_ERR PFX "Some URB in progress\n");
1493 
1494 	mutex_unlock(&upriv->mtx);
1495 
1496 	if (upriv->read_urb) {
1497 		kfree(upriv->read_urb->transfer_buffer);
1498 		usb_free_urb(upriv->read_urb);
1499 	}
1500 	kfree(upriv->bap_buf);
1501 	if (upriv->dev) {
1502 		struct orinoco_private *priv = ndev_priv(upriv->dev);
1503 		orinoco_if_del(priv);
1504 		wiphy_unregister(priv_to_wiphy(upriv));
1505 		free_orinocodev(priv);
1506 	}
1507 }
1508 
1509 static void ezusb_lock_irqsave(spinlock_t *lock,
1510 			       unsigned long *flags) __acquires(lock)
1511 {
1512 	spin_lock_bh(lock);
1513 }
1514 
1515 static void ezusb_unlock_irqrestore(spinlock_t *lock,
1516 				    unsigned long *flags) __releases(lock)
1517 {
1518 	spin_unlock_bh(lock);
1519 }
1520 
1521 static void ezusb_lock_irq(spinlock_t *lock) __acquires(lock)
1522 {
1523 	spin_lock_bh(lock);
1524 }
1525 
1526 static void ezusb_unlock_irq(spinlock_t *lock) __releases(lock)
1527 {
1528 	spin_unlock_bh(lock);
1529 }
1530 
1531 static const struct hermes_ops ezusb_ops = {
1532 	.init = ezusb_init,
1533 	.cmd_wait = ezusb_docmd_wait,
1534 	.init_cmd_wait = ezusb_doicmd_wait,
1535 	.allocate = ezusb_allocate,
1536 	.read_ltv = ezusb_read_ltv,
1537 	.write_ltv = ezusb_write_ltv,
1538 	.bap_pread = ezusb_bap_pread,
1539 	.read_pda = ezusb_read_pda,
1540 	.program_init = ezusb_program_init,
1541 	.program_end = ezusb_program_end,
1542 	.program = ezusb_program,
1543 	.lock_irqsave = ezusb_lock_irqsave,
1544 	.unlock_irqrestore = ezusb_unlock_irqrestore,
1545 	.lock_irq = ezusb_lock_irq,
1546 	.unlock_irq = ezusb_unlock_irq,
1547 };
1548 
1549 static const struct net_device_ops ezusb_netdev_ops = {
1550 	.ndo_open		= orinoco_open,
1551 	.ndo_stop		= orinoco_stop,
1552 	.ndo_start_xmit		= ezusb_xmit,
1553 	.ndo_set_rx_mode	= orinoco_set_multicast_list,
1554 	.ndo_change_mtu		= orinoco_change_mtu,
1555 	.ndo_set_mac_address	= eth_mac_addr,
1556 	.ndo_validate_addr	= eth_validate_addr,
1557 	.ndo_tx_timeout		= orinoco_tx_timeout,
1558 };
1559 
1560 static int ezusb_probe(struct usb_interface *interface,
1561 		       const struct usb_device_id *id)
1562 {
1563 	struct usb_device *udev = interface_to_usbdev(interface);
1564 	struct orinoco_private *priv;
1565 	struct hermes *hw;
1566 	struct ezusb_priv *upriv = NULL;
1567 	struct usb_interface_descriptor *iface_desc;
1568 	struct usb_endpoint_descriptor *ep;
1569 	const struct firmware *fw_entry = NULL;
1570 	int retval = 0;
1571 	int i;
1572 
1573 	priv = alloc_orinocodev(sizeof(*upriv), &udev->dev,
1574 				ezusb_hard_reset, NULL);
1575 	if (!priv) {
1576 		err("Couldn't allocate orinocodev");
1577 		retval = -ENOMEM;
1578 		goto exit;
1579 	}
1580 
1581 	hw = &priv->hw;
1582 
1583 	upriv = priv->card;
1584 
1585 	mutex_init(&upriv->mtx);
1586 	spin_lock_init(&upriv->reply_count_lock);
1587 
1588 	spin_lock_init(&upriv->req_lock);
1589 	INIT_LIST_HEAD(&upriv->req_pending);
1590 	INIT_LIST_HEAD(&upriv->req_active);
1591 
1592 	upriv->udev = udev;
1593 
1594 	hw->iobase = (void __force __iomem *) &upriv->hermes_reg_fake;
1595 	hw->reg_spacing = HERMES_16BIT_REGSPACING;
1596 	hw->priv = upriv;
1597 	hw->ops = &ezusb_ops;
1598 
1599 	/* set up the endpoint information */
1600 	/* check out the endpoints */
1601 
1602 	iface_desc = &interface->altsetting[0].desc;
1603 	for (i = 0; i < iface_desc->bNumEndpoints; ++i) {
1604 		ep = &interface->altsetting[0].endpoint[i].desc;
1605 
1606 		if (usb_endpoint_is_bulk_in(ep)) {
1607 			/* we found a bulk in endpoint */
1608 			if (upriv->read_urb != NULL) {
1609 				pr_warn("Found a second bulk in ep, ignored\n");
1610 				continue;
1611 			}
1612 
1613 			upriv->read_urb = usb_alloc_urb(0, GFP_KERNEL);
1614 			if (!upriv->read_urb)
1615 				goto error;
1616 			if (le16_to_cpu(ep->wMaxPacketSize) != 64)
1617 				pr_warn("bulk in: wMaxPacketSize!= 64\n");
1618 			if (ep->bEndpointAddress != (2 | USB_DIR_IN))
1619 				pr_warn("bulk in: bEndpointAddress: %d\n",
1620 					ep->bEndpointAddress);
1621 			upriv->read_pipe = usb_rcvbulkpipe(udev,
1622 							 ep->
1623 							 bEndpointAddress);
1624 			upriv->read_urb->transfer_buffer =
1625 			    kmalloc(BULK_BUF_SIZE, GFP_KERNEL);
1626 			if (!upriv->read_urb->transfer_buffer) {
1627 				err("Couldn't allocate IN buffer");
1628 				goto error;
1629 			}
1630 		}
1631 
1632 		if (usb_endpoint_is_bulk_out(ep)) {
1633 			/* we found a bulk out endpoint */
1634 			if (upriv->bap_buf != NULL) {
1635 				pr_warn("Found a second bulk out ep, ignored\n");
1636 				continue;
1637 			}
1638 
1639 			if (le16_to_cpu(ep->wMaxPacketSize) != 64)
1640 				pr_warn("bulk out: wMaxPacketSize != 64\n");
1641 			if (ep->bEndpointAddress != 2)
1642 				pr_warn("bulk out: bEndpointAddress: %d\n",
1643 					ep->bEndpointAddress);
1644 			upriv->write_pipe = usb_sndbulkpipe(udev,
1645 							  ep->
1646 							  bEndpointAddress);
1647 			upriv->bap_buf = kmalloc(BULK_BUF_SIZE, GFP_KERNEL);
1648 			if (!upriv->bap_buf) {
1649 				err("Couldn't allocate bulk_out_buffer");
1650 				goto error;
1651 			}
1652 		}
1653 	}
1654 	if (!upriv->bap_buf || !upriv->read_urb) {
1655 		err("Didn't find the required bulk endpoints");
1656 		goto error;
1657 	}
1658 
1659 	if (request_firmware(&fw_entry, "orinoco_ezusb_fw",
1660 			     &interface->dev) == 0) {
1661 		firmware.size = fw_entry->size;
1662 		firmware.code = fw_entry->data;
1663 	}
1664 	if (firmware.size && firmware.code) {
1665 		if (ezusb_firmware_download(upriv, &firmware) < 0)
1666 			goto error;
1667 	} else {
1668 		err("No firmware to download");
1669 		goto error;
1670 	}
1671 
1672 	if (ezusb_hard_reset(priv) < 0) {
1673 		err("Cannot reset the device");
1674 		goto error;
1675 	}
1676 
1677 	/* If the firmware is already downloaded orinoco.c will call
1678 	 * ezusb_init but if the firmware is not already there, that will make
1679 	 * the kernel very unstable, so we try initializing here and quit in
1680 	 * case of error */
1681 	if (ezusb_init(hw) < 0) {
1682 		err("Couldn't initialize the device");
1683 		err("Firmware may not be downloaded or may be wrong.");
1684 		goto error;
1685 	}
1686 
1687 	/* Initialise the main driver */
1688 	if (orinoco_init(priv) != 0) {
1689 		err("orinoco_init() failed\n");
1690 		goto error;
1691 	}
1692 
1693 	if (orinoco_if_add(priv, 0, 0, &ezusb_netdev_ops) != 0) {
1694 		upriv->dev = NULL;
1695 		err("%s: orinoco_if_add() failed", __func__);
1696 		wiphy_unregister(priv_to_wiphy(priv));
1697 		goto error;
1698 	}
1699 	upriv->dev = priv->ndev;
1700 
1701 	goto exit;
1702 
1703  error:
1704 	ezusb_delete(upriv);
1705 	if (upriv->dev) {
1706 		/* upriv->dev was 0, so ezusb_delete() didn't free it */
1707 		free_orinocodev(priv);
1708 	}
1709 	upriv = NULL;
1710 	retval = -EFAULT;
1711  exit:
1712 	if (fw_entry) {
1713 		firmware.code = NULL;
1714 		firmware.size = 0;
1715 		release_firmware(fw_entry);
1716 	}
1717 	usb_set_intfdata(interface, upriv);
1718 	return retval;
1719 }
1720 
1721 
1722 static void ezusb_disconnect(struct usb_interface *intf)
1723 {
1724 	struct ezusb_priv *upriv = usb_get_intfdata(intf);
1725 	usb_set_intfdata(intf, NULL);
1726 	ezusb_delete(upriv);
1727 	printk(KERN_INFO PFX "Disconnected\n");
1728 }
1729 
1730 
1731 /* usb specific object needed to register this driver with the usb subsystem */
1732 static struct usb_driver orinoco_driver = {
1733 	.name = DRIVER_NAME,
1734 	.probe = ezusb_probe,
1735 	.disconnect = ezusb_disconnect,
1736 	.id_table = ezusb_table,
1737 	.disable_hub_initiated_lpm = 1,
1738 };
1739 
1740 module_usb_driver(orinoco_driver);
1741 
1742 MODULE_AUTHOR("Manuel Estrada Sainz");
1743 MODULE_DESCRIPTION("Driver for Orinoco wireless LAN cards using EZUSB bridge");
1744 MODULE_LICENSE("Dual MPL/GPL");
1745