1 /******************************************************************************
2 * cxacru.c - driver for USB ADSL modems based on
3 * Conexant AccessRunner chipset
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
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the Free
11 * Software Foundation; either version 2 of the License, or (at your option)
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
19 * You should have received a copy of the GNU General Public License along with
20 * this program; if not, write to the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 ******************************************************************************/
26 * Credit is due for Josep Comas, who created the original patch to speedtch.c
27 * to support the different padding used by the AccessRunner (now generalized
28 * into usbatm), and the userspace firmware loading utility.
31 #include <linux/module.h>
32 #include <linux/moduleparam.h>
33 #include <linux/kernel.h>
34 #include <linux/timer.h>
35 #include <linux/errno.h>
36 #include <linux/slab.h>
37 #include <linux/init.h>
38 #include <linux/device.h>
39 #include <linux/firmware.h>
40 #include <linux/mutex.h>
44 #define DRIVER_AUTHOR "Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
45 #define DRIVER_VERSION "0.3"
46 #define DRIVER_DESC "Conexant AccessRunner ADSL USB modem driver"
48 static const char cxacru_driver_name[] = "cxacru";
50 #define CXACRU_EP_CMD 0x01 /* Bulk/interrupt in/out */
51 #define CXACRU_EP_DATA 0x02 /* Bulk in/out */
53 #define CMD_PACKET_SIZE 64 /* Should be maxpacket(ep)? */
56 #define PLLFCLK_ADDR 0x00350068
57 #define PLLBCLK_ADDR 0x0035006c
58 #define SDRAMEN_ADDR 0x00350010
59 #define FW_ADDR 0x00801000
60 #define BR_ADDR 0x00180600
61 #define SIG_ADDR 0x00180500
62 #define BR_STACK_ADDR 0x00187f10
67 #define CMD_TIMEOUT 2000 /* msecs */
68 #define POLL_INTERVAL 1 /* secs */
70 /* commands for interaction with the modem through the control channel before
71 * firmware is loaded */
72 enum cxacru_fw_request {
82 /* commands for interaction with the modem through the control channel once
83 * firmware is loaded */
84 enum cxacru_cm_request {
85 CM_REQUEST_UNDEFINED = 0x80,
87 CM_REQUEST_CHIP_GET_MAC_ADDRESS,
88 CM_REQUEST_CHIP_GET_DP_VERSIONS,
89 CM_REQUEST_CHIP_ADSL_LINE_START,
90 CM_REQUEST_CHIP_ADSL_LINE_STOP,
91 CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
92 CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
93 CM_REQUEST_CARD_INFO_GET,
94 CM_REQUEST_CARD_DATA_GET,
95 CM_REQUEST_CARD_DATA_SET,
96 CM_REQUEST_COMMAND_HW_IO,
97 CM_REQUEST_INTERFACE_HW_IO,
98 CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
99 CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
100 CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
101 CM_REQUEST_CARD_GET_STATUS,
102 CM_REQUEST_CARD_GET_MAC_ADDRESS,
103 CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
107 /* reply codes to the commands above */
108 enum cxacru_cm_status {
112 CM_STATUS_UNSUPPORTED,
113 CM_STATUS_UNIMPLEMENTED,
114 CM_STATUS_PARAMETER_ERROR,
115 CM_STATUS_DBG_LOOPBACK,
119 /* indices into CARD_INFO_GET return array */
120 enum cxacru_info_idx {
121 CXINF_DOWNSTREAM_RATE,
125 CXINF_MAC_ADDRESS_HIGH,
126 CXINF_MAC_ADDRESS_LOW,
127 CXINF_UPSTREAM_SNR_MARGIN,
128 CXINF_DOWNSTREAM_SNR_MARGIN,
129 CXINF_UPSTREAM_ATTENUATION,
130 CXINF_DOWNSTREAM_ATTENUATION,
131 CXINF_TRANSMITTER_POWER,
132 CXINF_UPSTREAM_BITS_PER_FRAME,
133 CXINF_DOWNSTREAM_BITS_PER_FRAME,
134 CXINF_STARTUP_ATTEMPTS,
135 CXINF_UPSTREAM_CRC_ERRORS,
136 CXINF_DOWNSTREAM_CRC_ERRORS,
137 CXINF_UPSTREAM_FEC_ERRORS,
138 CXINF_DOWNSTREAM_FEC_ERRORS,
139 CXINF_UPSTREAM_HEC_ERRORS,
140 CXINF_DOWNSTREAM_HEC_ERRORS,
141 CXINF_LINE_STARTABLE,
144 CXINF_ADSL_HEADEND_ENVIRONMENT,
145 CXINF_CONTROLLER_VERSION,
146 /* dunno what the missing two mean */
150 enum cxacru_poll_state {
157 struct cxacru_modem_type {
164 struct usbatm_data *usbatm;
166 const struct cxacru_modem_type *modem_type;
169 struct mutex adsl_state_serialize;
171 struct delayed_work poll_work;
172 u32 card_info[CXINF_MAX];
173 struct mutex poll_state_serialize;
177 struct mutex cm_serialize;
182 struct completion rcv_done;
183 struct completion snd_done;
186 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
187 u8 *wdata, int wsize, u8 *rdata, int rsize);
188 static void cxacru_poll_status(struct work_struct *work);
190 /* Card info exported through sysfs */
191 #define CXACRU__ATTR_INIT(_name) \
192 static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
194 #define CXACRU_CMD_INIT(_name) \
195 static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
196 cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
198 #define CXACRU_ATTR_INIT(_value, _type, _name) \
199 static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
200 struct device_attribute *attr, char *buf) \
202 struct usb_interface *intf = to_usb_interface(dev); \
203 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf); \
204 struct cxacru_data *instance = usbatm_instance->driver_data; \
205 return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
207 CXACRU__ATTR_INIT(_name)
209 #define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
210 #define CXACRU_CMD_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
211 #define CXACRU__ATTR_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
213 #define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
214 #define CXACRU_CMD_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
215 #define CXACRU__ATTR_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
217 static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
219 return snprintf(buf, PAGE_SIZE, "%u\n", value);
222 static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
224 return snprintf(buf, PAGE_SIZE, "%d\n", value);
227 static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
229 if (unlikely(value < 0)) {
230 return snprintf(buf, PAGE_SIZE, "%d.%02u\n",
231 value / 100, -value % 100);
233 return snprintf(buf, PAGE_SIZE, "%d.%02u\n",
234 value / 100, value % 100);
238 static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
241 case 0: return snprintf(buf, PAGE_SIZE, "no\n");
242 case 1: return snprintf(buf, PAGE_SIZE, "yes\n");
247 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
250 case 1: return snprintf(buf, PAGE_SIZE, "not connected\n");
251 case 2: return snprintf(buf, PAGE_SIZE, "connected\n");
252 case 3: return snprintf(buf, PAGE_SIZE, "lost\n");
253 default: return snprintf(buf, PAGE_SIZE, "unknown (%u)\n", value);
257 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
260 case 0: return snprintf(buf, PAGE_SIZE, "down\n");
261 case 1: return snprintf(buf, PAGE_SIZE, "attempting to activate\n");
262 case 2: return snprintf(buf, PAGE_SIZE, "training\n");
263 case 3: return snprintf(buf, PAGE_SIZE, "channel analysis\n");
264 case 4: return snprintf(buf, PAGE_SIZE, "exchange\n");
265 case 5: return snprintf(buf, PAGE_SIZE, "up\n");
266 case 6: return snprintf(buf, PAGE_SIZE, "waiting\n");
267 case 7: return snprintf(buf, PAGE_SIZE, "initialising\n");
268 default: return snprintf(buf, PAGE_SIZE, "unknown (%u)\n", value);
272 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
276 case 1: return snprintf(buf, PAGE_SIZE, "ANSI T1.413\n");
277 case 2: return snprintf(buf, PAGE_SIZE, "ITU-T G.992.1 (G.DMT)\n");
278 case 3: return snprintf(buf, PAGE_SIZE, "ITU-T G.992.2 (G.LITE)\n");
279 default: return snprintf(buf, PAGE_SIZE, "unknown (%u)\n", value);
284 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
285 * this data is already in atm_dev there's no point.
287 * MAC_ADDRESS_HIGH = 0x????5544
288 * MAC_ADDRESS_LOW = 0x33221100
289 * Where 00-55 are bytes 0-5 of the MAC.
291 static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
292 struct device_attribute *attr, char *buf)
294 struct usb_interface *intf = to_usb_interface(dev);
295 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
296 struct atm_dev *atm_dev = usbatm_instance->atm_dev;
298 return snprintf(buf, PAGE_SIZE, "%02x:%02x:%02x:%02x:%02x:%02x\n",
299 atm_dev->esi[0], atm_dev->esi[1], atm_dev->esi[2],
300 atm_dev->esi[3], atm_dev->esi[4], atm_dev->esi[5]);
303 static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
304 struct device_attribute *attr, char *buf)
306 struct usb_interface *intf = to_usb_interface(dev);
307 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
308 struct cxacru_data *instance = usbatm_instance->driver_data;
309 u32 value = instance->card_info[CXINF_LINE_STARTABLE];
312 case 0: return snprintf(buf, PAGE_SIZE, "running\n");
313 case 1: return snprintf(buf, PAGE_SIZE, "stopped\n");
314 default: return snprintf(buf, PAGE_SIZE, "unknown (%u)\n", value);
318 static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
319 struct device_attribute *attr, const char *buf, size_t count)
321 struct usb_interface *intf = to_usb_interface(dev);
322 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
323 struct cxacru_data *instance = usbatm_instance->driver_data;
327 int len = strlen(buf);
329 if (!capable(CAP_NET_ADMIN))
332 ret = sscanf(buf, "%7s", str_cmd);
337 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
340 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
341 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
343 atm_err(usbatm_instance, "change adsl state:"
344 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
349 poll = CXPOLL_STOPPED;
353 /* Line status is only updated every second
354 * and the device appears to only react to
355 * START/STOP every second too. Wait 1.5s to
356 * be sure that restart will have an effect. */
357 if (!strcmp(str_cmd, "restart"))
360 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
361 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
363 atm_err(usbatm_instance, "change adsl state:"
364 " CHIP_ADSL_LINE_START returned %d\n", ret);
369 poll = CXPOLL_POLLING;
373 if (!strcmp(str_cmd, "poll")) {
375 poll = CXPOLL_POLLING;
383 if (poll == CXPOLL_POLLING) {
384 mutex_lock(&instance->poll_state_serialize);
385 switch (instance->poll_state) {
388 instance->poll_state = CXPOLL_POLLING;
391 case CXPOLL_STOPPING:
392 /* abort stop request */
393 instance->poll_state = CXPOLL_POLLING;
395 case CXPOLL_SHUTDOWN:
396 /* don't start polling */
399 mutex_unlock(&instance->poll_state_serialize);
400 } else if (poll == CXPOLL_STOPPED) {
401 mutex_lock(&instance->poll_state_serialize);
403 if (instance->poll_state == CXPOLL_POLLING)
404 instance->poll_state = CXPOLL_STOPPING;
405 mutex_unlock(&instance->poll_state_serialize);
408 mutex_unlock(&instance->adsl_state_serialize);
410 if (poll == CXPOLL_POLLING)
411 cxacru_poll_status(&instance->poll_work.work);
417 * All device attributes are included in CXACRU_ALL_FILES
418 * so that the same list can be used multiple times:
419 * INIT (define the device attributes)
420 * CREATE (create all the device files)
421 * REMOVE (remove all the device files)
423 * With the last two being defined as needed in the functions
424 * they are used in before calling CXACRU_ALL_FILES()
426 #define CXACRU_ALL_FILES(_action) \
427 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
428 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
429 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
430 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
431 CXACRU__ATTR_##_action( mac_address); \
432 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
433 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
434 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
435 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
436 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
437 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
438 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
439 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
440 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
441 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
442 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
443 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
444 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
445 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
446 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
447 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
448 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
449 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
450 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
451 CXACRU_CMD_##_action( adsl_state);
453 CXACRU_ALL_FILES(INIT);
455 /* the following three functions are stolen from drivers/usb/core/message.c */
456 static void cxacru_blocking_completion(struct urb *urb)
458 complete((struct completion *)urb->context);
461 static void cxacru_timeout_kill(unsigned long data)
463 usb_unlink_urb((struct urb *) data);
466 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
469 struct timer_list timer;
473 timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
474 timer.data = (unsigned long) urb;
475 timer.function = cxacru_timeout_kill;
477 wait_for_completion(done);
478 status = urb->status;
479 if (status == -ECONNRESET)
481 del_timer_sync(&timer);
484 *actual_length = urb->actual_length;
488 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
489 u8 *wdata, int wsize, u8 *rdata, int rsize)
493 const int stride = CMD_PACKET_SIZE - 4;
494 u8 *wbuf = instance->snd_buf;
495 u8 *rbuf = instance->rcv_buf;
496 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
497 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
499 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
500 dbg("too big transfer requested");
505 mutex_lock(&instance->cm_serialize);
507 /* submit reading urb before the writing one */
508 init_completion(&instance->rcv_done);
509 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
511 dbg("submitting read urb for cm %#x failed", cm);
516 memset(wbuf, 0, wbuflen);
517 /* handle wsize == 0 */
519 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
521 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
524 instance->snd_urb->transfer_buffer_length = wbuflen;
525 init_completion(&instance->snd_done);
526 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
528 dbg("submitting write urb for cm %#x failed", cm);
533 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
535 dbg("sending cm %#x failed", cm);
540 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
542 dbg("receiving cm %#x failed", cm);
546 if (actlen % CMD_PACKET_SIZE || !actlen) {
547 dbg("response is not a positive multiple of %d: %#x",
548 CMD_PACKET_SIZE, actlen);
553 /* check the return status and copy the data to the output buffer, if needed */
554 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
555 if (rbuf[offb] != cm) {
556 dbg("wrong cm %#x in response", rbuf[offb]);
560 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
561 dbg("response failed: %#x", rbuf[offb + 1]);
567 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
574 mutex_unlock(&instance->cm_serialize);
578 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
584 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
585 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
587 buf = kmalloc(buflen, GFP_KERNEL);
591 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
595 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
597 for (offb = 0; offb < len; ) {
598 int l = le32_to_cpu(buf[offb++]);
599 if (l > stride || l > (len - offb) / 2) {
600 dbg("wrong data length %#x in response", l);
605 offd = le32_to_cpu(buf[offb++]);
607 dbg("wrong index %#x in response", offd);
611 data[offd] = le32_to_cpu(buf[offb++]);
622 static int cxacru_card_status(struct cxacru_data *instance)
624 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
625 if (ret < 0) { /* firmware not loaded */
626 dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret);
632 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
633 struct atm_dev *atm_dev)
635 struct usb_interface *intf = usbatm_instance->usb_intf;
637 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
638 device_remove_file(&intf->dev, &dev_attr_##_name);
639 CXACRU_ALL_FILES(REMOVE);
640 #undef CXACRU_DEVICE_REMOVE_FILE
643 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
644 struct atm_dev *atm_dev)
646 struct cxacru_data *instance = usbatm_instance->driver_data;
647 struct usb_interface *intf = usbatm_instance->usb_intf;
649 struct atm_dev *atm_dev = usbatm_instance->atm_dev;
652 int start_polling = 1;
654 dbg("cxacru_atm_start");
656 /* Read MAC address */
657 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
658 atm_dev->esi, sizeof(atm_dev->esi));
660 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
664 #define CXACRU_DEVICE_CREATE_FILE(_name) \
665 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
668 CXACRU_ALL_FILES(CREATE);
669 #undef CXACRU_DEVICE_CREATE_FILE
672 mutex_lock(&instance->adsl_state_serialize);
673 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
675 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
676 mutex_unlock(&instance->adsl_state_serialize);
680 /* Start status polling */
681 mutex_lock(&instance->poll_state_serialize);
682 switch (instance->poll_state) {
685 instance->poll_state = CXPOLL_POLLING;
688 case CXPOLL_STOPPING:
689 /* abort stop request */
690 instance->poll_state = CXPOLL_POLLING;
692 case CXPOLL_SHUTDOWN:
693 /* don't start polling */
696 mutex_unlock(&instance->poll_state_serialize);
697 mutex_unlock(&instance->adsl_state_serialize);
700 cxacru_poll_status(&instance->poll_work.work);
704 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
705 cxacru_remove_device_files(usbatm_instance, atm_dev);
709 static void cxacru_poll_status(struct work_struct *work)
711 struct cxacru_data *instance =
712 container_of(work, struct cxacru_data, poll_work.work);
713 u32 buf[CXINF_MAX] = {};
714 struct usbatm_data *usbatm = instance->usbatm;
715 struct atm_dev *atm_dev = usbatm->atm_dev;
716 int keep_polling = 1;
719 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
721 if (ret != -ESHUTDOWN)
722 atm_warn(usbatm, "poll status: error %d\n", ret);
724 mutex_lock(&instance->poll_state_serialize);
725 if (instance->poll_state != CXPOLL_SHUTDOWN) {
726 instance->poll_state = CXPOLL_STOPPED;
728 if (ret != -ESHUTDOWN)
729 atm_warn(usbatm, "polling disabled, set adsl_state"
730 " to 'start' or 'poll' to resume\n");
732 mutex_unlock(&instance->poll_state_serialize);
736 memcpy(instance->card_info, buf, sizeof(instance->card_info));
738 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
739 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
741 switch (instance->adsl_status) {
743 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
747 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
751 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
756 if (instance->line_status == buf[CXINF_LINE_STATUS])
759 instance->line_status = buf[CXINF_LINE_STATUS];
760 switch (instance->line_status) {
762 atm_dev->signal = ATM_PHY_SIG_LOST;
763 atm_info(usbatm, "ADSL line: down\n");
767 atm_dev->signal = ATM_PHY_SIG_LOST;
768 atm_info(usbatm, "ADSL line: attempting to activate\n");
772 atm_dev->signal = ATM_PHY_SIG_LOST;
773 atm_info(usbatm, "ADSL line: training\n");
777 atm_dev->signal = ATM_PHY_SIG_LOST;
778 atm_info(usbatm, "ADSL line: channel analysis\n");
782 atm_dev->signal = ATM_PHY_SIG_LOST;
783 atm_info(usbatm, "ADSL line: exchange\n");
787 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
788 atm_dev->signal = ATM_PHY_SIG_FOUND;
790 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
791 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
795 atm_dev->signal = ATM_PHY_SIG_LOST;
796 atm_info(usbatm, "ADSL line: waiting\n");
800 atm_dev->signal = ATM_PHY_SIG_LOST;
801 atm_info(usbatm, "ADSL line: initializing\n");
805 atm_dev->signal = ATM_PHY_SIG_UNKNOWN;
806 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
811 mutex_lock(&instance->poll_state_serialize);
812 if (instance->poll_state == CXPOLL_STOPPING &&
813 instance->adsl_status == 1 && /* stopped */
814 instance->line_status == 0) /* down */
815 instance->poll_state = CXPOLL_STOPPED;
817 if (instance->poll_state == CXPOLL_STOPPED)
819 mutex_unlock(&instance->poll_state_serialize);
822 schedule_delayed_work(&instance->poll_work,
823 round_jiffies_relative(POLL_INTERVAL*HZ));
826 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
827 u8 code1, u8 code2, u32 addr, u8 *data, int size)
832 const int stride = CMD_PACKET_SIZE - 8;
834 buf = (u8 *) __get_free_page(GFP_KERNEL);
840 int l = min_t(int, stride, size - offd);
845 *((u32 *) (buf + offb)) = cpu_to_le32(addr);
849 memcpy(buf + offb, data + offd, l);
851 memset(buf + offb + l, 0, stride - l);
854 if ((offb >= PAGE_SIZE) || (offd >= size)) {
855 ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
856 buf, offb, NULL, CMD_TIMEOUT);
858 dbg("sending fw %#x failed", fw);
863 } while(offd < size);
864 dbg("sent fw %#x", fw);
869 free_page((unsigned long) buf);
873 static void cxacru_upload_firmware(struct cxacru_data *instance,
874 const struct firmware *fw,
875 const struct firmware *bp,
876 const struct firmware *cf)
880 struct usbatm_data *usbatm = instance->usbatm;
881 struct usb_device *usb_dev = usbatm->usb_dev;
882 u16 signature[] = { usb_dev->descriptor.idVendor, usb_dev->descriptor.idProduct };
885 dbg("cxacru_upload_firmware");
887 /* FirmwarePllFClkValue */
888 val = cpu_to_le32(instance->modem_type->pll_f_clk);
889 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
891 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
895 /* FirmwarePllBClkValue */
896 val = cpu_to_le32(instance->modem_type->pll_b_clk);
897 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
899 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
904 val = cpu_to_le32(SDRAM_ENA);
905 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
907 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
912 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
914 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
919 if (instance->modem_type->boot_rom_patch) {
920 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
922 usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
928 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
930 usb_err(usbatm, "Signature storing failed: %d\n", ret);
934 if (instance->modem_type->boot_rom_patch) {
935 val = cpu_to_le32(BR_ADDR);
936 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
939 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
942 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
946 /* Delay to allow firmware to start up. */
947 msleep_interruptible(1000);
949 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
950 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
951 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
952 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
954 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
956 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
960 /* Load config data (le32), doing one packet at a time */
962 for (off = 0; off < cf->size / 4; ) {
963 u32 buf[CMD_PACKET_SIZE / 4 - 1];
964 int i, len = min_t(int, cf->size / 4 - off, CMD_PACKET_SIZE / 4 / 2 - 1);
965 buf[0] = cpu_to_le32(len);
966 for (i = 0; i < len; i++, off++) {
967 buf[i * 2 + 1] = cpu_to_le32(off);
968 memcpy(buf + i * 2 + 2, cf->data + off * 4, 4);
970 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
971 (u8 *) buf, len, NULL, 0);
973 usb_err(usbatm, "load config data failed: %d\n", ret);
978 msleep_interruptible(4000);
981 static int cxacru_find_firmware(struct cxacru_data *instance,
982 char* phase, const struct firmware **fw_p)
984 struct usbatm_data *usbatm = instance->usbatm;
985 struct device *dev = &usbatm->usb_intf->dev;
988 sprintf(buf, "cxacru-%s.bin", phase);
989 dbg("cxacru_find_firmware: looking for %s", buf);
991 if (request_firmware(fw_p, buf, dev)) {
992 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
996 usb_info(usbatm, "found firmware %s\n", buf);
1001 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1002 struct usb_interface *usb_intf)
1004 const struct firmware *fw, *bp, *cf;
1005 struct cxacru_data *instance = usbatm_instance->driver_data;
1007 int ret = cxacru_find_firmware(instance, "fw", &fw);
1009 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1013 if (instance->modem_type->boot_rom_patch) {
1014 ret = cxacru_find_firmware(instance, "bp", &bp);
1016 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1017 release_firmware(fw);
1022 if (cxacru_find_firmware(instance, "cf", &cf)) /* optional */
1025 cxacru_upload_firmware(instance, fw, bp, cf);
1028 release_firmware(cf);
1029 if (instance->modem_type->boot_rom_patch)
1030 release_firmware(bp);
1031 release_firmware(fw);
1033 ret = cxacru_card_status(instance);
1035 dbg("modem initialisation failed");
1037 dbg("done setting up the modem");
1042 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1043 struct usb_interface *intf, const struct usb_device_id *id)
1045 struct cxacru_data *instance;
1046 struct usb_device *usb_dev = interface_to_usbdev(intf);
1050 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1052 dbg("cxacru_bind: no memory for instance data");
1056 instance->usbatm = usbatm_instance;
1057 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1058 memset(instance->card_info, 0, sizeof(instance->card_info));
1060 mutex_init(&instance->poll_state_serialize);
1061 instance->poll_state = CXPOLL_STOPPED;
1062 instance->line_status = -1;
1063 instance->adsl_status = -1;
1065 mutex_init(&instance->adsl_state_serialize);
1067 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1068 if (!instance->rcv_buf) {
1069 dbg("cxacru_bind: no memory for rcv_buf");
1073 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1074 if (!instance->snd_buf) {
1075 dbg("cxacru_bind: no memory for snd_buf");
1079 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1080 if (!instance->rcv_urb) {
1081 dbg("cxacru_bind: no memory for rcv_urb");
1085 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1086 if (!instance->snd_urb) {
1087 dbg("cxacru_bind: no memory for snd_urb");
1092 usb_fill_int_urb(instance->rcv_urb,
1093 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1094 instance->rcv_buf, PAGE_SIZE,
1095 cxacru_blocking_completion, &instance->rcv_done, 1);
1097 usb_fill_int_urb(instance->snd_urb,
1098 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1099 instance->snd_buf, PAGE_SIZE,
1100 cxacru_blocking_completion, &instance->snd_done, 4);
1102 mutex_init(&instance->cm_serialize);
1104 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1106 usbatm_instance->driver_data = instance;
1108 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1113 free_page((unsigned long) instance->snd_buf);
1114 free_page((unsigned long) instance->rcv_buf);
1115 usb_free_urb(instance->snd_urb);
1116 usb_free_urb(instance->rcv_urb);
1122 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1123 struct usb_interface *intf)
1125 struct cxacru_data *instance = usbatm_instance->driver_data;
1128 dbg("cxacru_unbind entered");
1131 dbg("cxacru_unbind: NULL instance!");
1135 mutex_lock(&instance->poll_state_serialize);
1136 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1138 /* ensure that status polling continues unless
1139 * it has already stopped */
1140 if (instance->poll_state == CXPOLL_STOPPED)
1143 /* stop polling from being stopped or started */
1144 instance->poll_state = CXPOLL_SHUTDOWN;
1145 mutex_unlock(&instance->poll_state_serialize);
1148 cancel_rearming_delayed_work(&instance->poll_work);
1150 usb_kill_urb(instance->snd_urb);
1151 usb_kill_urb(instance->rcv_urb);
1152 usb_free_urb(instance->snd_urb);
1153 usb_free_urb(instance->rcv_urb);
1155 free_page((unsigned long) instance->snd_buf);
1156 free_page((unsigned long) instance->rcv_buf);
1160 usbatm_instance->driver_data = NULL;
1163 static const struct cxacru_modem_type cxacru_cafe = {
1164 .pll_f_clk = 0x02d874df,
1165 .pll_b_clk = 0x0196a51a,
1166 .boot_rom_patch = 1,
1169 static const struct cxacru_modem_type cxacru_cb00 = {
1172 .boot_rom_patch = 0,
1175 static const struct usb_device_id cxacru_usb_ids[] = {
1176 { /* V = Conexant P = ADSL modem (Euphrates project) */
1177 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1179 { /* V = Conexant P = ADSL modem (Hasbani project) */
1180 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1182 { /* V = Conexant P = ADSL modem */
1183 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1185 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1186 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1188 { /* V = Conexant P = ADSL modem */
1189 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1191 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1192 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1194 { /* V = Olitec P = ADSL modem version 2 */
1195 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1197 { /* V = Olitec P = ADSL modem version 3 */
1198 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1200 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1201 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1203 { /* V = Zoom P = 5510 */
1204 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1206 { /* V = Draytek P = Vigor 318 */
1207 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1209 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1210 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1212 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1213 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1215 { /* V = Aethra P = Starmodem UM1020 */
1216 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1218 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1219 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1221 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1222 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1224 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1225 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1230 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1232 static struct usbatm_driver cxacru_driver = {
1233 .driver_name = cxacru_driver_name,
1234 .bind = cxacru_bind,
1235 .heavy_init = cxacru_heavy_init,
1236 .unbind = cxacru_unbind,
1237 .atm_start = cxacru_atm_start,
1238 .atm_stop = cxacru_remove_device_files,
1239 .bulk_in = CXACRU_EP_DATA,
1240 .bulk_out = CXACRU_EP_DATA,
1245 static int cxacru_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1247 return usbatm_usb_probe(intf, id, &cxacru_driver);
1250 static struct usb_driver cxacru_usb_driver = {
1251 .name = cxacru_driver_name,
1252 .probe = cxacru_usb_probe,
1253 .disconnect = usbatm_usb_disconnect,
1254 .id_table = cxacru_usb_ids
1257 static int __init cxacru_init(void)
1259 return usb_register(&cxacru_usb_driver);
1262 static void __exit cxacru_cleanup(void)
1264 usb_deregister(&cxacru_usb_driver);
1267 module_init(cxacru_init);
1268 module_exit(cxacru_cleanup);
1270 MODULE_AUTHOR(DRIVER_AUTHOR);
1271 MODULE_DESCRIPTION(DRIVER_DESC);
1272 MODULE_LICENSE("GPL");
1273 MODULE_VERSION(DRIVER_VERSION);