Initial import from FreeBSD RELENG_4:
[dragonfly.git] / share / man / man4 / fwe.4
1 .\" Copyright (c) 2002 Hidetoshi Shimokawa
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\"
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
17 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
22 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23 .\" POSSIBILITY OF SUCH DAMAGE.
24 .\"
25 .\" $FreeBSD: src/share/man/man4/fwe.4,v 1.2.4.3 2003/03/03 18:51:16 trhodes Exp $
26 .\"
27 .\"
28 .Dd November 8, 2002
29 .Dt FWE 4
30 .Os
31 .Sh NAME
32 .Nm fwe
33 .Nd Ethernet emulation driver for FireWire
34 .Sh SYNOPSIS
35 .Cd "kldload firewire"
36 .Cd "kldload if_fwe"
37 .Pp
38 or
39 .Pp
40 .Cd "device fwe"
41 .Cd "device firewire"
42 .Cd "device fwohci"
43 .Sh DESCRIPTION
44 The
45 .Nm
46 driver provides non-standard ethernet emulation over FireWire (IEEE 1394).
47 .Pp
48 .Xr firewire 4
49 and
50 .Xr fwohci 4
51 must be configured in the kernel as well.
52 .Pp
53 This driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
54 frames.
55 The stream channel can be specified by
56 the
57 .Va hw.firewire.fwe.stream_ch
58 .Xr sysctl 8 .
59 .Pp
60 This driver supports
61 .Xr polling 4
62 as well if it is compiled with the
63 .Dv DEVICE_POLLING
64 option.
65 .Sh HISTORY
66 The fwe device driver first appeared in
67 .Fx 5.0 .
68 .Sh BUGS
69 This driver emulates ethernet very adhoc way and it does not reserve a
70 stream channel using an isochronous manager.
71 Note this driver uses very different protocol from RFC 2734
72 (IPv4 over IEEE 1394).
73 .Sh SEE ALSO
74 .Xr arp 4 ,
75 .Xr firewire 4 ,
76 .Xr fwohci 4 ,
77 .Xr netintro 4 ,
78 .Xr ng_ether 4 ,
79 .Xr polling 4 ,
80 .Xr ifconfig 8 ,
81 .Xr kldload 8 ,
82 .Xr sysctl 8
83 .Sh AUTHORS
84 The
85 .Nm
86 driver and this manual page were written by
87 .An Hidetoshi Shimokawa .