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