2 * Driver for USB ethernet port of Conexant CX82310-based ADSL routers
3 * Copyright (C) 2010 by Ondrej Zary
4 * some parts inspired by the cxacru driver
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, see <http://www.gnu.org/licenses/>.
20 #include <linux/module.h>
21 #include <linux/netdevice.h>
22 #include <linux/etherdevice.h>
23 #include <linux/ethtool.h>
24 #include <linux/workqueue.h>
25 #include <linux/mii.h>
26 #include <linux/usb.h>
27 #include <linux/usb/usbnet.h>
30 CMD_START
= 0x84, /* no effect? */
31 CMD_STOP
= 0x85, /* no effect? */
32 CMD_GET_STATUS
= 0x90, /* returns nothing? */
33 CMD_GET_MAC_ADDR
= 0x91, /* read MAC address */
34 CMD_GET_LINK_STATUS
= 0x92, /* not useful, link is always up */
35 CMD_ETHERNET_MODE
= 0x99, /* unknown, needed during init */
44 STATUS_PARAMETER_ERROR
,
48 #define CMD_PACKET_SIZE 64
49 #define CMD_TIMEOUT 100
50 #define CMD_REPLY_RETRY 5
52 #define CX82310_MTU 1514
56 * execute control command
57 * - optionally send some data (command parameters)
58 * - optionally wait for the reply
59 * - optionally read some data from the reply
61 static int cx82310_cmd(struct usbnet
*dev
, enum cx82310_cmd cmd
, bool reply
,
62 u8
*wdata
, int wlen
, u8
*rdata
, int rlen
)
64 int actual_len
, retries
, ret
;
65 struct usb_device
*udev
= dev
->udev
;
66 u8
*buf
= kzalloc(CMD_PACKET_SIZE
, GFP_KERNEL
);
71 /* create command packet */
74 memcpy(buf
+ 4, wdata
, min_t(int, wlen
, CMD_PACKET_SIZE
- 4));
76 /* send command packet */
77 ret
= usb_bulk_msg(udev
, usb_sndbulkpipe(udev
, CMD_EP
), buf
,
78 CMD_PACKET_SIZE
, &actual_len
, CMD_TIMEOUT
);
80 if (cmd
!= CMD_GET_LINK_STATUS
)
81 dev_err(&dev
->udev
->dev
, "send command %#x: error %d\n",
87 /* wait for reply, retry if it's empty */
88 for (retries
= 0; retries
< CMD_REPLY_RETRY
; retries
++) {
89 ret
= usb_bulk_msg(udev
, usb_rcvbulkpipe(udev
, CMD_EP
),
90 buf
, CMD_PACKET_SIZE
, &actual_len
,
93 if (cmd
!= CMD_GET_LINK_STATUS
)
94 dev_err(&dev
->udev
->dev
,
95 "reply receive error %d\n",
102 if (actual_len
== 0) {
103 dev_err(&dev
->udev
->dev
, "no reply to command %#x\n",
109 dev_err(&dev
->udev
->dev
,
110 "got reply to command %#x, expected: %#x\n",
115 if (buf
[1] != STATUS_SUCCESS
) {
116 dev_err(&dev
->udev
->dev
, "command %#x failed: %#x\n",
122 memcpy(rdata
, buf
+ 4,
123 min_t(int, rlen
, CMD_PACKET_SIZE
- 4));
130 #define partial_len data[0] /* length of partial packet data */
131 #define partial_rem data[1] /* remaining (missing) data length */
132 #define partial_data data[2] /* partial packet data */
134 static int cx82310_bind(struct usbnet
*dev
, struct usb_interface
*intf
)
138 struct usb_device
*udev
= dev
->udev
;
142 /* avoid ADSL modems - continue only if iProduct is "USB NET CARD" */
143 if (usb_string(udev
, udev
->descriptor
.iProduct
, buf
, sizeof(buf
)) > 0
144 && strcmp(buf
, "USB NET CARD")) {
145 dev_info(&udev
->dev
, "ignoring: probably an ADSL modem\n");
149 ret
= usbnet_get_endpoints(dev
, intf
);
154 * this must not include ethernet header as the device can send partial
155 * packets with no header (and sometimes even empty URBs)
157 dev
->net
->hard_header_len
= 0;
158 /* we can send at most 1514 bytes of data (+ 2-byte header) per URB */
159 dev
->hard_mtu
= CX82310_MTU
+ 2;
160 /* we can receive URBs up to 4KB from the device */
161 dev
->rx_urb_size
= 4096;
163 dev
->partial_data
= (unsigned long) kmalloc(dev
->hard_mtu
, GFP_KERNEL
);
164 if (!dev
->partial_data
)
167 /* wait for firmware to become ready (indicated by the link being up) */
169 ret
= cx82310_cmd(dev
, CMD_GET_LINK_STATUS
, true, NULL
, 0,
171 /* the command can time out during boot - it's not an error */
172 if (!ret
&& link
[0] == 1 && link
[2] == 1)
177 dev_err(&udev
->dev
, "firmware not ready in time\n");
181 /* enable ethernet mode (?) */
182 ret
= cx82310_cmd(dev
, CMD_ETHERNET_MODE
, true, "\x01", 1, NULL
, 0);
184 dev_err(&udev
->dev
, "unable to enable ethernet mode: %d\n",
189 /* get the MAC address */
190 ret
= cx82310_cmd(dev
, CMD_GET_MAC_ADDR
, true, NULL
, 0,
191 dev
->net
->dev_addr
, ETH_ALEN
);
193 dev_err(&udev
->dev
, "unable to read MAC address: %d\n", ret
);
197 /* start (does not seem to have any effect?) */
198 ret
= cx82310_cmd(dev
, CMD_START
, false, NULL
, 0, NULL
, 0);
204 kfree((void *)dev
->partial_data
);
208 static void cx82310_unbind(struct usbnet
*dev
, struct usb_interface
*intf
)
210 kfree((void *)dev
->partial_data
);
214 * RX is NOT easy - we can receive multiple packets per skb, each having 2-byte
215 * packet length at the beginning.
216 * The last packet might be incomplete (when it crosses the 4KB URB size),
217 * continuing in the next skb (without any headers).
218 * If a packet has odd length, there is one extra byte at the end (before next
219 * packet or at the end of the URB).
221 static int cx82310_rx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
)
224 struct sk_buff
*skb2
;
227 * If the last skb ended with an incomplete packet, this skb contains
228 * end of that packet at the beginning.
230 if (dev
->partial_rem
) {
231 len
= dev
->partial_len
+ dev
->partial_rem
;
232 skb2
= alloc_skb(len
, GFP_ATOMIC
);
236 memcpy(skb2
->data
, (void *)dev
->partial_data
,
238 memcpy(skb2
->data
+ dev
->partial_len
, skb
->data
,
240 usbnet_skb_return(dev
, skb2
);
241 skb_pull(skb
, (dev
->partial_rem
+ 1) & ~1);
242 dev
->partial_rem
= 0;
247 /* a skb can contain multiple packets */
248 while (skb
->len
> 1) {
249 /* first two bytes are packet length */
250 len
= skb
->data
[0] | (skb
->data
[1] << 8);
253 /* if last packet in the skb, let usbnet to process it */
254 if (len
== skb
->len
|| len
+ 1 == skb
->len
) {
259 if (len
> CX82310_MTU
) {
260 dev_err(&dev
->udev
->dev
, "RX packet too long: %d B\n",
265 /* incomplete packet, save it for the next skb */
266 if (len
> skb
->len
) {
267 dev
->partial_len
= skb
->len
;
268 dev
->partial_rem
= len
- skb
->len
;
269 memcpy((void *)dev
->partial_data
, skb
->data
,
271 skb_pull(skb
, skb
->len
);
275 skb2
= alloc_skb(len
, GFP_ATOMIC
);
279 memcpy(skb2
->data
, skb
->data
, len
);
280 /* process the packet */
281 usbnet_skb_return(dev
, skb2
);
283 skb_pull(skb
, (len
+ 1) & ~1);
286 /* let usbnet process the last packet */
290 /* TX is easy, just add 2 bytes of length at the beginning */
291 static struct sk_buff
*cx82310_tx_fixup(struct usbnet
*dev
, struct sk_buff
*skb
,
296 if (skb_cow_head(skb
, 2)) {
297 dev_kfree_skb_any(skb
);
303 skb
->data
[1] = len
>> 8;
309 static const struct driver_info cx82310_info
= {
310 .description
= "Conexant CX82310 USB ethernet",
312 .bind
= cx82310_bind
,
313 .unbind
= cx82310_unbind
,
314 .rx_fixup
= cx82310_rx_fixup
,
315 .tx_fixup
= cx82310_tx_fixup
,
318 #define USB_DEVICE_CLASS(vend, prod, cl, sc, pr) \
319 .match_flags = USB_DEVICE_ID_MATCH_DEVICE | \
320 USB_DEVICE_ID_MATCH_DEV_INFO, \
321 .idVendor = (vend), \
322 .idProduct = (prod), \
323 .bDeviceClass = (cl), \
324 .bDeviceSubClass = (sc), \
325 .bDeviceProtocol = (pr)
327 static const struct usb_device_id products
[] = {
329 USB_DEVICE_CLASS(0x0572, 0xcb01, 0xff, 0, 0),
330 .driver_info
= (unsigned long) &cx82310_info
334 MODULE_DEVICE_TABLE(usb
, products
);
336 static struct usb_driver cx82310_driver
= {
337 .name
= "cx82310_eth",
338 .id_table
= products
,
339 .probe
= usbnet_probe
,
340 .disconnect
= usbnet_disconnect
,
341 .suspend
= usbnet_suspend
,
342 .resume
= usbnet_resume
,
343 .disable_hub_initiated_lpm
= 1,
346 module_usb_driver(cx82310_driver
);
348 MODULE_AUTHOR("Ondrej Zary");
349 MODULE_DESCRIPTION("Conexant CX82310-based ADSL router USB ethernet driver");
350 MODULE_LICENSE("GPL");