Edit

Share via

PHW_RECEIVE_DEVICE_SRB callback function (strmini.h)

  • Article

The minidriver-supplied routine handles class driver requests that apply to the driver as a whole, such as initializing the device, or opening a stream within the device.

Syntax

PHW_RECEIVE_DEVICE_SRB PhwReceiveDeviceSrb;

void PhwReceiveDeviceSrb(
  [in] IN PHW_STREAM_REQUEST_BLOCK SRB
)
{...}

Parameters

[in] SRB

Pointer to the stream request block.

Return value

None

Remarks

The minidriver specifies this routine in the HwReceivePacket member of its HW_INITIALIZATION_DATA structure. The minidriver passes this structure to the class driver when it registers itself by calling StreamClassRegisterMinidriver.

StrMiniReceiveDevicePacket must handle class driver requests that apply to the driver as a whole, such as initializing the device, or opening a stream within the device. The class driver passes its information in the form of a pointer to a stream request block. The class driver fills in some of the entries in the stream request block. The minidriver, upon completion of the routine, must fill in additional information that the class driver will use to continue processing.

Upon completion of its handling of the request, the minidriver passes the structure back to the class driver by calling StreamClassDeviceNotification(DeviceRequestComplete, pSRB->HwDeviceExtension, pSRB).

See information about relevant SRB codes in Stream Class SRB Reference.

When the minidriver finishes its processing of the request, it enters the return status of the operation in pSrb->Status. The minidriver should enter STATUS_SUCCESS for normal successful processing. If the minidriver does not support that Command value, it should set pSrb->Status to STATUS_NOT_IMPLEMENTED. If there is a device hardware error that prevents the minidriver from completing the request, it should set pSrb->Status to STATUS_IO_DEVICE_ERROR. Other error codes the routine uses in specific circumstances are listed above with the specific Command code.

Note that the class driver passes read and write requests to the StrMiniReceiveStreamDataPacket routine.

The minidriver registers its StrMiniReceiveStreamControlPacket routine as follows: When the class driver opens the stream, it passes an SRB_OPEN_STREAM request block to the minidriver's StrMiniReceiveDevicePacket routine. The StreamObject member of the request packet points to an HW_STREAM_OBJECT. The minidriver sets the ReceiveControlPacket member of the structure pointed to by StreamObject to the minidriver's StrMiniReceiveControlPacket routine.

Upon completion of its handling of the request, the minidriver passes the structure back to the class driver by calling StreamClassStreamNotification(StreamRequestComplete, pSRB->StreamObject, pSRB).

See information about relevant SRB codes in Stream Class SRB Reference.

When the minidriver finishes its processing of the request, it enters the return status of the operation in pSrb->Status. The minidriver should enter STATUS_SUCCESS for normal successful processing. If the minidriver does not support that Command value, it should set pSrb->Status to STATUS_NOT_IMPLEMENTED. If there is a device hardware error that prevents the minidriver from completing the request, it should set pSrb->Status to STATUS_IO_DEVICE_ERROR. Other error codes the routine uses in specific circumstances are listed above with the specific Command code.

The stream class driver calls the minidriver's StrMiniReceiveStreamDataPacket routine to handle read and write requests for a specific stream.

The minidriver registers its StrMiniReceiveStreamDataPacket routine as follows: When the class driver opens the stream, it passes a SRB_OPEN_STREAM request block to the minidriver's StrMiniReceiveDevicePacket routine. The StreamObject of the request packet points to a HW_STREAM_OBJECT. The minidriver sets the ReceiveDataPacket member of the structure pointed to by pSrb->StreamObject to the minidriver's StrMiniReceiveDataPacket routine.

Upon completion of its handling of the request, the minidriver passes the structure back to the class driver by calling StreamClassStreamNotification(StreamRequestComplete, pSRB->StreamObject, pSRB).

See information about relevant SRB codes in Stream Class SRB Reference.

When the minidriver finishes its processing of the request, it enters the return status of the operation in pSrb->Status. The minidriver should enter STATUS_SUCCESS for normal successful processing. If the minidriver does not support that Command value, it should set pSrb->Status to STATUS_NOT_IMPLEMENTED. If there is a device hardware error that prevents the minidriver from completing the request, it should set pSrb->Status to STATUS_IO_DEVICE_ERROR. Other error codes the routine uses in specific circumstances are listed above with the specific Command code.

Requirements

Requirement Value
Target Platform Desktop
Header strmini.h (include Strmini.h)