xref: /openbmc/linux/drivers/usb/atm/ueagle-atm.c (revision 565d76cb)
1 /*-
2  * Copyright (c) 2003, 2004
3  *	Damien Bergamini <damien.bergamini@free.fr>. All rights reserved.
4  *
5  * Copyright (c) 2005-2007 Matthieu Castet <castet.matthieu@free.fr>
6  * Copyright (c) 2005-2007 Stanislaw Gruszka <stf_xl@wp.pl>
7  *
8  * This software is available to you under a choice of one of two
9  * licenses. You may choose to be licensed under the terms of the GNU
10  * General Public License (GPL) Version 2, available from the file
11  * COPYING in the main directory of this source tree, or the
12  * BSD license below:
13  *
14  * Redistribution and use in source and binary forms, with or without
15  * modification, are permitted provided that the following conditions
16  * are met:
17  * 1. Redistributions of source code must retain the above copyright
18  *    notice unmodified, this list of conditions, and the following
19  *    disclaimer.
20  * 2. Redistributions in binary form must reproduce the above copyright
21  *    notice, this list of conditions and the following disclaimer in the
22  *    documentation and/or other materials provided with the distribution.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  * GPL license :
37  * This program is free software; you can redistribute it and/or
38  * modify it under the terms of the GNU General Public License
39  * as published by the Free Software Foundation; either version 2
40  * of the License, or (at your option) any later version.
41  *
42  * This program is distributed in the hope that it will be useful,
43  * but WITHOUT ANY WARRANTY; without even the implied warranty of
44  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
45  * GNU General Public License for more details.
46  *
47  * You should have received a copy of the GNU General Public License
48  * along with this program; if not, write to the Free Software
49  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
50  *
51  *
52  * HISTORY : some part of the code was base on ueagle 1.3 BSD driver,
53  * Damien Bergamini agree to put his code under a DUAL GPL/BSD license.
54  *
55  * The rest of the code was was rewritten from scratch.
56  */
57 
58 #include <linux/module.h>
59 #include <linux/moduleparam.h>
60 #include <linux/init.h>
61 #include <linux/crc32.h>
62 #include <linux/usb.h>
63 #include <linux/firmware.h>
64 #include <linux/ctype.h>
65 #include <linux/sched.h>
66 #include <linux/kthread.h>
67 #include <linux/mutex.h>
68 #include <linux/freezer.h>
69 #include <linux/slab.h>
70 #include <linux/kernel.h>
71 
72 #include <asm/unaligned.h>
73 
74 #include "usbatm.h"
75 
76 #define EAGLEUSBVERSION "ueagle 1.4"
77 
78 
79 /*
80  * Debug macros
81  */
82 #define uea_dbg(usb_dev, format, args...)	\
83 	do { \
84 		if (debug >= 1) \
85 			dev_dbg(&(usb_dev)->dev, \
86 				"[ueagle-atm dbg] %s: " format, \
87 					__func__, ##args); \
88 	} while (0)
89 
90 #define uea_vdbg(usb_dev, format, args...)	\
91 	do { \
92 		if (debug >= 2) \
93 			dev_dbg(&(usb_dev)->dev, \
94 				"[ueagle-atm vdbg]  " format, ##args); \
95 	} while (0)
96 
97 #define uea_enters(usb_dev) \
98 	uea_vdbg(usb_dev, "entering %s\n" , __func__)
99 
100 #define uea_leaves(usb_dev) \
101 	uea_vdbg(usb_dev, "leaving  %s\n" , __func__)
102 
103 #define uea_err(usb_dev, format, args...) \
104 	dev_err(&(usb_dev)->dev , "[UEAGLE-ATM] " format , ##args)
105 
106 #define uea_warn(usb_dev, format, args...) \
107 	dev_warn(&(usb_dev)->dev , "[Ueagle-atm] " format, ##args)
108 
109 #define uea_info(usb_dev, format, args...) \
110 	dev_info(&(usb_dev)->dev , "[ueagle-atm] " format, ##args)
111 
112 struct intr_pkt;
113 
114 /* cmv's from firmware */
115 struct uea_cmvs_v1 {
116 	u32 address;
117 	u16 offset;
118 	u32 data;
119 } __attribute__ ((packed));
120 
121 struct uea_cmvs_v2 {
122 	u32 group;
123 	u32 address;
124 	u32 offset;
125 	u32 data;
126 } __attribute__ ((packed));
127 
128 /* information about currently processed cmv */
129 struct cmv_dsc_e1 {
130 	u8 function;
131 	u16 idx;
132 	u32 address;
133 	u16 offset;
134 };
135 
136 struct cmv_dsc_e4 {
137 	u16 function;
138 	u16 offset;
139 	u16 address;
140 	u16 group;
141 };
142 
143 union cmv_dsc {
144 	struct cmv_dsc_e1 e1;
145 	struct cmv_dsc_e4 e4;
146 };
147 
148 struct uea_softc {
149 	struct usb_device *usb_dev;
150 	struct usbatm_data *usbatm;
151 
152 	int modem_index;
153 	unsigned int driver_info;
154 	int annex;
155 #define ANNEXA 0
156 #define ANNEXB 1
157 
158 	int booting;
159 	int reset;
160 
161 	wait_queue_head_t sync_q;
162 
163 	struct task_struct *kthread;
164 	u32 data;
165 	u32 data1;
166 
167 	int cmv_ack;
168 	union cmv_dsc cmv_dsc;
169 
170 	struct work_struct task;
171 	u16 pageno;
172 	u16 ovl;
173 
174 	const struct firmware *dsp_firm;
175 	struct urb *urb_int;
176 
177 	void (*dispatch_cmv) (struct uea_softc *, struct intr_pkt *);
178 	void (*schedule_load_page) (struct uea_softc *, struct intr_pkt *);
179 	int (*stat) (struct uea_softc *);
180 	int (*send_cmvs) (struct uea_softc *);
181 
182 	/* keep in sync with eaglectl */
183 	struct uea_stats {
184 		struct {
185 			u32 state;
186 			u32 flags;
187 			u32 mflags;
188 			u32 vidcpe;
189 			u32 vidco;
190 			u32 dsrate;
191 			u32 usrate;
192 			u32 dsunc;
193 			u32 usunc;
194 			u32 dscorr;
195 			u32 uscorr;
196 			u32 txflow;
197 			u32 rxflow;
198 			u32 usattenuation;
199 			u32 dsattenuation;
200 			u32 dsmargin;
201 			u32 usmargin;
202 			u32 firmid;
203 		} phy;
204 	} stats;
205 };
206 
207 /*
208  * Elsa IDs
209  */
210 #define ELSA_VID		0x05CC
211 #define ELSA_PID_PSTFIRM	0x3350
212 #define ELSA_PID_PREFIRM	0x3351
213 
214 #define ELSA_PID_A_PREFIRM	0x3352
215 #define ELSA_PID_A_PSTFIRM	0x3353
216 #define ELSA_PID_B_PREFIRM	0x3362
217 #define ELSA_PID_B_PSTFIRM	0x3363
218 
219 /*
220  * Devolo IDs : pots if (pid & 0x10)
221  */
222 #define DEVOLO_VID			0x1039
223 #define DEVOLO_EAGLE_I_A_PID_PSTFIRM	0x2110
224 #define DEVOLO_EAGLE_I_A_PID_PREFIRM	0x2111
225 
226 #define DEVOLO_EAGLE_I_B_PID_PSTFIRM	0x2100
227 #define DEVOLO_EAGLE_I_B_PID_PREFIRM	0x2101
228 
229 #define DEVOLO_EAGLE_II_A_PID_PSTFIRM	0x2130
230 #define DEVOLO_EAGLE_II_A_PID_PREFIRM	0x2131
231 
232 #define DEVOLO_EAGLE_II_B_PID_PSTFIRM	0x2120
233 #define DEVOLO_EAGLE_II_B_PID_PREFIRM	0x2121
234 
235 /*
236  * Reference design USB IDs
237  */
238 #define ANALOG_VID		0x1110
239 #define ADI930_PID_PREFIRM	0x9001
240 #define ADI930_PID_PSTFIRM	0x9000
241 
242 #define EAGLE_I_PID_PREFIRM	0x9010	/* Eagle I */
243 #define EAGLE_I_PID_PSTFIRM	0x900F	/* Eagle I */
244 
245 #define EAGLE_IIC_PID_PREFIRM	0x9024	/* Eagle IIC */
246 #define EAGLE_IIC_PID_PSTFIRM	0x9023	/* Eagle IIC */
247 
248 #define EAGLE_II_PID_PREFIRM	0x9022	/* Eagle II */
249 #define EAGLE_II_PID_PSTFIRM	0x9021	/* Eagle II */
250 
251 #define EAGLE_III_PID_PREFIRM	0x9032	/* Eagle III */
252 #define EAGLE_III_PID_PSTFIRM	0x9031	/* Eagle III */
253 
254 #define EAGLE_IV_PID_PREFIRM	0x9042  /* Eagle IV */
255 #define EAGLE_IV_PID_PSTFIRM	0x9041  /* Eagle IV */
256 
257 /*
258  * USR USB IDs
259  */
260 #define USR_VID			0x0BAF
261 #define MILLER_A_PID_PREFIRM	0x00F2
262 #define MILLER_A_PID_PSTFIRM	0x00F1
263 #define MILLER_B_PID_PREFIRM	0x00FA
264 #define MILLER_B_PID_PSTFIRM	0x00F9
265 #define HEINEKEN_A_PID_PREFIRM	0x00F6
266 #define HEINEKEN_A_PID_PSTFIRM	0x00F5
267 #define HEINEKEN_B_PID_PREFIRM	0x00F8
268 #define HEINEKEN_B_PID_PSTFIRM	0x00F7
269 
270 #define PREFIRM 0
271 #define PSTFIRM (1<<7)
272 #define AUTO_ANNEX_A (1<<8)
273 #define AUTO_ANNEX_B (1<<9)
274 
275 enum {
276 	ADI930 = 0,
277 	EAGLE_I,
278 	EAGLE_II,
279 	EAGLE_III,
280 	EAGLE_IV
281 };
282 
283 /* macros for both struct usb_device_id and struct uea_softc */
284 #define UEA_IS_PREFIRM(x) \
285 	(!((x)->driver_info & PSTFIRM))
286 #define UEA_CHIP_VERSION(x) \
287 	((x)->driver_info & 0xf)
288 
289 #define IS_ISDN(x) \
290 	((x)->annex & ANNEXB)
291 
292 #define INS_TO_USBDEV(ins) (ins->usb_dev)
293 
294 #define GET_STATUS(data) \
295 	((data >> 8) & 0xf)
296 
297 #define IS_OPERATIONAL(sc) \
298 	((UEA_CHIP_VERSION(sc) != EAGLE_IV) ? \
299 	(GET_STATUS(sc->stats.phy.state) == 2) : \
300 	(sc->stats.phy.state == 7))
301 
302 /*
303  * Set of macros to handle unaligned data in the firmware blob.
304  * The FW_GET_BYTE() macro is provided only for consistency.
305  */
306 
307 #define FW_GET_BYTE(p) (*((__u8 *) (p)))
308 
309 #define FW_DIR "ueagle-atm/"
310 #define UEA_FW_NAME_MAX 30
311 #define NB_MODEM 4
312 
313 #define BULK_TIMEOUT 300
314 #define CTRL_TIMEOUT 1000
315 
316 #define ACK_TIMEOUT msecs_to_jiffies(3000)
317 
318 #define UEA_INTR_IFACE_NO	0
319 #define UEA_US_IFACE_NO		1
320 #define UEA_DS_IFACE_NO		2
321 
322 #define FASTEST_ISO_INTF	8
323 
324 #define UEA_BULK_DATA_PIPE	0x02
325 #define UEA_IDMA_PIPE		0x04
326 #define UEA_INTR_PIPE		0x04
327 #define UEA_ISO_DATA_PIPE	0x08
328 
329 #define UEA_E1_SET_BLOCK	0x0001
330 #define UEA_E4_SET_BLOCK	0x002c
331 #define UEA_SET_MODE		0x0003
332 #define UEA_SET_2183_DATA	0x0004
333 #define UEA_SET_TIMEOUT		0x0011
334 
335 #define UEA_LOOPBACK_OFF	0x0002
336 #define UEA_LOOPBACK_ON		0x0003
337 #define UEA_BOOT_IDMA		0x0006
338 #define UEA_START_RESET		0x0007
339 #define UEA_END_RESET		0x0008
340 
341 #define UEA_SWAP_MAILBOX	(0x3fcd | 0x4000)
342 #define UEA_MPTX_START		(0x3fce | 0x4000)
343 #define UEA_MPTX_MAILBOX	(0x3fd6 | 0x4000)
344 #define UEA_MPRX_MAILBOX	(0x3fdf | 0x4000)
345 
346 /* block information in eagle4 dsp firmware  */
347 struct block_index {
348 	__le32 PageOffset;
349 	__le32 NotLastBlock;
350 	__le32 dummy;
351 	__le32 PageSize;
352 	__le32 PageAddress;
353 	__le16 dummy1;
354 	__le16 PageNumber;
355 } __attribute__ ((packed));
356 
357 #define E4_IS_BOOT_PAGE(PageSize) ((le32_to_cpu(PageSize)) & 0x80000000)
358 #define E4_PAGE_BYTES(PageSize) ((le32_to_cpu(PageSize) & 0x7fffffff) * 4)
359 
360 #define E4_L1_STRING_HEADER 0x10
361 #define E4_MAX_PAGE_NUMBER 0x58
362 #define E4_NO_SWAPPAGE_HEADERS 0x31
363 
364 /* l1_code is eagle4 dsp firmware format */
365 struct l1_code {
366 	u8 string_header[E4_L1_STRING_HEADER];
367 	u8 page_number_to_block_index[E4_MAX_PAGE_NUMBER];
368 	struct block_index page_header[E4_NO_SWAPPAGE_HEADERS];
369 	u8 code[0];
370 } __attribute__ ((packed));
371 
372 /* structures describing a block within a DSP page */
373 struct block_info_e1 {
374 	__le16 wHdr;
375 	__le16 wAddress;
376 	__le16 wSize;
377 	__le16 wOvlOffset;
378 	__le16 wOvl;		/* overlay */
379 	__le16 wLast;
380 } __attribute__ ((packed));
381 #define E1_BLOCK_INFO_SIZE 12
382 
383 struct block_info_e4 {
384 	__be16 wHdr;
385 	__u8 bBootPage;
386 	__u8 bPageNumber;
387 	__be32 dwSize;
388 	__be32 dwAddress;
389 	__be16 wReserved;
390 } __attribute__ ((packed));
391 #define E4_BLOCK_INFO_SIZE 14
392 
393 #define UEA_BIHDR 0xabcd
394 #define UEA_RESERVED 0xffff
395 
396 /* constants describing cmv type */
397 #define E1_PREAMBLE 0x535c
398 #define E1_MODEMTOHOST 0x01
399 #define E1_HOSTTOMODEM 0x10
400 
401 #define E1_MEMACCESS 0x1
402 #define E1_ADSLDIRECTIVE 0x7
403 #define E1_FUNCTION_TYPE(f) ((f) >> 4)
404 #define E1_FUNCTION_SUBTYPE(f) ((f) & 0x0f)
405 
406 #define E4_MEMACCESS 0
407 #define E4_ADSLDIRECTIVE 0xf
408 #define E4_FUNCTION_TYPE(f) ((f) >> 8)
409 #define E4_FUNCTION_SIZE(f) ((f) & 0x0f)
410 #define E4_FUNCTION_SUBTYPE(f) (((f) >> 4) & 0x0f)
411 
412 /* for MEMACCESS */
413 #define E1_REQUESTREAD	0x0
414 #define E1_REQUESTWRITE	0x1
415 #define E1_REPLYREAD	0x2
416 #define E1_REPLYWRITE	0x3
417 
418 #define E4_REQUESTREAD	0x0
419 #define E4_REQUESTWRITE	0x4
420 #define E4_REPLYREAD	(E4_REQUESTREAD | 1)
421 #define E4_REPLYWRITE	(E4_REQUESTWRITE | 1)
422 
423 /* for ADSLDIRECTIVE */
424 #define E1_KERNELREADY 0x0
425 #define E1_MODEMREADY  0x1
426 
427 #define E4_KERNELREADY 0x0
428 #define E4_MODEMREADY  0x1
429 
430 #define E1_MAKEFUNCTION(t, s) (((t) & 0xf) << 4 | ((s) & 0xf))
431 #define E4_MAKEFUNCTION(t, st, s) (((t) & 0xf) << 8 | \
432 	((st) & 0xf) << 4 | ((s) & 0xf))
433 
434 #define E1_MAKESA(a, b, c, d)						\
435 	(((c) & 0xff) << 24 |						\
436 	 ((d) & 0xff) << 16 |						\
437 	 ((a) & 0xff) << 8  |						\
438 	 ((b) & 0xff))
439 
440 #define E1_GETSA1(a) ((a >> 8) & 0xff)
441 #define E1_GETSA2(a) (a & 0xff)
442 #define E1_GETSA3(a) ((a >> 24) & 0xff)
443 #define E1_GETSA4(a) ((a >> 16) & 0xff)
444 
445 #define E1_SA_CNTL E1_MAKESA('C', 'N', 'T', 'L')
446 #define E1_SA_DIAG E1_MAKESA('D', 'I', 'A', 'G')
447 #define E1_SA_INFO E1_MAKESA('I', 'N', 'F', 'O')
448 #define E1_SA_OPTN E1_MAKESA('O', 'P', 'T', 'N')
449 #define E1_SA_RATE E1_MAKESA('R', 'A', 'T', 'E')
450 #define E1_SA_STAT E1_MAKESA('S', 'T', 'A', 'T')
451 
452 #define E4_SA_CNTL 1
453 #define E4_SA_STAT 2
454 #define E4_SA_INFO 3
455 #define E4_SA_TEST 4
456 #define E4_SA_OPTN 5
457 #define E4_SA_RATE 6
458 #define E4_SA_DIAG 7
459 #define E4_SA_CNFG 8
460 
461 /* structures representing a CMV (Configuration and Management Variable) */
462 struct cmv_e1 {
463 	__le16 wPreamble;
464 	__u8 bDirection;
465 	__u8 bFunction;
466 	__le16 wIndex;
467 	__le32 dwSymbolicAddress;
468 	__le16 wOffsetAddress;
469 	__le32 dwData;
470 } __attribute__ ((packed));
471 
472 struct cmv_e4 {
473 	__be16 wGroup;
474 	__be16 wFunction;
475 	__be16 wOffset;
476 	__be16 wAddress;
477 	__be32 dwData[6];
478 } __attribute__ ((packed));
479 
480 /* structures representing swap information */
481 struct swap_info_e1 {
482 	__u8 bSwapPageNo;
483 	__u8 bOvl;		/* overlay */
484 } __attribute__ ((packed));
485 
486 struct swap_info_e4 {
487 	__u8 bSwapPageNo;
488 } __attribute__ ((packed));
489 
490 /* structures representing interrupt data */
491 #define e1_bSwapPageNo	u.e1.s1.swapinfo.bSwapPageNo
492 #define e1_bOvl		u.e1.s1.swapinfo.bOvl
493 #define e4_bSwapPageNo  u.e4.s1.swapinfo.bSwapPageNo
494 
495 #define INT_LOADSWAPPAGE 0x0001
496 #define INT_INCOMINGCMV  0x0002
497 
498 union intr_data_e1 {
499 	struct {
500 		struct swap_info_e1 swapinfo;
501 		__le16 wDataSize;
502 	} __attribute__ ((packed)) s1;
503 	struct {
504 		struct cmv_e1 cmv;
505 		__le16 wDataSize;
506 	} __attribute__ ((packed)) s2;
507 } __attribute__ ((packed));
508 
509 union intr_data_e4 {
510 	struct {
511 		struct swap_info_e4 swapinfo;
512 		__le16 wDataSize;
513 	} __attribute__ ((packed)) s1;
514 	struct {
515 		struct cmv_e4 cmv;
516 		__le16 wDataSize;
517 	} __attribute__ ((packed)) s2;
518 } __attribute__ ((packed));
519 
520 struct intr_pkt {
521 	__u8 bType;
522 	__u8 bNotification;
523 	__le16 wValue;
524 	__le16 wIndex;
525 	__le16 wLength;
526 	__le16 wInterrupt;
527 	union {
528 		union intr_data_e1 e1;
529 		union intr_data_e4 e4;
530 	} u;
531 } __attribute__ ((packed));
532 
533 #define E1_INTR_PKT_SIZE 28
534 #define E4_INTR_PKT_SIZE 64
535 
536 static struct usb_driver uea_driver;
537 static DEFINE_MUTEX(uea_mutex);
538 static const char *chip_name[] = {"ADI930", "Eagle I", "Eagle II", "Eagle III",
539 								"Eagle IV"};
540 
541 static int modem_index;
542 static unsigned int debug;
543 static unsigned int altsetting[NB_MODEM] = {
544 				[0 ... (NB_MODEM - 1)] = FASTEST_ISO_INTF};
545 static int sync_wait[NB_MODEM];
546 static char *cmv_file[NB_MODEM];
547 static int annex[NB_MODEM];
548 
549 module_param(debug, uint, 0644);
550 MODULE_PARM_DESC(debug, "module debug level (0=off,1=on,2=verbose)");
551 module_param_array(altsetting, uint, NULL, 0644);
552 MODULE_PARM_DESC(altsetting, "alternate setting for incoming traffic: 0=bulk, "
553 			     "1=isoc slowest, ... , 8=isoc fastest (default)");
554 module_param_array(sync_wait, bool, NULL, 0644);
555 MODULE_PARM_DESC(sync_wait, "wait the synchronisation before starting ATM");
556 module_param_array(cmv_file, charp, NULL, 0644);
557 MODULE_PARM_DESC(cmv_file,
558 		"file name with configuration and management variables");
559 module_param_array(annex, uint, NULL, 0644);
560 MODULE_PARM_DESC(annex,
561 		"manually set annex a/b (0=auto, 1=annex a, 2=annex b)");
562 
563 #define uea_wait(sc, cond, timeo) \
564 ({ \
565 	int _r = wait_event_interruptible_timeout(sc->sync_q, \
566 			(cond) || kthread_should_stop(), timeo); \
567 	if (kthread_should_stop()) \
568 		_r = -ENODEV; \
569 	_r; \
570 })
571 
572 #define UPDATE_ATM_STAT(type, val) \
573 	do { \
574 		if (sc->usbatm->atm_dev) \
575 			sc->usbatm->atm_dev->type = val; \
576 	} while (0)
577 
578 #define UPDATE_ATM_SIGNAL(val) \
579 	do { \
580 		if (sc->usbatm->atm_dev) \
581 			atm_dev_signal_change(sc->usbatm->atm_dev, val); \
582 	} while (0)
583 
584 
585 /* Firmware loading */
586 #define LOAD_INTERNAL     0xA0
587 #define F8051_USBCS       0x7f92
588 
589 /**
590  * uea_send_modem_cmd - Send a command for pre-firmware devices.
591  */
592 static int uea_send_modem_cmd(struct usb_device *usb,
593 			      u16 addr, u16 size, const u8 *buff)
594 {
595 	int ret = -ENOMEM;
596 	u8 *xfer_buff;
597 
598 	xfer_buff = kmemdup(buff, size, GFP_KERNEL);
599 	if (xfer_buff) {
600 		ret = usb_control_msg(usb,
601 				      usb_sndctrlpipe(usb, 0),
602 				      LOAD_INTERNAL,
603 				      USB_DIR_OUT | USB_TYPE_VENDOR |
604 				      USB_RECIP_DEVICE, addr, 0, xfer_buff,
605 				      size, CTRL_TIMEOUT);
606 		kfree(xfer_buff);
607 	}
608 
609 	if (ret < 0)
610 		return ret;
611 
612 	return (ret == size) ? 0 : -EIO;
613 }
614 
615 static void uea_upload_pre_firmware(const struct firmware *fw_entry,
616 								void *context)
617 {
618 	struct usb_device *usb = context;
619 	const u8 *pfw;
620 	u8 value;
621 	u32 crc = 0;
622 	int ret, size;
623 
624 	uea_enters(usb);
625 	if (!fw_entry) {
626 		uea_err(usb, "firmware is not available\n");
627 		goto err;
628 	}
629 
630 	pfw = fw_entry->data;
631 	size = fw_entry->size;
632 	if (size < 4)
633 		goto err_fw_corrupted;
634 
635 	crc = get_unaligned_le32(pfw);
636 	pfw += 4;
637 	size -= 4;
638 	if (crc32_be(0, pfw, size) != crc)
639 		goto err_fw_corrupted;
640 
641 	/*
642 	 * Start to upload firmware : send reset
643 	 */
644 	value = 1;
645 	ret = uea_send_modem_cmd(usb, F8051_USBCS, sizeof(value), &value);
646 
647 	if (ret < 0) {
648 		uea_err(usb, "modem reset failed with error %d\n", ret);
649 		goto err;
650 	}
651 
652 	while (size > 3) {
653 		u8 len = FW_GET_BYTE(pfw);
654 		u16 add = get_unaligned_le16(pfw + 1);
655 
656 		size -= len + 3;
657 		if (size < 0)
658 			goto err_fw_corrupted;
659 
660 		ret = uea_send_modem_cmd(usb, add, len, pfw + 3);
661 		if (ret < 0) {
662 			uea_err(usb, "uploading firmware data failed "
663 					"with error %d\n", ret);
664 			goto err;
665 		}
666 		pfw += len + 3;
667 	}
668 
669 	if (size != 0)
670 		goto err_fw_corrupted;
671 
672 	/*
673 	 * Tell the modem we finish : de-assert reset
674 	 */
675 	value = 0;
676 	ret = uea_send_modem_cmd(usb, F8051_USBCS, 1, &value);
677 	if (ret < 0)
678 		uea_err(usb, "modem de-assert failed with error %d\n", ret);
679 	else
680 		uea_info(usb, "firmware uploaded\n");
681 
682 	goto err;
683 
684 err_fw_corrupted:
685 	uea_err(usb, "firmware is corrupted\n");
686 err:
687 	release_firmware(fw_entry);
688 	uea_leaves(usb);
689 }
690 
691 /**
692  * uea_load_firmware - Load usb firmware for pre-firmware devices.
693  */
694 static int uea_load_firmware(struct usb_device *usb, unsigned int ver)
695 {
696 	int ret;
697 	char *fw_name = FW_DIR "eagle.fw";
698 
699 	uea_enters(usb);
700 	uea_info(usb, "pre-firmware device, uploading firmware\n");
701 
702 	switch (ver) {
703 	case ADI930:
704 		fw_name = FW_DIR "adi930.fw";
705 		break;
706 	case EAGLE_I:
707 		fw_name = FW_DIR "eagleI.fw";
708 		break;
709 	case EAGLE_II:
710 		fw_name = FW_DIR "eagleII.fw";
711 		break;
712 	case EAGLE_III:
713 		fw_name = FW_DIR "eagleIII.fw";
714 		break;
715 	case EAGLE_IV:
716 		fw_name = FW_DIR "eagleIV.fw";
717 		break;
718 	}
719 
720 	ret = request_firmware_nowait(THIS_MODULE, 1, fw_name, &usb->dev,
721 					GFP_KERNEL, usb,
722 					uea_upload_pre_firmware);
723 	if (ret)
724 		uea_err(usb, "firmware %s is not available\n", fw_name);
725 	else
726 		uea_info(usb, "loading firmware %s\n", fw_name);
727 
728 	uea_leaves(usb);
729 	return ret;
730 }
731 
732 /* modem management : dsp firmware, send/read CMV, monitoring statistic
733  */
734 
735 /*
736  * Make sure that the DSP code provided is safe to use.
737  */
738 static int check_dsp_e1(const u8 *dsp, unsigned int len)
739 {
740 	u8 pagecount, blockcount;
741 	u16 blocksize;
742 	u32 pageoffset;
743 	unsigned int i, j, p, pp;
744 
745 	pagecount = FW_GET_BYTE(dsp);
746 	p = 1;
747 
748 	/* enough space for page offsets? */
749 	if (p + 4 * pagecount > len)
750 		return 1;
751 
752 	for (i = 0; i < pagecount; i++) {
753 
754 		pageoffset = get_unaligned_le32(dsp + p);
755 		p += 4;
756 
757 		if (pageoffset == 0)
758 			continue;
759 
760 		/* enough space for blockcount? */
761 		if (pageoffset >= len)
762 			return 1;
763 
764 		pp = pageoffset;
765 		blockcount = FW_GET_BYTE(dsp + pp);
766 		pp += 1;
767 
768 		for (j = 0; j < blockcount; j++) {
769 
770 			/* enough space for block header? */
771 			if (pp + 4 > len)
772 				return 1;
773 
774 			pp += 2;	/* skip blockaddr */
775 			blocksize = get_unaligned_le16(dsp + pp);
776 			pp += 2;
777 
778 			/* enough space for block data? */
779 			if (pp + blocksize > len)
780 				return 1;
781 
782 			pp += blocksize;
783 		}
784 	}
785 
786 	return 0;
787 }
788 
789 static int check_dsp_e4(const u8 *dsp, int len)
790 {
791 	int i;
792 	struct l1_code *p = (struct l1_code *) dsp;
793 	unsigned int sum = p->code - dsp;
794 
795 	if (len < sum)
796 		return 1;
797 
798 	if (strcmp("STRATIPHY ANEXA", p->string_header) != 0 &&
799 	    strcmp("STRATIPHY ANEXB", p->string_header) != 0)
800 		return 1;
801 
802 	for (i = 0; i < E4_MAX_PAGE_NUMBER; i++) {
803 		struct block_index *blockidx;
804 		u8 blockno = p->page_number_to_block_index[i];
805 		if (blockno >= E4_NO_SWAPPAGE_HEADERS)
806 			continue;
807 
808 		do {
809 			u64 l;
810 
811 			if (blockno >= E4_NO_SWAPPAGE_HEADERS)
812 				return 1;
813 
814 			blockidx = &p->page_header[blockno++];
815 			if ((u8 *)(blockidx + 1) - dsp  >= len)
816 				return 1;
817 
818 			if (le16_to_cpu(blockidx->PageNumber) != i)
819 				return 1;
820 
821 			l = E4_PAGE_BYTES(blockidx->PageSize);
822 			sum += l;
823 			l += le32_to_cpu(blockidx->PageOffset);
824 			if (l > len)
825 				return 1;
826 
827 		/* zero is zero regardless endianes */
828 		} while (blockidx->NotLastBlock);
829 	}
830 
831 	return (sum == len) ? 0 : 1;
832 }
833 
834 /*
835  * send data to the idma pipe
836  * */
837 static int uea_idma_write(struct uea_softc *sc, const void *data, u32 size)
838 {
839 	int ret = -ENOMEM;
840 	u8 *xfer_buff;
841 	int bytes_read;
842 
843 	xfer_buff = kmemdup(data, size, GFP_KERNEL);
844 	if (!xfer_buff) {
845 		uea_err(INS_TO_USBDEV(sc), "can't allocate xfer_buff\n");
846 		return ret;
847 	}
848 
849 	ret = usb_bulk_msg(sc->usb_dev,
850 			 usb_sndbulkpipe(sc->usb_dev, UEA_IDMA_PIPE),
851 			 xfer_buff, size, &bytes_read, BULK_TIMEOUT);
852 
853 	kfree(xfer_buff);
854 	if (ret < 0)
855 		return ret;
856 	if (size != bytes_read) {
857 		uea_err(INS_TO_USBDEV(sc), "size != bytes_read %d %d\n", size,
858 		       bytes_read);
859 		return -EIO;
860 	}
861 
862 	return 0;
863 }
864 
865 static int request_dsp(struct uea_softc *sc)
866 {
867 	int ret;
868 	char *dsp_name;
869 
870 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV) {
871 		if (IS_ISDN(sc))
872 			dsp_name = FW_DIR "DSP4i.bin";
873 		else
874 			dsp_name = FW_DIR "DSP4p.bin";
875 	} else if (UEA_CHIP_VERSION(sc) == ADI930) {
876 		if (IS_ISDN(sc))
877 			dsp_name = FW_DIR "DSP9i.bin";
878 		else
879 			dsp_name = FW_DIR "DSP9p.bin";
880 	} else {
881 		if (IS_ISDN(sc))
882 			dsp_name = FW_DIR "DSPei.bin";
883 		else
884 			dsp_name = FW_DIR "DSPep.bin";
885 	}
886 
887 	ret = request_firmware(&sc->dsp_firm, dsp_name, &sc->usb_dev->dev);
888 	if (ret < 0) {
889 		uea_err(INS_TO_USBDEV(sc),
890 		       "requesting firmware %s failed with error %d\n",
891 			dsp_name, ret);
892 		return ret;
893 	}
894 
895 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV)
896 		ret = check_dsp_e4(sc->dsp_firm->data, sc->dsp_firm->size);
897 	else
898 		ret = check_dsp_e1(sc->dsp_firm->data, sc->dsp_firm->size);
899 
900 	if (ret) {
901 		uea_err(INS_TO_USBDEV(sc), "firmware %s is corrupted\n",
902 		       dsp_name);
903 		release_firmware(sc->dsp_firm);
904 		sc->dsp_firm = NULL;
905 		return -EILSEQ;
906 	}
907 
908 	return 0;
909 }
910 
911 /*
912  * The uea_load_page() function must be called within a process context
913  */
914 static void uea_load_page_e1(struct work_struct *work)
915 {
916 	struct uea_softc *sc = container_of(work, struct uea_softc, task);
917 	u16 pageno = sc->pageno;
918 	u16 ovl = sc->ovl;
919 	struct block_info_e1 bi;
920 
921 	const u8 *p;
922 	u8 pagecount, blockcount;
923 	u16 blockaddr, blocksize;
924 	u32 pageoffset;
925 	int i;
926 
927 	/* reload firmware when reboot start and it's loaded already */
928 	if (ovl == 0 && pageno == 0 && sc->dsp_firm) {
929 		release_firmware(sc->dsp_firm);
930 		sc->dsp_firm = NULL;
931 	}
932 
933 	if (sc->dsp_firm == NULL && request_dsp(sc) < 0)
934 		return;
935 
936 	p = sc->dsp_firm->data;
937 	pagecount = FW_GET_BYTE(p);
938 	p += 1;
939 
940 	if (pageno >= pagecount)
941 		goto bad1;
942 
943 	p += 4 * pageno;
944 	pageoffset = get_unaligned_le32(p);
945 
946 	if (pageoffset == 0)
947 		goto bad1;
948 
949 	p = sc->dsp_firm->data + pageoffset;
950 	blockcount = FW_GET_BYTE(p);
951 	p += 1;
952 
953 	uea_dbg(INS_TO_USBDEV(sc),
954 	       "sending %u blocks for DSP page %u\n", blockcount, pageno);
955 
956 	bi.wHdr = cpu_to_le16(UEA_BIHDR);
957 	bi.wOvl = cpu_to_le16(ovl);
958 	bi.wOvlOffset = cpu_to_le16(ovl | 0x8000);
959 
960 	for (i = 0; i < blockcount; i++) {
961 		blockaddr = get_unaligned_le16(p);
962 		p += 2;
963 
964 		blocksize = get_unaligned_le16(p);
965 		p += 2;
966 
967 		bi.wSize = cpu_to_le16(blocksize);
968 		bi.wAddress = cpu_to_le16(blockaddr);
969 		bi.wLast = cpu_to_le16((i == blockcount - 1) ? 1 : 0);
970 
971 		/* send block info through the IDMA pipe */
972 		if (uea_idma_write(sc, &bi, E1_BLOCK_INFO_SIZE))
973 			goto bad2;
974 
975 		/* send block data through the IDMA pipe */
976 		if (uea_idma_write(sc, p, blocksize))
977 			goto bad2;
978 
979 		p += blocksize;
980 	}
981 
982 	return;
983 
984 bad2:
985 	uea_err(INS_TO_USBDEV(sc), "sending DSP block %u failed\n", i);
986 	return;
987 bad1:
988 	uea_err(INS_TO_USBDEV(sc), "invalid DSP page %u requested\n", pageno);
989 }
990 
991 static void __uea_load_page_e4(struct uea_softc *sc, u8 pageno, int boot)
992 {
993 	struct block_info_e4 bi;
994 	struct block_index *blockidx;
995 	struct l1_code *p = (struct l1_code *) sc->dsp_firm->data;
996 	u8 blockno = p->page_number_to_block_index[pageno];
997 
998 	bi.wHdr = cpu_to_be16(UEA_BIHDR);
999 	bi.bBootPage = boot;
1000 	bi.bPageNumber = pageno;
1001 	bi.wReserved = cpu_to_be16(UEA_RESERVED);
1002 
1003 	do {
1004 		const u8 *blockoffset;
1005 		unsigned int blocksize;
1006 
1007 		blockidx = &p->page_header[blockno];
1008 		blocksize = E4_PAGE_BYTES(blockidx->PageSize);
1009 		blockoffset = sc->dsp_firm->data + le32_to_cpu(
1010 							blockidx->PageOffset);
1011 
1012 		bi.dwSize = cpu_to_be32(blocksize);
1013 		bi.dwAddress = cpu_to_be32(le32_to_cpu(blockidx->PageAddress));
1014 
1015 		uea_dbg(INS_TO_USBDEV(sc),
1016 			"sending block %u for DSP page "
1017 			"%u size %u address %x\n",
1018 			blockno, pageno, blocksize,
1019 			le32_to_cpu(blockidx->PageAddress));
1020 
1021 		/* send block info through the IDMA pipe */
1022 		if (uea_idma_write(sc, &bi, E4_BLOCK_INFO_SIZE))
1023 			goto bad;
1024 
1025 		/* send block data through the IDMA pipe */
1026 		if (uea_idma_write(sc, blockoffset, blocksize))
1027 			goto bad;
1028 
1029 		blockno++;
1030 	} while (blockidx->NotLastBlock);
1031 
1032 	return;
1033 
1034 bad:
1035 	uea_err(INS_TO_USBDEV(sc), "sending DSP block %u failed\n", blockno);
1036 	return;
1037 }
1038 
1039 static void uea_load_page_e4(struct work_struct *work)
1040 {
1041 	struct uea_softc *sc = container_of(work, struct uea_softc, task);
1042 	u8 pageno = sc->pageno;
1043 	int i;
1044 	struct block_info_e4 bi;
1045 	struct l1_code *p;
1046 
1047 	uea_dbg(INS_TO_USBDEV(sc), "sending DSP page %u\n", pageno);
1048 
1049 	/* reload firmware when reboot start and it's loaded already */
1050 	if (pageno == 0 && sc->dsp_firm) {
1051 		release_firmware(sc->dsp_firm);
1052 		sc->dsp_firm = NULL;
1053 	}
1054 
1055 	if (sc->dsp_firm == NULL && request_dsp(sc) < 0)
1056 		return;
1057 
1058 	p = (struct l1_code *) sc->dsp_firm->data;
1059 	if (pageno >= le16_to_cpu(p->page_header[0].PageNumber)) {
1060 		uea_err(INS_TO_USBDEV(sc), "invalid DSP "
1061 						"page %u requested\n", pageno);
1062 		return;
1063 	}
1064 
1065 	if (pageno != 0) {
1066 		__uea_load_page_e4(sc, pageno, 0);
1067 		return;
1068 	}
1069 
1070 	uea_dbg(INS_TO_USBDEV(sc),
1071 	       "sending Main DSP page %u\n", p->page_header[0].PageNumber);
1072 
1073 	for (i = 0; i < le16_to_cpu(p->page_header[0].PageNumber); i++) {
1074 		if (E4_IS_BOOT_PAGE(p->page_header[i].PageSize))
1075 			__uea_load_page_e4(sc, i, 1);
1076 	}
1077 
1078 	uea_dbg(INS_TO_USBDEV(sc) , "sending start bi\n");
1079 
1080 	bi.wHdr = cpu_to_be16(UEA_BIHDR);
1081 	bi.bBootPage = 0;
1082 	bi.bPageNumber = 0xff;
1083 	bi.wReserved = cpu_to_be16(UEA_RESERVED);
1084 	bi.dwSize = cpu_to_be32(E4_PAGE_BYTES(p->page_header[0].PageSize));
1085 	bi.dwAddress = cpu_to_be32(le32_to_cpu(p->page_header[0].PageAddress));
1086 
1087 	/* send block info through the IDMA pipe */
1088 	if (uea_idma_write(sc, &bi, E4_BLOCK_INFO_SIZE))
1089 		uea_err(INS_TO_USBDEV(sc), "sending DSP start bi failed\n");
1090 }
1091 
1092 static inline void wake_up_cmv_ack(struct uea_softc *sc)
1093 {
1094 	BUG_ON(sc->cmv_ack);
1095 	sc->cmv_ack = 1;
1096 	wake_up(&sc->sync_q);
1097 }
1098 
1099 static inline int wait_cmv_ack(struct uea_softc *sc)
1100 {
1101 	int ret = uea_wait(sc, sc->cmv_ack , ACK_TIMEOUT);
1102 
1103 	sc->cmv_ack = 0;
1104 
1105 	uea_dbg(INS_TO_USBDEV(sc), "wait_event_timeout : %d ms\n",
1106 			jiffies_to_msecs(ret));
1107 
1108 	if (ret < 0)
1109 		return ret;
1110 
1111 	return (ret == 0) ? -ETIMEDOUT : 0;
1112 }
1113 
1114 #define UCDC_SEND_ENCAPSULATED_COMMAND 0x00
1115 
1116 static int uea_request(struct uea_softc *sc,
1117 		u16 value, u16 index, u16 size, const void *data)
1118 {
1119 	u8 *xfer_buff;
1120 	int ret = -ENOMEM;
1121 
1122 	xfer_buff = kmemdup(data, size, GFP_KERNEL);
1123 	if (!xfer_buff) {
1124 		uea_err(INS_TO_USBDEV(sc), "can't allocate xfer_buff\n");
1125 		return ret;
1126 	}
1127 
1128 	ret = usb_control_msg(sc->usb_dev, usb_sndctrlpipe(sc->usb_dev, 0),
1129 			      UCDC_SEND_ENCAPSULATED_COMMAND,
1130 			      USB_DIR_OUT | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
1131 			      value, index, xfer_buff, size, CTRL_TIMEOUT);
1132 
1133 	kfree(xfer_buff);
1134 	if (ret < 0) {
1135 		uea_err(INS_TO_USBDEV(sc), "usb_control_msg error %d\n", ret);
1136 		return ret;
1137 	}
1138 
1139 	if (ret != size) {
1140 		uea_err(INS_TO_USBDEV(sc),
1141 		       "usb_control_msg send only %d bytes (instead of %d)\n",
1142 		       ret, size);
1143 		return -EIO;
1144 	}
1145 
1146 	return 0;
1147 }
1148 
1149 static int uea_cmv_e1(struct uea_softc *sc,
1150 		u8 function, u32 address, u16 offset, u32 data)
1151 {
1152 	struct cmv_e1 cmv;
1153 	int ret;
1154 
1155 	uea_enters(INS_TO_USBDEV(sc));
1156 	uea_vdbg(INS_TO_USBDEV(sc), "Function : %d-%d, Address : %c%c%c%c, "
1157 			"offset : 0x%04x, data : 0x%08x\n",
1158 			E1_FUNCTION_TYPE(function),
1159 			E1_FUNCTION_SUBTYPE(function),
1160 			E1_GETSA1(address), E1_GETSA2(address),
1161 			E1_GETSA3(address),
1162 			E1_GETSA4(address), offset, data);
1163 
1164 	/* we send a request, but we expect a reply */
1165 	sc->cmv_dsc.e1.function = function | 0x2;
1166 	sc->cmv_dsc.e1.idx++;
1167 	sc->cmv_dsc.e1.address = address;
1168 	sc->cmv_dsc.e1.offset = offset;
1169 
1170 	cmv.wPreamble = cpu_to_le16(E1_PREAMBLE);
1171 	cmv.bDirection = E1_HOSTTOMODEM;
1172 	cmv.bFunction = function;
1173 	cmv.wIndex = cpu_to_le16(sc->cmv_dsc.e1.idx);
1174 	put_unaligned_le32(address, &cmv.dwSymbolicAddress);
1175 	cmv.wOffsetAddress = cpu_to_le16(offset);
1176 	put_unaligned_le32(data >> 16 | data << 16, &cmv.dwData);
1177 
1178 	ret = uea_request(sc, UEA_E1_SET_BLOCK, UEA_MPTX_START,
1179 							sizeof(cmv), &cmv);
1180 	if (ret < 0)
1181 		return ret;
1182 	ret = wait_cmv_ack(sc);
1183 	uea_leaves(INS_TO_USBDEV(sc));
1184 	return ret;
1185 }
1186 
1187 static int uea_cmv_e4(struct uea_softc *sc,
1188 		u16 function, u16 group, u16 address, u16 offset, u32 data)
1189 {
1190 	struct cmv_e4 cmv;
1191 	int ret;
1192 
1193 	uea_enters(INS_TO_USBDEV(sc));
1194 	memset(&cmv, 0, sizeof(cmv));
1195 
1196 	uea_vdbg(INS_TO_USBDEV(sc), "Function : %d-%d, Group : 0x%04x, "
1197 		 "Address : 0x%04x, offset : 0x%04x, data : 0x%08x\n",
1198 		 E4_FUNCTION_TYPE(function), E4_FUNCTION_SUBTYPE(function),
1199 		 group, address, offset, data);
1200 
1201 	/* we send a request, but we expect a reply */
1202 	sc->cmv_dsc.e4.function = function | (0x1 << 4);
1203 	sc->cmv_dsc.e4.offset = offset;
1204 	sc->cmv_dsc.e4.address = address;
1205 	sc->cmv_dsc.e4.group = group;
1206 
1207 	cmv.wFunction = cpu_to_be16(function);
1208 	cmv.wGroup = cpu_to_be16(group);
1209 	cmv.wAddress = cpu_to_be16(address);
1210 	cmv.wOffset = cpu_to_be16(offset);
1211 	cmv.dwData[0] = cpu_to_be32(data);
1212 
1213 	ret = uea_request(sc, UEA_E4_SET_BLOCK, UEA_MPTX_START,
1214 							sizeof(cmv), &cmv);
1215 	if (ret < 0)
1216 		return ret;
1217 	ret = wait_cmv_ack(sc);
1218 	uea_leaves(INS_TO_USBDEV(sc));
1219 	return ret;
1220 }
1221 
1222 static inline int uea_read_cmv_e1(struct uea_softc *sc,
1223 		u32 address, u16 offset, u32 *data)
1224 {
1225 	int ret = uea_cmv_e1(sc, E1_MAKEFUNCTION(E1_MEMACCESS, E1_REQUESTREAD),
1226 			  address, offset, 0);
1227 	if (ret < 0)
1228 		uea_err(INS_TO_USBDEV(sc),
1229 			"reading cmv failed with error %d\n", ret);
1230 	else
1231 		*data = sc->data;
1232 
1233 	return ret;
1234 }
1235 
1236 static inline int uea_read_cmv_e4(struct uea_softc *sc,
1237 		u8 size, u16 group, u16 address, u16 offset, u32 *data)
1238 {
1239 	int ret = uea_cmv_e4(sc, E4_MAKEFUNCTION(E4_MEMACCESS,
1240 							E4_REQUESTREAD, size),
1241 			  group, address, offset, 0);
1242 	if (ret < 0)
1243 		uea_err(INS_TO_USBDEV(sc),
1244 			"reading cmv failed with error %d\n", ret);
1245 	else {
1246 		*data = sc->data;
1247 		/* size is in 16-bit word quantities */
1248 		if (size > 2)
1249 			*(data + 1) = sc->data1;
1250 	}
1251 	return ret;
1252 }
1253 
1254 static inline int uea_write_cmv_e1(struct uea_softc *sc,
1255 		u32 address, u16 offset, u32 data)
1256 {
1257 	int ret = uea_cmv_e1(sc, E1_MAKEFUNCTION(E1_MEMACCESS, E1_REQUESTWRITE),
1258 			  address, offset, data);
1259 	if (ret < 0)
1260 		uea_err(INS_TO_USBDEV(sc),
1261 			"writing cmv failed with error %d\n", ret);
1262 
1263 	return ret;
1264 }
1265 
1266 static inline int uea_write_cmv_e4(struct uea_softc *sc,
1267 		u8 size, u16 group, u16 address, u16 offset, u32 data)
1268 {
1269 	int ret = uea_cmv_e4(sc, E4_MAKEFUNCTION(E4_MEMACCESS,
1270 							E4_REQUESTWRITE, size),
1271 			  group, address, offset, data);
1272 	if (ret < 0)
1273 		uea_err(INS_TO_USBDEV(sc),
1274 			"writing cmv failed with error %d\n", ret);
1275 
1276 	return ret;
1277 }
1278 
1279 static void uea_set_bulk_timeout(struct uea_softc *sc, u32 dsrate)
1280 {
1281 	int ret;
1282 	u16 timeout;
1283 
1284 	/* in bulk mode the modem have problem with high rate
1285 	 * changing internal timing could improve things, but the
1286 	 * value is misterious.
1287 	 * ADI930 don't support it (-EPIPE error).
1288 	 */
1289 
1290 	if (UEA_CHIP_VERSION(sc) == ADI930 ||
1291 	    altsetting[sc->modem_index] > 0 ||
1292 	    sc->stats.phy.dsrate == dsrate)
1293 		return;
1294 
1295 	/* Original timming (1Mbit/s) from ADI (used in windows driver) */
1296 	timeout = (dsrate <= 1024*1024) ? 0 : 1;
1297 	ret = uea_request(sc, UEA_SET_TIMEOUT, timeout, 0, NULL);
1298 	uea_info(INS_TO_USBDEV(sc), "setting new timeout %d%s\n",
1299 		 timeout,  ret < 0 ? " failed" : "");
1300 
1301 }
1302 
1303 /*
1304  * Monitor the modem and update the stat
1305  * return 0 if everything is ok
1306  * return < 0 if an error occurs (-EAGAIN reboot needed)
1307  */
1308 static int uea_stat_e1(struct uea_softc *sc)
1309 {
1310 	u32 data;
1311 	int ret;
1312 
1313 	uea_enters(INS_TO_USBDEV(sc));
1314 	data = sc->stats.phy.state;
1315 
1316 	ret = uea_read_cmv_e1(sc, E1_SA_STAT, 0, &sc->stats.phy.state);
1317 	if (ret < 0)
1318 		return ret;
1319 
1320 	switch (GET_STATUS(sc->stats.phy.state)) {
1321 	case 0:		/* not yet synchronized */
1322 		uea_dbg(INS_TO_USBDEV(sc),
1323 		       "modem not yet synchronized\n");
1324 		return 0;
1325 
1326 	case 1:		/* initialization */
1327 		uea_dbg(INS_TO_USBDEV(sc), "modem initializing\n");
1328 		return 0;
1329 
1330 	case 2:		/* operational */
1331 		uea_vdbg(INS_TO_USBDEV(sc), "modem operational\n");
1332 		break;
1333 
1334 	case 3:		/* fail ... */
1335 		uea_info(INS_TO_USBDEV(sc), "modem synchronization failed"
1336 					" (may be try other cmv/dsp)\n");
1337 		return -EAGAIN;
1338 
1339 	case 4 ... 6:	/* test state */
1340 		uea_warn(INS_TO_USBDEV(sc),
1341 				"modem in test mode - not supported\n");
1342 		return -EAGAIN;
1343 
1344 	case 7:		/* fast-retain ... */
1345 		uea_info(INS_TO_USBDEV(sc), "modem in fast-retain mode\n");
1346 		return 0;
1347 	default:
1348 		uea_err(INS_TO_USBDEV(sc), "modem invalid SW mode %d\n",
1349 			GET_STATUS(sc->stats.phy.state));
1350 		return -EAGAIN;
1351 	}
1352 
1353 	if (GET_STATUS(data) != 2) {
1354 		uea_request(sc, UEA_SET_MODE, UEA_LOOPBACK_OFF, 0, NULL);
1355 		uea_info(INS_TO_USBDEV(sc), "modem operational\n");
1356 
1357 		/* release the dsp firmware as it is not needed until
1358 		 * the next failure
1359 		 */
1360 		if (sc->dsp_firm) {
1361 			release_firmware(sc->dsp_firm);
1362 			sc->dsp_firm = NULL;
1363 		}
1364 	}
1365 
1366 	/* always update it as atm layer could not be init when we switch to
1367 	 * operational state
1368 	 */
1369 	UPDATE_ATM_SIGNAL(ATM_PHY_SIG_FOUND);
1370 
1371 	/* wake up processes waiting for synchronization */
1372 	wake_up(&sc->sync_q);
1373 
1374 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 2, &sc->stats.phy.flags);
1375 	if (ret < 0)
1376 		return ret;
1377 	sc->stats.phy.mflags |= sc->stats.phy.flags;
1378 
1379 	/* in case of a flags ( for example delineation LOSS (& 0x10)),
1380 	 * we check the status again in order to detect the failure earlier
1381 	 */
1382 	if (sc->stats.phy.flags) {
1383 		uea_dbg(INS_TO_USBDEV(sc), "Stat flag = 0x%x\n",
1384 		       sc->stats.phy.flags);
1385 		return 0;
1386 	}
1387 
1388 	ret = uea_read_cmv_e1(sc, E1_SA_RATE, 0, &data);
1389 	if (ret < 0)
1390 		return ret;
1391 
1392 	uea_set_bulk_timeout(sc, (data >> 16) * 32);
1393 	sc->stats.phy.dsrate = (data >> 16) * 32;
1394 	sc->stats.phy.usrate = (data & 0xffff) * 32;
1395 	UPDATE_ATM_STAT(link_rate, sc->stats.phy.dsrate * 1000 / 424);
1396 
1397 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 23, &data);
1398 	if (ret < 0)
1399 		return ret;
1400 	sc->stats.phy.dsattenuation = (data & 0xff) / 2;
1401 
1402 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 47, &data);
1403 	if (ret < 0)
1404 		return ret;
1405 	sc->stats.phy.usattenuation = (data & 0xff) / 2;
1406 
1407 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 25, &sc->stats.phy.dsmargin);
1408 	if (ret < 0)
1409 		return ret;
1410 
1411 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 49, &sc->stats.phy.usmargin);
1412 	if (ret < 0)
1413 		return ret;
1414 
1415 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 51, &sc->stats.phy.rxflow);
1416 	if (ret < 0)
1417 		return ret;
1418 
1419 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 52, &sc->stats.phy.txflow);
1420 	if (ret < 0)
1421 		return ret;
1422 
1423 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 54, &sc->stats.phy.dsunc);
1424 	if (ret < 0)
1425 		return ret;
1426 
1427 	/* only for atu-c */
1428 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 58, &sc->stats.phy.usunc);
1429 	if (ret < 0)
1430 		return ret;
1431 
1432 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 53, &sc->stats.phy.dscorr);
1433 	if (ret < 0)
1434 		return ret;
1435 
1436 	/* only for atu-c */
1437 	ret = uea_read_cmv_e1(sc, E1_SA_DIAG, 57, &sc->stats.phy.uscorr);
1438 	if (ret < 0)
1439 		return ret;
1440 
1441 	ret = uea_read_cmv_e1(sc, E1_SA_INFO, 8, &sc->stats.phy.vidco);
1442 	if (ret < 0)
1443 		return ret;
1444 
1445 	ret = uea_read_cmv_e1(sc, E1_SA_INFO, 13, &sc->stats.phy.vidcpe);
1446 	if (ret < 0)
1447 		return ret;
1448 
1449 	return 0;
1450 }
1451 
1452 static int uea_stat_e4(struct uea_softc *sc)
1453 {
1454 	u32 data;
1455 	u32 tmp_arr[2];
1456 	int ret;
1457 
1458 	uea_enters(INS_TO_USBDEV(sc));
1459 	data = sc->stats.phy.state;
1460 
1461 	/* XXX only need to be done before operationnal... */
1462 	ret = uea_read_cmv_e4(sc, 1, E4_SA_STAT, 0, 0, &sc->stats.phy.state);
1463 	if (ret < 0)
1464 		return ret;
1465 
1466 	switch (sc->stats.phy.state) {
1467 	case 0x0:	/* not yet synchronized */
1468 	case 0x1:
1469 	case 0x3:
1470 	case 0x4:
1471 		uea_dbg(INS_TO_USBDEV(sc), "modem not yet "
1472 						"synchronized\n");
1473 		return 0;
1474 	case 0x5:	/* initialization */
1475 	case 0x6:
1476 	case 0x9:
1477 	case 0xa:
1478 		uea_dbg(INS_TO_USBDEV(sc), "modem initializing\n");
1479 		return 0;
1480 	case 0x2:	/* fail ... */
1481 		uea_info(INS_TO_USBDEV(sc), "modem synchronization "
1482 				"failed (may be try other cmv/dsp)\n");
1483 		return -EAGAIN;
1484 	case 0x7:	/* operational */
1485 		break;
1486 	default:
1487 		uea_warn(INS_TO_USBDEV(sc), "unknown state: %x\n",
1488 						sc->stats.phy.state);
1489 		return 0;
1490 	}
1491 
1492 	if (data != 7) {
1493 		uea_request(sc, UEA_SET_MODE, UEA_LOOPBACK_OFF, 0, NULL);
1494 		uea_info(INS_TO_USBDEV(sc), "modem operational\n");
1495 
1496 		/* release the dsp firmware as it is not needed until
1497 		 * the next failure
1498 		 */
1499 		if (sc->dsp_firm) {
1500 			release_firmware(sc->dsp_firm);
1501 			sc->dsp_firm = NULL;
1502 		}
1503 	}
1504 
1505 	/* always update it as atm layer could not be init when we switch to
1506 	 * operational state
1507 	 */
1508 	UPDATE_ATM_SIGNAL(ATM_PHY_SIG_FOUND);
1509 
1510 	/* wake up processes waiting for synchronization */
1511 	wake_up(&sc->sync_q);
1512 
1513 	/* TODO improve this state machine :
1514 	 * we need some CMV info : what they do and their unit
1515 	 * we should find the equivalent of eagle3- CMV
1516 	 */
1517 	/* check flags */
1518 	ret = uea_read_cmv_e4(sc, 1, E4_SA_DIAG, 0, 0, &sc->stats.phy.flags);
1519 	if (ret < 0)
1520 		return ret;
1521 	sc->stats.phy.mflags |= sc->stats.phy.flags;
1522 
1523 	/* in case of a flags ( for example delineation LOSS (& 0x10)),
1524 	 * we check the status again in order to detect the failure earlier
1525 	 */
1526 	if (sc->stats.phy.flags) {
1527 		uea_dbg(INS_TO_USBDEV(sc), "Stat flag = 0x%x\n",
1528 		       sc->stats.phy.flags);
1529 		if (sc->stats.phy.flags & 1) /* delineation LOSS */
1530 			return -EAGAIN;
1531 		if (sc->stats.phy.flags & 0x4000) /* Reset Flag */
1532 			return -EAGAIN;
1533 		return 0;
1534 	}
1535 
1536 	/* rate data may be in upper or lower half of 64 bit word, strange */
1537 	ret = uea_read_cmv_e4(sc, 4, E4_SA_RATE, 0, 0, tmp_arr);
1538 	if (ret < 0)
1539 		return ret;
1540 	data = (tmp_arr[0]) ? tmp_arr[0] : tmp_arr[1];
1541 	sc->stats.phy.usrate = data / 1000;
1542 
1543 	ret = uea_read_cmv_e4(sc, 4, E4_SA_RATE, 1, 0, tmp_arr);
1544 	if (ret < 0)
1545 		return ret;
1546 	data = (tmp_arr[0]) ? tmp_arr[0] : tmp_arr[1];
1547 	uea_set_bulk_timeout(sc, data / 1000);
1548 	sc->stats.phy.dsrate = data / 1000;
1549 	UPDATE_ATM_STAT(link_rate, sc->stats.phy.dsrate * 1000 / 424);
1550 
1551 	ret = uea_read_cmv_e4(sc, 1, E4_SA_INFO, 68, 1, &data);
1552 	if (ret < 0)
1553 		return ret;
1554 	sc->stats.phy.dsattenuation = data / 10;
1555 
1556 	ret = uea_read_cmv_e4(sc, 1, E4_SA_INFO, 69, 1, &data);
1557 	if (ret < 0)
1558 		return ret;
1559 	sc->stats.phy.usattenuation = data / 10;
1560 
1561 	ret = uea_read_cmv_e4(sc, 1, E4_SA_INFO, 68, 3, &data);
1562 	if (ret < 0)
1563 		return ret;
1564 	sc->stats.phy.dsmargin = data / 2;
1565 
1566 	ret = uea_read_cmv_e4(sc, 1, E4_SA_INFO, 69, 3, &data);
1567 	if (ret < 0)
1568 		return ret;
1569 	sc->stats.phy.usmargin = data / 10;
1570 
1571 	return 0;
1572 }
1573 
1574 static void cmvs_file_name(struct uea_softc *sc, char *const cmv_name, int ver)
1575 {
1576 	char file_arr[] = "CMVxy.bin";
1577 	char *file;
1578 
1579 	kparam_block_sysfs_write(cmv_file);
1580 	/* set proper name corresponding modem version and line type */
1581 	if (cmv_file[sc->modem_index] == NULL) {
1582 		if (UEA_CHIP_VERSION(sc) == ADI930)
1583 			file_arr[3] = '9';
1584 		else if (UEA_CHIP_VERSION(sc) == EAGLE_IV)
1585 			file_arr[3] = '4';
1586 		else
1587 			file_arr[3] = 'e';
1588 
1589 		file_arr[4] = IS_ISDN(sc) ? 'i' : 'p';
1590 		file = file_arr;
1591 	} else
1592 		file = cmv_file[sc->modem_index];
1593 
1594 	strcpy(cmv_name, FW_DIR);
1595 	strlcat(cmv_name, file, UEA_FW_NAME_MAX);
1596 	if (ver == 2)
1597 		strlcat(cmv_name, ".v2", UEA_FW_NAME_MAX);
1598 	kparam_unblock_sysfs_write(cmv_file);
1599 }
1600 
1601 static int request_cmvs_old(struct uea_softc *sc,
1602 		 void **cmvs, const struct firmware **fw)
1603 {
1604 	int ret, size;
1605 	u8 *data;
1606 	char cmv_name[UEA_FW_NAME_MAX]; /* 30 bytes stack variable */
1607 
1608 	cmvs_file_name(sc, cmv_name, 1);
1609 	ret = request_firmware(fw, cmv_name, &sc->usb_dev->dev);
1610 	if (ret < 0) {
1611 		uea_err(INS_TO_USBDEV(sc),
1612 		       "requesting firmware %s failed with error %d\n",
1613 		       cmv_name, ret);
1614 		return ret;
1615 	}
1616 
1617 	data = (u8 *) (*fw)->data;
1618 	size = (*fw)->size;
1619 	if (size < 1)
1620 		goto err_fw_corrupted;
1621 
1622 	if (size != *data * sizeof(struct uea_cmvs_v1) + 1)
1623 		goto err_fw_corrupted;
1624 
1625 	*cmvs = (void *)(data + 1);
1626 	return *data;
1627 
1628 err_fw_corrupted:
1629 	uea_err(INS_TO_USBDEV(sc), "firmware %s is corrupted\n", cmv_name);
1630 	release_firmware(*fw);
1631 	return -EILSEQ;
1632 }
1633 
1634 static int request_cmvs(struct uea_softc *sc,
1635 		 void **cmvs, const struct firmware **fw, int *ver)
1636 {
1637 	int ret, size;
1638 	u32 crc;
1639 	u8 *data;
1640 	char cmv_name[UEA_FW_NAME_MAX]; /* 30 bytes stack variable */
1641 
1642 	cmvs_file_name(sc, cmv_name, 2);
1643 	ret = request_firmware(fw, cmv_name, &sc->usb_dev->dev);
1644 	if (ret < 0) {
1645 		/* if caller can handle old version, try to provide it */
1646 		if (*ver == 1) {
1647 			uea_warn(INS_TO_USBDEV(sc), "requesting "
1648 							"firmware %s failed, "
1649 				"try to get older cmvs\n", cmv_name);
1650 			return request_cmvs_old(sc, cmvs, fw);
1651 		}
1652 		uea_err(INS_TO_USBDEV(sc),
1653 		       "requesting firmware %s failed with error %d\n",
1654 		       cmv_name, ret);
1655 		return ret;
1656 	}
1657 
1658 	size = (*fw)->size;
1659 	data = (u8 *) (*fw)->data;
1660 	if (size < 4 || strncmp(data, "cmv2", 4) != 0) {
1661 		if (*ver == 1) {
1662 			uea_warn(INS_TO_USBDEV(sc), "firmware %s is corrupted,"
1663 				" try to get older cmvs\n", cmv_name);
1664 			release_firmware(*fw);
1665 			return request_cmvs_old(sc, cmvs, fw);
1666 		}
1667 		goto err_fw_corrupted;
1668 	}
1669 
1670 	*ver = 2;
1671 
1672 	data += 4;
1673 	size -= 4;
1674 	if (size < 5)
1675 		goto err_fw_corrupted;
1676 
1677 	crc = get_unaligned_le32(data);
1678 	data += 4;
1679 	size -= 4;
1680 	if (crc32_be(0, data, size) != crc)
1681 		goto err_fw_corrupted;
1682 
1683 	if (size != *data * sizeof(struct uea_cmvs_v2) + 1)
1684 		goto err_fw_corrupted;
1685 
1686 	*cmvs = (void *) (data + 1);
1687 	return *data;
1688 
1689 err_fw_corrupted:
1690 	uea_err(INS_TO_USBDEV(sc), "firmware %s is corrupted\n", cmv_name);
1691 	release_firmware(*fw);
1692 	return -EILSEQ;
1693 }
1694 
1695 static int uea_send_cmvs_e1(struct uea_softc *sc)
1696 {
1697 	int i, ret, len;
1698 	void *cmvs_ptr;
1699 	const struct firmware *cmvs_fw;
1700 	int ver = 1; /* we can handle v1 cmv firmware version; */
1701 
1702 	/* Enter in R-IDLE (cmv) until instructed otherwise */
1703 	ret = uea_write_cmv_e1(sc, E1_SA_CNTL, 0, 1);
1704 	if (ret < 0)
1705 		return ret;
1706 
1707 	/* Dump firmware version */
1708 	ret = uea_read_cmv_e1(sc, E1_SA_INFO, 10, &sc->stats.phy.firmid);
1709 	if (ret < 0)
1710 		return ret;
1711 	uea_info(INS_TO_USBDEV(sc), "ATU-R firmware version : %x\n",
1712 			sc->stats.phy.firmid);
1713 
1714 	/* get options */
1715 	ret = len = request_cmvs(sc, &cmvs_ptr, &cmvs_fw, &ver);
1716 	if (ret < 0)
1717 		return ret;
1718 
1719 	/* send options */
1720 	if (ver == 1) {
1721 		struct uea_cmvs_v1 *cmvs_v1 = cmvs_ptr;
1722 
1723 		uea_warn(INS_TO_USBDEV(sc), "use deprecated cmvs version, "
1724 			"please update your firmware\n");
1725 
1726 		for (i = 0; i < len; i++) {
1727 			ret = uea_write_cmv_e1(sc,
1728 				get_unaligned_le32(&cmvs_v1[i].address),
1729 				get_unaligned_le16(&cmvs_v1[i].offset),
1730 				get_unaligned_le32(&cmvs_v1[i].data));
1731 			if (ret < 0)
1732 				goto out;
1733 		}
1734 	} else if (ver == 2) {
1735 		struct uea_cmvs_v2 *cmvs_v2 = cmvs_ptr;
1736 
1737 		for (i = 0; i < len; i++) {
1738 			ret = uea_write_cmv_e1(sc,
1739 				get_unaligned_le32(&cmvs_v2[i].address),
1740 				(u16) get_unaligned_le32(&cmvs_v2[i].offset),
1741 				get_unaligned_le32(&cmvs_v2[i].data));
1742 			if (ret < 0)
1743 				goto out;
1744 		}
1745 	} else {
1746 		/* This realy should not happen */
1747 		uea_err(INS_TO_USBDEV(sc), "bad cmvs version %d\n", ver);
1748 		goto out;
1749 	}
1750 
1751 	/* Enter in R-ACT-REQ */
1752 	ret = uea_write_cmv_e1(sc, E1_SA_CNTL, 0, 2);
1753 	uea_vdbg(INS_TO_USBDEV(sc), "Entering in R-ACT-REQ state\n");
1754 	uea_info(INS_TO_USBDEV(sc), "modem started, waiting "
1755 						"synchronization...\n");
1756 out:
1757 	release_firmware(cmvs_fw);
1758 	return ret;
1759 }
1760 
1761 static int uea_send_cmvs_e4(struct uea_softc *sc)
1762 {
1763 	int i, ret, len;
1764 	void *cmvs_ptr;
1765 	const struct firmware *cmvs_fw;
1766 	int ver = 2; /* we can only handle v2 cmv firmware version; */
1767 
1768 	/* Enter in R-IDLE (cmv) until instructed otherwise */
1769 	ret = uea_write_cmv_e4(sc, 1, E4_SA_CNTL, 0, 0, 1);
1770 	if (ret < 0)
1771 		return ret;
1772 
1773 	/* Dump firmware version */
1774 	/* XXX don't read the 3th byte as it is always 6 */
1775 	ret = uea_read_cmv_e4(sc, 2, E4_SA_INFO, 55, 0, &sc->stats.phy.firmid);
1776 	if (ret < 0)
1777 		return ret;
1778 	uea_info(INS_TO_USBDEV(sc), "ATU-R firmware version : %x\n",
1779 			sc->stats.phy.firmid);
1780 
1781 
1782 	/* get options */
1783 	ret = len = request_cmvs(sc, &cmvs_ptr, &cmvs_fw, &ver);
1784 	if (ret < 0)
1785 		return ret;
1786 
1787 	/* send options */
1788 	if (ver == 2) {
1789 		struct uea_cmvs_v2 *cmvs_v2 = cmvs_ptr;
1790 
1791 		for (i = 0; i < len; i++) {
1792 			ret = uea_write_cmv_e4(sc, 1,
1793 				get_unaligned_le32(&cmvs_v2[i].group),
1794 				get_unaligned_le32(&cmvs_v2[i].address),
1795 				get_unaligned_le32(&cmvs_v2[i].offset),
1796 				get_unaligned_le32(&cmvs_v2[i].data));
1797 			if (ret < 0)
1798 				goto out;
1799 		}
1800 	} else {
1801 		/* This realy should not happen */
1802 		uea_err(INS_TO_USBDEV(sc), "bad cmvs version %d\n", ver);
1803 		goto out;
1804 	}
1805 
1806 	/* Enter in R-ACT-REQ */
1807 	ret = uea_write_cmv_e4(sc, 1, E4_SA_CNTL, 0, 0, 2);
1808 	uea_vdbg(INS_TO_USBDEV(sc), "Entering in R-ACT-REQ state\n");
1809 	uea_info(INS_TO_USBDEV(sc), "modem started, waiting "
1810 						"synchronization...\n");
1811 out:
1812 	release_firmware(cmvs_fw);
1813 	return ret;
1814 }
1815 
1816 /* Start boot post firmware modem:
1817  * - send reset commands through usb control pipe
1818  * - start workqueue for DSP loading
1819  * - send CMV options to modem
1820  */
1821 
1822 static int uea_start_reset(struct uea_softc *sc)
1823 {
1824 	u16 zero = 0;	/* ;-) */
1825 	int ret;
1826 
1827 	uea_enters(INS_TO_USBDEV(sc));
1828 	uea_info(INS_TO_USBDEV(sc), "(re)booting started\n");
1829 
1830 	/* mask interrupt */
1831 	sc->booting = 1;
1832 	/* We need to set this here because, a ack timeout could have occured,
1833 	 * but before we start the reboot, the ack occurs and set this to 1.
1834 	 * So we will failed to wait Ready CMV.
1835 	 */
1836 	sc->cmv_ack = 0;
1837 	UPDATE_ATM_SIGNAL(ATM_PHY_SIG_LOST);
1838 
1839 	/* reset statistics */
1840 	memset(&sc->stats, 0, sizeof(struct uea_stats));
1841 
1842 	/* tell the modem that we want to boot in IDMA mode */
1843 	uea_request(sc, UEA_SET_MODE, UEA_LOOPBACK_ON, 0, NULL);
1844 	uea_request(sc, UEA_SET_MODE, UEA_BOOT_IDMA, 0, NULL);
1845 
1846 	/* enter reset mode */
1847 	uea_request(sc, UEA_SET_MODE, UEA_START_RESET, 0, NULL);
1848 
1849 	/* original driver use 200ms, but windows driver use 100ms */
1850 	ret = uea_wait(sc, 0, msecs_to_jiffies(100));
1851 	if (ret < 0)
1852 		return ret;
1853 
1854 	/* leave reset mode */
1855 	uea_request(sc, UEA_SET_MODE, UEA_END_RESET, 0, NULL);
1856 
1857 	if (UEA_CHIP_VERSION(sc) != EAGLE_IV) {
1858 		/* clear tx and rx mailboxes */
1859 		uea_request(sc, UEA_SET_2183_DATA, UEA_MPTX_MAILBOX, 2, &zero);
1860 		uea_request(sc, UEA_SET_2183_DATA, UEA_MPRX_MAILBOX, 2, &zero);
1861 		uea_request(sc, UEA_SET_2183_DATA, UEA_SWAP_MAILBOX, 2, &zero);
1862 	}
1863 
1864 	ret = uea_wait(sc, 0, msecs_to_jiffies(1000));
1865 	if (ret < 0)
1866 		return ret;
1867 
1868 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV)
1869 		sc->cmv_dsc.e4.function = E4_MAKEFUNCTION(E4_ADSLDIRECTIVE,
1870 							E4_MODEMREADY, 1);
1871 	else
1872 		sc->cmv_dsc.e1.function = E1_MAKEFUNCTION(E1_ADSLDIRECTIVE,
1873 							E1_MODEMREADY);
1874 
1875 	/* demask interrupt */
1876 	sc->booting = 0;
1877 
1878 	/* start loading DSP */
1879 	sc->pageno = 0;
1880 	sc->ovl = 0;
1881 	schedule_work(&sc->task);
1882 
1883 	/* wait for modem ready CMV */
1884 	ret = wait_cmv_ack(sc);
1885 	if (ret < 0)
1886 		return ret;
1887 
1888 	uea_vdbg(INS_TO_USBDEV(sc), "Ready CMV received\n");
1889 
1890 	ret = sc->send_cmvs(sc);
1891 	if (ret < 0)
1892 		return ret;
1893 
1894 	sc->reset = 0;
1895 	uea_leaves(INS_TO_USBDEV(sc));
1896 	return ret;
1897 }
1898 
1899 /*
1900  * In case of an error wait 1s before rebooting the modem
1901  * if the modem don't request reboot (-EAGAIN).
1902  * Monitor the modem every 1s.
1903  */
1904 
1905 static int uea_kthread(void *data)
1906 {
1907 	struct uea_softc *sc = data;
1908 	int ret = -EAGAIN;
1909 
1910 	set_freezable();
1911 	uea_enters(INS_TO_USBDEV(sc));
1912 	while (!kthread_should_stop()) {
1913 		if (ret < 0 || sc->reset)
1914 			ret = uea_start_reset(sc);
1915 		if (!ret)
1916 			ret = sc->stat(sc);
1917 		if (ret != -EAGAIN)
1918 			uea_wait(sc, 0, msecs_to_jiffies(1000));
1919 		try_to_freeze();
1920 	}
1921 	uea_leaves(INS_TO_USBDEV(sc));
1922 	return ret;
1923 }
1924 
1925 /* Load second usb firmware for ADI930 chip */
1926 static int load_XILINX_firmware(struct uea_softc *sc)
1927 {
1928 	const struct firmware *fw_entry;
1929 	int ret, size, u, ln;
1930 	const u8 *pfw;
1931 	u8 value;
1932 	char *fw_name = FW_DIR "930-fpga.bin";
1933 
1934 	uea_enters(INS_TO_USBDEV(sc));
1935 
1936 	ret = request_firmware(&fw_entry, fw_name, &sc->usb_dev->dev);
1937 	if (ret) {
1938 		uea_err(INS_TO_USBDEV(sc), "firmware %s is not available\n",
1939 		       fw_name);
1940 		goto err0;
1941 	}
1942 
1943 	pfw = fw_entry->data;
1944 	size = fw_entry->size;
1945 	if (size != 0x577B) {
1946 		uea_err(INS_TO_USBDEV(sc), "firmware %s is corrupted\n",
1947 		       fw_name);
1948 		ret = -EILSEQ;
1949 		goto err1;
1950 	}
1951 	for (u = 0; u < size; u += ln) {
1952 		ln = min(size - u, 64);
1953 		ret = uea_request(sc, 0xe, 0, ln, pfw + u);
1954 		if (ret < 0) {
1955 			uea_err(INS_TO_USBDEV(sc),
1956 			       "elsa download data failed (%d)\n", ret);
1957 			goto err1;
1958 		}
1959 	}
1960 
1961 	/* finish to send the fpga */
1962 	ret = uea_request(sc, 0xe, 1, 0, NULL);
1963 	if (ret < 0) {
1964 		uea_err(INS_TO_USBDEV(sc),
1965 				"elsa download data failed (%d)\n", ret);
1966 		goto err1;
1967 	}
1968 
1969 	/* Tell the modem we finish : de-assert reset */
1970 	value = 0;
1971 	ret = uea_send_modem_cmd(sc->usb_dev, 0xe, 1, &value);
1972 	if (ret < 0)
1973 		uea_err(sc->usb_dev, "elsa de-assert failed with error"
1974 								" %d\n", ret);
1975 
1976 err1:
1977 	release_firmware(fw_entry);
1978 err0:
1979 	uea_leaves(INS_TO_USBDEV(sc));
1980 	return ret;
1981 }
1982 
1983 /* The modem send us an ack. First with check if it right */
1984 static void uea_dispatch_cmv_e1(struct uea_softc *sc, struct intr_pkt *intr)
1985 {
1986 	struct cmv_dsc_e1 *dsc = &sc->cmv_dsc.e1;
1987 	struct cmv_e1 *cmv = &intr->u.e1.s2.cmv;
1988 
1989 	uea_enters(INS_TO_USBDEV(sc));
1990 	if (le16_to_cpu(cmv->wPreamble) != E1_PREAMBLE)
1991 		goto bad1;
1992 
1993 	if (cmv->bDirection != E1_MODEMTOHOST)
1994 		goto bad1;
1995 
1996 	/* FIXME : ADI930 reply wrong preambule (func = 2, sub = 2) to
1997 	 * the first MEMACCESS cmv. Ignore it...
1998 	 */
1999 	if (cmv->bFunction != dsc->function) {
2000 		if (UEA_CHIP_VERSION(sc) == ADI930
2001 				&& cmv->bFunction ==  E1_MAKEFUNCTION(2, 2)) {
2002 			cmv->wIndex = cpu_to_le16(dsc->idx);
2003 			put_unaligned_le32(dsc->address,
2004 						&cmv->dwSymbolicAddress);
2005 			cmv->wOffsetAddress = cpu_to_le16(dsc->offset);
2006 		} else
2007 			goto bad2;
2008 	}
2009 
2010 	if (cmv->bFunction == E1_MAKEFUNCTION(E1_ADSLDIRECTIVE,
2011 							E1_MODEMREADY)) {
2012 		wake_up_cmv_ack(sc);
2013 		uea_leaves(INS_TO_USBDEV(sc));
2014 		return;
2015 	}
2016 
2017 	/* in case of MEMACCESS */
2018 	if (le16_to_cpu(cmv->wIndex) != dsc->idx ||
2019 	    get_unaligned_le32(&cmv->dwSymbolicAddress) != dsc->address ||
2020 	    le16_to_cpu(cmv->wOffsetAddress) != dsc->offset)
2021 		goto bad2;
2022 
2023 	sc->data = get_unaligned_le32(&cmv->dwData);
2024 	sc->data = sc->data << 16 | sc->data >> 16;
2025 
2026 	wake_up_cmv_ack(sc);
2027 	uea_leaves(INS_TO_USBDEV(sc));
2028 	return;
2029 
2030 bad2:
2031 	uea_err(INS_TO_USBDEV(sc), "unexpected cmv received, "
2032 			"Function : %d, Subfunction : %d\n",
2033 			E1_FUNCTION_TYPE(cmv->bFunction),
2034 			E1_FUNCTION_SUBTYPE(cmv->bFunction));
2035 	uea_leaves(INS_TO_USBDEV(sc));
2036 	return;
2037 
2038 bad1:
2039 	uea_err(INS_TO_USBDEV(sc), "invalid cmv received, "
2040 			"wPreamble %d, bDirection %d\n",
2041 			le16_to_cpu(cmv->wPreamble), cmv->bDirection);
2042 	uea_leaves(INS_TO_USBDEV(sc));
2043 }
2044 
2045 /* The modem send us an ack. First with check if it right */
2046 static void uea_dispatch_cmv_e4(struct uea_softc *sc, struct intr_pkt *intr)
2047 {
2048 	struct cmv_dsc_e4 *dsc = &sc->cmv_dsc.e4;
2049 	struct cmv_e4 *cmv = &intr->u.e4.s2.cmv;
2050 
2051 	uea_enters(INS_TO_USBDEV(sc));
2052 	uea_dbg(INS_TO_USBDEV(sc), "cmv %x %x %x %x %x %x\n",
2053 		be16_to_cpu(cmv->wGroup), be16_to_cpu(cmv->wFunction),
2054 		be16_to_cpu(cmv->wOffset), be16_to_cpu(cmv->wAddress),
2055 		be32_to_cpu(cmv->dwData[0]), be32_to_cpu(cmv->dwData[1]));
2056 
2057 	if (be16_to_cpu(cmv->wFunction) != dsc->function)
2058 		goto bad2;
2059 
2060 	if (be16_to_cpu(cmv->wFunction) == E4_MAKEFUNCTION(E4_ADSLDIRECTIVE,
2061 						E4_MODEMREADY, 1)) {
2062 		wake_up_cmv_ack(sc);
2063 		uea_leaves(INS_TO_USBDEV(sc));
2064 		return;
2065 	}
2066 
2067 	/* in case of MEMACCESS */
2068 	if (be16_to_cpu(cmv->wOffset) != dsc->offset ||
2069 	    be16_to_cpu(cmv->wGroup) != dsc->group ||
2070 	    be16_to_cpu(cmv->wAddress) != dsc->address)
2071 		goto bad2;
2072 
2073 	sc->data = be32_to_cpu(cmv->dwData[0]);
2074 	sc->data1 = be32_to_cpu(cmv->dwData[1]);
2075 	wake_up_cmv_ack(sc);
2076 	uea_leaves(INS_TO_USBDEV(sc));
2077 	return;
2078 
2079 bad2:
2080 	uea_err(INS_TO_USBDEV(sc), "unexpected cmv received, "
2081 			"Function : %d, Subfunction : %d\n",
2082 			E4_FUNCTION_TYPE(cmv->wFunction),
2083 			E4_FUNCTION_SUBTYPE(cmv->wFunction));
2084 	uea_leaves(INS_TO_USBDEV(sc));
2085 	return;
2086 }
2087 
2088 static void uea_schedule_load_page_e1(struct uea_softc *sc,
2089 						struct intr_pkt *intr)
2090 {
2091 	sc->pageno = intr->e1_bSwapPageNo;
2092 	sc->ovl = intr->e1_bOvl >> 4 | intr->e1_bOvl << 4;
2093 	schedule_work(&sc->task);
2094 }
2095 
2096 static void uea_schedule_load_page_e4(struct uea_softc *sc,
2097 						struct intr_pkt *intr)
2098 {
2099 	sc->pageno = intr->e4_bSwapPageNo;
2100 	schedule_work(&sc->task);
2101 }
2102 
2103 /*
2104  * interrupt handler
2105  */
2106 static void uea_intr(struct urb *urb)
2107 {
2108 	struct uea_softc *sc = urb->context;
2109 	struct intr_pkt *intr = urb->transfer_buffer;
2110 	int status = urb->status;
2111 
2112 	uea_enters(INS_TO_USBDEV(sc));
2113 
2114 	if (unlikely(status < 0)) {
2115 		uea_err(INS_TO_USBDEV(sc), "uea_intr() failed with %d\n",
2116 		       status);
2117 		return;
2118 	}
2119 
2120 	/* device-to-host interrupt */
2121 	if (intr->bType != 0x08 || sc->booting) {
2122 		uea_err(INS_TO_USBDEV(sc), "wrong interrupt\n");
2123 		goto resubmit;
2124 	}
2125 
2126 	switch (le16_to_cpu(intr->wInterrupt)) {
2127 	case INT_LOADSWAPPAGE:
2128 		sc->schedule_load_page(sc, intr);
2129 		break;
2130 
2131 	case INT_INCOMINGCMV:
2132 		sc->dispatch_cmv(sc, intr);
2133 		break;
2134 
2135 	default:
2136 		uea_err(INS_TO_USBDEV(sc), "unknown interrupt %u\n",
2137 		       le16_to_cpu(intr->wInterrupt));
2138 	}
2139 
2140 resubmit:
2141 	usb_submit_urb(sc->urb_int, GFP_ATOMIC);
2142 }
2143 
2144 /*
2145  * Start the modem : init the data and start kernel thread
2146  */
2147 static int uea_boot(struct uea_softc *sc)
2148 {
2149 	int ret, size;
2150 	struct intr_pkt *intr;
2151 
2152 	uea_enters(INS_TO_USBDEV(sc));
2153 
2154 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV) {
2155 		size = E4_INTR_PKT_SIZE;
2156 		sc->dispatch_cmv = uea_dispatch_cmv_e4;
2157 		sc->schedule_load_page = uea_schedule_load_page_e4;
2158 		sc->stat = uea_stat_e4;
2159 		sc->send_cmvs = uea_send_cmvs_e4;
2160 		INIT_WORK(&sc->task, uea_load_page_e4);
2161 	} else {
2162 		size = E1_INTR_PKT_SIZE;
2163 		sc->dispatch_cmv = uea_dispatch_cmv_e1;
2164 		sc->schedule_load_page = uea_schedule_load_page_e1;
2165 		sc->stat = uea_stat_e1;
2166 		sc->send_cmvs = uea_send_cmvs_e1;
2167 		INIT_WORK(&sc->task, uea_load_page_e1);
2168 	}
2169 
2170 	init_waitqueue_head(&sc->sync_q);
2171 
2172 	if (UEA_CHIP_VERSION(sc) == ADI930)
2173 		load_XILINX_firmware(sc);
2174 
2175 	intr = kmalloc(size, GFP_KERNEL);
2176 	if (!intr) {
2177 		uea_err(INS_TO_USBDEV(sc),
2178 		       "cannot allocate interrupt package\n");
2179 		goto err0;
2180 	}
2181 
2182 	sc->urb_int = usb_alloc_urb(0, GFP_KERNEL);
2183 	if (!sc->urb_int) {
2184 		uea_err(INS_TO_USBDEV(sc), "cannot allocate interrupt URB\n");
2185 		goto err1;
2186 	}
2187 
2188 	usb_fill_int_urb(sc->urb_int, sc->usb_dev,
2189 			 usb_rcvintpipe(sc->usb_dev, UEA_INTR_PIPE),
2190 			 intr, size, uea_intr, sc,
2191 			 sc->usb_dev->actconfig->interface[0]->altsetting[0].
2192 			 endpoint[0].desc.bInterval);
2193 
2194 	ret = usb_submit_urb(sc->urb_int, GFP_KERNEL);
2195 	if (ret < 0) {
2196 		uea_err(INS_TO_USBDEV(sc),
2197 		       "urb submition failed with error %d\n", ret);
2198 		goto err1;
2199 	}
2200 
2201 	/* Create worker thread, but don't start it here.  Start it after
2202 	 * all usbatm generic initialization is done.
2203 	 */
2204 	sc->kthread = kthread_create(uea_kthread, sc, "ueagle-atm");
2205 	if (IS_ERR(sc->kthread)) {
2206 		uea_err(INS_TO_USBDEV(sc), "failed to create thread\n");
2207 		goto err2;
2208 	}
2209 
2210 	uea_leaves(INS_TO_USBDEV(sc));
2211 	return 0;
2212 
2213 err2:
2214 	usb_kill_urb(sc->urb_int);
2215 err1:
2216 	usb_free_urb(sc->urb_int);
2217 	sc->urb_int = NULL;
2218 	kfree(intr);
2219 err0:
2220 	uea_leaves(INS_TO_USBDEV(sc));
2221 	return -ENOMEM;
2222 }
2223 
2224 /*
2225  * Stop the modem : kill kernel thread and free data
2226  */
2227 static void uea_stop(struct uea_softc *sc)
2228 {
2229 	int ret;
2230 	uea_enters(INS_TO_USBDEV(sc));
2231 	ret = kthread_stop(sc->kthread);
2232 	uea_dbg(INS_TO_USBDEV(sc), "kthread finish with status %d\n", ret);
2233 
2234 	uea_request(sc, UEA_SET_MODE, UEA_LOOPBACK_ON, 0, NULL);
2235 
2236 	usb_kill_urb(sc->urb_int);
2237 	kfree(sc->urb_int->transfer_buffer);
2238 	usb_free_urb(sc->urb_int);
2239 
2240 	/* flush the work item, when no one can schedule it */
2241 	flush_work_sync(&sc->task);
2242 
2243 	if (sc->dsp_firm)
2244 		release_firmware(sc->dsp_firm);
2245 	uea_leaves(INS_TO_USBDEV(sc));
2246 }
2247 
2248 /* syfs interface */
2249 static struct uea_softc *dev_to_uea(struct device *dev)
2250 {
2251 	struct usb_interface *intf;
2252 	struct usbatm_data *usbatm;
2253 
2254 	intf = to_usb_interface(dev);
2255 	if (!intf)
2256 		return NULL;
2257 
2258 	usbatm = usb_get_intfdata(intf);
2259 	if (!usbatm)
2260 		return NULL;
2261 
2262 	return usbatm->driver_data;
2263 }
2264 
2265 static ssize_t read_status(struct device *dev, struct device_attribute *attr,
2266 		char *buf)
2267 {
2268 	int ret = -ENODEV;
2269 	struct uea_softc *sc;
2270 
2271 	mutex_lock(&uea_mutex);
2272 	sc = dev_to_uea(dev);
2273 	if (!sc)
2274 		goto out;
2275 	ret = snprintf(buf, 10, "%08x\n", sc->stats.phy.state);
2276 out:
2277 	mutex_unlock(&uea_mutex);
2278 	return ret;
2279 }
2280 
2281 static ssize_t reboot(struct device *dev, struct device_attribute *attr,
2282 		const char *buf, size_t count)
2283 {
2284 	int ret = -ENODEV;
2285 	struct uea_softc *sc;
2286 
2287 	mutex_lock(&uea_mutex);
2288 	sc = dev_to_uea(dev);
2289 	if (!sc)
2290 		goto out;
2291 	sc->reset = 1;
2292 	ret = count;
2293 out:
2294 	mutex_unlock(&uea_mutex);
2295 	return ret;
2296 }
2297 
2298 static DEVICE_ATTR(stat_status, S_IWUSR | S_IRUGO, read_status, reboot);
2299 
2300 static ssize_t read_human_status(struct device *dev,
2301 			struct device_attribute *attr, char *buf)
2302 {
2303 	int ret = -ENODEV;
2304 	int modem_state;
2305 	struct uea_softc *sc;
2306 
2307 	mutex_lock(&uea_mutex);
2308 	sc = dev_to_uea(dev);
2309 	if (!sc)
2310 		goto out;
2311 
2312 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV) {
2313 		switch (sc->stats.phy.state) {
2314 		case 0x0:	/* not yet synchronized */
2315 		case 0x1:
2316 		case 0x3:
2317 		case 0x4:
2318 			modem_state = 0;
2319 			break;
2320 		case 0x5:	/* initialization */
2321 		case 0x6:
2322 		case 0x9:
2323 		case 0xa:
2324 			modem_state = 1;
2325 			break;
2326 		case 0x7:	/* operational */
2327 			modem_state = 2;
2328 			break;
2329 		case 0x2:	/* fail ... */
2330 			modem_state = 3;
2331 			break;
2332 		default:	/* unknown */
2333 			modem_state = 4;
2334 			break;
2335 		}
2336 	} else
2337 		modem_state = GET_STATUS(sc->stats.phy.state);
2338 
2339 	switch (modem_state) {
2340 	case 0:
2341 		ret = sprintf(buf, "Modem is booting\n");
2342 		break;
2343 	case 1:
2344 		ret = sprintf(buf, "Modem is initializing\n");
2345 		break;
2346 	case 2:
2347 		ret = sprintf(buf, "Modem is operational\n");
2348 		break;
2349 	case 3:
2350 		ret = sprintf(buf, "Modem synchronization failed\n");
2351 		break;
2352 	default:
2353 		ret = sprintf(buf, "Modem state is unknown\n");
2354 		break;
2355 	}
2356 out:
2357 	mutex_unlock(&uea_mutex);
2358 	return ret;
2359 }
2360 
2361 static DEVICE_ATTR(stat_human_status, S_IRUGO, read_human_status, NULL);
2362 
2363 static ssize_t read_delin(struct device *dev, struct device_attribute *attr,
2364 		char *buf)
2365 {
2366 	int ret = -ENODEV;
2367 	struct uea_softc *sc;
2368 	char *delin = "GOOD";
2369 
2370 	mutex_lock(&uea_mutex);
2371 	sc = dev_to_uea(dev);
2372 	if (!sc)
2373 		goto out;
2374 
2375 	if (UEA_CHIP_VERSION(sc) == EAGLE_IV) {
2376 		if (sc->stats.phy.flags & 0x4000)
2377 			delin = "RESET";
2378 		else if (sc->stats.phy.flags & 0x0001)
2379 			delin = "LOSS";
2380 	} else {
2381 		if (sc->stats.phy.flags & 0x0C00)
2382 			delin = "ERROR";
2383 		else if (sc->stats.phy.flags & 0x0030)
2384 			delin = "LOSS";
2385 	}
2386 
2387 	ret = sprintf(buf, "%s\n", delin);
2388 out:
2389 	mutex_unlock(&uea_mutex);
2390 	return ret;
2391 }
2392 
2393 static DEVICE_ATTR(stat_delin, S_IRUGO, read_delin, NULL);
2394 
2395 #define UEA_ATTR(name, reset)					\
2396 								\
2397 static ssize_t read_##name(struct device *dev,			\
2398 		struct device_attribute *attr, char *buf)	\
2399 {								\
2400 	int ret = -ENODEV;					\
2401 	struct uea_softc *sc;					\
2402 								\
2403 	mutex_lock(&uea_mutex);					\
2404 	sc = dev_to_uea(dev);					\
2405 	if (!sc)						\
2406 		goto out;					\
2407 	ret = snprintf(buf, 10, "%08x\n", sc->stats.phy.name);	\
2408 	if (reset)						\
2409 		sc->stats.phy.name = 0;				\
2410 out:								\
2411 	mutex_unlock(&uea_mutex);				\
2412 	return ret;						\
2413 }								\
2414 								\
2415 static DEVICE_ATTR(stat_##name, S_IRUGO, read_##name, NULL)
2416 
2417 UEA_ATTR(mflags, 1);
2418 UEA_ATTR(vidcpe, 0);
2419 UEA_ATTR(usrate, 0);
2420 UEA_ATTR(dsrate, 0);
2421 UEA_ATTR(usattenuation, 0);
2422 UEA_ATTR(dsattenuation, 0);
2423 UEA_ATTR(usmargin, 0);
2424 UEA_ATTR(dsmargin, 0);
2425 UEA_ATTR(txflow, 0);
2426 UEA_ATTR(rxflow, 0);
2427 UEA_ATTR(uscorr, 0);
2428 UEA_ATTR(dscorr, 0);
2429 UEA_ATTR(usunc, 0);
2430 UEA_ATTR(dsunc, 0);
2431 UEA_ATTR(firmid, 0);
2432 
2433 /* Retrieve the device End System Identifier (MAC) */
2434 
2435 static int uea_getesi(struct uea_softc *sc, u_char * esi)
2436 {
2437 	unsigned char mac_str[2 * ETH_ALEN + 1];
2438 	int i;
2439 	if (usb_string
2440 	    (sc->usb_dev, sc->usb_dev->descriptor.iSerialNumber, mac_str,
2441 	     sizeof(mac_str)) != 2 * ETH_ALEN)
2442 		return 1;
2443 
2444 	for (i = 0; i < ETH_ALEN; i++)
2445 		esi[i] = hex_to_bin(mac_str[2 * i]) * 16 +
2446 			 hex_to_bin(mac_str[2 * i + 1]);
2447 
2448 	return 0;
2449 }
2450 
2451 /* ATM stuff */
2452 static int uea_atm_open(struct usbatm_data *usbatm, struct atm_dev *atm_dev)
2453 {
2454 	struct uea_softc *sc = usbatm->driver_data;
2455 
2456 	return uea_getesi(sc, atm_dev->esi);
2457 }
2458 
2459 static int uea_heavy(struct usbatm_data *usbatm, struct usb_interface *intf)
2460 {
2461 	struct uea_softc *sc = usbatm->driver_data;
2462 
2463 	wait_event_interruptible(sc->sync_q, IS_OPERATIONAL(sc));
2464 
2465 	return 0;
2466 
2467 }
2468 
2469 static int claim_interface(struct usb_device *usb_dev,
2470 			   struct usbatm_data *usbatm, int ifnum)
2471 {
2472 	int ret;
2473 	struct usb_interface *intf = usb_ifnum_to_if(usb_dev, ifnum);
2474 
2475 	if (!intf) {
2476 		uea_err(usb_dev, "interface %d not found\n", ifnum);
2477 		return -ENODEV;
2478 	}
2479 
2480 	ret = usb_driver_claim_interface(&uea_driver, intf, usbatm);
2481 	if (ret != 0)
2482 		uea_err(usb_dev, "can't claim interface %d, error %d\n", ifnum,
2483 		       ret);
2484 	return ret;
2485 }
2486 
2487 static struct attribute *attrs[] = {
2488 	&dev_attr_stat_status.attr,
2489 	&dev_attr_stat_mflags.attr,
2490 	&dev_attr_stat_human_status.attr,
2491 	&dev_attr_stat_delin.attr,
2492 	&dev_attr_stat_vidcpe.attr,
2493 	&dev_attr_stat_usrate.attr,
2494 	&dev_attr_stat_dsrate.attr,
2495 	&dev_attr_stat_usattenuation.attr,
2496 	&dev_attr_stat_dsattenuation.attr,
2497 	&dev_attr_stat_usmargin.attr,
2498 	&dev_attr_stat_dsmargin.attr,
2499 	&dev_attr_stat_txflow.attr,
2500 	&dev_attr_stat_rxflow.attr,
2501 	&dev_attr_stat_uscorr.attr,
2502 	&dev_attr_stat_dscorr.attr,
2503 	&dev_attr_stat_usunc.attr,
2504 	&dev_attr_stat_dsunc.attr,
2505 	&dev_attr_stat_firmid.attr,
2506 	NULL,
2507 };
2508 static struct attribute_group attr_grp = {
2509 	.attrs = attrs,
2510 };
2511 
2512 static int uea_bind(struct usbatm_data *usbatm, struct usb_interface *intf,
2513 		   const struct usb_device_id *id)
2514 {
2515 	struct usb_device *usb = interface_to_usbdev(intf);
2516 	struct uea_softc *sc;
2517 	int ret, ifnum = intf->altsetting->desc.bInterfaceNumber;
2518 	unsigned int alt;
2519 
2520 	uea_enters(usb);
2521 
2522 	/* interface 0 is for firmware/monitoring */
2523 	if (ifnum != UEA_INTR_IFACE_NO)
2524 		return -ENODEV;
2525 
2526 	usbatm->flags = (sync_wait[modem_index] ? 0 : UDSL_SKIP_HEAVY_INIT);
2527 
2528 	/* interface 1 is for outbound traffic */
2529 	ret = claim_interface(usb, usbatm, UEA_US_IFACE_NO);
2530 	if (ret < 0)
2531 		return ret;
2532 
2533 	/* ADI930 has only 2 interfaces and inbound traffic is on interface 1 */
2534 	if (UEA_CHIP_VERSION(id) != ADI930) {
2535 		/* interface 2 is for inbound traffic */
2536 		ret = claim_interface(usb, usbatm, UEA_DS_IFACE_NO);
2537 		if (ret < 0)
2538 			return ret;
2539 	}
2540 
2541 	sc = kzalloc(sizeof(struct uea_softc), GFP_KERNEL);
2542 	if (!sc) {
2543 		uea_err(usb, "uea_init: not enough memory !\n");
2544 		return -ENOMEM;
2545 	}
2546 
2547 	sc->usb_dev = usb;
2548 	usbatm->driver_data = sc;
2549 	sc->usbatm = usbatm;
2550 	sc->modem_index = (modem_index < NB_MODEM) ? modem_index++ : 0;
2551 	sc->driver_info = id->driver_info;
2552 
2553 	/* first try to use module parameter */
2554 	if (annex[sc->modem_index] == 1)
2555 		sc->annex = ANNEXA;
2556 	else if (annex[sc->modem_index] == 2)
2557 		sc->annex = ANNEXB;
2558 	/* try to autodetect annex */
2559 	else if (sc->driver_info & AUTO_ANNEX_A)
2560 		sc->annex = ANNEXA;
2561 	else if (sc->driver_info & AUTO_ANNEX_B)
2562 		sc->annex = ANNEXB;
2563 	else
2564 		sc->annex = (le16_to_cpu
2565 		(sc->usb_dev->descriptor.bcdDevice) & 0x80) ? ANNEXB : ANNEXA;
2566 
2567 	alt = altsetting[sc->modem_index];
2568 	/* ADI930 don't support iso */
2569 	if (UEA_CHIP_VERSION(id) != ADI930 && alt > 0) {
2570 		if (alt <= 8 &&
2571 			usb_set_interface(usb, UEA_DS_IFACE_NO, alt) == 0) {
2572 			uea_dbg(usb, "set alternate %u for 2 interface\n", alt);
2573 			uea_info(usb, "using iso mode\n");
2574 			usbatm->flags |= UDSL_USE_ISOC | UDSL_IGNORE_EILSEQ;
2575 		} else {
2576 			uea_err(usb, "setting alternate %u failed for "
2577 					"2 interface, using bulk mode\n", alt);
2578 		}
2579 	}
2580 
2581 	ret = sysfs_create_group(&intf->dev.kobj, &attr_grp);
2582 	if (ret < 0)
2583 		goto error;
2584 
2585 	ret = uea_boot(sc);
2586 	if (ret < 0)
2587 		goto error_rm_grp;
2588 
2589 	return 0;
2590 
2591 error_rm_grp:
2592 	sysfs_remove_group(&intf->dev.kobj, &attr_grp);
2593 error:
2594 	kfree(sc);
2595 	return ret;
2596 }
2597 
2598 static void uea_unbind(struct usbatm_data *usbatm, struct usb_interface *intf)
2599 {
2600 	struct uea_softc *sc = usbatm->driver_data;
2601 
2602 	sysfs_remove_group(&intf->dev.kobj, &attr_grp);
2603 	uea_stop(sc);
2604 	kfree(sc);
2605 }
2606 
2607 static struct usbatm_driver uea_usbatm_driver = {
2608 	.driver_name = "ueagle-atm",
2609 	.bind = uea_bind,
2610 	.atm_start = uea_atm_open,
2611 	.unbind = uea_unbind,
2612 	.heavy_init = uea_heavy,
2613 	.bulk_in = UEA_BULK_DATA_PIPE,
2614 	.bulk_out = UEA_BULK_DATA_PIPE,
2615 	.isoc_in = UEA_ISO_DATA_PIPE,
2616 };
2617 
2618 static int uea_probe(struct usb_interface *intf, const struct usb_device_id *id)
2619 {
2620 	struct usb_device *usb = interface_to_usbdev(intf);
2621 	int ret;
2622 
2623 	uea_enters(usb);
2624 	uea_info(usb, "ADSL device founded vid (%#X) pid (%#X) Rev (%#X): %s\n",
2625 		le16_to_cpu(usb->descriptor.idVendor),
2626 		le16_to_cpu(usb->descriptor.idProduct),
2627 		le16_to_cpu(usb->descriptor.bcdDevice),
2628 		chip_name[UEA_CHIP_VERSION(id)]);
2629 
2630 	usb_reset_device(usb);
2631 
2632 	if (UEA_IS_PREFIRM(id))
2633 		return uea_load_firmware(usb, UEA_CHIP_VERSION(id));
2634 
2635 	ret = usbatm_usb_probe(intf, id, &uea_usbatm_driver);
2636 	if (ret == 0) {
2637 		struct usbatm_data *usbatm = usb_get_intfdata(intf);
2638 		struct uea_softc *sc = usbatm->driver_data;
2639 
2640 		/* Ensure carrier is initialized to off as early as possible */
2641 		UPDATE_ATM_SIGNAL(ATM_PHY_SIG_LOST);
2642 
2643 		/* Only start the worker thread when all init is done */
2644 		wake_up_process(sc->kthread);
2645 	}
2646 
2647 	return ret;
2648 }
2649 
2650 static void uea_disconnect(struct usb_interface *intf)
2651 {
2652 	struct usb_device *usb = interface_to_usbdev(intf);
2653 	int ifnum = intf->altsetting->desc.bInterfaceNumber;
2654 	uea_enters(usb);
2655 
2656 	/* ADI930 has 2 interfaces and eagle 3 interfaces.
2657 	 * Pre-firmware device has one interface
2658 	 */
2659 	if (usb->config->desc.bNumInterfaces != 1 && ifnum == 0) {
2660 		mutex_lock(&uea_mutex);
2661 		usbatm_usb_disconnect(intf);
2662 		mutex_unlock(&uea_mutex);
2663 		uea_info(usb, "ADSL device removed\n");
2664 	}
2665 
2666 	uea_leaves(usb);
2667 }
2668 
2669 /*
2670  * List of supported VID/PID
2671  */
2672 static const struct usb_device_id uea_ids[] = {
2673 	{USB_DEVICE(ANALOG_VID,	ADI930_PID_PREFIRM),
2674 		.driver_info = ADI930 | PREFIRM},
2675 	{USB_DEVICE(ANALOG_VID,	ADI930_PID_PSTFIRM),
2676 		.driver_info = ADI930 | PSTFIRM},
2677 	{USB_DEVICE(ANALOG_VID,	EAGLE_I_PID_PREFIRM),
2678 		.driver_info = EAGLE_I | PREFIRM},
2679 	{USB_DEVICE(ANALOG_VID,	EAGLE_I_PID_PSTFIRM),
2680 		.driver_info = EAGLE_I | PSTFIRM},
2681 	{USB_DEVICE(ANALOG_VID,	EAGLE_II_PID_PREFIRM),
2682 		.driver_info = EAGLE_II | PREFIRM},
2683 	{USB_DEVICE(ANALOG_VID,	EAGLE_II_PID_PSTFIRM),
2684 		.driver_info = EAGLE_II | PSTFIRM},
2685 	{USB_DEVICE(ANALOG_VID,	EAGLE_IIC_PID_PREFIRM),
2686 		.driver_info = EAGLE_II | PREFIRM},
2687 	{USB_DEVICE(ANALOG_VID,	EAGLE_IIC_PID_PSTFIRM),
2688 		.driver_info = EAGLE_II | PSTFIRM},
2689 	{USB_DEVICE(ANALOG_VID,	EAGLE_III_PID_PREFIRM),
2690 		.driver_info = EAGLE_III | PREFIRM},
2691 	{USB_DEVICE(ANALOG_VID,	EAGLE_III_PID_PSTFIRM),
2692 		.driver_info = EAGLE_III | PSTFIRM},
2693 	{USB_DEVICE(ANALOG_VID,	EAGLE_IV_PID_PREFIRM),
2694 		.driver_info = EAGLE_IV | PREFIRM},
2695 	{USB_DEVICE(ANALOG_VID,	EAGLE_IV_PID_PSTFIRM),
2696 		.driver_info = EAGLE_IV | PSTFIRM},
2697 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_I_A_PID_PREFIRM),
2698 		.driver_info = EAGLE_I | PREFIRM},
2699 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_I_A_PID_PSTFIRM),
2700 		.driver_info = EAGLE_I | PSTFIRM | AUTO_ANNEX_A},
2701 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_I_B_PID_PREFIRM),
2702 		.driver_info = EAGLE_I | PREFIRM},
2703 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_I_B_PID_PSTFIRM),
2704 		.driver_info = EAGLE_I | PSTFIRM | AUTO_ANNEX_B},
2705 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_II_A_PID_PREFIRM),
2706 		.driver_info = EAGLE_II | PREFIRM},
2707 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_II_A_PID_PSTFIRM),
2708 		.driver_info = EAGLE_II | PSTFIRM | AUTO_ANNEX_A},
2709 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_II_B_PID_PREFIRM),
2710 		.driver_info = EAGLE_II | PREFIRM},
2711 	{USB_DEVICE(DEVOLO_VID,	DEVOLO_EAGLE_II_B_PID_PSTFIRM),
2712 		.driver_info = EAGLE_II | PSTFIRM | AUTO_ANNEX_B},
2713 	{USB_DEVICE(ELSA_VID,	ELSA_PID_PREFIRM),
2714 		.driver_info = ADI930 | PREFIRM},
2715 	{USB_DEVICE(ELSA_VID,	ELSA_PID_PSTFIRM),
2716 		.driver_info = ADI930 | PSTFIRM},
2717 	{USB_DEVICE(ELSA_VID,	ELSA_PID_A_PREFIRM),
2718 		.driver_info = ADI930 | PREFIRM},
2719 	{USB_DEVICE(ELSA_VID,	ELSA_PID_A_PSTFIRM),
2720 		.driver_info = ADI930 | PSTFIRM | AUTO_ANNEX_A},
2721 	{USB_DEVICE(ELSA_VID,	ELSA_PID_B_PREFIRM),
2722 		.driver_info = ADI930 | PREFIRM},
2723 	{USB_DEVICE(ELSA_VID,	ELSA_PID_B_PSTFIRM),
2724 		.driver_info = ADI930 | PSTFIRM | AUTO_ANNEX_B},
2725 	{USB_DEVICE(USR_VID,	MILLER_A_PID_PREFIRM),
2726 		.driver_info = EAGLE_I | PREFIRM},
2727 	{USB_DEVICE(USR_VID,	MILLER_A_PID_PSTFIRM),
2728 		.driver_info = EAGLE_I | PSTFIRM  | AUTO_ANNEX_A},
2729 	{USB_DEVICE(USR_VID,	MILLER_B_PID_PREFIRM),
2730 		.driver_info = EAGLE_I | PREFIRM},
2731 	{USB_DEVICE(USR_VID,	MILLER_B_PID_PSTFIRM),
2732 		.driver_info = EAGLE_I | PSTFIRM  | AUTO_ANNEX_B},
2733 	{USB_DEVICE(USR_VID,	HEINEKEN_A_PID_PREFIRM),
2734 		.driver_info = EAGLE_I | PREFIRM},
2735 	{USB_DEVICE(USR_VID,	HEINEKEN_A_PID_PSTFIRM),
2736 		.driver_info = EAGLE_I | PSTFIRM | AUTO_ANNEX_A},
2737 	{USB_DEVICE(USR_VID,	HEINEKEN_B_PID_PREFIRM),
2738 		.driver_info = EAGLE_I | PREFIRM},
2739 	{USB_DEVICE(USR_VID,	HEINEKEN_B_PID_PSTFIRM),
2740 		.driver_info = EAGLE_I | PSTFIRM | AUTO_ANNEX_B},
2741 	{}
2742 };
2743 
2744 /*
2745  * USB driver descriptor
2746  */
2747 static struct usb_driver uea_driver = {
2748 	.name = "ueagle-atm",
2749 	.id_table = uea_ids,
2750 	.probe = uea_probe,
2751 	.disconnect = uea_disconnect,
2752 };
2753 
2754 MODULE_DEVICE_TABLE(usb, uea_ids);
2755 
2756 /**
2757  * uea_init - Initialize the module.
2758  *      Register to USB subsystem
2759  */
2760 static int __init uea_init(void)
2761 {
2762 	printk(KERN_INFO "[ueagle-atm] driver " EAGLEUSBVERSION " loaded\n");
2763 
2764 	usb_register(&uea_driver);
2765 
2766 	return 0;
2767 }
2768 
2769 module_init(uea_init);
2770 
2771 /**
2772  * uea_exit  -  Destroy module
2773  *    Deregister with USB subsystem
2774  */
2775 static void __exit uea_exit(void)
2776 {
2777 	/*
2778 	 * This calls automatically the uea_disconnect method if necessary:
2779 	 */
2780 	usb_deregister(&uea_driver);
2781 
2782 	printk(KERN_INFO "[ueagle-atm] driver unloaded\n");
2783 }
2784 
2785 module_exit(uea_exit);
2786 
2787 MODULE_AUTHOR("Damien Bergamini/Matthieu Castet/Stanislaw W. Gruszka");
2788 MODULE_DESCRIPTION("ADI 930/Eagle USB ADSL Modem driver");
2789 MODULE_LICENSE("Dual BSD/GPL");
2790