spips
Vitis Drivers API Documentation
 All Data Structures Files Functions Variables Typedefs Groups Pages
xspips_selftest_example.c File Reference

Overview

This file contains an example for using the SPI Hardware, it does a simple hardware connection check.

Note

None

MODIFICATION HISTORY:
Ver   Who    Date     Changes


1.00 drg/jz 01/25/10 First release. 3.7 asa 04/01/22 The selftest example uses the instance name as "Spi" in the instance definition. That causes issue when periphtest application is build for a design that has a soft spi IP along with the hard spips. This is fixed by renaming the instance name from "Spi" to "SpiPs" 3.9 sb 07/05/23 Added support for system device-tree flow. 3.14 vlt 12/18/25 Update Doxygen comments to include SDT flow details.

#include "xparameters.h"
#include "xspips.h"
#include "xil_printf.h"

Functions

int SpiPsSelfTestExample (UINTPTR BaseAddress)
 This function does a selftest on the SPIPS device and XSpiPs driver as an example. More...
 
int main (void)
 Main function to call the Spi SelfTest example. More...
 

Function Documentation

int main ( void  )

Main function to call the Spi SelfTest example.

Returns
XST_SUCCESS if successful, XST_FAILURE if unsuccessful
Note
None

References SpiPsSelfTestExample().

int SpiPsSelfTestExample ( UINTPTR  BaseAddress)

This function does a selftest on the SPIPS device and XSpiPs driver as an example.

The purpose of this function is to illustrate the usage of the XSpiPs driver.

Parameters
BaseAddresscontains the base address of the device
Returns
XST_SUCCESS if successful, XST_FAILURE if unsuccessful
Note
In XSCT/classic flow, DeviceId is used to look up the device configuration.

References XSpiPs_Config::BaseAddress, XSpiPs_CfgInitialize(), XSpiPs_LookupConfig(), and XSpiPs_SelfTest().

Referenced by main().