blob: 5d17cdfc7bab00e468f8beafe466533b1815596e [file] [log] [blame]
David Brownell090ffa92005-08-31 09:54:50 -07001/*
2 * PL-2301/2302 USB host-to-host link cables
3 * Copyright (C) 2000-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 Brownell090ffa92005-08-31 09:54:50 -070023#include <linux/module.h>
24#include <linux/sched.h>
25#include <linux/init.h>
26#include <linux/netdevice.h>
27#include <linux/etherdevice.h>
28#include <linux/ethtool.h>
29#include <linux/workqueue.h>
30#include <linux/mii.h>
31#include <linux/usb.h>
32
33#include "usbnet.h"
34
35
36/*
37 * Prolific PL-2301/PL-2302 driver ... http://www.prolifictech.com
38 *
39 * The protocol and handshaking used here should be bug-compatible
40 * with the Linux 2.2 "plusb" driver, by Deti Fliegl.
41 *
42 * HEADS UP: this handshaking isn't all that robust. This driver
43 * gets confused easily if you unplug one end of the cable then
44 * try to connect it again; you'll need to restart both ends. The
45 * "naplink" software (used by some PlayStation/2 deveopers) does
46 * the handshaking much better! Also, sometimes this hardware
47 * seems to get wedged under load. Prolific docs are weak, and
48 * don't identify differences between PL2301 and PL2302, much less
49 * anything to explain the different PL2302 versions observed.
50 */
51
52/*
53 * Bits 0-4 can be used for software handshaking; they're set from
54 * one end, cleared from the other, "read" with the interrupt byte.
55 */
56#define PL_S_EN (1<<7) /* (feature only) suspend enable */
57/* reserved bit -- rx ready (6) ? */
58#define PL_TX_READY (1<<5) /* (interrupt only) transmit ready */
59#define PL_RESET_OUT (1<<4) /* reset output pipe */
60#define PL_RESET_IN (1<<3) /* reset input pipe */
61#define PL_TX_C (1<<2) /* transmission complete */
62#define PL_TX_REQ (1<<1) /* transmission received */
63#define PL_PEER_E (1<<0) /* peer exists */
64
65static inline int
66pl_vendor_req(struct usbnet *dev, u8 req, u8 val, u8 index)
67{
68 return usb_control_msg(dev->udev,
69 usb_rcvctrlpipe(dev->udev, 0),
70 req,
71 USB_DIR_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,
72 val, index,
73 NULL, 0,
74 USB_CTRL_GET_TIMEOUT);
75}
76
77static inline int
78pl_clear_QuickLink_features(struct usbnet *dev, int val)
79{
80 return pl_vendor_req(dev, 1, (u8) val, 0);
81}
82
83static inline int
84pl_set_QuickLink_features(struct usbnet *dev, int val)
85{
86 return pl_vendor_req(dev, 3, (u8) val, 0);
87}
88
89static int pl_reset(struct usbnet *dev)
90{
91 /* some units seem to need this reset, others reject it utterly.
92 * FIXME be more like "naplink" or windows drivers.
93 */
94 (void) pl_set_QuickLink_features(dev,
95 PL_S_EN|PL_RESET_OUT|PL_RESET_IN|PL_PEER_E);
96 return 0;
97}
98
99static const struct driver_info prolific_info = {
100 .description = "Prolific PL-2301/PL-2302",
101 .flags = FLAG_NO_SETINT,
102 /* some PL-2302 versions seem to fail usb_set_interface() */
103 .reset = pl_reset,
104};
105
106
107/*-------------------------------------------------------------------------*/
108
109/*
110 * Proilific's name won't normally be on the cables, and
111 * may not be on the device.
112 */
113
114static const struct usb_device_id products [] = {
115
116{
117 USB_DEVICE(0x067b, 0x0000), // PL-2301
118 .driver_info = (unsigned long) &prolific_info,
119}, {
120 USB_DEVICE(0x067b, 0x0001), // PL-2302
121 .driver_info = (unsigned long) &prolific_info,
122},
123
124 { }, // END
125};
126MODULE_DEVICE_TABLE(usb, products);
127
128static struct usb_driver plusb_driver = {
David Brownell090ffa92005-08-31 09:54:50 -0700129 .name = "plusb",
130 .id_table = products,
131 .probe = usbnet_probe,
132 .disconnect = usbnet_disconnect,
133 .suspend = usbnet_suspend,
134 .resume = usbnet_resume,
135};
136
137static int __init plusb_init(void)
138{
139 return usb_register(&plusb_driver);
140}
141module_init(plusb_init);
142
143static void __exit plusb_exit(void)
144{
145 usb_deregister(&plusb_driver);
146}
147module_exit(plusb_exit);
148
149MODULE_AUTHOR("David Brownell");
150MODULE_DESCRIPTION("Prolific PL-2301/2302 USB Host to Host Link Driver");
151MODULE_LICENSE("GPL");