| axipcie Vitis Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List
- Examples

Functions
xaxipcie_ep_enable_example.c File Reference

## Overview

This file contains a design example for using AXI PCIe IP and its driver.

The example handles AXI PCIe IP when it is configured as an end point. It shows how to use the API's.

Note

This code will illustrate how the AXI Pcie IP and its standalone driver can be used to:

- Initialize a AXI PCIe bridge core built as an end point
- Retrieve root complex configuration assigned to end point

We tried to use as much of the driver's API calls as possible to show the reader how each call could be used and that probably made the example not the shortest way of doing the tasks shown as they could be done.

      MODIFICATION HISTORY:

      Ver   Who  Date     Changes

      1.00a rkv  03/07/11 Initial version based on PLB PCIE example
      2.00a rkv  10/19/11 Renamed function call XAxiPcie_GetRequestId to
                          XAxiPcie_GetRequesterId
      3.1   ms   01/23/17 Added xil_printf statement in main function to
                          ensure that "Successfully ran" and "Failed" strings
                          are available in all examples. This is a fix for
                          CR-965028.
            ms   04/05/17 Added tabspace for return statements in functions
                          for proper documentation while generating doxygen.

    *

## Functions
int | PCIeEndPointInitialize (XAxiPcie *XlnxEndPointPtr, u16 DeviceId)
| This function initializes the AXI PCIE end point IP. More...
int | main (void)
| This function is the entry point for PCIe End Point Example. More...

## Function Documentation

int main | ( | void |  | ) |

This function is the entry point for PCIe End Point Example.

Parameters

  None |

Returns
  - XST_SUCCESS if successful
  - XST_FAILURE if unsuccessful

Note
  None.

References PCIeEndPointInitialize().

int PCIeEndPointInitialize | ( | XAxiPcie * | XlnxEndPointPtr,
|  | u16 | DeviceId
| ) |  |

This function initializes the AXI PCIE end point IP.

Parameters

  XlnxEndPointPtr | is a pointer to an instance of XAxiPcie data structure represents an end point IP.
  DeviceId | is AXI PCIe IP unique Device Id

Returns
  - XST_SUCCESS if successful
  - XST_FAILURE if unsuccessful

Note
  None.