Back to home page

OSCL-LXR
 
 

     

0001 // SPDX-License-Identifier: GPL-2.0+
0002 /******************************************************************************
0003  *  speedtch.c  -  Alcatel SpeedTouch USB xDSL modem driver
0004  *
0005  *  Copyright (C) 2001, Alcatel
0006  *  Copyright (C) 2003, Duncan Sands
0007  *  Copyright (C) 2004, David Woodhouse
0008  *
0009  *  Based on "modem_run.c", copyright (C) 2001, Benoit Papillault
0010  ******************************************************************************/
0011 
0012 #include <asm/page.h>
0013 #include <linux/device.h>
0014 #include <linux/errno.h>
0015 #include <linux/firmware.h>
0016 #include <linux/kernel.h>
0017 #include <linux/module.h>
0018 #include <linux/moduleparam.h>
0019 #include <linux/slab.h>
0020 #include <linux/stat.h>
0021 #include <linux/timer.h>
0022 #include <linux/types.h>
0023 #include <linux/usb/ch9.h>
0024 #include <linux/workqueue.h>
0025 
0026 #include "usbatm.h"
0027 
0028 #define DRIVER_AUTHOR   "Johan Verrept, Duncan Sands <duncan.sands@free.fr>"
0029 #define DRIVER_DESC "Alcatel SpeedTouch USB driver"
0030 
0031 static const char speedtch_driver_name[] = "speedtch";
0032 
0033 #define CTRL_TIMEOUT 2000   /* milliseconds */
0034 #define DATA_TIMEOUT 2000   /* milliseconds */
0035 
0036 #define OFFSET_7    0       /* size 1 */
0037 #define OFFSET_b    1       /* size 8 */
0038 #define OFFSET_d    9       /* size 4 */
0039 #define OFFSET_e    13      /* size 1 */
0040 #define OFFSET_f    14      /* size 1 */
0041 
0042 #define SIZE_7      1
0043 #define SIZE_b      8
0044 #define SIZE_d      4
0045 #define SIZE_e      1
0046 #define SIZE_f      1
0047 
0048 #define MIN_POLL_DELAY      5000    /* milliseconds */
0049 #define MAX_POLL_DELAY      60000   /* milliseconds */
0050 
0051 #define RESUBMIT_DELAY      1000    /* milliseconds */
0052 
0053 #define DEFAULT_BULK_ALTSETTING 1
0054 #define DEFAULT_ISOC_ALTSETTING 3
0055 #define DEFAULT_DL_512_FIRST    0
0056 #define DEFAULT_ENABLE_ISOC 0
0057 #define DEFAULT_SW_BUFFERING    0
0058 
0059 static unsigned int altsetting = 0; /* zero means: use the default */
0060 static bool dl_512_first = DEFAULT_DL_512_FIRST;
0061 static bool enable_isoc = DEFAULT_ENABLE_ISOC;
0062 static bool sw_buffering = DEFAULT_SW_BUFFERING;
0063 
0064 #define DEFAULT_B_MAX_DSL   8128
0065 #define DEFAULT_MODEM_MODE  11
0066 #define MODEM_OPTION_LENGTH 16
0067 static const unsigned char DEFAULT_MODEM_OPTION[MODEM_OPTION_LENGTH] = {
0068     0x10, 0x00, 0x00, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00
0069 };
0070 
0071 static unsigned int BMaxDSL = DEFAULT_B_MAX_DSL;
0072 static unsigned char ModemMode = DEFAULT_MODEM_MODE;
0073 static unsigned char ModemOption[MODEM_OPTION_LENGTH];
0074 static unsigned int num_ModemOption;
0075 
0076 module_param(altsetting, uint, S_IRUGO | S_IWUSR);
0077 MODULE_PARM_DESC(altsetting,
0078         "Alternative setting for data interface (bulk_default: "
0079         __MODULE_STRING(DEFAULT_BULK_ALTSETTING) "; isoc_default: "
0080         __MODULE_STRING(DEFAULT_ISOC_ALTSETTING) ")");
0081 
0082 module_param(dl_512_first, bool, S_IRUGO | S_IWUSR);
0083 MODULE_PARM_DESC(dl_512_first,
0084          "Read 512 bytes before sending firmware (default: "
0085          __MODULE_STRING(DEFAULT_DL_512_FIRST) ")");
0086 
0087 module_param(enable_isoc, bool, S_IRUGO | S_IWUSR);
0088 MODULE_PARM_DESC(enable_isoc,
0089         "Use isochronous transfers if available (default: "
0090         __MODULE_STRING(DEFAULT_ENABLE_ISOC) ")");
0091 
0092 module_param(sw_buffering, bool, S_IRUGO | S_IWUSR);
0093 MODULE_PARM_DESC(sw_buffering,
0094          "Enable software buffering (default: "
0095          __MODULE_STRING(DEFAULT_SW_BUFFERING) ")");
0096 
0097 module_param(BMaxDSL, uint, S_IRUGO | S_IWUSR);
0098 MODULE_PARM_DESC(BMaxDSL,
0099         "default: " __MODULE_STRING(DEFAULT_B_MAX_DSL));
0100 
0101 module_param(ModemMode, byte, S_IRUGO | S_IWUSR);
0102 MODULE_PARM_DESC(ModemMode,
0103         "default: " __MODULE_STRING(DEFAULT_MODEM_MODE));
0104 
0105 module_param_array(ModemOption, byte, &num_ModemOption, S_IRUGO);
0106 MODULE_PARM_DESC(ModemOption, "default: 0x10,0x00,0x00,0x00,0x20");
0107 
0108 #define INTERFACE_DATA      1
0109 #define ENDPOINT_INT        0x81
0110 #define ENDPOINT_BULK_DATA  0x07
0111 #define ENDPOINT_ISOC_DATA  0x07
0112 #define ENDPOINT_FIRMWARE   0x05
0113 
0114 struct speedtch_params {
0115     unsigned int altsetting;
0116     unsigned int BMaxDSL;
0117     unsigned char ModemMode;
0118     unsigned char ModemOption[MODEM_OPTION_LENGTH];
0119 };
0120 
0121 struct speedtch_instance_data {
0122     struct usbatm_data *usbatm;
0123 
0124     struct speedtch_params params; /* set in probe, constant afterwards */
0125 
0126     struct timer_list status_check_timer;
0127     struct work_struct status_check_work;
0128 
0129     unsigned char last_status;
0130 
0131     int poll_delay; /* milliseconds */
0132 
0133     struct timer_list resubmit_timer;
0134     struct urb *int_urb;
0135     unsigned char int_data[16];
0136 
0137     unsigned char scratch_buffer[16];
0138 };
0139 
0140 /***************
0141 **  firmware  **
0142 ***************/
0143 
0144 static void speedtch_set_swbuff(struct speedtch_instance_data *instance, int state)
0145 {
0146     struct usbatm_data *usbatm = instance->usbatm;
0147     struct usb_device *usb_dev = usbatm->usb_dev;
0148     int ret;
0149 
0150     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0151                   0x32, 0x40, state ? 0x01 : 0x00, 0x00, NULL, 0, CTRL_TIMEOUT);
0152     if (ret < 0)
0153         usb_warn(usbatm,
0154              "%sabling SW buffering: usb_control_msg returned %d\n",
0155              state ? "En" : "Dis", ret);
0156     else
0157         usb_dbg(usbatm, "speedtch_set_swbuff: %sbled SW buffering\n", state ? "En" : "Dis");
0158 }
0159 
0160 static void speedtch_test_sequence(struct speedtch_instance_data *instance)
0161 {
0162     struct usbatm_data *usbatm = instance->usbatm;
0163     struct usb_device *usb_dev = usbatm->usb_dev;
0164     unsigned char *buf = instance->scratch_buffer;
0165     int ret;
0166 
0167     /* URB 147 */
0168     buf[0] = 0x1c;
0169     buf[1] = 0x50;
0170     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0171                   0x01, 0x40, 0x0b, 0x00, buf, 2, CTRL_TIMEOUT);
0172     if (ret < 0)
0173         usb_warn(usbatm, "%s failed on URB147: %d\n", __func__, ret);
0174 
0175     /* URB 148 */
0176     buf[0] = 0x32;
0177     buf[1] = 0x00;
0178     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0179                   0x01, 0x40, 0x02, 0x00, buf, 2, CTRL_TIMEOUT);
0180     if (ret < 0)
0181         usb_warn(usbatm, "%s failed on URB148: %d\n", __func__, ret);
0182 
0183     /* URB 149 */
0184     buf[0] = 0x01;
0185     buf[1] = 0x00;
0186     buf[2] = 0x01;
0187     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0188                   0x01, 0x40, 0x03, 0x00, buf, 3, CTRL_TIMEOUT);
0189     if (ret < 0)
0190         usb_warn(usbatm, "%s failed on URB149: %d\n", __func__, ret);
0191 
0192     /* URB 150 */
0193     buf[0] = 0x01;
0194     buf[1] = 0x00;
0195     buf[2] = 0x01;
0196     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0197                   0x01, 0x40, 0x04, 0x00, buf, 3, CTRL_TIMEOUT);
0198     if (ret < 0)
0199         usb_warn(usbatm, "%s failed on URB150: %d\n", __func__, ret);
0200 
0201     /* Extra initialisation in recent drivers - gives higher speeds */
0202 
0203     /* URBext1 */
0204     buf[0] = instance->params.ModemMode;
0205     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0206                   0x01, 0x40, 0x11, 0x00, buf, 1, CTRL_TIMEOUT);
0207     if (ret < 0)
0208         usb_warn(usbatm, "%s failed on URBext1: %d\n", __func__, ret);
0209 
0210     /* URBext2 */
0211     /* This seems to be the one which actually triggers the higher sync
0212        rate -- it does require the new firmware too, although it works OK
0213        with older firmware */
0214     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0215                   0x01, 0x40, 0x14, 0x00,
0216                   instance->params.ModemOption,
0217                   MODEM_OPTION_LENGTH, CTRL_TIMEOUT);
0218     if (ret < 0)
0219         usb_warn(usbatm, "%s failed on URBext2: %d\n", __func__, ret);
0220 
0221     /* URBext3 */
0222     buf[0] = instance->params.BMaxDSL & 0xff;
0223     buf[1] = instance->params.BMaxDSL >> 8;
0224     ret = usb_control_msg(usb_dev, usb_sndctrlpipe(usb_dev, 0),
0225                   0x01, 0x40, 0x12, 0x00, buf, 2, CTRL_TIMEOUT);
0226     if (ret < 0)
0227         usb_warn(usbatm, "%s failed on URBext3: %d\n", __func__, ret);
0228 }
0229 
0230 static int speedtch_upload_firmware(struct speedtch_instance_data *instance,
0231                      const struct firmware *fw1,
0232                      const struct firmware *fw2)
0233 {
0234     unsigned char *buffer;
0235     struct usbatm_data *usbatm = instance->usbatm;
0236     struct usb_device *usb_dev = usbatm->usb_dev;
0237     int actual_length;
0238     int ret = 0;
0239     int offset;
0240 
0241     usb_dbg(usbatm, "%s entered\n", __func__);
0242 
0243     buffer = (unsigned char *)__get_free_page(GFP_KERNEL);
0244     if (!buffer) {
0245         ret = -ENOMEM;
0246         usb_dbg(usbatm, "%s: no memory for buffer!\n", __func__);
0247         goto out;
0248     }
0249 
0250     if (!usb_ifnum_to_if(usb_dev, 2)) {
0251         ret = -ENODEV;
0252         usb_dbg(usbatm, "%s: interface not found!\n", __func__);
0253         goto out_free;
0254     }
0255 
0256     /* URB 7 */
0257     if (dl_512_first) { /* some modems need a read before writing the firmware */
0258         ret = usb_bulk_msg(usb_dev, usb_rcvbulkpipe(usb_dev, ENDPOINT_FIRMWARE),
0259                    buffer, 0x200, &actual_length, 2000);
0260 
0261         if (ret < 0 && ret != -ETIMEDOUT)
0262             usb_warn(usbatm, "%s: read BLOCK0 from modem failed (%d)!\n", __func__, ret);
0263         else
0264             usb_dbg(usbatm, "%s: BLOCK0 downloaded (%d bytes)\n", __func__, ret);
0265     }
0266 
0267     /* URB 8 : both leds are static green */
0268     for (offset = 0; offset < fw1->size; offset += PAGE_SIZE) {
0269         int thislen = min_t(int, PAGE_SIZE, fw1->size - offset);
0270         memcpy(buffer, fw1->data + offset, thislen);
0271 
0272         ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, ENDPOINT_FIRMWARE),
0273                    buffer, thislen, &actual_length, DATA_TIMEOUT);
0274 
0275         if (ret < 0) {
0276             usb_err(usbatm, "%s: write BLOCK1 to modem failed (%d)!\n", __func__, ret);
0277             goto out_free;
0278         }
0279         usb_dbg(usbatm, "%s: BLOCK1 uploaded (%zu bytes)\n", __func__, fw1->size);
0280     }
0281 
0282     /* USB led blinking green, ADSL led off */
0283 
0284     /* URB 11 */
0285     ret = usb_bulk_msg(usb_dev, usb_rcvbulkpipe(usb_dev, ENDPOINT_FIRMWARE),
0286                buffer, 0x200, &actual_length, DATA_TIMEOUT);
0287 
0288     if (ret < 0) {
0289         usb_err(usbatm, "%s: read BLOCK2 from modem failed (%d)!\n", __func__, ret);
0290         goto out_free;
0291     }
0292     usb_dbg(usbatm, "%s: BLOCK2 downloaded (%d bytes)\n", __func__, actual_length);
0293 
0294     /* URBs 12 to 139 - USB led blinking green, ADSL led off */
0295     for (offset = 0; offset < fw2->size; offset += PAGE_SIZE) {
0296         int thislen = min_t(int, PAGE_SIZE, fw2->size - offset);
0297         memcpy(buffer, fw2->data + offset, thislen);
0298 
0299         ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, ENDPOINT_FIRMWARE),
0300                    buffer, thislen, &actual_length, DATA_TIMEOUT);
0301 
0302         if (ret < 0) {
0303             usb_err(usbatm, "%s: write BLOCK3 to modem failed (%d)!\n", __func__, ret);
0304             goto out_free;
0305         }
0306     }
0307     usb_dbg(usbatm, "%s: BLOCK3 uploaded (%zu bytes)\n", __func__, fw2->size);
0308 
0309     /* USB led static green, ADSL led static red */
0310 
0311     /* URB 142 */
0312     ret = usb_bulk_msg(usb_dev, usb_rcvbulkpipe(usb_dev, ENDPOINT_FIRMWARE),
0313                buffer, 0x200, &actual_length, DATA_TIMEOUT);
0314 
0315     if (ret < 0) {
0316         usb_err(usbatm, "%s: read BLOCK4 from modem failed (%d)!\n", __func__, ret);
0317         goto out_free;
0318     }
0319 
0320     /* success */
0321     usb_dbg(usbatm, "%s: BLOCK4 downloaded (%d bytes)\n", __func__, actual_length);
0322 
0323     /* Delay to allow firmware to start up. We can do this here
0324        because we're in our own kernel thread anyway. */
0325     msleep_interruptible(1000);
0326 
0327     if ((ret = usb_set_interface(usb_dev, INTERFACE_DATA, instance->params.altsetting)) < 0) {
0328         usb_err(usbatm, "%s: setting interface to %d failed (%d)!\n", __func__, instance->params.altsetting, ret);
0329         goto out_free;
0330     }
0331 
0332     /* Enable software buffering, if requested */
0333     if (sw_buffering)
0334         speedtch_set_swbuff(instance, 1);
0335 
0336     /* Magic spell; don't ask us what this does */
0337     speedtch_test_sequence(instance);
0338 
0339     ret = 0;
0340 
0341 out_free:
0342     free_page((unsigned long)buffer);
0343 out:
0344     return ret;
0345 }
0346 
0347 static int speedtch_find_firmware(struct usbatm_data *usbatm, struct usb_interface *intf,
0348                   int phase, const struct firmware **fw_p)
0349 {
0350     struct device *dev = &intf->dev;
0351     const u16 bcdDevice = le16_to_cpu(interface_to_usbdev(intf)->descriptor.bcdDevice);
0352     const u8 major_revision = bcdDevice >> 8;
0353     const u8 minor_revision = bcdDevice & 0xff;
0354     char buf[24];
0355 
0356     sprintf(buf, "speedtch-%d.bin.%x.%02x", phase, major_revision, minor_revision);
0357     usb_dbg(usbatm, "%s: looking for %s\n", __func__, buf);
0358 
0359     if (request_firmware(fw_p, buf, dev)) {
0360         sprintf(buf, "speedtch-%d.bin.%x", phase, major_revision);
0361         usb_dbg(usbatm, "%s: looking for %s\n", __func__, buf);
0362 
0363         if (request_firmware(fw_p, buf, dev)) {
0364             sprintf(buf, "speedtch-%d.bin", phase);
0365             usb_dbg(usbatm, "%s: looking for %s\n", __func__, buf);
0366 
0367             if (request_firmware(fw_p, buf, dev)) {
0368                 usb_err(usbatm, "%s: no stage %d firmware found!\n", __func__, phase);
0369                 return -ENOENT;
0370             }
0371         }
0372     }
0373 
0374     usb_info(usbatm, "found stage %d firmware %s\n", phase, buf);
0375 
0376     return 0;
0377 }
0378 
0379 static int speedtch_heavy_init(struct usbatm_data *usbatm, struct usb_interface *intf)
0380 {
0381     const struct firmware *fw1, *fw2;
0382     struct speedtch_instance_data *instance = usbatm->driver_data;
0383     int ret;
0384 
0385     if ((ret = speedtch_find_firmware(usbatm, intf, 1, &fw1)) < 0)
0386         return ret;
0387 
0388     if ((ret = speedtch_find_firmware(usbatm, intf, 2, &fw2)) < 0) {
0389         release_firmware(fw1);
0390         return ret;
0391     }
0392 
0393     if ((ret = speedtch_upload_firmware(instance, fw1, fw2)) < 0)
0394         usb_err(usbatm, "%s: firmware upload failed (%d)!\n", __func__, ret);
0395 
0396     release_firmware(fw2);
0397     release_firmware(fw1);
0398 
0399     return ret;
0400 }
0401 
0402 
0403 /**********
0404 **  ATM  **
0405 **********/
0406 
0407 static int speedtch_read_status(struct speedtch_instance_data *instance)
0408 {
0409     struct usbatm_data *usbatm = instance->usbatm;
0410     struct usb_device *usb_dev = usbatm->usb_dev;
0411     unsigned char *buf = instance->scratch_buffer;
0412     int ret;
0413 
0414     memset(buf, 0, 16);
0415 
0416     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0417                   0x12, 0xc0, 0x07, 0x00, buf + OFFSET_7, SIZE_7,
0418                   CTRL_TIMEOUT);
0419     if (ret < 0) {
0420         atm_dbg(usbatm, "%s: MSG 7 failed\n", __func__);
0421         return ret;
0422     }
0423 
0424     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0425                   0x12, 0xc0, 0x0b, 0x00, buf + OFFSET_b, SIZE_b,
0426                   CTRL_TIMEOUT);
0427     if (ret < 0) {
0428         atm_dbg(usbatm, "%s: MSG B failed\n", __func__);
0429         return ret;
0430     }
0431 
0432     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0433                   0x12, 0xc0, 0x0d, 0x00, buf + OFFSET_d, SIZE_d,
0434                   CTRL_TIMEOUT);
0435     if (ret < 0) {
0436         atm_dbg(usbatm, "%s: MSG D failed\n", __func__);
0437         return ret;
0438     }
0439 
0440     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0441                   0x01, 0xc0, 0x0e, 0x00, buf + OFFSET_e, SIZE_e,
0442                   CTRL_TIMEOUT);
0443     if (ret < 0) {
0444         atm_dbg(usbatm, "%s: MSG E failed\n", __func__);
0445         return ret;
0446     }
0447 
0448     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0449                   0x01, 0xc0, 0x0f, 0x00, buf + OFFSET_f, SIZE_f,
0450                   CTRL_TIMEOUT);
0451     if (ret < 0) {
0452         atm_dbg(usbatm, "%s: MSG F failed\n", __func__);
0453         return ret;
0454     }
0455 
0456     return 0;
0457 }
0458 
0459 static int speedtch_start_synchro(struct speedtch_instance_data *instance)
0460 {
0461     struct usbatm_data *usbatm = instance->usbatm;
0462     struct usb_device *usb_dev = usbatm->usb_dev;
0463     unsigned char *buf = instance->scratch_buffer;
0464     int ret;
0465 
0466     atm_dbg(usbatm, "%s entered\n", __func__);
0467 
0468     memset(buf, 0, 2);
0469 
0470     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0471                   0x12, 0xc0, 0x04, 0x00,
0472                   buf, 2, CTRL_TIMEOUT);
0473 
0474     if (ret < 0)
0475         atm_warn(usbatm, "failed to start ADSL synchronisation: %d\n", ret);
0476     else
0477         atm_dbg(usbatm, "%s: modem prodded. %d bytes returned: %02x %02x\n",
0478             __func__, ret, buf[0], buf[1]);
0479 
0480     return ret;
0481 }
0482 
0483 static void speedtch_check_status(struct work_struct *work)
0484 {
0485     struct speedtch_instance_data *instance =
0486         container_of(work, struct speedtch_instance_data,
0487                  status_check_work);
0488     struct usbatm_data *usbatm = instance->usbatm;
0489     struct atm_dev *atm_dev = usbatm->atm_dev;
0490     unsigned char *buf = instance->scratch_buffer;
0491     int down_speed, up_speed, ret;
0492     unsigned char status;
0493 
0494 #ifdef VERBOSE_DEBUG
0495     atm_dbg(usbatm, "%s entered\n", __func__);
0496 #endif
0497 
0498     ret = speedtch_read_status(instance);
0499     if (ret < 0) {
0500         atm_warn(usbatm, "error %d fetching device status\n", ret);
0501         instance->poll_delay = min(2 * instance->poll_delay, MAX_POLL_DELAY);
0502         return;
0503     }
0504 
0505     instance->poll_delay = max(instance->poll_delay / 2, MIN_POLL_DELAY);
0506 
0507     status = buf[OFFSET_7];
0508 
0509     if ((status != instance->last_status) || !status) {
0510         atm_dbg(usbatm, "%s: line state 0x%02x\n", __func__, status);
0511 
0512         switch (status) {
0513         case 0:
0514             atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
0515             if (instance->last_status)
0516                 atm_info(usbatm, "ADSL line is down\n");
0517             /* It may never resync again unless we ask it to... */
0518             ret = speedtch_start_synchro(instance);
0519             break;
0520 
0521         case 0x08:
0522             atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
0523             atm_info(usbatm, "ADSL line is blocked?\n");
0524             break;
0525 
0526         case 0x10:
0527             atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
0528             atm_info(usbatm, "ADSL line is synchronising\n");
0529             break;
0530 
0531         case 0x20:
0532             down_speed = buf[OFFSET_b] | (buf[OFFSET_b + 1] << 8)
0533                 | (buf[OFFSET_b + 2] << 16) | (buf[OFFSET_b + 3] << 24);
0534             up_speed = buf[OFFSET_b + 4] | (buf[OFFSET_b + 5] << 8)
0535                 | (buf[OFFSET_b + 6] << 16) | (buf[OFFSET_b + 7] << 24);
0536 
0537             if (!(down_speed & 0x0000ffff) && !(up_speed & 0x0000ffff)) {
0538                 down_speed >>= 16;
0539                 up_speed >>= 16;
0540             }
0541 
0542             atm_dev->link_rate = down_speed * 1000 / 424;
0543             atm_dev_signal_change(atm_dev, ATM_PHY_SIG_FOUND);
0544 
0545             atm_info(usbatm,
0546                  "ADSL line is up (%d kb/s down | %d kb/s up)\n",
0547                  down_speed, up_speed);
0548             break;
0549 
0550         default:
0551             atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
0552             atm_info(usbatm, "unknown line state %02x\n", status);
0553             break;
0554         }
0555 
0556         instance->last_status = status;
0557     }
0558 }
0559 
0560 static void speedtch_status_poll(struct timer_list *t)
0561 {
0562     struct speedtch_instance_data *instance = from_timer(instance, t,
0563                                      status_check_timer);
0564 
0565     schedule_work(&instance->status_check_work);
0566 
0567     /* The following check is racy, but the race is harmless */
0568     if (instance->poll_delay < MAX_POLL_DELAY)
0569         mod_timer(&instance->status_check_timer, jiffies + msecs_to_jiffies(instance->poll_delay));
0570     else
0571         atm_warn(instance->usbatm, "Too many failures - disabling line status polling\n");
0572 }
0573 
0574 static void speedtch_resubmit_int(struct timer_list *t)
0575 {
0576     struct speedtch_instance_data *instance = from_timer(instance, t,
0577                                  resubmit_timer);
0578     struct urb *int_urb = instance->int_urb;
0579     int ret;
0580 
0581     atm_dbg(instance->usbatm, "%s entered\n", __func__);
0582 
0583     if (int_urb) {
0584         ret = usb_submit_urb(int_urb, GFP_ATOMIC);
0585         if (!ret)
0586             schedule_work(&instance->status_check_work);
0587         else {
0588             atm_dbg(instance->usbatm, "%s: usb_submit_urb failed with result %d\n", __func__, ret);
0589             mod_timer(&instance->resubmit_timer, jiffies + msecs_to_jiffies(RESUBMIT_DELAY));
0590         }
0591     }
0592 }
0593 
0594 static void speedtch_handle_int(struct urb *int_urb)
0595 {
0596     struct speedtch_instance_data *instance = int_urb->context;
0597     struct usbatm_data *usbatm = instance->usbatm;
0598     unsigned int count = int_urb->actual_length;
0599     int status = int_urb->status;
0600     int ret;
0601 
0602     /* The magic interrupt for "up state" */
0603     static const unsigned char up_int[6]   = { 0xa1, 0x00, 0x01, 0x00, 0x00, 0x00 };
0604     /* The magic interrupt for "down state" */
0605     static const unsigned char down_int[6] = { 0xa1, 0x00, 0x00, 0x00, 0x00, 0x00 };
0606 
0607     atm_dbg(usbatm, "%s entered\n", __func__);
0608 
0609     if (status < 0) {
0610         atm_dbg(usbatm, "%s: nonzero urb status %d!\n", __func__, status);
0611         goto fail;
0612     }
0613 
0614     if ((count == 6) && !memcmp(up_int, instance->int_data, 6)) {
0615         del_timer(&instance->status_check_timer);
0616         atm_info(usbatm, "DSL line goes up\n");
0617     } else if ((count == 6) && !memcmp(down_int, instance->int_data, 6)) {
0618         atm_info(usbatm, "DSL line goes down\n");
0619     } else {
0620         int i;
0621 
0622         atm_dbg(usbatm, "%s: unknown interrupt packet of length %d:", __func__, count);
0623         for (i = 0; i < count; i++)
0624             printk(" %02x", instance->int_data[i]);
0625         printk("\n");
0626         goto fail;
0627     }
0628 
0629     int_urb = instance->int_urb;
0630     if (int_urb) {
0631         ret = usb_submit_urb(int_urb, GFP_ATOMIC);
0632         schedule_work(&instance->status_check_work);
0633         if (ret < 0) {
0634             atm_dbg(usbatm, "%s: usb_submit_urb failed with result %d\n", __func__, ret);
0635             goto fail;
0636         }
0637     }
0638 
0639     return;
0640 
0641 fail:
0642     int_urb = instance->int_urb;
0643     if (int_urb)
0644         mod_timer(&instance->resubmit_timer, jiffies + msecs_to_jiffies(RESUBMIT_DELAY));
0645 }
0646 
0647 static int speedtch_atm_start(struct usbatm_data *usbatm, struct atm_dev *atm_dev)
0648 {
0649     struct usb_device *usb_dev = usbatm->usb_dev;
0650     struct speedtch_instance_data *instance = usbatm->driver_data;
0651     int i, ret;
0652     unsigned char mac_str[13];
0653 
0654     atm_dbg(usbatm, "%s entered\n", __func__);
0655 
0656     /* Set MAC address, it is stored in the serial number */
0657     memset(atm_dev->esi, 0, sizeof(atm_dev->esi));
0658     if (usb_string(usb_dev, usb_dev->descriptor.iSerialNumber, mac_str, sizeof(mac_str)) == 12) {
0659         for (i = 0; i < 6; i++)
0660             atm_dev->esi[i] = (hex_to_bin(mac_str[i * 2]) << 4) +
0661                 hex_to_bin(mac_str[i * 2 + 1]);
0662     }
0663 
0664     /* Start modem synchronisation */
0665     ret = speedtch_start_synchro(instance);
0666 
0667     /* Set up interrupt endpoint */
0668     if (instance->int_urb) {
0669         ret = usb_submit_urb(instance->int_urb, GFP_KERNEL);
0670         if (ret < 0) {
0671             /* Doesn't matter; we'll poll anyway */
0672             atm_dbg(usbatm, "%s: submission of interrupt URB failed (%d)!\n", __func__, ret);
0673             usb_free_urb(instance->int_urb);
0674             instance->int_urb = NULL;
0675         }
0676     }
0677 
0678     /* Start status polling */
0679     mod_timer(&instance->status_check_timer, jiffies + msecs_to_jiffies(1000));
0680 
0681     return 0;
0682 }
0683 
0684 static void speedtch_atm_stop(struct usbatm_data *usbatm, struct atm_dev *atm_dev)
0685 {
0686     struct speedtch_instance_data *instance = usbatm->driver_data;
0687     struct urb *int_urb = instance->int_urb;
0688 
0689     atm_dbg(usbatm, "%s entered\n", __func__);
0690 
0691     del_timer_sync(&instance->status_check_timer);
0692 
0693     /*
0694      * Since resubmit_timer and int_urb can schedule themselves and
0695      * each other, shutting them down correctly takes some care
0696      */
0697     instance->int_urb = NULL; /* signal shutdown */
0698     mb();
0699     usb_kill_urb(int_urb);
0700     del_timer_sync(&instance->resubmit_timer);
0701     /*
0702      * At this point, speedtch_handle_int and speedtch_resubmit_int
0703      * can run or be running, but instance->int_urb == NULL means that
0704      * they will not reschedule
0705      */
0706     usb_kill_urb(int_urb);
0707     del_timer_sync(&instance->resubmit_timer);
0708     usb_free_urb(int_urb);
0709 
0710     flush_work(&instance->status_check_work);
0711 }
0712 
0713 static int speedtch_pre_reset(struct usb_interface *intf)
0714 {
0715     return 0;
0716 }
0717 
0718 static int speedtch_post_reset(struct usb_interface *intf)
0719 {
0720     return 0;
0721 }
0722 
0723 
0724 /**********
0725 **  USB  **
0726 **********/
0727 
0728 static const struct usb_device_id speedtch_usb_ids[] = {
0729     {USB_DEVICE(0x06b9, 0x4061)},
0730     {}
0731 };
0732 
0733 MODULE_DEVICE_TABLE(usb, speedtch_usb_ids);
0734 
0735 static int speedtch_usb_probe(struct usb_interface *, const struct usb_device_id *);
0736 
0737 static struct usb_driver speedtch_usb_driver = {
0738     .name       = speedtch_driver_name,
0739     .probe      = speedtch_usb_probe,
0740     .disconnect = usbatm_usb_disconnect,
0741     .pre_reset  = speedtch_pre_reset,
0742     .post_reset = speedtch_post_reset,
0743     .id_table   = speedtch_usb_ids
0744 };
0745 
0746 static void speedtch_release_interfaces(struct usb_device *usb_dev,
0747                     int num_interfaces)
0748 {
0749     struct usb_interface *cur_intf;
0750     int i;
0751 
0752     for (i = 0; i < num_interfaces; i++) {
0753         cur_intf = usb_ifnum_to_if(usb_dev, i);
0754         if (cur_intf) {
0755             usb_set_intfdata(cur_intf, NULL);
0756             usb_driver_release_interface(&speedtch_usb_driver, cur_intf);
0757         }
0758     }
0759 }
0760 
0761 static int speedtch_bind(struct usbatm_data *usbatm,
0762              struct usb_interface *intf,
0763              const struct usb_device_id *id)
0764 {
0765     struct usb_device *usb_dev = interface_to_usbdev(intf);
0766     struct usb_interface *cur_intf, *data_intf;
0767     struct speedtch_instance_data *instance;
0768     int ifnum = intf->altsetting->desc.bInterfaceNumber;
0769     int num_interfaces = usb_dev->actconfig->desc.bNumInterfaces;
0770     int i, ret;
0771     int use_isoc;
0772 
0773     usb_dbg(usbatm, "%s entered\n", __func__);
0774 
0775     /* sanity checks */
0776 
0777     if (usb_dev->descriptor.bDeviceClass != USB_CLASS_VENDOR_SPEC) {
0778         usb_err(usbatm, "%s: wrong device class %d\n", __func__, usb_dev->descriptor.bDeviceClass);
0779         return -ENODEV;
0780     }
0781 
0782     data_intf = usb_ifnum_to_if(usb_dev, INTERFACE_DATA);
0783     if (!data_intf) {
0784         usb_err(usbatm, "%s: data interface not found!\n", __func__);
0785         return -ENODEV;
0786     }
0787 
0788     /* claim all interfaces */
0789 
0790     for (i = 0; i < num_interfaces; i++) {
0791         cur_intf = usb_ifnum_to_if(usb_dev, i);
0792 
0793         if ((i != ifnum) && cur_intf) {
0794             ret = usb_driver_claim_interface(&speedtch_usb_driver, cur_intf, usbatm);
0795 
0796             if (ret < 0) {
0797                 usb_err(usbatm, "%s: failed to claim interface %2d (%d)!\n", __func__, i, ret);
0798                 speedtch_release_interfaces(usb_dev, i);
0799                 return ret;
0800             }
0801         }
0802     }
0803 
0804     instance = kzalloc(sizeof(*instance), GFP_KERNEL);
0805 
0806     if (!instance) {
0807         ret = -ENOMEM;
0808         goto fail_release;
0809     }
0810 
0811     instance->usbatm = usbatm;
0812 
0813     /* module parameters may change at any moment, so take a snapshot */
0814     instance->params.altsetting = altsetting;
0815     instance->params.BMaxDSL = BMaxDSL;
0816     instance->params.ModemMode = ModemMode;
0817     memcpy(instance->params.ModemOption, DEFAULT_MODEM_OPTION, MODEM_OPTION_LENGTH);
0818     memcpy(instance->params.ModemOption, ModemOption, num_ModemOption);
0819     use_isoc = enable_isoc;
0820 
0821     if (instance->params.altsetting)
0822         if ((ret = usb_set_interface(usb_dev, INTERFACE_DATA, instance->params.altsetting)) < 0) {
0823             usb_err(usbatm, "%s: setting interface to %2d failed (%d)!\n", __func__, instance->params.altsetting, ret);
0824             instance->params.altsetting = 0; /* fall back to default */
0825         }
0826 
0827     if (!instance->params.altsetting && use_isoc)
0828         if ((ret = usb_set_interface(usb_dev, INTERFACE_DATA, DEFAULT_ISOC_ALTSETTING)) < 0) {
0829             usb_dbg(usbatm, "%s: setting interface to %2d failed (%d)!\n", __func__, DEFAULT_ISOC_ALTSETTING, ret);
0830             use_isoc = 0; /* fall back to bulk */
0831         }
0832 
0833     if (use_isoc) {
0834         const struct usb_host_interface *desc = data_intf->cur_altsetting;
0835         const __u8 target_address = USB_DIR_IN | usbatm->driver->isoc_in;
0836 
0837         use_isoc = 0; /* fall back to bulk if endpoint not found */
0838 
0839         for (i = 0; i < desc->desc.bNumEndpoints; i++) {
0840             const struct usb_endpoint_descriptor *endpoint_desc = &desc->endpoint[i].desc;
0841 
0842             if ((endpoint_desc->bEndpointAddress == target_address)) {
0843                 use_isoc =
0844                     usb_endpoint_xfer_isoc(endpoint_desc);
0845                 break;
0846             }
0847         }
0848 
0849         if (!use_isoc)
0850             usb_info(usbatm, "isochronous transfer not supported - using bulk\n");
0851     }
0852 
0853     if (!use_isoc && !instance->params.altsetting)
0854         if ((ret = usb_set_interface(usb_dev, INTERFACE_DATA, DEFAULT_BULK_ALTSETTING)) < 0) {
0855             usb_err(usbatm, "%s: setting interface to %2d failed (%d)!\n", __func__, DEFAULT_BULK_ALTSETTING, ret);
0856             goto fail_free;
0857         }
0858 
0859     if (!instance->params.altsetting)
0860         instance->params.altsetting = use_isoc ? DEFAULT_ISOC_ALTSETTING : DEFAULT_BULK_ALTSETTING;
0861 
0862     usbatm->flags |= (use_isoc ? UDSL_USE_ISOC : 0);
0863 
0864     INIT_WORK(&instance->status_check_work, speedtch_check_status);
0865     timer_setup(&instance->status_check_timer, speedtch_status_poll, 0);
0866     instance->last_status = 0xff;
0867     instance->poll_delay = MIN_POLL_DELAY;
0868 
0869     timer_setup(&instance->resubmit_timer, speedtch_resubmit_int, 0);
0870 
0871     instance->int_urb = usb_alloc_urb(0, GFP_KERNEL);
0872 
0873     if (instance->int_urb)
0874         usb_fill_int_urb(instance->int_urb, usb_dev,
0875                  usb_rcvintpipe(usb_dev, ENDPOINT_INT),
0876                  instance->int_data, sizeof(instance->int_data),
0877                  speedtch_handle_int, instance, 16);
0878     else
0879         usb_dbg(usbatm, "%s: no memory for interrupt urb!\n", __func__);
0880 
0881     /* check whether the modem already seems to be alive */
0882     ret = usb_control_msg(usb_dev, usb_rcvctrlpipe(usb_dev, 0),
0883                   0x12, 0xc0, 0x07, 0x00,
0884                   instance->scratch_buffer + OFFSET_7, SIZE_7, 500);
0885 
0886     usbatm->flags |= (ret == SIZE_7 ? UDSL_SKIP_HEAVY_INIT : 0);
0887 
0888     usb_dbg(usbatm, "%s: firmware %s loaded\n", __func__, usbatm->flags & UDSL_SKIP_HEAVY_INIT ? "already" : "not");
0889 
0890     if (!(usbatm->flags & UDSL_SKIP_HEAVY_INIT))
0891         if ((ret = usb_reset_device(usb_dev)) < 0) {
0892             usb_err(usbatm, "%s: device reset failed (%d)!\n", __func__, ret);
0893             goto fail_free;
0894         }
0895 
0896         usbatm->driver_data = instance;
0897 
0898     return 0;
0899 
0900 fail_free:
0901     usb_free_urb(instance->int_urb);
0902     kfree(instance);
0903 fail_release:
0904     speedtch_release_interfaces(usb_dev, num_interfaces);
0905     return ret;
0906 }
0907 
0908 static void speedtch_unbind(struct usbatm_data *usbatm, struct usb_interface *intf)
0909 {
0910     struct usb_device *usb_dev = interface_to_usbdev(intf);
0911     struct speedtch_instance_data *instance = usbatm->driver_data;
0912 
0913     usb_dbg(usbatm, "%s entered\n", __func__);
0914 
0915     speedtch_release_interfaces(usb_dev, usb_dev->actconfig->desc.bNumInterfaces);
0916     usb_free_urb(instance->int_urb);
0917     kfree(instance);
0918 }
0919 
0920 
0921 /***********
0922 **  init  **
0923 ***********/
0924 
0925 static struct usbatm_driver speedtch_usbatm_driver = {
0926     .driver_name    = speedtch_driver_name,
0927     .bind       = speedtch_bind,
0928     .heavy_init = speedtch_heavy_init,
0929     .unbind     = speedtch_unbind,
0930     .atm_start  = speedtch_atm_start,
0931     .atm_stop   = speedtch_atm_stop,
0932     .bulk_in    = ENDPOINT_BULK_DATA,
0933     .bulk_out   = ENDPOINT_BULK_DATA,
0934     .isoc_in    = ENDPOINT_ISOC_DATA
0935 };
0936 
0937 static int speedtch_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
0938 {
0939     return usbatm_usb_probe(intf, id, &speedtch_usbatm_driver);
0940 }
0941 
0942 module_usb_driver(speedtch_usb_driver);
0943 
0944 MODULE_AUTHOR(DRIVER_AUTHOR);
0945 MODULE_DESCRIPTION(DRIVER_DESC);
0946 MODULE_LICENSE("GPL");
[ Source navigation ] [ Diff markup ] [ Identifier search ] [ general search ]

This page was automatically generated by the 2.1.0 LXR engine.

The LXR team
Valid CSS 2.1! Valid HTML 4.01!