| i3c Vitis Drivers API Documentation

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

Functions
xi3c_slave_polled_example.c File Reference

## Overview

Design example to use the I3C device as slave in polled mode.

It performs the send and receive operations in slave mode.

Note: Master need to check for slave devices availability and then assign address.

     MODIFICATION HISTORY:

    Ver   Who Date     Changes

    1.2 gm   02/18/25  Add support for Slave mode

## Functions
int | I3cSlavePolledExample (u16 DeviceId)
| This function does a minimal test on the I3c device and driver as a design example. More...
int | main (void)
| Main function to call the polled example. More...

## Function Documentation

int I3cSlavePolledExample | ( | u16 | DeviceId | ) |

This function does a minimal test on the I3c device and driver as a design example.

The purpose of this function is to illustrate how to use the XI3c driver.

This function sends data and expects to receive the same data through the I3C

This function uses polled driver mode of the I3C.

Parameters

  DeviceId | is the Device ID of the I3c Device and is the XPAR_<I3C_instance>_DEVICE_ID value from xparameters.h

Returns
  XST_SUCCESS if successful, otherwise XST_FAILURE.

Note

< Test data

References XI3c_Config::BaseAddress, XI3c_CfgInitialize(), XI3c_GetErrorStatus, XI3c_IsDyncAddrAssigned, XI3c_IsRespAvailable, XI3c_LookupConfig(), XI3c_SlaveRecvPolled(), and XI3c_SlaveSendPolled().

Referenced by main().

int main | ( | void |  | ) |

Main function to call the polled example.

Returns
  XST_SUCCESS if successful, XST_FAILURE if unsuccessful.

Note
  None.

References I3cSlavePolledExample().