Xilinx KCU105 User Manual page 103

Table E-1: APIs Provided by the XDMA Driver in Windows (Cont'd)
API Prototype
int
XDMAUnregister(
IN XDMA_HANDLE
UnregisterHandle
)
NTSTATUS
XlxDataTransfer(
IN XDMA_HANDLE
XDMAHandle,
IN
PDATA_TRANSFER_PARAM
S pXferParams
)
PCIe Streaming Data Plane TRD
UG920 (v2017.1) June 01, 2017
Appendix E:
Details
This API is made available
to child drivers present on
the DMA driver's virtual
bus.
It is used by child drivers
to unregister themselves
with DMA driver.
After successful
invocation of
XDMAUnregister the
DMA channel can be
reused by any other child
driver, by invoking
XDMARegister
This API can be invoked
using the function pointer
obtained as part of
PREGISTER_DMA_ENGINE
_RETURN
after successful
registration of Child driver.
This is the API which
programs the buffer
descriptors and initiates
DMA transfers based on
the information provided
in
PDATA_TRANSFER_PARAM
S
www.xilinx.com
APIs Provided by the XDMA Driver in Windows
Parameters
XDMA_HANDLE
This is the same parameter
obtained by child driver
upon successful
registration.
XDMA_HANDLE
This is the same parameter
obtained by child driver
upon successful
registration.
PDATA_TRANSFER_PARAM
S
This parameter contains
all the information
required by the DMA
driver to initiate data
transfer.
It contains the following
information:
1. Information regarding
which Queue of DMA
channel has to be
updated. (It can either be
SRC Q or DST Q).
2. Number of bytes to be
transferred.
3. Memory location
information, which helps
the DMA driver to know
whether the address
provided is the Card DDR
address or if it is a host
SGL list.
Return
Always returns zero.
STATUS_SUCCESS is
retuned if the call is
successful otherwise
relevant STATUS message
will be set.
103
Send Feedback