| v_sditx Vitis Drivers API Documentation

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

Functions
Overview

## Functions
u32 | XV_SdiTx_SelfTest (XV_SdiTx *InstancePtr)
| Runs a self-test on the driver/device. More...
u32 | XV_SdiTxSelfTestExample (u32 DeviceId)
| This function checks if the Tx core initialization is successful and the default register values are matching. More...
int | main (void)
| The entry point for this example. More...

## Function Documentation

int main | ( | void |  | ) |

The entry point for this example.

It invokes the example function, and reports the execution status.

Parameters

  None. |

Returns
  - XST_SUCCESS if example finishes successfully
  - XST_FAILURE if example fails.

Note
  None.

References XV_SdiTxSelfTestExample().

u32 XV_SdiTx_SelfTest | ( | XV_SdiTx * | InstancePtr | ) |

Runs a self-test on the driver/device.

This test checks if the mode control register valus have the default values.

Parameters

  InstancePtr | is a pointer to the XV_SdiTx instance.

Returns
  - XST_SUCCESS if self-test was successful
  - XST_FAILURE if the read value was not equal to _g.c file

Note
  None

References XV_SdiTx_Config::BaseAddress, XV_SdiTx::Config, XV_SdiTx::IsReady, XV_SdiTx_ReadReg, and XV_SdiTx_StopSdi().

Referenced by XV_SdiTxSelfTestExample().

u32 XV_SdiTxSelfTestExample | ( | u32 | DeviceId | ) |

This function checks if the Tx core initialization is successful and the default register values are matching.

Parameters

  DeviceId | is the XV_SdiTx Controller Device id.

Returns
  - XST_SUCCESS if Tx initialixation and self test are successsful
  - XST_FAILURE if either Tx initialixation and self test fails

Note
  None.

References XV_SdiTx_Config::BaseAddress, XV_SdiTx_CfgInitialize(), XV_SdiTx_LookupConfig(), and XV_SdiTx_SelfTest().

Referenced by main().