119 lines
13 KiB
HTML
119 lines
13 KiB
HTML
<!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">
|
|
<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.4"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>SemiDrive SSDK Appication Program Interface: Z:/01-Code/06-SSDK-DEV-Firewall/ssdk/drivers/include/sdrv_semag.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="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">SemiDrive SSDK Appication Program Interface<span id="projectnumber"> PTG3.0</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.4 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search",'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">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</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_ee023d43c33bfccc31aa50a48a76892b.html">include</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle"><div class="title">sdrv_semag.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="sdrv__semag_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#ifndef SDRV_SEMAG_H_</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define SDRV_SEMAG_H_</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="preprocessor">#include <<a class="code" href="sdrv__common_8h.html">sdrv_common.h</a>></span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="preprocessor">#include <types.h></span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span> </div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a41d9e164413a3329cc7debc241e667c6"> 17</a></span><span class="preprocessor">#define SDRV_SEMAG_NUM (32UL)</span></div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a955df89c459274a72555062ffc8c291e"> 18</a></span><span class="preprocessor">#define SDRV_SEMAG_PROCESSOR_NUM (8UL)</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> </div>
|
|
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a0e9b98ee41a4aeef9675f6a3d47a80cd"> 31</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#a0e9b98ee41a4aeef9675f6a3d47a80cd">sdrv_semag_trylock</a>(uint32_t gate_idx);</div>
|
|
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span> </div>
|
|
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#aa6b11497cf799fca41cb32a71ef278d8"> 44</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#aa6b11497cf799fca41cb32a71ef278d8">sdrv_semag_lock</a>(uint32_t gate_idx);</div>
|
|
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span> </div>
|
|
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#ae1474de31ac32cf189cba0bd44091f71"> 57</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#ae1474de31ac32cf189cba0bd44091f71">sdrv_semag_unlock</a>(uint32_t gate_idx);</div>
|
|
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"> 58</span> </div>
|
|
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#abf60568741259794ef70f5922b2db1a3"> 68</a></span>int32_t <a class="code hl_function" href="sdrv__semag_8h.html#abf60568741259794ef70f5922b2db1a3">sdrv_semag_get_lock_proc</a>(uint32_t gate_idx);</div>
|
|
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno"> 69</span> </div>
|
|
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a519a4d03ed6b09251826b417822c5e44"> 78</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#a519a4d03ed6b09251826b417822c5e44">sdrv_semag_reset_all_gate</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span> </div>
|
|
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#ae5f07b50e50df6b617e4f8450b6e15db"> 92</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#ae5f07b50e50df6b617e4f8450b6e15db">sdrv_semag_enable_gate_notify_interrupt</a>(uint32_t mask);</div>
|
|
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span> </div>
|
|
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a2772683a344c4a3070d98a71bab32cdf"> 106</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#a2772683a344c4a3070d98a71bab32cdf">sdrv_semag_disable_gate_notify_interrupt</a>(uint32_t mask);</div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"> 107</span> </div>
|
|
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a22140fa13f5c8baabe5982440d671f83"> 118</a></span>uint32_t <a class="code hl_function" href="sdrv__semag_8h.html#a22140fa13f5c8baabe5982440d671f83">sdrv_semag_get_notify_status</a>(<span class="keywordtype">void</span>);</div>
|
|
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"> 119</span> </div>
|
|
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno"><a class="line" href="sdrv__semag_8h.html#a1bd3298a847a5d0101eedb6ae0409934"> 130</a></span><a class="code hl_typedef" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> <a class="code hl_function" href="sdrv__semag_8h.html#a1bd3298a847a5d0101eedb6ae0409934">sdrv_semag_clear_notify_status</a>(uint32_t mask);</div>
|
|
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno"> 131</span> </div>
|
|
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"> 132</span><span class="preprocessor">#endif </span><span class="comment">/* SDRV_SEMAG_H_ */</span><span class="preprocessor"></span></div>
|
|
<div class="ttc" id="asdrv__common_8h_html"><div class="ttname"><a href="sdrv__common_8h.html">sdrv_common.h</a></div><div class="ttdoc">SemiDrive driver common header file.</div></div>
|
|
<div class="ttc" id="asdrv__common_8h_html_aaabdaf7ee58ca7269bd4bf24efcde092"><div class="ttname"><a href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a></div><div class="ttdeci">int32_t status_t</div><div class="ttdoc">Type used for all status and error return values.</div><div class="ttdef"><b>Definition:</b> sdrv_common.h:82</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_a0e9b98ee41a4aeef9675f6a3d47a80cd"><div class="ttname"><a href="sdrv__semag_8h.html#a0e9b98ee41a4aeef9675f6a3d47a80cd">sdrv_semag_trylock</a></div><div class="ttdeci">status_t sdrv_semag_trylock(uint32_t gate_idx)</div><div class="ttdoc">Tries to lock the SEMAG gate.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_a1bd3298a847a5d0101eedb6ae0409934"><div class="ttname"><a href="sdrv__semag_8h.html#a1bd3298a847a5d0101eedb6ae0409934">sdrv_semag_clear_notify_status</a></div><div class="ttdeci">status_t sdrv_semag_clear_notify_status(uint32_t mask)</div><div class="ttdoc">Clear the gate notification interrupt status.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_a22140fa13f5c8baabe5982440d671f83"><div class="ttname"><a href="sdrv__semag_8h.html#a22140fa13f5c8baabe5982440d671f83">sdrv_semag_get_notify_status</a></div><div class="ttdeci">uint32_t sdrv_semag_get_notify_status(void)</div><div class="ttdoc">Get the gate notification flags.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_a2772683a344c4a3070d98a71bab32cdf"><div class="ttname"><a href="sdrv__semag_8h.html#a2772683a344c4a3070d98a71bab32cdf">sdrv_semag_disable_gate_notify_interrupt</a></div><div class="ttdeci">status_t sdrv_semag_disable_gate_notify_interrupt(uint32_t mask)</div><div class="ttdoc">Disable the gate notification interrupt.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_a519a4d03ed6b09251826b417822c5e44"><div class="ttname"><a href="sdrv__semag_8h.html#a519a4d03ed6b09251826b417822c5e44">sdrv_semag_reset_all_gate</a></div><div class="ttdeci">status_t sdrv_semag_reset_all_gate(void)</div><div class="ttdoc">Resets all SEMAG gates to an unlocked status.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_aa6b11497cf799fca41cb32a71ef278d8"><div class="ttname"><a href="sdrv__semag_8h.html#aa6b11497cf799fca41cb32a71ef278d8">sdrv_semag_lock</a></div><div class="ttdeci">status_t sdrv_semag_lock(uint32_t gate_idx)</div><div class="ttdoc">Locks the SEMAG gate.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_abf60568741259794ef70f5922b2db1a3"><div class="ttname"><a href="sdrv__semag_8h.html#abf60568741259794ef70f5922b2db1a3">sdrv_semag_get_lock_proc</a></div><div class="ttdeci">int32_t sdrv_semag_get_lock_proc(uint32_t gate_idx)</div><div class="ttdoc">Gets the status of the SEMAG gate.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_ae1474de31ac32cf189cba0bd44091f71"><div class="ttname"><a href="sdrv__semag_8h.html#ae1474de31ac32cf189cba0bd44091f71">sdrv_semag_unlock</a></div><div class="ttdeci">status_t sdrv_semag_unlock(uint32_t gate_idx)</div><div class="ttdoc">Unlocks the SEMAG gate.</div></div>
|
|
<div class="ttc" id="asdrv__semag_8h_html_ae5f07b50e50df6b617e4f8450b6e15db"><div class="ttname"><a href="sdrv__semag_8h.html#ae5f07b50e50df6b617e4f8450b6e15db">sdrv_semag_enable_gate_notify_interrupt</a></div><div class="ttdeci">status_t sdrv_semag_enable_gate_notify_interrupt(uint32_t mask)</div><div class="ttdoc">Enable the gate notification interrupt.</div></div>
|
|
</div><!-- fragment --></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.4
|
|
</small></address>
|
|
</body>
|
|
</html>
|