-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
114 changed files
with
24,188 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,255 @@ | ||
| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" lang="en-US"> | ||
| <head> | ||
| <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> | ||
| <meta http-equiv="X-UA-Compatible" content="IE=11"/> | ||
| <meta name="generator" content="Doxygen 1.9.6"/> | ||
| <meta name="viewport" content="width=device-width, initial-scale=1"/> | ||
| <title>EF_SPI APIs: EF_Driver_Common.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="search/search.css" rel="stylesheet" type="text/css"/> | ||
| <script type="text/javascript" src="search/searchdata.js"></script> | ||
| <script type="text/javascript" src="search/search.js"></script> | ||
| <link href="doxygen.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 id="projectrow"> | ||
| <td id="projectalign"> | ||
| <div id="projectname">EF_SPI APIs | ||
| </div> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> | ||
| </div> | ||
| <!-- end header part --> | ||
| <!-- Generated by Doxygen 1.9.6 --> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| var searchBox = new SearchBox("searchBox", "search/",'.html'); | ||
| /* @license-end */ | ||
| </script> | ||
| <script type="text/javascript" src="menudata.js"></script> | ||
| <script type="text/javascript" src="menu.js"></script> | ||
| <script type="text/javascript"> | ||
| /* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */ | ||
| $(function() { | ||
| initMenu('',true,false,'search.php','Search'); | ||
| $(document).ready(function() { init_search(); }); | ||
| }); | ||
| /* @license-end */ | ||
| </script> | ||
| <div id="main-nav"></div> | ||
| <!-- window showing the filter options --> | ||
| <div id="MSearchSelectWindow" | ||
| onmouseover="return searchBox.OnSearchSelectShow()" | ||
| onmouseout="return searchBox.OnSearchSelectHide()" | ||
| onkeydown="return searchBox.OnSearchSelectKey(event)"> | ||
| </div> | ||
|
|
||
| <!-- iframe showing the search results (closed by default) --> | ||
| <div id="MSearchResultsWindow"> | ||
| <div id="MSearchResults"> | ||
| <div class="SRPage"> | ||
| <div id="SRIndex"> | ||
| <div id="SRResults"></div> | ||
| <div class="SRStatus" id="Loading">Loading...</div> | ||
| <div class="SRStatus" id="Searching">Searching...</div> | ||
| <div class="SRStatus" id="NoMatches">No Matches</div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| </div> | ||
|
|
||
| </div><!-- top --> | ||
| <div class="header"> | ||
| <div class="summary"> | ||
| <a href="#define-members">Macros</a> | | ||
| <a href="#typedef-members">Typedefs</a> </div> | ||
| <div class="headertitle"><div class="title">EF_Driver_Common.h File Reference</div></div> | ||
| </div><!--header--> | ||
| <div class="contents"> | ||
|
|
||
| <p>C header file for common driver definitions and types. | ||
| <a href="#details">More...</a></p> | ||
| <div class="textblock"><code>#include <stdint.h></code><br /> | ||
| <code>#include <stdbool.h></code><br /> | ||
| <code>#include <stddef.h></code><br /> | ||
| </div> | ||
| <p><a href="_e_f___driver___common_8h_source.html">Go to the source code of this file.</a></p> | ||
| <table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="define-members" name="define-members"></a> | ||
| Macros</h2></td></tr> | ||
| <tr class="memitem:ab56c746d5d1672835c101f00f7c90b7c"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#ab56c746d5d1672835c101f00f7c90b7c">EF_DRIVER_OK</a>   ((uint32_t)0)</td></tr> | ||
| <tr class="memdesc:ab56c746d5d1672835c101f00f7c90b7c"><td class="mdescLeft"> </td><td class="mdescRight">Operation succeeded. <br /></td></tr> | ||
| <tr class="separator:ab56c746d5d1672835c101f00f7c90b7c"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:adf96107766b856292d4f08a495064c7e"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#adf96107766b856292d4f08a495064c7e">EF_DRIVER_ERROR</a>   ((uint32_t)1)</td></tr> | ||
| <tr class="memdesc:adf96107766b856292d4f08a495064c7e"><td class="mdescLeft"> </td><td class="mdescRight">Unspecified error. <br /></td></tr> | ||
| <tr class="separator:adf96107766b856292d4f08a495064c7e"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a9b7e06e07ac1038e9cc63d5f25d681fb"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#a9b7e06e07ac1038e9cc63d5f25d681fb">EF_DRIVER_ERROR_BUSY</a>   ((uint32_t)2)</td></tr> | ||
| <tr class="memdesc:a9b7e06e07ac1038e9cc63d5f25d681fb"><td class="mdescLeft"> </td><td class="mdescRight">Driver is busy. <br /></td></tr> | ||
| <tr class="separator:a9b7e06e07ac1038e9cc63d5f25d681fb"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a26b87ad6f8f1d017af3ee034bd178795"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#a26b87ad6f8f1d017af3ee034bd178795">EF_DRIVER_ERROR_TIMEOUT</a>   ((uint32_t)3)</td></tr> | ||
| <tr class="memdesc:a26b87ad6f8f1d017af3ee034bd178795"><td class="mdescLeft"> </td><td class="mdescRight">Timeout occurred. <br /></td></tr> | ||
| <tr class="separator:a26b87ad6f8f1d017af3ee034bd178795"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:abd8e6eb4870238ef0f900911e3935d91"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#abd8e6eb4870238ef0f900911e3935d91">EF_DRIVER_ERROR_UNSUPPORTED</a>   ((uint32_t)4)</td></tr> | ||
| <tr class="memdesc:abd8e6eb4870238ef0f900911e3935d91"><td class="mdescLeft"> </td><td class="mdescRight">Operation not supported. <br /></td></tr> | ||
| <tr class="separator:abd8e6eb4870238ef0f900911e3935d91"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:aed4f0552faa082d7941ed37ae1e430e4"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#aed4f0552faa082d7941ed37ae1e430e4">EF_DRIVER_ERROR_PARAMETER</a>   ((uint32_t)5)</td></tr> | ||
| <tr class="memdesc:aed4f0552faa082d7941ed37ae1e430e4"><td class="mdescLeft"> </td><td class="mdescRight">Parameter error. <br /></td></tr> | ||
| <tr class="separator:aed4f0552faa082d7941ed37ae1e430e4"><td class="memSeparator" colspan="2"> </td></tr> | ||
| <tr class="memitem:a89de2e78c0ce8d5b48c0cef064ae3aab"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#a89de2e78c0ce8d5b48c0cef064ae3aab">EF_DRIVER_ERROR_SPECIFIC</a>   ((uint32_t)6)</td></tr> | ||
| <tr class="memdesc:a89de2e78c0ce8d5b48c0cef064ae3aab"><td class="mdescLeft"> </td><td class="mdescRight">Start of driver specific errors. <br /></td></tr> | ||
| <tr class="separator:a89de2e78c0ce8d5b48c0cef064ae3aab"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table><table class="memberdecls"> | ||
| <tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a> | ||
| Typedefs</h2></td></tr> | ||
| <tr class="memitem:ad1c99136d1edfd0a7757f5b81600a351"><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a></td></tr> | ||
| <tr class="memdesc:ad1c99136d1edfd0a7757f5b81600a351"><td class="mdescLeft"> </td><td class="mdescRight">A type that is used to return the status of the driver functions. <br /></td></tr> | ||
| <tr class="separator:ad1c99136d1edfd0a7757f5b81600a351"><td class="memSeparator" colspan="2"> </td></tr> | ||
| </table> | ||
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> | ||
| <div class="textblock"><p>C header file for common driver definitions and types. </p> | ||
| </div><h2 class="groupheader">Macro Definition Documentation</h2> | ||
| <a id="adf96107766b856292d4f08a495064c7e" name="adf96107766b856292d4f08a495064c7e"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#adf96107766b856292d4f08a495064c7e">◆ </a></span>EF_DRIVER_ERROR</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR   ((uint32_t)1)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Unspecified error. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="a9b7e06e07ac1038e9cc63d5f25d681fb" name="a9b7e06e07ac1038e9cc63d5f25d681fb"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#a9b7e06e07ac1038e9cc63d5f25d681fb">◆ </a></span>EF_DRIVER_ERROR_BUSY</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR_BUSY   ((uint32_t)2)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Driver is busy. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="aed4f0552faa082d7941ed37ae1e430e4" name="aed4f0552faa082d7941ed37ae1e430e4"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#aed4f0552faa082d7941ed37ae1e430e4">◆ </a></span>EF_DRIVER_ERROR_PARAMETER</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR_PARAMETER   ((uint32_t)5)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Parameter error. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="a89de2e78c0ce8d5b48c0cef064ae3aab" name="a89de2e78c0ce8d5b48c0cef064ae3aab"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#a89de2e78c0ce8d5b48c0cef064ae3aab">◆ </a></span>EF_DRIVER_ERROR_SPECIFIC</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR_SPECIFIC   ((uint32_t)6)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Start of driver specific errors. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="a26b87ad6f8f1d017af3ee034bd178795" name="a26b87ad6f8f1d017af3ee034bd178795"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#a26b87ad6f8f1d017af3ee034bd178795">◆ </a></span>EF_DRIVER_ERROR_TIMEOUT</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR_TIMEOUT   ((uint32_t)3)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Timeout occurred. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="abd8e6eb4870238ef0f900911e3935d91" name="abd8e6eb4870238ef0f900911e3935d91"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#abd8e6eb4870238ef0f900911e3935d91">◆ </a></span>EF_DRIVER_ERROR_UNSUPPORTED</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_ERROR_UNSUPPORTED   ((uint32_t)4)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Operation not supported. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <a id="ab56c746d5d1672835c101f00f7c90b7c" name="ab56c746d5d1672835c101f00f7c90b7c"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#ab56c746d5d1672835c101f00f7c90b7c">◆ </a></span>EF_DRIVER_OK</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">#define EF_DRIVER_OK   ((uint32_t)0)</td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>Operation succeeded. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| <h2 class="groupheader">Typedef Documentation</h2> | ||
| <a id="ad1c99136d1edfd0a7757f5b81600a351" name="ad1c99136d1edfd0a7757f5b81600a351"></a> | ||
| <h2 class="memtitle"><span class="permalink"><a href="#ad1c99136d1edfd0a7757f5b81600a351">◆ </a></span>EF_DRIVER_STATUS</h2> | ||
|
|
||
| <div class="memitem"> | ||
| <div class="memproto"> | ||
| <table class="memname"> | ||
| <tr> | ||
| <td class="memname">typedef uint32_t <a class="el" href="_e_f___driver___common_8h.html#ad1c99136d1edfd0a7757f5b81600a351">EF_DRIVER_STATUS</a></td> | ||
| </tr> | ||
| </table> | ||
| </div><div class="memdoc"> | ||
|
|
||
| <p>A type that is used to return the status of the driver functions. </p> | ||
|
|
||
| </div> | ||
| </div> | ||
| </div><!-- contents --> | ||
| <!-- start footer part --> | ||
| <hr class="footer"/><address class="footer"><small> | ||
| Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 | ||
| </small></address> | ||
| </body> | ||
| </html> |
Oops, something went wrong.