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