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