blob: c2163d0826e300d92659cffd0f39f03ef5584296 [file] [log] [blame]
Duncan Sands1b0e6142005-05-11 20:19:29 +02001/******************************************************************************
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)
Simon Arlott6a02c9962007-04-26 00:38:05 -07007 * Copyright (C) 2007 Simon Arlott
Duncan Sands1b0e6142005-05-11 20:19:29 +02008 *
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License as published by the Free
11 * Software Foundation; either version 2 of the License, or (at your option)
12 * any later version.
13 *
14 * This program is distributed in the hope that it will be useful, but WITHOUT
15 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
16 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
17 * more details.
18 *
19 * You should have received a copy of the GNU General Public License along with
20 * this program; if not, write to the Free Software Foundation, Inc., 59
21 * Temple Place - Suite 330, Boston, MA 02111-1307, USA.
22 *
23 ******************************************************************************/
24
25/*
26 * Credit is due for Josep Comas, who created the original patch to speedtch.c
27 * to support the different padding used by the AccessRunner (now generalized
28 * into usbatm), and the userspace firmware loading utility.
29 */
30
31#include <linux/module.h>
32#include <linux/moduleparam.h>
33#include <linux/kernel.h>
34#include <linux/timer.h>
35#include <linux/errno.h>
36#include <linux/slab.h>
37#include <linux/init.h>
Simon Arlottfa70fe42007-03-06 02:47:45 -080038#include <linux/device.h>
Duncan Sands1b0e6142005-05-11 20:19:29 +020039#include <linux/firmware.h>
Arjan van de Venab3c81f2006-01-13 15:52:55 +010040#include <linux/mutex.h>
Al Virofd05e722008-04-28 07:00:16 +010041#include <asm/unaligned.h>
Duncan Sands1b0e6142005-05-11 20:19:29 +020042
43#include "usbatm.h"
44
Simon Arlottfa70fe42007-03-06 02:47:45 -080045#define DRIVER_AUTHOR "Roman Kagan, David Woodhouse, Duncan Sands, Simon Arlott"
46#define DRIVER_VERSION "0.3"
Duncan Sands1b0e6142005-05-11 20:19:29 +020047#define DRIVER_DESC "Conexant AccessRunner ADSL USB modem driver"
48
49static const char cxacru_driver_name[] = "cxacru";
50
51#define CXACRU_EP_CMD 0x01 /* Bulk/interrupt in/out */
52#define CXACRU_EP_DATA 0x02 /* Bulk in/out */
53
54#define CMD_PACKET_SIZE 64 /* Should be maxpacket(ep)? */
Simon Arlott4ac37202009-11-21 15:14:01 +000055#define CMD_MAX_CONFIG ((CMD_PACKET_SIZE / 4 - 1) / 2)
Duncan Sands1b0e6142005-05-11 20:19:29 +020056
57/* Addresses */
58#define PLLFCLK_ADDR 0x00350068
59#define PLLBCLK_ADDR 0x0035006c
60#define SDRAMEN_ADDR 0x00350010
61#define FW_ADDR 0x00801000
62#define BR_ADDR 0x00180600
63#define SIG_ADDR 0x00180500
64#define BR_STACK_ADDR 0x00187f10
65
66/* Values */
67#define SDRAM_ENA 0x1
68
69#define CMD_TIMEOUT 2000 /* msecs */
Simon Arlottfa70fe42007-03-06 02:47:45 -080070#define POLL_INTERVAL 1 /* secs */
Duncan Sands1b0e6142005-05-11 20:19:29 +020071
72/* commands for interaction with the modem through the control channel before
73 * firmware is loaded */
74enum cxacru_fw_request {
75 FW_CMD_ERR,
76 FW_GET_VER,
77 FW_READ_MEM,
78 FW_WRITE_MEM,
79 FW_RMW_MEM,
80 FW_CHECKSUM_MEM,
81 FW_GOTO_MEM,
82};
83
84/* commands for interaction with the modem through the control channel once
85 * firmware is loaded */
86enum cxacru_cm_request {
87 CM_REQUEST_UNDEFINED = 0x80,
88 CM_REQUEST_TEST,
89 CM_REQUEST_CHIP_GET_MAC_ADDRESS,
90 CM_REQUEST_CHIP_GET_DP_VERSIONS,
91 CM_REQUEST_CHIP_ADSL_LINE_START,
92 CM_REQUEST_CHIP_ADSL_LINE_STOP,
93 CM_REQUEST_CHIP_ADSL_LINE_GET_STATUS,
94 CM_REQUEST_CHIP_ADSL_LINE_GET_SPEED,
95 CM_REQUEST_CARD_INFO_GET,
96 CM_REQUEST_CARD_DATA_GET,
97 CM_REQUEST_CARD_DATA_SET,
98 CM_REQUEST_COMMAND_HW_IO,
99 CM_REQUEST_INTERFACE_HW_IO,
100 CM_REQUEST_CARD_SERIAL_DATA_PATH_GET,
101 CM_REQUEST_CARD_SERIAL_DATA_PATH_SET,
102 CM_REQUEST_CARD_CONTROLLER_VERSION_GET,
103 CM_REQUEST_CARD_GET_STATUS,
104 CM_REQUEST_CARD_GET_MAC_ADDRESS,
105 CM_REQUEST_CARD_GET_DATA_LINK_STATUS,
106 CM_REQUEST_MAX,
107};
108
Simon Arlottc68bb0d2009-11-21 15:12:21 +0000109/* commands for interaction with the flash memory
110 *
111 * read: response is the contents of the first 60 bytes of flash memory
112 * write: request contains the 60 bytes of data to write to flash memory
113 * response is the contents of the first 60 bytes of flash memory
114 *
115 * layout: PP PP VV VV MM MM MM MM MM MM ?? ?? SS SS SS SS SS SS SS SS
116 * SS SS SS SS SS SS SS SS 00 00 00 00 00 00 00 00 00 00 00 00
117 * 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00
118 *
119 * P: le16 USB Product ID
120 * V: le16 USB Vendor ID
121 * M: be48 MAC Address
122 * S: le16 ASCII Serial Number
123 */
124enum cxacru_cm_flash {
125 CM_FLASH_READ = 0xa1,
126 CM_FLASH_WRITE = 0xa2
127};
128
Duncan Sands1b0e6142005-05-11 20:19:29 +0200129/* reply codes to the commands above */
130enum cxacru_cm_status {
131 CM_STATUS_UNDEFINED,
132 CM_STATUS_SUCCESS,
133 CM_STATUS_ERROR,
134 CM_STATUS_UNSUPPORTED,
135 CM_STATUS_UNIMPLEMENTED,
136 CM_STATUS_PARAMETER_ERROR,
137 CM_STATUS_DBG_LOOPBACK,
138 CM_STATUS_MAX,
139};
140
141/* indices into CARD_INFO_GET return array */
142enum cxacru_info_idx {
143 CXINF_DOWNSTREAM_RATE,
144 CXINF_UPSTREAM_RATE,
145 CXINF_LINK_STATUS,
146 CXINF_LINE_STATUS,
147 CXINF_MAC_ADDRESS_HIGH,
148 CXINF_MAC_ADDRESS_LOW,
149 CXINF_UPSTREAM_SNR_MARGIN,
150 CXINF_DOWNSTREAM_SNR_MARGIN,
151 CXINF_UPSTREAM_ATTENUATION,
152 CXINF_DOWNSTREAM_ATTENUATION,
153 CXINF_TRANSMITTER_POWER,
154 CXINF_UPSTREAM_BITS_PER_FRAME,
155 CXINF_DOWNSTREAM_BITS_PER_FRAME,
156 CXINF_STARTUP_ATTEMPTS,
157 CXINF_UPSTREAM_CRC_ERRORS,
158 CXINF_DOWNSTREAM_CRC_ERRORS,
159 CXINF_UPSTREAM_FEC_ERRORS,
160 CXINF_DOWNSTREAM_FEC_ERRORS,
161 CXINF_UPSTREAM_HEC_ERRORS,
162 CXINF_DOWNSTREAM_HEC_ERRORS,
163 CXINF_LINE_STARTABLE,
164 CXINF_MODULATION,
165 CXINF_ADSL_HEADEND,
166 CXINF_ADSL_HEADEND_ENVIRONMENT,
167 CXINF_CONTROLLER_VERSION,
168 /* dunno what the missing two mean */
169 CXINF_MAX = 0x1c,
170};
171
Simon Arlott6a02c9962007-04-26 00:38:05 -0700172enum cxacru_poll_state {
173 CXPOLL_STOPPING,
174 CXPOLL_STOPPED,
175 CXPOLL_POLLING,
176 CXPOLL_SHUTDOWN
177};
178
Duncan Sands1b0e6142005-05-11 20:19:29 +0200179struct cxacru_modem_type {
180 u32 pll_f_clk;
181 u32 pll_b_clk;
182 int boot_rom_patch;
183};
184
185struct cxacru_data {
186 struct usbatm_data *usbatm;
187
188 const struct cxacru_modem_type *modem_type;
189
190 int line_status;
Simon Arlott6a02c9962007-04-26 00:38:05 -0700191 struct mutex adsl_state_serialize;
192 int adsl_status;
David Howellsc4028952006-11-22 14:57:56 +0000193 struct delayed_work poll_work;
Simon Arlottfa70fe42007-03-06 02:47:45 -0800194 u32 card_info[CXINF_MAX];
Simon Arlott6a02c9962007-04-26 00:38:05 -0700195 struct mutex poll_state_serialize;
Simon Arlott87e71b42007-05-10 23:04:11 -0700196 enum cxacru_poll_state poll_state;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200197
198 /* contol handles */
Arjan van de Venab3c81f2006-01-13 15:52:55 +0100199 struct mutex cm_serialize;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200200 u8 *rcv_buf;
201 u8 *snd_buf;
202 struct urb *rcv_urb;
203 struct urb *snd_urb;
204 struct completion rcv_done;
205 struct completion snd_done;
206};
207
Simon Arlott6a02c9962007-04-26 00:38:05 -0700208static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
209 u8 *wdata, int wsize, u8 *rdata, int rsize);
210static void cxacru_poll_status(struct work_struct *work);
211
Simon Arlottfa70fe42007-03-06 02:47:45 -0800212/* Card info exported through sysfs */
213#define CXACRU__ATTR_INIT(_name) \
214static DEVICE_ATTR(_name, S_IRUGO, cxacru_sysfs_show_##_name, NULL)
215
Simon Arlott6a02c9962007-04-26 00:38:05 -0700216#define CXACRU_CMD_INIT(_name) \
217static DEVICE_ATTR(_name, S_IWUSR | S_IRUGO, \
218 cxacru_sysfs_show_##_name, cxacru_sysfs_store_##_name)
219
Simon Arlott4ac37202009-11-21 15:14:01 +0000220#define CXACRU_SET_INIT(_name) \
221static DEVICE_ATTR(_name, S_IWUSR, \
222 NULL, cxacru_sysfs_store_##_name)
223
Simon Arlottfa70fe42007-03-06 02:47:45 -0800224#define CXACRU_ATTR_INIT(_value, _type, _name) \
225static ssize_t cxacru_sysfs_show_##_name(struct device *dev, \
226 struct device_attribute *attr, char *buf) \
227{ \
Simon Arlott9fc950d2009-11-21 15:33:51 +0000228 struct cxacru_data *instance = to_usbatm_driver_data(\
229 to_usb_interface(dev)); \
230\
231 if (instance == NULL) \
232 return -ENODEV; \
233\
Simon Arlottfa70fe42007-03-06 02:47:45 -0800234 return cxacru_sysfs_showattr_##_type(instance->card_info[_value], buf); \
235} \
236CXACRU__ATTR_INIT(_name)
237
238#define CXACRU_ATTR_CREATE(_v, _t, _name) CXACRU_DEVICE_CREATE_FILE(_name)
Simon Arlott6a02c9962007-04-26 00:38:05 -0700239#define CXACRU_CMD_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
Simon Arlott4ac37202009-11-21 15:14:01 +0000240#define CXACRU_SET_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
Simon Arlottfa70fe42007-03-06 02:47:45 -0800241#define CXACRU__ATTR_CREATE(_name) CXACRU_DEVICE_CREATE_FILE(_name)
242
243#define CXACRU_ATTR_REMOVE(_v, _t, _name) CXACRU_DEVICE_REMOVE_FILE(_name)
Simon Arlott6a02c9962007-04-26 00:38:05 -0700244#define CXACRU_CMD_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
Simon Arlott4ac37202009-11-21 15:14:01 +0000245#define CXACRU_SET_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
Simon Arlottfa70fe42007-03-06 02:47:45 -0800246#define CXACRU__ATTR_REMOVE(_name) CXACRU_DEVICE_REMOVE_FILE(_name)
247
248static ssize_t cxacru_sysfs_showattr_u32(u32 value, char *buf)
249{
250 return snprintf(buf, PAGE_SIZE, "%u\n", value);
251}
252
253static ssize_t cxacru_sysfs_showattr_s8(s8 value, char *buf)
254{
255 return snprintf(buf, PAGE_SIZE, "%d\n", value);
256}
257
258static ssize_t cxacru_sysfs_showattr_dB(s16 value, char *buf)
259{
Simon Arlott10107bd2009-04-23 18:19:02 +0100260 if (likely(value >= 0)) {
261 return snprintf(buf, PAGE_SIZE, "%u.%02u\n",
262 value / 100, value % 100);
263 } else {
264 value = -value;
265 return snprintf(buf, PAGE_SIZE, "-%u.%02u\n",
266 value / 100, value % 100);
267 }
Simon Arlottfa70fe42007-03-06 02:47:45 -0800268}
269
270static ssize_t cxacru_sysfs_showattr_bool(u32 value, char *buf)
271{
Simon Arlott87e71b42007-05-10 23:04:11 -0700272 static char *str[] = { "no", "yes" };
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]);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800276}
277
278static ssize_t cxacru_sysfs_showattr_LINK(u32 value, char *buf)
279{
Simon Arlott87e71b42007-05-10 23:04:11 -0700280 static char *str[] = { NULL, "not connected", "connected", "lost" };
281 if (unlikely(value >= ARRAY_SIZE(str) || str[value] == NULL))
282 return snprintf(buf, PAGE_SIZE, "%u\n", value);
283 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800284}
285
286static ssize_t cxacru_sysfs_showattr_LINE(u32 value, char *buf)
287{
Simon Arlott87e71b42007-05-10 23:04:11 -0700288 static char *str[] = { "down", "attempting to activate",
289 "training", "channel analysis", "exchange", "up",
290 "waiting", "initialising"
291 };
292 if (unlikely(value >= ARRAY_SIZE(str)))
293 return snprintf(buf, PAGE_SIZE, "%u\n", value);
294 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800295}
296
297static ssize_t cxacru_sysfs_showattr_MODU(u32 value, char *buf)
298{
Simon Arlott87e71b42007-05-10 23:04:11 -0700299 static char *str[] = {
Simon Arlott1bfbd282009-11-21 15:03:23 +0000300 "",
Simon Arlott87e71b42007-05-10 23:04:11 -0700301 "ANSI T1.413",
302 "ITU-T G.992.1 (G.DMT)",
303 "ITU-T G.992.2 (G.LITE)"
304 };
Simon Arlott1bfbd282009-11-21 15:03:23 +0000305 if (unlikely(value >= ARRAY_SIZE(str)))
Simon Arlott87e71b42007-05-10 23:04:11 -0700306 return snprintf(buf, PAGE_SIZE, "%u\n", value);
307 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800308}
309
310/*
311 * This could use MAC_ADDRESS_HIGH and MAC_ADDRESS_LOW, but since
312 * this data is already in atm_dev there's no point.
313 *
314 * MAC_ADDRESS_HIGH = 0x????5544
315 * MAC_ADDRESS_LOW = 0x33221100
316 * Where 00-55 are bytes 0-5 of the MAC.
317 */
318static ssize_t cxacru_sysfs_show_mac_address(struct device *dev,
319 struct device_attribute *attr, char *buf)
320{
Simon Arlott9fc950d2009-11-21 15:33:51 +0000321 struct cxacru_data *instance = to_usbatm_driver_data(
322 to_usb_interface(dev));
Simon Arlottfa70fe42007-03-06 02:47:45 -0800323
Simon Arlott9fc950d2009-11-21 15:33:51 +0000324 if (instance == NULL || instance->usbatm->atm_dev == NULL)
325 return -ENODEV;
326
327 return snprintf(buf, PAGE_SIZE, "%pM\n",
328 instance->usbatm->atm_dev->esi);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800329}
330
Simon Arlott6a02c9962007-04-26 00:38:05 -0700331static ssize_t cxacru_sysfs_show_adsl_state(struct device *dev,
332 struct device_attribute *attr, char *buf)
333{
Simon Arlott87e71b42007-05-10 23:04:11 -0700334 static char *str[] = { "running", "stopped" };
Simon Arlott9fc950d2009-11-21 15:33:51 +0000335 struct cxacru_data *instance = to_usbatm_driver_data(
336 to_usb_interface(dev));
337 u32 value;
338
339 if (instance == NULL)
340 return -ENODEV;
341
342 value = instance->card_info[CXINF_LINE_STARTABLE];
Simon Arlott87e71b42007-05-10 23:04:11 -0700343 if (unlikely(value >= ARRAY_SIZE(str)))
344 return snprintf(buf, PAGE_SIZE, "%u\n", value);
345 return snprintf(buf, PAGE_SIZE, "%s\n", str[value]);
Simon Arlott6a02c9962007-04-26 00:38:05 -0700346}
347
348static ssize_t cxacru_sysfs_store_adsl_state(struct device *dev,
349 struct device_attribute *attr, const char *buf, size_t count)
350{
Simon Arlott9fc950d2009-11-21 15:33:51 +0000351 struct cxacru_data *instance = to_usbatm_driver_data(
352 to_usb_interface(dev));
Simon Arlott6a02c9962007-04-26 00:38:05 -0700353 int ret;
354 int poll = -1;
355 char str_cmd[8];
356 int len = strlen(buf);
357
358 if (!capable(CAP_NET_ADMIN))
359 return -EACCES;
360
361 ret = sscanf(buf, "%7s", str_cmd);
362 if (ret != 1)
363 return -EINVAL;
364 ret = 0;
365
Simon Arlott9fc950d2009-11-21 15:33:51 +0000366 if (instance == NULL)
367 return -ENODEV;
368
Simon Arlott6a02c9962007-04-26 00:38:05 -0700369 if (mutex_lock_interruptible(&instance->adsl_state_serialize))
370 return -ERESTARTSYS;
371
372 if (!strcmp(str_cmd, "stop") || !strcmp(str_cmd, "restart")) {
373 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_STOP, NULL, 0, NULL, 0);
374 if (ret < 0) {
Simon Arlott9fc950d2009-11-21 15:33:51 +0000375 atm_err(instance->usbatm, "change adsl state:"
Simon Arlott6a02c9962007-04-26 00:38:05 -0700376 " CHIP_ADSL_LINE_STOP returned %d\n", ret);
377
378 ret = -EIO;
379 } else {
380 ret = len;
381 poll = CXPOLL_STOPPED;
382 }
383 }
384
385 /* Line status is only updated every second
386 * and the device appears to only react to
387 * START/STOP every second too. Wait 1.5s to
388 * be sure that restart will have an effect. */
389 if (!strcmp(str_cmd, "restart"))
390 msleep(1500);
391
392 if (!strcmp(str_cmd, "start") || !strcmp(str_cmd, "restart")) {
393 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
394 if (ret < 0) {
Simon Arlott9fc950d2009-11-21 15:33:51 +0000395 atm_err(instance->usbatm, "change adsl state:"
Simon Arlott6a02c9962007-04-26 00:38:05 -0700396 " CHIP_ADSL_LINE_START returned %d\n", ret);
397
398 ret = -EIO;
399 } else {
400 ret = len;
401 poll = CXPOLL_POLLING;
402 }
403 }
404
405 if (!strcmp(str_cmd, "poll")) {
406 ret = len;
407 poll = CXPOLL_POLLING;
408 }
409
410 if (ret == 0) {
411 ret = -EINVAL;
412 poll = -1;
413 }
414
415 if (poll == CXPOLL_POLLING) {
416 mutex_lock(&instance->poll_state_serialize);
417 switch (instance->poll_state) {
418 case CXPOLL_STOPPED:
419 /* start polling */
420 instance->poll_state = CXPOLL_POLLING;
421 break;
422
423 case CXPOLL_STOPPING:
424 /* abort stop request */
425 instance->poll_state = CXPOLL_POLLING;
426 case CXPOLL_POLLING:
427 case CXPOLL_SHUTDOWN:
428 /* don't start polling */
429 poll = -1;
430 }
431 mutex_unlock(&instance->poll_state_serialize);
432 } else if (poll == CXPOLL_STOPPED) {
433 mutex_lock(&instance->poll_state_serialize);
434 /* request stop */
435 if (instance->poll_state == CXPOLL_POLLING)
436 instance->poll_state = CXPOLL_STOPPING;
437 mutex_unlock(&instance->poll_state_serialize);
438 }
439
440 mutex_unlock(&instance->adsl_state_serialize);
441
442 if (poll == CXPOLL_POLLING)
443 cxacru_poll_status(&instance->poll_work.work);
444
445 return ret;
446}
447
Simon Arlott4ac37202009-11-21 15:14:01 +0000448/* CM_REQUEST_CARD_DATA_GET times out, so no show attribute */
449
450static ssize_t cxacru_sysfs_store_adsl_config(struct device *dev,
451 struct device_attribute *attr, const char *buf, size_t count)
452{
453 struct cxacru_data *instance = to_usbatm_driver_data(
454 to_usb_interface(dev));
455 int len = strlen(buf);
456 int ret, pos, num;
457 __le32 data[CMD_PACKET_SIZE / 4];
458
459 if (!capable(CAP_NET_ADMIN))
460 return -EACCES;
461
462 if (instance == NULL)
463 return -ENODEV;
464
465 pos = 0;
466 num = 0;
467 while (pos < len) {
468 int tmp;
469 u32 index;
470 u32 value;
471
472 ret = sscanf(buf + pos, "%x=%x%n", &index, &value, &tmp);
473 if (ret < 2)
474 return -EINVAL;
475 if (index < 0 || index > 0x7f)
476 return -EINVAL;
477 pos += tmp;
478
479 /* skip trailing newline */
480 if (buf[pos] == '\n' && pos == len-1)
481 pos++;
482
483 data[num * 2 + 1] = cpu_to_le32(index);
484 data[num * 2 + 2] = cpu_to_le32(value);
485 num++;
486
487 /* send config values when data buffer is full
488 * or no more data
489 */
490 if (pos >= len || num >= CMD_MAX_CONFIG) {
491 char log[CMD_MAX_CONFIG * 12 + 1]; /* %02x=%08x */
492
493 data[0] = cpu_to_le32(num);
494 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
495 (u8 *) data, 4 + num * 8, NULL, 0);
496 if (ret < 0) {
497 atm_err(instance->usbatm,
498 "set card data returned %d\n", ret);
499 return -EIO;
500 }
501
502 for (tmp = 0; tmp < num; tmp++)
503 snprintf(log + tmp*12, 13, " %02x=%08x",
504 le32_to_cpu(data[tmp * 2 + 1]),
505 le32_to_cpu(data[tmp * 2 + 2]));
506 atm_info(instance->usbatm, "config%s\n", log);
507 num = 0;
508 }
509 }
510
511 return len;
512}
513
Simon Arlottfa70fe42007-03-06 02:47:45 -0800514/*
515 * All device attributes are included in CXACRU_ALL_FILES
516 * so that the same list can be used multiple times:
517 * INIT (define the device attributes)
518 * CREATE (create all the device files)
519 * REMOVE (remove all the device files)
520 *
521 * With the last two being defined as needed in the functions
522 * they are used in before calling CXACRU_ALL_FILES()
523 */
524#define CXACRU_ALL_FILES(_action) \
525CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_RATE, u32, downstream_rate); \
526CXACRU_ATTR_##_action(CXINF_UPSTREAM_RATE, u32, upstream_rate); \
527CXACRU_ATTR_##_action(CXINF_LINK_STATUS, LINK, link_status); \
528CXACRU_ATTR_##_action(CXINF_LINE_STATUS, LINE, line_status); \
529CXACRU__ATTR_##_action( mac_address); \
530CXACRU_ATTR_##_action(CXINF_UPSTREAM_SNR_MARGIN, dB, upstream_snr_margin); \
531CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_SNR_MARGIN, dB, downstream_snr_margin); \
532CXACRU_ATTR_##_action(CXINF_UPSTREAM_ATTENUATION, dB, upstream_attenuation); \
533CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_ATTENUATION, dB, downstream_attenuation); \
534CXACRU_ATTR_##_action(CXINF_TRANSMITTER_POWER, s8, transmitter_power); \
535CXACRU_ATTR_##_action(CXINF_UPSTREAM_BITS_PER_FRAME, u32, upstream_bits_per_frame); \
536CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_BITS_PER_FRAME, u32, downstream_bits_per_frame); \
537CXACRU_ATTR_##_action(CXINF_STARTUP_ATTEMPTS, u32, startup_attempts); \
538CXACRU_ATTR_##_action(CXINF_UPSTREAM_CRC_ERRORS, u32, upstream_crc_errors); \
539CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_CRC_ERRORS, u32, downstream_crc_errors); \
540CXACRU_ATTR_##_action(CXINF_UPSTREAM_FEC_ERRORS, u32, upstream_fec_errors); \
541CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_FEC_ERRORS, u32, downstream_fec_errors); \
542CXACRU_ATTR_##_action(CXINF_UPSTREAM_HEC_ERRORS, u32, upstream_hec_errors); \
543CXACRU_ATTR_##_action(CXINF_DOWNSTREAM_HEC_ERRORS, u32, downstream_hec_errors); \
544CXACRU_ATTR_##_action(CXINF_LINE_STARTABLE, bool, line_startable); \
545CXACRU_ATTR_##_action(CXINF_MODULATION, MODU, modulation); \
546CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND, u32, adsl_headend); \
547CXACRU_ATTR_##_action(CXINF_ADSL_HEADEND_ENVIRONMENT, u32, adsl_headend_environment); \
Simon Arlott6a02c9962007-04-26 00:38:05 -0700548CXACRU_ATTR_##_action(CXINF_CONTROLLER_VERSION, u32, adsl_controller_version); \
Simon Arlott4ac37202009-11-21 15:14:01 +0000549CXACRU_CMD_##_action( adsl_state); \
550CXACRU_SET_##_action( adsl_config);
Simon Arlottfa70fe42007-03-06 02:47:45 -0800551
552CXACRU_ALL_FILES(INIT);
553
Duncan Sands1b0e6142005-05-11 20:19:29 +0200554/* the following three functions are stolen from drivers/usb/core/message.c */
David Howells7d12e782006-10-05 14:55:46 +0100555static void cxacru_blocking_completion(struct urb *urb)
Duncan Sands1b0e6142005-05-11 20:19:29 +0200556{
Ming Leicdc97792008-02-24 18:41:47 +0800557 complete(urb->context);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200558}
559
560static void cxacru_timeout_kill(unsigned long data)
561{
562 usb_unlink_urb((struct urb *) data);
563}
564
565static int cxacru_start_wait_urb(struct urb *urb, struct completion *done,
566 int* actual_length)
567{
568 struct timer_list timer;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200569
570 init_timer(&timer);
571 timer.expires = jiffies + msecs_to_jiffies(CMD_TIMEOUT);
572 timer.data = (unsigned long) urb;
573 timer.function = cxacru_timeout_kill;
574 add_timer(&timer);
575 wait_for_completion(done);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200576 del_timer_sync(&timer);
577
578 if (actual_length)
579 *actual_length = urb->actual_length;
Oliver Neukum3b79cc22007-08-16 16:06:06 +0200580 return urb->status; /* must read status after completion */
Duncan Sands1b0e6142005-05-11 20:19:29 +0200581}
582
583static int cxacru_cm(struct cxacru_data *instance, enum cxacru_cm_request cm,
584 u8 *wdata, int wsize, u8 *rdata, int rsize)
585{
586 int ret, actlen;
587 int offb, offd;
588 const int stride = CMD_PACKET_SIZE - 4;
589 u8 *wbuf = instance->snd_buf;
590 u8 *rbuf = instance->rcv_buf;
591 int wbuflen = ((wsize - 1) / stride + 1) * CMD_PACKET_SIZE;
592 int rbuflen = ((rsize - 1) / stride + 1) * CMD_PACKET_SIZE;
593
594 if (wbuflen > PAGE_SIZE || rbuflen > PAGE_SIZE) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100595 if (printk_ratelimit())
596 usb_err(instance->usbatm, "requested transfer size too large (%d, %d)\n",
597 wbuflen, rbuflen);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200598 ret = -ENOMEM;
Jiri Slabyeeafa642009-03-11 21:47:36 +0100599 goto err;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200600 }
601
Arjan van de Venab3c81f2006-01-13 15:52:55 +0100602 mutex_lock(&instance->cm_serialize);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200603
604 /* submit reading urb before the writing one */
605 init_completion(&instance->rcv_done);
606 ret = usb_submit_urb(instance->rcv_urb, GFP_KERNEL);
607 if (ret < 0) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100608 if (printk_ratelimit())
609 usb_err(instance->usbatm, "submit of read urb for cm %#x failed (%d)\n",
610 cm, ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200611 goto fail;
612 }
613
614 memset(wbuf, 0, wbuflen);
615 /* handle wsize == 0 */
616 wbuf[0] = cm;
617 for (offb = offd = 0; offd < wsize; offd += stride, offb += CMD_PACKET_SIZE) {
618 wbuf[offb] = cm;
619 memcpy(wbuf + offb + 4, wdata + offd, min_t(int, stride, wsize - offd));
620 }
621
622 instance->snd_urb->transfer_buffer_length = wbuflen;
623 init_completion(&instance->snd_done);
624 ret = usb_submit_urb(instance->snd_urb, GFP_KERNEL);
625 if (ret < 0) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100626 if (printk_ratelimit())
627 usb_err(instance->usbatm, "submit of write urb for cm %#x failed (%d)\n",
628 cm, ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200629 goto fail;
630 }
631
632 ret = cxacru_start_wait_urb(instance->snd_urb, &instance->snd_done, NULL);
633 if (ret < 0) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100634 if (printk_ratelimit())
635 usb_err(instance->usbatm, "send of cm %#x failed (%d)\n", cm, ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200636 goto fail;
637 }
638
639 ret = cxacru_start_wait_urb(instance->rcv_urb, &instance->rcv_done, &actlen);
640 if (ret < 0) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100641 if (printk_ratelimit())
642 usb_err(instance->usbatm, "receive of cm %#x failed (%d)\n", cm, ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200643 goto fail;
644 }
645 if (actlen % CMD_PACKET_SIZE || !actlen) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100646 if (printk_ratelimit())
647 usb_err(instance->usbatm, "invalid response length to cm %#x: %d\n",
648 cm, actlen);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200649 ret = -EIO;
650 goto fail;
651 }
652
653 /* check the return status and copy the data to the output buffer, if needed */
654 for (offb = offd = 0; offd < rsize && offb < actlen; offb += CMD_PACKET_SIZE) {
655 if (rbuf[offb] != cm) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100656 if (printk_ratelimit())
657 usb_err(instance->usbatm, "wrong cm %#x in response to cm %#x\n",
658 rbuf[offb], cm);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200659 ret = -EIO;
660 goto fail;
661 }
662 if (rbuf[offb + 1] != CM_STATUS_SUCCESS) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100663 if (printk_ratelimit())
664 usb_err(instance->usbatm, "response to cm %#x failed: %#x\n",
665 cm, rbuf[offb + 1]);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200666 ret = -EIO;
667 goto fail;
668 }
669 if (offd >= rsize)
670 break;
671 memcpy(rdata + offd, rbuf + offb + 4, min_t(int, stride, rsize - offd));
672 offd += stride;
673 }
674
675 ret = offd;
676 dbg("cm %#x", cm);
677fail:
Arjan van de Venab3c81f2006-01-13 15:52:55 +0100678 mutex_unlock(&instance->cm_serialize);
Jiri Slabyeeafa642009-03-11 21:47:36 +0100679err:
Duncan Sands1b0e6142005-05-11 20:19:29 +0200680 return ret;
681}
682
683static int cxacru_cm_get_array(struct cxacru_data *instance, enum cxacru_cm_request cm,
684 u32 *data, int size)
685{
686 int ret, len;
Al Virofd05e722008-04-28 07:00:16 +0100687 __le32 *buf;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200688 int offb, offd;
689 const int stride = CMD_PACKET_SIZE / (4 * 2) - 1;
690 int buflen = ((size - 1) / stride + 1 + size * 2) * 4;
691
692 buf = kmalloc(buflen, GFP_KERNEL);
693 if (!buf)
694 return -ENOMEM;
695
696 ret = cxacru_cm(instance, cm, NULL, 0, (u8 *) buf, buflen);
697 if (ret < 0)
698 goto cleanup;
699
700 /* len > 0 && len % 4 == 0 guaranteed by cxacru_cm() */
701 len = ret / 4;
702 for (offb = 0; offb < len; ) {
703 int l = le32_to_cpu(buf[offb++]);
Simon Arlott5d0a9c72009-11-21 15:07:14 +0000704 if (l < 0 || l > stride || l > (len - offb) / 2) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100705 if (printk_ratelimit())
706 usb_err(instance->usbatm, "invalid data length from cm %#x: %d\n",
707 cm, l);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200708 ret = -EIO;
709 goto cleanup;
710 }
711 while (l--) {
712 offd = le32_to_cpu(buf[offb++]);
713 if (offd >= size) {
Simon Arlott4ac07182007-09-25 20:20:10 +0100714 if (printk_ratelimit())
Simon Arlott230ffc72008-07-12 22:19:48 +0100715 usb_err(instance->usbatm, "wrong index %#x in response to cm %#x\n",
Simon Arlott4ac07182007-09-25 20:20:10 +0100716 offd, cm);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200717 ret = -EIO;
718 goto cleanup;
719 }
720 data[offd] = le32_to_cpu(buf[offb++]);
721 }
722 }
723
724 ret = 0;
725
726cleanup:
727 kfree(buf);
728 return ret;
729}
730
731static int cxacru_card_status(struct cxacru_data *instance)
732{
733 int ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
734 if (ret < 0) { /* firmware not loaded */
735 dbg("cxacru_adsl_start: CARD_GET_STATUS returned %d", ret);
736 return ret;
737 }
738 return 0;
739}
740
Simon Arlottda1f82b52007-05-10 23:04:12 -0700741static void cxacru_remove_device_files(struct usbatm_data *usbatm_instance,
742 struct atm_dev *atm_dev)
743{
744 struct usb_interface *intf = usbatm_instance->usb_intf;
745
746 #define CXACRU_DEVICE_REMOVE_FILE(_name) \
747 device_remove_file(&intf->dev, &dev_attr_##_name);
748 CXACRU_ALL_FILES(REMOVE);
749 #undef CXACRU_DEVICE_REMOVE_FILE
750}
751
Duncan Sands1b0e6142005-05-11 20:19:29 +0200752static int cxacru_atm_start(struct usbatm_data *usbatm_instance,
753 struct atm_dev *atm_dev)
754{
755 struct cxacru_data *instance = usbatm_instance->driver_data;
Simon Arlottda1f82b52007-05-10 23:04:12 -0700756 struct usb_interface *intf = usbatm_instance->usb_intf;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200757 int ret;
Simon Arlott6a02c9962007-04-26 00:38:05 -0700758 int start_polling = 1;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200759
760 dbg("cxacru_atm_start");
761
762 /* Read MAC address */
763 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_MAC_ADDRESS, NULL, 0,
764 atm_dev->esi, sizeof(atm_dev->esi));
765 if (ret < 0) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100766 atm_err(usbatm_instance, "cxacru_atm_start: CARD_GET_MAC_ADDRESS returned %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200767 return ret;
768 }
769
Simon Arlottda1f82b52007-05-10 23:04:12 -0700770 #define CXACRU_DEVICE_CREATE_FILE(_name) \
771 ret = device_create_file(&intf->dev, &dev_attr_##_name); \
772 if (unlikely(ret)) \
773 goto fail_sysfs;
774 CXACRU_ALL_FILES(CREATE);
775 #undef CXACRU_DEVICE_CREATE_FILE
776
Duncan Sands1b0e6142005-05-11 20:19:29 +0200777 /* start ADSL */
Simon Arlott6a02c9962007-04-26 00:38:05 -0700778 mutex_lock(&instance->adsl_state_serialize);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200779 ret = cxacru_cm(instance, CM_REQUEST_CHIP_ADSL_LINE_START, NULL, 0, NULL, 0);
Simon Arlottfd209e32007-05-10 23:04:13 -0700780 if (ret < 0)
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100781 atm_err(usbatm_instance, "cxacru_atm_start: CHIP_ADSL_LINE_START returned %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200782
783 /* Start status polling */
Simon Arlott6a02c9962007-04-26 00:38:05 -0700784 mutex_lock(&instance->poll_state_serialize);
785 switch (instance->poll_state) {
786 case CXPOLL_STOPPED:
787 /* start polling */
788 instance->poll_state = CXPOLL_POLLING;
789 break;
790
791 case CXPOLL_STOPPING:
792 /* abort stop request */
793 instance->poll_state = CXPOLL_POLLING;
794 case CXPOLL_POLLING:
795 case CXPOLL_SHUTDOWN:
796 /* don't start polling */
797 start_polling = 0;
798 }
799 mutex_unlock(&instance->poll_state_serialize);
800 mutex_unlock(&instance->adsl_state_serialize);
801
Simon Arlott885582c2009-11-21 15:12:56 +0000802 printk(KERN_INFO "%s%d: %s %pM\n", atm_dev->type, atm_dev->number,
803 usbatm_instance->description, atm_dev->esi);
804
Simon Arlott6a02c9962007-04-26 00:38:05 -0700805 if (start_polling)
806 cxacru_poll_status(&instance->poll_work.work);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200807 return 0;
Simon Arlottda1f82b52007-05-10 23:04:12 -0700808
809fail_sysfs:
810 usb_err(usbatm_instance, "cxacru_atm_start: device_create_file failed (%d)\n", ret);
811 cxacru_remove_device_files(usbatm_instance, atm_dev);
812 return ret;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200813}
814
David Howellsc4028952006-11-22 14:57:56 +0000815static void cxacru_poll_status(struct work_struct *work)
Duncan Sands1b0e6142005-05-11 20:19:29 +0200816{
David Howellsc4028952006-11-22 14:57:56 +0000817 struct cxacru_data *instance =
818 container_of(work, struct cxacru_data, poll_work.work);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200819 u32 buf[CXINF_MAX] = {};
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100820 struct usbatm_data *usbatm = instance->usbatm;
821 struct atm_dev *atm_dev = usbatm->atm_dev;
Simon Arlott6a02c9962007-04-26 00:38:05 -0700822 int keep_polling = 1;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200823 int ret;
824
825 ret = cxacru_cm_get_array(instance, CM_REQUEST_CARD_INFO_GET, buf, CXINF_MAX);
826 if (ret < 0) {
Simon Arlott6a02c9962007-04-26 00:38:05 -0700827 if (ret != -ESHUTDOWN)
828 atm_warn(usbatm, "poll status: error %d\n", ret);
829
830 mutex_lock(&instance->poll_state_serialize);
831 if (instance->poll_state != CXPOLL_SHUTDOWN) {
832 instance->poll_state = CXPOLL_STOPPED;
833
834 if (ret != -ESHUTDOWN)
835 atm_warn(usbatm, "polling disabled, set adsl_state"
836 " to 'start' or 'poll' to resume\n");
837 }
838 mutex_unlock(&instance->poll_state_serialize);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200839 goto reschedule;
840 }
841
Simon Arlottfa70fe42007-03-06 02:47:45 -0800842 memcpy(instance->card_info, buf, sizeof(instance->card_info));
843
Simon Arlott6a02c9962007-04-26 00:38:05 -0700844 if (instance->adsl_status != buf[CXINF_LINE_STARTABLE]) {
845 instance->adsl_status = buf[CXINF_LINE_STARTABLE];
846
847 switch (instance->adsl_status) {
848 case 0:
849 atm_printk(KERN_INFO, usbatm, "ADSL state: running\n");
850 break;
851
852 case 1:
853 atm_printk(KERN_INFO, usbatm, "ADSL state: stopped\n");
854 break;
855
856 default:
857 atm_printk(KERN_INFO, usbatm, "Unknown adsl status %02x\n", instance->adsl_status);
858 break;
859 }
860 }
861
Duncan Sands1b0e6142005-05-11 20:19:29 +0200862 if (instance->line_status == buf[CXINF_LINE_STATUS])
863 goto reschedule;
864
865 instance->line_status = buf[CXINF_LINE_STATUS];
866 switch (instance->line_status) {
867 case 0:
868 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100869 atm_info(usbatm, "ADSL line: down\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200870 break;
871
872 case 1:
873 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100874 atm_info(usbatm, "ADSL line: attempting to activate\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200875 break;
876
877 case 2:
878 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100879 atm_info(usbatm, "ADSL line: training\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200880 break;
881
882 case 3:
883 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100884 atm_info(usbatm, "ADSL line: channel analysis\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200885 break;
886
887 case 4:
888 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100889 atm_info(usbatm, "ADSL line: exchange\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200890 break;
891
892 case 5:
893 atm_dev->link_rate = buf[CXINF_DOWNSTREAM_RATE] * 1000 / 424;
894 atm_dev->signal = ATM_PHY_SIG_FOUND;
895
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100896 atm_info(usbatm, "ADSL line: up (%d kb/s down | %d kb/s up)\n",
Duncan Sands1b0e6142005-05-11 20:19:29 +0200897 buf[CXINF_DOWNSTREAM_RATE], buf[CXINF_UPSTREAM_RATE]);
898 break;
899
900 case 6:
901 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100902 atm_info(usbatm, "ADSL line: waiting\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200903 break;
904
905 case 7:
906 atm_dev->signal = ATM_PHY_SIG_LOST;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100907 atm_info(usbatm, "ADSL line: initializing\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +0200908 break;
909
910 default:
911 atm_dev->signal = ATM_PHY_SIG_UNKNOWN;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100912 atm_info(usbatm, "Unknown line state %02x\n", instance->line_status);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200913 break;
914 }
915reschedule:
Simon Arlott6a02c9962007-04-26 00:38:05 -0700916
917 mutex_lock(&instance->poll_state_serialize);
918 if (instance->poll_state == CXPOLL_STOPPING &&
919 instance->adsl_status == 1 && /* stopped */
920 instance->line_status == 0) /* down */
921 instance->poll_state = CXPOLL_STOPPED;
922
923 if (instance->poll_state == CXPOLL_STOPPED)
924 keep_polling = 0;
925 mutex_unlock(&instance->poll_state_serialize);
926
927 if (keep_polling)
928 schedule_delayed_work(&instance->poll_work,
929 round_jiffies_relative(POLL_INTERVAL*HZ));
Duncan Sands1b0e6142005-05-11 20:19:29 +0200930}
931
932static int cxacru_fw(struct usb_device *usb_dev, enum cxacru_fw_request fw,
David Woodhouse3b216d12008-05-24 00:05:28 +0100933 u8 code1, u8 code2, u32 addr, const u8 *data, int size)
Duncan Sands1b0e6142005-05-11 20:19:29 +0200934{
935 int ret;
936 u8 *buf;
937 int offd, offb;
938 const int stride = CMD_PACKET_SIZE - 8;
939
940 buf = (u8 *) __get_free_page(GFP_KERNEL);
941 if (!buf)
942 return -ENOMEM;
943
944 offb = offd = 0;
945 do {
946 int l = min_t(int, stride, size - offd);
947 buf[offb++] = fw;
948 buf[offb++] = l;
949 buf[offb++] = code1;
950 buf[offb++] = code2;
Al Virofd05e722008-04-28 07:00:16 +0100951 put_unaligned(cpu_to_le32(addr), (__le32 *)(buf + offb));
Duncan Sands1b0e6142005-05-11 20:19:29 +0200952 offb += 4;
953 addr += l;
954 if(l)
955 memcpy(buf + offb, data + offd, l);
956 if (l < stride)
957 memset(buf + offb + l, 0, stride - l);
958 offb += stride;
959 offd += stride;
960 if ((offb >= PAGE_SIZE) || (offd >= size)) {
961 ret = usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD),
962 buf, offb, NULL, CMD_TIMEOUT);
963 if (ret < 0) {
964 dbg("sending fw %#x failed", fw);
965 goto cleanup;
966 }
967 offb = 0;
968 }
969 } while(offd < size);
970 dbg("sent fw %#x", fw);
971
972 ret = 0;
973
974cleanup:
975 free_page((unsigned long) buf);
976 return ret;
977}
978
979static void cxacru_upload_firmware(struct cxacru_data *instance,
980 const struct firmware *fw,
981 const struct firmware *bp,
982 const struct firmware *cf)
983{
984 int ret;
985 int off;
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100986 struct usbatm_data *usbatm = instance->usbatm;
987 struct usb_device *usb_dev = usbatm->usb_dev;
Al Virofd05e722008-04-28 07:00:16 +0100988 __le16 signature[] = { usb_dev->descriptor.idVendor,
989 usb_dev->descriptor.idProduct };
990 __le32 val;
Duncan Sands1b0e6142005-05-11 20:19:29 +0200991
992 dbg("cxacru_upload_firmware");
993
994 /* FirmwarePllFClkValue */
995 val = cpu_to_le32(instance->modem_type->pll_f_clk);
996 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLFCLK_ADDR, (u8 *) &val, 4);
997 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +0100998 usb_err(usbatm, "FirmwarePllFClkValue failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +0200999 return;
1000 }
1001
1002 /* FirmwarePllBClkValue */
1003 val = cpu_to_le32(instance->modem_type->pll_b_clk);
1004 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, PLLBCLK_ADDR, (u8 *) &val, 4);
1005 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001006 usb_err(usbatm, "FirmwarePllBClkValue failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001007 return;
1008 }
1009
1010 /* Enable SDRAM */
1011 val = cpu_to_le32(SDRAM_ENA);
1012 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SDRAMEN_ADDR, (u8 *) &val, 4);
1013 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001014 usb_err(usbatm, "Enable SDRAM failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001015 return;
1016 }
1017
1018 /* Firmware */
Simon Arlott885582c2009-11-21 15:12:56 +00001019 usb_info(usbatm, "loading firmware\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +02001020 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, FW_ADDR, fw->data, fw->size);
1021 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001022 usb_err(usbatm, "Firmware upload failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001023 return;
1024 }
1025
1026 /* Boot ROM patch */
1027 if (instance->modem_type->boot_rom_patch) {
Simon Arlott885582c2009-11-21 15:12:56 +00001028 usb_info(usbatm, "loading boot ROM patch\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +02001029 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_ADDR, bp->data, bp->size);
1030 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001031 usb_err(usbatm, "Boot ROM patching failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001032 return;
1033 }
1034 }
1035
1036 /* Signature */
1037 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, SIG_ADDR, (u8 *) signature, 4);
1038 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001039 usb_err(usbatm, "Signature storing failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001040 return;
1041 }
1042
Simon Arlott885582c2009-11-21 15:12:56 +00001043 usb_info(usbatm, "starting device\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +02001044 if (instance->modem_type->boot_rom_patch) {
1045 val = cpu_to_le32(BR_ADDR);
1046 ret = cxacru_fw(usb_dev, FW_WRITE_MEM, 0x2, 0x0, BR_STACK_ADDR, (u8 *) &val, 4);
1047 }
1048 else {
1049 ret = cxacru_fw(usb_dev, FW_GOTO_MEM, 0x0, 0x0, FW_ADDR, NULL, 0);
1050 }
1051 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001052 usb_err(usbatm, "Passing control to firmware failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001053 return;
1054 }
1055
1056 /* Delay to allow firmware to start up. */
1057 msleep_interruptible(1000);
1058
1059 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_CMD));
1060 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_CMD));
1061 usb_clear_halt(usb_dev, usb_sndbulkpipe(usb_dev, CXACRU_EP_DATA));
1062 usb_clear_halt(usb_dev, usb_rcvbulkpipe(usb_dev, CXACRU_EP_DATA));
1063
1064 ret = cxacru_cm(instance, CM_REQUEST_CARD_GET_STATUS, NULL, 0, NULL, 0);
1065 if (ret < 0) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001066 usb_err(usbatm, "modem failed to initialize: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001067 return;
1068 }
1069
1070 /* Load config data (le32), doing one packet at a time */
1071 if (cf)
1072 for (off = 0; off < cf->size / 4; ) {
Al Virofd05e722008-04-28 07:00:16 +01001073 __le32 buf[CMD_PACKET_SIZE / 4 - 1];
Duncan Sands1b0e6142005-05-11 20:19:29 +02001074 int i, len = min_t(int, cf->size / 4 - off, CMD_PACKET_SIZE / 4 / 2 - 1);
1075 buf[0] = cpu_to_le32(len);
1076 for (i = 0; i < len; i++, off++) {
1077 buf[i * 2 + 1] = cpu_to_le32(off);
1078 memcpy(buf + i * 2 + 2, cf->data + off * 4, 4);
1079 }
1080 ret = cxacru_cm(instance, CM_REQUEST_CARD_DATA_SET,
1081 (u8 *) buf, len, NULL, 0);
1082 if (ret < 0) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001083 usb_err(usbatm, "load config data failed: %d\n", ret);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001084 return;
1085 }
1086 }
Duncan Sands1b0e6142005-05-11 20:19:29 +02001087}
1088
1089static int cxacru_find_firmware(struct cxacru_data *instance,
1090 char* phase, const struct firmware **fw_p)
1091{
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001092 struct usbatm_data *usbatm = instance->usbatm;
1093 struct device *dev = &usbatm->usb_intf->dev;
Duncan Sands1b0e6142005-05-11 20:19:29 +02001094 char buf[16];
1095
1096 sprintf(buf, "cxacru-%s.bin", phase);
1097 dbg("cxacru_find_firmware: looking for %s", buf);
1098
1099 if (request_firmware(fw_p, buf, dev)) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001100 usb_dbg(usbatm, "no stage %s firmware found\n", phase);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001101 return -ENOENT;
1102 }
1103
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001104 usb_info(usbatm, "found firmware %s\n", buf);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001105
1106 return 0;
1107}
1108
1109static int cxacru_heavy_init(struct usbatm_data *usbatm_instance,
1110 struct usb_interface *usb_intf)
1111{
Duncan Sands1b0e6142005-05-11 20:19:29 +02001112 const struct firmware *fw, *bp, *cf;
1113 struct cxacru_data *instance = usbatm_instance->driver_data;
1114
1115 int ret = cxacru_find_firmware(instance, "fw", &fw);
1116 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001117 usb_warn(usbatm_instance, "firmware (cxacru-fw.bin) unavailable (system misconfigured?)\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +02001118 return ret;
1119 }
1120
1121 if (instance->modem_type->boot_rom_patch) {
1122 ret = cxacru_find_firmware(instance, "bp", &bp);
1123 if (ret) {
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001124 usb_warn(usbatm_instance, "boot ROM patch (cxacru-bp.bin) unavailable (system misconfigured?)\n");
Duncan Sands1b0e6142005-05-11 20:19:29 +02001125 release_firmware(fw);
1126 return ret;
1127 }
1128 }
1129
1130 if (cxacru_find_firmware(instance, "cf", &cf)) /* optional */
1131 cf = NULL;
1132
1133 cxacru_upload_firmware(instance, fw, bp, cf);
1134
1135 if (cf)
1136 release_firmware(cf);
1137 if (instance->modem_type->boot_rom_patch)
1138 release_firmware(bp);
1139 release_firmware(fw);
1140
1141 ret = cxacru_card_status(instance);
1142 if (ret)
1143 dbg("modem initialisation failed");
1144 else
1145 dbg("done setting up the modem");
1146
1147 return ret;
1148}
1149
1150static int cxacru_bind(struct usbatm_data *usbatm_instance,
Duncan Sands35644b02006-01-17 11:16:13 +01001151 struct usb_interface *intf, const struct usb_device_id *id)
Duncan Sands1b0e6142005-05-11 20:19:29 +02001152{
1153 struct cxacru_data *instance;
1154 struct usb_device *usb_dev = interface_to_usbdev(intf);
1155 int ret;
1156
1157 /* instance init */
Duncan Sands9a734ef2006-01-13 09:38:22 +01001158 instance = kzalloc(sizeof(*instance), GFP_KERNEL);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001159 if (!instance) {
1160 dbg("cxacru_bind: no memory for instance data");
1161 return -ENOMEM;
1162 }
1163
Duncan Sands1b0e6142005-05-11 20:19:29 +02001164 instance->usbatm = usbatm_instance;
1165 instance->modem_type = (struct cxacru_modem_type *) id->driver_info;
1166
Simon Arlott6a02c9962007-04-26 00:38:05 -07001167 mutex_init(&instance->poll_state_serialize);
1168 instance->poll_state = CXPOLL_STOPPED;
1169 instance->line_status = -1;
1170 instance->adsl_status = -1;
1171
1172 mutex_init(&instance->adsl_state_serialize);
1173
Duncan Sands1b0e6142005-05-11 20:19:29 +02001174 instance->rcv_buf = (u8 *) __get_free_page(GFP_KERNEL);
1175 if (!instance->rcv_buf) {
1176 dbg("cxacru_bind: no memory for rcv_buf");
1177 ret = -ENOMEM;
1178 goto fail;
1179 }
1180 instance->snd_buf = (u8 *) __get_free_page(GFP_KERNEL);
1181 if (!instance->snd_buf) {
1182 dbg("cxacru_bind: no memory for snd_buf");
1183 ret = -ENOMEM;
1184 goto fail;
1185 }
1186 instance->rcv_urb = usb_alloc_urb(0, GFP_KERNEL);
1187 if (!instance->rcv_urb) {
1188 dbg("cxacru_bind: no memory for rcv_urb");
1189 ret = -ENOMEM;
1190 goto fail;
1191 }
1192 instance->snd_urb = usb_alloc_urb(0, GFP_KERNEL);
1193 if (!instance->snd_urb) {
1194 dbg("cxacru_bind: no memory for snd_urb");
1195 ret = -ENOMEM;
1196 goto fail;
1197 }
1198
1199 usb_fill_int_urb(instance->rcv_urb,
1200 usb_dev, usb_rcvintpipe(usb_dev, CXACRU_EP_CMD),
1201 instance->rcv_buf, PAGE_SIZE,
1202 cxacru_blocking_completion, &instance->rcv_done, 1);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001203
1204 usb_fill_int_urb(instance->snd_urb,
1205 usb_dev, usb_sndintpipe(usb_dev, CXACRU_EP_CMD),
1206 instance->snd_buf, PAGE_SIZE,
1207 cxacru_blocking_completion, &instance->snd_done, 4);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001208
Arjan van de Venab3c81f2006-01-13 15:52:55 +01001209 mutex_init(&instance->cm_serialize);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001210
David Howellsc4028952006-11-22 14:57:56 +00001211 INIT_DELAYED_WORK(&instance->poll_work, cxacru_poll_status);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001212
1213 usbatm_instance->driver_data = instance;
1214
Duncan Sands35644b02006-01-17 11:16:13 +01001215 usbatm_instance->flags = (cxacru_card_status(instance) ? 0 : UDSL_SKIP_HEAVY_INIT);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001216
1217 return 0;
1218
1219 fail:
1220 free_page((unsigned long) instance->snd_buf);
1221 free_page((unsigned long) instance->rcv_buf);
1222 usb_free_urb(instance->snd_urb);
1223 usb_free_urb(instance->rcv_urb);
1224 kfree(instance);
1225
1226 return ret;
1227}
1228
1229static void cxacru_unbind(struct usbatm_data *usbatm_instance,
1230 struct usb_interface *intf)
1231{
1232 struct cxacru_data *instance = usbatm_instance->driver_data;
Simon Arlott6a02c9962007-04-26 00:38:05 -07001233 int is_polling = 1;
Duncan Sands1b0e6142005-05-11 20:19:29 +02001234
1235 dbg("cxacru_unbind entered");
1236
1237 if (!instance) {
1238 dbg("cxacru_unbind: NULL instance!");
1239 return;
1240 }
1241
Simon Arlott6a02c9962007-04-26 00:38:05 -07001242 mutex_lock(&instance->poll_state_serialize);
1243 BUG_ON(instance->poll_state == CXPOLL_SHUTDOWN);
1244
1245 /* ensure that status polling continues unless
1246 * it has already stopped */
1247 if (instance->poll_state == CXPOLL_STOPPED)
1248 is_polling = 0;
1249
1250 /* stop polling from being stopped or started */
1251 instance->poll_state = CXPOLL_SHUTDOWN;
1252 mutex_unlock(&instance->poll_state_serialize);
1253
1254 if (is_polling)
1255 cancel_rearming_delayed_work(&instance->poll_work);
Duncan Sands1b0e6142005-05-11 20:19:29 +02001256
1257 usb_kill_urb(instance->snd_urb);
1258 usb_kill_urb(instance->rcv_urb);
1259 usb_free_urb(instance->snd_urb);
1260 usb_free_urb(instance->rcv_urb);
1261
1262 free_page((unsigned long) instance->snd_buf);
1263 free_page((unsigned long) instance->rcv_buf);
Simon Arlottfa70fe42007-03-06 02:47:45 -08001264
Duncan Sands1b0e6142005-05-11 20:19:29 +02001265 kfree(instance);
1266
1267 usbatm_instance->driver_data = NULL;
1268}
1269
1270static const struct cxacru_modem_type cxacru_cafe = {
1271 .pll_f_clk = 0x02d874df,
1272 .pll_b_clk = 0x0196a51a,
1273 .boot_rom_patch = 1,
1274};
1275
1276static const struct cxacru_modem_type cxacru_cb00 = {
1277 .pll_f_clk = 0x5,
1278 .pll_b_clk = 0x3,
1279 .boot_rom_patch = 0,
1280};
1281
1282static const struct usb_device_id cxacru_usb_ids[] = {
1283 { /* V = Conexant P = ADSL modem (Euphrates project) */
1284 USB_DEVICE(0x0572, 0xcafe), .driver_info = (unsigned long) &cxacru_cafe
1285 },
1286 { /* V = Conexant P = ADSL modem (Hasbani project) */
1287 USB_DEVICE(0x0572, 0xcb00), .driver_info = (unsigned long) &cxacru_cb00
1288 },
Duncan Sands1b0e6142005-05-11 20:19:29 +02001289 { /* V = Conexant P = ADSL modem */
1290 USB_DEVICE(0x0572, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1291 },
Duncan Sands0ec3c7e2006-01-17 11:15:13 +01001292 { /* V = Conexant P = ADSL modem (Well PTI-800) */
1293 USB_DEVICE(0x0572, 0xcb02), .driver_info = (unsigned long) &cxacru_cb00
1294 },
Duncan Sands1b0e6142005-05-11 20:19:29 +02001295 { /* V = Conexant P = ADSL modem */
1296 USB_DEVICE(0x0572, 0xcb06), .driver_info = (unsigned long) &cxacru_cb00
1297 },
Duncan Sands44960af2006-10-05 11:05:50 +02001298 { /* V = Conexant P = ADSL modem (ZTE ZXDSL 852) */
1299 USB_DEVICE(0x0572, 0xcb07), .driver_info = (unsigned long) &cxacru_cb00
1300 },
Duncan Sands1b0e6142005-05-11 20:19:29 +02001301 { /* V = Olitec P = ADSL modem version 2 */
1302 USB_DEVICE(0x08e3, 0x0100), .driver_info = (unsigned long) &cxacru_cafe
1303 },
1304 { /* V = Olitec P = ADSL modem version 3 */
1305 USB_DEVICE(0x08e3, 0x0102), .driver_info = (unsigned long) &cxacru_cb00
1306 },
1307 { /* V = Trust/Amigo Technology Co. P = AMX-CA86U */
1308 USB_DEVICE(0x0eb0, 0x3457), .driver_info = (unsigned long) &cxacru_cafe
1309 },
1310 { /* V = Zoom P = 5510 */
1311 USB_DEVICE(0x1803, 0x5510), .driver_info = (unsigned long) &cxacru_cb00
1312 },
1313 { /* V = Draytek P = Vigor 318 */
1314 USB_DEVICE(0x0675, 0x0200), .driver_info = (unsigned long) &cxacru_cb00
1315 },
1316 { /* V = Zyxel P = 630-C1 aka OMNI ADSL USB (Annex A) */
1317 USB_DEVICE(0x0586, 0x330a), .driver_info = (unsigned long) &cxacru_cb00
1318 },
1319 { /* V = Zyxel P = 630-C3 aka OMNI ADSL USB (Annex B) */
1320 USB_DEVICE(0x0586, 0x330b), .driver_info = (unsigned long) &cxacru_cb00
1321 },
1322 { /* V = Aethra P = Starmodem UM1020 */
1323 USB_DEVICE(0x0659, 0x0020), .driver_info = (unsigned long) &cxacru_cb00
1324 },
1325 { /* V = Aztech Systems P = ? AKA Pirelli AUA-010 */
1326 USB_DEVICE(0x0509, 0x0812), .driver_info = (unsigned long) &cxacru_cb00
1327 },
1328 { /* V = Netopia P = Cayman 3341(Annex A)/3351(Annex B) */
1329 USB_DEVICE(0x100d, 0xcb01), .driver_info = (unsigned long) &cxacru_cb00
1330 },
1331 { /* V = Netopia P = Cayman 3342(Annex A)/3352(Annex B) */
1332 USB_DEVICE(0x100d, 0x3342), .driver_info = (unsigned long) &cxacru_cb00
1333 },
1334 {}
1335};
1336
1337MODULE_DEVICE_TABLE(usb, cxacru_usb_ids);
1338
1339static struct usbatm_driver cxacru_driver = {
Duncan Sands1b0e6142005-05-11 20:19:29 +02001340 .driver_name = cxacru_driver_name,
1341 .bind = cxacru_bind,
1342 .heavy_init = cxacru_heavy_init,
1343 .unbind = cxacru_unbind,
1344 .atm_start = cxacru_atm_start,
Simon Arlottda1f82b52007-05-10 23:04:12 -07001345 .atm_stop = cxacru_remove_device_files,
Duncan Sands80aae7a2006-01-13 10:59:23 +01001346 .bulk_in = CXACRU_EP_DATA,
1347 .bulk_out = CXACRU_EP_DATA,
Duncan Sands1b0e6142005-05-11 20:19:29 +02001348 .rx_padding = 3,
1349 .tx_padding = 11,
1350};
1351
1352static int cxacru_usb_probe(struct usb_interface *intf, const struct usb_device_id *id)
1353{
1354 return usbatm_usb_probe(intf, id, &cxacru_driver);
1355}
1356
1357static struct usb_driver cxacru_usb_driver = {
Duncan Sands1b0e6142005-05-11 20:19:29 +02001358 .name = cxacru_driver_name,
1359 .probe = cxacru_usb_probe,
1360 .disconnect = usbatm_usb_disconnect,
1361 .id_table = cxacru_usb_ids
1362};
1363
1364static int __init cxacru_init(void)
1365{
1366 return usb_register(&cxacru_usb_driver);
1367}
1368
1369static void __exit cxacru_cleanup(void)
1370{
1371 usb_deregister(&cxacru_usb_driver);
1372}
1373
1374module_init(cxacru_init);
1375module_exit(cxacru_cleanup);
1376
1377MODULE_AUTHOR(DRIVER_AUTHOR);
1378MODULE_DESCRIPTION(DRIVER_DESC);
1379MODULE_LICENSE("GPL");
1380MODULE_VERSION(DRIVER_VERSION);