kernel/drivers/usb/atm/cxacru.c

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