blob: 241756e0e86f03e86a1b368408c761389967d8f8 [file] [log] [blame]
David Brownell0aa599c2005-08-31 09:53:58 -07001/*
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
David Brownell0aa599c2005-08-31 09:53:58 -070023#include <linux/module.h>
David Brownell0aa599c2005-08-31 09:53:58 -070024#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>
David Brownella8c28f22006-06-13 09:57:47 -070031#include <linux/usb/cdc.h>
Jussi Kivilinna3692e942008-01-26 00:51:45 +020032#include <linux/usb/usbnet.h>
David Brownell0aa599c2005-08-31 09:53:58 -070033
34
35/*
36 * All known Zaurii lie about their standards conformance. At least
37 * the earliest SA-1100 models lie by saying they support CDC Ethernet.
38 * Some later models (especially PXA-25x and PXA-27x based ones) lie
39 * and say they support CDC MDLM (for access to cell phone modems).
40 *
41 * There are non-Zaurus products that use these same protocols too.
42 *
43 * The annoying thing is that at the same time Sharp was developing
44 * that annoying standards-breaking software, the Linux community had
45 * a simple "CDC Subset" working reliably on the same SA-1100 hardware.
46 * That is, the same functionality but not violating standards.
47 *
48 * The CDC Ethernet nonconformance points are troublesome to hosts
49 * with a true CDC Ethernet implementation:
50 * - Framing appends a CRC, which the spec says drivers "must not" do;
51 * - Transfers data in altsetting zero, instead of altsetting 1;
52 * - All these peripherals use the same ethernet address.
53 *
54 * The CDC MDLM nonconformance is less immediately troublesome, since all
55 * MDLM implementations are quasi-proprietary anyway.
56 */
57
58static struct sk_buff *
Al Viro55016f12005-10-21 03:21:58 -040059zaurus_tx_fixup(struct usbnet *dev, struct sk_buff *skb, gfp_t flags)
David Brownell0aa599c2005-08-31 09:53:58 -070060{
61 int padlen;
62 struct sk_buff *skb2;
63
64 padlen = 2;
65 if (!skb_cloned(skb)) {
66 int tailroom = skb_tailroom(skb);
67 if ((padlen + 4) <= tailroom)
68 goto done;
69 }
70 skb2 = skb_copy_expand(skb, 0, 4 + padlen, flags);
71 dev_kfree_skb_any(skb);
72 skb = skb2;
73 if (skb) {
74 u32 fcs;
75done:
76 fcs = crc32_le(~0, skb->data, skb->len);
77 fcs = ~fcs;
78
79 *skb_put (skb, 1) = fcs & 0xff;
80 *skb_put (skb, 1) = (fcs>> 8) & 0xff;
81 *skb_put (skb, 1) = (fcs>>16) & 0xff;
82 *skb_put (skb, 1) = (fcs>>24) & 0xff;
83 }
84 return skb;
85}
86
87static int zaurus_bind(struct usbnet *dev, struct usb_interface *intf)
88{
89 /* Belcarra's funky framing has other options; mostly
90 * TRAILERS (!) with 4 bytes CRC, and maybe 2 pad bytes.
91 */
92 dev->net->hard_header_len += 6;
93 dev->rx_urb_size = dev->net->hard_header_len + dev->net->mtu;
94 return usbnet_generic_cdc_bind(dev, intf);
95}
96
97/* PDA style devices are always connected if present */
98static int always_connected (struct usbnet *dev)
99{
100 return 0;
101}
102
103static const struct driver_info zaurus_sl5x00_info = {
104 .description = "Sharp Zaurus SL-5x00",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700105 .flags = FLAG_POINTTOPOINT | FLAG_FRAMING_Z,
David Brownell0aa599c2005-08-31 09:53:58 -0700106 .check_connect = always_connected,
107 .bind = zaurus_bind,
108 .unbind = usbnet_cdc_unbind,
David Brownellf44f7252006-05-12 19:24:34 -0700109 .tx_fixup = zaurus_tx_fixup,
David Brownell0aa599c2005-08-31 09:53:58 -0700110};
111#define ZAURUS_STRONGARM_INFO ((unsigned long)&zaurus_sl5x00_info)
112
113static const struct driver_info zaurus_pxa_info = {
114 .description = "Sharp Zaurus, PXA-2xx based",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700115 .flags = FLAG_POINTTOPOINT | FLAG_FRAMING_Z,
David Brownell0aa599c2005-08-31 09:53:58 -0700116 .check_connect = always_connected,
117 .bind = zaurus_bind,
118 .unbind = usbnet_cdc_unbind,
David Brownellf44f7252006-05-12 19:24:34 -0700119 .tx_fixup = zaurus_tx_fixup,
David Brownell0aa599c2005-08-31 09:53:58 -0700120};
121#define ZAURUS_PXA_INFO ((unsigned long)&zaurus_pxa_info)
122
123static const struct driver_info olympus_mxl_info = {
124 .description = "Olympus R1000",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700125 .flags = FLAG_POINTTOPOINT | FLAG_FRAMING_Z,
David Brownell0aa599c2005-08-31 09:53:58 -0700126 .check_connect = always_connected,
127 .bind = zaurus_bind,
128 .unbind = usbnet_cdc_unbind,
David Brownellf44f7252006-05-12 19:24:34 -0700129 .tx_fixup = zaurus_tx_fixup,
David Brownell0aa599c2005-08-31 09:53:58 -0700130};
131#define OLYMPUS_MXL_INFO ((unsigned long)&olympus_mxl_info)
132
133
134/* Some more recent products using Lineo/Belcarra code will wrongly claim
135 * CDC MDLM conformance. They aren't conformant: data endpoints live
136 * in the control interface, there's no data interface, and it's not used
137 * to talk to a cell phone radio. But at least we can detect these two
138 * pseudo-classes, rather than growing this product list with entries for
139 * each new nonconformant product (sigh).
140 */
141static const u8 safe_guid[16] = {
142 0x5d, 0x34, 0xcf, 0x66, 0x11, 0x18, 0x11, 0xd6,
143 0xa2, 0x1a, 0x00, 0x01, 0x02, 0xca, 0x9a, 0x7f,
144};
145static const u8 blan_guid[16] = {
146 0x74, 0xf0, 0x3d, 0xbd, 0x1e, 0xc1, 0x44, 0x70,
147 0xa3, 0x67, 0x71, 0x34, 0xc9, 0xf5, 0x54, 0x37,
148};
149
150static int blan_mdlm_bind(struct usbnet *dev, struct usb_interface *intf)
151{
152 u8 *buf = intf->cur_altsetting->extra;
153 int len = intf->cur_altsetting->extralen;
154 struct usb_cdc_mdlm_desc *desc = NULL;
155 struct usb_cdc_mdlm_detail_desc *detail = NULL;
156
157 while (len > 3) {
158 if (buf [1] != USB_DT_CS_INTERFACE)
159 goto next_desc;
160
161 /* use bDescriptorSubType, and just verify that we get a
162 * "BLAN" (or "SAFE") descriptor.
163 */
164 switch (buf [2]) {
165 case USB_CDC_MDLM_TYPE:
166 if (desc) {
167 dev_dbg(&intf->dev, "extra MDLM\n");
168 goto bad_desc;
169 }
170 desc = (void *) buf;
171 if (desc->bLength != sizeof *desc) {
172 dev_dbg(&intf->dev, "MDLM len %u\n",
173 desc->bLength);
174 goto bad_desc;
175 }
176 /* expect bcdVersion 1.0, ignore */
Joe Perches8e95a202009-12-03 07:58:21 +0000177 if (memcmp(&desc->bGUID, blan_guid, 16) &&
178 memcmp(&desc->bGUID, safe_guid, 16)) {
David Brownell0aa599c2005-08-31 09:53:58 -0700179 /* hey, this one might _really_ be MDLM! */
180 dev_dbg(&intf->dev, "MDLM guid\n");
181 goto bad_desc;
182 }
183 break;
184 case USB_CDC_MDLM_DETAIL_TYPE:
185 if (detail) {
186 dev_dbg(&intf->dev, "extra MDLM detail\n");
187 goto bad_desc;
188 }
189 detail = (void *) buf;
190 switch (detail->bGuidDescriptorType) {
191 case 0: /* "SAFE" */
192 if (detail->bLength != (sizeof *detail + 2))
193 goto bad_detail;
194 break;
195 case 1: /* "BLAN" */
196 if (detail->bLength != (sizeof *detail + 3))
197 goto bad_detail;
198 break;
199 default:
200 goto bad_detail;
201 }
202
203 /* assuming we either noticed BLAN already, or will
204 * find it soon, there are some data bytes here:
205 * - bmNetworkCapabilities (unused)
206 * - bmDataCapabilities (bits, see below)
207 * - bPad (ignored, for PADAFTER -- BLAN-only)
208 * bits are:
209 * - 0x01 -- Zaurus framing (add CRC)
210 * - 0x02 -- PADBEFORE (CRC includes some padding)
211 * - 0x04 -- PADAFTER (some padding after CRC)
212 * - 0x08 -- "fermat" packet mangling (for hw bugs)
213 * the PADBEFORE appears not to matter; we interop
214 * with devices that use it and those that don't.
215 */
216 if ((detail->bDetailData[1] & ~0x02) != 0x01) {
Alexey Dobriyan7f927fc2006-03-28 01:56:53 -0800217 /* bmDataCapabilities == 0 would be fine too,
David Brownell0aa599c2005-08-31 09:53:58 -0700218 * but framing is minidriver-coupled for now.
219 */
220bad_detail:
221 dev_dbg(&intf->dev,
222 "bad MDLM detail, %d %d %d\n",
223 detail->bLength,
224 detail->bDetailData[0],
225 detail->bDetailData[2]);
226 goto bad_desc;
227 }
David Brownellf44f7252006-05-12 19:24:34 -0700228
229 /* same extra framing as for non-BLAN mode */
230 dev->net->hard_header_len += 6;
231 dev->rx_urb_size = dev->net->hard_header_len
232 + dev->net->mtu;
David Brownell0aa599c2005-08-31 09:53:58 -0700233 break;
234 }
235next_desc:
236 len -= buf [0]; /* bLength */
237 buf += buf [0];
238 }
239
240 if (!desc || !detail) {
241 dev_dbg(&intf->dev, "missing cdc mdlm %s%sdescriptor\n",
242 desc ? "" : "func ",
243 detail ? "" : "detail ");
244 goto bad_desc;
245 }
246
247 /* There's probably a CDC Ethernet descriptor there, but we can't
248 * rely on the Ethernet address it provides since not all vendors
249 * bother to make it unique. Likewise there's no point in tracking
250 * of the CDC event notifications.
251 */
252 return usbnet_get_endpoints(dev, intf);
253
254bad_desc:
255 dev_info(&dev->udev->dev, "unsupported MDLM descriptors\n");
256 return -ENODEV;
257}
258
259static const struct driver_info bogus_mdlm_info = {
260 .description = "pseudo-MDLM (BLAN) device",
Arnd Bergmannc2613442011-04-01 20:12:02 -0700261 .flags = FLAG_POINTTOPOINT | FLAG_FRAMING_Z,
David Brownell0aa599c2005-08-31 09:53:58 -0700262 .check_connect = always_connected,
David Brownellf44f7252006-05-12 19:24:34 -0700263 .tx_fixup = zaurus_tx_fixup,
David Brownell0aa599c2005-08-31 09:53:58 -0700264 .bind = blan_mdlm_bind,
265};
266
267static const struct usb_device_id products [] = {
268#define ZAURUS_MASTER_INTERFACE \
269 .bInterfaceClass = USB_CLASS_COMM, \
270 .bInterfaceSubClass = USB_CDC_SUBCLASS_ETHERNET, \
271 .bInterfaceProtocol = USB_CDC_PROTO_NONE
272
273/* SA-1100 based Sharp Zaurus ("collie"), or compatible. */
274{
275 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
276 | USB_DEVICE_ID_MATCH_DEVICE,
277 .idVendor = 0x04DD,
278 .idProduct = 0x8004,
279 ZAURUS_MASTER_INTERFACE,
280 .driver_info = ZAURUS_STRONGARM_INFO,
281},
282
283/* PXA-2xx based models are also lying-about-cdc. If you add any
284 * more devices that claim to be CDC Ethernet, make sure they get
285 * added to the blacklist in cdc_ether too.
286 *
287 * NOTE: OpenZaurus versions with 2.6 kernels won't use these entries,
288 * unlike the older ones with 2.4 "embedix" kernels.
289 */
290{
291 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
292 | USB_DEVICE_ID_MATCH_DEVICE,
293 .idVendor = 0x04DD,
294 .idProduct = 0x8005, /* A-300 */
295 ZAURUS_MASTER_INTERFACE,
296 .driver_info = ZAURUS_PXA_INFO,
297}, {
298 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
299 | USB_DEVICE_ID_MATCH_DEVICE,
300 .idVendor = 0x04DD,
301 .idProduct = 0x8006, /* B-500/SL-5600 */
302 ZAURUS_MASTER_INTERFACE,
303 .driver_info = ZAURUS_PXA_INFO,
304}, {
305 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
306 | USB_DEVICE_ID_MATCH_DEVICE,
307 .idVendor = 0x04DD,
308 .idProduct = 0x8007, /* C-700 */
309 ZAURUS_MASTER_INTERFACE,
310 .driver_info = ZAURUS_PXA_INFO,
311}, {
312 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
313 | USB_DEVICE_ID_MATCH_DEVICE,
314 .idVendor = 0x04DD,
315 .idProduct = 0x9031, /* C-750 C-760 */
316 ZAURUS_MASTER_INTERFACE,
317 .driver_info = ZAURUS_PXA_INFO,
318}, {
319 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
320 | USB_DEVICE_ID_MATCH_DEVICE,
321 .idVendor = 0x04DD,
322 .idProduct = 0x9032, /* SL-6000 */
323 ZAURUS_MASTER_INTERFACE,
324 .driver_info = ZAURUS_PXA_INFO,
325}, {
326 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
327 | USB_DEVICE_ID_MATCH_DEVICE,
328 .idVendor = 0x04DD,
329 /* reported with some C860 units */
330 .idProduct = 0x9050, /* C-860 */
331 ZAURUS_MASTER_INTERFACE,
332 .driver_info = ZAURUS_PXA_INFO,
333},
334
335
336/* At least some of the newest PXA units have very different lies about
337 * their standards support: they claim to be cell phones offering
338 * direct access to their radios! (No, they don't conform to CDC MDLM.)
339 */
340{
341 USB_INTERFACE_INFO(USB_CLASS_COMM, USB_CDC_SUBCLASS_MDLM,
342 USB_CDC_PROTO_NONE),
343 .driver_info = (unsigned long) &bogus_mdlm_info,
Dmitriy Taychenachev52c03262009-02-24 18:42:48 +0000344}, {
345 /* Motorola MOTOMAGX phones */
346 USB_DEVICE_AND_INTERFACE_INFO(0x22b8, 0x6425, USB_CLASS_COMM,
347 USB_CDC_SUBCLASS_MDLM, USB_CDC_PROTO_NONE),
348 .driver_info = (unsigned long) &bogus_mdlm_info,
David Brownell0aa599c2005-08-31 09:53:58 -0700349},
350
351/* Olympus has some models with a Zaurus-compatible option.
352 * R-1000 uses a FreeScale i.MXL cpu (ARMv4T)
353 */
354{
355 .match_flags = USB_DEVICE_ID_MATCH_INT_INFO
356 | USB_DEVICE_ID_MATCH_DEVICE,
357 .idVendor = 0x07B4,
358 .idProduct = 0x0F02, /* R-1000 */
359 ZAURUS_MASTER_INTERFACE,
360 .driver_info = OLYMPUS_MXL_INFO,
361},
362 { }, // END
363};
364MODULE_DEVICE_TABLE(usb, products);
365
366static struct usb_driver zaurus_driver = {
David Brownell0aa599c2005-08-31 09:53:58 -0700367 .name = "zaurus",
368 .id_table = products,
369 .probe = usbnet_probe,
370 .disconnect = usbnet_disconnect,
371 .suspend = usbnet_suspend,
372 .resume = usbnet_resume,
373};
374
375static int __init zaurus_init(void)
376{
David Brownellf44f7252006-05-12 19:24:34 -0700377 return usb_register(&zaurus_driver);
David Brownell0aa599c2005-08-31 09:53:58 -0700378}
379module_init(zaurus_init);
380
381static void __exit zaurus_exit(void)
382{
David Brownellf44f7252006-05-12 19:24:34 -0700383 usb_deregister(&zaurus_driver);
David Brownell0aa599c2005-08-31 09:53:58 -0700384}
385module_exit(zaurus_exit);
386
387MODULE_AUTHOR("Pavel Machek, David Brownell");
388MODULE_DESCRIPTION("Sharp Zaurus PDA, and compatible products");
389MODULE_LICENSE("GPL");