SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT_NEW_DATA_NOTIFICATION function (sercx.h)

Article
10/21/2021

The SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT_NEW_DATA_NOTIFICATION function initializes a SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure.

Syntax

void SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT_NEW_DATA_NOTIFICATION(
  [out] SERCX2_SYSTEM_DMA_RECEIVE_CONFIG                           *Config,
  [in]  size_t                                                     MaximumTransferLength,
  [in]  PHYSICAL_ADDRESS                                           Address,
  [in]  DMA_WIDTH                                                  DmaWidth,
  [in]  PCM_PARTIAL_RESOURCE_DESCRIPTOR                            DmaDescriptor,
  [in]  PFN_SERCX2_SYSTEM_DMA_RECEIVE_ENABLE_NEW_DATA_NOTIFICATION EvtSerCx2SystemDmaReceiveEnableNewDataNotification,
  [in]  PFN_SERCX2_SYSTEM_DMA_RECEIVE_CANCEL_NEW_DATA_NOTIFICATION EvtSerCx2SystemDmaReceiveCancelNewDataNotification
);

Parameters

[out] Config

A pointer to the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure that is to be initialized.

[in] MaximumTransferLength

The value to load into the MaximumTransferLength member of the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure. For more information, see the description of the MaximumTransferLength member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

[in] Address

The value to load into the DeviceAddress member of the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

[in] DmaWidth

The value to load into the DmaWidth member of the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

[in] DmaDescriptor

The value to load into the DmaDescriptor member of the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure. For more information, see the description of this member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

[in] EvtSerCx2SystemDmaReceiveEnableNewDataNotification

The value to load into the EvtSerCx2SystemDmaReceiveEnableNewDataNotification member of the SERCX2_CONFIG structure. For more information, see the description of this member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

[in] EvtSerCx2SystemDmaReceiveCancelNewDataNotification

The value to load into the EvtSerCx2SystemDmaReceiveCancelNewDataNotification member of the SERCX2_CONFIG structure. For more information, see the description of this member in SERCX2_SYSTEM_DMA_RECEIVE_CONFIG.

Return value

None

Remarks

Your serial controller driver must use either this function or the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT function to initialize a SERCX2_SYSTEM_DMA_RECEIVE_CONFIG structure before passing a pointer to this structure as an input parameter to the SerCx2SystemDmaReceiveCreate method.

SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT_NEW_DATA_NOTIFICATION sets the Size member of the structure to sizeof(SERCX2_SYSTEM_DMA_RECEIVE_CONFIG), and sets six additional members of the structure to the values supplied as input parameters to the function. The function sets the other members of the structure to zero. The driver can, if necessary, explicitly set these other members to nonzero values after the SERCX2_SYSTEM_DMA_RECEIVE_CONFIG_INIT_NEW_DATA_NOTIFICATION call.

Requirements

Requirement	Value
Minimum supported client	Available starting with Windows 8.1.
Target Platform	Desktop
Header	sercx.h
IRQL	Any level.