Ug772 Xadc Wiz
Ug772 Xadc Wiz
Ug772 Xadc Wiz
Notice of Disclaimer
The information disclosed to you hereunder (the Materials) is provided solely for the selection and use of Xilinx products. To the maximum
extent permitted by applicable law: (1) Materials are made available "AS IS" and with all faults, Xilinx hereby DISCLAIMS ALL
WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF
MERCHANTABILITY, NON-INFRINGEMENT, OR FITNESS FOR ANY PARTICULAR PURPOSE; and (2) Xilinx shall not be liable (whether
in contract or tort, including negligence, or under any other theory of liability) for any loss or damage of any kind or nature related to, arising
under, or in connection with, the Materials (including your use of the Materials), including for any direct, indirect, special, incidental, or
consequential loss or damage (including loss of data, profits, goodwill, or any type of loss or damage suffered as a result of any action
brought by a third party) even if such damage or loss was reasonably foreseeable or Xilinx had been advised of the possibility of the same.
Xilinx assumes no obligation to correct any errors contained in the Materials or to notify you of updates to the Materials or to product
specifications. You may not reproduce, modify, distribute, or publicly display the Materials without prior written consent. Certain products are
subject to the terms and conditions of the Limited Warranties which can be viewed at http://www.xilinx.com/warranty.htm; IP cores may be
subject to warranty and support terms contained in a license issued to you by Xilinx. Xilinx products are not designed or intended to be failsafe or for use in any application requiring fail-safe performance; you assume sole risk and liability for use of Xilinx products in Critical
Applications: http://www.xilinx.com/warranty.htm#critapps.
Copyright 20112012 Xilinx, Inc. Xilinx, the Xilinx logo, Artix, ISE, Kintex, Spartan, Virtex, Vivado, Zynq, and other designated brands
included herein are trademarks of Xilinx in the United States and other countries. All other trademarks are the property of their respective
owners.
Revision History
The following table shows the revision history for this document.
Date
Version
03/01/11
1.0
06/22/11
1.1
08/17/11
1.2
01/18/12
1.3
Updated screen captures to core version 1.4 and ISE version to 13.4.
04/24/12
1.4
07/25/12
1.5
Updated with information about Core version 2.2, released in Vivado version 2012.2
only.
Revision
www.xilinx.com
Table of Contents
Revision History . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Chapter 1: Introduction
About the Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Supported Devices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Recommended Design Experience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Ordering Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Feedback. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
5
5
6
6
6
7
29
30
33
33
34
34
www.xilinx.com
www.xilinx.com
Chapter 1
Introduction
This chapter introduces and describes the LogiCORE IP XADC Wizard and provides
related information, including recommended design experience, additional resources,
technical support, and submitting feedback to Xilinx.
Features
Supported Devices
The Wizard supports the following FPGAs:
7 Series FPGAs
For a complete listing of supported devices, see the release notes for this Wizard. For more
information on the 7 series FPGAs, see the 7 Series FPGAs Overview [Ref 1].
www.xilinx.com
Chapter 1: Introduction
Design Files:
Example Design:
Test Bench:
Constraints File:
Provided
Simulation Model:
Not provided
Technical Support
For technical support, go to www.xilinx.com/support to file a WebCase. Questions are
routed to a team with expertise using the XADC Wizard. Additional support resources
available at this site include Answers, Documentation, Downloads, and Forums.
Xilinx provides technical support for this LogiCORE IP product when used as described in
the product documentation. Xilinx cannot guarantee timing, functionality, or support of
product if implemented in devices that are not defined in the documentation, if
customized beyond that allowed in the product documentation, or if changes are made to
any section of the design labeled DO NOT MODIFY.
Ordering Information
The LogiCORE IP XADC Wizard is provided free of charge under the terms of the Xilinx
End User License Agreement. The Wizard can be generated by the Xilinx Vivado IP
catalog, which is a standard component of the Xilinx Vivado Design Suite. This version of
the core can be generated using the Vivado IP catalog 2012.2. For more information, visit
the Architecture Wizards web page.
Information about additional Xilinx LogiCORE modules is available at the Xilinx IP
Center. For pricing and availability of other Xilinx LogiCORE modules and software,
contact your local Xilinx sales representative.
www.xilinx.com
Feedback
Feedback
Xilinx welcomes comments and suggestions about the XADC Wizard core and the
accompanying documentation.
XADC Wizard
For comments or suggestions about the XADC Wizard core, submit a WebCase from
www.xilinx.com/support/clearexpress/websupport.htm. Be sure to include the
following information:
Product name
Documentation
For comments or suggestions about the XADC Wizard documentation, submit a WebCase
from www.xilinx.com/support/clearexpress/websupport.htm. Be sure to include the
following information:
Document title
Document number
www.xilinx.com
Chapter 1: Introduction
www.xilinx.com
Chapter 2
Linux
Simulation
For the supported versions of the tools, see the ISE Design Suite 14: Release Notes Guide.
Synthesis
www.xilinx.com
Click Login at the top of the Xilinx home page then follow the on screen instructions
to create a MySupport account.
Start Vivado.
2.
After creating a new 7 series family project or opening an existing one, the IP catalog
appears at the right side of the window, as shown in Figure 2-1.
Figure 2-1:
10
Vivado IP Catalog
www.xilinx.com
3.
Determine if the installation was successful by verifying that XADC Wizard appears at
the following location in the catalog list:
/FPGA Features and Design/XADC.
www.xilinx.com
11
12
www.xilinx.com
Chapter 3
Functional Overview
The XADC Wizard is an interactive graphical user interface (GUI) that instantiates a XADC
block configured to your requirements. Using the wizard, users can explicitly configure the
XADC to operate in the desired mode. The GUI allows you to select the channels, enable
alarms, and set the alarm limits.
I/O Signals
Table 3-1 describes the input and output ports provided from the XADC Wizard.
Availability of ports is controlled by user-selected parameters. For example, when
Dynamic Reconfiguration is selected, only ports associated with Dynamic Reconfiguration
are exposed. Any port that is not exposed is tied off or connected to a signal labeled as
unused in the delivered source code.
Table 3-1:
DI_IN[15:0]
DO_OUT[15:0]
DADDR_IN[6:0]
Direction
Description
Input
Output
Input
www.xilinx.com
13
Table 3-1:
Direction
DEN_IN
Input
DWE_IN
Input
DCLK_IN
Input
DRDY_OUT
Output
Input
Input
Input
Input
Inputs
USER_TEMP_ALARM_OUT
Output
VCCINT_ALARM_OUT
Output
VCCAUX_ALARM_OUT
Output
OT_OUT
Output
Outputs
Output
RESET_IN
CONVST_IN
CONVSTCLK_IN
VP_IN
VN_IN
VAUXP15[15:0]
VAUXN15[15:0]
CHANNEL_OUT[4:0]
EOC_OUT
14
Description
www.xilinx.com
Overview
Table 3-1:
Direction
Description
Output
BUSY_OUT
Output
JTAGLOCKED_OUT
Output
JTAGMODIFIED_OUT
Output
JTAGBUSY_OUT
Output
VBRAM_ALARM_OUT
Output
VCCPINT_ALARM_OUT
Output
VCCPAUX_ALARM_OUT
Output
VCCDDRO_ALARM_OUT
Output
MUXADDR_OUT[4:0]
Output
ALARM_OUT
Output
EOS_OUT
User Attributes
The XADC functionality is configured through control registers (See the Register File
Interface sections in the 7 Series FPGAs XADC User Guide [Ref 2]). Table 3-2 lists the
attributes associated with these control registers. These control registers can be initialized
using HDL by configuring attaching HDL attributes to the XADC primitive instance and
configuring them according to Table 3-2. The control registers can also be initialized
through the DRP at run time. The XADC Wizard simplifies the initialization of these
control registers in the HDL instantiation by automatically configuring them to implement
the operating behavior you specify using the IP core GUI.
www.xilinx.com
15
Table 3-2:
XADC Attributes
Attribute
Name
Control
Reg
Address
INIT_40
Configuration
register 0
40h
INIT_41
Configuration
register 1
41h
INIT_42
Configuration
register 2
42h
Description
48h to 4Fh
Alarm Limits
registers
50h to 5Fh
SIM_MONITOR
_FILE
Simulation
Analog Entry
File
SIM_DEVICE
Device family
information
INIT_48 to
INIT_4F
Sequence
registers
INIT_50 to
INIT_5F
Creating a Directory
To set up the example project, first create a directory using the following steps:
1.
Change directory to the desired location. This example uses the following location and
directory name:
/Projects/xadc_example
2.
Start Vivado.
For help starting and using Vivado, see the Vivado Help, available in the Vivado
documentation [Ref 3].
16
3.
4.
www.xilinx.com
5.
Figure 3-1:
New Project
2.
3.
Select a device from the Device list that support XADC primitive.
4.
Select an appropriate package from the Package list. This example uses the XC7K235T
device (see Figure 3-2).
Note: If an unsupported silicon family is selected, the XADC Wizard remains light gray in the
taxonomy tree and cannot be customized. Only devices containing the XADC are supported by
the Wizard. See the 7 Series FPGAs Overview [Ref 1] for a list of devices containing XADC.
5.
6.
Click OK.
www.xilinx.com
17
Figure 3-2:
2.
After the wizard is launched, the IP catalog displays a series of screens that allow you to
configure the XADC Wizard.
18
www.xilinx.com
XADC Setup
The XADC Wizard screen (Page 1) of the Wizard (Figure 3-3) allows you to select the
component name, analog stimulus file name, start-up channel mode, timing mode, and
DRP timing options.
X-Ref Target - Figure 3-3
Component Name
User selectable component name is available. Component names must not contain any
reserved words in Verilog or VHDL.
Single Channel: In this mode, you can select only one channel to monitor.
Channel Sequencer: Choosing this mode, allows you to select any number of
channels to monitor. The channels to be used for this mode can be selected on Page 5
(Figure 3-7, page 25) and Page 6 (Figure 3-8, page 26) of the Wizard.
Simultaneous Sampling Mode: This mode allows you to monitor two external
channels simultaneously. For more information about this mode see the 7 Series
www.xilinx.com
19
Independent ADC Mode: This mode allows you to run the XADC in independent
mode. Here, the XADC independently monitors the externals channels and at the
same time monitors the FPGA voltages and temperature.
Timing Mode
The XADC can operate in two timing modes:
Continuous Mode: In this mode, the XADC continues to sample and convert the
selected channel/channels.
20
www.xilinx.com
I/O Ports
The I/O Port Selection screen (Page 2) of the Wizard (Figure 3-4) allows you to select the
I/O ports on the XADC primitive.
X-Ref Target - Figure 3-4
Control Ports
This section allows you to select control input ports:
Status Outputs
Output status signals are also provided to facilitate interfacing of the XADC to a user
design. See the 7 Series FPGAs XADC User Guide [Ref 2] for more information.
www.xilinx.com
21
ADC Setup
If the XADC is configured for Channel Sequencer, Simultaneous Sampling or Independent
ADC mode, you can choose the required sequencer mode. The available options are
Continuous, One-pass or Default mode.
The Channel Averaging drop-down menu allows you to select the required averaging
value. The available options are None, 16, 64 and 256.
You can select the type of ADC Calibration and/or Supply Sensor Calibration by checking
the respective checkboxes. Calibration Averaging is enabled by default in XADC. You can
disable this by deselecting the box.
Alarm Setup
The Alarm Setup screens of the Wizard (Figure 3-5 and Figure 3-6) allow the alarm outputs
to be enabled for the on-chip sensors. If a measurement of an on-chip sensor lies outside
the specified limits, then a logic output goes active if enabled. For a detailed description of
the alarm functionality see the 7 Series FPGAs XADC User Guide [Ref 2].
22
www.xilinx.com
Figure 3-5:
www.xilinx.com
23
Figure 3-6:
Enable Alarms
Use the checkboxes to enable alarm logic outputs. The eight options are:
VCCNT alarm
VCCAUX alarm
VBRAM alarm
24
www.xilinx.com
Use the Channel Sequencer Setup P1 and P2 screen to select Channels for monitoring,
enable Averaging for selected channels, enable Bipolar mode for external channels
and increase the Acquisition time for the selected channels.
In case of Independent ADC mode, only external channels are listed and can be userselected.
For more information about the simultaneous sampling mode and Independent ADC
mode, see the 7 Series FPGAs XADC User Guide [Ref 2].
X-Ref Target - Figure 3-7
Figure 3-7:
www.xilinx.com
25
Figure 3-8:
26
www.xilinx.com
Figure 3-9:
www.xilinx.com
27
28
www.xilinx.com
Chapter 4
<project_name>/<project_name>.srcs/sources_1/ip/
Top-level project directory; name is user-defined
topdirectory
<project_name>/<project_name>.srcs/sources_1/ip/<component name>
Core release notes file
<component name>/doc
Product documentation
<component name>/example design
Verilog or VHDL design files
<component name>/implement/results
Results directory, created after implementation scripts are run, and
contains implement script results
<component name>/simulation
Simulation scripts
simulation/functional
Functional simulation files
simulation/timing
Timing simulation files
www.xilinx.com
29
<project_name>/<project_name>.srcs/sources_1/ip/
The <project_name>/<project_name>.srcs/sources_1/ip/ contains all the Vivado project
files.
Table 4-1:
Project Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/
<component_name>.v[hd]
<component_name>.xci
<component_name>_flist.txt
<component_name>.{veo|vho}
<component_name>.xdc
Back to Top
<project_name>/<project_name>.srcs/sources_1/ip/<component name>
The <component name> directory contains the readme file provided with the core, which
can include last-minute changes and updates.
Table 4-2:
Description
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>
xadc_wiz_v2_2_readme.txt
Back to Top
<component name>/doc
The doc directory contains the PDF documentation provided with the core.
Table 4-3:
Doc Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/doc
ug772_xadc_wizard.pdf
Back to Top
30
www.xilinx.com
Description
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/example_design
<component_name>_exdes.v(hd)
<component_name>_exdes.xdc
Back to Top
<component name>/implement/results
The results directory should be created by the user and implementation files should be
copied to the results directory before running timing simulations.
Table 4-5:
Results Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/
<component_name>/implement/results
<component name>/simulation
The simulation directory contains the simulation scripts provided with the core.
Table 4-6:
Simulation Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/simulation
<component_name>_tb.v[hd]
Back to Top
www.xilinx.com
31
simulation/functional
The functional directory contains functional simulation scripts provided with the core.
Table 4-7:
Functional Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/
<component_name>/simulation/functional
simulate_xsim.sh
simulate_xsim.bat
simulate_mti.do
simulate_ncsim.sh
simulate_vcs.sh
Back to Top
simulation/timing
The timing directory contains timing simulation scripts provided with the core.
Table 4-8:
Functional Directory
Name
Description
<project_name>/<project_name>.srcs/sources_1/ip/
<component_name>/simulation/timing
simulate_xsim.sh
simulate_xsim.bat
simulate_mti.do
simulate_ncsim.sh
Back to Top
32
www.xilinx.com
Simulation Scripts
Simulation Scripts
Functional Simulation
The test scripts are a ModelSim, Cadence IES, VCS, VCS MX, or Vivado simulator macro
that automate the simulation of the test bench. They are available from the following
location:
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/
simulation/functional/
Timing Simulation
The test scripts are a ModelSim, Cadence IES, or Vivado simulator macro that automate the
simulation of the demonstration test bench. They are available from the following location:
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/
simulation/timing/
Example Design
Top Level Example Design
The following files describe the top-level example design for the XADC Wizard core.
VHDL
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/
example_design/<component_name>_exdes.vhd
Verilog
<project_name>/<project_name>.srcs/sources_1/ip/<component_name>/
example_design/<component_name>_exdes.v
The example design, instantiates the XADC core that is generated by the wizard.
www.xilinx.com
33
%XAMPLE $ESIGN
$#,+
'ENERATION
-ONITOR !LARMS
3TATUS 3IGNALS
8!$# #ORE
2ESET
%VENT