8933d11dd5
This patch updates the doxygen for the drivers hwicap, iomodule, intc , iic , iicps to include .h files in the listof files provided in the index.html file. Signed-off-by: Kedareswara rao Appana <appanad@xilinx.com>
95 lines
7.7 KiB
HTML
Executable file
95 lines
7.7 KiB
HTML
Executable file
<html>
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
|
<title>
|
|
Xilinx Driver hwicap v10_0: hwicap v10_0
|
|
</title>
|
|
<link href="doxygen_kalyanidocs/doc/css/driver_api_doxygen.css" rel="stylesheet" type="text/css">
|
|
</head>
|
|
<h3 class="PageHeader">Xilinx Processor IP Library</h3>
|
|
<hl>Software Drivers</hl>
|
|
<hr class="whs1">
|
|
|
|
<!-- Generated by Doxygen 1.6.1 -->
|
|
<div class="navigation" id="top">
|
|
<div class="tabs">
|
|
<ul>
|
|
<li class="current"><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="contents">
|
|
<h1>hwicap v10_0</h1><p>The Xilinx <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> driver supports the Xilinx Hardware Internal Configuration Access Port (HWICAP) device.</p>
|
|
<p>The HWICAP device is used for reconfiguration of select FPGA resources as well as loading partial bitstreams from the system memory through the Internal Configuration Access Port (ICAP).</p>
|
|
<p>The source code for the XHwIcap_SetClbBits and XHwIcap_GetClbBits functions are not included. These functions are delivered as .o files. These files have been compiled using gcc version 4.1.1. Libgen uses the appropriate .o files for the target processor.</p>
|
|
<p><b> Initialization and Configuration </b></p>
|
|
<p>The device driver enables higher layer software (e.g., an application) to communicate to the HWICAP device.</p>
|
|
<p><a class="el" href="xhwicap_8c.html#a928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a> API is used to initialize the HWICAP device. The user needs to first call the <a class="el" href="xhwicap_8h.html#a8966aa32e3b990dc44e6cfcbdfbf2f2d">XHwIcap_LookupConfig()</a> API which returns the Configuration structure pointer which is passed as a parameter to the <a class="el" href="xhwicap_8c.html#a928bb0618a3f4bab3264eceb7b898d6d">XHwIcap_CfgInitialize()</a> API.</p>
|
|
<p><b> Interrupts </b></p>
|
|
<p>The driver provides an interrupt handler XHwIcap_IntrHandler for handling the interrupt from the HWICAP device. The users of this driver have to register this handler with the interrupt system and provide the callback functions. The callback functions are invoked by the interrupt handler based on the interrupt source.</p>
|
|
<p>The driver supports interrupt mode only for writing to the ICAP device and is NOT supported for reading from the ICAP device.</p>
|
|
<p><b> Virtual Memory </b></p>
|
|
<p>This driver supports Virtual Memory. The RTOS is responsible for calculating the correct device base address in Virtual Memory space.</p>
|
|
<p><b> Threads </b></p>
|
|
<p>This driver is not thread safe. Any needs for threads or thread mutual exclusion must be satisfied by the layer above this driver.</p>
|
|
<p><b> Asserts </b></p>
|
|
<p>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.</p>
|
|
<p><b> Building the driver </b></p>
|
|
<p>The <a class="el" href="struct_x_hw_icap.html">XHwIcap</a> driver is composed of several source files. This allows the user to build and link only those parts of the driver that are necessary.</p>
|
|
<dl class="note"><dt><b>Note:</b></dt><dd></dd></dl>
|
|
<p>There are a few items to be aware of when using this driver: 1) Only Virtex4, Virtex5, Virtex6, Spartan6, 7 series and Zynq devices are supported. 2) The ICAP port is disabled when the configuration mode, via the MODE pins, is set to Boundary Scan/JTAG. The ICAP is enabled in all other configuration modes and it is possible to configure the device via JTAG in all configuration modes. 3) Reading or writing to columns containing SRL16's or LUT RAM's can cause corruption of data in those elements. Avoid reading or writing to columns containing SRL16's or LUT RAM's. 4) Only the LUT and SRL are accesible, all other features of the slice are not available through this interface. 5) The Spartan6 devices access is 16-bit access and is 32 bit for all other devices. 6) In a Zynq device the ICAP needs to be selected using the XDcfg_SelectIcapInterface API of the DevCfg driver (clear the PCAP_PR bit of Control register in the Device Config Interface) before it can be accessed using the HwIcap.</p>
|
|
<pre>
|
|
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
|
|
----- ---- -------- -------------------------------------------------------
|
|
1.00a bjb 11/17/03 First release
|
|
1.01a bjb 04/10/06 V4 Support
|
|
2.00a sv 09/28/07 First release for the FIFO mode
|
|
2.01a ecm 04/08/08 Updated data structures to include the V5FXT parts.
|
|
3.00a sv 11/28/08 Added the API for initiating Abort while reading/writing
|
|
from the ICAP.
|
|
3.01a sv 10/21/09 Corrected the IDCODE definitions for some of the
|
|
V5 FX parts in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a>. Corrected the V5 BOOTSTS and
|
|
CTL_1 Register definitions in <a class="el" href="xhwicap__i_8h.html">xhwicap_i.h</a> file as they
|
|
were wrongly defined.
|
|
4.00a hvm 12/1/09 Added support for V6 and updated with HAL phase 1
|
|
modifications
|
|
5.00a hvm 04/02/10 Added S6 device support
|
|
5.01a hvm 07/06/10 In XHwIcap_DeviceRead function, a read bit mask
|
|
verification is added after all the data bytes are read
|
|
from READ FIFO.The Verification of the read bit mask
|
|
at the begining of reading of bytes is removed.
|
|
Removed the code that adds wrong data byte before the
|
|
CRC bytes in the XHwIcap_DeviceWriteFrame function for S6
|
|
(CR560534).
|
|
5.02a hvm 10/06/10 Updated to support AXI HWICAP
|
|
5.03a hvm 15/4/11 Updated with V6 CXT device definitions.</pre><pre> 6.00a hvm 08/01/11 Added support for K7 devices.
|
|
7.00a bss 03/14/12 Added support for 8/16/32 ICAP Data Widths - CR 620085
|
|
Added support for Lite Mode(no Write FIFO) - CR 601748
|
|
Added Virtex7,Artix7 and Zynq Idcodes-CR647140,CR643295
|
|
ReadId API is added to desync after lock up during
|
|
configuration CR 637538
|
|
8.00a bss 06/20/12 Deleted ReadId API in <a class="el" href="xhwicap__srp_8c.html">xhwicap_srp.c</a> and Hang mask
|
|
definition in <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a> as per CR 656162
|
|
8.01a bss 04/18/13 Updated <a class="el" href="xhwicap_8c.html">xhwicap.c</a> to fix compiler warnings. CR#704814
|
|
Added the define XHI_COR_1 for CR718042
|
|
9.0 adk 19/12/13 Updated as per the New Tcl API's
|
|
9.0 bss 02/20/14 Modified <a class="el" href="xhwicap_8c.html">xhwicap.c</a>, <a class="el" href="xhwicap__l_8h.html">xhwicap_l.h</a>, <a class="el" href="xhwicap__i_8h.html">xhwicap_i.h</a> and tcl
|
|
to support Kintex8, kintexu and virtex72000T family
|
|
devices.
|
|
10.0 bss 6/24/14 Removed support for families older than 7 series.
|
|
Modified driver tcl not to generate family.h.
|
|
Removed IDCODE lookup logic in XHwIcap_CfgInitialize
|
|
in <a class="el" href="xhwicap_8c.html">xhwicap.c</a>.
|
|
Removed IDCODE macros from <a class="el" href="xhwicap__i_8h.html">xhwicap_i.h</a>.
|
|
Removed xhwicap_ff.h and xhwicap_lut.h examples.
|
|
Removed <a class="el" href="xhwicap__clb__ff_8h.html">xhwicap_clb_ff.h</a>, <a class="el" href="xhwicap__clb__lut_8h.html">xhwicap_clb_lut.h</a> and
|
|
<a class="el" href="xhwicap__clb__srinv_8h.html">xhwicap_clb_srinv.h</a> files from driver.
|
|
10.0 bss 7/10/14 Fix compilation failure for designs other than 32 bit
|
|
data width of HWICAP in <a class="el" href="xhwicap_8c.html">xhwicap.c</a>.</pre><pre> </pre> </div>
|
|
<p class="Copyright">
|
|
Copyright © 1995-2014 Xilinx, Inc. All rights reserved.
|
|
</p>
|
|
</body>
|
|
</html>
|