drivers/usb/atm/ueagle-atm.c

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