Storport driver miniport routines

A miniport driver that works with the Storport driver must contain implementations of the routine descriptions listed in this section, and it must expose them through a HW_INITIALIZATION_DATA structure during the miniport driver's initialization phase.

The Storport miniport driver routines are in most respects equivalent to their SCSI port counterparts (see SCSI Miniport Driver Routines for more information). However, there are important differences between the design of the SCSI port driver and that of the Storport driver, and these routines must accommodate those differences.

For instance, miniport drivers that work with the Storport driver must always be prepared to receive another I/O request after the HwStorStartIo routine has completed. A miniport driver that works with SCSI port is not required to do this. The SCSI port version does not receive a new I/O request until it explicitly signals the port driver, using the StorPortNotification function, that it is prepared to handle another request.

If the Storport version of the miniport driver cannot handle a request at the time it is submitted, it has a set of queue management functions, not available to the SCSI port version, that allow it to deal with the overload. Like the SCSI port version, the Storport version of the miniport driver completes the request with SRB_STATUS_BUSY, but unlike the SCSI port version, it can also mark the device queue as busy using the StorPortDeviceBusy routine. Similar functions allow the miniport driver to pause and resume processing on an adapter-wide basis.

For more information about the support routines provided by the Storport driver, see Storport driver support routines.

For more information about the Storport driver, see Storage Port Drivers.

The following are miniport driver routines:

Routine	Description
HW_MESSAGE_SIGNALED_INTERRUPT_ROUTINE	Handles a message signaled interrupt (MSI).
HW_ADAPTER_CONTROL	Performs synchronous operations to control the state or behavior of an adapter, such as stopping or restarting the HBA for power management.
HW_BUILDIO	Processes the SRB with unsynchronized access to shared system data structures before passing it to HwStorStartIo.
HW_DPC_ROUTINE	Routine that is deferred for execution at DISPATCH IRQL by means of the deferred procedure call (DPC) mechanism.
HW_FIND_ADAPTER	Uses the supplied configuration to determine whether a specific HBA is supported and, if it is, to return configuration information about that adapter.
HW_INITIALIZE	Initializes the miniport driver after a system reboot or power failure occurs.
HW_INTERRUPT	The Storport driver calls the HwStorInterrupt routine after the HBA generates an interrupt request.
HW_PASSIVE_INITIALIZE_ROUTINE	Called after the HwStorInitialize routine when the current IRQL is at PASSIVE_LEVEL.
HW_RESET_BUS	Called by the port driver to clear error conditions.
HW_STARTIO	The Storport driver calls the HwStorStartIo routine one time for each incoming I/O request.
HW_TIMER	Called after the interval that is specified when the miniport driver called StorPortNotification with the RequestTimerCall NotificationType value.
HW_TRACING_ENABLED	Enables the Storport to notify a miniport that event tracing is enabled.
HW_UNIT_CONTROL	Called to perform synchronous operations to control the state of storage unit device. The miniport driver is notified to start a unit or handle a power state transition for a unit device.
HW_WORKITEM	A miniport-provided callback function for processing a Storport work item request.
STORPORT_TELEMETRY_EVENT	Describes the miniport telemetry data payload.
StorPortLogTelemetry	Logs a miniport telemetry event to help diagnose or collect any useful information. The miniport can log eight general purpose name-value pairs and a buffer that has maximum length of 4KB, as well as several event related fields that are defined in structure STORPORT_TELEMETRY_EVENT.