e9b9bfa933
Added support for Ultrascale sysmon Signed-off-by: Subbaraya Sundeep Bhatta <sbhatta@xilinx.com> Acked-by: Srikanth Vemula <svemula@xilinx.com>
617 lines
23 KiB
C
Executable file
617 lines
23 KiB
C
Executable file
/******************************************************************************
|
|
*
|
|
* Copyright (C) 2007 - 2014 Xilinx, Inc. All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* Use of the Software is limited solely to applications:
|
|
* (a) running on a Xilinx device, or
|
|
* (b) that interact with a Xilinx device through a bus or interconnect.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* XILINX CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
|
* WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
|
|
* OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*
|
|
* Except as contained in this notice, the name of the Xilinx shall not be used
|
|
* in advertising or otherwise to promote the sale, use or other dealings in
|
|
* this Software without prior written authorization from Xilinx.
|
|
*
|
|
******************************************************************************/
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* @file xsysmon.h
|
|
*
|
|
* The XSysMon driver supports the Xilinx System Monitor/ADC device.
|
|
*
|
|
* The System Monitor/ADC device has the following features:
|
|
* - 10-bit, 200-KSPS (kilo samples per second)
|
|
* Analog-to-Digital Converter (ADC)
|
|
* - Monitoring of on-chip supply voltages and temperature
|
|
* - 1 dedicated differential analog-input pair and
|
|
* 16 auxiliary differential analog-input pairs
|
|
* - Automatic alarms based on user defined limits for the on-chip
|
|
* supply voltages and temperature
|
|
* - Automatic Channel Sequencer, programmable averaging, programmable
|
|
* acquisition time for the external inputs, unipolar or differential
|
|
* input selection for the external inputs
|
|
* - Inbuilt Calibration
|
|
* - Optional interrupt request generation
|
|
* - External Mux (7 Series and Zynq XADC)
|
|
*
|
|
*
|
|
* The user should refer to the hardware device specification for detailed
|
|
* information about the device.
|
|
*
|
|
* This header file contains the prototypes of driver functions that can
|
|
* be used to access the System Monitor/ADC device.
|
|
*
|
|
*
|
|
* <b> System Monitor Channel Sequencer Modes </b>
|
|
*
|
|
* The System Monitor Channel Sequencer supports the following operating modes:
|
|
*
|
|
* - <b> Default </b>: This is the default mode after power up.
|
|
* In this mode of operation the System Monitor operates in
|
|
* a sequence mode, monitoring the on chip sensors:
|
|
* Temperature, VCCINT, and VCCAUX.
|
|
* - <b> One pass through sequence </b>: In this mode the System Monitor
|
|
* converts the channels enabled in the Sequencer Channel Enable
|
|
* registers for a single pass and then stops.
|
|
* - <b> Continuous cycling of sequence </b>: In this mode the System Monitor
|
|
* converts the channels enabled in the Sequencer Channel Enable
|
|
* registers continuously.
|
|
* - <b> Single channel mode</b>: In this mode the System Monitor Channel
|
|
* Sequencer is disabled and the System Monitor operates in a
|
|
* Single Channel Mode.
|
|
* The System Monitor can operate either in a Continuous or Event
|
|
* driven sampling mode in the single channel mode.
|
|
* - <b> Simultaneous sampling mode</b>: This mode is available only in
|
|
* 7 Series and Zynq XADC devices. In this mode both ADCs sample and
|
|
* digitizes two different analog input signals at the same time.
|
|
* - <b> Independent ADC mode</b>: This mode is available only in 7 Series and
|
|
* Zynq XADC devices. In this mode ADC A is used to implement a
|
|
* fixed monitoring mode which is similar to default mode, but the
|
|
* fixed alarm functions are enabled. ADC B is available to be used
|
|
* with the external analog input channels only.
|
|
*
|
|
* <b> Initialization and Configuration </b>
|
|
*
|
|
* The device driver enables higher layer software (e.g., an application) to
|
|
* communicate to the System Monitor/ADC device.
|
|
*
|
|
* XSysMon_CfgInitialize() API is used to initialize the System Monitor/ADC
|
|
* device. The user needs to first call the XSysMon_LookupConfig() API which
|
|
* returns the Configuration structure pointer which is passed as a parameter to
|
|
* the XSysMon_CfgInitialize() API.
|
|
*
|
|
*
|
|
* <b>Interrupts</b>
|
|
*
|
|
* The System Monitor/ADC device supports interrupt driven mode and the default
|
|
* operation mode is polling mode.
|
|
*
|
|
* The interrupt mode is available only if hardware is configured to support
|
|
* interrupts.
|
|
*
|
|
* This driver does not provide a Interrupt Service Routine (ISR) for the device.
|
|
* It is the responsibility of the application to provide one if needed. Refer to
|
|
* the interrupt example provided with this driver for details on using the
|
|
* device in interrupt mode.
|
|
*
|
|
*
|
|
* <b> Virtual Memory </b>
|
|
*
|
|
* This driver supports Virtual Memory. The RTOS is responsible for calculating
|
|
* the correct device base address in Virtual Memory space.
|
|
*
|
|
*
|
|
* <b> Threads </b>
|
|
*
|
|
* This driver is not thread safe. Any needs for threads or thread mutual
|
|
* exclusion must be satisfied by the layer above this driver.
|
|
*
|
|
*
|
|
* <b> Asserts </b>
|
|
*
|
|
* Asserts are used within all Xilinx drivers to enforce constraints on argument
|
|
* values. Asserts can be turned off on a system-wide basis by defining, at
|
|
* compile time, the NDEBUG identifier. By default, asserts are turned on and it
|
|
* is recommended that users leave asserts on during development.
|
|
*
|
|
*
|
|
* <b> Building the driver </b>
|
|
*
|
|
* The XSysMon driver is composed of several source files. This allows the user
|
|
* to build and link only those parts of the driver that are necessary.
|
|
*
|
|
* <b> Limitations of the driver </b>
|
|
*
|
|
* System Monitor/ADC device can be accessed through the JTAG port and the AXI
|
|
* interface. The driver implementation does not support the simultaneous access
|
|
* of the device by both these interfaces. The user has to care of this situation
|
|
* in the user application code.
|
|
*
|
|
*
|
|
*
|
|
* <br><br>
|
|
*
|
|
* <pre>
|
|
*
|
|
* MODIFICATION HISTORY:
|
|
*
|
|
* Ver Who Date Changes
|
|
* ----- ----- -------- -----------------------------------------------------
|
|
* 1.00a xd/sv 05/22/07 First release
|
|
* 2.00a sv 07/07/08 Added bit definitions for new Alarm Interrupts in the
|
|
* Interrupt Registers. Changed the ADC data functions
|
|
* to return 16 bits of data. Added macros for conversion
|
|
* from Raw Data to Temperature/Voltage and vice-versa.
|
|
* 3.00a sdm 02/09/09 Added APIs and bit definitions for V6 SysMon.
|
|
* 4.00a ktn 10/22/09 Updated the driver to use the HAL Processor APIs/macros.
|
|
* The macros have been renamed to remove _m from the name
|
|
* in all the driver files.
|
|
* 5.00a sdm 06/15/11 Added support for XADC 7 Series.
|
|
* 5.01a bss 02/28/12 Added support for Zynq,
|
|
* renamed XSM_ATR_BRAM_UPPER to XSM_ATR_VBRAM_UPPER
|
|
* renamed XSM_ATR_BRAM_LOWER to XSM_ATR_VBRAM_LOWER
|
|
* 5.02a bss 11/23/12 Added APIs and Macros to support Temperature Updation
|
|
* over TEMP_OUT port(CR #679872)
|
|
* 5.03a bss 04/25/13 Modified XSysMon_SetSeqChEnables,
|
|
* XSysMon_SetSeqAvgEnables, XSysMon_SetSeqInputMode
|
|
* and XSysMon_SetSeqAcqTime APIs to check for Safe Mode
|
|
* instead of Single Channel mode(CR #703729) in xsysmon.c
|
|
* Modified examples: xsysmon_polled_example.c,
|
|
* xsysmon_low_level_example.c,
|
|
* xsysmon_intr_printf_example.c, xsysmon_intr_example.c
|
|
* xsysmon_extmux_example.c and
|
|
* xsysmon_polled_printf_example.c to set Sequencer Mode
|
|
* as Safe mode instead of Single channel mode before
|
|
* configuring Sequencer registers.
|
|
* 6.0 adk 19/12/13 Updated as per the New Tcl API's
|
|
* 7.0 bss 7/25/14 To support Ultrascale:
|
|
* Added XSM_CH_VUSR0 - XSMXSM_CH_VUSR3,XSM_MAX_VUSR0 -
|
|
* XSM_MIN_VUSR3,XSM_ATR_VUSR0_UPPER -
|
|
* XSM_ATR_VUSR3_LOWER macros.
|
|
* Added XSM_IP_OFFSET macro(since register
|
|
* offsets are different for Ultrascale comapared to
|
|
* earlier familes),Offsets,Masks for VUSER0 to
|
|
* VUSER3 channels, Configuration Register 3 and
|
|
* Sequence Registers 8 and 9 in xsysmon_hw.h.
|
|
* Modified XSysMon_GetAdcData,
|
|
* XSysMon_GetMinMaxMeasurement,
|
|
* XSysMon_SetSingleChParams, XSysMon_SetAlarmEnables,
|
|
* XSysMon_GetAlarmEnables,XSysMon_SetSeqChEnables,
|
|
* XSysMon_GetSeqChEnables,XSysMon_SetSeqAvgEnables,
|
|
* XSysMon_GetSeqAvgEnables,XSysMon_SetAlarmThreshold
|
|
* and XSysMon_GetAlarmThreshold in xsysmon.c.
|
|
* Modified driver tcl to generate XPAR_SYSMON_0_IP_TYPE
|
|
* parameter.
|
|
*
|
|
* </pre>
|
|
*
|
|
*****************************************************************************/
|
|
|
|
#ifndef XSYSMON_H /* Prevent circular inclusions */
|
|
#define XSYSMON_H /* by using protection macros */
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/***************************** Include Files ********************************/
|
|
|
|
#include "xil_types.h"
|
|
#include "xil_assert.h"
|
|
#include "xstatus.h"
|
|
#include "xsysmon_hw.h"
|
|
|
|
/************************** Constant Definitions ****************************/
|
|
|
|
|
|
/**
|
|
* @name Indexes for the different channels.
|
|
* @{
|
|
*/
|
|
#define XSM_CH_TEMP 0x0 /**< On Chip Temperature */
|
|
#define XSM_CH_VCCINT 0x1 /**< VCCINT */
|
|
#define XSM_CH_VCCAUX 0x2 /**< VCCAUX */
|
|
#define XSM_CH_VPVN 0x3 /**< VP/VN Dedicated analog inputs */
|
|
#define XSM_CH_VREFP 0x4 /**< VREFP */
|
|
#define XSM_CH_VREFN 0x5 /**< VREFN */
|
|
#define XSM_CH_VBRAM 0x6 /**< VBRAM - 7 Series and Zynq */
|
|
#define XSM_CH_SUPPLY_CALIB 0x07 /**< Supply Calib Data Reg */
|
|
#define XSM_CH_ADC_CALIB 0x08 /**< ADC Offset Channel Reg */
|
|
#define XSM_CH_GAINERR_CALIB 0x09 /**< Gain Error Channel Reg */
|
|
#define XSM_CH_VCCPINT 0x0D /**< On-chip PS VCCPINT Channel, Zynq */
|
|
#define XSM_CH_VCCPAUX 0x0E /**< On-chip PS VCCPAUX Channel, Zynq */
|
|
#define XSM_CH_VCCPDRO 0x0F /**< On-chip PS VCCPDRO Channel, Zynq */
|
|
#define XSM_CH_AUX_MIN 16 /**< Channel number for 1st Aux Channel */
|
|
#define XSM_CH_AUX_MAX 31 /**< Channel number for Last Aux channel */
|
|
#define XSM_CH_VUSR0 32 /**< VUSER0 Supply - UltraScale */
|
|
#define XSM_CH_VUSR1 33 /**< VUSER1 Supply - UltraScale */
|
|
#define XSM_CH_VUSR2 34 /**< VUSER2 Supply - UltraScale */
|
|
#define XSM_CH_VUSR3 35 /**< VUSER3 Supply - UltraScale */
|
|
|
|
|
|
/*@}*/
|
|
|
|
|
|
/**
|
|
* @name Indexes for reading the Calibration Coefficient Data.
|
|
* @{
|
|
*/
|
|
#define XSM_CALIB_SUPPLY_OFFSET_COEFF 0 /**< Supply Offset Calib Coefficient */
|
|
#define XSM_CALIB_ADC_OFFSET_COEFF 1 /**< ADC Offset Calib Coefficient */
|
|
#define XSM_CALIB_GAIN_ERROR_COEFF 2 /**< Gain Error Calib Coefficient*/
|
|
|
|
/*@}*/
|
|
|
|
|
|
/**
|
|
* @name Indexes for reading the Minimum/Maximum Measurement Data.
|
|
* @{
|
|
*/
|
|
#define XSM_MAX_TEMP 0 /**< Maximum Temperature Data */
|
|
#define XSM_MAX_VCCINT 1 /**< Maximum VCCINT Data */
|
|
#define XSM_MAX_VCCAUX 2 /**< Maximum VCCAUX Data */
|
|
#define XSM_MAX_VCCBRAM 3 /**< Maximum VCCBRAM Data, 7 Series/Zynq */
|
|
#define XSM_MIN_TEMP 4 /**< Minimum Temperature Data */
|
|
#define XSM_MIN_VCCINT 5 /**< Minimum VCCINT Data */
|
|
#define XSM_MIN_VCCAUX 6 /**< Minimum VCCAUX Data */
|
|
#define XSM_MIN_VCCBRAM 7 /**< Minimum VCCBRAM Data, 7 Series/Zynq */
|
|
#define XSM_MAX_VCCPINT 8 /**< Maximum VCCPINT Data, Zynq */
|
|
#define XSM_MAX_VCCPAUX 9 /**< Maximum VCCPAUX Data, Zynq */
|
|
#define XSM_MAX_VCCPDRO 0xA /**< Maximum VCCPDRO Data, Zynq */
|
|
#define XSM_MIN_VCCPINT 0xC /**< Minimum VCCPINT Data, Zynq */
|
|
#define XSM_MIN_VCCPAUX 0xD /**< Minimum VCCPAUX Data, Zynq */
|
|
#define XSM_MIN_VCCPDRO 0xE /**< Minimum VCCPDRO Data, Zynq */
|
|
#define XSM_MAX_VUSR0 0x80 /**< Maximum VUSR0 Data, Ultrascale */
|
|
#define XSM_MAX_VUSR1 0x81 /**< Maximum VUSR1 Data, Ultrascale */
|
|
#define XSM_MAX_VUSR2 0x82 /**< Maximum VUSR2 Data, Ultrascale */
|
|
#define XSM_MAX_VUSR3 0x83 /**< Maximum VUSR3 Data, Ultrascale */
|
|
#define XSM_MIN_VUSR0 0x88 /**< Minimum VUSR0 Data, Ultrascale */
|
|
#define XSM_MIN_VUSR1 0x89 /**< Minimum VUSR1 Data, Ultrascale */
|
|
#define XSM_MIN_VUSR2 0x8A /**< Minimum VUSR2 Data, Ultrascale */
|
|
#define XSM_MIN_VUSR3 0x8B /**< Minimum VUSR3 Data, Ultrascale */
|
|
|
|
|
|
/*@}*/
|
|
|
|
|
|
/**
|
|
* @name Alarm Threshold(Limit) Register (ATR) indexes.
|
|
* @{
|
|
*/
|
|
#define XSM_ATR_TEMP_UPPER 0 /**< High user Temperature */
|
|
#define XSM_ATR_VCCINT_UPPER 1 /**< VCCINT high voltage limit */
|
|
#define XSM_ATR_VCCAUX_UPPER 2 /**< VCCAUX high voltage limit */
|
|
#define XSM_ATR_OT_UPPER 3 /**< Lower Over Temperature limit */
|
|
#define XSM_ATR_TEMP_LOWER 4 /**< Low user Temperature */
|
|
#define XSM_ATR_VCCINT_LOWER 5 /**< VCCINT low voltage limit */
|
|
#define XSM_ATR_VCCAUX_LOWER 6 /**< VCCAUX low voltage limit */
|
|
#define XSM_ATR_OT_LOWER 7 /**< Lower Over Temperature limit */
|
|
#define XSM_ATR_VBRAM_UPPER 8 /**< VBRAM high voltage limit */
|
|
#define XSM_ATR_VCCPINT_UPPER 9 /**< VCCPINT Upper Alarm, Zynq */
|
|
#define XSM_ATR_VCCPAUX_UPPER 0xA /**< VCCPAUX Upper Alarm, Zynq */
|
|
#define XSM_ATR_VCCPDRO_UPPER 0xB /**< VCCPDRO Upper Alarm, Zynq */
|
|
#define XSM_ATR_VBRAM_LOWER 0xC /**< VRBAM Lower Alarm, 7 Series and Zynq*/
|
|
#define XSM_ATR_VCCPINT_LOWER 0xD /**< VCCPINT Lower Alarm, Zynq */
|
|
#define XSM_ATR_VCCPAUX_LOWER 0xE /**< VCCPAUX Lower Alarm, Zynq */
|
|
#define XSM_ATR_VCCPDRO_LOWER 0xF /**< VCCPDRO Lower Alarm, Zynq */
|
|
#define XSM_ATR_VUSR0_UPPER 0x10 /**< VUSER0 Upper Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR1_UPPER 0x11 /**< VUSER1 Upper Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR2_UPPER 0x12 /**< VUSER2 Upper Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR3_UPPER 0x13 /**< VUSER3 Upper Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR0_LOWER 0x18 /**< VUSER0 Lower Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR1_LOWER 0x19 /**< VUSER1 Lower Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR2_LOWER 0x1A /**< VUSER2 Lower Alarm, Ultrascale */
|
|
#define XSM_ATR_VUSR3_LOWER 0x1B /**< VUSER3 Lower Alarm, Ultrascale */
|
|
|
|
/*@}*/
|
|
|
|
|
|
/**
|
|
* @name Averaging to be done for the channels.
|
|
* @{
|
|
*/
|
|
#define XSM_AVG_0_SAMPLES 0 /**< No Averaging */
|
|
#define XSM_AVG_16_SAMPLES 1 /**< Average 16 samples */
|
|
#define XSM_AVG_64_SAMPLES 2 /**< Average 64 samples */
|
|
#define XSM_AVG_256_SAMPLES 3 /**< Average 256 samples */
|
|
|
|
/*@}*/
|
|
|
|
|
|
/**
|
|
* @name Channel Sequencer Modes of operation.
|
|
* @{
|
|
*/
|
|
#define XSM_SEQ_MODE_SAFE 0 /**< Default Safe Mode */
|
|
#define XSM_SEQ_MODE_ONEPASS 1 /**< Onepass through Sequencer */
|
|
#define XSM_SEQ_MODE_CONTINPASS 2 /**< Continuous Cycling Seqquencer */
|
|
#define XSM_SEQ_MODE_SINGCHAN 3 /**< Single channel - No Sequencing */
|
|
#define XSM_SEQ_MODE_SIMUL 4 /**< Simultaneous Cycling Sequencer,
|
|
* 7 Series and Zynq XADC only */
|
|
#define XSM_SEQ_MODE_INDEPENDENT 8 /**< Independent ADC Sequencer,
|
|
* 7 Series and Zynq XADC only */
|
|
|
|
/*@}*/
|
|
|
|
/* For backwards compatabilty */
|
|
#define XSM_CH_CALIBRATION XSM_CH_ADC_CALIB
|
|
#define XSM_ATR_BRAM_UPPER XSM_ATR_VBRAM_UPPER
|
|
#define XSM_ATR_BRAM_LOWER XSM_ATR_VBRAM_LOWER
|
|
|
|
|
|
/**************************** Type Definitions ******************************/
|
|
|
|
/**
|
|
* This typedef contains configuration information for the System Monitor/ADC
|
|
* device.
|
|
*/
|
|
typedef struct {
|
|
u16 DeviceId; /**< Unique ID of device */
|
|
u32 BaseAddress; /**< Device base address */
|
|
int IncludeInterrupt; /**< Supports Interrupt driven mode */
|
|
u8 IpType; /**< 1 - System Management */
|
|
/**< 0 - XADC/System Monoitor */
|
|
} XSysMon_Config;
|
|
|
|
|
|
/**
|
|
* The driver's instance data. The user is required to allocate a variable
|
|
* of this type for every System Monitor/ADC device in the system. A pointer to
|
|
* a variable of this type is then passed to the driver API functions.
|
|
*/
|
|
typedef struct {
|
|
XSysMon_Config Config; /**< XSysMon_Config of current device */
|
|
u32 IsReady; /**< Device is initialized and ready */
|
|
u32 Mask; /**< Store the previously written value
|
|
in CONVST register */
|
|
} XSysMon;
|
|
|
|
/***************** Macros (Inline Functions) Definitions ********************/
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro checks if the SysMonitor/ADC device is in Event Sampling mode.
|
|
*
|
|
* @param InstancePtr is a pointer to the XSysMon instance.
|
|
*
|
|
* @return
|
|
* - TRUE if the device is in Event Sampling Mode.
|
|
* - FALSE if the device is in Continuous Sampling Mode.
|
|
*
|
|
* @note C-Style signature:
|
|
* int XSysMon_IsEventSamplingMode(XSysMon *InstancePtr);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_IsEventSamplingModeSet(InstancePtr) \
|
|
(((XSysMon_ReadReg((InstancePtr)->Config.BaseAddress, \
|
|
XSM_CFR0_OFFSET) & XSM_CFR0_EC_MASK) ? \
|
|
TRUE : FALSE))
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro checks if the Dynamic Reconfiguration Port (DRP) transaction from
|
|
* the JTAG is in progress.
|
|
*
|
|
* @param InstancePtr is a pointer to the XSysMon instance.
|
|
*
|
|
* @return
|
|
* - TRUE if the DRP transaction from JTAG is in Progress.
|
|
* - FALSE if there is no DRP transaction from the JTAG.
|
|
*
|
|
* @note C-Style signature:
|
|
* int XSysMon_IsDrpBusy(XSysMon *InstancePtr);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_IsDrpBusy(InstancePtr) \
|
|
((XSysMon_ReadReg((InstancePtr)->Config.BaseAddress, \
|
|
XSM_SR_OFFSET) & XSM_SR_JTAG_BUSY_MASK) ? \
|
|
TRUE : FALSE)
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro checks if the Dynamic Reconfiguration Port (DRP) is locked by the
|
|
* JTAG.
|
|
*
|
|
* @param InstancePtr is a pointer to the XSysMon instance.
|
|
*
|
|
* @return
|
|
* - TRUE if the DRP is locked by the JTAG.
|
|
* - FALSE if the DRP is not locked by the JTAG.
|
|
*
|
|
* @note C-Style signature:
|
|
* int XSysMon_IsDrpLocked(XSysMon *InstancePtr);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_IsDrpLocked(InstancePtr) \
|
|
(((XSysMon_ReadReg((InstancePtr)->Config.BaseAddress, \
|
|
XSM_SR_OFFSET) & XSM_SR_JTAG_LOCKED_MASK) ? \
|
|
TRUE : FALSE))
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro converts System Monitor/ADC Raw Data to Temperature(centigrades).
|
|
*
|
|
* @param AdcData is the SysMon Raw ADC Data.
|
|
*
|
|
* @return The Temperature in centigrades.
|
|
*
|
|
* @note C-Style signature:
|
|
* float XSysMon_RawToTemperature(u32 AdcData);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_RawToTemperature(AdcData) \
|
|
((((float)(AdcData)/65536.0f)/0.00198421639f ) - 273.15f)
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro converts System Monitor/ADC Raw Data to Voltage(volts).
|
|
*
|
|
* @param AdcData is the System Monitor/ADC Raw Data.
|
|
*
|
|
* @return The Voltage in volts.
|
|
*
|
|
* @note C-Style signature:
|
|
* float XSysMon_RawToVoltage(u32 AdcData);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_RawToVoltage(AdcData) \
|
|
((((float)(AdcData))* (3.0f))/65536.0f)
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro converts Temperature in centigrades to System Monitor/ADC Raw Data.
|
|
*
|
|
* @param Temperature is the Temperature in centigrades to be
|
|
* converted to System Monitor/ADC Raw Data.
|
|
*
|
|
* @return The System Monitor/ADC Raw Data.
|
|
*
|
|
* @note C-Style signature:
|
|
* int XSysMon_TemperatureToRaw(float Temperature);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_TemperatureToRaw(Temperature) \
|
|
((int)(((Temperature) + 273.15f)*65536.0f*0.00198421639f))
|
|
|
|
/****************************************************************************/
|
|
/**
|
|
*
|
|
* This macro converts Voltage in Volts to System Monitor/ADC Raw Data.
|
|
*
|
|
* @param Voltage is the Voltage in volts to be converted to
|
|
* System Monitor/ADC Raw Data.
|
|
*
|
|
* @return The System Monitor/ADC Raw Data.
|
|
*
|
|
* @note C-Style signature:
|
|
* int XSysMon_VoltageToRaw(float Voltage);
|
|
*
|
|
*****************************************************************************/
|
|
#define XSysMon_VoltageToRaw(Voltage) \
|
|
((int)((Voltage)*65536.0f/3.0f))
|
|
|
|
|
|
/************************** Function Prototypes *****************************/
|
|
|
|
/**
|
|
* Functions in xsysmon_sinit.c
|
|
*/
|
|
XSysMon_Config *XSysMon_LookupConfig(u16 DeviceId);
|
|
|
|
/**
|
|
* Functions in xsysmon.c
|
|
*/
|
|
int XSysMon_CfgInitialize(XSysMon *InstancePtr,
|
|
XSysMon_Config *ConfigPtr, u32 EffectiveAddr);
|
|
|
|
void XSysMon_Reset(XSysMon *InstancePtr);
|
|
|
|
u32 XSysMon_GetStatus(XSysMon *InstancePtr);
|
|
|
|
u32 XSysMon_GetAlarmOutputStatus(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_StartAdcConversion(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_ResetAdc(XSysMon *InstancePtr);
|
|
|
|
u16 XSysMon_GetAdcData(XSysMon *InstancePtr, u8 Channel);
|
|
|
|
u16 XSysMon_GetCalibCoefficient(XSysMon *InstancePtr, u8 CoeffType);
|
|
|
|
u16 XSysMon_GetMinMaxMeasurement(XSysMon *InstancePtr, u8 MeasurementType);
|
|
|
|
void XSysMon_SetAvg(XSysMon *InstancePtr, u8 Average);
|
|
u8 XSysMon_GetAvg(XSysMon *InstancePtr);
|
|
|
|
int XSysMon_SetSingleChParams(XSysMon *InstancePtr, u8 Channel,
|
|
int IncreaseAcqCycles, int IsEventMode,
|
|
int IsDifferentialMode);
|
|
|
|
void XSysMon_SetAlarmEnables(XSysMon *InstancePtr, u32 AlmEnableMask);
|
|
u32 XSysMon_GetAlarmEnables(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_SetCalibEnables(XSysMon *InstancePtr, u16 Calibration);
|
|
u16 XSysMon_GetCalibEnables(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_SetSequencerMode(XSysMon *InstancePtr, u8 SequencerMode);
|
|
u8 XSysMon_GetSequencerMode(XSysMon *InstancePtr);
|
|
void XSysMon_SetSequencerEvent(XSysMon *InstancePtr, int IsEventMode);
|
|
|
|
void XSysMon_SetExtenalMux(XSysMon *InstancePtr, u8 Channel);
|
|
|
|
void XSysMon_SetAdcClkDivisor(XSysMon *InstancePtr, u8 Divisor);
|
|
u8 XSysMon_GetAdcClkDivisor(XSysMon *InstancePtr);
|
|
|
|
int XSysMon_SetSeqChEnables(XSysMon *InstancePtr, u64 ChEnableMask);
|
|
u64 XSysMon_GetSeqChEnables(XSysMon *InstancePtr);
|
|
|
|
int XSysMon_SetSeqAvgEnables(XSysMon *InstancePtr, u64 AvgEnableChMask);
|
|
u64 XSysMon_GetSeqAvgEnables(XSysMon *InstancePtr);
|
|
|
|
int XSysMon_SetSeqInputMode(XSysMon *InstancePtr, u32 InputModeChMask);
|
|
u32 XSysMon_GetSeqInputMode(XSysMon *InstancePtr);
|
|
|
|
int XSysMon_SetSeqAcqTime(XSysMon *InstancePtr, u32 AcqCyclesChMask);
|
|
u32 XSysMon_GetSeqAcqTime(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_SetAlarmThreshold(XSysMon *InstancePtr, u8 AlarmThrReg, u16 Value);
|
|
u16 XSysMon_GetAlarmThreshold(XSysMon *InstancePtr, u8 AlarmThrReg);
|
|
|
|
void XSysMon_SetOverTemp(XSysMon *InstancePtr, u16 Value);
|
|
u16 XSysMon_GetOverTemp(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_EnableUserOverTemp(XSysMon *InstancePtr);
|
|
void XSysMon_DisableUserOverTemp(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_EnableTempUpdate(XSysMon *InstancePtr);
|
|
void XSysMon_DisableTempUpdate(XSysMon *InstancePtr);
|
|
void XSysMon_SetTempWaitCycles(XSysMon *InstancePtr, u16 WaitCycles);
|
|
|
|
|
|
/**
|
|
* Functions in xsysmon_selftest.c
|
|
*/
|
|
int XSysMon_SelfTest(XSysMon *InstancePtr);
|
|
|
|
/**
|
|
* Functions in xsysmon_intr.c
|
|
*/
|
|
void XSysMon_IntrGlobalEnable(XSysMon *InstancePtr);
|
|
void XSysMon_IntrGlobalDisable(XSysMon *InstancePtr);
|
|
|
|
void XSysMon_IntrEnable(XSysMon *InstancePtr, u32 Mask);
|
|
void XSysMon_IntrDisable(XSysMon *InstancePtr, u32 Mask);
|
|
u32 XSysMon_IntrGetEnabled(XSysMon *InstancePtr);
|
|
|
|
u32 XSysMon_IntrGetStatus(XSysMon *InstancePtr);
|
|
void XSysMon_IntrClear(XSysMon *InstancePtr, u32 Mask);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* End of protection macro. */
|