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