SerCx2 Event Callback Functions

This section describes the event callback functions that are defined for version 2 of the serial framework extension (SerCx2). These functions are implemented by your serial controller driver. SerCx2 calls these functions to communicate with the serial controller driver.

In this section

TopicDescription

EVT_SERCX2_APPLY_CONFIG

The EvtSerCx2ApplyConfig event callback function is called by version 2 of the serial framework extension (SerCx2) to supply the serial controller driver with a list of device-specific configuration settings to apply to the serial controller hardware.

EVT_SERCX2_CONTROL

The EvtSerCx2Control event callback function is called by version 2 of the serial framework extension (SerCx2) to handle a serial I/O control request.

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_CLEANUP

The EvtSerCx2CustomReceiveTransactionCleanup event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller's hardware state after a custom-receive transaction ends.

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_NEW_DATA_NOTIFICATION

The EvtSerCx2CustomReceiveTransactionEnableNewDataNotification event callback function is called by version 2 of the serial extension framework (SerCx2) to enable the serial controller driver to notify SerCx2 when the serial controller receives new data.

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_INITIALIZE

The EvtSerCx2CustomReceiveTransactionInitialize event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller hardware to perform a new custom-receive transaction.

EVT_SERCX2_CUSTOM_RECEIVE_TRANSMIT_QUERY_PROGRESS

The EvtSerCx2CustomReceiveTransactionQueryProgress event callback function is called by version 2 of the serial framework extension (SerCx2) to check whether progress is being made on the current custom-receive transaction.

EVT_SERCX2_CUSTOM_RECEIVE_TRANSACTION_START

The EvtSerCx2CustomReceiveTransactionStart event callback function is called by version 2 of the serial framework extension (SerCx2) to start a custom-receive transaction.

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_CLEANUP

The EvtSerCx2CustomTransmitTransactionCleanup event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller's hardware state after a custom-transmit transaction ends.

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_INITIALIZE

The EvtSerCx2CustomTransmitTransactionInitialize event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller driver to perform a custom-transmit transaction.

EVT_SERCX2_CUSTOM_TRANSMIT_TRANSACTION_START

The EvtSerCx2CustomTransmitTransactionStart event callback function is called by version 2 of the serial framework extension (SerCx2) to start a custom-transmit transaction.

EVT_SERCX2_FILECLOSE

The EvtSerCx2FileClose event callback function is called by version 2 of the serial framework extension (SerCx2) to notify the serial controller driver that the client released the file object that represents the logical connection to the serial controller device.

EVT_SERCX2_FILEOPEN

The EvtSerCx2FileOpen event callback function is called by version 2 of the serial framework extension (SerCx2) to notify the serial controller driver that a client opened a logical connection to the serial controller device and that a file object has been created to represent this connection.

EVT_SERCX2_PIO_RECEIVE_CANCEL_READY_NOTIFICATION

The EvtSerCx2PioReceiveCancelReadyNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to cancel a ready notification that SerCx2 enabled in a previous call to the EvtSerCx2PioReceiveEnableReadyNotification event callback function.

EVT_SERCX2_PIO_RECEIVE_CLEANUP_TRANSACTION

The EvtSerCx2PioReceiveCleanupTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller's hardware state after a PIO-receive transaction ends.

EVT_SERCX2_PIO_RECEIVE_ENABLE_READY_NOTIFICATION

The EvtSerCx2PioReceiveEnableReadyNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to enable the serial controller driver to notify SerCx2 when the serial controller receives new data.

EVT_SERCX2_PIO_RECEIVE_INITIALIZE_TRANSACTION

The EvtSerCx2PioReceiveInitializeTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller to perform a PIO-receive transaction.

EVT_SERCX2_PIO_RECEIVE_READ_BUFFER

The EvtSerCx2PioReceiveReadBuffer event callback function is called by version 2 of the serial framework extension (SerCx2) to use programmed I/O (PIO) to transfer data from the receive FIFO in the serial controller to a read buffer.

EVT_SERCX2_PIO_TRANSMIT_CANCEL_DRAIN_FIFO

The EvtSerCx2PioTransmitCancelDrainFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to cancel a previous request to drain the transmit FIFO in the serial controller hardware.

EVT_SERCX2_PIO_TRANSMIT_CANCEL_READY_NOTIFICATION

The EvtSerCx2PioTransmitCancelReadyNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to cancel a ready notification that SerCx2 enabled in a previous call to the EvtSerCx2PioTransmitEnableReadyNotification event callback function.

EVT_SERCX2_PIO_TRANSMIT_CLEANUP_TRANSACTION

The EvtSerCx2PioTransmitCleanupTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller state after a PIO-transmit transaction ends.

EVT_SERCX2_PIO_TRANSMIT_DRAIN_FIFO

The EvtSerCx2PioTransmitDrainFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to drain the transmit FIFO in the serial controller hardware.

EVT_SERCX2_PIO_TRANSMIT_ENABLE_READY_NOTIFICATION

The EvtSerCx2PioTransmitEnableReadyNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to enable the serial controller driver to notify SerCx2 when the transmit FIFO in the serial controller is ready to accept more data.

EVT_SERCX2_PIO_TRANSMIT_INITIALIZE_TRANSACTION

The EvtSerCx2PioTransmitInitializeTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller driver to perform a PIO-transmit transaction.

EVT_SERCX2_PIO_TRANSMIT_PURGE_FIFO

The EvtSerCx2PioTransmitPurgeFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to discard any bytes of unsent data that remain in the transmit FIFO in the serial controller.

EVT_SERCX2_PIO_TRANSMIT_WRITE_BUFFER

The EvtSerCx2PioTransmitWriteBuffer event callback function is called by version 2 of the serial framework extension (SerCx2) to use programmed I/O (PIO) to transfer the contents of a write buffer to the transmit FIFO in the serial controller.

EVT_SERCX2_PURGE_FIFOS

The EvtSerCx2PurgeFifos event callback function is called by version 2 of the serial framework extension (SerCx2) to purge the FIFO buffers in the serial controller hardware.

EVT_SERCX2_SELECT_NEXT_RECEIVE_TRANSACTION_TYPE

The EvtSerCx2SelectNextReceiveTransactionType event callback function is called by version 2 of the serial framework extension (SerCx2) to determine which data-transfer mechanism to use for the next read operation.

EVT_SERCX2_SELECT_NEXT_TRANSMIT_TRANSACTION_TYPE

The EvtSerCx2SelectNextTransmitTransactionType event callback function is called by version 2 of the serial framework extension (SerCx2) to determine which data-transfer mechanism to use for the next write operation.

EVT_SERCX2_SET_WAIT_MASK

The EvtSerCx2SetWaitMask event callback function is called by version 2 of the serial framework extension (SerCx2) to configure the serial controller to monitor a set of hardware events that are specified by a wait mask.

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION

The EvtSerCx2SystemDmaReceiveCancelNewDataNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to cancel a new-data notification that SerCx2 enabled in a previous call to the EvtSerCx2SystemDmaReceiveEnableNewDataNotification event callback function.

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CLEANUP_TRANSACTION

The EvtSerCx2SystemDmaReceiveCleanupTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller state after a system-DMA-receive transaction ends.

EVT_SERCX2_SYSTEM_DMA_RECEIVE_CONFIGURE_DMA_CHANNEL

The EvtSerCx2SystemDmaReceiveConfigureDmaChannel event callback function is called by version 2 of the serial framework extension (SerCx2) to let the serial controller driver do any custom configuration of the DMA adapter that might be required before the start of each transfer in a system-DMA-receive transaction.

EVT_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION

The EvtSerCx2SystemDmaReceiveEnableNewDataNotification event callback function is called by version 2 of the serial framework extension (SerCx2) to enable the serial controller driver to notify SerCx2 when the serial controller receives new data.

EVT_SERCX2_SYSTEM_DMA_RECEIVE_INITIALIZE_TRANSACTION

The EvtSerCx2EvtSerCx2SystemDmaReceiveInitializeTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller driver to perform a system-DMA-receive transaction.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CANCEL_DRAIN_FIFO

The EvtSerCx2SystemDmaTransmitCancelDrainFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to cancel a previous request to drain the transmit FIFO in the serial controller hardware.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CLEANUP_TRANSACTION

The EvtSerCx2SystemDmaTransmitCleanupTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to clean up the serial controller state after a system-DMA-transmit transaction ends.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_CONFIGURE_DMA_CHANNEL

The EvtSerCx2SystemDmaTransmitConfigureDmaChannel event callback function is called by version 2 of the serial framework extension (SerCx2) to let the serial controller driver do any custom configuration of the DMA adapter that might be required before the start of each DMA transfer in a system-DMA-transmit transaction.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_DRAIN_FIFO

The EvtSerCx2SystemDmaTransmitDrainFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to drain the transmit FIFO in the serial controller hardware.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_INITIALIZE_TRANSACTION

The EvtSerCx2SystemDmaTransmitInitializeTransaction event callback function is called by version 2 of the serial framework extension (SerCx2) to prepare the serial controller driver to perform a system-DMA-transmit transaction.

EVT_SERCX2_SYSTEM_DMA_TRANSMIT_PURGE_FIFO

The EvtSerCx2SystemDmaTransmitPurgeFifo event callback function is called by version 2 of the serial framework extension (SerCx2) to discard any bytes of unsent data that remain in the transmit FIFO in the serial controller hardware.

 

 

 

Send comments about this topic to Microsoft

Show: