diff options
Diffstat (limited to 'share/man/man4/hatm.4')
-rw-r--r-- | share/man/man4/hatm.4 | 114 |
1 files changed, 76 insertions, 38 deletions
diff --git a/share/man/man4/hatm.4 b/share/man/man4/hatm.4 index 26ffebd..59ac3096 100644 --- a/share/man/man4/hatm.4 +++ b/share/man/man4/hatm.4 @@ -51,7 +51,8 @@ The driver interfaces with the framework, .Xr netgraph 4 and the HARP ATM stack. -It provides only PVC services. Signalling, ATMARP, ILMI and other +It provides only PVC services. +Signalling, ATMARP, ILMI and other higher layer protocols are implemented using .Xr netgraph 4 or HARP. @@ -64,7 +65,8 @@ handled by .Xr utopia 4 : .Bl -tag -width XXX .It Cm hw.atm.hatm.natm_traffic -This is the traffic type to be used for NATM pvc connections. The type of +This is the traffic type to be used for NATM pvc connections. +The type of this variable is integer and it must have one of the values 0 (UBR) or 1 (CBR). .It Cm hw.atm.hatm.natm_pcr This is the peak cell rate to be used for NATM CBR connections. @@ -78,12 +80,14 @@ Contains an array of with internal driver statistics. .It Cm hw.atm.hatmN.debug .Em (only if debugging enabled) -These are the debugging flags. See +These are the debugging flags. +See .Fn if_hatmvar.h for the possible flags. .It Cm hw.atm.hatmN.tsr .Em (only if debugging enabled) -This is an array containing all transmission status registers. For each of the +This is an array containing all transmission status registers. +For each of the 4096 possible VCCs there are 15 32-bit registers. .It Cm hw.atm.hatmN.tpd .Em (only if debugging enabled) @@ -120,86 +124,120 @@ hatm0: ForeRunnerHE 622, Rev. D, S/N 2949834, MAC=00:20:48:2d:02:ca When attaching to a device the driver checks the kernel environment (see .Xr kenv 4 ) -to see if the default queues sizes should be overwritten or not. The +to see if the default queues sizes should be overwritten or not. +The following variables are checked and interpreted as unsigned integer values (in either radix): .Bl -tag -width XXX .It Cm hw.hatmN.rbps0_size -Size of the small receive buffer pool 0. This pool is used for all -except raw AAL connections. The pool size must be a power of two between -4 and 8192 inclusive. When attaching the driver allocates this number +Size of the small receive buffer pool 0. +This pool is used for all +except raw AAL connections. +The pool size must be a power of two between +4 and 8192 inclusive. +When attaching the driver allocates this number of mbufs. .It Cm hw.hatmN.rbps0_thresh -Interrupt threshold for small receive buffer pool 0. When the number of free +Interrupt threshold for small receive buffer pool 0. +When the number of free buffers in the pool falls below this threshold it generates an interrupt so that the driver can refill the pool. .It Cm hw.hatmN.rbpl0_thresh -Size of the large receive buffer pool 0. This pool is used for all -except raw AAL connections. The pool size must be a power of two between -4 and 8192 inclusive. When attaching the driver allocates this number +Size of the large receive buffer pool 0. +This pool is used for all +except raw AAL connections. +The pool size must be a power of two between +4 and 8192 inclusive. +When attaching the driver allocates this number of mbufs with clusters. .It Cm hw.hatmN.rbpl0_thresh -Interrupt threshold for large receive buffer pool 0. When the number of free +Interrupt threshold for large receive buffer pool 0. +When the number of free buffers in the pool falls below this threshold it generates an interrupt so that the driver can refill the pool. .It Cm hw.hatmN.rbrq0_size -Size of receive buffer return queue 0. This queue is used to return buffers -filled with received frames to the driver. The size must be a power of 2 +Size of receive buffer return queue 0. +This queue is used to return buffers +filled with received frames to the driver. +The size must be a power of 2 between 1 and 16384 inclusive. .It Cm hw.hatmN.rbrq0_thresh -Interrupt threshold for receive buffer return queue 0. This threshold +Interrupt threshold for receive buffer return queue 0. +This threshold should only be triggered in exceptional cases. .It Cm hw.hatmN.rbrq0_tout -Interrupt timeout for receive buffer return queue 0. An interrupt is generated -after this time if the queue is not empty. The number is in internal card +Interrupt timeout for receive buffer return queue 0. +An interrupt is generated +after this time if the queue is not empty. +The number is in internal card ticks. .It Cm hw.hatmN.rbrq0_pcnt -Packet count threshold for receive buffer return queue 0. An interrupt +Packet count threshold for receive buffer return queue 0. +An interrupt is generated if this number of packets is in the queue. .It Cm hw.hatmN.rbps1_size -Size of the small receive buffer pool 1. This pool is used for all -raw AAL connections. The pool size must be a power of two between -4 and 8192 inclusive. When attaching the driver allocates this number +Size of the small receive buffer pool 1. +This pool is used for all +raw AAL connections. +The pool size must be a power of two between +4 and 8192 inclusive. +When attaching the driver allocates this number of mbufs. .It Cm hw.hatmN.rbps1_thresh -Interrupt threshold for small receive buffer pool 1. When the number of free +Interrupt threshold for small receive buffer pool 1. +When the number of free buffers in the pool falls below this threshold it generates an interrupt so that the driver can refill the pool. .It Cm hw.hatmN.rbrq1_size -Size of receive buffer return queue 1. This queue is used to return buffers -filled with received cells to the driver. The size must be a power of 2 +Size of receive buffer return queue 1. +This queue is used to return buffers +filled with received cells to the driver. +The size must be a power of 2 between 1 and 16384 inclusive. .It Cm hw.hatmN.rbrq1_thresh -Interrupt threshold for receive buffer return queue 1. This threshold +Interrupt threshold for receive buffer return queue 1. +This threshold should only be triggered in exceptional cases. .It Cm hw.hatmN.rbrq1_tout -Interrupt timeout for receive buffer return queue 1. An interrupt is generated -after this time if the queue is not empty. The number is in internal card +Interrupt timeout for receive buffer return queue 1. +An interrupt is generated +after this time if the queue is not empty. +The number is in internal card ticks. .It Cm hw.hatmN.rbrq1_pcnt -Packet count threshold for receive buffer return queue 0. An interrupt +Packet count threshold for receive buffer return queue 0. +An interrupt is generated if this number of cells is in the queue. .It Cm hw.hatmN.irq0_size -Size of interrupt queue 0. This must be a number between 1 and 1023 inclusive. +Size of interrupt queue 0. +This must be a number between 1 and 1023 inclusive. .It Cm hw.hatmN.irq0_thresh -Interrupt retrigger threshold of interrupt queue 0. A new interrupt is trigger +Interrupt retrigger threshold of interrupt queue 0. +A new interrupt is trigger if the queue fill state reaches this threshold and the interrupt was no served. .It Cm hw.hatmN.tbrq0_size -Transmit buffer return queue 0 size. This queue is used to feed back empty -buffers of transmitted frames back to the driver. It must be a power of 2 +Transmit buffer return queue 0 size. +This queue is used to feed back empty +buffers of transmitted frames back to the driver. +It must be a power of 2 between 1 and 4096 inclusive. .It Cm hw.hatmN.tbrq0_thresh -Transmit buffer return queue 0 threshold. An interrupt is generated if the +Transmit buffer return queue 0 threshold. +An interrupt is generated if the queue fill state reaches this point. .It Cm hw.hatmN.tpdrq_size -Transmit descriptor ready queue size. This queue is used by the driver -to feed transmit descriptors into the card. The size must be a power of 2 +Transmit descriptor ready queue size. +This queue is used by the driver +to feed transmit descriptors into the card. +The size must be a power of 2 between 1 and 16384 inclusive. .It Cm hw.hatmN.tpdmax -Maximum number of active TPDs per connection. This controls the maximum +Maximum number of active TPDs per connection. +This controls the maximum number of outstanding packet chunks per connection and thus the maximum -delay packets can have because of queueing on the adapter. If set to 0, +delay packets can have because of queueing on the adapter. +If set to 0, a connection can eat up all available TPDs. .It Cm hw.hatmN.mbuf_max_pages Maximum number of memory pages allocated to small external mbufs. |