share/man/man4/fwe.4

   1 .\" Copyright (c) 2002 Hidetoshi Shimokawa
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  15 .\" WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  16 .\" DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
  17 .\" INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  18 .\" (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
  19 .\" SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  21 .\" STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  22 .\" ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  23 .\" POSSIBILITY OF SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .\"
  28 .Dd July 16, 2005
  29 .Dt FWE 4
  30 .Os
  31 .Sh NAME
  32 .Nm fwe
  33 .Nd "Ethernet emulation driver for FireWire"
  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 fwe"
  41 .Ed
  42 .Pp
  43 Alternatively, to load the driver as a
  44 module at boot time, place the following line in
  45 .Xr loader.conf 5 :
  46 .Bd -literal -offset indent
  47 if_fwe_load="YES"
  48 .Ed
  49 .Sh DESCRIPTION
  50 The
  51 .Nm
  52 driver provides non-standard Ethernet emulation over FireWire (IEEE 1394).
  53 .Pp
  54 .Xr firewire 4
  55 and
  56 .Xr fwohci 4
  57 must be configured in the kernel as well.
  58 .Pp
  59 This driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
  60 frames.
  61 The stream channel can be specified by
  62 the
  63 .Va hw.firewire.fwe.stream_ch
  64 .Xr sysctl 8 .
  65 .Pp
  66 This driver supports
  67 .Xr polling 4
  68 as well if it is compiled with the
  69 .Dv DEVICE_POLLING
  70 option.
  71 .Sh SEE ALSO
  72 .Xr arp 4 ,
  73 .Xr firewire 4 ,
  74 .Xr fwip 4 ,
  75 .Xr fwohci 4 ,
  76 .Xr netintro 4 ,
  77 .Xr ng_ether 4 ,
  78 .Xr polling 4 ,
  79 .Xr ifconfig 8 ,
  80 .Xr kldload 8 ,
  81 .Xr sysctl 8
  82 .Sh HISTORY
  83 The
  84 .Nm
  85 device driver first appeared in
  86 .Fx 5.0 .
  87 .Sh AUTHORS
  88 The
  89 .Nm
  90 driver and this manual page were written by
  91 .An Hidetoshi Shimokawa .
  92 .Sh BUGS
  93 This driver emulates Ethernet in a very adhoc way and it does not reserve a
  94 stream channel using an isochronous manager.
  95 Note that this driver uses a protocol which is very different from RFC 2734
  96 (IPv4 over IEEE 1394).