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;
174 enum cxacru_poll_state poll_state;
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 return snprintf(buf, PAGE_SIZE, "%d.%02u\n",
230 value / 100, abs(value) % 100);
233 static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
235 static char *str[] = { "no", "yes" };
236 if (unlikely(value >= ARRAY_SIZE(str)))
237 return snprintf(buf, PAGE_SIZE, "%u\n", value);
238 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
241 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
243 static char *str[] = { NULL, "not connected", "connected", "lost" };
244 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
245 return snprintf(buf, PAGE_SIZE, "%u\n", value);
246 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
249 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
251 static char *str[] = { "down", "attempting to activate",
252 "training", "channel analysis", "exchange", "up",
253 "waiting", "initialising"
255 if (unlikely(value >= ARRAY_SIZE(str)))
256 return snprintf(buf, PAGE_SIZE, "%u\n", value);
257 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
260 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
262 static char *str[] = {
265 "ITU-T G.992.1 (G.DMT)",
266 "ITU-T G.992.2 (G.LITE)"
268 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
269 return snprintf(buf, PAGE_SIZE, "%u\n", value);
270 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
274 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
275 * this data is already in atm_dev there's no point.
277 * MAC_ADDRESS_HIGH = 0x????5544
278 * MAC_ADDRESS_LOW = 0x33221100
279 * Where 00-55 are bytes 0-5 of the MAC.
281 static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
282 struct device_attribute *attr, char *buf)
284 struct usb_interface *intf = to_usb_interface(dev);
285 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
286 struct atm_dev *atm_dev = usbatm_instance->atm_dev;
288 return snprintf(buf, PAGE_SIZE, "%02x:%02x:%02x:%02x:%02x:%02x\n",
289 atm_dev->esi[0], atm_dev->esi[1], atm_dev->esi[2],
290 atm_dev->esi[3], atm_dev->esi[4], atm_dev->esi[5]);
293 static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
294 struct device_attribute *attr, char *buf)
296 struct usb_interface *intf = to_usb_interface(dev);
297 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
298 struct cxacru_data *instance = usbatm_instance->driver_data;
299 u32 value = instance->card_info[CXINF_LINE_STARTABLE];
301 static char *str[] = { "running", "stopped" };
302 if (unlikely(value >= ARRAY_SIZE(str)))
303 return snprintf(buf, PAGE_SIZE, "%u\n", value);
304 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
307 static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
308 struct device_attribute *attr, const char *buf, size_t count)
310 struct usb_interface *intf = to_usb_interface(dev);
311 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf);
312 struct cxacru_data *instance = usbatm_instance->driver_data;
316 int len = strlen(buf);
318 if (!capable(CAP_NET_ADMIN))
321 ret = sscanf(buf, "%7s", str_cmd);
326 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
329 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
330 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
332 atm_err(usbatm_instance, "change adsl state:"
333 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
338 poll = CXPOLL_STOPPED;
342 /* Line status is only updated every second
343 * and the device appears to only react to
344 * START/STOP every second too. Wait 1.5s to
345 * be sure that restart will have an effect. */
346 if (!strcmp(str_cmd, "restart"))
349 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
350 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
352 atm_err(usbatm_instance, "change adsl state:"
353 " CHIP_ADSL_LINE_START returned %d\n", ret);
358 poll = CXPOLL_POLLING;
362 if (!strcmp(str_cmd, "poll")) {
364 poll = CXPOLL_POLLING;
372 if (poll == CXPOLL_POLLING) {
373 mutex_lock(&instance->poll_state_serialize);
374 switch (instance->poll_state) {
377 instance->poll_state = CXPOLL_POLLING;
380 case CXPOLL_STOPPING:
381 /* abort stop request */
382 instance->poll_state = CXPOLL_POLLING;
384 case CXPOLL_SHUTDOWN:
385 /* don't start polling */
388 mutex_unlock(&instance->poll_state_serialize);
389 } else if (poll == CXPOLL_STOPPED) {
390 mutex_lock(&instance->poll_state_serialize);
392 if (instance->poll_state == CXPOLL_POLLING)
393 instance->poll_state = CXPOLL_STOPPING;
394 mutex_unlock(&instance->poll_state_serialize);
397 mutex_unlock(&instance->adsl_state_serialize);
399 if (poll == CXPOLL_POLLING)
400 cxacru_poll_status(&instance->poll_work.work);
406 * All device attributes are included in CXACRU_ALL_FILES
407 * so that the same list can be used multiple times:
408 * INIT (define the device attributes)
409 * CREATE (create all the device files)
410 * REMOVE (remove all the device files)
412 * With the last two being defined as needed in the functions
413 * they are used in before calling CXACRU_ALL_FILES()
415 #define CXACRU_ALL_FILES(_action) \
416 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
417 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
418 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
419 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
420 CXACRU__ATTR_##_action( mac_address); \
421 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
422 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
423 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
424 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
425 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
426 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
427 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
428 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
429 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
430 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
431 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
432 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
433 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
434 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
435 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
436 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
437 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
438 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
439 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
440 CXACRU_CMD_##_action( adsl_state);
442 CXACRU_ALL_FILES(INIT);
444 /* the following three functions are stolen from drivers/usb/core/message.c */
445 static void cxacru_blocking_completion(struct urb *urb)
447 complete((struct completion *)urb->context);
450 static void cxacru_timeout_kill(unsigned long data)
452 usb_unlink_urb((struct urb *) data);
455 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
458 struct timer_list timer;
462 timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
463 timer.data = (unsigned long) urb;
464 timer.function = cxacru_timeout_kill;
466 wait_for_completion(done);
467 status = urb->status;
468 del_timer_sync(&timer);
471 *actual_length = urb->actual_length;
475 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
476 u8 *wdata, int wsize, u8 *rdata, int rsize)
480 const int stride = CMD_PACKET_SIZE - 4;
481 u8 *wbuf = instance->snd_buf;
482 u8 *rbuf = instance->rcv_buf;
483 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
484 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
486 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
487 dbg("too big transfer requested");
492 mutex_lock(&instance->cm_serialize);
494 /* submit reading urb before the writing one */
495 init_completion(&instance->rcv_done);
496 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
498 dbg("submitting read urb for cm %#x failed", cm);
503 memset(wbuf, 0, wbuflen);
504 /* handle wsize == 0 */
506 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
508 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
511 instance->snd_urb->transfer_buffer_length = wbuflen;
512 init_completion(&instance->snd_done);
513 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
515 dbg("submitting write urb for cm %#x failed", cm);
520 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
522 dbg("sending cm %#x failed", cm);
527 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
529 dbg("receiving cm %#x failed", cm);
533 if (actlen % CMD_PACKET_SIZE || !actlen) {
534 dbg("response is not a positive multiple of %d: %#x",
535 CMD_PACKET_SIZE, actlen);
540 /* check the return status and copy the data to the output buffer, if needed */
541 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
542 if (rbuf[offb] != cm) {
543 dbg("wrong cm %#x in response", rbuf[offb]);
547 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
548 dbg("response failed: %#x", rbuf[offb + 1]);
554 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
561 mutex_unlock(&instance->cm_serialize);
565 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
571 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
572 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
574 buf = kmalloc(buflen, GFP_KERNEL);
578 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
582 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
584 for (offb = 0; offb < len; ) {
585 int l = le32_to_cpu(buf[offb++]);
586 if (l > stride || l > (len - offb) / 2) {
587 dbg("wrong data length %#x in response", l);
592 offd = le32_to_cpu(buf[offb++]);
594 dbg("wrong index %#x in response", offd);
598 data[offd] = le32_to_cpu(buf[offb++]);
609 static int cxacru_card_status(struct cxacru_data *instance)
611 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
612 if (ret < 0) { /* firmware not loaded */
613 dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret);
619 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
620 struct atm_dev *atm_dev)
622 struct usb_interface *intf = usbatm_instance->usb_intf;
624 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
625 device_remove_file(&intf->dev, &dev_attr_##_name);
626 CXACRU_ALL_FILES(REMOVE);
627 #undef CXACRU_DEVICE_REMOVE_FILE
630 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
631 struct atm_dev *atm_dev)
633 struct cxacru_data *instance = usbatm_instance->driver_data;
634 struct usb_interface *intf = usbatm_instance->usb_intf;
636 struct atm_dev *atm_dev = usbatm_instance->atm_dev;
639 int start_polling = 1;
641 dbg("cxacru_atm_start");
643 /* Read MAC address */
644 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
645 atm_dev->esi, sizeof(atm_dev->esi));
647 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
651 #define CXACRU_DEVICE_CREATE_FILE(_name) \
652 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
655 CXACRU_ALL_FILES(CREATE);
656 #undef CXACRU_DEVICE_CREATE_FILE
659 mutex_lock(&instance->adsl_state_serialize);
660 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
662 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
664 /* Start status polling */
665 mutex_lock(&instance->poll_state_serialize);
666 switch (instance->poll_state) {
669 instance->poll_state = CXPOLL_POLLING;
672 case CXPOLL_STOPPING:
673 /* abort stop request */
674 instance->poll_state = CXPOLL_POLLING;
676 case CXPOLL_SHUTDOWN:
677 /* don't start polling */
680 mutex_unlock(&instance->poll_state_serialize);
681 mutex_unlock(&instance->adsl_state_serialize);
684 cxacru_poll_status(&instance->poll_work.work);
688 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
689 cxacru_remove_device_files(usbatm_instance, atm_dev);
693 static void cxacru_poll_status(struct work_struct *work)
695 struct cxacru_data *instance =
696 container_of(work, struct cxacru_data, poll_work.work);
697 u32 buf[CXINF_MAX] = {};
698 struct usbatm_data *usbatm = instance->usbatm;
699 struct atm_dev *atm_dev = usbatm->atm_dev;
700 int keep_polling = 1;
703 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
705 if (ret != -ESHUTDOWN)
706 atm_warn(usbatm, "poll status: error %d\n", ret);
708 mutex_lock(&instance->poll_state_serialize);
709 if (instance->poll_state != CXPOLL_SHUTDOWN) {
710 instance->poll_state = CXPOLL_STOPPED;
712 if (ret != -ESHUTDOWN)
713 atm_warn(usbatm, "polling disabled, set adsl_state"
714 " to 'start' or 'poll' to resume\n");
716 mutex_unlock(&instance->poll_state_serialize);
720 memcpy(instance->card_info, buf, sizeof(instance->card_info));
722 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
723 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
725 switch (instance->adsl_status) {
727 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
731 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
735 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
740 if (instance->line_status == buf[CXINF_LINE_STATUS])
743 instance->line_status = buf[CXINF_LINE_STATUS];
744 switch (instance->line_status) {
746 atm_dev->signal = ATM_PHY_SIG_LOST;
747 atm_info(usbatm, "ADSL line: down\n");
751 atm_dev->signal = ATM_PHY_SIG_LOST;
752 atm_info(usbatm, "ADSL line: attempting to activate\n");
756 atm_dev->signal = ATM_PHY_SIG_LOST;
757 atm_info(usbatm, "ADSL line: training\n");
761 atm_dev->signal = ATM_PHY_SIG_LOST;
762 atm_info(usbatm, "ADSL line: channel analysis\n");
766 atm_dev->signal = ATM_PHY_SIG_LOST;
767 atm_info(usbatm, "ADSL line: exchange\n");
771 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
772 atm_dev->signal = ATM_PHY_SIG_FOUND;
774 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
775 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
779 atm_dev->signal = ATM_PHY_SIG_LOST;
780 atm_info(usbatm, "ADSL line: waiting\n");
784 atm_dev->signal = ATM_PHY_SIG_LOST;
785 atm_info(usbatm, "ADSL line: initializing\n");
789 atm_dev->signal = ATM_PHY_SIG_UNKNOWN;
790 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
795 mutex_lock(&instance->poll_state_serialize);
796 if (instance->poll_state == CXPOLL_STOPPING &&
797 instance->adsl_status == 1 && /* stopped */
798 instance->line_status == 0) /* down */
799 instance->poll_state = CXPOLL_STOPPED;
801 if (instance->poll_state == CXPOLL_STOPPED)
803 mutex_unlock(&instance->poll_state_serialize);
806 schedule_delayed_work(&instance->poll_work,
807 round_jiffies_relative(POLL_INTERVAL*HZ));
810 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
811 u8 code1, u8 code2, u32 addr, u8 *data, int size)
816 const int stride = CMD_PACKET_SIZE - 8;
818 buf = (u8 *) __get_free_page(GFP_KERNEL);
824 int l = min_t(int, stride, size - offd);
829 *((u32 *) (buf + offb)) = cpu_to_le32(addr);
833 memcpy(buf + offb, data + offd, l);
835 memset(buf + offb + l, 0, stride - l);
838 if ((offb >= PAGE_SIZE) || (offd >= size)) {
839 ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
840 buf, offb, NULL, CMD_TIMEOUT);
842 dbg("sending fw %#x failed", fw);
847 } while(offd < size);
848 dbg("sent fw %#x", fw);
853 free_page((unsigned long) buf);
857 static void cxacru_upload_firmware(struct cxacru_data *instance,
858 const struct firmware *fw,
859 const struct firmware *bp,
860 const struct firmware *cf)
864 struct usbatm_data *usbatm = instance->usbatm;
865 struct usb_device *usb_dev = usbatm->usb_dev;
866 u16 signature[] = { usb_dev->descriptor.idVendor, usb_dev->descriptor.idProduct };
869 dbg("cxacru_upload_firmware");
871 /* FirmwarePllFClkValue */
872 val = cpu_to_le32(instance->modem_type->pll_f_clk);
873 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
875 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
879 /* FirmwarePllBClkValue */
880 val = cpu_to_le32(instance->modem_type->pll_b_clk);
881 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
883 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
888 val = cpu_to_le32(SDRAM_ENA);
889 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
891 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
896 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
898 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
903 if (instance->modem_type->boot_rom_patch) {
904 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
906 usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
912 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
914 usb_err(usbatm, "Signature storing failed: %d\n", ret);
918 if (instance->modem_type->boot_rom_patch) {
919 val = cpu_to_le32(BR_ADDR);
920 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
923 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
926 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
930 /* Delay to allow firmware to start up. */
931 msleep_interruptible(1000);
933 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
934 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
935 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
936 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
938 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
940 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
944 /* Load config data (le32), doing one packet at a time */
946 for (off = 0; off < cf->size / 4; ) {
947 u32 buf[CMD_PACKET_SIZE / 4 - 1];
948 int i, len = min_t(int, cf->size / 4 - off, CMD_PACKET_SIZE / 4 / 2 - 1);
949 buf[0] = cpu_to_le32(len);
950 for (i = 0; i < len; i++, off++) {
951 buf[i * 2 + 1] = cpu_to_le32(off);
952 memcpy(buf + i * 2 + 2, cf->data + off * 4, 4);
954 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
955 (u8 *) buf, len, NULL, 0);
957 usb_err(usbatm, "load config data failed: %d\n", ret);
962 msleep_interruptible(4000);
965 static int cxacru_find_firmware(struct cxacru_data *instance,
966 char* phase, const struct firmware **fw_p)
968 struct usbatm_data *usbatm = instance->usbatm;
969 struct device *dev = &usbatm->usb_intf->dev;
972 sprintf(buf, "cxacru-%s.bin", phase);
973 dbg("cxacru_find_firmware: looking for %s", buf);
975 if (request_firmware(fw_p, buf, dev)) {
976 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
980 usb_info(usbatm, "found firmware %s\n", buf);
985 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
986 struct usb_interface *usb_intf)
988 const struct firmware *fw, *bp, *cf;
989 struct cxacru_data *instance = usbatm_instance->driver_data;
991 int ret = cxacru_find_firmware(instance, "fw", &fw);
993 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
997 if (instance->modem_type->boot_rom_patch) {
998 ret = cxacru_find_firmware(instance, "bp", &bp);
1000 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1001 release_firmware(fw);
1006 if (cxacru_find_firmware(instance, "cf", &cf)) /* optional */
1009 cxacru_upload_firmware(instance, fw, bp, cf);
1012 release_firmware(cf);
1013 if (instance->modem_type->boot_rom_patch)
1014 release_firmware(bp);
1015 release_firmware(fw);
1017 ret = cxacru_card_status(instance);
1019 dbg("modem initialisation failed");
1021 dbg("done setting up the modem");
1026 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1027 struct usb_interface *intf, const struct usb_device_id *id)
1029 struct cxacru_data *instance;
1030 struct usb_device *usb_dev = interface_to_usbdev(intf);
1034 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1036 dbg("cxacru_bind: no memory for instance data");
1040 instance->usbatm = usbatm_instance;
1041 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1042 memset(instance->card_info, 0, sizeof(instance->card_info));
1044 mutex_init(&instance->poll_state_serialize);
1045 instance->poll_state = CXPOLL_STOPPED;
1046 instance->line_status = -1;
1047 instance->adsl_status = -1;
1049 mutex_init(&instance->adsl_state_serialize);
1051 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1052 if (!instance->rcv_buf) {
1053 dbg("cxacru_bind: no memory for rcv_buf");
1057 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1058 if (!instance->snd_buf) {
1059 dbg("cxacru_bind: no memory for snd_buf");
1063 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1064 if (!instance->rcv_urb) {
1065 dbg("cxacru_bind: no memory for rcv_urb");
1069 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1070 if (!instance->snd_urb) {
1071 dbg("cxacru_bind: no memory for snd_urb");
1076 usb_fill_int_urb(instance->rcv_urb,
1077 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1078 instance->rcv_buf, PAGE_SIZE,
1079 cxacru_blocking_completion, &instance->rcv_done, 1);
1081 usb_fill_int_urb(instance->snd_urb,
1082 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1083 instance->snd_buf, PAGE_SIZE,
1084 cxacru_blocking_completion, &instance->snd_done, 4);
1086 mutex_init(&instance->cm_serialize);
1088 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1090 usbatm_instance->driver_data = instance;
1092 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1097 free_page((unsigned long) instance->snd_buf);
1098 free_page((unsigned long) instance->rcv_buf);
1099 usb_free_urb(instance->snd_urb);
1100 usb_free_urb(instance->rcv_urb);
1106 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1107 struct usb_interface *intf)
1109 struct cxacru_data *instance = usbatm_instance->driver_data;
1112 dbg("cxacru_unbind entered");
1115 dbg("cxacru_unbind: NULL instance!");
1119 mutex_lock(&instance->poll_state_serialize);
1120 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1122 /* ensure that status polling continues unless
1123 * it has already stopped */
1124 if (instance->poll_state == CXPOLL_STOPPED)
1127 /* stop polling from being stopped or started */
1128 instance->poll_state = CXPOLL_SHUTDOWN;
1129 mutex_unlock(&instance->poll_state_serialize);
1132 cancel_rearming_delayed_work(&instance->poll_work);
1134 usb_kill_urb(instance->snd_urb);
1135 usb_kill_urb(instance->rcv_urb);
1136 usb_free_urb(instance->snd_urb);
1137 usb_free_urb(instance->rcv_urb);
1139 free_page((unsigned long) instance->snd_buf);
1140 free_page((unsigned long) instance->rcv_buf);
1144 usbatm_instance->driver_data = NULL;
1147 static const struct cxacru_modem_type cxacru_cafe = {
1148 .pll_f_clk = 0x02d874df,
1149 .pll_b_clk = 0x0196a51a,
1150 .boot_rom_patch = 1,
1153 static const struct cxacru_modem_type cxacru_cb00 = {
1156 .boot_rom_patch = 0,
1159 static const struct usb_device_id cxacru_usb_ids[] = {
1160 { /* V = Conexant P = ADSL modem (Euphrates project) */
1161 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1163 { /* V = Conexant P = ADSL modem (Hasbani project) */
1164 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1166 { /* V = Conexant P = ADSL modem */
1167 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1169 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1170 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1172 { /* V = Conexant P = ADSL modem */
1173 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1175 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1176 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1178 { /* V = Olitec P = ADSL modem version 2 */
1179 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1181 { /* V = Olitec P = ADSL modem version 3 */
1182 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1184 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1185 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1187 { /* V = Zoom P = 5510 */
1188 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1190 { /* V = Draytek P = Vigor 318 */
1191 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1193 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1194 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1196 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1197 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1199 { /* V = Aethra P = Starmodem UM1020 */
1200 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1202 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1203 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1205 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1206 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1208 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1209 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1214 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1216 static struct usbatm_driver cxacru_driver = {
1217 .driver_name = cxacru_driver_name,
1218 .bind = cxacru_bind,
1219 .heavy_init = cxacru_heavy_init,
1220 .unbind = cxacru_unbind,
1221 .atm_start = cxacru_atm_start,
1222 .atm_stop = cxacru_remove_device_files,
1223 .bulk_in = CXACRU_EP_DATA,
1224 .bulk_out = CXACRU_EP_DATA,
1229 static int cxacru_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1231 return usbatm_usb_probe(intf, id, &cxacru_driver);
1234 static struct usb_driver cxacru_usb_driver = {
1235 .name = cxacru_driver_name,
1236 .probe = cxacru_usb_probe,
1237 .disconnect = usbatm_usb_disconnect,
1238 .id_table = cxacru_usb_ids
1241 static int __init cxacru_init(void)
1243 return usb_register(&cxacru_usb_driver);
1246 static void __exit cxacru_cleanup(void)
1248 usb_deregister(&cxacru_usb_driver);
1251 module_init(cxacru_init);
1252 module_exit(cxacru_cleanup);
1254 MODULE_AUTHOR(DRIVER_AUTHOR);
1255 MODULE_DESCRIPTION(DRIVER_DESC);
1256 MODULE_LICENSE("GPL");
1257 MODULE_VERSION(DRIVER_VERSION);