| @@ -1,140 +1,140 @@ | | | @@ -1,140 +1,140 @@ |
1 | .\" Copyright (c) 2004 Daniel Hartmeier | | 1 | .\" Copyright (c) 2004 Daniel Hartmeier |
2 | .\" All rights reserved. | | 2 | .\" All rights reserved. |
3 | .\" | | 3 | .\" |
4 | .\" Redistribution and use in source and binary forms, with or without | | 4 | .\" Redistribution and use in source and binary forms, with or without |
5 | .\" modification, are permitted provided that the following conditions | | 5 | .\" modification, are permitted provided that the following conditions |
6 | .\" are met: | | 6 | .\" are met: |
7 | .\" | | 7 | .\" |
8 | .\" - Redistributions of source code must retain the above copyright | | 8 | .\" - Redistributions of source code must retain the above copyright |
9 | .\" notice, this list of conditions and the following disclaimer. | | 9 | .\" notice, this list of conditions and the following disclaimer. |
10 | .\" - Redistributions in binary form must reproduce the above | | 10 | .\" - Redistributions in binary form must reproduce the above |
11 | .\" copyright notice, this list of conditions and the following | | 11 | .\" copyright notice, this list of conditions and the following |
12 | .\" disclaimer in the documentation and/or other materials provided | | 12 | .\" disclaimer in the documentation and/or other materials provided |
13 | .\" with the distribution. | | 13 | .\" with the distribution. |
14 | .\" | | 14 | .\" |
15 | .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | | 15 | .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
16 | .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | | 16 | .\" "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
17 | .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS | | 17 | .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS |
18 | .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE | | 18 | .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE |
19 | .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, | | 19 | .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, |
20 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, | | 20 | .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, |
21 | .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; | | 21 | .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; |
22 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER | | 22 | .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
23 | .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | | 23 | .\" CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT |
24 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN | | 24 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN |
25 | .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | | 25 | .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
26 | .\" POSSIBILITY OF SUCH DAMAGE. | | 26 | .\" POSSIBILITY OF SUCH DAMAGE. |
27 | .\" | | 27 | .\" |
28 | .\" $NetBSD: cdce.4,v 1.7 2011/06/07 05:46:00 msaitoh Exp $ | | 28 | .\" $NetBSD: cdce.4,v 1.8 2011/06/07 07:26:19 wiz Exp $ |
29 | .\" | | 29 | .\" |
30 | .Dd June 07, 2011 | | 30 | .Dd June 7, 2011 |
31 | .Dt CDCE 4 | | 31 | .Dt CDCE 4 |
32 | .Os | | 32 | .Os |
33 | .Sh NAME | | 33 | .Sh NAME |
34 | .Nm cdce | | 34 | .Nm cdce |
35 | .Nd USB Communication Device Class Ethernet driver | | 35 | .Nd USB Communication Device Class Ethernet driver |
36 | .Sh SYNOPSIS | | 36 | .Sh SYNOPSIS |
37 | .Cd "cdce* at uhub? port ?" | | 37 | .Cd "cdce* at uhub? port ?" |
38 | .Sh DESCRIPTION | | 38 | .Sh DESCRIPTION |
39 | The | | 39 | The |
40 | .Nm | | 40 | .Nm |
41 | driver provides support for USB Host-to-Host (aka USB-to-USB) bridges | | 41 | driver provides support for USB Host-to-Host (aka USB-to-USB) bridges |
42 | based on the USB Communication Device Class (CDC) and Ethernet subclass, | | 42 | based on the USB Communication Device Class (CDC) and Ethernet subclass, |
43 | including the following: | | 43 | including the following: |
44 | .Pp | | 44 | .Pp |
45 | .Bl -bullet -compact | | 45 | .Bl -bullet -compact |
46 | .It | | 46 | .It |
47 | Acer Labs USB 2.0 Data Link | | 47 | Acer Labs USB 2.0 Data Link |
48 | .It | | 48 | .It |
49 | G.Mate YP3X00 | | 49 | G.Mate YP3X00 |
50 | .It | | 50 | .It |
51 | Motorola USBNET | | 51 | Motorola USBNET |
52 | .It | | 52 | .It |
53 | NetChip EthernetGadget | | 53 | NetChip EthernetGadget |
54 | .It | | 54 | .It |
55 | Prolific PL-2501 | | 55 | Prolific PL-2501 |
56 | .It | | 56 | .It |
57 | Sharp Zaurus | | 57 | Sharp Zaurus |
58 | .El | | 58 | .El |
59 | .Pp | | 59 | .Pp |
60 | The USB bridge appears as a regular network interface on both sides, | | 60 | The USB bridge appears as a regular network interface on both sides, |
61 | transporting Ethernet frames. | | 61 | transporting Ethernet frames. |
62 | .Pp | | 62 | .Pp |
63 | For more information on configuring this device, see | | 63 | For more information on configuring this device, see |
64 | .Xr ifconfig 8 . | | 64 | .Xr ifconfig 8 . |
65 | .Pp | | 65 | .Pp |
66 | USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of | | 66 | USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds of |
67 | up to 480Mbps. | | 67 | up to 480Mbps. |
68 | .Pp | | 68 | .Pp |
69 | Packets are | | 69 | Packets are |
70 | received and transmitted over separate USB bulk transfer endpoints. | | 70 | received and transmitted over separate USB bulk transfer endpoints. |
71 | .Pp | | 71 | .Pp |
72 | The | | 72 | The |
73 | .Nm | | 73 | .Nm |
74 | driver does not support different media types or options. | | 74 | driver does not support different media types or options. |
75 | .Sh DIAGNOSTICS | | 75 | .Sh DIAGNOSTICS |
76 | .Bl -diag | | 76 | .Bl -diag |
77 | .It "cdce%d: no union descriptor" | | 77 | .It "cdce%d: no union descriptor" |
78 | The driver couldn't fetch an interface descriptor from the USB | | 78 | The driver couldn't fetch an interface descriptor from the USB |
79 | device. | | 79 | device. |
80 | For a manually added USB vendor/product, the CDCE_NO_UNION flag | | 80 | For a manually added USB vendor/product, the CDCE_NO_UNION flag |
81 | can be tried to work around the missing descriptor. | | 81 | can be tried to work around the missing descriptor. |
82 | .It "cdce%d: no data interface" | | 82 | .It "cdce%d: no data interface" |
83 | .It "cdce%d: could not read endpoint descriptor" | | 83 | .It "cdce%d: could not read endpoint descriptor" |
84 | .It "cdce%d: unexpected endpoint" | | 84 | .It "cdce%d: unexpected endpoint" |
85 | .It "cdce%d: could not find data bulk in/out" | | 85 | .It "cdce%d: could not find data bulk in/out" |
86 | For a manually added USB vendor/product, these errors indicate | | 86 | For a manually added USB vendor/product, these errors indicate |
87 | that the bridge is not compatible with the driver. | | 87 | that the bridge is not compatible with the driver. |
88 | .It "cdce%d: watchdog timeout" | | 88 | .It "cdce%d: watchdog timeout" |
89 | A packet was queued for transmission and a transmit command was | | 89 | A packet was queued for transmission and a transmit command was |
90 | issued, however the device failed to acknowledge the transmission | | 90 | issued, however the device failed to acknowledge the transmission |
91 | before a timeout expired. | | 91 | before a timeout expired. |
92 | .It "cdce%d: no memory for rx list -- packet dropped!" | | 92 | .It "cdce%d: no memory for rx list -- packet dropped!" |
93 | Memory allocation through MGETHDR or MCLGET failed, the system | | 93 | Memory allocation through MGETHDR or MCLGET failed, the system |
94 | is running low on mbufs. | | 94 | is running low on mbufs. |
95 | .It "cdce%d: abort/close rx/tx pipe failed" | | 95 | .It "cdce%d: abort/close rx/tx pipe failed" |
96 | .It "cdce%d: rx/tx list init failed" | | 96 | .It "cdce%d: rx/tx list init failed" |
97 | .It "cdce%d: open rx/tx pipe failed" | | 97 | .It "cdce%d: open rx/tx pipe failed" |
98 | .It "cdce%d: usb error on rx/tx" | | 98 | .It "cdce%d: usb error on rx/tx" |
99 | .El | | 99 | .El |
100 | .Sh SEE ALSO | | 100 | .Sh SEE ALSO |
101 | .Xr arp 4 , | | 101 | .Xr arp 4 , |
102 | .Xr intro 4 , | | 102 | .Xr intro 4 , |
103 | .Xr netintro 4 , | | 103 | .Xr netintro 4 , |
104 | .Xr usb 4 , | | 104 | .Xr usb 4 , |
105 | .\" .Xr hostname.if 5 , | | 105 | .\" .Xr hostname.if 5 , |
106 | .Xr ifconfig 8 | | 106 | .Xr ifconfig 8 |
107 | .Rs | | 107 | .Rs |
108 | .%T "Universal Serial Bus Class Definitions for Communication Devices" | | 108 | .%T "Universal Serial Bus Class Definitions for Communication Devices" |
109 | .%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf | | 109 | .%U http://www.usb.org/developers/devclass_docs/usbcdc11.pdf |
110 | .Re | | 110 | .Re |
111 | .Rs | | 111 | .Rs |
112 | .%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" | | 112 | .%T "Data sheet Prolific PL-2501 Host-to-Host Bridge/Network Controller" |
113 | .%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 | | 113 | .%U http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530 |
114 | .Re | | 114 | .Re |
115 | .Sh HISTORY | | 115 | .Sh HISTORY |
116 | The | | 116 | The |
117 | .Nm | | 117 | .Nm |
118 | device driver first appeared in | | 118 | device driver first appeared in |
119 | .Ox 3.6 | | 119 | .Ox 3.6 |
120 | and | | 120 | and |
121 | .Nx 3.0 . | | 121 | .Nx 3.0 . |
122 | .Sh AUTHORS | | 122 | .Sh AUTHORS |
123 | .An -nosplit | | 123 | .An -nosplit |
124 | The | | 124 | The |
125 | .Nm | | 125 | .Nm |
126 | driver was written by | | 126 | driver was written by |
127 | .An Craig Boston Aq craig@tobuj.gank.org | | 127 | .An Craig Boston Aq craig@tobuj.gank.org |
128 | based on the | | 128 | based on the |
129 | .Xr aue 4 | | 129 | .Xr aue 4 |
130 | driver written by | | 130 | driver written by |
131 | .An Bill Paul Aq wpaul@windriver.com | | 131 | .An Bill Paul Aq wpaul@windriver.com |
132 | and ported to | | 132 | and ported to |
133 | .Ox | | 133 | .Ox |
134 | by | | 134 | by |
135 | .An Daniel Hartmeier Aq dhartmei@openbsd.org . | | 135 | .An Daniel Hartmeier Aq dhartmei@openbsd.org . |
136 | .Sh CAVEATS | | 136 | .Sh CAVEATS |
137 | Many USB devices notoriously fail to report their class and interfaces | | 137 | Many USB devices notoriously fail to report their class and interfaces |
138 | correctly. | | 138 | correctly. |
139 | Undetected products might work flawlessly when their vendor and product IDs | | 139 | Undetected products might work flawlessly when their vendor and product IDs |
140 | are added to the driver manually. | | 140 | are added to the driver manually. |