5.3 Token Ring Objects

This describes the OIDs for Token Ring objects, both operational and statistical types.

Token Ring Operational Characteristics

The following chart summarizes the OIDs used to get or set Token Ring operational characteristics for NDIS drivers and NICs.

Length	Q	S	Name
6	M		OID_802_5_PERMANENT_ADDRESS  Permanent station address
6	M		OID_802_5_CURRENT_ADDRESS  Current station address
4	M	M	OID_802_5_CURRENT_FUNCTIONAL  Current functional address
4	M	M	OID_802_5_CURRENT_GROUP  Current group address
4	M		OID_802_5_LAST_OPEN_STATUS  Last open status
4	M		OID_802_5_CURRENT_RING_STATUS  Current ring status
4	M		OID_802_5_CURRENT_RING_STATE  Current ring state

The following describes each of the OID_XXX listed in the preceding chart more fully.

OID_802_5_PERMANENT_ADDRESS

The address of the NIC encoded in the hardware.

OID_802_5_CURRENT_ADDRESS

The address the NIC is currently using.

The network management software cannot set the current station address using the NDIS library. It must set the address as a configuration parameter.

OID_802_5_CURRENT_FUNCTIONAL

The functional address enabled on the NIC for packet reception.

When the underlying driver initializes its NIC, it resets the functional address to zero. NDIS also initializes the packet filter so that a protocol does not receive functional address packets.

To receive a functional address packet, a bound protocol must later set the packet filter to include the NDIS_PACKET_TYPE_FUNCTIONAL flag. At any time, it can disable packet reception by canceling this flag. The order in which the protocol enables reception for functional address packets is unimportant.

OID_802_5_CURRENT_GROUP

The group address enabled on the NIC for packet reception.

OID_802_5_LAST_OPEN_STATUS

The last open error status returned for a protocol’s call to NdisOpenAdapter.

If the open succeeded, a status code other than NDIS_STATUS_OPEN_FAILED was returned for the most recent open of the target NIC, so the value returned for this query should be zero.

OID_802_5_CURRENT_RING_STATUS

The last ring status indicated with an NDIS_RING_XXX status code, which can be any of the following values:
NDIS_RING_SIGNAL_LOSS
NDIS_RING_HARD_ERROR
NDIS_RING_SOFT_ERROR
NDIS_RING_TRANSMIT_BEACON
NDIS_RING_LOBE_WIRE_FAULT
NDIS_RING_AUTO_REMOVAL_ERROR
NDIS_RING_REMOVE_RECEIVED
NDIS_RING_COUNTER_OVERFLOW
NDIS_RING_SINGLE_STATION
NDIS_RING_RING_RECOVERY

OID_802_5_CURRENT_RING_STATE

The state of the NIC driver with respect to entering the ring, as one of the following:

NdisRingStateOpened

Specifies an open ring.

NdisRingStateClosed

Specifies a closed ring.

NdisRingStateOpening

Specifies a ring that is opening.

NdisRingStateClosing

Specifies a ring that is closing.

NdisRingStateOpenFailure

Specifies a failure of a ring open operation.

NdisRingStateRingFailure

Specifies a failure of the ring.

Token Ring Statistics

The following chart summarizes the OIDs used to get Token Ring statistics for NICs.

Length	Q	S	Name
4	M		OID_802_5_LINE_ERRORS  FCS or code violations detected in repeated frame
4	M		OID_802_5_LOST_FRAMES  Frames transmitted that have failed to return
4	O		OID_802_5_BURST_ERRORS  Number of five half-bit transition absences detected
4	O		OID_802_5_AC_ERRORS  Access control (A/C) errors
4	O		OID_802_5_ABORT_DELIMITERS  Frames transmitted with abort delimiter
4	O		OID_802_5_FRAME_COPIED_ERRORS  Frame copy errors
4	O		OID_802_5_FREQUENCY_ERRORS  Frequency errors detected
4	O		OID_802_5_TOKEN_ERRORS  Active monitor regenerations
4	O		OID_802_5_INTERNAL_ERRORS  Internal errors detected

The following describes each of the OID_XXX listed in the preceding chart more fully.

OID_802_5_LINE_ERRORS

The number of frames with an invalid FCS or a code violation.

OID_802_5_LOST_FRAMES

The number of frames transmitted that have not circled the ring within the maximum ring latency.

OID_802_5_BURST_ERRORS

The number of frames containing five half bits with no transition.

OID_802_5_AC_ERRORS

The number of frames with A/C errors.

OID_802_5_ABORT_DELIMITERS

The number of abort delimiters transmitted.

OID_802_5_FRAME_COPIED_ERRORS

The number of frames addressed to this NIC that another NIC on the ring has also copied.

OID_802_5_FREQUENCY_ERRORS

The number of frequency errors on the ring.

OID_802_5_TOKEN_ERRORS

The number of times the NIC has been the active monitor and has had to recreate.

OID_802_5_INTERNAL_ERRORS

The number of internal errors the NIC has detected.