aboutsummaryrefslogtreecommitdiffstats
path: root/drivers/net/usb/zaurus.c
diff options
context:
space:
mode:
authorJeff Garzik <jeff@garzik.org>2007-05-09 21:31:55 -0400
committerJeff Garzik <jeff@garzik.org>2007-05-09 21:31:55 -0400
commit5b2fc499917e5897a13add780e181b4cef197072 (patch)
tree1a1ba52c0c2a7ce9843875cdd713d75d37c4ea1b /drivers/net/usb/zaurus.c
parent3cb7396b7b26585b1ab7c1a8ca554ec103da5d37 (diff)
Move USB network drivers to drivers/net/usb.
It is preferable to group drivers by usage (net, scsi, ATA, ...) than by bus. When reviewing drivers, the [PCI|USB|PCMCIA|...] maintainer is probably less qualified on networking issues than a networking maintainer. Also, from a practical standpoint, chips often appear on multiple buses, which is why we do not put drivers into drivers/pci/net. Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de> Signed-off-by: Jeff Garzik <jeff@garzik.org>
Diffstat (limited to 'drivers/net/usb/zaurus.c')
-rw-r--r--drivers/net/usb/zaurus.c385
1 files changed, 385 insertions, 0 deletions
diff --git a/drivers/net/usb/zaurus.c b/drivers/net/usb/zaurus.c
new file mode 100644
index 000000000000..9f98e8ce487a
--- /dev/null
+++ b/drivers/net/usb/zaurus.c
@@ -0,0 +1,385 @@
1/*
2 * Copyright (C) 2002 Pavel Machek <pavel@ucw.cz>
3 * Copyright (C) 2002-2005 by David Brownell
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 */
19
20// #define DEBUG // error path messages, extra info
21// #define VERBOSE // more; success messages
22
23#include <linux/module.h>
24#include <linux/init.h>
25#include <linux/netdevice.h>
26#include <linux/ethtool.h>
27#include <linux/workqueue.h>
28#include <linux/mii.h>
29#include <linux/crc32.h>
30#include <linux/usb.h>
31#include <linux/usb/cdc.h>
32
33#include "usbnet.h"
34
35
36/*
37 * All known Zaurii lie about their standards conformance. At least
38 * the earliest SA-1100 models lie by saying they support CDC Ethernet.
39 * Some later models (especially PXA-25x and PXA-27x based ones) lie
40 * and say they support CDC MDLM (for access to cell phone modems).
41 *
42 * There are non-Zaurus products that use these same protocols too.
43 *
44 * The annoying thing is that at the same time Sharp was developing
45 * that annoying standards-breaking software, the Linux community had
46 * a simple "CDC Subset" working reliably on the same SA-1100 hardware.
47 * That is, the same functionality but not violating standards.
48 *
49 * The CDC Ethernet nonconformance points are troublesome to hosts
50 * with a true CDC Ethernet implementation:
51 * - Framing appends a CRC, which the spec says drivers "must not" do;
52 * - Transfers data in altsetting zero, instead of altsetting 1;
53 * - All these peripherals use the same ethernet address.
54 *
55 * The CDC MDLM nonconformance is less immediately troublesome, since all
56 * MDLM implementations are quasi-proprietary anyway.
57 */
58
59static struct sk_buff *
60zaurus_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
61{
62 int padlen;
63 struct sk_buff *skb2;
64
65 padlen = 2;
66 if (!skb_cloned(skb)) {
67 int tailroom = skb_tailroom(skb);
68 if ((padlen + 4) <= tailroom)
69 goto done;
70 }
71 skb2 = skb_copy_expand(skb, 0, 4 + padlen, flags);
72 dev_kfree_skb_any(skb);
73 skb = skb2;
74 if (skb) {
75 u32 fcs;
76done:
77 fcs = crc32_le(~0, skb->data, skb->len);
78 fcs = ~fcs;
79
80 *skb_put (skb, 1) = fcs & 0xff;
81 *skb_put (skb, 1) = (fcs>> 8) & 0xff;
82 *skb_put (skb, 1) = (fcs>>16) & 0xff;
83 *skb_put (skb, 1) = (fcs>>24) & 0xff;
84 }
85 return skb;
86}
87
88static int zaurus_bind(struct usbnet *dev, struct usb_interface *intf)
89{
90 /* Belcarra's funky framing has other options; mostly
91 * TRAILERS (!) with 4 bytes CRC, and maybe 2 pad bytes.
92 */
93 dev->net->hard_header_len += 6;
94 dev->rx_urb_size = dev->net->hard_header_len + dev->net->mtu;
95 return usbnet_generic_cdc_bind(dev, intf);
96}
97
98/* PDA style devices are always connected if present */
99static int always_connected (struct usbnet *dev)
100{
101 return 0;
102}
103
104static const struct driver_info zaurus_sl5x00_info = {
105 .description = "Sharp Zaurus SL-5x00",
106 .flags = FLAG_FRAMING_Z,
107 .check_connect = always_connected,
108 .bind = zaurus_bind,
109 .unbind = usbnet_cdc_unbind,
110 .tx_fixup = zaurus_tx_fixup,
111};
112#define ZAURUS_STRONGARM_INFO ((unsigned long)&zaurus_sl5x00_info)
113
114static const struct driver_info zaurus_pxa_info = {
115 .description = "Sharp Zaurus, PXA-2xx based",
116 .flags = FLAG_FRAMING_Z,
117 .check_connect = always_connected,
118 .bind = zaurus_bind,
119 .unbind = usbnet_cdc_unbind,
120 .tx_fixup = zaurus_tx_fixup,
121};
122#define ZAURUS_PXA_INFO ((unsigned long)&zaurus_pxa_info)
123
124static const struct driver_info olympus_mxl_info = {
125 .description = "Olympus R1000",
126 .flags = FLAG_FRAMING_Z,
127 .check_connect = always_connected,
128 .bind = zaurus_bind,
129 .unbind = usbnet_cdc_unbind,
130 .tx_fixup = zaurus_tx_fixup,
131};
132#define OLYMPUS_MXL_INFO ((unsigned long)&olympus_mxl_info)
133
134
135/* Some more recent products using Lineo/Belcarra code will wrongly claim
136 * CDC MDLM conformance. They aren't conformant: data endpoints live
137 * in the control interface, there's no data interface, and it's not used
138 * to talk to a cell phone radio. But at least we can detect these two
139 * pseudo-classes, rather than growing this product list with entries for
140 * each new nonconformant product (sigh).
141 */
142static const u8 safe_guid[16] = {
143 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
144 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
145};
146static const u8 blan_guid[16] = {
147 0x74, 0xf0, 0x3d, 0xbd, 0x1e, 0xc1, 0x44, 0x70,
148 0xa3, 0x67, 0x71, 0x34, 0xc9, 0xf5, 0x54, 0x37,
149};
150
151static int blan_mdlm_bind(struct usbnet *dev, struct usb_interface *intf)
152{
153 u8 *buf = intf->cur_altsetting->extra;
154 int len = intf->cur_altsetting->extralen;
155 struct usb_cdc_mdlm_desc *desc = NULL;
156 struct usb_cdc_mdlm_detail_desc *detail = NULL;
157
158 while (len > 3) {
159 if (buf [1] != USB_DT_CS_INTERFACE)
160 goto next_desc;
161
162 /* use bDescriptorSubType, and just verify that we get a
163 * "BLAN" (or "SAFE") descriptor.
164 */
165 switch (buf [2]) {
166 case USB_CDC_MDLM_TYPE:
167 if (desc) {
168 dev_dbg(&intf->dev, "extra MDLM\n");
169 goto bad_desc;
170 }
171 desc = (void *) buf;
172 if (desc->bLength != sizeof *desc) {
173 dev_dbg(&intf->dev, "MDLM len %u\n",
174 desc->bLength);
175 goto bad_desc;
176 }
177 /* expect bcdVersion 1.0, ignore */
178 if (memcmp(&desc->bGUID, blan_guid, 16)
179 && memcmp(&desc->bGUID, safe_guid, 16) ) {
180 /* hey, this one might _really_ be MDLM! */
181 dev_dbg(&intf->dev, "MDLM guid\n");
182 goto bad_desc;
183 }
184 break;
185 case USB_CDC_MDLM_DETAIL_TYPE:
186 if (detail) {
187 dev_dbg(&intf->dev, "extra MDLM detail\n");
188 goto bad_desc;
189 }
190 detail = (void *) buf;
191 switch (detail->bGuidDescriptorType) {
192 case 0: /* "SAFE" */
193 if (detail->bLength != (sizeof *detail + 2))
194 goto bad_detail;
195 break;
196 case 1: /* "BLAN" */
197 if (detail->bLength != (sizeof *detail + 3))
198 goto bad_detail;
199 break;
200 default:
201 goto bad_detail;
202 }
203
204 /* assuming we either noticed BLAN already, or will
205 * find it soon, there are some data bytes here:
206 * - bmNetworkCapabilities (unused)
207 * - bmDataCapabilities (bits, see below)
208 * - bPad (ignored, for PADAFTER -- BLAN-only)
209 * bits are:
210 * - 0x01 -- Zaurus framing (add CRC)
211 * - 0x02 -- PADBEFORE (CRC includes some padding)
212 * - 0x04 -- PADAFTER (some padding after CRC)
213 * - 0x08 -- "fermat" packet mangling (for hw bugs)
214 * the PADBEFORE appears not to matter; we interop
215 * with devices that use it and those that don't.
216 */
217 if ((detail->bDetailData[1] & ~0x02) != 0x01) {
218 /* bmDataCapabilities == 0 would be fine too,
219 * but framing is minidriver-coupled for now.
220 */
221bad_detail:
222 dev_dbg(&intf->dev,
223 "bad MDLM detail, %d %d %d\n",
224 detail->bLength,
225 detail->bDetailData[0],
226 detail->bDetailData[2]);
227 goto bad_desc;
228 }
229
230 /* same extra framing as for non-BLAN mode */
231 dev->net->hard_header_len += 6;
232 dev->rx_urb_size = dev->net->hard_header_len
233 + dev->net->mtu;
234 break;
235 }
236next_desc:
237 len -= buf [0]; /* bLength */
238 buf += buf [0];
239 }
240
241 if (!desc || !detail) {
242 dev_dbg(&intf->dev, "missing cdc mdlm %s%sdescriptor\n",
243 desc ? "" : "func ",
244 detail ? "" : "detail ");
245 goto bad_desc;
246 }
247
248 /* There's probably a CDC Ethernet descriptor there, but we can't
249 * rely on the Ethernet address it provides since not all vendors
250 * bother to make it unique. Likewise there's no point in tracking
251 * of the CDC event notifications.
252 */
253 return usbnet_get_endpoints(dev, intf);
254
255bad_desc:
256 dev_info(&dev->udev->dev, "unsupported MDLM descriptors\n");
257 return -ENODEV;
258}
259
260static const struct driver_info bogus_mdlm_info = {
261 .description = "pseudo-MDLM (BLAN) device",
262 .flags = FLAG_FRAMING_Z,
263 .check_connect = always_connected,
264 .tx_fixup = zaurus_tx_fixup,
265 .bind = blan_mdlm_bind,
266};
267
268static const struct usb_device_id products [] = {
269#define ZAURUS_MASTER_INTERFACE \
270 .bInterfaceClass = USB_CLASS_COMM, \
271 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
272 .bInterfaceProtocol = USB_CDC_PROTO_NONE
273
274/* SA-1100 based Sharp Zaurus ("collie"), or compatible. */
275{
276 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
277 | USB_DEVICE_ID_MATCH_DEVICE,
278 .idVendor = 0x04DD,
279 .idProduct = 0x8004,
280 ZAURUS_MASTER_INTERFACE,
281 .driver_info = ZAURUS_STRONGARM_INFO,
282},
283
284/* PXA-2xx based models are also lying-about-cdc. If you add any
285 * more devices that claim to be CDC Ethernet, make sure they get
286 * added to the blacklist in cdc_ether too.
287 *
288 * NOTE: OpenZaurus versions with 2.6 kernels won't use these entries,
289 * unlike the older ones with 2.4 "embedix" kernels.
290 */
291{
292 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
293 | USB_DEVICE_ID_MATCH_DEVICE,
294 .idVendor = 0x04DD,
295 .idProduct = 0x8005, /* A-300 */
296 ZAURUS_MASTER_INTERFACE,
297 .driver_info = ZAURUS_PXA_INFO,
298}, {
299 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
300 | USB_DEVICE_ID_MATCH_DEVICE,
301 .idVendor = 0x04DD,
302 .idProduct = 0x8006, /* B-500/SL-5600 */
303 ZAURUS_MASTER_INTERFACE,
304 .driver_info = ZAURUS_PXA_INFO,
305}, {
306 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
307 | USB_DEVICE_ID_MATCH_DEVICE,
308 .idVendor = 0x04DD,
309 .idProduct = 0x8007, /* C-700 */
310 ZAURUS_MASTER_INTERFACE,
311 .driver_info = ZAURUS_PXA_INFO,
312}, {
313 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
314 | USB_DEVICE_ID_MATCH_DEVICE,
315 .idVendor = 0x04DD,
316 .idProduct = 0x9031, /* C-750 C-760 */
317 ZAURUS_MASTER_INTERFACE,
318 .driver_info = ZAURUS_PXA_INFO,
319}, {
320 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
321 | USB_DEVICE_ID_MATCH_DEVICE,
322 .idVendor = 0x04DD,
323 .idProduct = 0x9032, /* SL-6000 */
324 ZAURUS_MASTER_INTERFACE,
325 .driver_info = ZAURUS_PXA_INFO,
326}, {
327 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
328 | USB_DEVICE_ID_MATCH_DEVICE,
329 .idVendor = 0x04DD,
330 /* reported with some C860 units */
331 .idProduct = 0x9050, /* C-860 */
332 ZAURUS_MASTER_INTERFACE,
333 .driver_info = ZAURUS_PXA_INFO,
334},
335
336
337/* At least some of the newest PXA units have very different lies about
338 * their standards support: they claim to be cell phones offering
339 * direct access to their radios! (No, they don't conform to CDC MDLM.)
340 */
341{
342 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
343 USB_CDC_PROTO_NONE),
344 .driver_info = (unsigned long) &bogus_mdlm_info,
345},
346
347/* Olympus has some models with a Zaurus-compatible option.
348 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
349 */
350{
351 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
352 | USB_DEVICE_ID_MATCH_DEVICE,
353 .idVendor = 0x07B4,
354 .idProduct = 0x0F02, /* R-1000 */
355 ZAURUS_MASTER_INTERFACE,
356 .driver_info = OLYMPUS_MXL_INFO,
357},
358 { }, // END
359};
360MODULE_DEVICE_TABLE(usb, products);
361
362static struct usb_driver zaurus_driver = {
363 .name = "zaurus",
364 .id_table = products,
365 .probe = usbnet_probe,
366 .disconnect = usbnet_disconnect,
367 .suspend = usbnet_suspend,
368 .resume = usbnet_resume,
369};
370
371static int __init zaurus_init(void)
372{
373 return usb_register(&zaurus_driver);
374}
375module_init(zaurus_init);
376
377static void __exit zaurus_exit(void)
378{
379 usb_deregister(&zaurus_driver);
380}
381module_exit(zaurus_exit);
382
383MODULE_AUTHOR("Pavel Machek, David Brownell");
384MODULE_DESCRIPTION("Sharp Zaurus PDA, and compatible products");
385MODULE_LICENSE("GPL");