stv0g/embeddedsw
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity
embeddedsw/lib/sw_services/xilisf/doc/html/api/xilisf_8c.html
Jagannadha Sutradharudu Teki 2c8f92039d embeddesw: Add initial code support 
Added initial support Xilinx Embedded Software.

Signed-off-by: Jagannadha Sutradharudu Teki <jaganna@xilinx.com>
2014-06-24 16:45:01 +05:30

388 lines
20 KiB
HTML
Executable file
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>2014.1_doc: xilisf.c File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.5 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main&nbsp;Page</span></a></li>
<li><a href="annotated.html"><span>Data&nbsp;Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File&nbsp;List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<h1>xilisf.c File Reference</h1><code>#include &quot;<a class="el" href="xilisf_8h.html">include/xilisf.h</a>&quot;</code><br>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#a49172a16258a144cb357139b3c5ec9f">XIsf_Initialize</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, XIsf_Iface *SpiInstPtr, u8 SlaveSelect, u8 *WritePtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#25b8b893226596531c19fe40f1a29cc7">XIsf_SetSpiConfiguration</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, XIsf_Iface *SpiInstPtr, u32 Options, u8 PreScaler)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#19cd8d1a3f3e3e806158e97eb4e38502">XIsf_GetStatus</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, u8 *ReadPtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#6f13ecf8a086def8aa00b670e8ba4ea2">XIsf_GetDeviceInfo</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, u8 *ReadPtr)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#ce8dd0bdcd65aa50b52fd1d61a1fb5f3">XIsf_WriteEnable</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, u8 WriteEnable)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="xilisf_8c.html#c32cffd6e6f79a5ac7272c07a44dbe6e">XIsf_Ioctl</a> (<a class="el" href="struct_x_isf.html">XIsf</a> *InstancePtr, <a class="el" href="xilisf_8h.html#7ac002cffd0bf0af01a2755fa362f8da">XIsf_IoctlOperation</a> Operation)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This file contains the library functions to initialize, control and read the device information of the Serial Flash devices. Refer <a class="el" href="xilisf_8h.html">xilisf.h</a> for detailed description.<p>
<pre></pre><p>
<pre> MODIFICATION HISTORY:</pre><p>
<pre> Ver Who Date Changes
----- ------- -------- -----------------------------------------------
1.00a ksu/sdm 03/03/08 First release
1.00a sdm 07/02/08 Changed the initialization so that the SPI
Master works in Spi Mode 3 as the In-System Flash
works only in Spi Mode 3
2.00a ktn 11/27/09 Updated to use HAL processor APIs/definitions
2.01a sdm 01/04/10 Added Support for Winbond W25QXX/W25XX devices
The parameter PagesPerBlock in the struct
IntelStmDeviceGeometry has been renamed to
PagesPerSector.
2.03a sdm 04/17/10 Updated to support Winbond memory W25Q128.
2.04a sdm 08/17/10 Updated to support Numonyx (N25QXX) and Spansion
flash memories
3.00a srt 06/20/12 Updated to support interfaces SPI PS and QSPI PS.
New API:
XIsf_RegisterInterface()
<a class="el" href="xilisf_8h.html#25b8b893226596531c19fe40f1a29cc7">XIsf_SetSpiConfiguration()</a>
XIsf_SetTransferMode()
Changed API:
<a class="el" href="xilisf_8h.html#a49172a16258a144cb357139b3c5ec9f">XIsf_Initialize()</a>
XIsf_Transfer()
Added support to SST flash.
3.01a srt 02/06/13 Updated for changes made in QSPIPS driver (CR 698107).</pre><p>
<pre> </pre> <hr><h2>Function Documentation</h2>
<a class="anchor" name="6f13ecf8a086def8aa00b670e8ba4ea2"></a><!-- doxytag: member="xilisf.c::XIsf_GetDeviceInfo" ref="6f13ecf8a086def8aa00b670e8ba4ea2" args="(XIsf *InstancePtr, u8 *ReadPtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_GetDeviceInfo </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8 *&nbsp;</td>
<td class="mdname" nowrap> <em>ReadPtr</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This API reads the Joint Electron Device Engineering Council (JEDEC) information of the Serial Flash.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ReadPtr</em>&nbsp;</td><td>is a pointer to the buffer where the Device information is copied.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The Device information is stored at the second byte pointed by the ReadPtr. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="19cd8d1a3f3e3e806158e97eb4e38502"></a><!-- doxytag: member="xilisf.c::XIsf_GetStatus" ref="19cd8d1a3f3e3e806158e97eb4e38502" args="(XIsf *InstancePtr, u8 *ReadPtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_GetStatus </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8 *&nbsp;</td>
<td class="mdname" nowrap> <em>ReadPtr</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This API reads the Serial Flash Status Register.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>ReadPtr</em>&nbsp;</td><td>is a pointer to the memory where the Status Register content is copied.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>The contents of the Status Register is stored at the second byte pointed by the ReadPtr. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="a49172a16258a144cb357139b3c5ec9f"></a><!-- doxytag: member="xilisf.c::XIsf_Initialize" ref="a49172a16258a144cb357139b3c5ec9f" args="(XIsf *InstancePtr, XIsf_Iface *SpiInstPtr, u8 SlaveSelect, u8 *WritePtr)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_Initialize </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XIsf_Iface *&nbsp;</td>
<td class="mdname" nowrap> <em>SpiInstPtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8&nbsp;</td>
<td class="mdname" nowrap> <em>SlaveSelect</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8 *&nbsp;</td>
<td class="mdname" nowrap> <em>WritePtr</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
The geometry of the underlying Serial Flash is determined by reading the Joint Electron Device Engineering Council (JEDEC) Device Information and the Status Register of the Serial Flash. This API when called initializes the SPI interface with default settings. With custom settings, user should call <a class="el" href="xilisf_8h.html#25b8b893226596531c19fe40f1a29cc7">XIsf_SetSpiConfiguration()</a> and then call this API.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SpiInstPtr</em>&nbsp;</td><td>is a pointer to the XIsf_Iface instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SlaveSelect</em>&nbsp;</td><td>is a 32-bit mask with a 1 in the bit position of the slave being selected. Only one slave can be selected at a time. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>WritePtr</em>&nbsp;</td><td>is a pointer to the buffer allocated by the user to be used by the In-system and Serial Flash Library to perform any read/write operations on the Serial Flash device. User applications must pass the address of this buffer for the Library to work.<ul>
<li>Write operations :<ul>
<li>The size of this buffer should be equal to the Number of bytes to be written to the Serial Flash + XISF_CMD_MAX_EXTRA_BYTES.</li><li>The size of this buffer should be large enough for usage across all the applications that use a common instance of the Serial Flash.</li><li>A minimum of one byte and a maximum of ISF_PAGE_SIZE bytes can be written to the Serial Flash, through a single Write operation.</li></ul>
</li><li>Read operations :<ul>
<li>The size of this buffer should be equal to XISF_CMD_MAX_EXTRA_BYTES, if the application only reads from the Serial Flash (no write operations).</li></ul>
</li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>- XST_SUCCESS if successful.<ul>
<li>XST_DEVICE_IS_STOPPED if the device must be started before transferring data.</li><li>XST_FAILURE, otherwise.</li></ul>
</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>- The <a class="el" href="xilisf_8h.html#a49172a16258a144cb357139b3c5ec9f">XIsf_Initialize()</a> API is a blocking call (for both polled and interrupt modes of the Spi driver). It reads the JEDEC information of the device and waits till the transfer is complete before checking if the information is valid.<ul>
<li>This library can support multiple instances of Serial Flash at a time, provided they are of the same device family (either Atmel, Intel or STM, Winbond or Spansion) as the device family is selected at compile time. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="c32cffd6e6f79a5ac7272c07a44dbe6e"></a><!-- doxytag: member="xilisf.c::XIsf_Ioctl" ref="c32cffd6e6f79a5ac7272c07a44dbe6e" args="(XIsf *InstancePtr, XIsf_IoctlOperation Operation)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_Ioctl </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap><a class="el" href="xilisf_8h.html#7ac002cffd0bf0af01a2755fa362f8da">XIsf_IoctlOperation</a>&nbsp;</td>
<td class="mdname" nowrap> <em>Operation</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This API configures and controls the Intel, STM, Winbond and Spansion Serial Flash.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Operation</em>&nbsp;</td><td>is the type of Control operation to be performed on the Serial Flash. The different control operations are<ul>
<li>XISF_RELEASE_DPD: Release from Deep Power Down (DPD) Mode</li><li>XISF_ENTER_DPD: Enter DPD Mode</li><li>XISF_CLEAR_SR_FAIL_FLAGS: Clear the Status Register Fail Flags</li></ul>
</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd><ul>
<li>Atmel Serial Flash does not support any of these operations.</li><li>Intel Serial Flash support Enter/Release from DPD Mode and Clear Status Register Fail Flags.</li><li>STM, Winbond and Spansion Serial Flash support Enter/Release from DPD Mode.</li><li>Winbond (W25QXX) Serial Flash support Enable High Performance mode. </li></ul>
</dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="25b8b893226596531c19fe40f1a29cc7"></a><!-- doxytag: member="xilisf.c::XIsf_SetSpiConfiguration" ref="25b8b893226596531c19fe40f1a29cc7" args="(XIsf *InstancePtr, XIsf_Iface *SpiInstPtr, u32 Options, u8 PreScaler)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_SetSpiConfiguration </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>XIsf_Iface *&nbsp;</td>
<td class="mdname" nowrap> <em>SpiInstPtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u32&nbsp;</td>
<td class="mdname" nowrap> <em>Options</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8&nbsp;</td>
<td class="mdname" nowrap> <em>PreScaler</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This API sets the configuration of SPI. This will set the options and clock prescaler (if applicable).<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>SpiInstPtr</em>&nbsp;</td><td>is a pointer to the XIsf_Iface instance to be worked on. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>Options</em>&nbsp;</td><td>contains specified options to be set. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>PreScaler</em>&nbsp;</td><td>is the value of the clock prescaler to set.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This API can be called before calling <a class="el" href="xilisf_8h.html#a49172a16258a144cb357139b3c5ec9f">XIsf_Initialize()</a> to initialize the SPI interface in other than default options mode. PreScaler is only applicable to PS SPI/QSPI. </dd></dl>
</td>
</tr>
</table>
<a class="anchor" name="ce8dd0bdcd65aa50b52fd1d61a1fb5f3"></a><!-- doxytag: member="xilisf.c::XIsf_WriteEnable" ref="ce8dd0bdcd65aa50b52fd1d61a1fb5f3" args="(XIsf *InstancePtr, u8 WriteEnable)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td class="md" nowrap valign="top">int XIsf_WriteEnable </td>
<td class="md" valign="top">(&nbsp;</td>
<td class="md" nowrap valign="top"><a class="el" href="struct_x_isf.html">XIsf</a> *&nbsp;</td>
<td class="mdname" nowrap> <em>InstancePtr</em>, </td>
</tr>
<tr>
<td class="md" nowrap align="right"></td>
<td class="md"></td>
<td class="md" nowrap>u8&nbsp;</td>
<td class="mdname" nowrap> <em>WriteEnable</em></td>
</tr>
<tr>
<td class="md"></td>
<td class="md">)&nbsp;</td>
<td class="md" colspan="2"></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
<tr>
<td>
&nbsp;
</td>
<td>
<p>
This API Enables/Disables writes to the Intel, STM, Winbond and Spansion Serial Flash.<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>InstancePtr</em>&nbsp;</td><td>is a pointer to the <a class="el" href="struct_x_isf.html">XIsf</a> instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>WriteEnable</em>&nbsp;</td><td>specifies whether to Enable (XISF_CMD_ENABLE_WRITE) or Disable (XISF_CMD_DISABLE_WRITE) the writes to the Serial Flash.</td></tr>
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>XST_SUCCESS if successful else XST_FAILURE.</dd></dl>
<dl compact><dt><b>Note:</b></dt><dd>This API works only for Intel, STM, Winbond and Spansion Serial Flash. If this API is called for Atmel Flash, XST_FAILURE is returned. </dd></dl>
</td>
</tr>
</table>
<hr size="1"><address style="align: right;"><small>Generated on Thu Feb 13 14:38:18 2014 for 2014.1_doc by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.5 </small></address>
</body>
</html>
Reference in a new issue View git blame Copy permalink