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