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
8 * Copyright (C) 2009 Simon Arlott
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the Free
12 * Software Foundation; either version 2 of the License, or (at your option)
15 * This program is distributed in the hope that it will be useful, but WITHOUT
16 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
17 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
20 * You should have received a copy of the GNU General Public License along with
21 * this program; if not, write to the Free Software Foundation, Inc., 59
22 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
24 ******************************************************************************/
27 * Credit is due for Josep Comas, who created the original patch to speedtch.c
28 * to support the different padding used by the AccessRunner (now generalized
29 * into usbatm), and the userspace firmware loading utility.
32 #include <linux/module.h>
33 #include <linux/moduleparam.h>
34 #include <linux/kernel.h>
35 #include <linux/timer.h>
36 #include <linux/errno.h>
37 #include <linux/slab.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.4"
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" };
274 if (unlikely(value >= ARRAY_SIZE(str)))
275 return snprintf(buf, PAGE_SIZE, "%u\n", value);
276 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
279 static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
281 static char *str[] = { NULL, "not connected", "connected", "lost" };
283 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
284 return snprintf(buf, PAGE_SIZE, "%u\n", value);
285 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
288 static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
290 static char *str[] = { "down", "attempting to activate",
291 "training", "channel analysis", "exchange", "up",
292 "waiting", "initialising"
294 if (unlikely(value >= ARRAY_SIZE(str)))
295 return snprintf(buf, PAGE_SIZE, "%u\n", value);
296 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
299 static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
301 static char *str[] = {
304 "ITU-T G.992.1 (G.DMT)",
305 "ITU-T G.992.2 (G.LITE)"
307 if (unlikely(value >= ARRAY_SIZE(str)))
308 return snprintf(buf, PAGE_SIZE, "%u\n", value);
309 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
313 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
314 * this data is already in atm_dev there's no point.
316 * MAC_ADDRESS_HIGH = 0x????5544
317 * MAC_ADDRESS_LOW = 0x33221100
318 * Where 00-55 are bytes 0-5 of the MAC.
320 static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
321 struct device_attribute *attr, char *buf)
323 struct cxacru_data *instance = to_usbatm_driver_data(
324 to_usb_interface(dev));
326 if (instance == NULL || instance->usbatm->atm_dev == NULL)
329 return snprintf(buf, PAGE_SIZE, "%pM\n",
330 instance->usbatm->atm_dev->esi);
333 static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
334 struct device_attribute *attr, char *buf)
336 static char *str[] = { "running", "stopped" };
337 struct cxacru_data *instance = to_usbatm_driver_data(
338 to_usb_interface(dev));
341 if (instance == NULL)
344 value = instance->card_info[CXINF_LINE_STARTABLE];
345 if (unlikely(value >= ARRAY_SIZE(str)))
346 return snprintf(buf, PAGE_SIZE, "%u\n", value);
347 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
350 static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
351 struct device_attribute *attr, const char *buf, size_t count)
353 struct cxacru_data *instance = to_usbatm_driver_data(
354 to_usb_interface(dev));
358 int len = strlen(buf);
360 if (!capable(CAP_NET_ADMIN))
363 ret = sscanf(buf, "%7s", str_cmd);
368 if (instance == NULL)
371 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
374 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
375 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
377 atm_err(instance->usbatm, "change adsl state:"
378 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
383 poll = CXPOLL_STOPPED;
387 /* Line status is only updated every second
388 * and the device appears to only react to
389 * START/STOP every second too. Wait 1.5s to
390 * be sure that restart will have an effect. */
391 if (!strcmp(str_cmd, "restart"))
394 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
395 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
397 atm_err(instance->usbatm, "change adsl state:"
398 " CHIP_ADSL_LINE_START returned %d\n", ret);
403 poll = CXPOLL_POLLING;
407 if (!strcmp(str_cmd, "poll")) {
409 poll = CXPOLL_POLLING;
417 if (poll == CXPOLL_POLLING) {
418 mutex_lock(&instance->poll_state_serialize);
419 switch (instance->poll_state) {
422 instance->poll_state = CXPOLL_POLLING;
425 case CXPOLL_STOPPING:
426 /* abort stop request */
427 instance->poll_state = CXPOLL_POLLING;
429 case CXPOLL_SHUTDOWN:
430 /* don't start polling */
433 mutex_unlock(&instance->poll_state_serialize);
434 } else if (poll == CXPOLL_STOPPED) {
435 mutex_lock(&instance->poll_state_serialize);
437 if (instance->poll_state == CXPOLL_POLLING)
438 instance->poll_state = CXPOLL_STOPPING;
439 mutex_unlock(&instance->poll_state_serialize);
442 mutex_unlock(&instance->adsl_state_serialize);
444 if (poll == CXPOLL_POLLING)
445 cxacru_poll_status(&instance->poll_work.work);
450 /* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
452 static ssize_t cxacru_sysfs_store_adsl_config(struct device *dev,
453 struct device_attribute *attr, const char *buf, size_t count)
455 struct cxacru_data *instance = to_usbatm_driver_data(
456 to_usb_interface(dev));
457 int len = strlen(buf);
459 __le32 data[CMD_PACKET_SIZE / 4];
461 if (!capable(CAP_NET_ADMIN))
464 if (instance == NULL)
474 ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
477 if (index < 0 || index > 0x7f)
481 /* skip trailing newline */
482 if (buf[pos] == '\n' && pos == len-1)
485 data[num * 2 + 1] = cpu_to_le32(index);
486 data[num * 2 + 2] = cpu_to_le32(value);
489 /* send config values when data buffer is full
492 if (pos >= len || num >= CMD_MAX_CONFIG) {
493 char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
495 data[0] = cpu_to_le32(num);
496 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
497 (u8 *) data, 4 + num * 8, NULL, 0);
499 atm_err(instance->usbatm,
500 "set card data returned %d\n", ret);
504 for (tmp = 0; tmp < num; tmp++)
505 snprintf(log + tmp*12, 13, " %02x=%08x",
506 le32_to_cpu(data[tmp * 2 + 1]),
507 le32_to_cpu(data[tmp * 2 + 2]));
508 atm_info(instance->usbatm, "config%s\n", log);
517 * All device attributes are included in CXACRU_ALL_FILES
518 * so that the same list can be used multiple times:
519 * INIT (define the device attributes)
520 * CREATE (create all the device files)
521 * REMOVE (remove all the device files)
523 * With the last two being defined as needed in the functions
524 * they are used in before calling CXACRU_ALL_FILES()
526 #define CXACRU_ALL_FILES(_action) \
527 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
528 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
529 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
530 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
531 CXACRU__ATTR_##_action( mac_address); \
532 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
533 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
534 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
535 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
536 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
537 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
538 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
539 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
540 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
541 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
542 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
543 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
544 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
545 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
546 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
547 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
548 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
549 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
550 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
551 CXACRU_CMD_##_action( adsl_state); \
552 CXACRU_SET_##_action( adsl_config);
554 CXACRU_ALL_FILES(INIT);
556 /* the following three functions are stolen from drivers/usb/core/message.c */
557 static void cxacru_blocking_completion(struct urb *urb)
559 complete(urb->context);
562 static void cxacru_timeout_kill(unsigned long data)
564 usb_unlink_urb((struct urb *) data);
567 static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
570 struct timer_list timer;
573 timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
574 timer.data = (unsigned long) urb;
575 timer.function = cxacru_timeout_kill;
577 wait_for_completion(done);
578 del_timer_sync(&timer);
581 *actual_length = urb->actual_length;
582 return urb->status; /* must read status after completion */
585 static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
586 u8 *wdata, int wsize, u8 *rdata, int rsize)
590 const int stride = CMD_PACKET_SIZE - 4;
591 u8 *wbuf = instance->snd_buf;
592 u8 *rbuf = instance->rcv_buf;
593 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
594 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
596 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
597 if (printk_ratelimit())
598 usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
604 mutex_lock(&instance->cm_serialize);
606 /* submit reading urb before the writing one */
607 init_completion(&instance->rcv_done);
608 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
610 if (printk_ratelimit())
611 usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
616 memset(wbuf, 0, wbuflen);
617 /* handle wsize == 0 */
619 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
621 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
624 instance->snd_urb->transfer_buffer_length = wbuflen;
625 init_completion(&instance->snd_done);
626 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
628 if (printk_ratelimit())
629 usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
634 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
636 if (printk_ratelimit())
637 usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
641 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
643 if (printk_ratelimit())
644 usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
647 if (actlen % CMD_PACKET_SIZE || !actlen) {
648 if (printk_ratelimit())
649 usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
655 /* check the return status and copy the data to the output buffer, if needed */
656 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
657 if (rbuf[offb] != cm) {
658 if (printk_ratelimit())
659 usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
664 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
665 if (printk_ratelimit())
666 usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
673 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
678 usb_dbg(instance->usbatm, "cm %#x\n", cm);
680 mutex_unlock(&instance->cm_serialize);
685 static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
692 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
693 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
695 buf = kmalloc(buflen, GFP_KERNEL);
699 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
703 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
705 for (offb = 0; offb < len; ) {
706 int l = le32_to_cpu(buf[offb++]);
708 if (l < 0 || l > stride || l > (len - offb) / 2) {
709 if (printk_ratelimit())
710 usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
716 offd = le32_to_cpu(buf[offb++]);
718 if (printk_ratelimit())
719 usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
724 data[offd] = le32_to_cpu(buf[offb++]);
735 static int cxacru_card_status(struct cxacru_data *instance)
737 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
739 if (ret < 0) { /* firmware not loaded */
740 usb_dbg(instance->usbatm, "cxacru_adsl_start: CARD_GET_STATUS returned %d\n", ret);
746 static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
747 struct atm_dev *atm_dev)
749 struct usb_interface *intf = usbatm_instance->usb_intf;
751 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
752 device_remove_file(&intf->dev, &dev_attr_##_name);
753 CXACRU_ALL_FILES(REMOVE);
754 #undef CXACRU_DEVICE_REMOVE_FILE
757 static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
758 struct atm_dev *atm_dev)
760 struct cxacru_data *instance = usbatm_instance->driver_data;
761 struct usb_interface *intf = usbatm_instance->usb_intf;
763 int start_polling = 1;
765 dev_dbg(&intf->dev, "%s\n", __func__);
767 /* Read MAC address */
768 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
769 atm_dev->esi, sizeof(atm_dev->esi));
771 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
775 #define CXACRU_DEVICE_CREATE_FILE(_name) \
776 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
779 CXACRU_ALL_FILES(CREATE);
780 #undef CXACRU_DEVICE_CREATE_FILE
783 mutex_lock(&instance->adsl_state_serialize);
784 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
786 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
788 /* Start status polling */
789 mutex_lock(&instance->poll_state_serialize);
790 switch (instance->poll_state) {
793 instance->poll_state = CXPOLL_POLLING;
796 case CXPOLL_STOPPING:
797 /* abort stop request */
798 instance->poll_state = CXPOLL_POLLING;
800 case CXPOLL_SHUTDOWN:
801 /* don't start polling */
804 mutex_unlock(&instance->poll_state_serialize);
805 mutex_unlock(&instance->adsl_state_serialize);
807 printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
808 usbatm_instance->description, atm_dev->esi);
811 cxacru_poll_status(&instance->poll_work.work);
815 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
816 cxacru_remove_device_files(usbatm_instance, atm_dev);
820 static void cxacru_poll_status(struct work_struct *work)
822 struct cxacru_data *instance =
823 container_of(work, struct cxacru_data, poll_work.work);
824 u32 buf[CXINF_MAX] = {};
825 struct usbatm_data *usbatm = instance->usbatm;
826 struct atm_dev *atm_dev = usbatm->atm_dev;
827 int keep_polling = 1;
830 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
832 if (ret != -ESHUTDOWN)
833 atm_warn(usbatm, "poll status: error %d\n", ret);
835 mutex_lock(&instance->poll_state_serialize);
836 if (instance->poll_state != CXPOLL_SHUTDOWN) {
837 instance->poll_state = CXPOLL_STOPPED;
839 if (ret != -ESHUTDOWN)
840 atm_warn(usbatm, "polling disabled, set adsl_state"
841 " to 'start' or 'poll' to resume\n");
843 mutex_unlock(&instance->poll_state_serialize);
847 memcpy(instance->card_info, buf, sizeof(instance->card_info));
849 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
850 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
852 switch (instance->adsl_status) {
854 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
858 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
862 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
867 if (instance->line_status == buf[CXINF_LINE_STATUS])
870 instance->line_status = buf[CXINF_LINE_STATUS];
871 switch (instance->line_status) {
873 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
874 atm_info(usbatm, "ADSL line: down\n");
878 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
879 atm_info(usbatm, "ADSL line: attempting to activate\n");
883 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
884 atm_info(usbatm, "ADSL line: training\n");
888 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
889 atm_info(usbatm, "ADSL line: channel analysis\n");
893 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
894 atm_info(usbatm, "ADSL line: exchange\n");
898 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
899 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_FOUND);
901 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
902 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
906 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
907 atm_info(usbatm, "ADSL line: waiting\n");
911 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
912 atm_info(usbatm, "ADSL line: initializing\n");
916 atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
917 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
922 mutex_lock(&instance->poll_state_serialize);
923 if (instance->poll_state == CXPOLL_STOPPING &&
924 instance->adsl_status == 1 && /* stopped */
925 instance->line_status == 0) /* down */
926 instance->poll_state = CXPOLL_STOPPED;
928 if (instance->poll_state == CXPOLL_STOPPED)
930 mutex_unlock(&instance->poll_state_serialize);
933 schedule_delayed_work(&instance->poll_work,
934 round_jiffies_relative(POLL_INTERVAL*HZ));
937 static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
938 u8 code1, u8 code2, u32 addr, const u8 *data, int size)
943 const int stride = CMD_PACKET_SIZE - 8;
945 buf = (u8 *) __get_free_page(GFP_KERNEL);
951 int l = min_t(int, stride, size - offd);
957 put_unaligned(cpu_to_le32(addr), (__le32 *)(buf + offb));
961 memcpy(buf + offb, data + offd, l);
963 memset(buf + offb + l, 0, stride - l);
966 if ((offb >= PAGE_SIZE) || (offd >= size)) {
967 ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
968 buf, offb, NULL, CMD_TIMEOUT);
970 dev_dbg(&usb_dev->dev, "sending fw %#x failed\n", fw);
975 } while (offd < size);
976 dev_dbg(&usb_dev->dev, "sent fw %#x\n", fw);
981 free_page((unsigned long) buf);
985 static void cxacru_upload_firmware(struct cxacru_data *instance,
986 const struct firmware *fw,
987 const struct firmware *bp)
990 struct usbatm_data *usbatm = instance->usbatm;
991 struct usb_device *usb_dev = usbatm->usb_dev;
992 __le16 signature[] = { usb_dev->descriptor.idVendor,
993 usb_dev->descriptor.idProduct };
996 usb_dbg(usbatm, "%s\n", __func__);
998 /* FirmwarePllFClkValue */
999 val = cpu_to_le32(instance->modem_type->pll_f_clk);
1000 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
1002 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
1006 /* FirmwarePllBClkValue */
1007 val = cpu_to_le32(instance->modem_type->pll_b_clk);
1008 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
1010 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
1015 val = cpu_to_le32(SDRAM_ENA);
1016 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
1018 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
1023 usb_info(usbatm, "loading firmware\n");
1024 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
1026 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
1030 /* Boot ROM patch */
1031 if (instance->modem_type->boot_rom_patch) {
1032 usb_info(usbatm, "loading boot ROM patch\n");
1033 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
1035 usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
1041 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
1043 usb_err(usbatm, "Signature storing failed: %d\n", ret);
1047 usb_info(usbatm, "starting device\n");
1048 if (instance->modem_type->boot_rom_patch) {
1049 val = cpu_to_le32(BR_ADDR);
1050 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
1052 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1055 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
1059 /* Delay to allow firmware to start up. */
1060 msleep_interruptible(1000);
1062 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
1063 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
1064 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
1065 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
1067 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1069 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
1074 static int cxacru_find_firmware(struct cxacru_data *instance,
1075 char *phase, const struct firmware **fw_p)
1077 struct usbatm_data *usbatm = instance->usbatm;
1078 struct device *dev = &usbatm->usb_intf->dev;
1081 sprintf(buf, "cxacru-%s.bin", phase);
1082 usb_dbg(usbatm, "cxacru_find_firmware: looking for %s\n", buf);
1084 if (request_firmware(fw_p, buf, dev)) {
1085 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
1089 usb_info(usbatm, "found firmware %s\n", buf);
1094 static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1095 struct usb_interface *usb_intf)
1097 const struct firmware *fw, *bp;
1098 struct cxacru_data *instance = usbatm_instance->driver_data;
1099 int ret = cxacru_find_firmware(instance, "fw", &fw);
1102 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1106 if (instance->modem_type->boot_rom_patch) {
1107 ret = cxacru_find_firmware(instance, "bp", &bp);
1109 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1110 release_firmware(fw);
1115 cxacru_upload_firmware(instance, fw, bp);
1117 if (instance->modem_type->boot_rom_patch)
1118 release_firmware(bp);
1119 release_firmware(fw);
1121 ret = cxacru_card_status(instance);
1123 usb_dbg(usbatm_instance, "modem initialisation failed\n");
1125 usb_dbg(usbatm_instance, "done setting up the modem\n");
1130 static int cxacru_bind(struct usbatm_data *usbatm_instance,
1131 struct usb_interface *intf, const struct usb_device_id *id)
1133 struct cxacru_data *instance;
1134 struct usb_device *usb_dev = interface_to_usbdev(intf);
1135 struct usb_host_endpoint *cmd_ep = usb_dev->ep_in[CXACRU_EP_CMD];
1139 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1141 usb_dbg(usbatm_instance, "cxacru_bind: no memory for instance data\n");
1145 instance->usbatm = usbatm_instance;
1146 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1148 mutex_init(&instance->poll_state_serialize);
1149 instance->poll_state = CXPOLL_STOPPED;
1150 instance->line_status = -1;
1151 instance->adsl_status = -1;
1153 mutex_init(&instance->adsl_state_serialize);
1155 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1156 if (!instance->rcv_buf) {
1157 usb_dbg(usbatm_instance, "cxacru_bind: no memory for rcv_buf\n");
1161 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1162 if (!instance->snd_buf) {
1163 usb_dbg(usbatm_instance, "cxacru_bind: no memory for snd_buf\n");
1167 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1168 if (!instance->rcv_urb) {
1169 usb_dbg(usbatm_instance, "cxacru_bind: no memory for rcv_urb\n");
1173 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1174 if (!instance->snd_urb) {
1175 usb_dbg(usbatm_instance, "cxacru_bind: no memory for snd_urb\n");
1181 usb_dbg(usbatm_instance, "cxacru_bind: no command endpoint\n");
1186 if ((cmd_ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1187 == USB_ENDPOINT_XFER_INT) {
1188 usb_fill_int_urb(instance->rcv_urb,
1189 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1190 instance->rcv_buf, PAGE_SIZE,
1191 cxacru_blocking_completion, &instance->rcv_done, 1);
1193 usb_fill_int_urb(instance->snd_urb,
1194 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1195 instance->snd_buf, PAGE_SIZE,
1196 cxacru_blocking_completion, &instance->snd_done, 4);
1198 usb_fill_bulk_urb(instance->rcv_urb,
1199 usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD),
1200 instance->rcv_buf, PAGE_SIZE,
1201 cxacru_blocking_completion, &instance->rcv_done);
1203 usb_fill_bulk_urb(instance->snd_urb,
1204 usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
1205 instance->snd_buf, PAGE_SIZE,
1206 cxacru_blocking_completion, &instance->snd_done);
1209 mutex_init(&instance->cm_serialize);
1211 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1213 usbatm_instance->driver_data = instance;
1215 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1220 free_page((unsigned long) instance->snd_buf);
1221 free_page((unsigned long) instance->rcv_buf);
1222 usb_free_urb(instance->snd_urb);
1223 usb_free_urb(instance->rcv_urb);
1229 static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1230 struct usb_interface *intf)
1232 struct cxacru_data *instance = usbatm_instance->driver_data;
1235 usb_dbg(usbatm_instance, "cxacru_unbind entered\n");
1238 usb_dbg(usbatm_instance, "cxacru_unbind: NULL instance!\n");
1242 mutex_lock(&instance->poll_state_serialize);
1243 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1245 /* ensure that status polling continues unless
1246 * it has already stopped */
1247 if (instance->poll_state == CXPOLL_STOPPED)
1250 /* stop polling from being stopped or started */
1251 instance->poll_state = CXPOLL_SHUTDOWN;
1252 mutex_unlock(&instance->poll_state_serialize);
1255 cancel_delayed_work_sync(&instance->poll_work);
1257 usb_kill_urb(instance->snd_urb);
1258 usb_kill_urb(instance->rcv_urb);
1259 usb_free_urb(instance->snd_urb);
1260 usb_free_urb(instance->rcv_urb);
1262 free_page((unsigned long) instance->snd_buf);
1263 free_page((unsigned long) instance->rcv_buf);
1267 usbatm_instance->driver_data = NULL;
1270 static const struct cxacru_modem_type cxacru_cafe = {
1271 .pll_f_clk = 0x02d874df,
1272 .pll_b_clk = 0x0196a51a,
1273 .boot_rom_patch = 1,
1276 static const struct cxacru_modem_type cxacru_cb00 = {
1279 .boot_rom_patch = 0,
1282 static const struct usb_device_id cxacru_usb_ids[] = {
1283 { /* V = Conexant P = ADSL modem (Euphrates project) */
1284 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1286 { /* V = Conexant P = ADSL modem (Hasbani project) */
1287 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1289 { /* V = Conexant P = ADSL modem */
1290 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1292 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1293 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1295 { /* V = Conexant P = ADSL modem */
1296 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1298 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1299 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1301 { /* V = Olitec P = ADSL modem version 2 */
1302 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1304 { /* V = Olitec P = ADSL modem version 3 */
1305 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1307 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1308 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1310 { /* V = Zoom P = 5510 */
1311 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1313 { /* V = Draytek P = Vigor 318 */
1314 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1316 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1317 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1319 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1320 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1322 { /* V = Aethra P = Starmodem UM1020 */
1323 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1325 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1326 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1328 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1329 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1331 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1332 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1337 MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1339 static struct usbatm_driver cxacru_driver = {
1340 .driver_name = cxacru_driver_name,
1341 .bind = cxacru_bind,
1342 .heavy_init = cxacru_heavy_init,
1343 .unbind = cxacru_unbind,
1344 .atm_start = cxacru_atm_start,
1345 .atm_stop = cxacru_remove_device_files,
1346 .bulk_in = CXACRU_EP_DATA,
1347 .bulk_out = CXACRU_EP_DATA,
1352 static int cxacru_usb_probe(struct usb_interface *intf,
1353 const struct usb_device_id *id)
1355 struct usb_device *usb_dev = interface_to_usbdev(intf);
1358 /* Avoid ADSL routers (cx82310_eth).
1359 * Abort if bDeviceClass is 0xff and iProduct is "USB NET CARD".
1361 if (usb_dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC
1362 && usb_string(usb_dev, usb_dev->descriptor.iProduct,
1363 buf, sizeof(buf)) > 0) {
1364 if (!strcmp(buf, "USB NET CARD")) {
1365 dev_info(&intf->dev, "ignoring cx82310_eth device\n");
1370 return usbatm_usb_probe(intf, id, &cxacru_driver);
1373 static struct usb_driver cxacru_usb_driver = {
1374 .name = cxacru_driver_name,
1375 .probe = cxacru_usb_probe,
1376 .disconnect = usbatm_usb_disconnect,
1377 .id_table = cxacru_usb_ids
1380 module_usb_driver(cxacru_usb_driver);
1382 MODULE_AUTHOR(DRIVER_AUTHOR);
1383 MODULE_DESCRIPTION(DRIVER_DESC);
1384 MODULE_LICENSE("GPL");
1385 MODULE_VERSION(DRIVER_VERSION);