share/man/man4/ng_atmllc.4

   1 .\" Copyright (c) 2004 Benno Rice <benno@FreeBSD.org>
   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 AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd March 8, 2004
  28 .Dt NG_ATMLLC 4
  29 .Os
  30 .Sh NAME
  31 .Nm ng_atmllc
  32 .Nd ATM LLC netgraph node type
  33 .Sh SYNOPSIS
  34 .In netgraph/ng_atmllc.h
  35 .Sh DESCRIPTION
  36 The
  37 .Nm atmllc
  38 node type translates frames in to and out of ATM LLC encapsulation,
  39 as specified by RFC 1483.
  40 In LLC encapsulation the protocol of a given protocol data unit (PDU) is
  41 specified by an IEEE 802.2 LLC header, possibly followed by an IEEE 802.1a
  42 SubNetwork Attachment Point (SNAP) header.
  43 This node currently handles the Ethernet and FDDI protocols.
  44 .Pp
  45 The node transmits and receives ATM PDUs on the
  46 .Va atm
  47 hook.
  48 Received PDUs are decoded and forwarded to the
  49 .Va ether
  50 or
  51 .Va fddi
  52 hooks as appropriate.
  53 Data received on the
  54 .Va ether
  55 or
  56 .Va fddi
  57 hooks are assumed to be full Ethernet or FDDI packets as appropriate and are
  58 encapsulated into a PDU and transmitted via the
  59 .Va atm
  60 hook.
  61 .Sh HOOKS
  62 This node type supports the following hooks:
  63 .Bl -tag -width indent
  64 .It Va atm
  65 ATM connection.
  66 Typically, this hook would be connected to a
  67 .Xr ng_atm 4
  68 node, which handles transmission of ATM PDUs over an ATM device.
  69 .It Va ether
  70 Ethernet connection.
  71 This hook sends and receives Ethernet frames.
  72 This would normally be connected to an
  73 .Xr ng_eiface 4
  74 node if in use.
  75 .It Va fddi
  76 FDDI connection.
  77 This hook sends and receives FDDI frames.
  78 .El
  79 .Sh CONTROL MESSAGES
  80 This node type supports the generic control messages.
  81 .Sh SHUTDOWN
  82 This node shuts down upon receipt of a
  83 .Dv NGM_SHUTDOWN
  84 control message, or when all hooks have been disconnected.
  85 .Sh SEE ALSO
  86 .Xr netgraph 4 ,
  87 .Xr ng_atm 4 ,
  88 .Xr ng_eiface 4 ,
  89 .Xr ngctl 8
  90 .Rs
  91 .%A J. Heinanen
  92 .%T "Multiprotocol Encapsulation over ATM Adaptation Layer 5"
  93 .%O RFC 1483
  94 .Re
  95 .Sh AUTHORS
  96 .An Benno Rice Aq benno@FreeBSD.org