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