SerCx2CustomReceiveTransactionNewDataNotification function (sercx.h)

Article
02/22/2024

The SerCx2CustomReceiveTransactionNewDataNotification 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 hardware.

Syntax

void SerCx2CustomReceiveTransactionNewDataNotification(
  [in] SERCX2CUSTOMRECEIVETRANSACTION CustomReceiveTransaction
);

Parameters

[in] CustomReceiveTransaction

A SERCX2CUSTOMRECEIVETRANSACTION handle to a custom-receive object. The serial controller driver previously called the SerCx2CustomReceiveTransactionCreate method to create this object.

Return value

None

Remarks

If the receive FIFO in the serial controller becomes empty before a custom-receive transaction can be completed, SerCx2 calls the EvtSerCx2CustomReceiveTransactionEnableNewDataNotification event callback function, if it is implemented, to enable a new-data notification to occur when new data is available to be read from the receive FIFO.

If new-data notifications are enabled and new data is available to be read, the serial controller driver must call SerCx2CustomReceiveTransactionNewDataNotification to notify SerCx2. This notification occurs when the driver detects that one or more new bytes of received data either are ready to be transferred by the custom data-transfer mechanism or have already been transferred by this mechanism.

The serial controller driver must call SerCx2CustomReceiveTransactionNewDataNotification only in response to a call to the EvtSerCx2CustomReceiveTransactionEnableNewDataNotification function.

If a serial controller driver supports new-data notifications for custom-receive transactions, SerCx uses these notifications to detect interval time-outs during the handling of read (IRP_MJ_READ) requests. For more information about interval time-outs, see SERIAL_TIMEOUTS. For more information about new-data notifications, see SerCx2 Custom-Receive Transactions.

Requirements

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