share/man/man4/fwip.4

   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
  35 To compile this driver into the kernel,
  36 place the following lines in your
  37 kernel configuration file:
  38 .Bd -ragged -offset indent
  39 .Cd "device firewire"
  40 .Cd "device fwip"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following lines in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 firewire_load="YES"
  48 if_fwip_load="YES"
  49 .Ed
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 driver provides standard IP over FireWire (IEEE 1394) based on the
  54 protocols described in RFC 2734 and RFC 3146.
  55 .Pp
  56 The
  57 .Xr firewire 4
  58 and
  59 .Xr fwohci 4
  60 drivers
  61 must be configured in the kernel as well.
  62 .Pp
  63 This driver supports
  64 .Xr polling 4
  65 as well if it is compiled with the
  66 .Dv DEVICE_POLLING
  67 option.
  68 .Sh SEE ALSO
  69 .Xr arp 4 ,
  70 .Xr firewire 4 ,
  71 .Xr fwe 4 ,
  72 .Xr fwohci 4 ,
  73 .Xr netintro 4 ,
  74 .Xr polling 4 ,
  75 .Xr ifconfig 8 ,
  76 .Xr kldload 8 ,
  77 .Xr sysctl 8
  78 .Sh HISTORY
  79 The
  80 .Nm
  81 device driver first appeared in
  82 .Fx 5.3 .
  83 .Sh AUTHORS
  84 .An -nosplit
  85 The
  86 .Nm
  87 driver and this manual page were written by
  88 .An Doug Rabson ,
  89 based on earlier work by
  90 .An Hidetoshi Shimokawa .
  91 .Sh BUGS
  92 This driver currently does not support the MCAP protocol for multicast
  93 IP over FireWire.
  94 Multicast packets are treated as broadcast packets which is sufficient
  95 for most trivial uses of multicast.