xref: /freebsd/share/man/man4/fwip.4 (revision b6de9e91bd2c47efaeec72a08642f8fd99cc7b20)
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.\" $FreeBSD$
27.\"
28.Dd July 16, 2005
29.Dt FWIP 4
30.Os
31.Sh NAME
32.Nm fwip
33.Nd "IP over FireWire driver"
34.Sh SYNOPSIS
35To compile support for the
36.Xr fwip 4
37driver into your kernel, place the following lines in your
38kernel configuration file:
39.Bd -ragged -offset indent
40.Cd "device firewire"
41.Cd "device fwip"
42.Ed
43.Pp
44Alternatively, to load the
45.Xr fwip 4
46driver at boot time, place the following lines in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49firewire_load="YES"
50if_fwip_load="YES"
51.Ed
52.Sh DESCRIPTION
53The
54.Nm
55driver provides standard IP over FireWire (IEEE 1394) based on the
56protocols described in RFC 2734 and RFC 3146.
57.Pp
58The
59.Xr firewire 4
60and
61.Xr fwohci 4
62drivers
63must be configured in the kernel as well.
64.Pp
65This driver supports
66.Xr polling 4
67as well if it is compiled with the
68.Dv DEVICE_POLLING
69option.
70.Sh SEE ALSO
71.Xr arp 4 ,
72.Xr firewire 4 ,
73.Xr fwe 4 ,
74.Xr fwohci 4 ,
75.Xr netintro 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.3 .
85.Sh AUTHORS
86.An -nosplit
87The
88.Nm
89driver and this manual page were written by
90.An Doug Rabson ,
91based on earlier work by
92.An Hidetoshi Shimokawa .
93.Sh BUGS
94This driver currently does not support the MCAP protocol for multicast
95IP over FireWire.
96Multicast packets are treated as broadcast packets which is sufficient
97for most trivial uses of multicast.
98