xref: /freebsd/share/man/man4/fwip.4 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 2004 Doug Rabson
2.\" Copyright (c) 2002 Hidetoshi Shimokawa
3.\" All rights reserved.
4.\"
5.\" Redistribution and use in source and binary forms, with or without
6.\" modification, are permitted provided that the following conditions
7.\" are met:
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in the
12.\"    documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
15.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
18.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
20.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
22.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
23.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
24.\" POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd July 16, 2005
27.Dt FWIP 4
28.Os
29.Sh NAME
30.Nm fwip
31.Nd "IP over FireWire driver"
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 fwip"
39.Ed
40.Pp
41Alternatively, to load the driver as a
42module at boot time, place the following lines in
43.Xr loader.conf 5 :
44.Bd -literal -offset indent
45firewire_load="YES"
46if_fwip_load="YES"
47.Ed
48.Sh DESCRIPTION
49The
50.Nm
51driver provides standard IP over FireWire (IEEE 1394) based on the
52protocols described in RFC 2734 and RFC 3146.
53.Pp
54The
55.Xr firewire 4
56and
57.Xr fwohci 4
58drivers
59must be configured in the kernel as well.
60.Pp
61This driver supports
62.Xr polling 4
63as well if it is compiled with the
64.Dv DEVICE_POLLING
65option.
66.Sh SEE ALSO
67.Xr arp 4 ,
68.Xr firewire 4 ,
69.Xr fwe 4 ,
70.Xr fwohci 4 ,
71.Xr netintro 4 ,
72.Xr polling 4 ,
73.Xr ifconfig 8 ,
74.Xr kldload 8 ,
75.Xr sysctl 8
76.Sh HISTORY
77The
78.Nm
79device driver first appeared in
80.Fx 5.3 .
81.Sh AUTHORS
82.An -nosplit
83The
84.Nm
85driver and this manual page were written by
86.An Doug Rabson ,
87based on earlier work by
88.An Hidetoshi Shimokawa .
89.Sh BUGS
90This driver currently does not support the MCAP protocol for multicast
91IP over FireWire.
92Multicast packets are treated as broadcast packets which is sufficient
93for most trivial uses of multicast.
94