151 lines
19 KiB
HTML
Executable file
151 lines
19 KiB
HTML
Executable file
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
|
<meta name="generator" content="Doxygen 1.8.10"/>
|
|
<title>spips: xspips.h File Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr style="height: 56px;">
|
|
<td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">spips
|
|
</div>
|
|
<div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.10 -->
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Overview</span></a></li>
|
|
<li><a href="annotated.html"><span>Data Structures</span></a></li>
|
|
<li><a href="globals.html"><span>APIs</span></a></li>
|
|
<li><a href="files.html"><span>File List</span></a></li>
|
|
</ul>
|
|
</div>
|
|
<div id="nav-path" class="navpath">
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="dir_14bc92f4b96c8519b376567118ac28b3.html">drivers</a></li><li class="navelem"><a class="el" href="dir_0a3a8085a3eb9b8a9bb467cf32fc7b90.html">spips</a></li><li class="navelem"><a class="el" href="dir_f68a8c076ea823df190a865abfe54864.html">src</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#nested-classes">Data Structures</a> |
|
|
<a href="#define-members">Macros</a> |
|
|
<a href="#typedef-members">Typedefs</a> |
|
|
<a href="#func-members">Functions</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">xspips.h File Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
|
|
Data Structures</h2></td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps___config.html">XSpiPs_Config</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_spi_ps.html">XSpiPs</a></td></tr>
|
|
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
|
|
Macros</h2></td></tr>
|
|
<tr class="memitem:gac782d76352000f7cab838491744a022a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gac782d76352000f7cab838491744a022a">XSpiPs_SetSlaveIdle</a>(InstancePtr, RegisterValue)</td></tr>
|
|
<tr class="separator:gac782d76352000f7cab838491744a022a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8f2055cfa93a26da233dff2fa8b0af8b"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga8f2055cfa93a26da233dff2fa8b0af8b">XSpiPs_GetSlaveIdle</a>(InstancePtr)</td></tr>
|
|
<tr class="separator:ga8f2055cfa93a26da233dff2fa8b0af8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga5501c2b3144a42ec20d93bcaa4732797"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga5501c2b3144a42ec20d93bcaa4732797">XSpiPs_SetTXWatermark</a>(InstancePtr, RegisterValue)</td></tr>
|
|
<tr class="separator:ga5501c2b3144a42ec20d93bcaa4732797"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae768acaf29460ddf625c0842a6546991"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gae768acaf29460ddf625c0842a6546991">XSpiPs_GetTXWatermark</a>(InstancePtr)   XSpiPs_In32(((InstancePtr)->Config.BaseAddress) + <a class="el" href="group__spips__v3__0.html#ga82b0c7855556fbb3d13b1d0fc3f7ae24">XSPIPS_TXWR_OFFSET</a>)</td></tr>
|
|
<tr class="separator:gae768acaf29460ddf625c0842a6546991"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gabf7789f973a99a1192e89e6df23b8d84"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gabf7789f973a99a1192e89e6df23b8d84">XSpiPs_SetRXWatermark</a>(InstancePtr, RegisterValue)</td></tr>
|
|
<tr class="separator:gabf7789f973a99a1192e89e6df23b8d84"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga27fb8402703b83365149ff051bb7aee8"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga27fb8402703b83365149ff051bb7aee8">XSpiPs_GetRXWatermark</a>(InstancePtr)   XSpiPs_In32(((InstancePtr)->Config.BaseAddress) + <a class="el" href="group__spips__v3__0.html#ga708b416f4994dca83b3d50a464552286">XSPIPS_RXWR_OFFSET</a>)</td></tr>
|
|
<tr class="separator:ga27fb8402703b83365149ff051bb7aee8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga7b3a41972453b0dfb7ec90f3972ddc74"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga7b3a41972453b0dfb7ec90f3972ddc74">XSpiPs_Enable</a>(InstancePtr)</td></tr>
|
|
<tr class="separator:ga7b3a41972453b0dfb7ec90f3972ddc74"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gae33752db88677fe0580abb65d6ba70cf"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gae33752db88677fe0580abb65d6ba70cf">XSpiPs_Disable</a>(InstancePtr)   XSpiPs_Out32(((InstancePtr)->Config.BaseAddress) + <a class="el" href="group__spips__v3__0.html#ga96a2524f86a513015b982462f7a6ffcb">XSPIPS_ER_OFFSET</a>, 0U)</td></tr>
|
|
<tr class="separator:gae33752db88677fe0580abb65d6ba70cf"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Configuration options</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>The following options are supported to enable/disable certain features of an SPI device.</p>
|
|
<p>Each of the options is a bit mask, so more than one may be specified.</p>
|
|
<p><b>The Master option</b> configures the SPI device as a master. By default, the device is a slave.</p>
|
|
<p>The <b>Active Low Clock option</b> configures the device's clock polarity. Setting this option means the clock is active low and the SCK signal idles high. By default, the clock is active high and SCK idles low.</p>
|
|
<p>The <b>Clock Phase option</b> configures the SPI device for one of two transfer formats. A clock phase of 0, the default, means data is valid on the first SCK edge (rising or falling) after the slave select (SS) signal has been asserted. A clock phase of 1 means data is valid on the second SCK edge (rising or falling) after SS has been asserted.</p>
|
|
<p>The <b>Slave Select Decode Enable option</b> selects how the SPI_SS_outN are controlled by the SPI Slave Select Decode bits. 0: Use this setting for the standard configuration of up to three slave select outputs. Only one of the three slave select outputs will be low. (Default) 1: Use this setting for the optional configuration of an additional decoder to support 8 slave select outputs. SPI_SS_outN reflects the value in the register.</p>
|
|
<p>The <b>SPI Force Slave Select option</b> is used to enable manual control of the signals SPI_SS_outN. 0: The SPI_SS_outN signals are controlled by the SPI controller during transfers. (Default) 1: The SPI_SS_outN signal indicated by the Slave Select Control bit is forced active (driven low) regardless of any transfers in progress.</p>
|
|
<p>NOTE: The driver will handle setting and clearing the Slave Select when the user sets the "FORCE_SSELECT_OPTION". Using this option will allow the SPI clock to be set to a faster speed. If the SPI clock is too fast, the processor cannot empty and refill the FIFOs before the TX FIFO is empty When the SPI hardware is controlling the Slave Select signals, this will cause slave to be de-selected and terminate the transfer.</p>
|
|
<p>The <b>Manual Start option</b> is used to enable manual control of the Start command to perform data transfer. 0: The Start command is controlled by the SPI controller during transfers(Default). Data transmission starts as soon as there is data in the TXFIFO and stalls when the TXFIFO is empty 1: The Start command must be issued by software to perform data transfer. Bit 15 of Configuration register is used to issue Start command. This bit must be set whenever TXFIFO is filled with new data.</p>
|
|
<p>NOTE: The driver will set the Manual Start Enable bit in Configuration Register, if Manual Start option is selected. Software will issue Manual Start command whenever TXFIFO is filled with data. When there is no further data, driver will clear the Manual Start Enable bit. </p>
|
|
</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">SPI Clock Prescaler options</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>The SPI Clock Prescaler Configuration bits are used to program master mode bit rate.</p>
|
|
<p>The bit rate can be programmed in divide-by-two decrements from pclk/4 to pclk/256. </p>
|
|
</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupHeader">Callback events</div></td></tr>
|
|
<tr><td colspan="2"><div class="groupText"><p>These constants specify the handler events that are passed to a handler from the driver.</p>
|
|
<p>These constants are not bit masks such that only one will be passed at a time to the handler. </p>
|
|
</div></td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
|
|
Typedefs</h2></td></tr>
|
|
<tr class="memitem:gaec95e118eb971ab521b5a348a9861783"><td class="memItemLeft" align="right" valign="top">typedef void(* </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gaec95e118eb971ab521b5a348a9861783">XSpiPs_StatusHandler</a>) (void *CallBackRef, u32 StatusEvent, u32 ByteCount)</td></tr>
|
|
<tr class="separator:gaec95e118eb971ab521b5a348a9861783"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
|
Functions</h2></td></tr>
|
|
<tr class="memitem:ga70c86f3842f5996d9d7fc874466f4136"><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct_x_spi_ps___config.html">XSpiPs_Config</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga70c86f3842f5996d9d7fc874466f4136">XSpiPs_LookupConfig</a> (u16 DeviceId)</td></tr>
|
|
<tr class="separator:ga70c86f3842f5996d9d7fc874466f4136"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga66fc6e7b4ec94e279b89cc0eab2debf2"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga66fc6e7b4ec94e279b89cc0eab2debf2">XSpiPs_CfgInitialize</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, <a class="el" href="struct_x_spi_ps___config.html">XSpiPs_Config</a> *ConfigPtr, u32 EffectiveAddr)</td></tr>
|
|
<tr class="separator:ga66fc6e7b4ec94e279b89cc0eab2debf2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad3abd2456cfa67bc8d24dd255ba7de51"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gad3abd2456cfa67bc8d24dd255ba7de51">XSpiPs_Reset</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:gad3abd2456cfa67bc8d24dd255ba7de51"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga747939dd62eb9c82ed185611e95211c7"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga747939dd62eb9c82ed185611e95211c7">XSpiPs_Transfer</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 *SendBufPtr, u8 *RecvBufPtr, u32 ByteCount)</td></tr>
|
|
<tr class="separator:ga747939dd62eb9c82ed185611e95211c7"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga94490f99431c92c2a9a54cc41d4abe71"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga94490f99431c92c2a9a54cc41d4abe71">XSpiPs_PolledTransfer</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 *SendBufPtr, u8 *RecvBufPtr, u32 ByteCount)</td></tr>
|
|
<tr class="separator:ga94490f99431c92c2a9a54cc41d4abe71"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gacafc99130a16e99abb3d86e682f1de09"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gacafc99130a16e99abb3d86e682f1de09">XSpiPs_SetStatusHandler</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, void *CallBackRef, <a class="el" href="group__spips__v3__0.html#gaec95e118eb971ab521b5a348a9861783">XSpiPs_StatusHandler</a> FunctionPtr)</td></tr>
|
|
<tr class="separator:gacafc99130a16e99abb3d86e682f1de09"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gac57ccd3fab9a25399bdb8bc234fecc66"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gac57ccd3fab9a25399bdb8bc234fecc66">XSpiPs_InterruptHandler</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:gac57ccd3fab9a25399bdb8bc234fecc66"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1f40732e67f63579b811af115f2c575c"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga1f40732e67f63579b811af115f2c575c">XSpiPs_Abort</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga1f40732e67f63579b811af115f2c575c"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga1ef5af2211095df5692567fa4721a8d5"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga1ef5af2211095df5692567fa4721a8d5">XSpiPs_SetSlaveSelect</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 SlaveSel)</td></tr>
|
|
<tr class="separator:ga1ef5af2211095df5692567fa4721a8d5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga4efc98fb1e6b9a927146bd3bcab8ea8b"><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga4efc98fb1e6b9a927146bd3bcab8ea8b">XSpiPs_GetSlaveSelect</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga4efc98fb1e6b9a927146bd3bcab8ea8b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gaaa797b9b8184e6f39b0c0038553e48d8"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gaaa797b9b8184e6f39b0c0038553e48d8">XSpiPs_SelfTest</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:gaaa797b9b8184e6f39b0c0038553e48d8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gad1b67fe9b7737a1af8067d6d69e1508b"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gad1b67fe9b7737a1af8067d6d69e1508b">XSpiPs_SetOptions</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u32 Options)</td></tr>
|
|
<tr class="separator:gad1b67fe9b7737a1af8067d6d69e1508b"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga842e4cf2fabf1849f451d9592d0b2722"><td class="memItemLeft" align="right" valign="top">u32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga842e4cf2fabf1849f451d9592d0b2722">XSpiPs_GetOptions</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:ga842e4cf2fabf1849f451d9592d0b2722"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga8359f8188f7bf36a0688963aff561692"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga8359f8188f7bf36a0688963aff561692">XSpiPs_SetClkPrescaler</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 Prescaler)</td></tr>
|
|
<tr class="separator:ga8359f8188f7bf36a0688963aff561692"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gab8f7c1eb75848839d7dc4fa81bc273e4"><td class="memItemLeft" align="right" valign="top">u8 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gab8f7c1eb75848839d7dc4fa81bc273e4">XSpiPs_GetClkPrescaler</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr)</td></tr>
|
|
<tr class="separator:gab8f7c1eb75848839d7dc4fa81bc273e4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:gafe7ecd11569d8cf376ebc8f982503c52"><td class="memItemLeft" align="right" valign="top">s32 </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#gafe7ecd11569d8cf376ebc8f982503c52">XSpiPs_SetDelays</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 DelayNss, u8 DelayBtwn, u8 DelayAfter, u8 DelayInit)</td></tr>
|
|
<tr class="separator:gafe7ecd11569d8cf376ebc8f982503c52"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ga716d3d27606e693e765a2b9d01cce462"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="group__spips__v3__0.html#ga716d3d27606e693e765a2b9d01cce462">XSpiPs_GetDelays</a> (<a class="el" href="struct_x_spi_ps.html">XSpiPs</a> *InstancePtr, u8 *DelayNss, u8 *DelayBtwn, u8 *DelayAfter, u8 *DelayInit)</td></tr>
|
|
<tr class="separator:ga716d3d27606e693e765a2b9d01cce462"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
</div><!-- contents -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="footer">Copyright © 2015 Xilinx Inc. All rights reserved.</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|