drivers/usb/atm/cxacru.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /******************************************************************************
   3  *  cxacru.c  -  driver for USB ADSL modems based on
   4  *               Conexant AccessRunner chipset
   5  *
   6  *  Copyright (C) 2004 David Woodhouse, Duncan Sands, Roman Kagan
   7  *  Copyright (C) 2005 Duncan Sands, Roman Kagan (rkagan % mail ! ru)
   8  *  Copyright (C) 2007 Simon Arlott
   9  *  Copyright (C) 2009 Simon Arlott
  10  ******************************************************************************/
  11
  12 /*
  13  *  Credit is due for Josep Comas, who created the original patch to speedtch.c
  14  *  to support the different padding used by the AccessRunner (now generalized
  15  *  into usbatm), and the userspace firmware loading utility.
  16  */
  17
  18 #include <linux/module.h>
  19 #include <linux/moduleparam.h>
  20 #include <linux/kernel.h>
  21 #include <linux/timer.h>
  22 #include <linux/errno.h>
  23 #include <linux/slab.h>
  24 #include <linux/device.h>
  25 #include <linux/firmware.h>
  26 #include <linux/mutex.h>
  27 #include <asm/unaligned.h>
  28
  29 #include "usbatm.h"
  30
  31 #define DRIVER_AUTHOR   "Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
  32 #define DRIVER_DESC     "Conexant AccessRunner ADSL USB modem driver"
  33
  34 static const char cxacru_driver_name[] = "cxacru";
  35
  36 #define CXACRU_EP_CMD           0x01    /* Bulk/interrupt in/out */
  37 #define CXACRU_EP_DATA          0x02    /* Bulk in/out */
  38
  39 #define CMD_PACKET_SIZE         64      /* Should be maxpacket(ep)? */
  40 #define CMD_MAX_CONFIG          ((CMD_PACKET_SIZE / 4 - 1) / 2)
  41
  42 /* Addresses */
  43 #define PLLFCLK_ADDR    0x00350068
  44 #define PLLBCLK_ADDR    0x0035006c
  45 #define SDRAMEN_ADDR    0x00350010
  46 #define FW_ADDR         0x00801000
  47 #define BR_ADDR         0x00180600
  48 #define SIG_ADDR        0x00180500
  49 #define BR_STACK_ADDR   0x00187f10
  50
  51 /* Values */
  52 #define SDRAM_ENA       0x1
  53
  54 #define CMD_TIMEOUT     2000    /* msecs */
  55 #define POLL_INTERVAL   1       /* secs */
  56
  57 /* commands for interaction with the modem through the control channel before
  58  * firmware is loaded  */
  59 enum cxacru_fw_request {
  60         FW_CMD_ERR,
  61         FW_GET_VER,
  62         FW_READ_MEM,
  63         FW_WRITE_MEM,
  64         FW_RMW_MEM,
  65         FW_CHECKSUM_MEM,
  66         FW_GOTO_MEM,
  67 };
  68
  69 /* commands for interaction with the modem through the control channel once
  70  * firmware is loaded  */
  71 enum cxacru_cm_request {
  72         CM_REQUEST_UNDEFINED = 0x80,
  73         CM_REQUEST_TEST,
  74         CM_REQUEST_CHIP_GET_MAC_ADDRESS,
  75         CM_REQUEST_CHIP_GET_DP_VERSIONS,
  76         CM_REQUEST_CHIP_ADSL_LINE_START,
  77         CM_REQUEST_CHIP_ADSL_LINE_STOP,
  78         CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
  79         CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
  80         CM_REQUEST_CARD_INFO_GET,
  81         CM_REQUEST_CARD_DATA_GET,
  82         CM_REQUEST_CARD_DATA_SET,
  83         CM_REQUEST_COMMAND_HW_IO,
  84         CM_REQUEST_INTERFACE_HW_IO,
  85         CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
  86         CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
  87         CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
  88         CM_REQUEST_CARD_GET_STATUS,
  89         CM_REQUEST_CARD_GET_MAC_ADDRESS,
  90         CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
  91         CM_REQUEST_MAX,
  92 };
  93
  94 /* commands for interaction with the flash memory
  95  *
  96  * read:  response is the contents of the first 60 bytes of flash memory
  97  * write: request contains the 60 bytes of data to write to flash memory
  98  *        response is the contents of the first 60 bytes of flash memory
  99  *
 100  * layout: PP PP VV VV  MM MM MM MM  MM MM ?? ??  SS SS SS SS  SS SS SS SS
 101  *         SS SS SS SS  SS SS SS SS  00 00 00 00  00 00 00 00  00 00 00 00
 102  *         00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
 103  *
 104  *   P: le16  USB Product ID
 105  *   V: le16  USB Vendor ID
 106  *   M: be48  MAC Address
 107  *   S: le16  ASCII Serial Number
 108  */
 109 enum cxacru_cm_flash {
 110         CM_FLASH_READ = 0xa1,
 111         CM_FLASH_WRITE = 0xa2
 112 };
 113
 114 /* reply codes to the commands above */
 115 enum cxacru_cm_status {
 116         CM_STATUS_UNDEFINED,
 117         CM_STATUS_SUCCESS,
 118         CM_STATUS_ERROR,
 119         CM_STATUS_UNSUPPORTED,
 120         CM_STATUS_UNIMPLEMENTED,
 121         CM_STATUS_PARAMETER_ERROR,
 122         CM_STATUS_DBG_LOOPBACK,
 123         CM_STATUS_MAX,
 124 };
 125
 126 /* indices into CARD_INFO_GET return array */
 127 enum cxacru_info_idx {
 128         CXINF_DOWNSTREAM_RATE,
 129         CXINF_UPSTREAM_RATE,
 130         CXINF_LINK_STATUS,
 131         CXINF_LINE_STATUS,
 132         CXINF_MAC_ADDRESS_HIGH,
 133         CXINF_MAC_ADDRESS_LOW,
 134         CXINF_UPSTREAM_SNR_MARGIN,
 135         CXINF_DOWNSTREAM_SNR_MARGIN,
 136         CXINF_UPSTREAM_ATTENUATION,
 137         CXINF_DOWNSTREAM_ATTENUATION,
 138         CXINF_TRANSMITTER_POWER,
 139         CXINF_UPSTREAM_BITS_PER_FRAME,
 140         CXINF_DOWNSTREAM_BITS_PER_FRAME,
 141         CXINF_STARTUP_ATTEMPTS,
 142         CXINF_UPSTREAM_CRC_ERRORS,
 143         CXINF_DOWNSTREAM_CRC_ERRORS,
 144         CXINF_UPSTREAM_FEC_ERRORS,
 145         CXINF_DOWNSTREAM_FEC_ERRORS,
 146         CXINF_UPSTREAM_HEC_ERRORS,
 147         CXINF_DOWNSTREAM_HEC_ERRORS,
 148         CXINF_LINE_STARTABLE,
 149         CXINF_MODULATION,
 150         CXINF_ADSL_HEADEND,
 151         CXINF_ADSL_HEADEND_ENVIRONMENT,
 152         CXINF_CONTROLLER_VERSION,
 153         /* dunno what the missing two mean */
 154         CXINF_MAX = 0x1c,
 155 };
 156
 157 enum cxacru_poll_state {
 158         CXPOLL_STOPPING,
 159         CXPOLL_STOPPED,
 160         CXPOLL_POLLING,
 161         CXPOLL_SHUTDOWN
 162 };
 163
 164 struct cxacru_modem_type {
 165         u32 pll_f_clk;
 166         u32 pll_b_clk;
 167         int boot_rom_patch;
 168 };
 169
 170 struct cxacru_data {
 171         struct usbatm_data *usbatm;
 172
 173         const struct cxacru_modem_type *modem_type;
 174
 175         int line_status;
 176         struct mutex adsl_state_serialize;
 177         int adsl_status;
 178         struct delayed_work poll_work;
 179         u32 card_info[CXINF_MAX];
 180         struct mutex poll_state_serialize;
 181         enum cxacru_poll_state poll_state;
 182
 183         /* contol handles */
 184         struct mutex cm_serialize;
 185         u8 *rcv_buf;
 186         u8 *snd_buf;
 187         struct urb *rcv_urb;
 188         struct urb *snd_urb;
 189         struct completion rcv_done;
 190         struct completion snd_done;
 191 };
 192
 193 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
 194         u8 *wdata, int wsize, u8 *rdata, int rsize);
 195 static void cxacru_poll_status(struct work_struct *work);
 196
 197 /* Card info exported through sysfs */
 198 #define CXACRU__ATTR_INIT(_name) \
 199 static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
 200
 201 #define CXACRU_CMD_INIT(_name) \
 202 static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
 203         cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
 204
 205 #define CXACRU_SET_INIT(_name) \
 206 static DEVICE_ATTR(_name, S_IWUSR, \
 207         NULL, cxacru_sysfs_store_##_name)
 208
 209 #define CXACRU_ATTR_INIT(_value, _type, _name) \
 210 static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
 211         struct device_attribute *attr, char *buf) \
 212 { \
 213         struct cxacru_data *instance = to_usbatm_driver_data(\
 214                 to_usb_interface(dev)); \
 215 \
 216         if (instance == NULL) \
 217                 return -ENODEV; \
 218 \
 219         return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
 220 } \
 221 CXACRU__ATTR_INIT(_name)
 222
 223 #define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
 224 #define CXACRU_CMD_CREATE(_name)          CXACRU_DEVICE_CREATE_FILE(_name)
 225 #define CXACRU_SET_CREATE(_name)          CXACRU_DEVICE_CREATE_FILE(_name)
 226 #define CXACRU__ATTR_CREATE(_name)        CXACRU_DEVICE_CREATE_FILE(_name)
 227
 228 #define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
 229 #define CXACRU_CMD_REMOVE(_name)          CXACRU_DEVICE_REMOVE_FILE(_name)
 230 #define CXACRU_SET_REMOVE(_name)          CXACRU_DEVICE_REMOVE_FILE(_name)
 231 #define CXACRU__ATTR_REMOVE(_name)        CXACRU_DEVICE_REMOVE_FILE(_name)
 232
 233 static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
 234 {
 235         return snprintf(buf, PAGE_SIZE, "%u\n", value);
 236 }
 237
 238 static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
 239 {
 240         return snprintf(buf, PAGE_SIZE, "%d\n", value);
 241 }
 242
 243 static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
 244 {
 245         if (likely(value >= 0)) {
 246                 return snprintf(buf, PAGE_SIZE, "%u.%02u\n",
 247                                         value / 100, value % 100);
 248         } else {
 249                 value = -value;
 250                 return snprintf(buf, PAGE_SIZE, "-%u.%02u\n",
 251                                         value / 100, value % 100);
 252         }
 253 }
 254
 255 static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
 256 {
 257         static char *str[] = { "no", "yes" };
 258
 259         if (unlikely(value >= ARRAY_SIZE(str)))
 260                 return snprintf(buf, PAGE_SIZE, "%u\n", value);
 261         return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
 262 }
 263
 264 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
 265 {
 266         static char *str[] = { NULL, "not connected", "connected", "lost" };
 267
 268         if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
 269                 return snprintf(buf, PAGE_SIZE, "%u\n", value);
 270         return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
 271 }
 272
 273 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
 274 {
 275         static char *str[] = { "down", "attempting to activate",
 276                 "training", "channel analysis", "exchange", "up",
 277                 "waiting", "initialising"
 278         };
 279         if (unlikely(value >= ARRAY_SIZE(str)))
 280                 return snprintf(buf, PAGE_SIZE, "%u\n", value);
 281         return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
 282 }
 283
 284 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
 285 {
 286         static char *str[] = {
 287                         "",
 288                         "ANSI T1.413",
 289                         "ITU-T G.992.1 (G.DMT)",
 290                         "ITU-T G.992.2 (G.LITE)"
 291         };
 292         if (unlikely(value >= ARRAY_SIZE(str)))
 293                 return snprintf(buf, PAGE_SIZE, "%u\n", value);
 294         return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
 295 }
 296
 297 /*
 298  * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
 299  * this data is already in atm_dev there's no point.
 300  *
 301  * MAC_ADDRESS_HIGH = 0x????5544
 302  * MAC_ADDRESS_LOW  = 0x33221100
 303  * Where 00-55 are bytes 0-5 of the MAC.
 304  */
 305 static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
 306         struct device_attribute *attr, char *buf)
 307 {
 308         struct cxacru_data *instance = to_usbatm_driver_data(
 309                         to_usb_interface(dev));
 310
 311         if (instance == NULL || instance->usbatm->atm_dev == NULL)
 312                 return -ENODEV;
 313
 314         return snprintf(buf, PAGE_SIZE, "%pM\n",
 315                 instance->usbatm->atm_dev->esi);
 316 }
 317
 318 static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
 319         struct device_attribute *attr, char *buf)
 320 {
 321         static char *str[] = { "running", "stopped" };
 322         struct cxacru_data *instance = to_usbatm_driver_data(
 323                         to_usb_interface(dev));
 324         u32 value;
 325
 326         if (instance == NULL)
 327                 return -ENODEV;
 328
 329         value = instance->card_info[CXINF_LINE_STARTABLE];
 330         if (unlikely(value >= ARRAY_SIZE(str)))
 331                 return snprintf(buf, PAGE_SIZE, "%u\n", value);
 332         return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
 333 }
 334
 335 static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
 336         struct device_attribute *attr, const char *buf, size_t count)
 337 {
 338         struct cxacru_data *instance = to_usbatm_driver_data(
 339                         to_usb_interface(dev));
 340         int ret;
 341         int poll = -1;
 342         char str_cmd[8];
 343         int len = strlen(buf);
 344
 345         if (!capable(CAP_NET_ADMIN))
 346                 return -EACCES;
 347
 348         ret = sscanf(buf, "%7s", str_cmd);
 349         if (ret != 1)
 350                 return -EINVAL;
 351         ret = 0;
 352
 353         if (instance == NULL)
 354                 return -ENODEV;
 355
 356         if (mutex_lock_interruptible(&instance->adsl_state_serialize))
 357                 return -ERESTARTSYS;
 358
 359         if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
 360                 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
 361                 if (ret < 0) {
 362                         atm_err(instance->usbatm, "change adsl state:"
 363                                 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
 364
 365                         ret = -EIO;
 366                 } else {
 367                         ret = len;
 368                         poll = CXPOLL_STOPPED;
 369                 }
 370         }
 371
 372         /* Line status is only updated every second
 373          * and the device appears to only react to
 374          * START/STOP every second too. Wait 1.5s to
 375          * be sure that restart will have an effect. */
 376         if (!strcmp(str_cmd, "restart"))
 377                 msleep(1500);
 378
 379         if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
 380                 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
 381                 if (ret < 0) {
 382                         atm_err(instance->usbatm, "change adsl state:"
 383                                 " CHIP_ADSL_LINE_START returned %d\n", ret);
 384
 385                         ret = -EIO;
 386                 } else {
 387                         ret = len;
 388                         poll = CXPOLL_POLLING;
 389                 }
 390         }
 391
 392         if (!strcmp(str_cmd, "poll")) {
 393                 ret = len;
 394                 poll = CXPOLL_POLLING;
 395         }
 396
 397         if (ret == 0) {
 398                 ret = -EINVAL;
 399                 poll = -1;
 400         }
 401
 402         if (poll == CXPOLL_POLLING) {
 403                 mutex_lock(&instance->poll_state_serialize);
 404                 switch (instance->poll_state) {
 405                 case CXPOLL_STOPPED:
 406                         /* start polling */
 407                         instance->poll_state = CXPOLL_POLLING;
 408                         break;
 409
 410                 case CXPOLL_STOPPING:
 411                         /* abort stop request */
 412                         instance->poll_state = CXPOLL_POLLING;
 413                         /* fall through */
 414                 case CXPOLL_POLLING:
 415                 case CXPOLL_SHUTDOWN:
 416                         /* don't start polling */
 417                         poll = -1;
 418                 }
 419                 mutex_unlock(&instance->poll_state_serialize);
 420         } else if (poll == CXPOLL_STOPPED) {
 421                 mutex_lock(&instance->poll_state_serialize);
 422                 /* request stop */
 423                 if (instance->poll_state == CXPOLL_POLLING)
 424                         instance->poll_state = CXPOLL_STOPPING;
 425                 mutex_unlock(&instance->poll_state_serialize);
 426         }
 427
 428         mutex_unlock(&instance->adsl_state_serialize);
 429
 430         if (poll == CXPOLL_POLLING)
 431                 cxacru_poll_status(&instance->poll_work.work);
 432
 433         return ret;
 434 }
 435
 436 /* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
 437
 438 static ssize_t cxacru_sysfs_store_adsl_config(struct device *dev,
 439         struct device_attribute *attr, const char *buf, size_t count)
 440 {
 441         struct cxacru_data *instance = to_usbatm_driver_data(
 442                         to_usb_interface(dev));
 443         int len = strlen(buf);
 444         int ret, pos, num;
 445         __le32 data[CMD_PACKET_SIZE / 4];
 446
 447         if (!capable(CAP_NET_ADMIN))
 448                 return -EACCES;
 449
 450         if (instance == NULL)
 451                 return -ENODEV;
 452
 453         pos = 0;
 454         num = 0;
 455         while (pos < len) {
 456                 int tmp;
 457                 u32 index;
 458                 u32 value;
 459
 460                 ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
 461                 if (ret < 2)
 462                         return -EINVAL;
 463                 if (index > 0x7f)
 464                         return -EINVAL;
 465                 if (tmp < 0 || tmp > len - pos)
 466                         return -EINVAL;
 467                 pos += tmp;
 468
 469                 /* skip trailing newline */
 470                 if (buf[pos] == '\n' && pos == len-1)
 471                         pos++;
 472
 473                 data[num * 2 + 1] = cpu_to_le32(index);
 474                 data[num * 2 + 2] = cpu_to_le32(value);
 475                 num++;
 476
 477                 /* send config values when data buffer is full
 478                  * or no more data
 479                  */
 480                 if (pos >= len || num >= CMD_MAX_CONFIG) {
 481                         char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
 482
 483                         data[0] = cpu_to_le32(num);
 484                         ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
 485                                 (u8 *) data, 4 + num * 8, NULL, 0);
 486                         if (ret < 0) {
 487                                 atm_err(instance->usbatm,
 488                                         "set card data returned %d\n", ret);
 489                                 return -EIO;
 490                         }
 491
 492                         for (tmp = 0; tmp < num; tmp++)
 493                                 snprintf(log + tmp*12, 13, " %02x=%08x",
 494                                         le32_to_cpu(data[tmp * 2 + 1]),
 495                                         le32_to_cpu(data[tmp * 2 + 2]));
 496                         atm_info(instance->usbatm, "config%s\n", log);
 497                         num = 0;
 498                 }
 499         }
 500
 501         return len;
 502 }
 503
 504 /*
 505  * All device attributes are included in CXACRU_ALL_FILES
 506  * so that the same list can be used multiple times:
 507  *     INIT   (define the device attributes)
 508  *     CREATE (create all the device files)
 509  *     REMOVE (remove all the device files)
 510  *
 511  * With the last two being defined as needed in the functions
 512  * they are used in before calling CXACRU_ALL_FILES()
 513  */
 514 #define CXACRU_ALL_FILES(_action) \
 515 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE,           u32,  downstream_rate); \
 516 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE,             u32,  upstream_rate); \
 517 CXACRU_ATTR_##_action(CXINF_LINK_STATUS,               LINK, link_status); \
 518 CXACRU_ATTR_##_action(CXINF_LINE_STATUS,               LINE, line_status); \
 519 CXACRU__ATTR_##_action(                                      mac_address); \
 520 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN,       dB,   upstream_snr_margin); \
 521 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN,     dB,   downstream_snr_margin); \
 522 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION,      dB,   upstream_attenuation); \
 523 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION,    dB,   downstream_attenuation); \
 524 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER,         s8,   transmitter_power); \
 525 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME,   u32,  upstream_bits_per_frame); \
 526 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32,  downstream_bits_per_frame); \
 527 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS,          u32,  startup_attempts); \
 528 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS,       u32,  upstream_crc_errors); \
 529 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS,     u32,  downstream_crc_errors); \
 530 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS,       u32,  upstream_fec_errors); \
 531 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS,     u32,  downstream_fec_errors); \
 532 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS,       u32,  upstream_hec_errors); \
 533 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS,     u32,  downstream_hec_errors); \
 534 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE,            bool, line_startable); \
 535 CXACRU_ATTR_##_action(CXINF_MODULATION,                MODU, modulation); \
 536 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND,              u32,  adsl_headend); \
 537 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT,  u32,  adsl_headend_environment); \
 538 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION,        u32,  adsl_controller_version); \
 539 CXACRU_CMD_##_action(                                        adsl_state); \
 540 CXACRU_SET_##_action(                                        adsl_config);
 541
 542 CXACRU_ALL_FILES(INIT);
 543
 544 /* the following three functions are stolen from drivers/usb/core/message.c */
 545 static void cxacru_blocking_completion(struct urb *urb)
 546 {
 547         complete(urb->context);
 548 }
 549
 550 static void cxacru_timeout_kill(unsigned long data)
 551 {
 552         usb_unlink_urb((struct urb *) data);
 553 }
 554
 555 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
 556                                  int *actual_length)
 557 {
 558         struct timer_list timer;
 559
 560         setup_timer(&timer, cxacru_timeout_kill, (unsigned long)urb);
 561         timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
 562         add_timer(&timer);
 563         wait_for_completion(done);
 564         del_timer_sync(&timer);
 565
 566         if (actual_length)
 567                 *actual_length = urb->actual_length;
 568         return urb->status; /* must read status after completion */
 569 }
 570
 571 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
 572                      u8 *wdata, int wsize, u8 *rdata, int rsize)
 573 {
 574         int ret, actlen;
 575         int offb, offd;
 576         const int stride = CMD_PACKET_SIZE - 4;
 577         u8 *wbuf = instance->snd_buf;
 578         u8 *rbuf = instance->rcv_buf;
 579         int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
 580         int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
 581
 582         if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
 583                 if (printk_ratelimit())
 584                         usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
 585                                 wbuflen, rbuflen);
 586                 ret = -ENOMEM;
 587                 goto err;
 588         }
 589
 590         mutex_lock(&instance->cm_serialize);
 591
 592         /* submit reading urb before the writing one */
 593         init_completion(&instance->rcv_done);
 594         ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
 595         if (ret < 0) {
 596                 if (printk_ratelimit())
 597                         usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
 598                                 cm, ret);
 599                 goto fail;
 600         }
 601
 602         memset(wbuf, 0, wbuflen);
 603         /* handle wsize == 0 */
 604         wbuf[0] = cm;
 605         for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
 606                 wbuf[offb] = cm;
 607                 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
 608         }
 609
 610         instance->snd_urb->transfer_buffer_length = wbuflen;
 611         init_completion(&instance->snd_done);
 612         ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
 613         if (ret < 0) {
 614                 if (printk_ratelimit())
 615                         usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
 616                                 cm, ret);
 617                 goto fail;
 618         }
 619
 620         ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
 621         if (ret < 0) {
 622                 if (printk_ratelimit())
 623                         usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
 624                 goto fail;
 625         }
 626
 627         ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
 628         if (ret < 0) {
 629                 if (printk_ratelimit())
 630                         usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
 631                 goto fail;
 632         }
 633         if (actlen % CMD_PACKET_SIZE || !actlen) {
 634                 if (printk_ratelimit())
 635                         usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
 636                                 cm, actlen);
 637                 ret = -EIO;
 638                 goto fail;
 639         }
 640
 641         /* check the return status and copy the data to the output buffer, if needed */
 642         for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
 643                 if (rbuf[offb] != cm) {
 644                         if (printk_ratelimit())
 645                                 usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
 646                                         rbuf[offb], cm);
 647                         ret = -EIO;
 648                         goto fail;
 649                 }
 650                 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
 651                         if (printk_ratelimit())
 652                                 usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
 653                                         cm, rbuf[offb + 1]);
 654                         ret = -EIO;
 655                         goto fail;
 656                 }
 657                 if (offd >= rsize)
 658                         break;
 659                 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
 660                 offd += stride;
 661         }
 662
 663         ret = offd;
 664         usb_dbg(instance->usbatm, "cm %#x\n", cm);
 665 fail:
 666         mutex_unlock(&instance->cm_serialize);
 667 err:
 668         return ret;
 669 }
 670
 671 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
 672                                u32 *data, int size)
 673 {
 674         int ret, len;
 675         __le32 *buf;
 676         int offb;
 677         unsigned int offd;
 678         const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
 679         int buflen =  ((size - 1) / stride + 1 + size * 2) * 4;
 680
 681         buf = kmalloc(buflen, GFP_KERNEL);
 682         if (!buf)
 683                 return -ENOMEM;
 684
 685         ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
 686         if (ret < 0)
 687                 goto cleanup;
 688
 689         /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
 690         len = ret / 4;
 691         for (offb = 0; offb < len; ) {
 692                 int l = le32_to_cpu(buf[offb++]);
 693
 694                 if (l < 0 || l > stride || l > (len - offb) / 2) {
 695                         if (printk_ratelimit())
 696                                 usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
 697                                         cm, l);
 698                         ret = -EIO;
 699                         goto cleanup;
 700                 }
 701                 while (l--) {
 702                         offd = le32_to_cpu(buf[offb++]);
 703                         if (offd >= size) {
 704                                 if (printk_ratelimit())
 705                                         usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
 706                                                 offd, cm);
 707                                 ret = -EIO;
 708                                 goto cleanup;
 709                         }
 710                         data[offd] = le32_to_cpu(buf[offb++]);
 711                 }
 712         }
 713
 714         ret = 0;
 715
 716 cleanup:
 717         kfree(buf);
 718         return ret;
 719 }
 720
 721 static int cxacru_card_status(struct cxacru_data *instance)
 722 {
 723         int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
 724
 725         if (ret < 0) {          /* firmware not loaded */
 726                 usb_dbg(instance->usbatm, "cxacru_adsl_start: CARD_GET_STATUS returned %d\n", ret);
 727                 return ret;
 728         }
 729         return 0;
 730 }
 731
 732 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
 733                 struct atm_dev *atm_dev)
 734 {
 735         struct usb_interface *intf = usbatm_instance->usb_intf;
 736
 737         #define CXACRU_DEVICE_REMOVE_FILE(_name) \
 738                 device_remove_file(&intf->dev, &dev_attr_##_name);
 739         CXACRU_ALL_FILES(REMOVE);
 740         #undef CXACRU_DEVICE_REMOVE_FILE
 741 }
 742
 743 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
 744                 struct atm_dev *atm_dev)
 745 {
 746         struct cxacru_data *instance = usbatm_instance->driver_data;
 747         struct usb_interface *intf = usbatm_instance->usb_intf;
 748         int ret;
 749         int start_polling = 1;
 750
 751         dev_dbg(&intf->dev, "%s\n", __func__);
 752
 753         /* Read MAC address */
 754         ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
 755                         atm_dev->esi, sizeof(atm_dev->esi));
 756         if (ret < 0) {
 757                 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
 758                 return ret;
 759         }
 760
 761         #define CXACRU_DEVICE_CREATE_FILE(_name) \
 762                 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
 763                 if (unlikely(ret)) \
 764                         goto fail_sysfs;
 765         CXACRU_ALL_FILES(CREATE);
 766         #undef CXACRU_DEVICE_CREATE_FILE
 767
 768         /* start ADSL */
 769         mutex_lock(&instance->adsl_state_serialize);
 770         ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
 771         if (ret < 0)
 772                 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
 773
 774         /* Start status polling */
 775         mutex_lock(&instance->poll_state_serialize);
 776         switch (instance->poll_state) {
 777         case CXPOLL_STOPPED:
 778                 /* start polling */
 779                 instance->poll_state = CXPOLL_POLLING;
 780                 break;
 781
 782         case CXPOLL_STOPPING:
 783                 /* abort stop request */
 784                 instance->poll_state = CXPOLL_POLLING;
 785                 /* fall through */
 786         case CXPOLL_POLLING:
 787         case CXPOLL_SHUTDOWN:
 788                 /* don't start polling */
 789                 start_polling = 0;
 790         }
 791         mutex_unlock(&instance->poll_state_serialize);
 792         mutex_unlock(&instance->adsl_state_serialize);
 793
 794         printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
 795                         usbatm_instance->description, atm_dev->esi);
 796
 797         if (start_polling)
 798                 cxacru_poll_status(&instance->poll_work.work);
 799         return 0;
 800
 801 fail_sysfs:
 802         usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
 803         cxacru_remove_device_files(usbatm_instance, atm_dev);
 804         return ret;
 805 }
 806
 807 static void cxacru_poll_status(struct work_struct *work)
 808 {
 809         struct cxacru_data *instance =
 810                 container_of(work, struct cxacru_data, poll_work.work);
 811         u32 buf[CXINF_MAX] = {};
 812         struct usbatm_data *usbatm = instance->usbatm;
 813         struct atm_dev *atm_dev = usbatm->atm_dev;
 814         int keep_polling = 1;
 815         int ret;
 816
 817         ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
 818         if (ret < 0) {
 819                 if (ret != -ESHUTDOWN)
 820                         atm_warn(usbatm, "poll status: error %d\n", ret);
 821
 822                 mutex_lock(&instance->poll_state_serialize);
 823                 if (instance->poll_state != CXPOLL_SHUTDOWN) {
 824                         instance->poll_state = CXPOLL_STOPPED;
 825
 826                         if (ret != -ESHUTDOWN)
 827                                 atm_warn(usbatm, "polling disabled, set adsl_state"
 828                                                 " to 'start' or 'poll' to resume\n");
 829                 }
 830                 mutex_unlock(&instance->poll_state_serialize);
 831                 goto reschedule;
 832         }
 833
 834         memcpy(instance->card_info, buf, sizeof(instance->card_info));
 835
 836         if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
 837                 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
 838
 839                 switch (instance->adsl_status) {
 840                 case 0:
 841                         atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
 842                         break;
 843
 844                 case 1:
 845                         atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
 846                         break;
 847
 848                 default:
 849                         atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
 850                         break;
 851                 }
 852         }
 853
 854         if (instance->line_status == buf[CXINF_LINE_STATUS])
 855                 goto reschedule;
 856
 857         instance->line_status = buf[CXINF_LINE_STATUS];
 858         switch (instance->line_status) {
 859         case 0:
 860                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 861                 atm_info(usbatm, "ADSL line: down\n");
 862                 break;
 863
 864         case 1:
 865                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 866                 atm_info(usbatm, "ADSL line: attempting to activate\n");
 867                 break;
 868
 869         case 2:
 870                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 871                 atm_info(usbatm, "ADSL line: training\n");
 872                 break;
 873
 874         case 3:
 875                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 876                 atm_info(usbatm, "ADSL line: channel analysis\n");
 877                 break;
 878
 879         case 4:
 880                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 881                 atm_info(usbatm, "ADSL line: exchange\n");
 882                 break;
 883
 884         case 5:
 885                 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
 886                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_FOUND);
 887
 888                 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
 889                      buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
 890                 break;
 891
 892         case 6:
 893                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 894                 atm_info(usbatm, "ADSL line: waiting\n");
 895                 break;
 896
 897         case 7:
 898                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
 899                 atm_info(usbatm, "ADSL line: initializing\n");
 900                 break;
 901
 902         default:
 903                 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
 904                 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
 905                 break;
 906         }
 907 reschedule:
 908
 909         mutex_lock(&instance->poll_state_serialize);
 910         if (instance->poll_state == CXPOLL_STOPPING &&
 911                                 instance->adsl_status == 1 && /* stopped */
 912                                 instance->line_status == 0) /* down */
 913                 instance->poll_state = CXPOLL_STOPPED;
 914
 915         if (instance->poll_state == CXPOLL_STOPPED)
 916                 keep_polling = 0;
 917         mutex_unlock(&instance->poll_state_serialize);
 918
 919         if (keep_polling)
 920                 schedule_delayed_work(&instance->poll_work,
 921                                 round_jiffies_relative(POLL_INTERVAL*HZ));
 922 }
 923
 924 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
 925                      u8 code1, u8 code2, u32 addr, const u8 *data, int size)
 926 {
 927         int ret;
 928         u8 *buf;
 929         int offd, offb;
 930         const int stride = CMD_PACKET_SIZE - 8;
 931
 932         buf = (u8 *) __get_free_page(GFP_KERNEL);
 933         if (!buf)
 934                 return -ENOMEM;
 935
 936         offb = offd = 0;
 937         do {
 938                 int l = min_t(int, stride, size - offd);
 939
 940                 buf[offb++] = fw;
 941                 buf[offb++] = l;
 942                 buf[offb++] = code1;
 943                 buf[offb++] = code2;
 944                 put_unaligned(cpu_to_le32(addr), (__le32 *)(buf + offb));
 945                 offb += 4;
 946                 addr += l;
 947                 if (l)
 948                         memcpy(buf + offb, data + offd, l);
 949                 if (l < stride)
 950                         memset(buf + offb + l, 0, stride - l);
 951                 offb += stride;
 952                 offd += stride;
 953                 if ((offb >= PAGE_SIZE) || (offd >= size)) {
 954                         ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
 955                                            buf, offb, NULL, CMD_TIMEOUT);
 956                         if (ret < 0) {
 957                                 dev_dbg(&usb_dev->dev, "sending fw %#x failed\n", fw);
 958                                 goto cleanup;
 959                         }
 960                         offb = 0;
 961                 }
 962         } while (offd < size);
 963         dev_dbg(&usb_dev->dev, "sent fw %#x\n", fw);
 964
 965         ret = 0;
 966
 967 cleanup:
 968         free_page((unsigned long) buf);
 969         return ret;
 970 }
 971
 972 static void cxacru_upload_firmware(struct cxacru_data *instance,
 973                                    const struct firmware *fw,
 974                                    const struct firmware *bp)
 975 {
 976         int ret;
 977         struct usbatm_data *usbatm = instance->usbatm;
 978         struct usb_device *usb_dev = usbatm->usb_dev;
 979         __le16 signature[] = { usb_dev->descriptor.idVendor,
 980                                usb_dev->descriptor.idProduct };
 981         __le32 val;
 982
 983         usb_dbg(usbatm, "%s\n", __func__);
 984
 985         /* FirmwarePllFClkValue */
 986         val = cpu_to_le32(instance->modem_type->pll_f_clk);
 987         ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
 988         if (ret) {
 989                 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
 990                 return;
 991         }
 992
 993         /* FirmwarePllBClkValue */
 994         val = cpu_to_le32(instance->modem_type->pll_b_clk);
 995         ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
 996         if (ret) {
 997                 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
 998                 return;
 999         }
1000
1001         /* Enable SDRAM */
1002         val = cpu_to_le32(SDRAM_ENA);
1003         ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
1004         if (ret) {
1005                 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
1006                 return;
1007         }
1008
1009         /* Firmware */
1010         usb_info(usbatm, "loading firmware\n");
1011         ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
1012         if (ret) {
1013                 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
1014                 return;
1015         }
1016
1017         /* Boot ROM patch */
1018         if (instance->modem_type->boot_rom_patch) {
1019                 usb_info(usbatm, "loading boot ROM patch\n");
1020                 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
1021                 if (ret) {
1022                         usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
1023                         return;
1024                 }
1025         }
1026
1027         /* Signature */
1028         ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
1029         if (ret) {
1030                 usb_err(usbatm, "Signature storing failed: %d\n", ret);
1031                 return;
1032         }
1033
1034         usb_info(usbatm, "starting device\n");
1035         if (instance->modem_type->boot_rom_patch) {
1036                 val = cpu_to_le32(BR_ADDR);
1037                 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
1038         } else {
1039                 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1040         }
1041         if (ret) {
1042                 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
1043                 return;
1044         }
1045
1046         /* Delay to allow firmware to start up. */
1047         msleep_interruptible(1000);
1048
1049         usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
1050         usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
1051         usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
1052         usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
1053
1054         ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1055         if (ret < 0) {
1056                 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
1057                 return;
1058         }
1059 }
1060
1061 static int cxacru_find_firmware(struct cxacru_data *instance,
1062                                 char *phase, const struct firmware **fw_p)
1063 {
1064         struct usbatm_data *usbatm = instance->usbatm;
1065         struct device *dev = &usbatm->usb_intf->dev;
1066         char buf[16];
1067
1068         sprintf(buf, "cxacru-%s.bin", phase);
1069         usb_dbg(usbatm, "cxacru_find_firmware: looking for %s\n", buf);
1070
1071         if (request_firmware(fw_p, buf, dev)) {
1072                 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
1073                 return -ENOENT;
1074         }
1075
1076         usb_info(usbatm, "found firmware %s\n", buf);
1077
1078         return 0;
1079 }
1080
1081 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1082                              struct usb_interface *usb_intf)
1083 {
1084         const struct firmware *fw, *bp;
1085         struct cxacru_data *instance = usbatm_instance->driver_data;
1086         int ret = cxacru_find_firmware(instance, "fw", &fw);
1087
1088         if (ret) {
1089                 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1090                 return ret;
1091         }
1092
1093         if (instance->modem_type->boot_rom_patch) {
1094                 ret = cxacru_find_firmware(instance, "bp", &bp);
1095                 if (ret) {
1096                         usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1097                         release_firmware(fw);
1098                         return ret;
1099                 }
1100         }
1101
1102         cxacru_upload_firmware(instance, fw, bp);
1103
1104         if (instance->modem_type->boot_rom_patch)
1105                 release_firmware(bp);
1106         release_firmware(fw);
1107
1108         ret = cxacru_card_status(instance);
1109         if (ret)
1110                 usb_dbg(usbatm_instance, "modem initialisation failed\n");
1111         else
1112                 usb_dbg(usbatm_instance, "done setting up the modem\n");
1113
1114         return ret;
1115 }
1116
1117 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1118                        struct usb_interface *intf, const struct usb_device_id *id)
1119 {
1120         struct cxacru_data *instance;
1121         struct usb_device *usb_dev = interface_to_usbdev(intf);
1122         struct usb_host_endpoint *cmd_ep = usb_dev->ep_in[CXACRU_EP_CMD];
1123         int ret;
1124
1125         /* instance init */
1126         instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1127         if (!instance)
1128                 return -ENOMEM;
1129
1130         instance->usbatm = usbatm_instance;
1131         instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1132
1133         mutex_init(&instance->poll_state_serialize);
1134         instance->poll_state = CXPOLL_STOPPED;
1135         instance->line_status = -1;
1136         instance->adsl_status = -1;
1137
1138         mutex_init(&instance->adsl_state_serialize);
1139
1140         instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1141         if (!instance->rcv_buf) {
1142                 usb_dbg(usbatm_instance, "cxacru_bind: no memory for rcv_buf\n");
1143                 ret = -ENOMEM;
1144                 goto fail;
1145         }
1146         instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1147         if (!instance->snd_buf) {
1148                 usb_dbg(usbatm_instance, "cxacru_bind: no memory for snd_buf\n");
1149                 ret = -ENOMEM;
1150                 goto fail;
1151         }
1152         instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1153         if (!instance->rcv_urb) {
1154                 ret = -ENOMEM;
1155                 goto fail;
1156         }
1157         instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1158         if (!instance->snd_urb) {
1159                 ret = -ENOMEM;
1160                 goto fail;
1161         }
1162
1163         if (!cmd_ep) {
1164                 usb_dbg(usbatm_instance, "cxacru_bind: no command endpoint\n");
1165                 ret = -ENODEV;
1166                 goto fail;
1167         }
1168
1169         if ((cmd_ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1170                         == USB_ENDPOINT_XFER_INT) {
1171                 usb_fill_int_urb(instance->rcv_urb,
1172                         usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1173                         instance->rcv_buf, PAGE_SIZE,
1174                         cxacru_blocking_completion, &instance->rcv_done, 1);
1175
1176                 usb_fill_int_urb(instance->snd_urb,
1177                         usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1178                         instance->snd_buf, PAGE_SIZE,
1179                         cxacru_blocking_completion, &instance->snd_done, 4);
1180         } else {
1181                 usb_fill_bulk_urb(instance->rcv_urb,
1182                         usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD),
1183                         instance->rcv_buf, PAGE_SIZE,
1184                         cxacru_blocking_completion, &instance->rcv_done);
1185
1186                 usb_fill_bulk_urb(instance->snd_urb,
1187                         usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
1188                         instance->snd_buf, PAGE_SIZE,
1189                         cxacru_blocking_completion, &instance->snd_done);
1190         }
1191
1192         mutex_init(&instance->cm_serialize);
1193
1194         INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1195
1196         usbatm_instance->driver_data = instance;
1197
1198         usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1199
1200         return 0;
1201
1202  fail:
1203         free_page((unsigned long) instance->snd_buf);
1204         free_page((unsigned long) instance->rcv_buf);
1205         usb_free_urb(instance->snd_urb);
1206         usb_free_urb(instance->rcv_urb);
1207         kfree(instance);
1208
1209         return ret;
1210 }
1211
1212 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1213                 struct usb_interface *intf)
1214 {
1215         struct cxacru_data *instance = usbatm_instance->driver_data;
1216         int is_polling = 1;
1217
1218         usb_dbg(usbatm_instance, "cxacru_unbind entered\n");
1219
1220         if (!instance) {
1221                 usb_dbg(usbatm_instance, "cxacru_unbind: NULL instance!\n");
1222                 return;
1223         }
1224
1225         mutex_lock(&instance->poll_state_serialize);
1226         BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1227
1228         /* ensure that status polling continues unless
1229          * it has already stopped */
1230         if (instance->poll_state == CXPOLL_STOPPED)
1231                 is_polling = 0;
1232
1233         /* stop polling from being stopped or started */
1234         instance->poll_state = CXPOLL_SHUTDOWN;
1235         mutex_unlock(&instance->poll_state_serialize);
1236
1237         if (is_polling)
1238                 cancel_delayed_work_sync(&instance->poll_work);
1239
1240         usb_kill_urb(instance->snd_urb);
1241         usb_kill_urb(instance->rcv_urb);
1242         usb_free_urb(instance->snd_urb);
1243         usb_free_urb(instance->rcv_urb);
1244
1245         free_page((unsigned long) instance->snd_buf);
1246         free_page((unsigned long) instance->rcv_buf);
1247
1248         kfree(instance);
1249
1250         usbatm_instance->driver_data = NULL;
1251 }
1252
1253 static const struct cxacru_modem_type cxacru_cafe = {
1254         .pll_f_clk = 0x02d874df,
1255         .pll_b_clk = 0x0196a51a,
1256         .boot_rom_patch = 1,
1257 };
1258
1259 static const struct cxacru_modem_type cxacru_cb00 = {
1260         .pll_f_clk = 0x5,
1261         .pll_b_clk = 0x3,
1262         .boot_rom_patch = 0,
1263 };
1264
1265 static const struct usb_device_id cxacru_usb_ids[] = {
1266         { /* V = Conexant                       P = ADSL modem (Euphrates project)      */
1267                 USB_DEVICE(0x0572, 0xcafe),     .driver_info = (unsigned long) &cxacru_cafe
1268         },
1269         { /* V = Conexant                       P = ADSL modem (Hasbani project)        */
1270                 USB_DEVICE(0x0572, 0xcb00),     .driver_info = (unsigned long) &cxacru_cb00
1271         },
1272         { /* V = Conexant                       P = ADSL modem                          */
1273                 USB_DEVICE(0x0572, 0xcb01),     .driver_info = (unsigned long) &cxacru_cb00
1274         },
1275         { /* V = Conexant                       P = ADSL modem (Well PTI-800) */
1276                 USB_DEVICE(0x0572, 0xcb02),     .driver_info = (unsigned long) &cxacru_cb00
1277         },
1278         { /* V = Conexant                       P = ADSL modem                          */
1279                 USB_DEVICE(0x0572, 0xcb06),     .driver_info = (unsigned long) &cxacru_cb00
1280         },
1281         { /* V = Conexant                       P = ADSL modem (ZTE ZXDSL 852)          */
1282                 USB_DEVICE(0x0572, 0xcb07),     .driver_info = (unsigned long) &cxacru_cb00
1283         },
1284         { /* V = Olitec                         P = ADSL modem version 2                */
1285                 USB_DEVICE(0x08e3, 0x0100),     .driver_info = (unsigned long) &cxacru_cafe
1286         },
1287         { /* V = Olitec                         P = ADSL modem version 3                */
1288                 USB_DEVICE(0x08e3, 0x0102),     .driver_info = (unsigned long) &cxacru_cb00
1289         },
1290         { /* V = Trust/Amigo Technology Co.     P = AMX-CA86U                           */
1291                 USB_DEVICE(0x0eb0, 0x3457),     .driver_info = (unsigned long) &cxacru_cafe
1292         },
1293         { /* V = Zoom                           P = 5510                                */
1294                 USB_DEVICE(0x1803, 0x5510),     .driver_info = (unsigned long) &cxacru_cb00
1295         },
1296         { /* V = Draytek                        P = Vigor 318                           */
1297                 USB_DEVICE(0x0675, 0x0200),     .driver_info = (unsigned long) &cxacru_cb00
1298         },
1299         { /* V = Zyxel                          P = 630-C1 aka OMNI ADSL USB (Annex A)  */
1300                 USB_DEVICE(0x0586, 0x330a),     .driver_info = (unsigned long) &cxacru_cb00
1301         },
1302         { /* V = Zyxel                          P = 630-C3 aka OMNI ADSL USB (Annex B)  */
1303                 USB_DEVICE(0x0586, 0x330b),     .driver_info = (unsigned long) &cxacru_cb00
1304         },
1305         { /* V = Aethra                         P = Starmodem UM1020                    */
1306                 USB_DEVICE(0x0659, 0x0020),     .driver_info = (unsigned long) &cxacru_cb00
1307         },
1308         { /* V = Aztech Systems                 P = ? AKA Pirelli AUA-010               */
1309                 USB_DEVICE(0x0509, 0x0812),     .driver_info = (unsigned long) &cxacru_cb00
1310         },
1311         { /* V = Netopia                        P = Cayman 3341(Annex A)/3351(Annex B)  */
1312                 USB_DEVICE(0x100d, 0xcb01),     .driver_info = (unsigned long) &cxacru_cb00
1313         },
1314         { /* V = Netopia                        P = Cayman 3342(Annex A)/3352(Annex B)  */
1315                 USB_DEVICE(0x100d, 0x3342),     .driver_info = (unsigned long) &cxacru_cb00
1316         },
1317         {}
1318 };
1319
1320 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1321
1322 static struct usbatm_driver cxacru_driver = {
1323         .driver_name    = cxacru_driver_name,
1324         .bind           = cxacru_bind,
1325         .heavy_init     = cxacru_heavy_init,
1326         .unbind         = cxacru_unbind,
1327         .atm_start      = cxacru_atm_start,
1328         .atm_stop       = cxacru_remove_device_files,
1329         .bulk_in        = CXACRU_EP_DATA,
1330         .bulk_out       = CXACRU_EP_DATA,
1331         .rx_padding     = 3,
1332         .tx_padding     = 11,
1333 };
1334
1335 static int cxacru_usb_probe(struct usb_interface *intf,
1336                 const struct usb_device_id *id)
1337 {
1338         struct usb_device *usb_dev = interface_to_usbdev(intf);
1339         char buf[15];
1340
1341         /* Avoid ADSL routers (cx82310_eth).
1342          * Abort if bDeviceClass is 0xff and iProduct is "USB NET CARD".
1343          */
1344         if (usb_dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC
1345                         && usb_string(usb_dev, usb_dev->descriptor.iProduct,
1346                                 buf, sizeof(buf)) > 0) {
1347                 if (!strcmp(buf, "USB NET CARD")) {
1348                         dev_info(&intf->dev, "ignoring cx82310_eth device\n");
1349                         return -ENODEV;
1350                 }
1351         }
1352
1353         return usbatm_usb_probe(intf, id, &cxacru_driver);
1354 }
1355
1356 static struct usb_driver cxacru_usb_driver = {
1357         .name           = cxacru_driver_name,
1358         .probe          = cxacru_usb_probe,
1359         .disconnect     = usbatm_usb_disconnect,
1360         .id_table       = cxacru_usb_ids
1361 };
1362
1363 module_usb_driver(cxacru_usb_driver);
1364
1365 MODULE_AUTHOR(DRIVER_AUTHOR);
1366 MODULE_DESCRIPTION(DRIVER_DESC);
1367 MODULE_LICENSE("GPL");