SerCx2 Custom-Transmit Transactions

Some serial controller hardware might implement a data-transfer mechanism other than PIO or system DMA for writing data to a serial controller. A serial controller driver can support custom-transmit transactions to make this data-transfer mechanism available to be used by SerCx2.

To start a custom-transmit transaction, SerCx2 calls the driver's EvtSerCx2CustomTransmitTransactionStart event callback function and supplies as parameters the write (IRP_MJ_WRITE) request and a description of the write buffer for the transaction. In this call, the function initiates the transaction and returns. The driver is then responsible for finishing the transaction and completing the write request.

Creating the custom-transmit object

Before SerCx2 can call any of the serial controller driver's EvtSerCx2CustomTransmitTransactionXxx functions, the driver must call the SerCx2CustomTransmitTransactionCreate method to register these functions with SerCx2. This method accepts, as an input parameter, a pointer to a SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CONFIG structure that contains pointers to the driver's EvtSerCx2CustomTransmitTransactionXxx functions.

The driver must implement the following function:

As an option, the driver can implement one or both of the following functions:

The SerCx2CustomTransmitTransactionCreate method creates a custom-transmit object and supplies the calling driver with a SERCX2CUSTOMTRANSMITTRANSACTION handle to this object. The driver's EvtSerCx2CustomTransmitTransactionXxx functions all take this handle as their first parameter. The following SerCx2 methods take this handle as their first parameter:

Hardware initialization and clean-up

Some serial controller drivers might need to initialize the serial controller hardware at the start of a custom-transmit transaction, or to clean up the hardware state of the serial controller at the end of the transaction.

If a driver implements an EvtSerCx2CustomTransmitTransactionInitialize event callback function, SerCx2 calls this function to initialize the serial controller before starting the transaction. If implemented, the EvtSerCx2CustomTransmitTransactionInitialize function must call the SerCx2CustomTransmitTransactionInitializeComplete method to inform SerCx2 when the driver finishes initializing the serial controller.

If the driver implements an EvtSerCx2CustomTransmitTransactionCleanup event callback function, SerCx2 calls this function to clean up the hardware state after the transaction ends. If implemented, the EvtSerCx2CustomTransmitTransactionInitialize function must call the SerCx2CustomTransmitTransactionCleanupComplete method to inform SerCx2 when the driver finishes cleaning up the serial controller.

Accessing the request object

To start a custom-transmit transaction, SerCx2 calls the driver's EvtSerCx2CustomTransmitTransactionStart function and passes the associated write request (encapsulated in a WDFREQUEST object handle) to this function as a parameter. The driver is responsible for calling a method such as WdfRequestComplete to complete this request when the transaction finishes. Unless the request can be completed immediately, before the EvtSerCx2CustomTransmitTransactionStart function returns, the driver must call a method such as WdfRequestMarkCancelableEx to mark the request as cancelable.

The serial controller driver must not use a method such as WdfRequestRetrieveInputBuffer to access the data buffer in the write request. Instead, the driver should use the Mdl, Offset, and Length parameter values passed to the EvtSerCx2CustomTransmitTransactionStart function to access this buffer.

During a custom-transmit transaction, the driver might need to store information about the transaction in a context that is attached to the request object. If so, the driver's EvtDriverDeviceAdd event callback function can call the WdfDeviceInitSetRequestAttributes method to set the attributes to use for request objects. These attributes include the name and allocation size to use for request contexts. The request attributes specified in this call must match the request attributes that the driver specifies in the call to the SerCx2InitializeDevice method. These attributes are specified in the RequestAttributes member of the SERCX2_CONFIG structure that the driver passes to SerCx2InitializeDevice. For more information, see SERCX2_CONFIG.

For a write request that the serial controller driver receives at the start of a custom-transmit transaction, the request context allocated by the driver framework is uninitialized. The driver should, as a best practice, call the RtlZeroMemory routine to initialize this request context to all zeros.

 

 

Send comments about this topic to Microsoft

Show: