Appendix D: Apis Provided By The Xdma Driver In Linux - Xilinx KCU105 User Manual

APIs Provided by the XDMA Driver in
Linux
Table D-1 describes the application programming interfaces (APIs) provided by the XDMA
driver in a Linux environment.
Table D-1: APIs Provided by the XDMA Driver
API Prototype
ps_pcie_dma_desc_t*
xlnx_get_pform_dma_de
sc (void *prev_desc,
unsigned short vendid,
unsigned short devid) ;
PCIe Streaming Data Plane TRD
UG920 (v2017.1) June 01, 2017
Details
Returns pointer to an
instance of a DMA
descriptor. The XDMA
driver creates one
instance of a DMA
descriptor corresponding
to each Expresso DMA
Endpoint plugged into
PCIe slots of a system.
The host side API can be
called, successively
passing the previously
returned descriptor
pointer till all instance
pointers are returned. This
API is typically called by an
application driver (stacked
on the XDMA driver)
during initialization.
On the Endpoint side, this
API needs to be called just
once, because a single
XDMA instance is
supported.
www.xilinx.com
Parameters
prev_desc – Pointer to the
XDMA descriptor instance
returned in a previous call
to the API. When called for
the first time, NULL is
passed.
vendid – PCIe vendor ID
devid – PCIe device ID
Currently the
Note:
XDMA driver does not
support multiple
Endpoints on the host
side, hence this API is
always called with all
parameters as 0.
Appendix D
Return
API returns the pointer to
the XDMA software
descriptor. This pointer
can be used as a
parameter to other XDMA
driver APIs.
95
Send Feedback