Select Git revision
board_8h_source.html
Forked from
card10 / firmware
766 commits behind, 1 commit ahead of the upstream repository.
board_8h_source.html 15.97 KiB
<!-- HTML header for doxygen 1.8.11-->
<!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.13"/>
<title>MAX32665 SDK Documentation: board.h Source File</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="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.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 style="height: 44px;">
<td id="projectlogo" style="vertical-align:middle"><img alt="Logo" style="width:144px;height:63px;" src="MI_Logo_Small_Pos_RGB_150dpi.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MAX32665 SDK Documentation
 <span id="projectnumber">0.2</span>
</div>
<div id="projectbrief">Software Development Kit Overview and API Documentation</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('board_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle"><div class="title">board.h</div> </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*******************************************************************************</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Copyright (C) 2017 Maxim Integrated Products, Inc., All Rights Reserved.</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> *</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * copy of this software and associated documentation files (the "Software"),</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * to deal in the Software without restriction, including without limitation</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the rights to use, copy, modify, merge, publish, distribute, sublicense,</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * and/or sell copies of the Software, and to permit persons to whom the</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * Software is furnished to do so, subject to the following conditions:</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> *</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * The above copyright notice and this permission notice shall be included</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * in all copies or substantial portions of the Software.</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> *</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * IN NO EVENT SHALL MAXIM INTEGRATED BE LIABLE FOR ANY CLAIM, DAMAGES</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * OTHER DEALINGS IN THE SOFTWARE.</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> *</span></div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment"> * Except as contained in this notice, the name of Maxim Integrated</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> * Products, Inc. shall not be used except as stated in the Maxim Integrated</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> * Products, Inc. Branding Policy.</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> *</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> * The mere transfer of this software does not imply any licenses</span></div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> * of trade secrets, proprietary technology, copyrights, patents,</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> * trademarks, maskwork rights, or any other form of intellectual</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> * property whatsoever. Maxim Integrated Products, Inc. retains all</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> * ownership rights.</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> *</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> * $Date: 2019-10-29 09:21:01 -0500 (Tue, 29 Oct 2019) $</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> * $Revision: 48140 $</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"> *</span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment"> ******************************************************************************/</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> </div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="preprocessor">#include <stdio.h></span></div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="preprocessor">#include "spixfc.h"</span></div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="preprocessor">#ifndef _BOARD_H</span></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="preprocessor">#define _BOARD_H</span></div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span> </div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span> <span class="preprocessor">#ifndef CONSOLE_UART</span></div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="preprocessor">#define CONSOLE_UART 1 </span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="preprocessor">#ifndef CONSOLE_BAUD</span></div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="preprocessor">#define CONSOLE_BAUD 115200 </span></div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00060"></a><span class="lineno"> 60</span> </div><div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="preprocessor">#define LED_OFF 1 </span></div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="preprocessor">#define LED_ON 0 </span></div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="preprocessor"></span></div><div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="preprocessor">#define MX25_SPI MXC_SPIXFC</span></div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="preprocessor">#define MX25_SSEL 0</span></div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment">// #define SPI_CHAR_BITS 8</span></div><div class="line"><a name="l00067"></a><span class="lineno"> 67</span> </div><div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">int</span> Board_Init(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00080"></a><span class="lineno"> 80</span> <span class="keywordtype">int</span> Console_Init(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00081"></a><span class="lineno"> 81</span> </div><div class="line"><a name="l00086"></a><span class="lineno"> 86</span> <span class="keywordtype">int</span> Console_PrepForSleep(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keywordtype">int</span> Console_Shutdown(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> </div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> <span class="keywordtype">int</span> MX25_Board_Init(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00110"></a><span class="lineno"> 110</span> <span class="keywordtype">int</span> MX25_Board_Read(uint8_t* read, <span class="keywordtype">unsigned</span> len, <span class="keywordtype">unsigned</span> deassert, <a class="code" href="group__spixfc.html#gaded948febc10c21ddffc69210f1df16e">spixfc_width_t</a> width);</div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">int</span> MX25_Board_Write(<span class="keyword">const</span> uint8_t* write, <span class="keywordtype">unsigned</span> len, <span class="keywordtype">unsigned</span> deassert, <a class="code" href="group__spixfc.html#gaded948febc10c21ddffc69210f1df16e">spixfc_width_t</a> width);</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="keywordtype">int</span> MX25_Clock(<span class="keywordtype">unsigned</span> len, <span class="keywordtype">unsigned</span> deassert);</div><div class="line"><a name="l00129"></a><span class="lineno"> 129</span> </div><div class="line"><a name="l00130"></a><span class="lineno"> 130</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00131"></a><span class="lineno"> 131</span> }</div><div class="line"><a name="l00132"></a><span class="lineno"> 132</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00133"></a><span class="lineno"> 133</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="preprocessor">#endif </span><span class="comment">/* _BOARD_H */</span><span class="preprocessor"></span></div><div class="ttc" id="group__spixfc_html_gaded948febc10c21ddffc69210f1df16e"><div class="ttname"><a href="group__spixfc.html#gaded948febc10c21ddffc69210f1df16e">spixfc_width_t</a></div><div class="ttdeci">spixfc_width_t</div><div class="ttdoc">Number of data lines to use. </div><div class="ttdef"><b>Definition:</b> spixfc.h:80</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- HTML footer for doxygen 1.8.12-->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_74b6a3b63f61c160c0f14b7a283a4c9b.html">Firmware</a></li><li class="navelem"><a class="el" href="dir_3540c00680c2664f9f7e8f48ca1cab09.html">Libraries</a></li><li class="navelem"><a class="el" href="dir_9f2a8f1ccad01dad74520aa17e6d69ff.html">Boards</a></li><li class="navelem"><a class="el" href="dir_1f2f7bf2c9c3785a18a5ed279dfc7be8.html">EvKit_V1</a></li><li class="navelem"><a class="el" href="dir_1591e976cf2be5b2a5fc58e6820b0523.html">Include</a></li><li class="navelem"><b>board.h</b></li>
<li class="footer">
<a href="http://www.maximintegrated.com/index.html">
<img class="footer" align="middle" src="MI_Logo_Small_Footer_RGB_150dpi.png" alt="Maxim Integrated"/></a> 0.2 </li>
</ul>
</div>
</body>
</html>