Skip to content

Latest commit

 

History

History
105 lines (72 loc) · 5.52 KB

ns-sercx-_sercx2_custom_transmit_config.md

File metadata and controls

105 lines (72 loc) · 5.52 KB
UID title description old-location tech.root ms.date keywords ms.keywords req.header req.include-header req.target-type req.target-min-winverclnt req.target-min-winversvr req.kmdf-ver req.umdf-ver req.ddi-compliance req.unicode-ansi req.idl req.max-support req.namespace req.assembly req.type-library req.lib req.dll req.irql targetos req.typenames f1_keywords topic_type api_type api_location api_name
NS:sercx._SERCX2_CUSTOM_TRANSMIT_CONFIG
_SERCX2_CUSTOM_TRANSMIT_CONFIG (sercx.h)
The SERCX2_CUSTOM_TRANSMIT_CONFIG structure contains information that version 2 of the serial framework extension (SerCx2) uses to configure a new custom-transmit object.
serports\sercx2_custom_transmit_config.htm
serports
04/23/2018
SERCX2_CUSTOM_TRANSMIT_CONFIG structure
*PSERCX2_CUSTOM_TRANSMIT_CONFIG, 2/PSERCX2_CUSTOM_TRANSMIT_CONFIG, 2/SERCX2_CUSTOM_TRANSMIT_CONFIG, PSERCX2_CUSTOM_TRANSMIT_CONFIG, PSERCX2_CUSTOM_TRANSMIT_CONFIG structure pointer [Serial Ports], SERCX2_CUSTOM_TRANSMIT_CONFIG, SERCX2_CUSTOM_TRANSMIT_CONFIG structure [Serial Ports], _SERCX2_CUSTOM_TRANSMIT_CONFIG, serports.sercx2_custom_transmit_config
sercx.h
Windows
Supported starting with Windows 8.1.
Windows
SERCX2_CUSTOM_TRANSMIT_CONFIG, *PSERCX2_CUSTOM_TRANSMIT_CONFIG
_SERCX2_CUSTOM_TRANSMIT_CONFIG
sercx/_SERCX2_CUSTOM_TRANSMIT_CONFIG
PSERCX2_CUSTOM_TRANSMIT_CONFIG
sercx/PSERCX2_CUSTOM_TRANSMIT_CONFIG
SERCX2_CUSTOM_TRANSMIT_CONFIG
sercx/SERCX2_CUSTOM_TRANSMIT_CONFIG
APIRef
kbSyntax
HeaderDef
2.0\Sercx.h
_SERCX2_CUSTOM_TRANSMIT_CONFIG
PSERCX2_CUSTOM_TRANSMIT_CONFIG
SERCX2_CUSTOM_TRANSMIT_CONFIG

_SERCX2_CUSTOM_TRANSMIT_CONFIG structure

-description

The SERCX2_CUSTOM_TRANSMIT_CONFIG structure contains information that version 2 of the serial framework extension (SerCx2) uses to configure a new custom-transmit object.

-struct-fields

-field Size

The size, in bytes, of this structure. The SerCx2CustomTransmitCreate method uses this member to determine which version of the structure the caller is using. The size of this structure might change in future versions of the Sercx.h header file.

-field Alignment

Data alignment requirement. Specifies how the starting address of a transfer in a custom-transmit transaction must be aligned in memory. Set this member to the appropriate FILE_XXX_ALIGNMENT constant in the Wdm.h header file. For example, FILE_WORD_ALIGNMENT indicates that the starting address must be aligned to two-byte boundary in memory, FILE_LONG_ALIGNMENT indicates that the address must be aligned to a four-byte boundary, and so on.

-field MinimumTransactionLength

The minimum length, in bytes, of a data transfer in a custom-transmit transaction. If the length of the buffer in a write (IRP_MJ_WRITE) request is less than this minimum length, SerCx2 uses programmed I/O (PIO) for the transaction.

-field MaximumTransactionLength

The maximum length, in bytes, of a data transfer in a custom-transmit transaction. If the size of the buffer in the write request is larger than this maximum length, SerCx2 uses multiple custom-transmit transactions to handle the request, and limits each transaction to the maximum length.

-field MinimumTransferUnit

The minimum transfer unit. The number of bytes to transfer in a custom-transmit transaction must be an integer multiple of the minimum transfer unit. To indicate that the default minimum transfer unit should be used, set this member to zero. For more information about the default minimum transfer unit, see DMA_ADAPTER_INFO_V1.

-field Exclusive

Whether to use custom-transmit transactions exclusively to handle write (IRP_MJ_WRITE) requests. Set to TRUE to indicate that write requests should use custom-transmit transactions exclusively. Set to FALSE to indicate that write requests can use a combination of custom-transmit transactions and PIO-transmit transactions.

Set this member to TRUE only if the minimum transfer unit for custom-transmit transactions is one byte, the minimum transaction length is one byte, and the write buffer for the transaction can start on any byte boundary in memory.

If Exclusive is TRUE, the MinimumTransferUnit, Alignment, and MinimumTransactionLength members must be zero.

-remarks

The SerCx2CustomTransmitCreate method accepts a pointer to a SERCX2_CUSTOM_TRANSMIT_CONFIG structure as an input parameter. Before calling SerCx2CustomTransmitCreate, call the SERCX2_CUSTOM_TRANSMIT_CONFIG_INIT function to initialize this structure.

-see-also

DMA_ADAPTER_INFO_V1

IRP_MJ_WRITE

SERCX2_CUSTOM_TRANSMIT_CONFIG_INIT

SerCx2CustomTransmitCreate