share/man/man4/ef.4

   1 .\"
   2 .\" Copyright (c) 1999, Boris Popov
   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 AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd June 20, 1999
  29 .Dt EF 4
  30 .Os
  31 .Sh NAME
  32 .Nm ef
  33 .Nd "pseudo-device driver providing support for multiple Ethernet frame types"
  34 .Sh SYNOPSIS
  35 .Cd "device ef"
  36 .Sh DESCRIPTION
  37 The
  38 .Nm
  39 pseudo-device driver clones each Ethernet type device with four
  40 additional interfaces.
  41 Each of them is capable to send or receive only
  42 one predefined frame type.
  43 .Pp
  44 Names for the new interfaces are created by adding a
  45 .Ar fN
  46 suffix to an existing device name.
  47 Where
  48 .Ar N
  49 is a device unit which can have one of the following values:
  50 .Bd -literal -offset indent
  51 0     interface with an Ethernet_II frame
  52 1     interface with a Novell Ethernet_802.3 frame
  53 2     interface with an Ethernet_802.2 frame
  54 3     interface with an Ethernet_802.2/SNAP frame support.
  55 .Ed
  56 .Pp
  57 For example, device
  58 .Ar ed0
  59 will be populated with four devices:
  60 .Ar ed0f0 ,
  61 .Ar ed0f1 ,
  62 .Ar ed0f2
  63 and
  64 .Ar ed0f3 .
  65 .Pp
  66 After that, each device can be configured as usual:
  67 .Dl # ifconfig ed0f1 ipx 0x105
  68 This will configure IPX protocol with network number
  69 .Ar 0x105
  70 and
  71 .Ar Ethernet_802.3
  72 frame type.
  73 .Pp
  74 Please note that it is impossible to configure the IPX protocol on the parent
  75 .Ar ed0
  76 device after the
  77 .Ar if_ef.ko
  78 driver has been loaded.
  79 .Pp
  80 If the parent interface is not configured for any other protocol
  81 (IP for example), subinterfaces will not function.
  82 To avoid that, the parent interface should be
  83 manually marked as
  84 .Dq up :
  85 .Dl # ifconfig ed0 up
  86 .Sh EXAMPLES
  87 The
  88 .Nm
  89 driver can be loaded via the
  90 .Xr loader.conf 5
  91 file:
  92 .Dl if_ef_load="YES"
  93 .Pp
  94 In this case, ordinary interface configuration commands can be used
  95 in the
  96 .Xr rc.conf 5
  97 file:
  98 .Dl network_interfaces="ed2 lo0 tun0 ed2f0 ed2f1"
  99 .Dl ifconfig_ed2f0_ipx="ipx 0x101"
 100 .Dl ifconfig_ed2f1_ipx="ipx 0x102"
 101 .Sh DIAGNOSTICS
 102 None.
 103 .Sh SEE ALSO
 104 .Xr ipx 3 ,
 105 .Xr ifconfig 8
 106 .Sh AUTHORS
 107 .An Boris Popov Aq bp@FreeBSD.org .
 108 .Sh CAVEATS
 109 Avoid to configure the parent Ethernet device for the IPX protocol, after the
 110 .Nm
 111 driver is loaded.