xref: /freebsd/share/man/man4/fwe.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
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.\"
2686e3186eSTom Rhodes.Dd July 16, 2005
27d4f61705SHidetoshi Shimokawa.Dt FWE 4
28d4f61705SHidetoshi Shimokawa.Os
29d4f61705SHidetoshi Shimokawa.Sh NAME
30d4f61705SHidetoshi Shimokawa.Nm fwe
3186e3186eSTom Rhodes.Nd "Ethernet emulation driver for FireWire"
32d4f61705SHidetoshi Shimokawa.Sh SYNOPSIS
3316d78bb8STom RhodesTo compile this driver into the kernel,
3416d78bb8STom Rhodesplace the following lines in your
3590296834STom Rhodeskernel configuration file:
3686e3186eSTom Rhodes.Bd -ragged -offset indent
37d4f61705SHidetoshi Shimokawa.Cd "device firewire"
387d6c1b57SChristian Brueffer.Cd "device fwe"
3986e3186eSTom Rhodes.Ed
4086e3186eSTom Rhodes.Pp
4116d78bb8STom RhodesAlternatively, to load the driver as a
4216d78bb8STom Rhodesmodule at boot time, place the following line in
4386e3186eSTom Rhodes.Xr loader.conf 5 :
4486e3186eSTom Rhodes.Bd -literal -offset indent
4586e3186eSTom Rhodesif_fwe_load="YES"
4686e3186eSTom Rhodes.Ed
47d4f61705SHidetoshi Shimokawa.Sh DESCRIPTION
48d4f61705SHidetoshi ShimokawaThe
49d4f61705SHidetoshi Shimokawa.Nm
507d6c1b57SChristian Bruefferdriver provides non-standard Ethernet emulation over FireWire (IEEE 1394).
51d4f61705SHidetoshi Shimokawa.Pp
52a2931c09SRuslan Ermilov.Xr firewire 4
53d4f61705SHidetoshi Shimokawaand
54a2931c09SRuslan Ermilov.Xr fwohci 4
55d4f61705SHidetoshi Shimokawamust be configured in the kernel as well.
56d4f61705SHidetoshi Shimokawa.Pp
57d4f61705SHidetoshi ShimokawaThis driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
58a2931c09SRuslan Ermilovframes.
59a2931c09SRuslan ErmilovThe stream channel can be specified by
60a2931c09SRuslan Ermilovthe
61a2931c09SRuslan Ermilov.Va hw.firewire.fwe.stream_ch
62a2931c09SRuslan Ermilov.Xr sysctl 8 .
63d4f61705SHidetoshi Shimokawa.Pp
64a2931c09SRuslan ErmilovThis driver supports
65a2931c09SRuslan Ermilov.Xr polling 4
66a2931c09SRuslan Ermilovas well if it is compiled with the
67a2931c09SRuslan Ermilov.Dv DEVICE_POLLING
68a2931c09SRuslan Ermilovoption.
69d4f61705SHidetoshi Shimokawa.Sh SEE ALSO
70d4f61705SHidetoshi Shimokawa.Xr arp 4 ,
71d4f61705SHidetoshi Shimokawa.Xr firewire 4 ,
727d6c1b57SChristian Brueffer.Xr fwip 4 ,
73d4f61705SHidetoshi Shimokawa.Xr fwohci 4 ,
74d4f61705SHidetoshi Shimokawa.Xr netintro 4 ,
75d4f61705SHidetoshi Shimokawa.Xr ng_ether 4 ,
76d4f61705SHidetoshi Shimokawa.Xr polling 4 ,
77d4f61705SHidetoshi Shimokawa.Xr ifconfig 8 ,
78ace5be68SRuslan Ermilov.Xr kldload 8 ,
79d4f61705SHidetoshi Shimokawa.Xr sysctl 8
809cbda590SRuslan Ermilov.Sh HISTORY
819cbda590SRuslan ErmilovThe
829cbda590SRuslan Ermilov.Nm
839cbda590SRuslan Ermilovdevice driver first appeared in
849cbda590SRuslan Ermilov.Fx 5.0 .
85d4f61705SHidetoshi Shimokawa.Sh AUTHORS
86d4f61705SHidetoshi ShimokawaThe
87d4f61705SHidetoshi Shimokawa.Nm
88a2931c09SRuslan Ermilovdriver and this manual page were written by
89d4f61705SHidetoshi Shimokawa.An Hidetoshi Shimokawa .
909cbda590SRuslan Ermilov.Sh BUGS
919cbda590SRuslan ErmilovThis driver emulates Ethernet in a very adhoc way and it does not reserve a
929cbda590SRuslan Ermilovstream channel using an isochronous manager.
939cbda590SRuslan ErmilovNote that this driver uses a protocol which is very different from RFC 2734
949cbda590SRuslan Ermilov(IPv4 over IEEE 1394).
95