i2stx: xi2stx_selftest_example.c File Reference

| i2stx Xilinx SDK Drivers API Documentation

- Overview
- Data Structures
- APIs
- File List

Functions
xi2stx_selftest_example.c File Reference

## Overview

This file contains a example for using the I2s Transmitter hardware device and I2s Transmitter driver.

     MODIFICATION HISTORY:

    Ver      Who Date       Changes

    1.0   kar 01/25/18      First release

## Functions
int | I2sSelfTestExample (u16 DeviceId)
| This function does a minimal test on the I2s Transmitter device and driver as a design example. More...
int | main (void)
| Main function to call the Self Test example. More...

## Function Documentation

int I2sSelfTestExample | ( | u16 | DeviceId | ) |

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

The purpose of this function is to illustrate how to use the Xi2s transmitter component.

Parameters

  DeviceId | is the Device ID of the I2s TX Device and is the XPAR_<I2S_TRANSMITTER_instance>_DEVICE_ID value from xparameters.h

Returns
  XST_SUCCESS if successful, otherwise XST_FAILURE.

Note
  None.

References XI2stx_Config::BaseAddress, XI2s_Tx_CfgInitialize(), XI2s_Tx_LookupConfig(), and XI2s_Tx_SelfTest().

Referenced by main().

int main | ( | void |  | ) |

Main function to call the Self Test example.

Parameters

  None. |

Returns
  XST_SUCCESS if successful, XST_FAILURE if unsuccessful.

Note
  None.

References I2sSelfTestExample().