embeddedsw/XilinxProcessorIPLib/drivers/gpiops/doc/html/api/index.html

61 lines
3 KiB
HTML
Raw Normal View History

<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>
Xilinx Driver gpiops v2_1: gpiops v2_1
</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&nbsp;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>gpiops v2_1</h1><p>The Xilinx PS GPIO driver. This driver supports the Xilinx PS GPIO Controller.</p>
<p>The GPIO Controller supports the following features:</p>
<ul>
<li>4 banks</li>
<li>Masked writes (There are no masked reads)</li>
<li>Bypass mode</li>
<li>Configurable Interrupts (Level/Edge)</li>
</ul>
<p>This driver is intended to be RTOS and processor independent. Any needs for dynamic memory management, threads or thread mutual exclusion, virtual memory, or cache control must be satisfied by the layer above this driver.</p>
<p>This driver supports all the features listed above, if applicable.</p>
<p><b>Driver Description</b></p>
<p>The device driver enables higher layer software (e.g., an application) to communicate to the GPIO.</p>
<p><b>Interrupts</b></p>
<p>The driver provides interrupt management functions and an interrupt handler. Users of this driver need to provide callback functions. An interrupt handler example is available with the driver.</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_gpio_ps.html">XGpioPs</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. <br/>
<br/>
</p>
<pre>
MODIFICATION HISTORY:</pre><pre> Ver Who Date Changes
----- ---- -------- -----------------------------------------------
1.00a sv 01/15/10 First Release
1.01a sv 04/15/12 Removed the APIs XGpioPs_SetMode, XGpioPs_SetModePin
XGpioPs_GetMode, XGpioPs_GetModePin as they are not
relevant to Zynq device.The interrupts are disabled
for output pins on all banks during initialization.
1.02a hk 08/22/13 Added low level reset API
2.1 hk 04/29/14 Use Input data register DATA_RO for read. CR# 771667.</pre><pre> </pre> </div>
<p class="Copyright">
Copyright &copy; 1995-2014 Xilinx, Inc. All rights reserved.
</p>
</body>
</html>