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)? */
57 #define PLLFCLK_ADDR 0x00350068
58 #define PLLBCLK_ADDR 0x0035006c
59 #define SDRAMEN_ADDR 0x00350010
60 #define FW_ADDR 0x00801000
61 #define BR_ADDR 0x00180600
62 #define SIG_ADDR 0x00180500
63 #define BR_STACK_ADDR 0x00187f10
68 #define CMD_TIMEOUT 2000 /* msecs */
69 #define POLL_INTERVAL 1 /* secs */
71 /* commands for interaction with the modem through the control channel before
72 * firmware is loaded */
73 enum cxacru_fw_request
{
83 /* commands for interaction with the modem through the control channel once
84 * firmware is loaded */
85 enum cxacru_cm_request
{
86 CM_REQUEST_UNDEFINED
= 0x80,
88 CM_REQUEST_CHIP_GET_MAC_ADDRESS
,
89 CM_REQUEST_CHIP_GET_DP_VERSIONS
,
90 CM_REQUEST_CHIP_ADSL_LINE_START
,
91 CM_REQUEST_CHIP_ADSL_LINE_STOP
,
92 CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS
,
93 CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED
,
94 CM_REQUEST_CARD_INFO_GET
,
95 CM_REQUEST_CARD_DATA_GET
,
96 CM_REQUEST_CARD_DATA_SET
,
97 CM_REQUEST_COMMAND_HW_IO
,
98 CM_REQUEST_INTERFACE_HW_IO
,
99 CM_REQUEST_CARD_SERIAL_DATA_PATH_GET
,
100 CM_REQUEST_CARD_SERIAL_DATA_PATH_SET
,
101 CM_REQUEST_CARD_CONTROLLER_VERSION_GET
,
102 CM_REQUEST_CARD_GET_STATUS
,
103 CM_REQUEST_CARD_GET_MAC_ADDRESS
,
104 CM_REQUEST_CARD_GET_DATA_LINK_STATUS
,
108 /* reply codes to the commands above */
109 enum cxacru_cm_status
{
113 CM_STATUS_UNSUPPORTED
,
114 CM_STATUS_UNIMPLEMENTED
,
115 CM_STATUS_PARAMETER_ERROR
,
116 CM_STATUS_DBG_LOOPBACK
,
120 /* indices into CARD_INFO_GET return array */
121 enum cxacru_info_idx
{
122 CXINF_DOWNSTREAM_RATE
,
126 CXINF_MAC_ADDRESS_HIGH
,
127 CXINF_MAC_ADDRESS_LOW
,
128 CXINF_UPSTREAM_SNR_MARGIN
,
129 CXINF_DOWNSTREAM_SNR_MARGIN
,
130 CXINF_UPSTREAM_ATTENUATION
,
131 CXINF_DOWNSTREAM_ATTENUATION
,
132 CXINF_TRANSMITTER_POWER
,
133 CXINF_UPSTREAM_BITS_PER_FRAME
,
134 CXINF_DOWNSTREAM_BITS_PER_FRAME
,
135 CXINF_STARTUP_ATTEMPTS
,
136 CXINF_UPSTREAM_CRC_ERRORS
,
137 CXINF_DOWNSTREAM_CRC_ERRORS
,
138 CXINF_UPSTREAM_FEC_ERRORS
,
139 CXINF_DOWNSTREAM_FEC_ERRORS
,
140 CXINF_UPSTREAM_HEC_ERRORS
,
141 CXINF_DOWNSTREAM_HEC_ERRORS
,
142 CXINF_LINE_STARTABLE
,
145 CXINF_ADSL_HEADEND_ENVIRONMENT
,
146 CXINF_CONTROLLER_VERSION
,
147 /* dunno what the missing two mean */
151 enum cxacru_poll_state
{
158 struct cxacru_modem_type
{
165 struct usbatm_data
*usbatm
;
167 const struct cxacru_modem_type
*modem_type
;
170 struct mutex adsl_state_serialize
;
172 struct delayed_work poll_work
;
173 u32 card_info
[CXINF_MAX
];
174 struct mutex poll_state_serialize
;
175 enum cxacru_poll_state poll_state
;
178 struct mutex cm_serialize
;
183 struct completion rcv_done
;
184 struct completion snd_done
;
187 static int cxacru_cm(struct cxacru_data
*instance
, enum cxacru_cm_request cm
,
188 u8
*wdata
, int wsize
, u8
*rdata
, int rsize
);
189 static void cxacru_poll_status(struct work_struct
*work
);
191 /* Card info exported through sysfs */
192 #define CXACRU__ATTR_INIT(_name) \
193 static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
195 #define CXACRU_CMD_INIT(_name) \
196 static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
197 cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
199 #define CXACRU_ATTR_INIT(_value, _type, _name) \
200 static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
201 struct device_attribute *attr, char *buf) \
203 struct usb_interface *intf = to_usb_interface(dev); \
204 struct usbatm_data *usbatm_instance = usb_get_intfdata(intf); \
205 struct cxacru_data *instance = usbatm_instance->driver_data; \
206 return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
208 CXACRU__ATTR_INIT(_name)
210 #define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
211 #define CXACRU_CMD_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
212 #define CXACRU__ATTR_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
214 #define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
215 #define CXACRU_CMD_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
216 #define CXACRU__ATTR_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
218 static ssize_t
cxacru_sysfs_showattr_u32(u32 value
, char *buf
)
220 return snprintf(buf
, PAGE_SIZE
, "%u\n", value
);
223 static ssize_t
cxacru_sysfs_showattr_s8(s8 value
, char *buf
)
225 return snprintf(buf
, PAGE_SIZE
, "%d\n", value
);
228 static ssize_t
cxacru_sysfs_showattr_dB(s16 value
, char *buf
)
230 if (likely(value
>= 0)) {
231 return snprintf(buf
, PAGE_SIZE
, "%u.%02u\n",
232 value
/ 100, value
% 100);
235 return snprintf(buf
, PAGE_SIZE
, "-%u.%02u\n",
236 value
/ 100, value
% 100);
240 static ssize_t
cxacru_sysfs_showattr_bool(u32 value
, char *buf
)
242 static char *str
[] = { "no", "yes" };
243 if (unlikely(value
>= ARRAY_SIZE(str
)))
244 return snprintf(buf
, PAGE_SIZE
, "%u\n", value
);
245 return snprintf(buf
, PAGE_SIZE
, "%s\n", str
[value
]);
248 static ssize_t
cxacru_sysfs_showattr_LINK(u32 value
, char *buf
)
250 static char *str
[] = { NULL
, "not connected", "connected", "lost" };
251 if (unlikely(value
>= ARRAY_SIZE(str
) || str
[value
] == NULL
))
252 return snprintf(buf
, PAGE_SIZE
, "%u\n", value
);
253 return snprintf(buf
, PAGE_SIZE
, "%s\n", str
[value
]);
256 static ssize_t
cxacru_sysfs_showattr_LINE(u32 value
, char *buf
)
258 static char *str
[] = { "down", "attempting to activate",
259 "training", "channel analysis", "exchange", "up",
260 "waiting", "initialising"
262 if (unlikely(value
>= ARRAY_SIZE(str
)))
263 return snprintf(buf
, PAGE_SIZE
, "%u\n", value
);
264 return snprintf(buf
, PAGE_SIZE
, "%s\n", str
[value
]);
267 static ssize_t
cxacru_sysfs_showattr_MODU(u32 value
, char *buf
)
269 static char *str
[] = {
272 "ITU-T G.992.1 (G.DMT)",
273 "ITU-T G.992.2 (G.LITE)"
275 if (unlikely(value
>= ARRAY_SIZE(str
) || str
[value
] == NULL
))
276 return snprintf(buf
, PAGE_SIZE
, "%u\n", value
);
277 return snprintf(buf
, PAGE_SIZE
, "%s\n", str
[value
]);
281 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
282 * this data is already in atm_dev there's no point.
284 * MAC_ADDRESS_HIGH = 0x????5544
285 * MAC_ADDRESS_LOW = 0x33221100
286 * Where 00-55 are bytes 0-5 of the MAC.
288 static ssize_t
cxacru_sysfs_show_mac_address(struct device
*dev
,
289 struct device_attribute
*attr
, char *buf
)
291 struct usb_interface
*intf
= to_usb_interface(dev
);
292 struct usbatm_data
*usbatm_instance
= usb_get_intfdata(intf
);
293 struct atm_dev
*atm_dev
= usbatm_instance
->atm_dev
;
295 return snprintf(buf
, PAGE_SIZE
, "%pM\n", atm_dev
->esi
);
298 static ssize_t
cxacru_sysfs_show_adsl_state(struct device
*dev
,
299 struct device_attribute
*attr
, char *buf
)
301 struct usb_interface
*intf
= to_usb_interface(dev
);
302 struct usbatm_data
*usbatm_instance
= usb_get_intfdata(intf
);
303 struct cxacru_data
*instance
= usbatm_instance
->driver_data
;
304 u32 value
= instance
->card_info
[CXINF_LINE_STARTABLE
];
306 static char *str
[] = { "running", "stopped" };
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
]);
312 static ssize_t
cxacru_sysfs_store_adsl_state(struct device
*dev
,
313 struct device_attribute
*attr
, const char *buf
, size_t count
)
315 struct usb_interface
*intf
= to_usb_interface(dev
);
316 struct usbatm_data
*usbatm_instance
= usb_get_intfdata(intf
);
317 struct cxacru_data
*instance
= usbatm_instance
->driver_data
;
321 int len
= strlen(buf
);
323 if (!capable(CAP_NET_ADMIN
))
326 ret
= sscanf(buf
, "%7s", str_cmd
);
331 if (mutex_lock_interruptible(&instance
->adsl_state_serialize
))
334 if (!strcmp(str_cmd
, "stop") || !strcmp(str_cmd
, "restart")) {
335 ret
= cxacru_cm(instance
, CM_REQUEST_CHIP_ADSL_LINE_STOP
, NULL
, 0, NULL
, 0);
337 atm_err(usbatm_instance
, "change adsl state:"
338 " CHIP_ADSL_LINE_STOP returned %d\n", ret
);
343 poll
= CXPOLL_STOPPED
;
347 /* Line status is only updated every second
348 * and the device appears to only react to
349 * START/STOP every second too. Wait 1.5s to
350 * be sure that restart will have an effect. */
351 if (!strcmp(str_cmd
, "restart"))
354 if (!strcmp(str_cmd
, "start") || !strcmp(str_cmd
, "restart")) {
355 ret
= cxacru_cm(instance
, CM_REQUEST_CHIP_ADSL_LINE_START
, NULL
, 0, NULL
, 0);
357 atm_err(usbatm_instance
, "change adsl state:"
358 " CHIP_ADSL_LINE_START returned %d\n", ret
);
363 poll
= CXPOLL_POLLING
;
367 if (!strcmp(str_cmd
, "poll")) {
369 poll
= CXPOLL_POLLING
;
377 if (poll
== CXPOLL_POLLING
) {
378 mutex_lock(&instance
->poll_state_serialize
);
379 switch (instance
->poll_state
) {
382 instance
->poll_state
= CXPOLL_POLLING
;
385 case CXPOLL_STOPPING
:
386 /* abort stop request */
387 instance
->poll_state
= CXPOLL_POLLING
;
389 case CXPOLL_SHUTDOWN
:
390 /* don't start polling */
393 mutex_unlock(&instance
->poll_state_serialize
);
394 } else if (poll
== CXPOLL_STOPPED
) {
395 mutex_lock(&instance
->poll_state_serialize
);
397 if (instance
->poll_state
== CXPOLL_POLLING
)
398 instance
->poll_state
= CXPOLL_STOPPING
;
399 mutex_unlock(&instance
->poll_state_serialize
);
402 mutex_unlock(&instance
->adsl_state_serialize
);
404 if (poll
== CXPOLL_POLLING
)
405 cxacru_poll_status(&instance
->poll_work
.work
);
411 * All device attributes are included in CXACRU_ALL_FILES
412 * so that the same list can be used multiple times:
413 * INIT (define the device attributes)
414 * CREATE (create all the device files)
415 * REMOVE (remove all the device files)
417 * With the last two being defined as needed in the functions
418 * they are used in before calling CXACRU_ALL_FILES()
420 #define CXACRU_ALL_FILES(_action) \
421 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
422 CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
423 CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
424 CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
425 CXACRU__ATTR_##_action( mac_address); \
426 CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
427 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
428 CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
429 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
430 CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
431 CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
432 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
433 CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
434 CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
435 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
436 CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
437 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
438 CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
439 CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
440 CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
441 CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
442 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
443 CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
444 CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
445 CXACRU_CMD_##_action( adsl_state);
447 CXACRU_ALL_FILES(INIT
);
449 /* the following three functions are stolen from drivers/usb/core/message.c */
450 static void cxacru_blocking_completion(struct urb
*urb
)
452 complete(urb
->context
);
455 static void cxacru_timeout_kill(unsigned long data
)
457 usb_unlink_urb((struct urb
*) data
);
460 static int cxacru_start_wait_urb(struct urb
*urb
, struct completion
*done
,
463 struct timer_list timer
;
466 timer
.expires
= jiffies
+ msecs_to_jiffies(CMD_TIMEOUT
);
467 timer
.data
= (unsigned long) urb
;
468 timer
.function
= cxacru_timeout_kill
;
470 wait_for_completion(done
);
471 del_timer_sync(&timer
);
474 *actual_length
= urb
->actual_length
;
475 return urb
->status
; /* must read status after completion */
478 static int cxacru_cm(struct cxacru_data
*instance
, enum cxacru_cm_request cm
,
479 u8
*wdata
, int wsize
, u8
*rdata
, int rsize
)
483 const int stride
= CMD_PACKET_SIZE
- 4;
484 u8
*wbuf
= instance
->snd_buf
;
485 u8
*rbuf
= instance
->rcv_buf
;
486 int wbuflen
= ((wsize
- 1) / stride
+ 1) * CMD_PACKET_SIZE
;
487 int rbuflen
= ((rsize
- 1) / stride
+ 1) * CMD_PACKET_SIZE
;
489 if (wbuflen
> PAGE_SIZE
|| rbuflen
> PAGE_SIZE
) {
490 if (printk_ratelimit())
491 usb_err(instance
->usbatm
, "requested transfer size too large (%d, %d)\n",
497 mutex_lock(&instance
->cm_serialize
);
499 /* submit reading urb before the writing one */
500 init_completion(&instance
->rcv_done
);
501 ret
= usb_submit_urb(instance
->rcv_urb
, GFP_KERNEL
);
503 if (printk_ratelimit())
504 usb_err(instance
->usbatm
, "submit of read urb for cm %#x failed (%d)\n",
509 memset(wbuf
, 0, wbuflen
);
510 /* handle wsize == 0 */
512 for (offb
= offd
= 0; offd
< wsize
; offd
+= stride
, offb
+= CMD_PACKET_SIZE
) {
514 memcpy(wbuf
+ offb
+ 4, wdata
+ offd
, min_t(int, stride
, wsize
- offd
));
517 instance
->snd_urb
->transfer_buffer_length
= wbuflen
;
518 init_completion(&instance
->snd_done
);
519 ret
= usb_submit_urb(instance
->snd_urb
, GFP_KERNEL
);
521 if (printk_ratelimit())
522 usb_err(instance
->usbatm
, "submit of write urb for cm %#x failed (%d)\n",
527 ret
= cxacru_start_wait_urb(instance
->snd_urb
, &instance
->snd_done
, NULL
);
529 if (printk_ratelimit())
530 usb_err(instance
->usbatm
, "send of cm %#x failed (%d)\n", cm
, ret
);
534 ret
= cxacru_start_wait_urb(instance
->rcv_urb
, &instance
->rcv_done
, &actlen
);
536 if (printk_ratelimit())
537 usb_err(instance
->usbatm
, "receive of cm %#x failed (%d)\n", cm
, ret
);
540 if (actlen
% CMD_PACKET_SIZE
|| !actlen
) {
541 if (printk_ratelimit())
542 usb_err(instance
->usbatm
, "invalid response length to cm %#x: %d\n",
548 /* check the return status and copy the data to the output buffer, if needed */
549 for (offb
= offd
= 0; offd
< rsize
&& offb
< actlen
; offb
+= CMD_PACKET_SIZE
) {
550 if (rbuf
[offb
] != cm
) {
551 if (printk_ratelimit())
552 usb_err(instance
->usbatm
, "wrong cm %#x in response to cm %#x\n",
557 if (rbuf
[offb
+ 1] != CM_STATUS_SUCCESS
) {
558 if (printk_ratelimit())
559 usb_err(instance
->usbatm
, "response to cm %#x failed: %#x\n",
566 memcpy(rdata
+ offd
, rbuf
+ offb
+ 4, min_t(int, stride
, rsize
- offd
));
573 mutex_unlock(&instance
->cm_serialize
);
578 static int cxacru_cm_get_array(struct cxacru_data
*instance
, enum cxacru_cm_request cm
,
584 const int stride
= CMD_PACKET_SIZE
/ (4 * 2) - 1;
585 int buflen
= ((size
- 1) / stride
+ 1 + size
* 2) * 4;
587 buf
= kmalloc(buflen
, GFP_KERNEL
);
591 ret
= cxacru_cm(instance
, cm
, NULL
, 0, (u8
*) buf
, buflen
);
595 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
597 for (offb
= 0; offb
< len
; ) {
598 int l
= le32_to_cpu(buf
[offb
++]);
599 if (l
> stride
|| l
> (len
- offb
) / 2) {
600 if (printk_ratelimit())
601 usb_err(instance
->usbatm
, "invalid data length from cm %#x: %d\n",
607 offd
= le32_to_cpu(buf
[offb
++]);
609 if (printk_ratelimit())
610 usb_err(instance
->usbatm
, "wrong index %#x in response to cm %#x\n",
615 data
[offd
] = le32_to_cpu(buf
[offb
++]);
626 static int cxacru_card_status(struct cxacru_data
*instance
)
628 int ret
= cxacru_cm(instance
, CM_REQUEST_CARD_GET_STATUS
, NULL
, 0, NULL
, 0);
629 if (ret
< 0) { /* firmware not loaded */
630 dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret
);
636 static void cxacru_remove_device_files(struct usbatm_data
*usbatm_instance
,
637 struct atm_dev
*atm_dev
)
639 struct usb_interface
*intf
= usbatm_instance
->usb_intf
;
641 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
642 device_remove_file(&intf->dev, &dev_attr_##_name);
643 CXACRU_ALL_FILES(REMOVE
);
644 #undef CXACRU_DEVICE_REMOVE_FILE
647 static int cxacru_atm_start(struct usbatm_data
*usbatm_instance
,
648 struct atm_dev
*atm_dev
)
650 struct cxacru_data
*instance
= usbatm_instance
->driver_data
;
651 struct usb_interface
*intf
= usbatm_instance
->usb_intf
;
653 struct atm_dev *atm_dev = usbatm_instance->atm_dev;
656 int start_polling
= 1;
658 dbg("cxacru_atm_start");
660 /* Read MAC address */
661 ret
= cxacru_cm(instance
, CM_REQUEST_CARD_GET_MAC_ADDRESS
, NULL
, 0,
662 atm_dev
->esi
, sizeof(atm_dev
->esi
));
664 atm_err(usbatm_instance
, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret
);
668 #define CXACRU_DEVICE_CREATE_FILE(_name) \
669 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
672 CXACRU_ALL_FILES(CREATE
);
673 #undef CXACRU_DEVICE_CREATE_FILE
676 mutex_lock(&instance
->adsl_state_serialize
);
677 ret
= cxacru_cm(instance
, CM_REQUEST_CHIP_ADSL_LINE_START
, NULL
, 0, NULL
, 0);
679 atm_err(usbatm_instance
, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret
);
681 /* Start status polling */
682 mutex_lock(&instance
->poll_state_serialize
);
683 switch (instance
->poll_state
) {
686 instance
->poll_state
= CXPOLL_POLLING
;
689 case CXPOLL_STOPPING
:
690 /* abort stop request */
691 instance
->poll_state
= CXPOLL_POLLING
;
693 case CXPOLL_SHUTDOWN
:
694 /* don't start polling */
697 mutex_unlock(&instance
->poll_state_serialize
);
698 mutex_unlock(&instance
->adsl_state_serialize
);
701 cxacru_poll_status(&instance
->poll_work
.work
);
705 usb_err(usbatm_instance
, "cxacru_atm_start: device_create_file failed (%d)\n", ret
);
706 cxacru_remove_device_files(usbatm_instance
, atm_dev
);
710 static void cxacru_poll_status(struct work_struct
*work
)
712 struct cxacru_data
*instance
=
713 container_of(work
, struct cxacru_data
, poll_work
.work
);
714 u32 buf
[CXINF_MAX
] = {};
715 struct usbatm_data
*usbatm
= instance
->usbatm
;
716 struct atm_dev
*atm_dev
= usbatm
->atm_dev
;
717 int keep_polling
= 1;
720 ret
= cxacru_cm_get_array(instance
, CM_REQUEST_CARD_INFO_GET
, buf
, CXINF_MAX
);
722 if (ret
!= -ESHUTDOWN
)
723 atm_warn(usbatm
, "poll status: error %d\n", ret
);
725 mutex_lock(&instance
->poll_state_serialize
);
726 if (instance
->poll_state
!= CXPOLL_SHUTDOWN
) {
727 instance
->poll_state
= CXPOLL_STOPPED
;
729 if (ret
!= -ESHUTDOWN
)
730 atm_warn(usbatm
, "polling disabled, set adsl_state"
731 " to 'start' or 'poll' to resume\n");
733 mutex_unlock(&instance
->poll_state_serialize
);
737 memcpy(instance
->card_info
, buf
, sizeof(instance
->card_info
));
739 if (instance
->adsl_status
!= buf
[CXINF_LINE_STARTABLE
]) {
740 instance
->adsl_status
= buf
[CXINF_LINE_STARTABLE
];
742 switch (instance
->adsl_status
) {
744 atm_printk(KERN_INFO
, usbatm
, "ADSL state: running\n");
748 atm_printk(KERN_INFO
, usbatm
, "ADSL state: stopped\n");
752 atm_printk(KERN_INFO
, usbatm
, "Unknown adsl status %02x\n", instance
->adsl_status
);
757 if (instance
->line_status
== buf
[CXINF_LINE_STATUS
])
760 instance
->line_status
= buf
[CXINF_LINE_STATUS
];
761 switch (instance
->line_status
) {
763 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
764 atm_info(usbatm
, "ADSL line: down\n");
768 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
769 atm_info(usbatm
, "ADSL line: attempting to activate\n");
773 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
774 atm_info(usbatm
, "ADSL line: training\n");
778 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
779 atm_info(usbatm
, "ADSL line: channel analysis\n");
783 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
784 atm_info(usbatm
, "ADSL line: exchange\n");
788 atm_dev
->link_rate
= buf
[CXINF_DOWNSTREAM_RATE
] * 1000 / 424;
789 atm_dev
->signal
= ATM_PHY_SIG_FOUND
;
791 atm_info(usbatm
, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
792 buf
[CXINF_DOWNSTREAM_RATE
], buf
[CXINF_UPSTREAM_RATE
]);
796 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
797 atm_info(usbatm
, "ADSL line: waiting\n");
801 atm_dev
->signal
= ATM_PHY_SIG_LOST
;
802 atm_info(usbatm
, "ADSL line: initializing\n");
806 atm_dev
->signal
= ATM_PHY_SIG_UNKNOWN
;
807 atm_info(usbatm
, "Unknown line state %02x\n", instance
->line_status
);
812 mutex_lock(&instance
->poll_state_serialize
);
813 if (instance
->poll_state
== CXPOLL_STOPPING
&&
814 instance
->adsl_status
== 1 && /* stopped */
815 instance
->line_status
== 0) /* down */
816 instance
->poll_state
= CXPOLL_STOPPED
;
818 if (instance
->poll_state
== CXPOLL_STOPPED
)
820 mutex_unlock(&instance
->poll_state_serialize
);
823 schedule_delayed_work(&instance
->poll_work
,
824 round_jiffies_relative(POLL_INTERVAL
*HZ
));
827 static int cxacru_fw(struct usb_device
*usb_dev
, enum cxacru_fw_request fw
,
828 u8 code1
, u8 code2
, u32 addr
, const u8
*data
, int size
)
833 const int stride
= CMD_PACKET_SIZE
- 8;
835 buf
= (u8
*) __get_free_page(GFP_KERNEL
);
841 int l
= min_t(int, stride
, size
- offd
);
846 put_unaligned(cpu_to_le32(addr
), (__le32
*)(buf
+ offb
));
850 memcpy(buf
+ offb
, data
+ offd
, l
);
852 memset(buf
+ offb
+ l
, 0, stride
- l
);
855 if ((offb
>= PAGE_SIZE
) || (offd
>= size
)) {
856 ret
= usb_bulk_msg(usb_dev
, usb_sndbulkpipe(usb_dev
, CXACRU_EP_CMD
),
857 buf
, offb
, NULL
, CMD_TIMEOUT
);
859 dbg("sending fw %#x failed", fw
);
864 } while(offd
< size
);
865 dbg("sent fw %#x", fw
);
870 free_page((unsigned long) buf
);
874 static void cxacru_upload_firmware(struct cxacru_data
*instance
,
875 const struct firmware
*fw
,
876 const struct firmware
*bp
,
877 const struct firmware
*cf
)
881 struct usbatm_data
*usbatm
= instance
->usbatm
;
882 struct usb_device
*usb_dev
= usbatm
->usb_dev
;
883 __le16 signature
[] = { usb_dev
->descriptor
.idVendor
,
884 usb_dev
->descriptor
.idProduct
};
887 dbg("cxacru_upload_firmware");
889 /* FirmwarePllFClkValue */
890 val
= cpu_to_le32(instance
->modem_type
->pll_f_clk
);
891 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, PLLFCLK_ADDR
, (u8
*) &val
, 4);
893 usb_err(usbatm
, "FirmwarePllFClkValue failed: %d\n", ret
);
897 /* FirmwarePllBClkValue */
898 val
= cpu_to_le32(instance
->modem_type
->pll_b_clk
);
899 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, PLLBCLK_ADDR
, (u8
*) &val
, 4);
901 usb_err(usbatm
, "FirmwarePllBClkValue failed: %d\n", ret
);
906 val
= cpu_to_le32(SDRAM_ENA
);
907 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, SDRAMEN_ADDR
, (u8
*) &val
, 4);
909 usb_err(usbatm
, "Enable SDRAM failed: %d\n", ret
);
914 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, FW_ADDR
, fw
->data
, fw
->size
);
916 usb_err(usbatm
, "Firmware upload failed: %d\n", ret
);
921 if (instance
->modem_type
->boot_rom_patch
) {
922 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, BR_ADDR
, bp
->data
, bp
->size
);
924 usb_err(usbatm
, "Boot ROM patching failed: %d\n", ret
);
930 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, SIG_ADDR
, (u8
*) signature
, 4);
932 usb_err(usbatm
, "Signature storing failed: %d\n", ret
);
936 if (instance
->modem_type
->boot_rom_patch
) {
937 val
= cpu_to_le32(BR_ADDR
);
938 ret
= cxacru_fw(usb_dev
, FW_WRITE_MEM
, 0x2, 0x0, BR_STACK_ADDR
, (u8
*) &val
, 4);
941 ret
= cxacru_fw(usb_dev
, FW_GOTO_MEM
, 0x0, 0x0, FW_ADDR
, NULL
, 0);
944 usb_err(usbatm
, "Passing control to firmware failed: %d\n", ret
);
948 /* Delay to allow firmware to start up. */
949 msleep_interruptible(1000);
951 usb_clear_halt(usb_dev
, usb_sndbulkpipe(usb_dev
, CXACRU_EP_CMD
));
952 usb_clear_halt(usb_dev
, usb_rcvbulkpipe(usb_dev
, CXACRU_EP_CMD
));
953 usb_clear_halt(usb_dev
, usb_sndbulkpipe(usb_dev
, CXACRU_EP_DATA
));
954 usb_clear_halt(usb_dev
, usb_rcvbulkpipe(usb_dev
, CXACRU_EP_DATA
));
956 ret
= cxacru_cm(instance
, CM_REQUEST_CARD_GET_STATUS
, NULL
, 0, NULL
, 0);
958 usb_err(usbatm
, "modem failed to initialize: %d\n", ret
);
962 /* Load config data (le32), doing one packet at a time */
964 for (off
= 0; off
< cf
->size
/ 4; ) {
965 __le32 buf
[CMD_PACKET_SIZE
/ 4 - 1];
966 int i
, len
= min_t(int, cf
->size
/ 4 - off
, CMD_PACKET_SIZE
/ 4 / 2 - 1);
967 buf
[0] = cpu_to_le32(len
);
968 for (i
= 0; i
< len
; i
++, off
++) {
969 buf
[i
* 2 + 1] = cpu_to_le32(off
);
970 memcpy(buf
+ i
* 2 + 2, cf
->data
+ off
* 4, 4);
972 ret
= cxacru_cm(instance
, CM_REQUEST_CARD_DATA_SET
,
973 (u8
*) buf
, len
, NULL
, 0);
975 usb_err(usbatm
, "load config data failed: %d\n", ret
);
980 msleep_interruptible(4000);
983 static int cxacru_find_firmware(struct cxacru_data
*instance
,
984 char* phase
, const struct firmware
**fw_p
)
986 struct usbatm_data
*usbatm
= instance
->usbatm
;
987 struct device
*dev
= &usbatm
->usb_intf
->dev
;
990 sprintf(buf
, "cxacru-%s.bin", phase
);
991 dbg("cxacru_find_firmware: looking for %s", buf
);
993 if (request_firmware(fw_p
, buf
, dev
)) {
994 usb_dbg(usbatm
, "no stage %s firmware found\n", phase
);
998 usb_info(usbatm
, "found firmware %s\n", buf
);
1003 static int cxacru_heavy_init(struct usbatm_data
*usbatm_instance
,
1004 struct usb_interface
*usb_intf
)
1006 const struct firmware
*fw
, *bp
, *cf
;
1007 struct cxacru_data
*instance
= usbatm_instance
->driver_data
;
1009 int ret
= cxacru_find_firmware(instance
, "fw", &fw
);
1011 usb_warn(usbatm_instance
, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1015 if (instance
->modem_type
->boot_rom_patch
) {
1016 ret
= cxacru_find_firmware(instance
, "bp", &bp
);
1018 usb_warn(usbatm_instance
, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1019 release_firmware(fw
);
1024 if (cxacru_find_firmware(instance
, "cf", &cf
)) /* optional */
1027 cxacru_upload_firmware(instance
, fw
, bp
, cf
);
1030 release_firmware(cf
);
1031 if (instance
->modem_type
->boot_rom_patch
)
1032 release_firmware(bp
);
1033 release_firmware(fw
);
1035 ret
= cxacru_card_status(instance
);
1037 dbg("modem initialisation failed");
1039 dbg("done setting up the modem");
1044 static int cxacru_bind(struct usbatm_data
*usbatm_instance
,
1045 struct usb_interface
*intf
, const struct usb_device_id
*id
)
1047 struct cxacru_data
*instance
;
1048 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
1052 instance
= kzalloc(sizeof(*instance
), GFP_KERNEL
);
1054 dbg("cxacru_bind: no memory for instance data");
1058 instance
->usbatm
= usbatm_instance
;
1059 instance
->modem_type
= (struct cxacru_modem_type
*) id
->driver_info
;
1061 mutex_init(&instance
->poll_state_serialize
);
1062 instance
->poll_state
= CXPOLL_STOPPED
;
1063 instance
->line_status
= -1;
1064 instance
->adsl_status
= -1;
1066 mutex_init(&instance
->adsl_state_serialize
);
1068 instance
->rcv_buf
= (u8
*) __get_free_page(GFP_KERNEL
);
1069 if (!instance
->rcv_buf
) {
1070 dbg("cxacru_bind: no memory for rcv_buf");
1074 instance
->snd_buf
= (u8
*) __get_free_page(GFP_KERNEL
);
1075 if (!instance
->snd_buf
) {
1076 dbg("cxacru_bind: no memory for snd_buf");
1080 instance
->rcv_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1081 if (!instance
->rcv_urb
) {
1082 dbg("cxacru_bind: no memory for rcv_urb");
1086 instance
->snd_urb
= usb_alloc_urb(0, GFP_KERNEL
);
1087 if (!instance
->snd_urb
) {
1088 dbg("cxacru_bind: no memory for snd_urb");
1093 usb_fill_int_urb(instance
->rcv_urb
,
1094 usb_dev
, usb_rcvintpipe(usb_dev
, CXACRU_EP_CMD
),
1095 instance
->rcv_buf
, PAGE_SIZE
,
1096 cxacru_blocking_completion
, &instance
->rcv_done
, 1);
1098 usb_fill_int_urb(instance
->snd_urb
,
1099 usb_dev
, usb_sndintpipe(usb_dev
, CXACRU_EP_CMD
),
1100 instance
->snd_buf
, PAGE_SIZE
,
1101 cxacru_blocking_completion
, &instance
->snd_done
, 4);
1103 mutex_init(&instance
->cm_serialize
);
1105 INIT_DELAYED_WORK(&instance
->poll_work
, cxacru_poll_status
);
1107 usbatm_instance
->driver_data
= instance
;
1109 usbatm_instance
->flags
= (cxacru_card_status(instance
) ? 0 : UDSL_SKIP_HEAVY_INIT
);
1114 free_page((unsigned long) instance
->snd_buf
);
1115 free_page((unsigned long) instance
->rcv_buf
);
1116 usb_free_urb(instance
->snd_urb
);
1117 usb_free_urb(instance
->rcv_urb
);
1123 static void cxacru_unbind(struct usbatm_data
*usbatm_instance
,
1124 struct usb_interface
*intf
)
1126 struct cxacru_data
*instance
= usbatm_instance
->driver_data
;
1129 dbg("cxacru_unbind entered");
1132 dbg("cxacru_unbind: NULL instance!");
1136 mutex_lock(&instance
->poll_state_serialize
);
1137 BUG_ON(instance
->poll_state
== CXPOLL_SHUTDOWN
);
1139 /* ensure that status polling continues unless
1140 * it has already stopped */
1141 if (instance
->poll_state
== CXPOLL_STOPPED
)
1144 /* stop polling from being stopped or started */
1145 instance
->poll_state
= CXPOLL_SHUTDOWN
;
1146 mutex_unlock(&instance
->poll_state_serialize
);
1149 cancel_rearming_delayed_work(&instance
->poll_work
);
1151 usb_kill_urb(instance
->snd_urb
);
1152 usb_kill_urb(instance
->rcv_urb
);
1153 usb_free_urb(instance
->snd_urb
);
1154 usb_free_urb(instance
->rcv_urb
);
1156 free_page((unsigned long) instance
->snd_buf
);
1157 free_page((unsigned long) instance
->rcv_buf
);
1161 usbatm_instance
->driver_data
= NULL
;
1164 static const struct cxacru_modem_type cxacru_cafe
= {
1165 .pll_f_clk
= 0x02d874df,
1166 .pll_b_clk
= 0x0196a51a,
1167 .boot_rom_patch
= 1,
1170 static const struct cxacru_modem_type cxacru_cb00
= {
1173 .boot_rom_patch
= 0,
1176 static const struct usb_device_id cxacru_usb_ids
[] = {
1177 { /* V = Conexant P = ADSL modem (Euphrates project) */
1178 USB_DEVICE(0x0572, 0xcafe), .driver_info
= (unsigned long) &cxacru_cafe
1180 { /* V = Conexant P = ADSL modem (Hasbani project) */
1181 USB_DEVICE(0x0572, 0xcb00), .driver_info
= (unsigned long) &cxacru_cb00
1183 { /* V = Conexant P = ADSL modem */
1184 USB_DEVICE(0x0572, 0xcb01), .driver_info
= (unsigned long) &cxacru_cb00
1186 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1187 USB_DEVICE(0x0572, 0xcb02), .driver_info
= (unsigned long) &cxacru_cb00
1189 { /* V = Conexant P = ADSL modem */
1190 USB_DEVICE(0x0572, 0xcb06), .driver_info
= (unsigned long) &cxacru_cb00
1192 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1193 USB_DEVICE(0x0572, 0xcb07), .driver_info
= (unsigned long) &cxacru_cb00
1195 { /* V = Olitec P = ADSL modem version 2 */
1196 USB_DEVICE(0x08e3, 0x0100), .driver_info
= (unsigned long) &cxacru_cafe
1198 { /* V = Olitec P = ADSL modem version 3 */
1199 USB_DEVICE(0x08e3, 0x0102), .driver_info
= (unsigned long) &cxacru_cb00
1201 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1202 USB_DEVICE(0x0eb0, 0x3457), .driver_info
= (unsigned long) &cxacru_cafe
1204 { /* V = Zoom P = 5510 */
1205 USB_DEVICE(0x1803, 0x5510), .driver_info
= (unsigned long) &cxacru_cb00
1207 { /* V = Draytek P = Vigor 318 */
1208 USB_DEVICE(0x0675, 0x0200), .driver_info
= (unsigned long) &cxacru_cb00
1210 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1211 USB_DEVICE(0x0586, 0x330a), .driver_info
= (unsigned long) &cxacru_cb00
1213 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1214 USB_DEVICE(0x0586, 0x330b), .driver_info
= (unsigned long) &cxacru_cb00
1216 { /* V = Aethra P = Starmodem UM1020 */
1217 USB_DEVICE(0x0659, 0x0020), .driver_info
= (unsigned long) &cxacru_cb00
1219 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1220 USB_DEVICE(0x0509, 0x0812), .driver_info
= (unsigned long) &cxacru_cb00
1222 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1223 USB_DEVICE(0x100d, 0xcb01), .driver_info
= (unsigned long) &cxacru_cb00
1225 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1226 USB_DEVICE(0x100d, 0x3342), .driver_info
= (unsigned long) &cxacru_cb00
1231 MODULE_DEVICE_TABLE(usb
, cxacru_usb_ids
);
1233 static struct usbatm_driver cxacru_driver
= {
1234 .driver_name
= cxacru_driver_name
,
1235 .bind
= cxacru_bind
,
1236 .heavy_init
= cxacru_heavy_init
,
1237 .unbind
= cxacru_unbind
,
1238 .atm_start
= cxacru_atm_start
,
1239 .atm_stop
= cxacru_remove_device_files
,
1240 .bulk_in
= CXACRU_EP_DATA
,
1241 .bulk_out
= CXACRU_EP_DATA
,
1246 static int cxacru_usb_probe(struct usb_interface
*intf
, const struct usb_device_id
*id
)
1248 return usbatm_usb_probe(intf
, id
, &cxacru_driver
);
1251 static struct usb_driver cxacru_usb_driver
= {
1252 .name
= cxacru_driver_name
,
1253 .probe
= cxacru_usb_probe
,
1254 .disconnect
= usbatm_usb_disconnect
,
1255 .id_table
= cxacru_usb_ids
1258 static int __init
cxacru_init(void)
1260 return usb_register(&cxacru_usb_driver
);
1263 static void __exit
cxacru_cleanup(void)
1265 usb_deregister(&cxacru_usb_driver
);
1268 module_init(cxacru_init
);
1269 module_exit(cxacru_cleanup
);
1271 MODULE_AUTHOR(DRIVER_AUTHOR
);
1272 MODULE_DESCRIPTION(DRIVER_DESC
);
1273 MODULE_LICENSE("GPL");
1274 MODULE_VERSION(DRIVER_VERSION
);