1 // SPDX-License-Identifier: GPL-2.0+
2 /******************************************************************************
3 * cxacru.c - driver for USB ADSL modems based on
4 * Conexant AccessRunner chipset
6 * Copyright (C) 2004 David Woodhouse, Duncan Sands, Roman Kagan
7 * Copyright (C) 2005 Duncan Sands, Roman Kagan (rkagan % mail ! ru)
8 * Copyright (C) 2007 Simon Arlott
9 * Copyright (C) 2009 Simon Arlott
10 ******************************************************************************/
13 * Credit is due for Josep Comas, who created the original patch to speedtch.c
14 * to support the different padding used by the AccessRunner (now generalized
15 * into usbatm), and the userspace firmware loading utility.
18 #include <linux/module.h>
19 #include <linux/moduleparam.h>
20 #include <linux/kernel.h>
21 #include <linux/timer.h>
22 #include <linux/errno.h>
23 #include <linux/slab.h>
24 #include <linux/device.h>
25 #include <linux/firmware.h>
26 #include <linux/mutex.h>
27 #include <asm/unaligned.h>
31 #define DRIVER_AUTHOR "Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
32 #define DRIVER_DESC "Conexant AccessRunner ADSL USB modem driver"
34 static const char cxacru_driver_name[] = "cxacru";
36 #define CXACRU_EP_CMD 0x01 /* Bulk/interrupt in/out */
37 #define CXACRU_EP_DATA 0x02 /* Bulk in/out */
39 #define CMD_PACKET_SIZE 64 /* Should be maxpacket(ep)? */
40 #define CMD_MAX_CONFIG ((CMD_PACKET_SIZE / 4 - 1) / 2)
43 #define PLLFCLK_ADDR 0x00350068
44 #define PLLBCLK_ADDR 0x0035006c
45 #define SDRAMEN_ADDR 0x00350010
46 #define FW_ADDR 0x00801000
47 #define BR_ADDR 0x00180600
48 #define SIG_ADDR 0x00180500
49 #define BR_STACK_ADDR 0x00187f10
54 #define CMD_TIMEOUT 2000 /* msecs */
55 #define POLL_INTERVAL 1 /* secs */
57 /* commands for interaction with the modem through the control channel before
58 * firmware is loaded */
59 enum cxacru_fw_request {
69 /* commands for interaction with the modem through the control channel once
70 * firmware is loaded */
71 enum cxacru_cm_request {
72 CM_REQUEST_UNDEFINED = 0x80,
74 CM_REQUEST_CHIP_GET_MAC_ADDRESS,
75 CM_REQUEST_CHIP_GET_DP_VERSIONS,
76 CM_REQUEST_CHIP_ADSL_LINE_START,
77 CM_REQUEST_CHIP_ADSL_LINE_STOP,
78 CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
79 CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
80 CM_REQUEST_CARD_INFO_GET,
81 CM_REQUEST_CARD_DATA_GET,
82 CM_REQUEST_CARD_DATA_SET,
83 CM_REQUEST_COMMAND_HW_IO,
84 CM_REQUEST_INTERFACE_HW_IO,
85 CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
86 CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
87 CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
88 CM_REQUEST_CARD_GET_STATUS,
89 CM_REQUEST_CARD_GET_MAC_ADDRESS,
90 CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
94 /* commands for interaction with the flash memory
96 * read: response is the contents of the first 60 bytes of flash memory
97 * write: request contains the 60 bytes of data to write to flash memory
98 * response is the contents of the first 60 bytes of flash memory
100 * layout: PP PP VV VV MM MM MM MM MM MM ?? ?? SS SS SS SS SS SS SS SS
101 * SS SS SS SS SS SS SS SS 00 00 00 00 00 00 00 00 00 00 00 00
102 * 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
104 * P: le16 USB Product ID
105 * V: le16 USB Vendor ID
106 * M: be48 MAC Address
107 * S: le16 ASCII Serial Number
109 enum cxacru_cm_flash {
110 CM_FLASH_READ = 0xa1,
111 CM_FLASH_WRITE = 0xa2
114 /* reply codes to the commands above */
115 enum cxacru_cm_status {
119 CM_STATUS_UNSUPPORTED,
120 CM_STATUS_UNIMPLEMENTED,
121 CM_STATUS_PARAMETER_ERROR,
122 CM_STATUS_DBG_LOOPBACK,
126 /* indices into CARD_INFO_GET return array */
127 enum cxacru_info_idx {
128 CXINF_DOWNSTREAM_RATE,
132 CXINF_MAC_ADDRESS_HIGH,
133 CXINF_MAC_ADDRESS_LOW,
134 CXINF_UPSTREAM_SNR_MARGIN,
135 CXINF_DOWNSTREAM_SNR_MARGIN,
136 CXINF_UPSTREAM_ATTENUATION,
137 CXINF_DOWNSTREAM_ATTENUATION,
138 CXINF_TRANSMITTER_POWER,
139 CXINF_UPSTREAM_BITS_PER_FRAME,
140 CXINF_DOWNSTREAM_BITS_PER_FRAME,
141 CXINF_STARTUP_ATTEMPTS,
142 CXINF_UPSTREAM_CRC_ERRORS,
143 CXINF_DOWNSTREAM_CRC_ERRORS,
144 CXINF_UPSTREAM_FEC_ERRORS,
145 CXINF_DOWNSTREAM_FEC_ERRORS,
146 CXINF_UPSTREAM_HEC_ERRORS,
147 CXINF_DOWNSTREAM_HEC_ERRORS,
148 CXINF_LINE_STARTABLE,
151 CXINF_ADSL_HEADEND_ENVIRONMENT,
152 CXINF_CONTROLLER_VERSION,
153 /* dunno what the missing two mean */
157 enum cxacru_poll_state {
164 struct cxacru_modem_type {
171 struct usbatm_data *usbatm;
173 const struct cxacru_modem_type *modem_type;
176 struct mutex adsl_state_serialize;
178 struct delayed_work poll_work;
179 u32 card_info[CXINF_MAX];
180 struct mutex poll_state_serialize;
181 enum cxacru_poll_state poll_state;
184 struct mutex cm_serialize;
189 struct completion rcv_done;
190 struct completion snd_done;
193 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
194 u8 *wdata, int wsize, u8 *rdata, int rsize);
195 static void cxacru_poll_status(struct work_struct *work);
197 /* Card info exported through sysfs */
198 #define CXACRU__ATTR_INIT(_name) \
199 static DEVICE_ATTR_RO(_name)
201 #define CXACRU_CMD_INIT(_name) \
202 static DEVICE_ATTR_RW(_name)
204 #define CXACRU_SET_INIT(_name) \
205 static DEVICE_ATTR_WO(_name)
207 #define CXACRU_ATTR_INIT(_value, _type, _name) \
208 static ssize_t _name##_show(struct device *dev, \
209 struct device_attribute *attr, char *buf) \
211 struct cxacru_data *instance = to_usbatm_driver_data(\
212 to_usb_interface(dev)); \
214 if (instance == NULL) \
217 return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
219 CXACRU__ATTR_INIT(_name)
221 #define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
222 #define CXACRU_CMD_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
223 #define CXACRU_SET_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
224 #define CXACRU__ATTR_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
226 #define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
227 #define CXACRU_CMD_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
228 #define CXACRU_SET_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
229 #define CXACRU__ATTR_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
231 static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
233 return snprintf(buf, PAGE_SIZE, "%u\n", value);
236 static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
238 return snprintf(buf, PAGE_SIZE, "%d\n", value);
241 static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
243 if (likely(value >= 0)) {
244 return snprintf(buf, PAGE_SIZE, "%u.%02u\n",
245 value / 100, value % 100);
248 return snprintf(buf, PAGE_SIZE, "-%u.%02u\n",
249 value / 100, value % 100);
253 static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
255 static char *str[] = { "no", "yes" };
257 if (unlikely(value >= ARRAY_SIZE(str)))
258 return snprintf(buf, PAGE_SIZE, "%u\n", value);
259 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
262 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
264 static char *str[] = { NULL, "not connected", "connected", "lost" };
266 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
267 return snprintf(buf, PAGE_SIZE, "%u\n", value);
268 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
271 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
273 static char *str[] = { "down", "attempting to activate",
274 "training", "channel analysis", "exchange", "up",
275 "waiting", "initialising"
277 if (unlikely(value >= ARRAY_SIZE(str)))
278 return snprintf(buf, PAGE_SIZE, "%u\n", value);
279 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
282 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
284 static char *str[] = {
287 "ITU-T G.992.1 (G.DMT)",
288 "ITU-T G.992.2 (G.LITE)"
290 if (unlikely(value >= ARRAY_SIZE(str)))
291 return snprintf(buf, PAGE_SIZE, "%u\n", value);
292 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
296 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
297 * this data is already in atm_dev there's no point.
299 * MAC_ADDRESS_HIGH = 0x????5544
300 * MAC_ADDRESS_LOW = 0x33221100
301 * Where 00-55 are bytes 0-5 of the MAC.
303 static ssize_t mac_address_show(struct device *dev,
304 struct device_attribute *attr, char *buf)
306 struct cxacru_data *instance = to_usbatm_driver_data(
307 to_usb_interface(dev));
309 if (instance == NULL || instance->usbatm->atm_dev == NULL)
312 return snprintf(buf, PAGE_SIZE, "%pM\n",
313 instance->usbatm->atm_dev->esi);
316 static ssize_t adsl_state_show(struct device *dev,
317 struct device_attribute *attr, char *buf)
319 static char *str[] = { "running", "stopped" };
320 struct cxacru_data *instance = to_usbatm_driver_data(
321 to_usb_interface(dev));
324 if (instance == NULL)
327 value = instance->card_info[CXINF_LINE_STARTABLE];
328 if (unlikely(value >= ARRAY_SIZE(str)))
329 return snprintf(buf, PAGE_SIZE, "%u\n", value);
330 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
333 static ssize_t adsl_state_store(struct device *dev,
334 struct device_attribute *attr, const char *buf, size_t count)
336 struct cxacru_data *instance = to_usbatm_driver_data(
337 to_usb_interface(dev));
341 int len = strlen(buf);
343 if (!capable(CAP_NET_ADMIN))
346 ret = sscanf(buf, "%7s", str_cmd);
351 if (instance == NULL)
354 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
357 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
358 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
360 atm_err(instance->usbatm, "change adsl state:"
361 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
366 poll = CXPOLL_STOPPED;
370 /* Line status is only updated every second
371 * and the device appears to only react to
372 * START/STOP every second too. Wait 1.5s to
373 * be sure that restart will have an effect. */
374 if (!strcmp(str_cmd, "restart"))
377 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
378 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
380 atm_err(instance->usbatm, "change adsl state:"
381 " CHIP_ADSL_LINE_START returned %d\n", ret);
386 poll = CXPOLL_POLLING;
390 if (!strcmp(str_cmd, "poll")) {
392 poll = CXPOLL_POLLING;
400 if (poll == CXPOLL_POLLING) {
401 mutex_lock(&instance->poll_state_serialize);
402 switch (instance->poll_state) {
405 instance->poll_state = CXPOLL_POLLING;
408 case CXPOLL_STOPPING:
409 /* abort stop request */
410 instance->poll_state = CXPOLL_POLLING;
413 case CXPOLL_SHUTDOWN:
414 /* don't start polling */
417 mutex_unlock(&instance->poll_state_serialize);
418 } else if (poll == CXPOLL_STOPPED) {
419 mutex_lock(&instance->poll_state_serialize);
421 if (instance->poll_state == CXPOLL_POLLING)
422 instance->poll_state = CXPOLL_STOPPING;
423 mutex_unlock(&instance->poll_state_serialize);
426 mutex_unlock(&instance->adsl_state_serialize);
428 if (poll == CXPOLL_POLLING)
429 cxacru_poll_status(&instance->poll_work.work);
434 /* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
436 static ssize_t adsl_config_store(struct device *dev,
437 struct device_attribute *attr, const char *buf, size_t count)
439 struct cxacru_data *instance = to_usbatm_driver_data(
440 to_usb_interface(dev));
441 int len = strlen(buf);
443 __le32 data[CMD_PACKET_SIZE / 4];
445 if (!capable(CAP_NET_ADMIN))
448 if (instance == NULL)
458 ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
463 if (tmp < 0 || tmp > len - pos)
467 /* skip trailing newline */
468 if (buf[pos] == '\n' && pos == len-1)
471 data[num * 2 + 1] = cpu_to_le32(index);
472 data[num * 2 + 2] = cpu_to_le32(value);
475 /* send config values when data buffer is full
478 if (pos >= len || num >= CMD_MAX_CONFIG) {
479 char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
481 data[0] = cpu_to_le32(num);
482 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
483 (u8 *) data, 4 + num * 8, NULL, 0);
485 atm_err(instance->usbatm,
486 "set card data returned %d\n", ret);
490 for (tmp = 0; tmp < num; tmp++)
491 snprintf(log + tmp*12, 13, " %02x=%08x",
492 le32_to_cpu(data[tmp * 2 + 1]),
493 le32_to_cpu(data[tmp * 2 + 2]));
494 atm_info(instance->usbatm, "config%s\n", log);
503 * All device attributes are included in CXACRU_ALL_FILES
504 * so that the same list can be used multiple times:
505 * INIT (define the device attributes)
506 * CREATE (create all the device files)
507 * REMOVE (remove all the device files)
509 * With the last two being defined as needed in the functions
510 * they are used in before calling CXACRU_ALL_FILES()
512 #define CXACRU_ALL_FILES(_action) \
513 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
514 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
515 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
516 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
517 CXACRU__ATTR_##_action( mac_address); \
518 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
519 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
520 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
521 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
522 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
523 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
524 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
525 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
526 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
527 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
528 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
529 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
530 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
531 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
532 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
533 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
534 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
535 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
536 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
537 CXACRU_CMD_##_action( adsl_state); \
538 CXACRU_SET_##_action( adsl_config);
540 CXACRU_ALL_FILES(INIT);
542 /* the following three functions are stolen from drivers/usb/core/message.c */
543 static void cxacru_blocking_completion(struct urb *urb)
545 complete(urb->context);
548 struct cxacru_timer {
549 struct timer_list timer;
553 static void cxacru_timeout_kill(struct timer_list *t)
555 struct cxacru_timer *timer = from_timer(timer, t, timer);
557 usb_unlink_urb(timer->urb);
560 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
563 struct cxacru_timer timer = {
567 timer_setup_on_stack(&timer.timer, cxacru_timeout_kill, 0);
568 mod_timer(&timer.timer, jiffies + msecs_to_jiffies(CMD_TIMEOUT));
569 wait_for_completion(done);
570 del_timer_sync(&timer.timer);
571 destroy_timer_on_stack(&timer.timer);
574 *actual_length = urb->actual_length;
575 return urb->status; /* must read status after completion */
578 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
579 u8 *wdata, int wsize, u8 *rdata, int rsize)
583 const int stride = CMD_PACKET_SIZE - 4;
584 u8 *wbuf = instance->snd_buf;
585 u8 *rbuf = instance->rcv_buf;
586 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
587 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
589 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
590 if (printk_ratelimit())
591 usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
597 mutex_lock(&instance->cm_serialize);
599 /* submit reading urb before the writing one */
600 init_completion(&instance->rcv_done);
601 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
603 if (printk_ratelimit())
604 usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
609 memset(wbuf, 0, wbuflen);
610 /* handle wsize == 0 */
612 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
614 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
617 instance->snd_urb->transfer_buffer_length = wbuflen;
618 init_completion(&instance->snd_done);
619 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
621 if (printk_ratelimit())
622 usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
627 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
629 if (printk_ratelimit())
630 usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
634 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
636 if (printk_ratelimit())
637 usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
640 if (actlen % CMD_PACKET_SIZE || !actlen) {
641 if (printk_ratelimit())
642 usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
648 /* check the return status and copy the data to the output buffer, if needed */
649 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
650 if (rbuf[offb] != cm) {
651 if (printk_ratelimit())
652 usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
657 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
658 if (printk_ratelimit())
659 usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
666 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
671 usb_dbg(instance->usbatm, "cm %#x\n", cm);
673 mutex_unlock(&instance->cm_serialize);
678 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
685 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
686 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
688 buf = kmalloc(buflen, GFP_KERNEL);
692 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
696 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
698 for (offb = 0; offb < len; ) {
699 int l = le32_to_cpu(buf[offb++]);
701 if (l < 0 || l > stride || l > (len - offb) / 2) {
702 if (printk_ratelimit())
703 usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
709 offd = le32_to_cpu(buf[offb++]);
711 if (printk_ratelimit())
712 usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
717 data[offd] = le32_to_cpu(buf[offb++]);
728 static int cxacru_card_status(struct cxacru_data *instance)
730 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
732 if (ret < 0) { /* firmware not loaded */
733 usb_dbg(instance->usbatm, "cxacru_adsl_start: CARD_GET_STATUS returned %d\n", ret);
739 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
740 struct atm_dev *atm_dev)
742 struct usb_interface *intf = usbatm_instance->usb_intf;
744 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
745 device_remove_file(&intf->dev, &dev_attr_##_name);
746 CXACRU_ALL_FILES(REMOVE);
747 #undef CXACRU_DEVICE_REMOVE_FILE
750 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
751 struct atm_dev *atm_dev)
753 struct cxacru_data *instance = usbatm_instance->driver_data;
754 struct usb_interface *intf = usbatm_instance->usb_intf;
756 int start_polling = 1;
758 dev_dbg(&intf->dev, "%s\n", __func__);
760 /* Read MAC address */
761 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
762 atm_dev->esi, sizeof(atm_dev->esi));
764 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
768 #define CXACRU_DEVICE_CREATE_FILE(_name) \
769 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
772 CXACRU_ALL_FILES(CREATE);
773 #undef CXACRU_DEVICE_CREATE_FILE
776 mutex_lock(&instance->adsl_state_serialize);
777 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
779 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
781 /* Start status polling */
782 mutex_lock(&instance->poll_state_serialize);
783 switch (instance->poll_state) {
786 instance->poll_state = CXPOLL_POLLING;
789 case CXPOLL_STOPPING:
790 /* abort stop request */
791 instance->poll_state = CXPOLL_POLLING;
794 case CXPOLL_SHUTDOWN:
795 /* don't start polling */
798 mutex_unlock(&instance->poll_state_serialize);
799 mutex_unlock(&instance->adsl_state_serialize);
801 printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
802 usbatm_instance->description, atm_dev->esi);
805 cxacru_poll_status(&instance->poll_work.work);
809 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
810 cxacru_remove_device_files(usbatm_instance, atm_dev);
814 static void cxacru_poll_status(struct work_struct *work)
816 struct cxacru_data *instance =
817 container_of(work, struct cxacru_data, poll_work.work);
818 u32 buf[CXINF_MAX] = {};
819 struct usbatm_data *usbatm = instance->usbatm;
820 struct atm_dev *atm_dev = usbatm->atm_dev;
821 int keep_polling = 1;
824 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
826 if (ret != -ESHUTDOWN)
827 atm_warn(usbatm, "poll status: error %d\n", ret);
829 mutex_lock(&instance->poll_state_serialize);
830 if (instance->poll_state != CXPOLL_SHUTDOWN) {
831 instance->poll_state = CXPOLL_STOPPED;
833 if (ret != -ESHUTDOWN)
834 atm_warn(usbatm, "polling disabled, set adsl_state"
835 " to 'start' or 'poll' to resume\n");
837 mutex_unlock(&instance->poll_state_serialize);
841 memcpy(instance->card_info, buf, sizeof(instance->card_info));
843 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
844 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
846 switch (instance->adsl_status) {
848 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
852 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
856 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
861 if (instance->line_status == buf[CXINF_LINE_STATUS])
864 instance->line_status = buf[CXINF_LINE_STATUS];
865 switch (instance->line_status) {
867 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
868 atm_info(usbatm, "ADSL line: down\n");
872 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
873 atm_info(usbatm, "ADSL line: attempting to activate\n");
877 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
878 atm_info(usbatm, "ADSL line: training\n");
882 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
883 atm_info(usbatm, "ADSL line: channel analysis\n");
887 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
888 atm_info(usbatm, "ADSL line: exchange\n");
892 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
893 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_FOUND);
895 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
896 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
900 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
901 atm_info(usbatm, "ADSL line: waiting\n");
905 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
906 atm_info(usbatm, "ADSL line: initializing\n");
910 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
911 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
916 mutex_lock(&instance->poll_state_serialize);
917 if (instance->poll_state == CXPOLL_STOPPING &&
918 instance->adsl_status == 1 && /* stopped */
919 instance->line_status == 0) /* down */
920 instance->poll_state = CXPOLL_STOPPED;
922 if (instance->poll_state == CXPOLL_STOPPED)
924 mutex_unlock(&instance->poll_state_serialize);
927 schedule_delayed_work(&instance->poll_work,
928 round_jiffies_relative(POLL_INTERVAL*HZ));
931 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
932 u8 code1, u8 code2, u32 addr, const u8 *data, int size)
937 const int stride = CMD_PACKET_SIZE - 8;
939 buf = (u8 *) __get_free_page(GFP_KERNEL);
945 int l = min_t(int, stride, size - offd);
951 put_unaligned(cpu_to_le32(addr), (__le32 *)(buf + offb));
955 memcpy(buf + offb, data + offd, l);
957 memset(buf + offb + l, 0, stride - l);
960 if ((offb >= PAGE_SIZE) || (offd >= size)) {
961 ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
962 buf, offb, NULL, CMD_TIMEOUT);
964 dev_dbg(&usb_dev->dev, "sending fw %#x failed\n", fw);
969 } while (offd < size);
970 dev_dbg(&usb_dev->dev, "sent fw %#x\n", fw);
975 free_page((unsigned long) buf);
979 static void cxacru_upload_firmware(struct cxacru_data *instance,
980 const struct firmware *fw,
981 const struct firmware *bp)
984 struct usbatm_data *usbatm = instance->usbatm;
985 struct usb_device *usb_dev = usbatm->usb_dev;
986 __le16 signature[] = { usb_dev->descriptor.idVendor,
987 usb_dev->descriptor.idProduct };
990 usb_dbg(usbatm, "%s\n", __func__);
992 /* FirmwarePllFClkValue */
993 val = cpu_to_le32(instance->modem_type->pll_f_clk);
994 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
996 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
1000 /* FirmwarePllBClkValue */
1001 val = cpu_to_le32(instance->modem_type->pll_b_clk);
1002 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
1004 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
1009 val = cpu_to_le32(SDRAM_ENA);
1010 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
1012 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
1017 usb_info(usbatm, "loading firmware\n");
1018 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
1020 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
1024 /* Boot ROM patch */
1025 if (instance->modem_type->boot_rom_patch) {
1026 usb_info(usbatm, "loading boot ROM patch\n");
1027 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
1029 usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
1035 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
1037 usb_err(usbatm, "Signature storing failed: %d\n", ret);
1041 usb_info(usbatm, "starting device\n");
1042 if (instance->modem_type->boot_rom_patch) {
1043 val = cpu_to_le32(BR_ADDR);
1044 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
1046 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1049 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
1053 /* Delay to allow firmware to start up. */
1054 msleep_interruptible(1000);
1056 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
1057 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
1058 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
1059 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
1061 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1063 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
1068 static int cxacru_find_firmware(struct cxacru_data *instance,
1069 char *phase, const struct firmware **fw_p)
1071 struct usbatm_data *usbatm = instance->usbatm;
1072 struct device *dev = &usbatm->usb_intf->dev;
1075 sprintf(buf, "cxacru-%s.bin", phase);
1076 usb_dbg(usbatm, "cxacru_find_firmware: looking for %s\n", buf);
1078 if (request_firmware(fw_p, buf, dev)) {
1079 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
1083 usb_info(usbatm, "found firmware %s\n", buf);
1088 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1089 struct usb_interface *usb_intf)
1091 const struct firmware *fw, *bp;
1092 struct cxacru_data *instance = usbatm_instance->driver_data;
1093 int ret = cxacru_find_firmware(instance, "fw", &fw);
1096 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1100 if (instance->modem_type->boot_rom_patch) {
1101 ret = cxacru_find_firmware(instance, "bp", &bp);
1103 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1104 release_firmware(fw);
1109 cxacru_upload_firmware(instance, fw, bp);
1111 if (instance->modem_type->boot_rom_patch)
1112 release_firmware(bp);
1113 release_firmware(fw);
1115 ret = cxacru_card_status(instance);
1117 usb_dbg(usbatm_instance, "modem initialisation failed\n");
1119 usb_dbg(usbatm_instance, "done setting up the modem\n");
1124 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1125 struct usb_interface *intf, const struct usb_device_id *id)
1127 struct cxacru_data *instance;
1128 struct usb_device *usb_dev = interface_to_usbdev(intf);
1129 struct usb_host_endpoint *cmd_ep = usb_dev->ep_in[CXACRU_EP_CMD];
1133 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1137 instance->usbatm = usbatm_instance;
1138 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1140 mutex_init(&instance->poll_state_serialize);
1141 instance->poll_state = CXPOLL_STOPPED;
1142 instance->line_status = -1;
1143 instance->adsl_status = -1;
1145 mutex_init(&instance->adsl_state_serialize);
1147 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1148 if (!instance->rcv_buf) {
1149 usb_dbg(usbatm_instance, "cxacru_bind: no memory for rcv_buf\n");
1153 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1154 if (!instance->snd_buf) {
1155 usb_dbg(usbatm_instance, "cxacru_bind: no memory for snd_buf\n");
1159 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1160 if (!instance->rcv_urb) {
1164 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1165 if (!instance->snd_urb) {
1171 usb_dbg(usbatm_instance, "cxacru_bind: no command endpoint\n");
1176 if ((cmd_ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1177 == USB_ENDPOINT_XFER_INT) {
1178 usb_fill_int_urb(instance->rcv_urb,
1179 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1180 instance->rcv_buf, PAGE_SIZE,
1181 cxacru_blocking_completion, &instance->rcv_done, 1);
1183 usb_fill_int_urb(instance->snd_urb,
1184 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1185 instance->snd_buf, PAGE_SIZE,
1186 cxacru_blocking_completion, &instance->snd_done, 4);
1188 usb_fill_bulk_urb(instance->rcv_urb,
1189 usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD),
1190 instance->rcv_buf, PAGE_SIZE,
1191 cxacru_blocking_completion, &instance->rcv_done);
1193 usb_fill_bulk_urb(instance->snd_urb,
1194 usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
1195 instance->snd_buf, PAGE_SIZE,
1196 cxacru_blocking_completion, &instance->snd_done);
1199 mutex_init(&instance->cm_serialize);
1201 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1203 usbatm_instance->driver_data = instance;
1205 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1210 free_page((unsigned long) instance->snd_buf);
1211 free_page((unsigned long) instance->rcv_buf);
1212 usb_free_urb(instance->snd_urb);
1213 usb_free_urb(instance->rcv_urb);
1219 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1220 struct usb_interface *intf)
1222 struct cxacru_data *instance = usbatm_instance->driver_data;
1225 usb_dbg(usbatm_instance, "cxacru_unbind entered\n");
1228 usb_dbg(usbatm_instance, "cxacru_unbind: NULL instance!\n");
1232 mutex_lock(&instance->poll_state_serialize);
1233 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1235 /* ensure that status polling continues unless
1236 * it has already stopped */
1237 if (instance->poll_state == CXPOLL_STOPPED)
1240 /* stop polling from being stopped or started */
1241 instance->poll_state = CXPOLL_SHUTDOWN;
1242 mutex_unlock(&instance->poll_state_serialize);
1245 cancel_delayed_work_sync(&instance->poll_work);
1247 usb_kill_urb(instance->snd_urb);
1248 usb_kill_urb(instance->rcv_urb);
1249 usb_free_urb(instance->snd_urb);
1250 usb_free_urb(instance->rcv_urb);
1252 free_page((unsigned long) instance->snd_buf);
1253 free_page((unsigned long) instance->rcv_buf);
1257 usbatm_instance->driver_data = NULL;
1260 static const struct cxacru_modem_type cxacru_cafe = {
1261 .pll_f_clk = 0x02d874df,
1262 .pll_b_clk = 0x0196a51a,
1263 .boot_rom_patch = 1,
1266 static const struct cxacru_modem_type cxacru_cb00 = {
1269 .boot_rom_patch = 0,
1272 static const struct usb_device_id cxacru_usb_ids[] = {
1273 { /* V = Conexant P = ADSL modem (Euphrates project) */
1274 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1276 { /* V = Conexant P = ADSL modem (Hasbani project) */
1277 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1279 { /* V = Conexant P = ADSL modem */
1280 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1282 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1283 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1285 { /* V = Conexant P = ADSL modem */
1286 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1288 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1289 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1291 { /* V = Olitec P = ADSL modem version 2 */
1292 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1294 { /* V = Olitec P = ADSL modem version 3 */
1295 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1297 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1298 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1300 { /* V = Zoom P = 5510 */
1301 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1303 { /* V = Draytek P = Vigor 318 */
1304 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1306 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1307 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1309 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1310 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1312 { /* V = Aethra P = Starmodem UM1020 */
1313 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1315 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1316 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1318 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1319 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1321 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1322 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1327 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1329 static struct usbatm_driver cxacru_driver = {
1330 .driver_name = cxacru_driver_name,
1331 .bind = cxacru_bind,
1332 .heavy_init = cxacru_heavy_init,
1333 .unbind = cxacru_unbind,
1334 .atm_start = cxacru_atm_start,
1335 .atm_stop = cxacru_remove_device_files,
1336 .bulk_in = CXACRU_EP_DATA,
1337 .bulk_out = CXACRU_EP_DATA,
1342 static int cxacru_usb_probe(struct usb_interface *intf,
1343 const struct usb_device_id *id)
1345 struct usb_device *usb_dev = interface_to_usbdev(intf);
1348 /* Avoid ADSL routers (cx82310_eth).
1349 * Abort if bDeviceClass is 0xff and iProduct is "USB NET CARD".
1351 if (usb_dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC
1352 && usb_string(usb_dev, usb_dev->descriptor.iProduct,
1353 buf, sizeof(buf)) > 0) {
1354 if (!strcmp(buf, "USB NET CARD")) {
1355 dev_info(&intf->dev, "ignoring cx82310_eth device\n");
1360 return usbatm_usb_probe(intf, id, &cxacru_driver);
1363 static struct usb_driver cxacru_usb_driver = {
1364 .name = cxacru_driver_name,
1365 .probe = cxacru_usb_probe,
1366 .disconnect = usbatm_usb_disconnect,
1367 .id_table = cxacru_usb_ids
1370 module_usb_driver(cxacru_usb_driver);
1372 MODULE_AUTHOR(DRIVER_AUTHOR);
1373 MODULE_DESCRIPTION(DRIVER_DESC);
1374 MODULE_LICENSE("GPL");