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: src/share/man/man4/fwe.4,v 1.2.4.4 2003/12/25 22:47:38 brueffer Exp $
  26 .\" $DragonFly: src/share/man/man4/fwe.4,v 1.3 2004/01/30 22:38:47 dillon Exp $
  27 .\"
  28 .\"
  29 .Dd November 8, 2002
  30 .Dt FWE 4
  31 .Os
  32 .Sh NAME
  33 .Nm fwe
  34 .Nd Ethernet emulation driver for FireWire
  35 .Sh SYNOPSIS
  36 .Cd "kldload firewire"
  37 .Cd "kldload if_fwe"
  38 .Pp
  39 or
  40 .Pp
  41 .Cd "device fwe"
  42 .Cd "device firewire"
  43 .Cd "device fwohci"
  44 .Sh DESCRIPTION
  45 The
  46 .Nm
  47 driver provides non-standard ethernet emulation over FireWire (IEEE 1394).
  48 .Pp
  49 .Xr firewire 4
  50 and
  51 .Xr fwohci 4
  52 must be configured in the kernel as well.
  53 .Pp
  54 This driver exploits asynchronous stream over IEEE 1394 to carry Ethernet
  55 frames.
  56 The stream channel can be specified by
  57 the
  58 .Va hw.firewire.fwe.stream_ch
  59 .Xr sysctl 8 .
  60 .Pp
  61 This driver supports
  62 .Xr polling 4
  63 as well if it is compiled with the
  64 .Dv DEVICE_POLLING
  65 option.
  66 .Sh HISTORY
  67 The
  68 .Nm
  69 device driver first appeared in
  70 .Fx 5.0 .
  71 .Sh BUGS
  72 This driver emulates ethernet in a very adhoc way and it does not reserve a
  73 stream channel using an isochronous manager.
  74 Note that this driver uses a protocol which is very different from RFC 2734
  75 (IPv4 over IEEE 1394).
  76 .Sh SEE ALSO
  77 .Xr arp 4 ,
  78 .Xr firewire 4 ,
  79 .Xr fwohci 4 ,
  80 .Xr netintro 4 ,
  81 .Xr ng_ether 4 ,
  82 .Xr polling 4 ,
  83 .Xr ifconfig 8 ,
  84 .Xr kldload 8 ,
  85 .Xr sysctl 8
  86 .Sh AUTHORS
  87 The
  88 .Nm
  89 driver and this manual page were written by
  90 .An Hidetoshi Shimokawa .