1/******************************************************************************
2 *  cxacru.c  -  driver for USB ADSL modems based on
3 *               Conexant AccessRunner chipset
4 *
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
9 *
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)
13 *  any later version.
14 *
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
18 *  more details.
19 *
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.
23 *
24 ******************************************************************************/
25
26/*
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.
30 */
31
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/init.h>
39#include <linux/device.h>
40#include <linux/firmware.h>
41#include <linux/mutex.h>
42#include <asm/unaligned.h>
43
44#include "usbatm.h"
45
46#define DRIVER_AUTHOR	"Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
47#define DRIVER_VERSION	"0.4"
48#define DRIVER_DESC	"Conexant AccessRunner ADSL USB modem driver"
49
50static const char cxacru_driver_name[] = "cxacru";
51
52#define CXACRU_EP_CMD		0x01	/* Bulk/interrupt in/out */
53#define CXACRU_EP_DATA		0x02	/* Bulk in/out */
54
55#define CMD_PACKET_SIZE		64	/* Should be maxpacket(ep)? */
56#define CMD_MAX_CONFIG		((CMD_PACKET_SIZE / 4 - 1) / 2)
57
58/* Addresses */
59#define PLLFCLK_ADDR	0x00350068
60#define PLLBCLK_ADDR	0x0035006c
61#define SDRAMEN_ADDR	0x00350010
62#define FW_ADDR		0x00801000
63#define BR_ADDR		0x00180600
64#define SIG_ADDR	0x00180500
65#define BR_STACK_ADDR	0x00187f10
66
67/* Values */
68#define SDRAM_ENA	0x1
69
70#define CMD_TIMEOUT	2000	/* msecs */
71#define POLL_INTERVAL	1	/* secs */
72
73/* commands for interaction with the modem through the control channel before
74 * firmware is loaded  */
75enum cxacru_fw_request {
76	FW_CMD_ERR,
77	FW_GET_VER,
78	FW_READ_MEM,
79	FW_WRITE_MEM,
80	FW_RMW_MEM,
81	FW_CHECKSUM_MEM,
82	FW_GOTO_MEM,
83};
84
85/* commands for interaction with the modem through the control channel once
86 * firmware is loaded  */
87enum cxacru_cm_request {
88	CM_REQUEST_UNDEFINED = 0x80,
89	CM_REQUEST_TEST,
90	CM_REQUEST_CHIP_GET_MAC_ADDRESS,
91	CM_REQUEST_CHIP_GET_DP_VERSIONS,
92	CM_REQUEST_CHIP_ADSL_LINE_START,
93	CM_REQUEST_CHIP_ADSL_LINE_STOP,
94	CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
95	CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
96	CM_REQUEST_CARD_INFO_GET,
97	CM_REQUEST_CARD_DATA_GET,
98	CM_REQUEST_CARD_DATA_SET,
99	CM_REQUEST_COMMAND_HW_IO,
100	CM_REQUEST_INTERFACE_HW_IO,
101	CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
102	CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
103	CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
104	CM_REQUEST_CARD_GET_STATUS,
105	CM_REQUEST_CARD_GET_MAC_ADDRESS,
106	CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
107	CM_REQUEST_MAX,
108};
109
110/* commands for interaction with the flash memory
111 *
112 * read:  response is the contents of the first 60 bytes of flash memory
113 * write: request contains the 60 bytes of data to write to flash memory
114 *        response is the contents of the first 60 bytes of flash memory
115 *
116 * layout: PP PP VV VV  MM MM MM MM  MM MM ?? ??  SS SS SS SS  SS SS SS SS
117 *         SS SS SS SS  SS SS SS SS  00 00 00 00  00 00 00 00  00 00 00 00
118 *         00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00  00 00 00 00
119 *
120 *   P: le16  USB Product ID
121 *   V: le16  USB Vendor ID
122 *   M: be48  MAC Address
123 *   S: le16  ASCII Serial Number
124 */
125enum cxacru_cm_flash {
126	CM_FLASH_READ = 0xa1,
127	CM_FLASH_WRITE = 0xa2
128};
129
130/* reply codes to the commands above */
131enum cxacru_cm_status {
132	CM_STATUS_UNDEFINED,
133	CM_STATUS_SUCCESS,
134	CM_STATUS_ERROR,
135	CM_STATUS_UNSUPPORTED,
136	CM_STATUS_UNIMPLEMENTED,
137	CM_STATUS_PARAMETER_ERROR,
138	CM_STATUS_DBG_LOOPBACK,
139	CM_STATUS_MAX,
140};
141
142/* indices into CARD_INFO_GET return array */
143enum cxacru_info_idx {
144	CXINF_DOWNSTREAM_RATE,
145	CXINF_UPSTREAM_RATE,
146	CXINF_LINK_STATUS,
147	CXINF_LINE_STATUS,
148	CXINF_MAC_ADDRESS_HIGH,
149	CXINF_MAC_ADDRESS_LOW,
150	CXINF_UPSTREAM_SNR_MARGIN,
151	CXINF_DOWNSTREAM_SNR_MARGIN,
152	CXINF_UPSTREAM_ATTENUATION,
153	CXINF_DOWNSTREAM_ATTENUATION,
154	CXINF_TRANSMITTER_POWER,
155	CXINF_UPSTREAM_BITS_PER_FRAME,
156	CXINF_DOWNSTREAM_BITS_PER_FRAME,
157	CXINF_STARTUP_ATTEMPTS,
158	CXINF_UPSTREAM_CRC_ERRORS,
159	CXINF_DOWNSTREAM_CRC_ERRORS,
160	CXINF_UPSTREAM_FEC_ERRORS,
161	CXINF_DOWNSTREAM_FEC_ERRORS,
162	CXINF_UPSTREAM_HEC_ERRORS,
163	CXINF_DOWNSTREAM_HEC_ERRORS,
164	CXINF_LINE_STARTABLE,
165	CXINF_MODULATION,
166	CXINF_ADSL_HEADEND,
167	CXINF_ADSL_HEADEND_ENVIRONMENT,
168	CXINF_CONTROLLER_VERSION,
169	/* dunno what the missing two mean */
170	CXINF_MAX = 0x1c,
171};
172
173enum cxacru_poll_state {
174	CXPOLL_STOPPING,
175	CXPOLL_STOPPED,
176	CXPOLL_POLLING,
177	CXPOLL_SHUTDOWN
178};
179
180struct cxacru_modem_type {
181	u32 pll_f_clk;
182	u32 pll_b_clk;
183	int boot_rom_patch;
184};
185
186struct cxacru_data {
187	struct usbatm_data *usbatm;
188
189	const struct cxacru_modem_type *modem_type;
190
191	int line_status;
192	struct mutex adsl_state_serialize;
193	int adsl_status;
194	struct delayed_work poll_work;
195	u32 card_info[CXINF_MAX];
196	struct mutex poll_state_serialize;
197	enum cxacru_poll_state poll_state;
198
199	/* contol handles */
200	struct mutex cm_serialize;
201	u8 *rcv_buf;
202	u8 *snd_buf;
203	struct urb *rcv_urb;
204	struct urb *snd_urb;
205	struct completion rcv_done;
206	struct completion snd_done;
207};
208
209static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
210	u8 *wdata, int wsize, u8 *rdata, int rsize);
211static void cxacru_poll_status(struct work_struct *work);
212
213/* Card info exported through sysfs */
214#define CXACRU__ATTR_INIT(_name) \
215static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
216
217#define CXACRU_CMD_INIT(_name) \
218static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
219	cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
220
221#define CXACRU_SET_INIT(_name) \
222static DEVICE_ATTR(_name, S_IWUSR, \
223	NULL, cxacru_sysfs_store_##_name)
224
225#define CXACRU_ATTR_INIT(_value, _type, _name) \
226static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
227	struct device_attribute *attr, char *buf) \
228{ \
229	struct cxacru_data *instance = to_usbatm_driver_data(\
230		to_usb_interface(dev)); \
231\
232	if (instance == NULL) \
233		return -ENODEV; \
234\
235	return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
236} \
237CXACRU__ATTR_INIT(_name)
238
239#define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
240#define CXACRU_CMD_CREATE(_name)          CXACRU_DEVICE_CREATE_FILE(_name)
241#define CXACRU_SET_CREATE(_name)          CXACRU_DEVICE_CREATE_FILE(_name)
242#define CXACRU__ATTR_CREATE(_name)        CXACRU_DEVICE_CREATE_FILE(_name)
243
244#define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
245#define CXACRU_CMD_REMOVE(_name)          CXACRU_DEVICE_REMOVE_FILE(_name)
246#define CXACRU_SET_REMOVE(_name)          CXACRU_DEVICE_REMOVE_FILE(_name)
247#define CXACRU__ATTR_REMOVE(_name)        CXACRU_DEVICE_REMOVE_FILE(_name)
248
249static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
250{
251	return snprintf(buf, PAGE_SIZE, "%u\n", value);
252}
253
254static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
255{
256	return snprintf(buf, PAGE_SIZE, "%d\n", value);
257}
258
259static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
260{
261	if (likely(value >= 0)) {
262		return snprintf(buf, PAGE_SIZE, "%u.%02u\n",
263					value / 100, value % 100);
264	} else {
265		value = -value;
266		return snprintf(buf, PAGE_SIZE, "-%u.%02u\n",
267					value / 100, value % 100);
268	}
269}
270
271static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
272{
273	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]);
277}
278
279static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
280{
281	static char *str[] = { NULL, "not connected", "connected", "lost" };
282	if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
283		return snprintf(buf, PAGE_SIZE, "%u\n", value);
284	return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
285}
286
287static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
288{
289	static char *str[] = { "down", "attempting to activate",
290		"training", "channel analysis", "exchange", "up",
291		"waiting", "initialising"
292	};
293	if (unlikely(value >= ARRAY_SIZE(str)))
294		return snprintf(buf, PAGE_SIZE, "%u\n", value);
295	return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
296}
297
298static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
299{
300	static char *str[] = {
301			"",
302			"ANSI T1.413",
303			"ITU-T G.992.1 (G.DMT)",
304			"ITU-T G.992.2 (G.LITE)"
305	};
306	if (unlikely(value >= ARRAY_SIZE(str)))
307		return snprintf(buf, PAGE_SIZE, "%u\n", value);
308	return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
309}
310
311/*
312 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
313 * this data is already in atm_dev there's no point.
314 *
315 * MAC_ADDRESS_HIGH = 0x????5544
316 * MAC_ADDRESS_LOW  = 0x33221100
317 * Where 00-55 are bytes 0-5 of the MAC.
318 */
319static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
320	struct device_attribute *attr, char *buf)
321{
322	struct cxacru_data *instance = to_usbatm_driver_data(
323			to_usb_interface(dev));
324
325	if (instance == NULL || instance->usbatm->atm_dev == NULL)
326		return -ENODEV;
327
328	return snprintf(buf, PAGE_SIZE, "%pM\n",
329		instance->usbatm->atm_dev->esi);
330}
331
332static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
333	struct device_attribute *attr, char *buf)
334{
335	static char *str[] = { "running", "stopped" };
336	struct cxacru_data *instance = to_usbatm_driver_data(
337			to_usb_interface(dev));
338	u32 value;
339
340	if (instance == NULL)
341		return -ENODEV;
342
343	value = instance->card_info[CXINF_LINE_STARTABLE];
344	if (unlikely(value >= ARRAY_SIZE(str)))
345		return snprintf(buf, PAGE_SIZE, "%u\n", value);
346	return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
347}
348
349static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
350	struct device_attribute *attr, const char *buf, size_t count)
351{
352	struct cxacru_data *instance = to_usbatm_driver_data(
353			to_usb_interface(dev));
354	int ret;
355	int poll = -1;
356	char str_cmd[8];
357	int len = strlen(buf);
358
359	if (!capable(CAP_NET_ADMIN))
360		return -EACCES;
361
362	ret = sscanf(buf, "%7s", str_cmd);
363	if (ret != 1)
364		return -EINVAL;
365	ret = 0;
366
367	if (instance == NULL)
368		return -ENODEV;
369
370	if (mutex_lock_interruptible(&instance->adsl_state_serialize))
371		return -ERESTARTSYS;
372
373	if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
374		ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
375		if (ret < 0) {
376			atm_err(instance->usbatm, "change adsl state:"
377				" CHIP_ADSL_LINE_STOP returned %d\n", ret);
378
379			ret = -EIO;
380		} else {
381			ret = len;
382			poll = CXPOLL_STOPPED;
383		}
384	}
385
386	/* Line status is only updated every second
387	 * and the device appears to only react to
388	 * START/STOP every second too. Wait 1.5s to
389	 * be sure that restart will have an effect. */
390	if (!strcmp(str_cmd, "restart"))
391		msleep(1500);
392
393	if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
394		ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
395		if (ret < 0) {
396			atm_err(instance->usbatm, "change adsl state:"
397				" CHIP_ADSL_LINE_START returned %d\n", ret);
398
399			ret = -EIO;
400		} else {
401			ret = len;
402			poll = CXPOLL_POLLING;
403		}
404	}
405
406	if (!strcmp(str_cmd, "poll")) {
407		ret = len;
408		poll = CXPOLL_POLLING;
409	}
410
411	if (ret == 0) {
412		ret = -EINVAL;
413		poll = -1;
414	}
415
416	if (poll == CXPOLL_POLLING) {
417		mutex_lock(&instance->poll_state_serialize);
418		switch (instance->poll_state) {
419		case CXPOLL_STOPPED:
420			/* start polling */
421			instance->poll_state = CXPOLL_POLLING;
422			break;
423
424		case CXPOLL_STOPPING:
425			/* abort stop request */
426			instance->poll_state = CXPOLL_POLLING;
427		case CXPOLL_POLLING:
428		case CXPOLL_SHUTDOWN:
429			/* don't start polling */
430			poll = -1;
431		}
432		mutex_unlock(&instance->poll_state_serialize);
433	} else if (poll == CXPOLL_STOPPED) {
434		mutex_lock(&instance->poll_state_serialize);
435		/* request stop */
436		if (instance->poll_state == CXPOLL_POLLING)
437			instance->poll_state = CXPOLL_STOPPING;
438		mutex_unlock(&instance->poll_state_serialize);
439	}
440
441	mutex_unlock(&instance->adsl_state_serialize);
442
443	if (poll == CXPOLL_POLLING)
444		cxacru_poll_status(&instance->poll_work.work);
445
446	return ret;
447}
448
449/* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
450
451static ssize_t cxacru_sysfs_store_adsl_config(struct device *dev,
452	struct device_attribute *attr, const char *buf, size_t count)
453{
454	struct cxacru_data *instance = to_usbatm_driver_data(
455			to_usb_interface(dev));
456	int len = strlen(buf);
457	int ret, pos, num;
458	__le32 data[CMD_PACKET_SIZE / 4];
459
460	if (!capable(CAP_NET_ADMIN))
461		return -EACCES;
462
463	if (instance == NULL)
464		return -ENODEV;
465
466	pos = 0;
467	num = 0;
468	while (pos < len) {
469		int tmp;
470		u32 index;
471		u32 value;
472
473		ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
474		if (ret < 2)
475			return -EINVAL;
476		if (index < 0 || index > 0x7f)
477			return -EINVAL;
478		pos += tmp;
479
480		/* skip trailing newline */
481		if (buf[pos] == '\n' && pos == len-1)
482			pos++;
483
484		data[num * 2 + 1] = cpu_to_le32(index);
485		data[num * 2 + 2] = cpu_to_le32(value);
486		num++;
487
488		/* send config values when data buffer is full
489		 * or no more data
490		 */
491		if (pos >= len || num >= CMD_MAX_CONFIG) {
492			char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
493
494			data[0] = cpu_to_le32(num);
495			ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
496				(u8 *) data, 4 + num * 8, NULL, 0);
497			if (ret < 0) {
498				atm_err(instance->usbatm,
499					"set card data returned %d\n", ret);
500				return -EIO;
501			}
502
503			for (tmp = 0; tmp < num; tmp++)
504				snprintf(log + tmp*12, 13, " %02x=%08x",
505					le32_to_cpu(data[tmp * 2 + 1]),
506					le32_to_cpu(data[tmp * 2 + 2]));
507			atm_info(instance->usbatm, "config%s\n", log);
508			num = 0;
509		}
510	}
511
512	return len;
513}
514
515/*
516 * All device attributes are included in CXACRU_ALL_FILES
517 * so that the same list can be used multiple times:
518 *     INIT   (define the device attributes)
519 *     CREATE (create all the device files)
520 *     REMOVE (remove all the device files)
521 *
522 * With the last two being defined as needed in the functions
523 * they are used in before calling CXACRU_ALL_FILES()
524 */
525#define CXACRU_ALL_FILES(_action) \
526CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE,           u32,  downstream_rate); \
527CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE,             u32,  upstream_rate); \
528CXACRU_ATTR_##_action(CXINF_LINK_STATUS,               LINK, link_status); \
529CXACRU_ATTR_##_action(CXINF_LINE_STATUS,               LINE, line_status); \
530CXACRU__ATTR_##_action(                                      mac_address); \
531CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN,       dB,   upstream_snr_margin); \
532CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN,     dB,   downstream_snr_margin); \
533CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION,      dB,   upstream_attenuation); \
534CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION,    dB,   downstream_attenuation); \
535CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER,         s8,   transmitter_power); \
536CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME,   u32,  upstream_bits_per_frame); \
537CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32,  downstream_bits_per_frame); \
538CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS,          u32,  startup_attempts); \
539CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS,       u32,  upstream_crc_errors); \
540CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS,     u32,  downstream_crc_errors); \
541CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS,       u32,  upstream_fec_errors); \
542CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS,     u32,  downstream_fec_errors); \
543CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS,       u32,  upstream_hec_errors); \
544CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS,     u32,  downstream_hec_errors); \
545CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE,            bool, line_startable); \
546CXACRU_ATTR_##_action(CXINF_MODULATION,                MODU, modulation); \
547CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND,              u32,  adsl_headend); \
548CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT,  u32,  adsl_headend_environment); \
549CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION,        u32,  adsl_controller_version); \
550CXACRU_CMD_##_action(                                        adsl_state); \
551CXACRU_SET_##_action(                                        adsl_config);
552
553CXACRU_ALL_FILES(INIT);
554
555/* the following three functions are stolen from drivers/usb/core/message.c */
556static void cxacru_blocking_completion(struct urb *urb)
557{
558	complete(urb->context);
559}
560
561static void cxacru_timeout_kill(unsigned long data)
562{
563	usb_unlink_urb((struct urb *) data);
564}
565
566static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
567				 int *actual_length)
568{
569	struct timer_list timer;
570
571	init_timer(&timer);
572	timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
573	timer.data = (unsigned long) urb;
574	timer.function = cxacru_timeout_kill;
575	add_timer(&timer);
576	wait_for_completion(done);
577	del_timer_sync(&timer);
578
579	if (actual_length)
580		*actual_length = urb->actual_length;
581	return urb->status; /* must read status after completion */
582}
583
584static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
585		     u8 *wdata, int wsize, u8 *rdata, int rsize)
586{
587	int ret, actlen;
588	int offb, offd;
589	const int stride = CMD_PACKET_SIZE - 4;
590	u8 *wbuf = instance->snd_buf;
591	u8 *rbuf = instance->rcv_buf;
592	int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
593	int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
594
595	if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
596		if (printk_ratelimit())
597			usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
598				wbuflen, rbuflen);
599		ret = -ENOMEM;
600		goto err;
601	}
602
603	mutex_lock(&instance->cm_serialize);
604
605	/* submit reading urb before the writing one */
606	init_completion(&instance->rcv_done);
607	ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
608	if (ret < 0) {
609		if (printk_ratelimit())
610			usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
611				cm, ret);
612		goto fail;
613	}
614
615	memset(wbuf, 0, wbuflen);
616	/* handle wsize == 0 */
617	wbuf[0] = cm;
618	for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
619		wbuf[offb] = cm;
620		memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
621	}
622
623	instance->snd_urb->transfer_buffer_length = wbuflen;
624	init_completion(&instance->snd_done);
625	ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
626	if (ret < 0) {
627		if (printk_ratelimit())
628			usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
629				cm, ret);
630		goto fail;
631	}
632
633	ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
634	if (ret < 0) {
635		if (printk_ratelimit())
636			usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
637		goto fail;
638	}
639
640	ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
641	if (ret < 0) {
642		if (printk_ratelimit())
643			usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
644		goto fail;
645	}
646	if (actlen % CMD_PACKET_SIZE || !actlen) {
647		if (printk_ratelimit())
648			usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
649				cm, actlen);
650		ret = -EIO;
651		goto fail;
652	}
653
654	/* check the return status and copy the data to the output buffer, if needed */
655	for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
656		if (rbuf[offb] != cm) {
657			if (printk_ratelimit())
658				usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
659					rbuf[offb], cm);
660			ret = -EIO;
661			goto fail;
662		}
663		if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
664			if (printk_ratelimit())
665				usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
666					cm, rbuf[offb + 1]);
667			ret = -EIO;
668			goto fail;
669		}
670		if (offd >= rsize)
671			break;
672		memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
673		offd += stride;
674	}
675
676	ret = offd;
677	dbg("cm %#x", cm);
678fail:
679	mutex_unlock(&instance->cm_serialize);
680err:
681	return ret;
682}
683
684static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
685			       u32 *data, int size)
686{
687	int ret, len;
688	__le32 *buf;
689	int offb, offd;
690	const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
691	int buflen =  ((size - 1) / stride + 1 + size * 2) * 4;
692
693	buf = kmalloc(buflen, GFP_KERNEL);
694	if (!buf)
695		return -ENOMEM;
696
697	ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
698	if (ret < 0)
699		goto cleanup;
700
701	/* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
702	len = ret / 4;
703	for (offb = 0; offb < len; ) {
704		int l = le32_to_cpu(buf[offb++]);
705		if (l < 0 || l > stride || l > (len - offb) / 2) {
706			if (printk_ratelimit())
707				usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
708					cm, l);
709			ret = -EIO;
710			goto cleanup;
711		}
712		while (l--) {
713			offd = le32_to_cpu(buf[offb++]);
714			if (offd >= size) {
715				if (printk_ratelimit())
716					usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
717						offd, cm);
718				ret = -EIO;
719				goto cleanup;
720			}
721			data[offd] = le32_to_cpu(buf[offb++]);
722		}
723	}
724
725	ret = 0;
726
727cleanup:
728	kfree(buf);
729	return ret;
730}
731
732static int cxacru_card_status(struct cxacru_data *instance)
733{
734	int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
735	if (ret < 0) {		/* firmware not loaded */
736		dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret);
737		return ret;
738	}
739	return 0;
740}
741
742static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
743		struct atm_dev *atm_dev)
744{
745	struct usb_interface *intf = usbatm_instance->usb_intf;
746
747	#define CXACRU_DEVICE_REMOVE_FILE(_name) \
748		device_remove_file(&intf->dev, &dev_attr_##_name);
749	CXACRU_ALL_FILES(REMOVE);
750	#undef CXACRU_DEVICE_REMOVE_FILE
751}
752
753static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
754		struct atm_dev *atm_dev)
755{
756	struct cxacru_data *instance = usbatm_instance->driver_data;
757	struct usb_interface *intf = usbatm_instance->usb_intf;
758	int ret;
759	int start_polling = 1;
760
761	dbg("cxacru_atm_start");
762
763	/* Read MAC address */
764	ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
765			atm_dev->esi, sizeof(atm_dev->esi));
766	if (ret < 0) {
767		atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
768		return ret;
769	}
770
771	#define CXACRU_DEVICE_CREATE_FILE(_name) \
772		ret = device_create_file(&intf->dev, &dev_attr_##_name); \
773		if (unlikely(ret)) \
774			goto fail_sysfs;
775	CXACRU_ALL_FILES(CREATE);
776	#undef CXACRU_DEVICE_CREATE_FILE
777
778	/* start ADSL */
779	mutex_lock(&instance->adsl_state_serialize);
780	ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
781	if (ret < 0)
782		atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
783
784	/* Start status polling */
785	mutex_lock(&instance->poll_state_serialize);
786	switch (instance->poll_state) {
787	case CXPOLL_STOPPED:
788		/* start polling */
789		instance->poll_state = CXPOLL_POLLING;
790		break;
791
792	case CXPOLL_STOPPING:
793		/* abort stop request */
794		instance->poll_state = CXPOLL_POLLING;
795	case CXPOLL_POLLING:
796	case CXPOLL_SHUTDOWN:
797		/* don't start polling */
798		start_polling = 0;
799	}
800	mutex_unlock(&instance->poll_state_serialize);
801	mutex_unlock(&instance->adsl_state_serialize);
802
803	printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
804			usbatm_instance->description, atm_dev->esi);
805
806	if (start_polling)
807		cxacru_poll_status(&instance->poll_work.work);
808	return 0;
809
810fail_sysfs:
811	usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
812	cxacru_remove_device_files(usbatm_instance, atm_dev);
813	return ret;
814}
815
816static void cxacru_poll_status(struct work_struct *work)
817{
818	struct cxacru_data *instance =
819		container_of(work, struct cxacru_data, poll_work.work);
820	u32 buf[CXINF_MAX] = {};
821	struct usbatm_data *usbatm = instance->usbatm;
822	struct atm_dev *atm_dev = usbatm->atm_dev;
823	int keep_polling = 1;
824	int ret;
825
826	ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
827	if (ret < 0) {
828		if (ret != -ESHUTDOWN)
829			atm_warn(usbatm, "poll status: error %d\n", ret);
830
831		mutex_lock(&instance->poll_state_serialize);
832		if (instance->poll_state != CXPOLL_SHUTDOWN) {
833			instance->poll_state = CXPOLL_STOPPED;
834
835			if (ret != -ESHUTDOWN)
836				atm_warn(usbatm, "polling disabled, set adsl_state"
837						" to 'start' or 'poll' to resume\n");
838		}
839		mutex_unlock(&instance->poll_state_serialize);
840		goto reschedule;
841	}
842
843	memcpy(instance->card_info, buf, sizeof(instance->card_info));
844
845	if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
846		instance->adsl_status = buf[CXINF_LINE_STARTABLE];
847
848		switch (instance->adsl_status) {
849		case 0:
850			atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
851			break;
852
853		case 1:
854			atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
855			break;
856
857		default:
858			atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
859			break;
860		}
861	}
862
863	if (instance->line_status == buf[CXINF_LINE_STATUS])
864		goto reschedule;
865
866	instance->line_status = buf[CXINF_LINE_STATUS];
867	switch (instance->line_status) {
868	case 0:
869		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
870		atm_info(usbatm, "ADSL line: down\n");
871		break;
872
873	case 1:
874		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
875		atm_info(usbatm, "ADSL line: attempting to activate\n");
876		break;
877
878	case 2:
879		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
880		atm_info(usbatm, "ADSL line: training\n");
881		break;
882
883	case 3:
884		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
885		atm_info(usbatm, "ADSL line: channel analysis\n");
886		break;
887
888	case 4:
889		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
890		atm_info(usbatm, "ADSL line: exchange\n");
891		break;
892
893	case 5:
894		atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
895		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_FOUND);
896
897		atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
898		     buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
899		break;
900
901	case 6:
902		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
903		atm_info(usbatm, "ADSL line: waiting\n");
904		break;
905
906	case 7:
907		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_LOST);
908		atm_info(usbatm, "ADSL line: initializing\n");
909		break;
910
911	default:
912		atm_dev_signal_change(atm_dev, ATM_PHY_SIG_UNKNOWN);
913		atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
914		break;
915	}
916reschedule:
917
918	mutex_lock(&instance->poll_state_serialize);
919	if (instance->poll_state == CXPOLL_STOPPING &&
920				instance->adsl_status == 1 && /* stopped */
921				instance->line_status == 0) /* down */
922		instance->poll_state = CXPOLL_STOPPED;
923
924	if (instance->poll_state == CXPOLL_STOPPED)
925		keep_polling = 0;
926	mutex_unlock(&instance->poll_state_serialize);
927
928	if (keep_polling)
929		schedule_delayed_work(&instance->poll_work,
930				round_jiffies_relative(POLL_INTERVAL*HZ));
931}
932
933static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
934		     u8 code1, u8 code2, u32 addr, const u8 *data, int size)
935{
936	int ret;
937	u8 *buf;
938	int offd, offb;
939	const int stride = CMD_PACKET_SIZE - 8;
940
941	buf = (u8 *) __get_free_page(GFP_KERNEL);
942	if (!buf)
943		return -ENOMEM;
944
945	offb = offd = 0;
946	do {
947		int l = min_t(int, stride, size - offd);
948		buf[offb++] = fw;
949		buf[offb++] = l;
950		buf[offb++] = code1;
951		buf[offb++] = code2;
952		put_unaligned(cpu_to_le32(addr), (__le32 *)(buf + offb));
953		offb += 4;
954		addr += l;
955		if (l)
956			memcpy(buf + offb, data + offd, l);
957		if (l < stride)
958			memset(buf + offb + l, 0, stride - l);
959		offb += stride;
960		offd += stride;
961		if ((offb >= PAGE_SIZE) || (offd >= size)) {
962			ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
963					   buf, offb, NULL, CMD_TIMEOUT);
964			if (ret < 0) {
965				dbg("sending fw %#x failed", fw);
966				goto cleanup;
967			}
968			offb = 0;
969		}
970	} while (offd < size);
971	dbg("sent fw %#x", fw);
972
973	ret = 0;
974
975cleanup:
976	free_page((unsigned long) buf);
977	return ret;
978}
979
980static void cxacru_upload_firmware(struct cxacru_data *instance,
981				   const struct firmware *fw,
982				   const struct firmware *bp)
983{
984	int ret;
985	struct usbatm_data *usbatm = instance->usbatm;
986	struct usb_device *usb_dev = usbatm->usb_dev;
987	__le16 signature[] = { usb_dev->descriptor.idVendor,
988			       usb_dev->descriptor.idProduct };
989	__le32 val;
990
991	dbg("cxacru_upload_firmware");
992
993	/* FirmwarePllFClkValue */
994	val = cpu_to_le32(instance->modem_type->pll_f_clk);
995	ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
996	if (ret) {
997		usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
998		return;
999	}
1000
1001	/* FirmwarePllBClkValue */
1002	val = cpu_to_le32(instance->modem_type->pll_b_clk);
1003	ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
1004	if (ret) {
1005		usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
1006		return;
1007	}
1008
1009	/* Enable SDRAM */
1010	val = cpu_to_le32(SDRAM_ENA);
1011	ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
1012	if (ret) {
1013		usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
1014		return;
1015	}
1016
1017	/* Firmware */
1018	usb_info(usbatm, "loading firmware\n");
1019	ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
1020	if (ret) {
1021		usb_err(usbatm, "Firmware upload failed: %d\n", ret);
1022		return;
1023	}
1024
1025	/* Boot ROM patch */
1026	if (instance->modem_type->boot_rom_patch) {
1027		usb_info(usbatm, "loading boot ROM patch\n");
1028		ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
1029		if (ret) {
1030			usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
1031			return;
1032		}
1033	}
1034
1035	/* Signature */
1036	ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
1037	if (ret) {
1038		usb_err(usbatm, "Signature storing failed: %d\n", ret);
1039		return;
1040	}
1041
1042	usb_info(usbatm, "starting device\n");
1043	if (instance->modem_type->boot_rom_patch) {
1044		val = cpu_to_le32(BR_ADDR);
1045		ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
1046	} else {
1047		ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1048	}
1049	if (ret) {
1050		usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
1051		return;
1052	}
1053
1054	/* Delay to allow firmware to start up. */
1055	msleep_interruptible(1000);
1056
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));
1061
1062	ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1063	if (ret < 0) {
1064		usb_err(usbatm, "modem failed to initialize: %d\n", ret);
1065		return;
1066	}
1067}
1068
1069static int cxacru_find_firmware(struct cxacru_data *instance,
1070				char *phase, const struct firmware **fw_p)
1071{
1072	struct usbatm_data *usbatm = instance->usbatm;
1073	struct device *dev = &usbatm->usb_intf->dev;
1074	char buf[16];
1075
1076	sprintf(buf, "cxacru-%s.bin", phase);
1077	dbg("cxacru_find_firmware: looking for %s", buf);
1078
1079	if (request_firmware(fw_p, buf, dev)) {
1080		usb_dbg(usbatm, "no stage %s firmware found\n", phase);
1081		return -ENOENT;
1082	}
1083
1084	usb_info(usbatm, "found firmware %s\n", buf);
1085
1086	return 0;
1087}
1088
1089static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1090			     struct usb_interface *usb_intf)
1091{
1092	const struct firmware *fw, *bp;
1093	struct cxacru_data *instance = usbatm_instance->driver_data;
1094
1095	int ret = cxacru_find_firmware(instance, "fw", &fw);
1096	if (ret) {
1097		usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
1098		return ret;
1099	}
1100
1101	if (instance->modem_type->boot_rom_patch) {
1102		ret = cxacru_find_firmware(instance, "bp", &bp);
1103		if (ret) {
1104			usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
1105			release_firmware(fw);
1106			return ret;
1107		}
1108	}
1109
1110	cxacru_upload_firmware(instance, fw, bp);
1111
1112	if (instance->modem_type->boot_rom_patch)
1113		release_firmware(bp);
1114	release_firmware(fw);
1115
1116	ret = cxacru_card_status(instance);
1117	if (ret)
1118		dbg("modem initialisation failed");
1119	else
1120		dbg("done setting up the modem");
1121
1122	return ret;
1123}
1124
1125static int cxacru_bind(struct usbatm_data *usbatm_instance,
1126		       struct usb_interface *intf, const struct usb_device_id *id)
1127{
1128	struct cxacru_data *instance;
1129	struct usb_device *usb_dev = interface_to_usbdev(intf);
1130	struct usb_host_endpoint *cmd_ep = usb_dev->ep_in[CXACRU_EP_CMD];
1131	int ret;
1132
1133	/* instance init */
1134	instance = kzalloc(sizeof(*instance), GFP_KERNEL);
1135	if (!instance) {
1136		dbg("cxacru_bind: no memory for instance data");
1137		return -ENOMEM;
1138	}
1139
1140	instance->usbatm = usbatm_instance;
1141	instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1142
1143	mutex_init(&instance->poll_state_serialize);
1144	instance->poll_state = CXPOLL_STOPPED;
1145	instance->line_status = -1;
1146	instance->adsl_status = -1;
1147
1148	mutex_init(&instance->adsl_state_serialize);
1149
1150	instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1151	if (!instance->rcv_buf) {
1152		dbg("cxacru_bind: no memory for rcv_buf");
1153		ret = -ENOMEM;
1154		goto fail;
1155	}
1156	instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1157	if (!instance->snd_buf) {
1158		dbg("cxacru_bind: no memory for snd_buf");
1159		ret = -ENOMEM;
1160		goto fail;
1161	}
1162	instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1163	if (!instance->rcv_urb) {
1164		dbg("cxacru_bind: no memory for rcv_urb");
1165		ret = -ENOMEM;
1166		goto fail;
1167	}
1168	instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1169	if (!instance->snd_urb) {
1170		dbg("cxacru_bind: no memory for snd_urb");
1171		ret = -ENOMEM;
1172		goto fail;
1173	}
1174
1175	if (!cmd_ep) {
1176		dbg("cxacru_bind: no command endpoint");
1177		ret = -ENODEV;
1178		goto fail;
1179	}
1180
1181	if ((cmd_ep->desc.bmAttributes & USB_ENDPOINT_XFERTYPE_MASK)
1182			== USB_ENDPOINT_XFER_INT) {
1183		usb_fill_int_urb(instance->rcv_urb,
1184			usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1185			instance->rcv_buf, PAGE_SIZE,
1186			cxacru_blocking_completion, &instance->rcv_done, 1);
1187
1188		usb_fill_int_urb(instance->snd_urb,
1189			usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1190			instance->snd_buf, PAGE_SIZE,
1191			cxacru_blocking_completion, &instance->snd_done, 4);
1192	} else {
1193		usb_fill_bulk_urb(instance->rcv_urb,
1194			usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD),
1195			instance->rcv_buf, PAGE_SIZE,
1196			cxacru_blocking_completion, &instance->rcv_done);
1197
1198		usb_fill_bulk_urb(instance->snd_urb,
1199			usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
1200			instance->snd_buf, PAGE_SIZE,
1201			cxacru_blocking_completion, &instance->snd_done);
1202	}
1203
1204	mutex_init(&instance->cm_serialize);
1205
1206	INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
1207
1208	usbatm_instance->driver_data = instance;
1209
1210	usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
1211
1212	return 0;
1213
1214 fail:
1215	free_page((unsigned long) instance->snd_buf);
1216	free_page((unsigned long) instance->rcv_buf);
1217	usb_free_urb(instance->snd_urb);
1218	usb_free_urb(instance->rcv_urb);
1219	kfree(instance);
1220
1221	return ret;
1222}
1223
1224static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1225		struct usb_interface *intf)
1226{
1227	struct cxacru_data *instance = usbatm_instance->driver_data;
1228	int is_polling = 1;
1229
1230	dbg("cxacru_unbind entered");
1231
1232	if (!instance) {
1233		dbg("cxacru_unbind: NULL instance!");
1234		return;
1235	}
1236
1237	mutex_lock(&instance->poll_state_serialize);
1238	BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1239
1240	/* ensure that status polling continues unless
1241	 * it has already stopped */
1242	if (instance->poll_state == CXPOLL_STOPPED)
1243		is_polling = 0;
1244
1245	/* stop polling from being stopped or started */
1246	instance->poll_state = CXPOLL_SHUTDOWN;
1247	mutex_unlock(&instance->poll_state_serialize);
1248
1249	if (is_polling)
1250		cancel_delayed_work_sync(&instance->poll_work);
1251
1252	usb_kill_urb(instance->snd_urb);
1253	usb_kill_urb(instance->rcv_urb);
1254	usb_free_urb(instance->snd_urb);
1255	usb_free_urb(instance->rcv_urb);
1256
1257	free_page((unsigned long) instance->snd_buf);
1258	free_page((unsigned long) instance->rcv_buf);
1259
1260	kfree(instance);
1261
1262	usbatm_instance->driver_data = NULL;
1263}
1264
1265static const struct cxacru_modem_type cxacru_cafe = {
1266	.pll_f_clk = 0x02d874df,
1267	.pll_b_clk = 0x0196a51a,
1268	.boot_rom_patch = 1,
1269};
1270
1271static const struct cxacru_modem_type cxacru_cb00 = {
1272	.pll_f_clk = 0x5,
1273	.pll_b_clk = 0x3,
1274	.boot_rom_patch = 0,
1275};
1276
1277static const struct usb_device_id cxacru_usb_ids[] = {
1278	{ /* V = Conexant			P = ADSL modem (Euphrates project)	*/
1279		USB_DEVICE(0x0572, 0xcafe),	.driver_info = (unsigned long) &cxacru_cafe
1280	},
1281	{ /* V = Conexant			P = ADSL modem (Hasbani project)	*/
1282		USB_DEVICE(0x0572, 0xcb00),	.driver_info = (unsigned long) &cxacru_cb00
1283	},
1284	{ /* V = Conexant			P = ADSL modem				*/
1285		USB_DEVICE(0x0572, 0xcb01),	.driver_info = (unsigned long) &cxacru_cb00
1286	},
1287	{ /* V = Conexant			P = ADSL modem (Well PTI-800) */
1288		USB_DEVICE(0x0572, 0xcb02),	.driver_info = (unsigned long) &cxacru_cb00
1289	},
1290	{ /* V = Conexant			P = ADSL modem				*/
1291		USB_DEVICE(0x0572, 0xcb06),	.driver_info = (unsigned long) &cxacru_cb00
1292	},
1293	{ /* V = Conexant			P = ADSL modem (ZTE ZXDSL 852)		*/
1294		USB_DEVICE(0x0572, 0xcb07),	.driver_info = (unsigned long) &cxacru_cb00
1295	},
1296	{ /* V = Olitec				P = ADSL modem version 2		*/
1297		USB_DEVICE(0x08e3, 0x0100),	.driver_info = (unsigned long) &cxacru_cafe
1298	},
1299	{ /* V = Olitec				P = ADSL modem version 3		*/
1300		USB_DEVICE(0x08e3, 0x0102),	.driver_info = (unsigned long) &cxacru_cb00
1301	},
1302	{ /* V = Trust/Amigo Technology Co.	P = AMX-CA86U				*/
1303		USB_DEVICE(0x0eb0, 0x3457),	.driver_info = (unsigned long) &cxacru_cafe
1304	},
1305	{ /* V = Zoom				P = 5510				*/
1306		USB_DEVICE(0x1803, 0x5510),	.driver_info = (unsigned long) &cxacru_cb00
1307	},
1308	{ /* V = Draytek			P = Vigor 318				*/
1309		USB_DEVICE(0x0675, 0x0200),	.driver_info = (unsigned long) &cxacru_cb00
1310	},
1311	{ /* V = Zyxel				P = 630-C1 aka OMNI ADSL USB (Annex A)	*/
1312		USB_DEVICE(0x0586, 0x330a),	.driver_info = (unsigned long) &cxacru_cb00
1313	},
1314	{ /* V = Zyxel				P = 630-C3 aka OMNI ADSL USB (Annex B)	*/
1315		USB_DEVICE(0x0586, 0x330b),	.driver_info = (unsigned long) &cxacru_cb00
1316	},
1317	{ /* V = Aethra				P = Starmodem UM1020			*/
1318		USB_DEVICE(0x0659, 0x0020),	.driver_info = (unsigned long) &cxacru_cb00
1319	},
1320	{ /* V = Aztech Systems			P = ? AKA Pirelli AUA-010		*/
1321		USB_DEVICE(0x0509, 0x0812),	.driver_info = (unsigned long) &cxacru_cb00
1322	},
1323	{ /* V = Netopia			P = Cayman 3341(Annex A)/3351(Annex B)	*/
1324		USB_DEVICE(0x100d, 0xcb01),	.driver_info = (unsigned long) &cxacru_cb00
1325	},
1326	{ /* V = Netopia			P = Cayman 3342(Annex A)/3352(Annex B)	*/
1327		USB_DEVICE(0x100d, 0x3342),	.driver_info = (unsigned long) &cxacru_cb00
1328	},
1329	{}
1330};
1331
1332MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1333
1334static struct usbatm_driver cxacru_driver = {
1335	.driver_name	= cxacru_driver_name,
1336	.bind		= cxacru_bind,
1337	.heavy_init	= cxacru_heavy_init,
1338	.unbind		= cxacru_unbind,
1339	.atm_start	= cxacru_atm_start,
1340	.atm_stop	= cxacru_remove_device_files,
1341	.bulk_in	= CXACRU_EP_DATA,
1342	.bulk_out	= CXACRU_EP_DATA,
1343	.rx_padding	= 3,
1344	.tx_padding	= 11,
1345};
1346
1347static int cxacru_usb_probe(struct usb_interface *intf,
1348		const struct usb_device_id *id)
1349{
1350	struct usb_device *usb_dev = interface_to_usbdev(intf);
1351	char buf[15];
1352
1353	/* Avoid ADSL routers (cx82310_eth).
1354	 * Abort if bDeviceClass is 0xff and iProduct is "USB NET CARD".
1355	 */
1356	if (usb_dev->descriptor.bDeviceClass == USB_CLASS_VENDOR_SPEC
1357			&& usb_string(usb_dev, usb_dev->descriptor.iProduct,
1358				buf, sizeof(buf)) > 0) {
1359		if (!strcmp(buf, "USB NET CARD")) {
1360			dev_info(&intf->dev, "ignoring cx82310_eth device\n");
1361			return -ENODEV;
1362		}
1363	}
1364
1365	return usbatm_usb_probe(intf, id, &cxacru_driver);
1366}
1367
1368static struct usb_driver cxacru_usb_driver = {
1369	.name		= cxacru_driver_name,
1370	.probe		= cxacru_usb_probe,
1371	.disconnect	= usbatm_usb_disconnect,
1372	.id_table	= cxacru_usb_ids
1373};
1374
1375module_usb_driver(cxacru_usb_driver);
1376
1377MODULE_AUTHOR(DRIVER_AUTHOR);
1378MODULE_DESCRIPTION(DRIVER_DESC);
1379MODULE_LICENSE("GPL");
1380MODULE_VERSION(DRIVER_VERSION);
1381