v_sditxss: si570drv.h File Reference

| v_sditxss Xilinx SDK Drivers API Documentation

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

Macros
si570drv.h File Reference

## Overview

This file contains definitions for low-level driver functions for controlling the SiliconLabs Si570 clock generator as mounted on the ZCU106 demo board.

The user should refer to the hardware device specification for more details of the device operation.

    MODIFICATION HISTORY:

    Ver   Who  Date        Changes

    1.00     ssh 07/05/2018   Initial release

## Macros
#define | SI570_DEBUG FALSE
| Debug output enable. More...
#define | SI570_SUCCESS 0
| The following constants are error codes generated by the functions in this driver. More...
#define | SI570_ERR_IIC -1
| IIC error occurred. More...
#define | SI570_ERR_FREQ -2
| Could not calculate frequency setting. More...
#define | SI570_ERR_PARM -3
| Invalid parameter. More...

## Macro Definition Documentation

#define SI570_DEBUG FALSE

Debug output enable.

Set to TRUE to enable debug prints, to FALSE to disable debug prints.

Referenced by Si570_DoSettings(), and Si570_SetClock().

#define SI570_ERR_FREQ -2

Could not calculate frequency setting.

#define SI570_ERR_IIC -1

IIC error occurred.

Referenced by Si570_DoSettings().

#define SI570_ERR_PARM -3

Invalid parameter.

Referenced by Si570_DoSettings().

#define SI570_SUCCESS 0

The following constants are error codes generated by the functions in this driver.

Operation was successful

Referenced by Si570_DoSettings().