v_sditxss: xsdi_menu.h File Reference

| v_sditxss Xilinx SDK Drivers API Documentation

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

Data Structures | Macros | Enumerations | Functions
xsdi_menu.h File Reference

## Overview

This is the main header file for the Xilinx Menu implementation as used in the SDI example design.

    MODIFICATION HISTORY:

    Ver   Who  Date       Changes

    1.0     ssh      07/05/2018 Initial version

## Data Structures
struct | XSdi_Menu
| The SDI menu instance data. More...

## Macros
#define | XSDI_MENU_H_
| Prevent circular inclusions by using protection macros. More...

## Enumerations
enum | XSdi_MenuType
| The SDI menu types. More...

## Functions
void | XSdi_MenuInitialize (XSdi_Menu *InstancePtr, u32 UartBaseAddress)
| This function takes care of the SDI menu initialization. More...
void | XSdi_MenuProcess (XSdi_Menu *InstancePtr)
| This function is called to trigger the SDI menu statemachine. More...

## Macro Definition Documentation

#define XSDI_MENU_H_

Prevent circular inclusions by using protection macros.

## Enumeration Type Documentation

enum XSdi_MenuType

The SDI menu types.

## Function Documentation

void XSdi_MenuInitialize | ( | XSdi_Menu * | InstancePtr,
|  | u32 | UartBaseAddress
| ) |  |

This function takes care of the SDI menu initialization.

Parameters

  InstancePtr | is a pointer to the XSdi_Menu instance.
  UartBaseAddress | points to the base address of PS uart.

Returns
  None

Referenced by main().

void XSdi_MenuProcess | ( | XSdi_Menu * | InstancePtr | ) |

This function is called to trigger the SDI menu statemachine.

Parameters

  InstancePtr | is a pointer to the XSdi_Menu instance.

Returns
  None

Referenced by main().