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