Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This header is used by serports. For more information, see:
sercx.h contains the following programming interfaces:
Functions
| SERCX_ACTIVITY_INIT The SERCX_ACTIVITY_INIT function initializes a SERCX_ACTIVITY structure. |
| SERCX_BUFFER_DESCRIPTOR_INIT The SERCX_BUFFER_DESCRIPTOR_INIT function initializes a SERCX_BUFFER_DESCRIPTOR structure. |
| SERCX_CONFIG_INIT The SERCX_CONFIG_INIT function initializes a SERCX_CONFIG structure. |
| SerCxCompleteWait The SerCxCompleteWait method notifies the serial framework extension (SerCx) that an event in the current wait mask has occurred. |
| SerCxDeviceInitConfig The SerCxDeviceInitConfig method is called by the serial controller driver to attach the serial framework extension (SerCx) to the I/O pipeline for a framework device object (FDO or PDO) that it is creating. |
| SerCxGetActivity The SerCxGetActivity method retrieves the status of pending work for the serial controller driver. |
| SerCxGetConnectionParameters The SerCxGetConnectionParameters method retrieves the connection parameters for the associated peripheral device. |
| SerCxGetReadIntervalTimeout The SerCxGetReadIntervalTimeout method returns the interval time-out value for a read (receive) operation. |
| SerCxGetRingBufferUtilization The SerCxGetRingBufferUtilization method enables the serial controller driver to determine how much of the type-ahead ring buffer is currently filled by data received from the serial port. |
| SerCxGetWaitMask The SerCxGetWaitMask method returns the event wait mask for the wait operation that is currently pending. |
| SerCxInitialize The SerCxInitialize method completes the initialization of the serial framework extension (SerCx) after this driver creates the associated device object. |
| SerCxProgressReceive The SerCxProgressReceive method reports the progress of the current read (receive) operation. |
| SerCxProgressTransmit The SerCxProgressTransmit method reports the progress of the current write (transmit) operation. |
| SerCxRetrieveReceiveBuffer The SerCxRetrieveReceiveBuffer method obtains an input buffer into which data received from the serial port can be loaded. |
| SerCxRetrieveReceiveMdl The SerCxRetrieveReceiveMdl method retrieves the MDL that describes the buffer to use to receive the next block of input data. |
| SerCxRetrieveTransmitBuffer The SerCxRetrieveTransmitBuffer method obtains an output buffer that contains data that is ready to be transmitted to the serial port. |
| SerCxRetrieveTransmitMdl The SerCxRetrieveTransmitMdl method retrieves the MDL that describes the buffer that contains the next block of output data to be transmitted. |
Callback functions
| EVT_SERCX_APPLY_CONFIG The EvtSerCxApplyConfig event callback function instructs the serial controller driver to apply a list of configuration settings to the serial controller hardware. |
| EVT_SERCX_CONTROL The EvtSerCxControl event callback function handles an I/O control request that has an I/O control code (IOCTL) that the serial framework extension (SerCx) supports. |
| EVT_SERCX_FILECLEANUP The EvtSerCxFileCleanup event callback function notifies the serial controller driver that a client has closed the last handle to the file object that represents the serial controller device. |
| EVT_SERCX_FILECLOSE The EvtSerCxFileClose event callback function notifies the serial controller driver that the file object that represents the serial controller device has been released. |
| EVT_SERCX_FILEOPEN The EvtSerCxFileOpen event callback function notifies the serial controller driver that a client opened a file handle on the serial controller device and that a file object has been created to represent the device. |
| EVT_SERCX_PURGE The EvtSerCxPurge event callback function is called by the serial framework extension (SerCx) to purge the serial controller's hardware buffers. |
| EVT_SERCX_RECEIVE The EvtSerCxReceive event callback function prepares the serial controller device (UART) to do a read (receive) operation. |
| EVT_SERCX_RECEIVE_CANCEL The EvtSerCxReceiveCancel event callback function notifies the serial controller driver that the pending receive request is canceled. |
| EVT_SERCX_TRANSMIT The EvtSerCxTransmit event callback function prepares the serial controller device (UART) to do a write (transmit) operation. |
| EVT_SERCX_TRANSMIT_CANCEL The EvtSerCxTransmitCancel event callback function notifies the serial controller driver that the pending transmit request is canceled. |
| EVT_SERCX_WAITMASK The EvtSerCxWaitmask event callback function configures the serial controller to monitor the events in a wait mask, which is a bitmask value that specifies a set of hardware events. |
| SERFUNC SERFUNC is used to create the SERCX function interfaces. |
Structures
| SERCX_ACTIVITY The SERCX_ACTIVITY structure contains a summary of work items that are ready for the serial controller driver to process. |
| SERCX_BUFFER_DESCRIPTOR The SERCX_BUFFER_DESCRIPTOR structure describes a data buffer for a receive operation or transmit operation. |
| SERCX_CONFIG The SERCX_CONFIG structure contains configuration information for the serial framework extension (SerCx). |
Enumerations
| SERCX_STATUS The SERCX_STATUS enumeration indicates the status of a serial receive or transmit operation. |