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>
41 #include <asm/unaligned.h>
45 #define DRIVER_AUTHOR "Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
46 #define DRIVER_VERSION "0.3"
47 #define DRIVER_DESC "Conexant AccessRunner ADSL USB modem driver"
49 static const char cxacru_driver_name[] = "cxacru";
51 #define CXACRU_EP_CMD 0x01 /* Bulk/interrupt in/out */
52 #define CXACRU_EP_DATA 0x02 /* Bulk in/out */
54 #define CMD_PACKET_SIZE 64 /* Should be maxpacket(ep)? */
55 #define CMD_MAX_CONFIG ((CMD_PACKET_SIZE / 4 - 1) / 2)
58 #define PLLFCLK_ADDR 0x00350068
59 #define PLLBCLK_ADDR 0x0035006c
60 #define SDRAMEN_ADDR 0x00350010
61 #define FW_ADDR 0x00801000
62 #define BR_ADDR 0x00180600
63 #define SIG_ADDR 0x00180500
64 #define BR_STACK_ADDR 0x00187f10
69 #define CMD_TIMEOUT 2000 /* msecs */
70 #define POLL_INTERVAL 1 /* secs */
72 /* commands for interaction with the modem through the control channel before
73 * firmware is loaded */
74 enum cxacru_fw_request {
84 /* commands for interaction with the modem through the control channel once
85 * firmware is loaded */
86 enum cxacru_cm_request {
87 CM_REQUEST_UNDEFINED = 0x80,
89 CM_REQUEST_CHIP_GET_MAC_ADDRESS,
90 CM_REQUEST_CHIP_GET_DP_VERSIONS,
91 CM_REQUEST_CHIP_ADSL_LINE_START,
92 CM_REQUEST_CHIP_ADSL_LINE_STOP,
93 CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
94 CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
95 CM_REQUEST_CARD_INFO_GET,
96 CM_REQUEST_CARD_DATA_GET,
97 CM_REQUEST_CARD_DATA_SET,
98 CM_REQUEST_COMMAND_HW_IO,
99 CM_REQUEST_INTERFACE_HW_IO,
100 CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
101 CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
102 CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
103 CM_REQUEST_CARD_GET_STATUS,
104 CM_REQUEST_CARD_GET_MAC_ADDRESS,
105 CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
109 /* commands for interaction with the flash memory
111 * read: response is the contents of the first 60 bytes of flash memory
112 * write: request contains the 60 bytes of data to write to flash memory
113 * response is the contents of the first 60 bytes of flash memory
115 * layout: PP PP VV VV MM MM MM MM MM MM ?? ?? SS SS SS SS SS SS SS SS
116 * SS SS SS SS SS SS SS SS 00 00 00 00 00 00 00 00 00 00 00 00
117 * 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
119 * P: le16 USB Product ID
120 * V: le16 USB Vendor ID
121 * M: be48 MAC Address
122 * S: le16 ASCII Serial Number
124 enum cxacru_cm_flash {
125 CM_FLASH_READ = 0xa1,
126 CM_FLASH_WRITE = 0xa2
129 /* reply codes to the commands above */
130 enum cxacru_cm_status {
134 CM_STATUS_UNSUPPORTED,
135 CM_STATUS_UNIMPLEMENTED,
136 CM_STATUS_PARAMETER_ERROR,
137 CM_STATUS_DBG_LOOPBACK,
141 /* indices into CARD_INFO_GET return array */
142 enum cxacru_info_idx {
143 CXINF_DOWNSTREAM_RATE,
147 CXINF_MAC_ADDRESS_HIGH,
148 CXINF_MAC_ADDRESS_LOW,
149 CXINF_UPSTREAM_SNR_MARGIN,
150 CXINF_DOWNSTREAM_SNR_MARGIN,
151 CXINF_UPSTREAM_ATTENUATION,
152 CXINF_DOWNSTREAM_ATTENUATION,
153 CXINF_TRANSMITTER_POWER,
154 CXINF_UPSTREAM_BITS_PER_FRAME,
155 CXINF_DOWNSTREAM_BITS_PER_FRAME,
156 CXINF_STARTUP_ATTEMPTS,
157 CXINF_UPSTREAM_CRC_ERRORS,
158 CXINF_DOWNSTREAM_CRC_ERRORS,
159 CXINF_UPSTREAM_FEC_ERRORS,
160 CXINF_DOWNSTREAM_FEC_ERRORS,
161 CXINF_UPSTREAM_HEC_ERRORS,
162 CXINF_DOWNSTREAM_HEC_ERRORS,
163 CXINF_LINE_STARTABLE,
166 CXINF_ADSL_HEADEND_ENVIRONMENT,
167 CXINF_CONTROLLER_VERSION,
168 /* dunno what the missing two mean */
172 enum cxacru_poll_state {
179 struct cxacru_modem_type {
186 struct usbatm_data *usbatm;
188 const struct cxacru_modem_type *modem_type;
191 struct mutex adsl_state_serialize;
193 struct delayed_work poll_work;
194 u32 card_info[CXINF_MAX];
195 struct mutex poll_state_serialize;
196 enum cxacru_poll_state poll_state;
199 struct mutex cm_serialize;
204 struct completion rcv_done;
205 struct completion snd_done;
208 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
209 u8 *wdata, int wsize, u8 *rdata, int rsize);
210 static void cxacru_poll_status(struct work_struct *work);
212 /* Card info exported through sysfs */
213 #define CXACRU__ATTR_INIT(_name) \
214 static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
216 #define CXACRU_CMD_INIT(_name) \
217 static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
218 cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
220 #define CXACRU_SET_INIT(_name) \
221 static DEVICE_ATTR(_name, S_IWUSR, \
222 NULL, cxacru_sysfs_store_##_name)
224 #define CXACRU_ATTR_INIT(_value, _type, _name) \
225 static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
226 struct device_attribute *attr, char *buf) \
228 struct cxacru_data *instance = to_usbatm_driver_data(\
229 to_usb_interface(dev)); \
231 if (instance == NULL) \
234 return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
236 CXACRU__ATTR_INIT(_name)
238 #define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
239 #define CXACRU_CMD_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
240 #define CXACRU_SET_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
241 #define CXACRU__ATTR_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
243 #define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
244 #define CXACRU_CMD_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
245 #define CXACRU_SET_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
246 #define CXACRU__ATTR_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
248 static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
250 return snprintf(buf, PAGE_SIZE, "%u\n", value);
253 static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
255 return snprintf(buf, PAGE_SIZE, "%d\n", value);
258 static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
260 if (likely(value >= 0)) {
261 return snprintf(buf, PAGE_SIZE, "%u.%02u\n",
262 value / 100, value % 100);
265 return snprintf(buf, PAGE_SIZE, "-%u.%02u\n",
266 value / 100, value % 100);
270 static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
272 static char *str[] = { "no", "yes" };
273 if (unlikely(value >= ARRAY_SIZE(str)))
274 return snprintf(buf, PAGE_SIZE, "%u\n", value);
275 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
278 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
280 static char *str[] = { NULL, "not connected", "connected", "lost" };
281 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
282 return snprintf(buf, PAGE_SIZE, "%u\n", value);
283 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
286 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
288 static char *str[] = { "down", "attempting to activate",
289 "training", "channel analysis", "exchange", "up",
290 "waiting", "initialising"
292 if (unlikely(value >= ARRAY_SIZE(str)))
293 return snprintf(buf, PAGE_SIZE, "%u\n", value);
294 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
297 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
299 static char *str[] = {
302 "ITU-T G.992.1 (G.DMT)",
303 "ITU-T G.992.2 (G.LITE)"
305 if (unlikely(value >= ARRAY_SIZE(str)))
306 return snprintf(buf, PAGE_SIZE, "%u\n", value);
307 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
311 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
312 * this data is already in atm_dev there's no point.
314 * MAC_ADDRESS_HIGH = 0x????5544
315 * MAC_ADDRESS_LOW = 0x33221100
316 * Where 00-55 are bytes 0-5 of the MAC.
318 static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
319 struct device_attribute *attr, char *buf)
321 struct cxacru_data *instance = to_usbatm_driver_data(
322 to_usb_interface(dev));
324 if (instance == NULL || instance->usbatm->atm_dev == NULL)
327 return snprintf(buf, PAGE_SIZE, "%pM\n",
328 instance->usbatm->atm_dev->esi);
331 static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
332 struct device_attribute *attr, char *buf)
334 static char *str[] = { "running", "stopped" };
335 struct cxacru_data *instance = to_usbatm_driver_data(
336 to_usb_interface(dev));
339 if (instance == NULL)
342 value = instance->card_info[CXINF_LINE_STARTABLE];
343 if (unlikely(value >= ARRAY_SIZE(str)))
344 return snprintf(buf, PAGE_SIZE, "%u\n", value);
345 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
348 static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
349 struct device_attribute *attr, const char *buf, size_t count)
351 struct cxacru_data *instance = to_usbatm_driver_data(
352 to_usb_interface(dev));
356 int len = strlen(buf);
358 if (!capable(CAP_NET_ADMIN))
361 ret = sscanf(buf, "%7s", str_cmd);
366 if (instance == NULL)
369 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
372 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
373 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
375 atm_err(instance->usbatm, "change adsl state:"
376 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
381 poll = CXPOLL_STOPPED;
385 /* Line status is only updated every second
386 * and the device appears to only react to
387 * START/STOP every second too. Wait 1.5s to
388 * be sure that restart will have an effect. */
389 if (!strcmp(str_cmd, "restart"))
392 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
393 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
395 atm_err(instance->usbatm, "change adsl state:"
396 " CHIP_ADSL_LINE_START returned %d\n", ret);
401 poll = CXPOLL_POLLING;
405 if (!strcmp(str_cmd, "poll")) {
407 poll = CXPOLL_POLLING;
415 if (poll == CXPOLL_POLLING) {
416 mutex_lock(&instance->poll_state_serialize);
417 switch (instance->poll_state) {
420 instance->poll_state = CXPOLL_POLLING;
423 case CXPOLL_STOPPING:
424 /* abort stop request */
425 instance->poll_state = CXPOLL_POLLING;
427 case CXPOLL_SHUTDOWN:
428 /* don't start polling */
431 mutex_unlock(&instance->poll_state_serialize);
432 } else if (poll == CXPOLL_STOPPED) {
433 mutex_lock(&instance->poll_state_serialize);
435 if (instance->poll_state == CXPOLL_POLLING)
436 instance->poll_state = CXPOLL_STOPPING;
437 mutex_unlock(&instance->poll_state_serialize);
440 mutex_unlock(&instance->adsl_state_serialize);
442 if (poll == CXPOLL_POLLING)
443 cxacru_poll_status(&instance->poll_work.work);
448 /* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
450 static ssize_t cxacru_sysfs_store_adsl_config(struct device *dev,
451 struct device_attribute *attr, const char *buf, size_t count)
453 struct cxacru_data *instance = to_usbatm_driver_data(
454 to_usb_interface(dev));
455 int len = strlen(buf);
457 __le32 data[CMD_PACKET_SIZE / 4];
459 if (!capable(CAP_NET_ADMIN))
462 if (instance == NULL)
472 ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
475 if (index < 0 || index > 0x7f)
479 /* skip trailing newline */
480 if (buf[pos] == '\n' && pos == len-1)
483 data[num * 2 + 1] = cpu_to_le32(index);
484 data[num * 2 + 2] = cpu_to_le32(value);
487 /* send config values when data buffer is full
490 if (pos >= len || num >= CMD_MAX_CONFIG) {
491 char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
493 data[0] = cpu_to_le32(num);
494 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
495 (u8 *) data, 4 + num * 8, NULL, 0);
497 atm_err(instance->usbatm,
498 "set card data returned %d\n", ret);
502 for (tmp = 0; tmp < num; tmp++)
503 snprintf(log + tmp*12, 13, " %02x=%08x",
504 le32_to_cpu(data[tmp * 2 + 1]),
505 le32_to_cpu(data[tmp * 2 + 2]));
506 atm_info(instance->usbatm, "config%s\n", log);
515 * All device attributes are included in CXACRU_ALL_FILES
516 * so that the same list can be used multiple times:
517 * INIT (define the device attributes)
518 * CREATE (create all the device files)
519 * REMOVE (remove all the device files)
521 * With the last two being defined as needed in the functions
522 * they are used in before calling CXACRU_ALL_FILES()
524 #define CXACRU_ALL_FILES(_action) \
525 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
526 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
527 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
528 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
529 CXACRU__ATTR_##_action( mac_address); \
530 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
531 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
532 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
533 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
534 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
535 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
536 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
537 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
538 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
539 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
540 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
541 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
542 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
543 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
544 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
545 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
546 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
547 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
548 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
549 CXACRU_CMD_##_action( adsl_state); \
550 CXACRU_SET_##_action( adsl_config);
552 CXACRU_ALL_FILES(INIT);
554 /* the following three functions are stolen from drivers/usb/core/message.c */
555 static void cxacru_blocking_completion(struct urb *urb)
557 complete(urb->context);
560 static void cxacru_timeout_kill(unsigned long data)
562 usb_unlink_urb((struct urb *) data);
565 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
568 struct timer_list timer;
571 timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
572 timer.data = (unsigned long) urb;
573 timer.function = cxacru_timeout_kill;
575 wait_for_completion(done);
576 del_timer_sync(&timer);
579 *actual_length = urb->actual_length;
580 return urb->status; /* must read status after completion */
583 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
584 u8 *wdata, int wsize, u8 *rdata, int rsize)
588 const int stride = CMD_PACKET_SIZE - 4;
589 u8 *wbuf = instance->snd_buf;
590 u8 *rbuf = instance->rcv_buf;
591 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
592 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
594 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
595 if (printk_ratelimit())
596 usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
602 mutex_lock(&instance->cm_serialize);
604 /* submit reading urb before the writing one */
605 init_completion(&instance->rcv_done);
606 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
608 if (printk_ratelimit())
609 usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
614 memset(wbuf, 0, wbuflen);
615 /* handle wsize == 0 */
617 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
619 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
622 instance->snd_urb->transfer_buffer_length = wbuflen;
623 init_completion(&instance->snd_done);
624 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
626 if (printk_ratelimit())
627 usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
632 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
634 if (printk_ratelimit())
635 usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
639 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
641 if (printk_ratelimit())
642 usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
645 if (actlen % CMD_PACKET_SIZE || !actlen) {
646 if (printk_ratelimit())
647 usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
653 /* check the return status and copy the data to the output buffer, if needed */
654 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
655 if (rbuf[offb] != cm) {
656 if (printk_ratelimit())
657 usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
662 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
663 if (printk_ratelimit())
664 usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
671 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
678 mutex_unlock(&instance->cm_serialize);
683 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
689 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
690 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
692 buf = kmalloc(buflen, GFP_KERNEL);
696 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
700 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
702 for (offb = 0; offb < len; ) {
703 int l = le32_to_cpu(buf[offb++]);
704 if (l < 0 || l > stride || l > (len - offb) / 2) {
705 if (printk_ratelimit())
706 usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
712 offd = le32_to_cpu(buf[offb++]);
714 if (printk_ratelimit())
715 usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
720 data[offd] = le32_to_cpu(buf[offb++]);
731 static int cxacru_card_status(struct cxacru_data *instance)
733 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
734 if (ret < 0) { /* firmware not loaded */
735 dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret);
741 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
742 struct atm_dev *atm_dev)
744 struct usb_interface *intf = usbatm_instance->usb_intf;
746 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
747 device_remove_file(&intf->dev, &dev_attr_##_name);
748 CXACRU_ALL_FILES(REMOVE);
749 #undef CXACRU_DEVICE_REMOVE_FILE
752 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
753 struct atm_dev *atm_dev)
755 struct cxacru_data *instance = usbatm_instance->driver_data;
756 struct usb_interface *intf = usbatm_instance->usb_intf;
758 int start_polling = 1;
760 dbg("cxacru_atm_start");
762 /* Read MAC address */
763 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
764 atm_dev->esi, sizeof(atm_dev->esi));
766 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
770 #define CXACRU_DEVICE_CREATE_FILE(_name) \
771 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
774 CXACRU_ALL_FILES(CREATE);
775 #undef CXACRU_DEVICE_CREATE_FILE
778 mutex_lock(&instance->adsl_state_serialize);
779 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
781 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
783 /* Start status polling */
784 mutex_lock(&instance->poll_state_serialize);
785 switch (instance->poll_state) {
788 instance->poll_state = CXPOLL_POLLING;
791 case CXPOLL_STOPPING:
792 /* abort stop request */
793 instance->poll_state = CXPOLL_POLLING;
795 case CXPOLL_SHUTDOWN:
796 /* don't start polling */
799 mutex_unlock(&instance->poll_state_serialize);
800 mutex_unlock(&instance->adsl_state_serialize);
802 printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
803 usbatm_instance->description, atm_dev->esi);
806 cxacru_poll_status(&instance->poll_work.work);
810 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
811 cxacru_remove_device_files(usbatm_instance, atm_dev);
815 static void cxacru_poll_status(struct work_struct *work)
817 struct cxacru_data *instance =
818 container_of(work, struct cxacru_data, poll_work.work);
819 u32 buf[CXINF_MAX] = {};
820 struct usbatm_data *usbatm = instance->usbatm;
821 struct atm_dev *atm_dev = usbatm->atm_dev;
822 int keep_polling = 1;
825 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
827 if (ret != -ESHUTDOWN)
828 atm_warn(usbatm, "poll status: error %d\n", ret);
830 mutex_lock(&instance->poll_state_serialize);
831 if (instance->poll_state != CXPOLL_SHUTDOWN) {
832 instance->poll_state = CXPOLL_STOPPED;
834 if (ret != -ESHUTDOWN)
835 atm_warn(usbatm, "polling disabled, set adsl_state"
836 " to 'start' or 'poll' to resume\n");
838 mutex_unlock(&instance->poll_state_serialize);
842 memcpy(instance->card_info, buf, sizeof(instance->card_info));
844 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
845 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
847 switch (instance->adsl_status) {
849 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
853 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
857 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
862 if (instance->line_status == buf[CXINF_LINE_STATUS])
865 instance->line_status = buf[CXINF_LINE_STATUS];
866 switch (instance->line_status) {
868 atm_dev->signal = ATM_PHY_SIG_LOST;
869 atm_info(usbatm, "ADSL line: down\n");
873 atm_dev->signal = ATM_PHY_SIG_LOST;
874 atm_info(usbatm, "ADSL line: attempting to activate\n");
878 atm_dev->signal = ATM_PHY_SIG_LOST;
879 atm_info(usbatm, "ADSL line: training\n");
883 atm_dev->signal = ATM_PHY_SIG_LOST;
884 atm_info(usbatm, "ADSL line: channel analysis\n");
888 atm_dev->signal = ATM_PHY_SIG_LOST;
889 atm_info(usbatm, "ADSL line: exchange\n");
893 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
894 atm_dev->signal = ATM_PHY_SIG_FOUND;
896 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
897 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
901 atm_dev->signal = ATM_PHY_SIG_LOST;
902 atm_info(usbatm, "ADSL line: waiting\n");
906 atm_dev->signal = ATM_PHY_SIG_LOST;
907 atm_info(usbatm, "ADSL line: initializing\n");
911 atm_dev->signal = ATM_PHY_SIG_UNKNOWN;
912 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
917 mutex_lock(&instance->poll_state_serialize);
918 if (instance->poll_state == CXPOLL_STOPPING &&
919 instance->adsl_status == 1 && /* stopped */
920 instance->line_status == 0) /* down */
921 instance->poll_state = CXPOLL_STOPPED;
923 if (instance->poll_state == CXPOLL_STOPPED)
925 mutex_unlock(&instance->poll_state_serialize);
928 schedule_delayed_work(&instance->poll_work,
929 round_jiffies_relative(POLL_INTERVAL*HZ));
932 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
933 u8 code1, u8 code2, u32 addr, const u8 *data, int size)
938 const int stride = CMD_PACKET_SIZE - 8;
940 buf = (u8 *) __get_free_page(GFP_KERNEL);
946 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 dbg("sending fw %#x failed", fw);
969 } while(offd < size);
970 dbg("sent fw %#x", 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 dbg("cxacru_upload_firmware");
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);
1047 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1050 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
1054 /* Delay to allow firmware to start up. */
1055 msleep_interruptible(1000);
1057 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
1058 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
1059 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
1060 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
1062 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1064 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
1069 static int cxacru_find_firmware(struct cxacru_data *instance,
1070 char* phase, const struct firmware **fw_p)
1072 struct usbatm_data *usbatm = instance->usbatm;
1073 struct device *dev = &usbatm->usb_intf->dev;
1076 sprintf(buf, "cxacru-%s.bin", phase);
1077 dbg("cxacru_find_firmware: looking for %s", buf);
1079 if (request_firmware(fw_p, buf, dev)) {
1080 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
1084 usb_info(usbatm, "found firmware %s\n", buf);
1089 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1090 struct usb_interface *usb_intf)
1092 const struct firmware *fw, *bp;
1093 struct cxacru_data *instance = usbatm_instance->driver_data;
1095 int ret = cxacru_find_firmware(instance, "fw", &fw);
1097 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1101 if (instance->modem_type->boot_rom_patch) {
1102 ret = cxacru_find_firmware(instance, "bp", &bp);
1104 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1105 release_firmware(fw);
1110 cxacru_upload_firmware(instance, fw, bp);
1112 if (instance->modem_type->boot_rom_patch)
1113 release_firmware(bp);
1114 release_firmware(fw);
1116 ret = cxacru_card_status(instance);
1118 dbg("modem initialisation failed");
1120 dbg("done setting up the modem");
1125 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1126 struct usb_interface *intf, const struct usb_device_id *id)
1128 struct cxacru_data *instance;
1129 struct usb_device *usb_dev = interface_to_usbdev(intf);
1133 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1135 dbg("cxacru_bind: no memory for instance data");
1139 instance->usbatm = usbatm_instance;
1140 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1142 mutex_init(&instance->poll_state_serialize);
1143 instance->poll_state = CXPOLL_STOPPED;
1144 instance->line_status = -1;
1145 instance->adsl_status = -1;
1147 mutex_init(&instance->adsl_state_serialize);
1149 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1150 if (!instance->rcv_buf) {
1151 dbg("cxacru_bind: no memory for rcv_buf");
1155 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1156 if (!instance->snd_buf) {
1157 dbg("cxacru_bind: no memory for snd_buf");
1161 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1162 if (!instance->rcv_urb) {
1163 dbg("cxacru_bind: no memory for rcv_urb");
1167 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1168 if (!instance->snd_urb) {
1169 dbg("cxacru_bind: no memory for snd_urb");
1174 usb_fill_int_urb(instance->rcv_urb,
1175 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1176 instance->rcv_buf, PAGE_SIZE,
1177 cxacru_blocking_completion, &instance->rcv_done, 1);
1179 usb_fill_int_urb(instance->snd_urb,
1180 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1181 instance->snd_buf, PAGE_SIZE,
1182 cxacru_blocking_completion, &instance->snd_done, 4);
1184 mutex_init(&instance->cm_serialize);
1186 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1188 usbatm_instance->driver_data = instance;
1190 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1195 free_page((unsigned long) instance->snd_buf);
1196 free_page((unsigned long) instance->rcv_buf);
1197 usb_free_urb(instance->snd_urb);
1198 usb_free_urb(instance->rcv_urb);
1204 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1205 struct usb_interface *intf)
1207 struct cxacru_data *instance = usbatm_instance->driver_data;
1210 dbg("cxacru_unbind entered");
1213 dbg("cxacru_unbind: NULL instance!");
1217 mutex_lock(&instance->poll_state_serialize);
1218 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1220 /* ensure that status polling continues unless
1221 * it has already stopped */
1222 if (instance->poll_state == CXPOLL_STOPPED)
1225 /* stop polling from being stopped or started */
1226 instance->poll_state = CXPOLL_SHUTDOWN;
1227 mutex_unlock(&instance->poll_state_serialize);
1230 cancel_rearming_delayed_work(&instance->poll_work);
1232 usb_kill_urb(instance->snd_urb);
1233 usb_kill_urb(instance->rcv_urb);
1234 usb_free_urb(instance->snd_urb);
1235 usb_free_urb(instance->rcv_urb);
1237 free_page((unsigned long) instance->snd_buf);
1238 free_page((unsigned long) instance->rcv_buf);
1242 usbatm_instance->driver_data = NULL;
1245 static const struct cxacru_modem_type cxacru_cafe = {
1246 .pll_f_clk = 0x02d874df,
1247 .pll_b_clk = 0x0196a51a,
1248 .boot_rom_patch = 1,
1251 static const struct cxacru_modem_type cxacru_cb00 = {
1254 .boot_rom_patch = 0,
1257 static const struct usb_device_id cxacru_usb_ids[] = {
1258 { /* V = Conexant P = ADSL modem (Euphrates project) */
1259 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1261 { /* V = Conexant P = ADSL modem (Hasbani project) */
1262 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1264 { /* V = Conexant P = ADSL modem */
1265 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1267 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1268 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1270 { /* V = Conexant P = ADSL modem */
1271 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1273 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1274 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1276 { /* V = Olitec P = ADSL modem version 2 */
1277 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1279 { /* V = Olitec P = ADSL modem version 3 */
1280 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1282 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1283 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1285 { /* V = Zoom P = 5510 */
1286 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1288 { /* V = Draytek P = Vigor 318 */
1289 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1291 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1292 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1294 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1295 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1297 { /* V = Aethra P = Starmodem UM1020 */
1298 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1300 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1301 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1303 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1304 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1306 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1307 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1312 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1314 static struct usbatm_driver cxacru_driver = {
1315 .driver_name = cxacru_driver_name,
1316 .bind = cxacru_bind,
1317 .heavy_init = cxacru_heavy_init,
1318 .unbind = cxacru_unbind,
1319 .atm_start = cxacru_atm_start,
1320 .atm_stop = cxacru_remove_device_files,
1321 .bulk_in = CXACRU_EP_DATA,
1322 .bulk_out = CXACRU_EP_DATA,
1327 static int cxacru_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1329 return usbatm_usb_probe(intf, id, &cxacru_driver);
1332 static struct usb_driver cxacru_usb_driver = {
1333 .name = cxacru_driver_name,
1334 .probe = cxacru_usb_probe,
1335 .disconnect = usbatm_usb_disconnect,
1336 .id_table = cxacru_usb_ids
1339 static int __init cxacru_init(void)
1341 return usb_register(&cxacru_usb_driver);
1344 static void __exit cxacru_cleanup(void)
1346 usb_deregister(&cxacru_usb_driver);
1349 module_init(cxacru_init);
1350 module_exit(cxacru_cleanup);
1352 MODULE_AUTHOR(DRIVER_AUTHOR);
1353 MODULE_DESCRIPTION(DRIVER_DESC);
1354 MODULE_LICENSE("GPL");
1355 MODULE_VERSION(DRIVER_VERSION);