xref: /freebsd/share/man/man4/fwe.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.\"
26.Dd July 16, 2005
27.Dt FWE 4
28.Os
29.Sh NAME
30.Nm fwe
31.Nd "Ethernet emulation driver for FireWire"
32.Sh SYNOPSIS
33To compile this driver into the kernel,
34place the following lines in your
35kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device firewire"
38.Cd "device fwe"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following line in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45if_fwe_load="YES"
46.Ed
47.Sh DESCRIPTION
48The
49.Nm
50driver provides non-standard Ethernet emulation over FireWire (IEEE 1394).
51.Pp
52.Xr firewire 4
53and
54.Xr fwohci 4
55must be configured in the kernel as well.
56.Pp
57This driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
58frames.
59The stream channel can be specified by
60the
61.Va hw.firewire.fwe.stream_ch
62.Xr sysctl 8 .
63.Pp
64This driver supports
65.Xr polling 4
66as well if it is compiled with the
67.Dv DEVICE_POLLING
68option.
69.Sh SEE ALSO
70.Xr arp 4 ,
71.Xr firewire 4 ,
72.Xr fwip 4 ,
73.Xr fwohci 4 ,
74.Xr netintro 4 ,
75.Xr ng_ether 4 ,
76.Xr polling 4 ,
77.Xr ifconfig 8 ,
78.Xr kldload 8 ,
79.Xr sysctl 8
80.Sh HISTORY
81The
82.Nm
83device driver first appeared in
84.Fx 5.0 .
85.Sh AUTHORS
86The
87.Nm
88driver and this manual page were written by
89.An Hidetoshi Shimokawa .
90.Sh BUGS
91This driver emulates Ethernet in a very adhoc way and it does not reserve a
92stream channel using an isochronous manager.
93Note that this driver uses a protocol which is very different from RFC 2734
94(IPv4 over IEEE 1394).
95