xref: /freebsd/share/man/man4/fwe.4 (revision 16d78bb878deb14559061f5733b2439e9a3392cf)
1d4f61705SHidetoshi Shimokawa.\" Copyright (c) 2002 Hidetoshi Shimokawa
2d4f61705SHidetoshi Shimokawa.\" All rights reserved.
3d4f61705SHidetoshi Shimokawa.\"
4d4f61705SHidetoshi Shimokawa.\" Redistribution and use in source and binary forms, with or without
5d4f61705SHidetoshi Shimokawa.\" modification, are permitted provided that the following conditions
6d4f61705SHidetoshi Shimokawa.\" are met:
7d4f61705SHidetoshi Shimokawa.\" 1. Redistributions of source code must retain the above copyright
8d4f61705SHidetoshi Shimokawa.\"    notice, this list of conditions and the following disclaimer.
9d4f61705SHidetoshi Shimokawa.\" 2. Redistributions in binary form must reproduce the above copyright
10d4f61705SHidetoshi Shimokawa.\"    notice, this list of conditions and the following disclaimer in the
11d4f61705SHidetoshi Shimokawa.\"    documentation and/or other materials provided with the distribution.
12d4f61705SHidetoshi Shimokawa.\"
13d4f61705SHidetoshi Shimokawa.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14d4f61705SHidetoshi Shimokawa.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15d4f61705SHidetoshi Shimokawa.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16d4f61705SHidetoshi Shimokawa.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
17d4f61705SHidetoshi Shimokawa.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18d4f61705SHidetoshi Shimokawa.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19d4f61705SHidetoshi Shimokawa.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20d4f61705SHidetoshi Shimokawa.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21d4f61705SHidetoshi Shimokawa.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
22d4f61705SHidetoshi Shimokawa.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
23d4f61705SHidetoshi Shimokawa.\" POSSIBILITY OF SUCH DAMAGE.
24d4f61705SHidetoshi Shimokawa.\"
25d4f61705SHidetoshi Shimokawa.\" $FreeBSD$
26d4f61705SHidetoshi Shimokawa.\"
27d4f61705SHidetoshi Shimokawa.\"
2886e3186eSTom Rhodes.Dd July 16, 2005
29d4f61705SHidetoshi Shimokawa.Dt FWE 4
30d4f61705SHidetoshi Shimokawa.Os
31d4f61705SHidetoshi Shimokawa.Sh NAME
32d4f61705SHidetoshi Shimokawa.Nm fwe
3386e3186eSTom Rhodes.Nd "Ethernet emulation driver for FireWire"
34d4f61705SHidetoshi Shimokawa.Sh SYNOPSIS
3516d78bb8STom RhodesTo compile this driver into the kernel,
3616d78bb8STom Rhodesplace the following lines in your
3790296834STom Rhodeskernel configuration file:
3886e3186eSTom Rhodes.Bd -ragged -offset indent
39d4f61705SHidetoshi Shimokawa.Cd "device firewire"
407d6c1b57SChristian Brueffer.Cd "device fwe"
4186e3186eSTom Rhodes.Ed
4286e3186eSTom Rhodes.Pp
4316d78bb8STom RhodesAlternatively, to load the driver as a
4416d78bb8STom Rhodesmodule at boot time, place the following line in
4586e3186eSTom Rhodes.Xr loader.conf 5 :
4686e3186eSTom Rhodes.Bd -literal -offset indent
4786e3186eSTom Rhodesif_fwe_load="YES"
4886e3186eSTom Rhodes.Ed
49d4f61705SHidetoshi Shimokawa.Sh DESCRIPTION
50d4f61705SHidetoshi ShimokawaThe
51d4f61705SHidetoshi Shimokawa.Nm
527d6c1b57SChristian Bruefferdriver provides non-standard Ethernet emulation over FireWire (IEEE 1394).
53d4f61705SHidetoshi Shimokawa.Pp
54a2931c09SRuslan Ermilov.Xr firewire 4
55d4f61705SHidetoshi Shimokawaand
56a2931c09SRuslan Ermilov.Xr fwohci 4
57d4f61705SHidetoshi Shimokawamust be configured in the kernel as well.
58d4f61705SHidetoshi Shimokawa.Pp
59d4f61705SHidetoshi ShimokawaThis driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
60a2931c09SRuslan Ermilovframes.
61a2931c09SRuslan ErmilovThe stream channel can be specified by
62a2931c09SRuslan Ermilovthe
63a2931c09SRuslan Ermilov.Va hw.firewire.fwe.stream_ch
64a2931c09SRuslan Ermilov.Xr sysctl 8 .
65d4f61705SHidetoshi Shimokawa.Pp
66a2931c09SRuslan ErmilovThis driver supports
67a2931c09SRuslan Ermilov.Xr polling 4
68a2931c09SRuslan Ermilovas well if it is compiled with the
69a2931c09SRuslan Ermilov.Dv DEVICE_POLLING
70a2931c09SRuslan Ermilovoption.
71d4f61705SHidetoshi Shimokawa.Sh SEE ALSO
72d4f61705SHidetoshi Shimokawa.Xr arp 4 ,
73d4f61705SHidetoshi Shimokawa.Xr firewire 4 ,
747d6c1b57SChristian Brueffer.Xr fwip 4 ,
75d4f61705SHidetoshi Shimokawa.Xr fwohci 4 ,
76d4f61705SHidetoshi Shimokawa.Xr netintro 4 ,
77d4f61705SHidetoshi Shimokawa.Xr ng_ether 4 ,
78d4f61705SHidetoshi Shimokawa.Xr polling 4 ,
79d4f61705SHidetoshi Shimokawa.Xr ifconfig 8 ,
80ace5be68SRuslan Ermilov.Xr kldload 8 ,
81d4f61705SHidetoshi Shimokawa.Xr sysctl 8
829cbda590SRuslan Ermilov.Sh HISTORY
839cbda590SRuslan ErmilovThe
849cbda590SRuslan Ermilov.Nm
859cbda590SRuslan Ermilovdevice driver first appeared in
869cbda590SRuslan Ermilov.Fx 5.0 .
87d4f61705SHidetoshi Shimokawa.Sh AUTHORS
88d4f61705SHidetoshi ShimokawaThe
89d4f61705SHidetoshi Shimokawa.Nm
90a2931c09SRuslan Ermilovdriver and this manual page were written by
91d4f61705SHidetoshi Shimokawa.An Hidetoshi Shimokawa .
929cbda590SRuslan Ermilov.Sh BUGS
939cbda590SRuslan ErmilovThis driver emulates Ethernet in a very adhoc way and it does not reserve a
949cbda590SRuslan Ermilovstream channel using an isochronous manager.
959cbda590SRuslan ErmilovNote that this driver uses a protocol which is very different from RFC 2734
969cbda590SRuslan Ermilov(IPv4 over IEEE 1394).
97