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