|
|
|
NDIS object identifiers (OIDs) are a set of system-defined constants that take the form OID_XXX. Higher-level NDIS drivers set these OIDs in an NDIS_REQUEST-type structure for their calls to NdisRequest or NdisCoRequest. This section describes these OIDs.
NDIS OID requests are classified as follows:
An NDIS protocol driver sets NdisRequestQueryInformation for the RequestType parameter to NdisRequest or NdisCoRequest when it makes global queries. Such a request made with NdisRequest is handled by the MiniportQueryInformation function of an underlying NIC driver. Such a request made with NdisCoRequest is handled by the MiniportCoRequest function of an underlying connection-oriented NIC driver or the ProtocolCoRequest function of a connection-oriented client, call manager, or MCM driver, depending on the target of the request.
An NDIS protocol driver sets NdisRequestSetInformation for the RequestType parameter to NdisRequest or NdisCoRequest when it makes this type of request. Such a request made with NdisRequest is handled by the MiniportSetInformation function of an underlying NIC driver. Such a request made with NdisCoRequest is handled by the MiniportCoRequest function an underlying connection-oriented NIC driver. Such a request made with NdisCoRequest is handled by the MiniportCoRequest function of an underlying connection-oriented NIC driver or the ProtocolCoRequest function of a connection-oriented client, call manager, or MCM driver, depending on the target of the request.
Many system-defined OIDs are valid with more than one of the preceding NdisRequestXxx values. Associated with each NDIS object identified by an OID_XXX is a data buffer, which varies in size and format depending on the given OID. The caller of NdisRequest supplies a pointer to this data buffer in the InformationBuffer member of the NDIS_REQUEST structure.
OIDs are either general or media-specific in nature. Each defined OID is either an operational OID or a statistics OID. Support for each NDIS-defined OID is either mandatory or optional.
Some of the information about OIDs is presented in charts. For each entry (row), these charts contain the information summarized in the following table.
| Column Header | Notation Meaning |
|---|---|
| Length | By default, the value indicates the number of bytes of data associated with the OID.
For counters, a length of 4 indicates a 32-bit counter and 8 indicates a 64-bit counter. The NIC driver cannot reset counters; counters wrap when they reach their maximum. Values expressed in the form Arr(n), indicate an array of elements, each of size n. The underlying driver stores array elements consecutively, with no padding. |
| Q | An "M" indicates the mandatory OID is valid in calls to NdisRequest or NdisCoRequest with RequestType value NdisRequestQueryInformation or, from components other than protocols, NdisRequestQueryStatistics. An "O" indicates the optional OID is valid in the same type of request if the underlying NDIS driver supports the OID. |
| S | An "M" indicates the mandatory OID is valid in calls to NdisRequest or NdisCoRequest with RequestType value NdisRequestSetInformation. An "O" indicates the optional OID is valid in the same type of request if the underlying NDIS driver supports the OID. |
| Name | The system-defined OID_XXX, followed by a brief explanation of the constant name. |
NDIS-defined OID_XXX constants are 4-byte values, encoded as shown in the following chart. However, OIDs of the form OID_TAPI_XXX do not have values that explicitly indicate whether support of each OID is mandatory or optional.
| Byte (LSB to MSB) |
Code(s) |
Definition |
|---|---|---|
| 1 | 0xN (unique value) |
Differentiates each OID from others with the same value in the three high-order bytes. |
| 2 | 0x01 | Mandatory |
| 0x02 | Optional | |
| 3 | 0x01 | Operational Characteristics |
| 0x02 | Statistics | |
| 4 | 0x00 | General Information |
| 0x01-0xFE | System-defined media-specific information, as follows: | |
| 0x01 | Ethernet (802.3) | |
| 0x02 | Token Ring (802.5) | |
| 0x03 | Fiber Distributed Data Interface (FDDI) | |
| 0x05 | LocalTalk | |
| 0x06 | ARCNET | |
| 0x04 | Wide area network (WAN) | |
| 0x07 | TAPI | |
| 0x08 | Native ATM | |
| 0x09 | Wireless | |
| 0x0A | Reserved for infrared (IrDA) | |
| 0xFE | Call managers for connection-oriented media | |
| 0xFF | Vendor-specific information |
For OID-specific reference information, see the following sections:
General Objects (OIDs supported by all drivers)