SerCx2PioReceiveReady function (sercx.h)

Article
02/22/2024

The SerCx2PioReceiveReady method notifies version 2 of the serial framework extension (SerCx2) that data is available to be read from the receive FIFO in the serial controller.

Syntax

void SerCx2PioReceiveReady(
  [in] SERCX2PIORECEIVE PioReceive
);

Parameters

[in] PioReceive

A SERCX2PIORECEIVE handle to a PIO-receive object. The serial controller driver previously called the SerCx2PioReceiveCreate method to create this object.

Return value

None

Remarks

To initiate a PIO-receive transaction, SerCx2 calls the EvtSerCx2PioReceiveReadBuffer event callback function and supplies a read buffer to which to transfer the data from the receive FIFO in the serial controller. If the return value from this function indicates that the read buffer was only partially filled before the receive FIFO became empty, SerCx2 calls the EvtSerCx2PioReceiveEnableReadyNotification event callback routine to enable a ready notification to occur when more data is available to be read.

If the ready notification is enabled and more data is available to be read, the serial controller driver must call SerCx2PioReceiveReady to notify SerCx2. In response to this notification, SerCx2 calls the EvtSerCx2PioReceiveReadBuffer function again to transfer more data from the receive FIFO to the read buffer.

The serial controller driver must call SerCx2PioReceiveReady only in response to a call to the EvtSerCx2PioReceiveEnableReadyNotification function.

Additionally, SerCx2 uses these ready notifications to detect interval time-outs during the handling of a read request. For more information about interval time-outs, see SERIAL_TIMEOUTS. For more information about ready notifications, see SerCx2 PIO-Receive Transactions.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.1.
Target Platform	Universal
Header	sercx.h
IRQL	<= DISPATCH_LEVEL