/******************************************************************************
*
* Copyright (C) 2011 - 2014 Xilinx, Inc. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* Use of the Software is limited solely to applications:
* (a) running on a Xilinx device, or
* (b) that interact with a Xilinx device through a bus or interconnect.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
* SOFTWARE.
*
* Except as contained in this notice, the name of the Xilinx shall not be used
* in advertising or otherwise to promote the sale, use or other dealings in
* this Software without prior written authorization from Xilinx.
*
******************************************************************************/
/****************************************************************************/
/**
* @file xaxipcie_rc_cdma_example.c
*
* This file contains a design example for using AXI PCIe IP and its driver.
* This is an example to show the usage of driver APIs when AXI PCIe IP is
* configured as a Root Port. The AXI PCIe can be configured as a Root Port
* only on the 7 Series Xilinx FPGA families.
*
* The example initialises the AXI PCIe IP, shows how to enumerate the PCIe
* system and transfer data between endpoint and root complex using Central DMA.
*
* This example assumes that there is an AXI CDMA IP in the system. The user
* has to specify the Source, Destination and the Length of the DMA transfer
* which are valid for this system and are defined AXICDMA_SRC_ADDR,
* AXICDMA_DEST_ADDR and AXICDMA_LENGTH respectively in this example.
*
* @note
*
* This example should be used only when AXI PCIe IP is configured as
* root complex and AXI CDMA IP in included in system.
*
* This code will illustrate how the XAxiPcie IP and its standalone driver can
* be used to:
* - Initialize a AXI PCIe IP core built as a root complex.
* - Enumerate PCIe end points in the system.
* - Transfer data between root complex and endpoint using CDMA.
*
* Please note that this example enumerates and initializes PCIe end points
* only. It does not shows how to deal with PCIe switches (and its virtual
* P2P bridges)
*
* 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.
*
*<pre>
* MODIFICATION HISTORY:
*
* Ver Who Date Changes
* ----- ---- -------- -----------------------------------------------
* 2.00a nm 10/19/11 Initial version of AXI PCIe Root Port example
*
*</pre>
*****************************************************************************/
/***************************** Include Files ********************************/
#include "xparameters.h" /* Defines for XPAR constants */
#include "xaxipcie.h" /* XAxiPcie level 1 interface */
#include "xaxicdma.h" /* AXICDMA interface */
#include "stdio.h"
/************************** Constant Definitions ****************************/
#define AXIPCIE_DEVICE_ID XPAR_AXIPCIE_0_DEVICE_ID
#define AXIDMA_DEVICE_ID XPAR_AXICDMA_0_DEVICE_ID
/*
* AXICDMA Transfer Parameters. These have to be defined properly based
* on the HW system.
*/
#define AXICDMA_SRC_ADDR 0x48000000 /* Source Address */
#define AXICDMA_DEST_ADDR 0xD0000000 /* Destination Address */
#define AXICDMA_LENGTH 0x400 /* Length */
/*
* Command register offsets
*/
#define PCIE_CFG_CMD_IO_EN 0x00000001 /* I/O access enable */
#define PCIE_CFG_CMD_MEM_EN 0x00000002 /* Memory access enable */
#define PCIE_CFG_CMD_BUSM_EN 0x00000004 /* Bus master enable */
#define PCIE_CFG_CMD_PARITY 0x00000040 /* parity errors response */
#define PCIE_CFG_CMD_SERR_EN 0x00000100 /* SERR report enable */
/*
* PCIe Configuration registers offsets
*/
#define PCIE_CFG_ID_REG 0x0000 /* Vendor ID/Device ID offset */
#define PCIE_CFG_CMD_STATUS_REG 0x0001 /*
* Command/Status Register
* Offset
*/
#define PCIE_CFG_PRI_SEC_BUS_REG 0x0006 /*
* Primary/Sec.Bus Register
* Offset
*/
#define PCIE_CFG_CAH_LAT_HD_REG 0x0003 /*
* Cache Line/Latency Timer/
* Header Type/
* BIST Register Offset
*/
#define PCIE_CFG_BAR_0_REG 0x0004 /* PCIe Base Addr 0 */
#define PCIE_CFG_FUN_NOT_IMP_MASK 0xFFFF
#define PCIE_CFG_HEADER_TYPE_MASK 0x00EF0000
#define PCIE_CFG_MUL_FUN_DEV_MASK 0x00800000
#define PCIE_CFG_MAX_NUM_OF_BUS 256
#define PCIE_CFG_MAX_NUM_OF_DEV 1
#define PCIE_CFG_MAX_NUM_OF_FUN 8
#define PCIE_CFG_PRIM_SEC_BUS 0xFFFF0100
#define PCIE_CFG_HEADER_O_TYPE 0x0000
#define PCIE_CFG_BAR_0_ADDR 0x0000000D
/**************************** Type Definitions ******************************/
/***************** Macros (Inline Functions) Definitions ********************/
/************************** Function Prototypes *****************************/
int PcieInitRootComplex(XAxiPcie *AxiPciePtr, u16 DeviceId);
void PCIeEnumerateFabric(XAxiPcie *AxiPciePtr);
int DmaDataTransfer(u16 CdmaID);
/************************** Variable Definitions ****************************/
/* Allocate PCIe Root Complex IP Instance */
XAxiPcie AxiPcieInstance;
XAxiPcie_BarAddr BarAddr;
/* Allocate AXI CDMA IP Instance */
XAxiCdma CdmaInstance;
/****************************************************************************/
/**
* This function is the entry point for PCIe Root Complex Enumeration Example
*
* @param None
*
* @return - XST_SUCCESS if successful
* - XST_FAILURE if unsuccessful.
*
* @note None.
*
*****************************************************************************/
int main(void)
{
int Status;
/* Initialize Root Complex */
Status = PcieInitRootComplex(&AxiPcieInstance, AXIPCIE_DEVICE_ID);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/* Scan PCIe Fabric */
PCIeEnumerateFabric(&AxiPcieInstance);
/* Use AXICDMA to transfer data to/from root complex to end point. */
Status = DmaDataTransfer(AXIDMA_DEVICE_ID);
if (Status != XST_SUCCESS) {
return (XST_FAILURE);
}
return XST_SUCCESS;
}
/****************************************************************************/
/**
* This function initializes a AXI PCIe IP built as a root complex
*
* @param AxiPciePtr is a pointer to an instance of XAxiPcie data
* structure represents a root complex IP.
* @param DeviceId is AXI PCIe IP unique ID
*
* @return - XST_SUCCESS if successful.
* - XST_FAILURE if unsuccessful.
*
* @note None.
*
*
******************************************************************************/
int PcieInitRootComplex(XAxiPcie *AxiPciePtr, u16 DeviceId)
{
int Status;
u32 HeaderData;
u32 InterruptMask;
u8 BusNumber;
u8 DeviceNumber;
u8 FunNumber;
u8 PortNumber;
XAxiPcie_Config *ConfigPtr;
ConfigPtr = XAxiPcie_LookupConfig(DeviceId);
Status = XAxiPcie_CfgInitialize(AxiPciePtr, ConfigPtr,
ConfigPtr->BaseAddress);
if (Status != XST_SUCCESS) {
xil_printf("Failed to initialize PCIe Root Complex"
"IP Instance\r\n");
return XST_FAILURE;
}
if(!AxiPciePtr->Config.IncludeRootComplex) {
xil_printf("Failed to initialize...AXI PCIE is configured"
" as endpoint\r\n");
return XST_FAILURE;
}
/* See what interrupts are currently enabled */
XAxiPcie_GetEnabledInterrupts(AxiPciePtr, &InterruptMask);
xil_printf("Interrupts currently enabled are %8X\r\n", InterruptMask);
/* Make sure all interrupts disabled. */
XAxiPcie_DisableInterrupts(AxiPciePtr,
XAXIPCIE_IM_ENABLE_ALL_MASK);
/* See what interrupts are currently pending */
XAxiPcie_GetPendingInterrupts(AxiPciePtr, &InterruptMask);
xil_printf("Interrupts currently pending are %8X\r\n", InterruptMask);
/* Just if there is any pending interrupt then clear it.*/
XAxiPcie_ClearPendingInterrupts(AxiPciePtr,
XAXIPCIE_ID_CLEAR_ALL_MASK);
/*
* Read enabled interrupts and pending interrupts
* to verify the previous two operations and also
* to test those two API functions
*/
XAxiPcie_GetEnabledInterrupts(AxiPciePtr, &InterruptMask);
xil_printf("Interrupts currently enabled are %8X\r\n", InterruptMask);
XAxiPcie_GetPendingInterrupts(AxiPciePtr, &InterruptMask);
xil_printf("Interrupts currently pending are %8X\r\n", InterruptMask);
/*
* The following two calls have no effect on the behavior
* of this program. It shows you how to use those two API calls
*/
XAxiPcie_GetLocalBusBar2PcieBar(AxiPciePtr, 0, &BarAddr);
XAxiPcie_SetLocalBusBar2PcieBar(AxiPciePtr, 0, &BarAddr);
/* Make sure link is up. */
Status = XAxiPcie_IsLinkUp(AxiPciePtr);
if (Status != TRUE ) {
printf("Link is not up\r\n");
return XST_FAILURE;
}
printf("Link is up\r\n");
/*
* Read back requester ID.
*/
XAxiPcie_GetRequesterId(AxiPciePtr, &BusNumber,
&DeviceNumber, &FunNumber, &PortNumber);
printf("Bus Number is %02X\r\n"
"Device Number is %02X\r\n"
"Function Number is %02X\r\n"
"Port Number is %02X\r\n",
BusNumber, DeviceNumber, FunNumber, PortNumber);
/* Set up the PCIe header of this Root Complex */
XAxiPcie_ReadLocalConfigSpace(AxiPciePtr,
PCIE_CFG_CMD_STATUS_REG, &HeaderData);
HeaderData |= (PCIE_CFG_CMD_BUSM_EN | PCIE_CFG_CMD_MEM_EN |
PCIE_CFG_CMD_IO_EN | PCIE_CFG_CMD_PARITY |
PCIE_CFG_CMD_SERR_EN);
XAxiPcie_WriteLocalConfigSpace(AxiPciePtr,
PCIE_CFG_CMD_STATUS_REG, HeaderData);
/*
* Read back local config reg.
* to verify the write.
*/
XAxiPcie_ReadLocalConfigSpace(AxiPciePtr,
PCIE_CFG_CMD_STATUS_REG, &HeaderData);
xil_printf("PCIe Local Config Space is %8X at register"
" CommandStatus\r\n", HeaderData);
/*
* Set up Bus number
*/
HeaderData = PCIE_CFG_PRIM_SEC_BUS;
XAxiPcie_WriteLocalConfigSpace(AxiPciePtr,
PCIE_CFG_PRI_SEC_BUS_REG, HeaderData);
/*
* Read back local config reg.
* to verify the write.
*/
XAxiPcie_ReadLocalConfigSpace(AxiPciePtr,
PCIE_CFG_PRI_SEC_BUS_REG, &HeaderData);
xil_printf("PCIe Local Config Space is %8X at register "
"Prim Sec. Bus\r\n", HeaderData);
/* Now it is ready to function */
xil_printf("Root Complex IP Instance has been successfully"
" initialized\r\n");
return XST_SUCCESS;
}
/*****************************************************************************/
/**
* This function enumerates its PCIe system and figures out the nature of each
* component there like end points,bridges,...
*
* @param AxiPciePtr is a pointer to an instance of XAxiPcie
* data structure represents a root complex IP.
*
* @return None.
*
* @note None.
*
******************************************************************************/
void PCIeEnumerateFabric(XAxiPcie *AxiPciePtr)
{
u32 ConfigData;
u32 PCIeHeaderType;
u32 PCIeMultiFun;
u32 PCIeBusNum;
u32 PCIeDevNum;
u32 PCIeFunNum;
u16 PCIeVendorID;
u32 RegVal;
xil_printf("Start Enumeration of PCIe Fabric on This System\r\n");
/* Scan PCIe Fabric */
for (PCIeBusNum = 0; PCIeBusNum < PCIE_CFG_MAX_NUM_OF_BUS;
PCIeBusNum++) {
for (PCIeDevNum = 0; PCIeDevNum < PCIE_CFG_MAX_NUM_OF_DEV;
PCIeDevNum++) {
for (PCIeFunNum = 0;
PCIeFunNum < PCIE_CFG_MAX_NUM_OF_FUN;
PCIeFunNum++) {
/* Vendor ID */
XAxiPcie_ReadRemoteConfigSpace(
AxiPciePtr,PCIeBusNum,
PCIeDevNum, PCIeFunNum,
PCIE_CFG_ID_REG, &ConfigData);
PCIeVendorID = (u16) (ConfigData >> 16);
if (PCIeVendorID ==
PCIE_CFG_FUN_NOT_IMP_MASK) {
if (PCIeFunNum == 0)
/*
* We don't need to look
* any further on this device.
*/
break;
}
else {
xil_printf("PCIeBus is %02X\r\n"
"PCIeDev is %02X\r\n"
"PCIeFunc is %02X\r\n",
PCIeBusNum, PCIeDevNum,
PCIeFunNum);
xil_printf("Vendor ID is %04X \r\n",
PCIeVendorID);
/* Header Type */
XAxiPcie_ReadRemoteConfigSpace(
AxiPciePtr, PCIeBusNum,
PCIeDevNum, PCIeFunNum,
PCIE_CFG_CAH_LAT_HD_REG,
&ConfigData);
PCIeHeaderType = ConfigData &
PCIE_CFG_HEADER_TYPE_MASK;
PCIeMultiFun = ConfigData &
PCIE_CFG_MUL_FUN_DEV_MASK;
if (PCIeHeaderType ==
PCIE_CFG_HEADER_O_TYPE) {
/* This is an End Point */
xil_printf("This is an "
"End Point\r\n");
/*
* Initialize this end point
* and return.
*/
XAxiPcie_ReadRemoteConfigSpace(
AxiPciePtr,
PCIeBusNum, PCIeDevNum,
PCIeFunNum,
PCIE_CFG_CMD_STATUS_REG,
&ConfigData);
ConfigData |=
(PCIE_CFG_CMD_BUSM_EN |
PCIE_CFG_CMD_MEM_EN);
XAxiPcie_WriteRemoteConfigSpace
(AxiPciePtr,
PCIeBusNum, PCIeDevNum,
PCIeFunNum,
PCIE_CFG_CMD_STATUS_REG,
ConfigData);
/*
* Write Address to
* PCIe BAR0
*/
ConfigData =
(PCIE_CFG_BAR_0_ADDR |
PCIeBusNum |
PCIeDevNum |
PCIeFunNum);
XAxiPcie_WriteRemoteConfigSpace
(AxiPciePtr,
PCIeBusNum, PCIeDevNum,
PCIeFunNum, PCIE_CFG_BAR_0_REG,
ConfigData);
xil_printf("End Point has been"
" enabled\r\n");
}
else {
/* This is a bridge */
xil_printf("This is a "
"Bridge\r\n");
}
}
if ((!PCIeFunNum) && (!PCIeMultiFun)) {
/*
* If it is function 0 and it is not a
* multi function device, we don't need
* to look any further on this devie
*/
break;
}
} /* Functions in one device */
} /* Devices on the same bus */
} /* Buses in the same system */
xil_printf("End of Enumeration of PCIe Fabric on This system\r\n");
/* Bridge enable */
XAxiPcie_GetRootPortStatusCtrl(AxiPciePtr, &RegVal);
RegVal |= XAXIPCIE_RPSC_BRIDGE_ENABLE_MASK;
XAxiPcie_SetRootPortStatusCtrl(AxiPciePtr, RegVal);
return;
}
/*****************************************************************************/
/**
* This function transfers data from Source Address to Destination Address
* using the AXI CDMA.
* User has to specify the Source Address, Destination Address and Transfer
* Length in AXICDMA_SRC_ADDR, AXICDMA_DEST_ADDR and AXICDMA_LENGTH defines
* respectively.
*
* @param DeviceId is device ID of the XAxiCdma Device.
*
* @return - XST_SUCCESS if successful
* - XST_FAILURE.if unsuccessful.
*
* @note If the hardware system is not built correctly this function
* may never return to the caller.
*
******************************************************************************/
int DmaDataTransfer (u16 DeviceID)
{
int Status;
volatile int Error;
XAxiCdma_Config *ConfigPtr;
Error = 0;
/*
* Make sure we have a valid addresses for Src and Dst.
*/
if (AXICDMA_SRC_ADDR == 0) {
return XST_FAILURE;
}
if (AXICDMA_DEST_ADDR == 0) {
return XST_FAILURE;
}
/*
* Initialize the AXI CDMA IP.
*/
ConfigPtr = XAxiCdma_LookupConfig(DeviceID);
if (ConfigPtr == NULL) {
return XST_FAILURE;
}
Status = XAxiCdma_CfgInitialize(&CdmaInstance,
ConfigPtr, ConfigPtr->BaseAddress);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Reset the AXI CDMA device.
*/
XAxiCdma_Reset(&CdmaInstance);
/*
* Disable AXI CDMA Interrupts
*/
XAxiCdma_IntrDisable(&CdmaInstance, XAXICDMA_XR_IRQ_ALL_MASK);
/*
* Start Transferring Data from source to destination in polled mode
*/
XAxiCdma_SimpleTransfer (&CdmaInstance, AXICDMA_SRC_ADDR,
AXICDMA_DEST_ADDR, AXICDMA_LENGTH, 0, 0);
/*
* Poll Status register waiting for either Completion or Error
*/
while (XAxiCdma_IsBusy(&CdmaInstance));
Error = XAxiCdma_GetError(&CdmaInstance);
if (Error != 0x0) {
xil_printf("AXI CDMA Transfer Error = %8.8x\r\n");
return XST_FAILURE;
}
xil_printf("AXI CDMA Transfer is Complete\r\n");
return XST_SUCCESS;
}