xref: /freebsd/share/man/man4/fwip.4 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
148ec0513SDoug Rabson.\" Copyright (c) 2004 Doug Rabson
248ec0513SDoug Rabson.\" Copyright (c) 2002 Hidetoshi Shimokawa
348ec0513SDoug Rabson.\" All rights reserved.
448ec0513SDoug Rabson.\"
548ec0513SDoug Rabson.\" Redistribution and use in source and binary forms, with or without
648ec0513SDoug Rabson.\" modification, are permitted provided that the following conditions
748ec0513SDoug Rabson.\" are met:
848ec0513SDoug Rabson.\" 1. Redistributions of source code must retain the above copyright
948ec0513SDoug Rabson.\"    notice, this list of conditions and the following disclaimer.
1048ec0513SDoug Rabson.\" 2. Redistributions in binary form must reproduce the above copyright
1148ec0513SDoug Rabson.\"    notice, this list of conditions and the following disclaimer in the
1248ec0513SDoug Rabson.\"    documentation and/or other materials provided with the distribution.
1348ec0513SDoug Rabson.\"
1448ec0513SDoug Rabson.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
1548ec0513SDoug Rabson.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1648ec0513SDoug Rabson.\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1748ec0513SDoug Rabson.\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
1848ec0513SDoug Rabson.\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1948ec0513SDoug Rabson.\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2048ec0513SDoug Rabson.\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2148ec0513SDoug Rabson.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2248ec0513SDoug Rabson.\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
2348ec0513SDoug Rabson.\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2448ec0513SDoug Rabson.\" POSSIBILITY OF SUCH DAMAGE.
2548ec0513SDoug Rabson.\"
2686e3186eSTom Rhodes.Dd July 16, 2005
2748ec0513SDoug Rabson.Dt FWIP 4
2848ec0513SDoug Rabson.Os
2948ec0513SDoug Rabson.Sh NAME
3048ec0513SDoug Rabson.Nm fwip
3186e3186eSTom Rhodes.Nd "IP over FireWire driver"
3248ec0513SDoug Rabson.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
3748ec0513SDoug Rabson.Cd "device firewire"
3814e3326aSChristian Brueffer.Cd "device fwip"
3986e3186eSTom Rhodes.Ed
4086e3186eSTom Rhodes.Pp
4116d78bb8STom RhodesAlternatively, to load the driver as a
4278ad5421SRuslan Ermilovmodule at boot time, place the following lines in
4386e3186eSTom Rhodes.Xr loader.conf 5 :
4486e3186eSTom Rhodes.Bd -literal -offset indent
4586e3186eSTom Rhodesfirewire_load="YES"
4686e3186eSTom Rhodesif_fwip_load="YES"
4786e3186eSTom Rhodes.Ed
4848ec0513SDoug Rabson.Sh DESCRIPTION
4948ec0513SDoug RabsonThe
5048ec0513SDoug Rabson.Nm
5148ec0513SDoug Rabsondriver provides standard IP over FireWire (IEEE 1394) based on the
5248ec0513SDoug Rabsonprotocols described in RFC 2734 and RFC 3146.
5348ec0513SDoug Rabson.Pp
54dfacb1dfSDoug RabsonThe
5548ec0513SDoug Rabson.Xr firewire 4
5648ec0513SDoug Rabsonand
5748ec0513SDoug Rabson.Xr fwohci 4
58dfacb1dfSDoug Rabsondrivers
5948ec0513SDoug Rabsonmust be configured in the kernel as well.
6048ec0513SDoug Rabson.Pp
6148ec0513SDoug RabsonThis driver supports
6248ec0513SDoug Rabson.Xr polling 4
6348ec0513SDoug Rabsonas well if it is compiled with the
6448ec0513SDoug Rabson.Dv DEVICE_POLLING
6548ec0513SDoug Rabsonoption.
6648ec0513SDoug Rabson.Sh SEE ALSO
6748ec0513SDoug Rabson.Xr arp 4 ,
6848ec0513SDoug Rabson.Xr firewire 4 ,
6914e3326aSChristian Brueffer.Xr fwe 4 ,
7048ec0513SDoug Rabson.Xr fwohci 4 ,
7148ec0513SDoug Rabson.Xr netintro 4 ,
7248ec0513SDoug Rabson.Xr polling 4 ,
7348ec0513SDoug Rabson.Xr ifconfig 8 ,
7448ec0513SDoug Rabson.Xr kldload 8 ,
7548ec0513SDoug Rabson.Xr sysctl 8
769cbda590SRuslan Ermilov.Sh HISTORY
779cbda590SRuslan ErmilovThe
789cbda590SRuslan Ermilov.Nm
799cbda590SRuslan Ermilovdevice driver first appeared in
809cbda590SRuslan Ermilov.Fx 5.3 .
8148ec0513SDoug Rabson.Sh AUTHORS
82c492956fSDoug Rabson.An -nosplit
8348ec0513SDoug RabsonThe
8448ec0513SDoug Rabson.Nm
8548ec0513SDoug Rabsondriver and this manual page were written by
8648ec0513SDoug Rabson.An Doug Rabson ,
8748ec0513SDoug Rabsonbased on earlier work by
8848ec0513SDoug Rabson.An Hidetoshi Shimokawa .
899cbda590SRuslan Ermilov.Sh BUGS
909cbda590SRuslan ErmilovThis driver currently does not support the MCAP protocol for multicast
919cbda590SRuslan ErmilovIP over FireWire.
929cbda590SRuslan ErmilovMulticast packets are treated as broadcast packets which is sufficient
939cbda590SRuslan Ermilovfor most trivial uses of multicast.
94