NDIS 5.x Legacy Functions (Compact 7)

3/12/2014

This topic includes the NDIS 5.x legacy functions that are referenced by NDIS 6.0 and related topics.

In This Section

• DriverEntry
  A required function that the system calls first in any NDIS 5.x driver

• MiniportCancelSendPackets
  Cancels the transmission of all packets that are marked with a specified cancellation identifier

• MiniportCheckForHang
  Reports the state of the network adapter or monitors the responsiveness of an underlying device driver

• MiniportDisableInterrupt
  Supplied by drivers of network adapters that support dynamic enabling and disabling of interrupts but do not share an IRQ

• MiniportEnableInterrupt
  Supplied by some drivers of network adapters that support dynamic enabling and disabling of interrupts but do not share an IRQ

• MiniportHalt
  Deallocates resources when the network adapter is removed, and halts the network adapter

• MiniportHandleInterrupt
  Performs the deferred processing of all outstanding interrupt operations

• MiniportInitialize
  Sets up a network adapter or virtual network adapter for network I/O operations, claims all hardware resources necessary to the network adapter in the registry, and allocates resources the driver needs in order to perform network I/O operations

• MiniportISR
  A required function if the driver's network adapter generates interrupt

• MiniportQueryInformation
  Returns information about the capabilities and status of the driver and its network adapter

• MiniportReconfigure
  Can be called by the MiniportInitialize function as an internal driver function

• MiniportReset
  Issues a hardware reset to the network adapter and resets the driver's software state

• MiniportReturnPacket
  A required function in drivers that indicate receives with NdisMIndicateReceivePacket

• MiniportSend
  Transfers a protocol-supplied packet over the network

• MiniportSendPackets
  Transfers some number of packets, specified as an array of packet pointers, over the network

• MiniportSetInformation
  Allows bound protocol drivers or NDIS to request changes in the state information that the miniport maintains for particular object identifiers, such as changes in multicast addresses

• MiniportShutdown
  Restores a network adapter to its initial state when the system is shut down

• MiniportSynchronizeISR
  A required function for network adapter driver functions that run at less than DIRQL and share resources with that driver's MiniportISR or MiniportDisableInterrupt function

• MiniportTimer
  A required function if a driver's network adapter does not generate interrupts

• MiniportTransferData
  A required function in network adapter drivers that do not indicate multipacket receives and media-specific information by using NdisMIndicateReceivePacket, and in those that do not support WAN media

• MiniportWanSend
  A required function if the driver controls a WAN network adapter

• NdisAdjustBufferLength
  Modifies the length specified in a buffer descriptor allocated or copied by the caller

• NdisAllocateBuffer
  Creates a buffer descriptor mapping a specified virtual range or sub-range in an already allocated memory block

• NdisAllocateBufferPool
  Returns a handle with which the caller can allocate buffer descriptors

• NdisAllocateMemory
  Allocates resident system-space memory

• NdisAllocateMemoryWithTag
  Allocates resident system-space memory

• NdisAllocatePacket
  Allocates and initializes a packet descriptor

• NdisAllocatePacketPool
  Allocates and initializes a block of storage for a pool of packet descriptors

• NdisCancelSendPackets
  Cancels transmission of all packets marked with the specified cancellation identifier on the miniport identified by the binding handle

• NdisCloseAdapter
  Releases the binding established and the resources allocated when the protocol called the NdisOpenAdapter function

• NdisCompleteBindAdapter
  Finishes a binding operation for which the caller's ProtocolBindAdapter function previously returned NDIS_STATUS_PENDING

• NdisCompletePnPEvent
  Finishes a protocol's response to a Plug and Play or Power Management event for which the protocol's ProtocolPnPEvent function previously returned NDIS_STATUS_PENDING

• NdisCompleteUnbindAdapter
  Finishes an unbinding operation for which the caller's ProtocolBindAdapter function previously returned NDIS_STATUS_PENDING

• NdisDeregisterProtocol
  Releases the resources allocated when the driver calls the NdisRegisterProtocol function

• NdisDprAllocatePacket
  Allocates and initializes a packet descriptor

• NdisDprFreePacket
  Releases a driver-allocated packet descriptor and returns it to the free list

• NdisFreeBuffer
  Releases a buffer descriptor that was obtained in a previous call to the NdisAllocateBuffer function

• NdisFreeBufferPool
  Releases a handle that was obtained in a previous call to the NdisAllocateBufferPool function

• NdisFreePacket
  Releases a packet that was allocated from a packet pool with the NdisAllocatePacket function and returns it to the free list

• NdisFreePacketPool
  Releases a handle to a block of packet pool that was allocated with the NdisAllocatePacket function

• NdisGetFirstBufferFromPacket
  Returns pointers to the buffer descriptor and base virtual address for the initial buffer chained to a specified packet descriptor, together with the sizes of the initial buffer and total buffer in case the buffer is fragmented

• NdisGetFirstBufferFromPacketSafe
  Returns pointers to the buffer descriptor and base virtual address for the first buffer chained to a given packet descriptor, together with the sizes of the first buffer and the total buffer

• NdisGetNextBuffer
  Returns the next buffer descriptor in a chain, provided it has a pointer to the current buffer descriptor

• NdisGetPacketCancelId
  Returns the cancellation identifier that is assigned to a packet

• NdisGetPacketFlags
  Returns the flags, if any, set by a protocol driver in a specified packet descriptor

• NdisGetReceivedPacket
  Retrieves a received packet from the underlying driver

• NdisGetSystemUpTime
  Returns the number of milliseconds that have elapsed since the system was booted

• NdisIMInitializeDeviceInstance
  Calls an NDIS intermediate driver's MiniportInitialize function to set up the driver's virtual network adapter for I/O operations on an underlying network adapter driver to which the intermediate driver is bound

• NdisIMRegisterLayeredMiniport
  Registers an intermediate driver's MiniportXXX entry points and name with the NDIS library when the driver initializes

• NdisMCancelTimer
  Cancels a preceding call to the NdisMSetPeriodicTimer function or cancels the preceding call to the NdisMSetTimer function if the interval specified to NdisMSetTimer has not yet expired

• NdisMDeregisterAdapterShutdownHandler
  Removes a network adapter-driver-supplied MiniportShutdown function from the list of registered shutdown handlers to be called.

• NdisMDeregisterInterrupt
  Stops a miniport's interrupt service routine (ISR) from being called to handle network adapter interrupts

• NdisMIndicateStatus
  Indicates changes in the status of a network adapter to higher-level NDIS drivers

• NdisMIndicateStatusComplete
  Notifies NDIS, or NDISWAN, that the network adapter driver, which has called the NdisMIndicateStatus function one or more times to indicate hardware anomalies or run-time state changes in the network adapter, is ready to resume standard device I/O operation

• NdisMIndicateReceivePacket
  Notifies NDIS that an array of received packets is available to be forwarded to the appropriate bound protocol drivers

• NdisMInitializeTimer
  Initializes a timer object associated with a caller-supplied MiniportTimer function

• NdisMInitializeWrapper
  Notifies NDIS that a new miniport is initializing

• NdisMPciAssignResources
  Returns a list of bus-relative hardware resources, such as IRQ, I/O ports, and device memory ranges

• NdisMPromoteMiniport
  Promotes a secondary miniport adapter to the primary role after the primary miniport adapter is removed from the system

• NdisMQueryAdapterResources
  returns a list of hardware resources for a network adapter

• NdisMQueryInformationComplete
  Indicates that a prior call to the MiniportQueryInformation function, which returned NDIS_STATUS_PENDING, has completed

• NdisMRegisterAdapterShutdownHandler
  Registers a network adapter-driver-supplied MiniportShutdown function to be called when the system is shutting down

• NdisMRegisterInterrupt
  Sets up a mapping between a network adapter driver's MiniportISR and MiniportHandleInterrupt functions

• NdisMRegisterMiniport
  Registers a network adapter or intermediate driver's Miniport_* entry points and name with the NDIS library when the driver initializes

• NdisMRegisterUnloadHandler
  Registers an unload handler for a driver

• NdisMSendComplete
  Returns the packet and final status of a completed send request for which the driver previously returned NDIS_STATUS_PENDING

• NdisMSendResourcesAvailable
  Notifies NDIS that a miniport has sufficient internal resources to accept another send request, even though one or more outstanding send packets are pending within the miniport

• NdisMSetAttributes
  Informs the NDIS library about significant features of the caller's network adapter during initialization

• NdisMSetAttributesEx
  Informs the NDIS library about significant features of the caller's network adapter or virtual network adapter during initialization

• NdisMSetInformationComplete
  Returns the final status of a completed set-information request for which the driver previously returned NDIS_STATUS_PENDING

• NdisMSetMiniportSecondary
  Sets the specified miniport adapter to the secondary role in relation to the primary miniport adapter

• NdisMSetPeriodicTimer
  Sets a timer to fire periodically, thus running an associated caller-supplied MiniportTimer function repeatedly at fixed intervals

• NdisMSetTimer
  Sets a timer to fire after a specified interval, therefore running an associated MiniportTimer function when the timer fires

• NdisMSynchronizeWithInterrupt
  Synchronizes execution of a miniport-supplied function together with the MiniportISR or the MiniportDisableInterrupt function

• NdisMTransferDataComplete
  Returns the packet and completion status for a transfer-data request for which the miniport previously returned NDIS_STATUS_PENDING

• NdisMWanSendComplete
  Returns the packet and final status of a completed send request for which the miniport previously returned NDIS_STATUS_PENDING

• NdisOpenAdapter
  Sets up a binding between the calling protocols and a particular underlying network adapter driver or NDIS intermediate driver

• NdisOpenConfiguration
  Returns a handle for an NDIS network adapter driver's \DriverName\Parms registry key

• NdisOpenProtocolConfiguration
  Returns a handle for the HKEY_LOCAL_MACHINE\Comm\ProtocolName\Parms registry key

• NdisQueryBuffer
  Retrieves the size of the range from a buffer descriptor and, optionally, its base virtual address

• NdisQueryBufferOffset
  Retrieves the base virtual address of the range that is specified in a specified buffer descriptor

• NdisQueryBufferSafe
  The safe version of NdisQueryBuffer. Unlike NdisQueryBuffer, this function does not cause a bug check if system resources are low or exhausted.

• NdisQueryPacket
  Returns information about a specified packet

• NdisReadPciSlotInformation
  Returns bus-specific PCI configuration information from the PCI configuration space for a device at a particular socket on the bus

• NdisRegisterProtocol
  Registers an NDIS driver's Protocol_* entry points and name with the NDIS library when the driver initializes

• NdisReinitializePacket
  Removes any chained buffers from a given packet and reinitializes it for reuse

• NdisRequest
  Forwards a request to the underlying driver that it query the capabilities or status of its network adapter or that it set the state of its network adapter

• NdisReset
  Forwards a reset request to an underlying driver

• NdisReturnPackets
  Releases ownership of one or more packets after a protocol has consumed the received data

• ProtocolResetComplete
  Finishes a protocol-initiated reset operation for which NdisReset returned NDIS_STATUS_PENDING

• NdisSend
  Forwards a send request to the underlying driver

• NdisSendPackets
  Forwards a multipacket send request, possibly with associated out-of-band information, to the underlying driver

• NdisSetPacketFlags
  Sets caller-determined and medium-specific information in the flags of a given packet descriptor

• NdisTerminateWrapper
  Releases system resources that were allocated when the network adapter driver called the NdisMInitializeWrapper function

• NdisTransferData
  Forwards a request to copy data that was received on the underlying network adapter into a protocol-supplied packet

• NdisWriteErrorLogEntry
  Writes an entry to the system I/O error log file

• NdisWritePciSlotInformation
  Writes a specified number of bytes to the PCI configuration space for an network adapter on the PCI bus

• ProtocolBindAdapter
  Supports Plug and Play

• ProtocolCloseAdapterComplete
  Finishes processing for an unbinding operation for which NdisCloseAdapter returned NDIS_STATUS_PENDING

• ProtocolOpenAdapterComplete
  Finishes processing of a binding operation for which NdisOpenAdapter returned NDIS_STATUS_PENDING

• ProtocolPnPEvent
  Indicates a Plug and Play event or a Power Management event to a protocol bound to a network adapter

• ProtocolReceive
  Determines whether a received network packet is interesting to the protocol's clients and, if so, copies the indicated data

• ProtocolReceiveComplete
  Finishes post-processing of one or more previous receive indications from a network adapter driver

• ProtocolReceivePacket
  Processes receive indications made by underlying connectionless network adapter driver(s)

• ProtocolRequestComplete
  Finishes the processing of a protocol-initiated query or set for which NdisRequest returned NDIS_STATUS_PENDING

• ProtocolSendComplete
  Finishes the processing of a protocol-initiated send previously passed to NdisSendPackets or NdisSend which returned NDIS_STATUS_PENDING

• ProtocolStatus
  Handles status-change notifications raised by an underlying connectionless network adapter driver or by NDIS

• ProtocolStatusComplete
  Finishes a status-change operation initiated when the underlying driver called NdisMIndicateStatus

• ProtocolTransferDataComplete
  Finishes the processing of a protocol-initiated transfer-data request for which NdisTransferData returned NDIS_STATUS_PENDING

• ProtocolUnbindAdapter
  Supports Plug and Play

See Also

Reference

NDIS 5.x Legacy Reference
NDIS 5.x Legacy Structures
NDIS 5.x Legacy Wireless LAN OIDs
NDIS 5.x Legacy Data Types
NDIS 5.x Legacy Network Driver Macros
NDIS 5.x Legacy Messages
NDIS 5.x Legacy NDISTAPI Object Identifiers
NDIS 5.x Legacy NDISWAN Object Identifiers
NDIS 5.x Legacy Token Ring Object Identifiers