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