usr.sbin/pvctxctl/pvctxctl.8

   1 .\" Copyright (C) 1998
   2 .\"     Sony Computer Science Laboratory Inc.  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 SONY CSL 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 SONY CSL 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 .\" $NetBSD: pvctxctl.8,v 1.6 2005/09/11 23:43:27 wiz Exp $
  26 .\"
  27 .Dd December 29, 1997
  28 .Dt PVCTXCTL 8
  29 .Os
  30 .Sh NAME
  31 .Nm pvctxctl
  32 .Nd display or control ATM PVC transmitter parameters
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Ar interface
  36 .Op Oo vpi : Oc Ns Ar vci
  37 .Nm
  38 .Ar interface
  39 .Oo vpi : Oc Ns Ar vci
  40 .Op Fl n
  41 .Op Fl b Ar max-bandwidth
  42 .Op Fl j Oo vpi : Oc Ns Ar vci
  43 .Op Fl p Ar pcr
  44 .Sh DESCRIPTION
  45 .Nm
  46 displays or controls the shaper parameters of an ATM VC.
  47 When a shaper value is specified,
  48 .Nm
  49 sets a shaper to an ATM VC.
  50 .Nm
  51 works for a PVC sub interface
  52 .Xr pvc 4
  53 as well as a real ATM interface
  54 .Xr en 4 .
  55 .Pp
  56 For a real ATM interface, the specified VC should be assigned
  57 beforehand by
  58 .Xr route 8 .
  59 .Pp
  60 For a sub interface,
  61 .Nm
  62 assigns the specified VC to the sub interface.  If another VC is
  63 already assigned to the sub interface, the old VC is invalidated.
  64 .Pp
  65 Availability of shapers, the number of hardware shaper channels,
  66 and accuracy of shaping are all device dependent.
  67 For example, ENI Midway chip has 8 shaper channels but the driver
  68 reserves one for non-shaping VCs.
  69 .Pp
  70 The options are as follows:
  71 .Bl -tag -width Fl
  72 .It Ar interface
  73 The
  74 .Ar interface
  75 parameter is a string of the form
  76 .Dq name unit ,
  77 for example,
  78 .Dq en0 .
  79 .It Oo vpi: Oc Ns Ar vci
  80 The VC number to which the shaper is assigned.
  81 When the VPI number is omitted, VPI number 0 is
  82 assumed.
  83 For example, to assign a shaper to VPI=0 and
  84 VCI=201, the following forms can be used:
  85 "201", "0xc9", "0:201", "0:0xc9".
  86 .It Fl b Ar max-bandwidth
  87 The PCR parameter can be specified also in
  88 .Dq bits per second .
  89 The rate is the rate of AAL5 frame and
  90 the PCR is calculated by the following form:
  91 .Pp
  92 .Dl PCR = max-bandwidth / 8 / 48
  93 .Pp
  94 .Dq K
  95 and
  96 .Dq M
  97 can be used as a short hand of
  98 .Dq 000
  99 and
 100 .Dq 000000
 101 respectively.  For example,
 102 .Dq 45M
 103 means
 104 .Dq 45Mbps
 105 or PCR value
 106 .Dq 117187 .
 107 .It Fl j Oo vpi : Oc Ns Ar vci
 108 The join parameter is intended for VP shaping.
 109 The VC shaper channel is shared with the existing VC,
 110 which means the sum of the cell rates never exceeds
 111 the maximum PCR among the shared VCs.
 112 On the other hand, when the shaper channel is not shared,
 113 the sum of the cell rates could be the sum of the PCRs.
 114 .Pp
 115 For example, if two VCs (say 201 and 202) share a
 116 45Mbps VP, use:
 117 .Pp
 118 .Dl # pvctxctl en0 201 -b 45M
 119 .Dl # pvctxctl en0 202 -b 45M -j 201
 120 .It Fl n
 121 This parameter is only for a sub interface.
 122 Use NULL encapsulation instead of LLC/SNAP.
 123 .It Fl p Ar pcr
 124 The PCR (Peak Cell Rate) parameter specifies the peak cell rate in
 125 "cells per second".
 126 If PCR value "0" is specified,
 127 no shaper is assigned, which means cells are sent at
 128 full-speed of the link.
 129 If PCR value
 130 .Dq -1
 131 is specified, the corresponding VC
 132 is invalidated.
 133 .El
 134 .Sh SEE ALSO
 135 .Xr en 4 ,
 136 .Xr ifconfig 8 ,
 137 .Xr pvcsif 8 ,
 138 .Xr route 8
 139 .Sh BUGS
 140 A real ATM interface and a sub interface require different
 141 sequences to set a shaper.
 142 For example, to assign a 45Mbps shaper to VC 201 (0xc9) of en0:
 143 .Bd -literal -offset indent
 144 # ifconfig en0 10.0.0.1
 145 # route add -iface 10.0.0.2 -link en0:3.0.0.c9
 146 # pvctxctl en0 0xc9 -b 45M
 147 .Ed
 148 .Pp
 149 For a shadow interface,
 150 .Bd -literal -offset indent
 151 # pvcsif en0                            # creates pvc0
 152 # ifconfig pvc0 10.0.0.1 10.0.0.2
 153 # pvctxctl pvc0 201 -b 45M
 154 .Ed