xref: /freebsd/share/man/man4/fwe.4 (revision ace5be682d8e04a1dccf8939efa1babe059e3609)
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.\"
28d4f61705SHidetoshi Shimokawa.Dd November 8, 2002
29d4f61705SHidetoshi Shimokawa.Dt FWE 4
30d4f61705SHidetoshi Shimokawa.Os
31d4f61705SHidetoshi Shimokawa.Sh NAME
32d4f61705SHidetoshi Shimokawa.Nm fwe
33a2931c09SRuslan Ermilov.Nd Ethernet emulation driver for FireWire
34d4f61705SHidetoshi Shimokawa.Sh SYNOPSIS
35f5bff460SHidetoshi Shimokawa.Cd "kldload firewire"
36f5bff460SHidetoshi Shimokawa.Cd "kldload if_fwe"
37f5bff460SHidetoshi Shimokawa.Pp
38f5bff460SHidetoshi Shimokawaor
39f5bff460SHidetoshi Shimokawa.Pp
40d4f61705SHidetoshi Shimokawa.Cd "device fwe"
41d4f61705SHidetoshi Shimokawa.Cd "device firewire"
42d4f61705SHidetoshi Shimokawa.Cd "device fwohci"
43d4f61705SHidetoshi Shimokawa.Sh DESCRIPTION
44d4f61705SHidetoshi ShimokawaThe
45d4f61705SHidetoshi Shimokawa.Nm
46d4f61705SHidetoshi Shimokawadriver provides non-standard ethernet emulation over FireWire (IEEE 1394).
47d4f61705SHidetoshi Shimokawa.Pp
48a2931c09SRuslan Ermilov.Xr firewire 4
49d4f61705SHidetoshi Shimokawaand
50a2931c09SRuslan Ermilov.Xr fwohci 4
51d4f61705SHidetoshi Shimokawamust be configured in the kernel as well.
52d4f61705SHidetoshi Shimokawa.Pp
53d4f61705SHidetoshi ShimokawaThis driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
54a2931c09SRuslan Ermilovframes.
55a2931c09SRuslan ErmilovThe stream channel can be specified by
56a2931c09SRuslan Ermilovthe
57a2931c09SRuslan Ermilov.Va hw.firewire.fwe.stream_ch
58a2931c09SRuslan Ermilov.Xr sysctl 8 .
59d4f61705SHidetoshi Shimokawa.Pp
60a2931c09SRuslan ErmilovThis driver supports
61a2931c09SRuslan Ermilov.Xr polling 4
62a2931c09SRuslan Ermilovas well if it is compiled with the
63a2931c09SRuslan Ermilov.Dv DEVICE_POLLING
64a2931c09SRuslan Ermilovoption.
65d4f61705SHidetoshi Shimokawa.Sh HISTORY
66a2931c09SRuslan ErmilovThe fwe device driver first appeared in
67a2931c09SRuslan Ermilov.Fx 5.0 .
68d4f61705SHidetoshi Shimokawa.Sh BUGS
69a2931c09SRuslan ErmilovThis driver emulates ethernet very adhoc way and it does not reserve a
70a2931c09SRuslan Ermilovstream channel using an isochronous manager.
71a2931c09SRuslan ErmilovNote this driver uses very different protocol from RFC 2734
72a2931c09SRuslan Ermilov(IPv4 over IEEE 1394).
73d4f61705SHidetoshi Shimokawa.Sh SEE ALSO
74d4f61705SHidetoshi Shimokawa.Xr arp 4 ,
75d4f61705SHidetoshi Shimokawa.Xr firewire 4 ,
76d4f61705SHidetoshi Shimokawa.Xr fwohci 4 ,
77d4f61705SHidetoshi Shimokawa.Xr netintro 4 ,
78d4f61705SHidetoshi Shimokawa.Xr ng_ether 4 ,
79d4f61705SHidetoshi Shimokawa.Xr polling 4 ,
80d4f61705SHidetoshi Shimokawa.Xr ifconfig 8 ,
81ace5be68SRuslan Ermilov.Xr kldload 8 ,
82d4f61705SHidetoshi Shimokawa.Xr sysctl 8
83d4f61705SHidetoshi Shimokawa.Sh AUTHORS
84d4f61705SHidetoshi ShimokawaThe
85d4f61705SHidetoshi Shimokawa.Nm
86a2931c09SRuslan Ermilovdriver and this manual page were written by
87d4f61705SHidetoshi Shimokawa.An Hidetoshi Shimokawa .
88