atmHeaderCounter
atmHeaderCounter - configure ATM counters for VPI and VCI values.
SYNOPSIS
atmHeaderCounter sub-command options
DESCRIPTION
The atmHeaderCounter command is used to configure the ATM configure a counter that can set the VPI or VCI value to:
- Fixed: a single value is used throughout.
- Counter: an incrementing counter is applied.
- Random: a masked set of bits are randomly set.
- Table: a table of values is repetitively used.
The selection of VPI or VCI is performed in the set and get sub-commands.
STANDARD OPTIONS
dataItemList
If the type option is set to atmTableMode, then this TCL list is used for the set of values. (default = {})
maskselect
If the type option is set to atmRandom, then this 16-bit mask indicates which bits are held constant. The constant values are indicated in the maskvalue option. (default = {00 00})
maskvalue
If the type option is set to atmRandom, then this 16-bit value indicates the values that the bits indicated in the maskselect option should have. (default = {00 00})
mode
If the type option is set to atmCounter, then this indicates what counter mode should be used.
Option |
Value |
Usage |
---|---|---|
atmIncrement |
0 |
(default) Increment the VPI/VCI value for the number of times indicated in the repeatCount option by the value indicated in the step option. After the repeatCount is exhausted, the value from the vpi or vci option in the atmHeader command is used. |
atmContinuousIncrement |
1 |
Continuously increment the VPI/VCI value by the value indicated in the step option. |
atmDecrement |
2 |
Decrement the VPI/VCI value for the number of times indicated in the repeatCount option by the value indicated in the step option. After the repeatCount is exhausted, the value from the vpi or vci option in the atmHeader command is used. |
atmContinuousDecrement |
3 |
Continuously decrement the VPI/VCI value by the value indicated in the step option. |
repeatCount
If the type option is set to atmCounter and the mode option is set to atmIncrement or atmDecrement, then this is the number of time to increment the VPI/VCI value before repeating from the start value. (default = 1)
step
If the type option is set to atmCounter, then this is the value added/subtracted between successive values. (default = 1)
type
The type of counter to use on the VPI/VCI.
Option |
Value |
Usage |
---|---|---|
atmIdle |
0 |
(default) The VPI/VCI has a fixed value set in the atmHeader command's vpi or vci option. |
atmCounter |
1 |
The VPI/VCI value increments or decrements for a fixed number of repetitions or continuously, as dictated by the mode and repeatCount options. The step size is in the step option. The starting value is set in the value set in the atmHeader command's vpi or vci option. |
atmRandom |
2 |
Selected bits of VPI/VCI value varies randomly. The mask of values that are fixed is in the maskselect option and their fixed values are in the maskvalue option. |
atmTableMode |
3 |
The VPI/VCI values are selected round-robin from the data table in the dataItemList option. |
COMMANDS
The atmHeaderCounter command is invoked with the following sub-commands. If no sub-command is specified, returns a list of all sub-commands available.
atmHeaderCounter cget option
Returns the current value of the configuration option given by option. Option may have any of the values accepted by the atmHeaderCounter command.
atmHeaderCounter config option value
Modify the configuration options of the atmHeaderCounter. If no option is specified, returns a list describing all of the available options (see STANDARD OPTIONS) for atmHeaderCounter.
atmHeaderCounter get type
Gets the current configuration of the atmHeaderCounter for the VPI/VCI type indicated in the type argument.The choices are:
Option |
Value |
Usage |
---|---|---|
atmVpi |
0 |
(default) The VPI value. |
atmVci |
1 |
The VCI value. |
Call this command before calling atmHeaderCounter cget option value to get the value of the configuration option. Specific errors are:
- Invalid type
atmHeaderCounter set type
Sets the current configuration of the atmHeaderCounter for the VPI/VCI type indicated in the type argument.The choices are:
Option |
Value |
Usage |
---|---|---|
atmVpi |
0 |
(default) The VPI value. |
atmVci |
1 |
The VCI value. |
Specific errors are:
- Invalid type
- Invalid parameter settings
atmHeaderCounterset Default
Sets to IxTclHal default values for all configuration options.
EXAMPLES
See examples in atmHeader.