liumin/6CAR
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
f5e9e1ead790a8a20607eab37c6e4ee219eb70c4
6CAR/doc/Doxygen/html/sdrv__scr_8h.html
liumin 1575212f13 移动了文件位置
2026-04-18 09:16:58 +08:00

400 lines
19 KiB
HTML
Raw Blame History

<!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_scr.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">SemiDrive SSDK Appication Program Interface<span id="projectnumber">&#160;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&amp;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&amp;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="summary">
<a href="#nested-classes">Data Structures</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sdrv_scr.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;<a class="el" href="sdrv__common_8h_source.html">sdrv_common.h</a>&gt;</code><br />
<code>#include &lt;types.h&gt;</code><br />
</div>
<p><a href="sdrv__scr_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="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structscr__signal.html">scr_signal</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structsdrv__scr.html">sdrv_scr</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</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:aae0932ec3f0771f7f403c54290c3033d"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structscr__signal.html">scr_signal</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a></td></tr>
<tr class="separator:aae0932ec3f0771f7f403c54290c3033d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a50f346a26d694490b0462063ec12b705"><td class="memItemLeft" align="right" valign="top">uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__scr_8h.html#a50f346a26d694490b0462063ec12b705">scr_get</a> (const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *scr, const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *signal)</td></tr>
<tr class="separator:a50f346a26d694490b0462063ec12b705"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf10de1cf640696df379ea421f19e11c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__scr_8h.html#acf10de1cf640696df379ea421f19e11c">scr_set</a> (const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *scr, const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *signal, uint32_t value)</td></tr>
<tr class="separator:acf10de1cf640696df379ea421f19e11c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afa07833386daabd48eead6f8707c0ad6"><td class="memItemLeft" align="right" valign="top"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__scr_8h.html#afa07833386daabd48eead6f8707c0ad6">scr_lock</a> (const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *scr, const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *signal)</td></tr>
<tr class="separator:afa07833386daabd48eead6f8707c0ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adb3de0a3d16758ed6dcd6a7fb1c49fd0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__scr_8h.html#adb3de0a3d16758ed6dcd6a7fb1c49fd0">scr_is_locked</a> (const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *scr, const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *signal)</td></tr>
<tr class="separator:adb3de0a3d16758ed6dcd6a7fb1c49fd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><dl class="section copyright"><dt>Copyright</dt><dd>Copyright (c) 2022 Semidrive Semiconductor. All rights reserved. </dd></dl>
</div><h2 class="groupheader">Macro Definition Documentation</h2>
<a id="aaad8951fce415d05810e1226fb8d5d4e" name="aaad8951fce415d05810e1226fb8d5d4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaad8951fce415d05810e1226fb8d5d4e">&#9670;&nbsp;</a></span>TYPE_L16</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TYPE_L16&#160;&#160;&#160;2<a class="el" href="warning__image_8h.html#ae31d80f000b561c9b9f1be374ce459f9">u</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a3278f4c8589d26cfa0f8abfa95a2469e" name="a3278f4c8589d26cfa0f8abfa95a2469e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3278f4c8589d26cfa0f8abfa95a2469e">&#9670;&nbsp;</a></span>TYPE_L31</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TYPE_L31&#160;&#160;&#160;3<a class="el" href="warning__image_8h.html#ae31d80f000b561c9b9f1be374ce459f9">u</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a2bfbfa855972ed4dd380d135d4d1e0eb" name="a2bfbfa855972ed4dd380d135d4d1e0eb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2bfbfa855972ed4dd380d135d4d1e0eb">&#9670;&nbsp;</a></span>TYPE_R16W16</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TYPE_R16W16&#160;&#160;&#160;4<a class="el" href="warning__image_8h.html#ae31d80f000b561c9b9f1be374ce459f9">u</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a85d6a4b6fa430af81da988c043e41a74" name="a85d6a4b6fa430af81da988c043e41a74"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85d6a4b6fa430af81da988c043e41a74">&#9670;&nbsp;</a></span>TYPE_RO</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TYPE_RO&#160;&#160;&#160;1<a class="el" href="warning__image_8h.html#ae31d80f000b561c9b9f1be374ce459f9">u</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="a925d0297986302f2497439309edee16e" name="a925d0297986302f2497439309edee16e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a925d0297986302f2497439309edee16e">&#9670;&nbsp;</a></span>TYPE_RW</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define TYPE_RW&#160;&#160;&#160;0u</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aae0932ec3f0771f7f403c54290c3033d" name="aae0932ec3f0771f7f403c54290c3033d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aae0932ec3f0771f7f403c54290c3033d">&#9670;&nbsp;</a></span>scr_signal_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structscr__signal.html">scr_signal</a> <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>SCR signal structure. </p>
<dl class="section note"><dt>Note</dt><dd>Do NOT define SCR signals by yourself. Use signals defined in "scr_hw.h", which is automatically generated. </dd></dl>
</div>
</div>
<a id="aee18a69a980ee7a704706e063cc24d2a" name="aee18a69a980ee7a704706e063cc24d2a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aee18a69a980ee7a704706e063cc24d2a">&#9670;&nbsp;</a></span>sdrv_scr_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__scr.html">sdrv_scr</a> <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>SCR device structure. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a4790f45dcc812c1b00184a2edccdddf5" name="a4790f45dcc812c1b00184a2edccdddf5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4790f45dcc812c1b00184a2edccdddf5">&#9670;&nbsp;</a></span>anonymous enum</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">anonymous enum</td>
</tr>
</table>
</div><div class="memdoc">
<p>SCR driver error codes. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a4790f45dcc812c1b00184a2edccdddf5ad4d8c6a3982ee90912b5e03e811e92c3" name="a4790f45dcc812c1b00184a2edccdddf5ad4d8c6a3982ee90912b5e03e811e92c3"></a>SDRV_SCR_LOCKED&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4790f45dcc812c1b00184a2edccdddf5ae13e322804af7040cfcb40b8e137d640" name="a4790f45dcc812c1b00184a2edccdddf5ae13e322804af7040cfcb40b8e137d640"></a>SDRV_SCR_CANNOT_LOCK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a4790f45dcc812c1b00184a2edccdddf5a7c7293b2f3f5cd64f4cf0a0c3fa341d7" name="a4790f45dcc812c1b00184a2edccdddf5a7c7293b2f3f5cd64f4cf0a0c3fa341d7"></a>SDRV_SCR_CANNOT_WRITE&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="a50f346a26d694490b0462063ec12b705" name="a50f346a26d694490b0462063ec12b705"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a50f346a26d694490b0462063ec12b705">&#9670;&nbsp;</a></span>scr_get()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t scr_get </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *&#160;</td>
<td class="paramname"><em>scr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *&#160;</td>
<td class="paramname"><em>signal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get value of signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scr</td><td>SCR controller. </td></tr>
<tr><td class="paramname">signal</td><td>Signal defined in "scr_hw.h". </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Signal value. </dd></dl>
</div>
</div>
<a id="adb3de0a3d16758ed6dcd6a7fb1c49fd0" name="adb3de0a3d16758ed6dcd6a7fb1c49fd0"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adb3de0a3d16758ed6dcd6a7fb1c49fd0">&#9670;&nbsp;</a></span>scr_is_locked()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool scr_is_locked </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *&#160;</td>
<td class="paramname"><em>scr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *&#160;</td>
<td class="paramname"><em>signal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check the lock status of signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scr</td><td>SCR controller. </td></tr>
<tr><td class="paramname">signal</td><td>Signal defined in "scr_hw.h", which should be of L16/L31 type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if signal is locked. </dd></dl>
</div>
</div>
<a id="afa07833386daabd48eead6f8707c0ad6" name="afa07833386daabd48eead6f8707c0ad6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afa07833386daabd48eead6f8707c0ad6">&#9670;&nbsp;</a></span>scr_lock()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> scr_lock </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *&#160;</td>
<td class="paramname"><em>scr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *&#160;</td>
<td class="paramname"><em>signal</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Lock the given signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scr</td><td>SCR controller. </td></tr>
<tr><td class="paramname">signal</td><td>Signal defined in "scr_hw.h", which should be of L16/L31 type. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK if successfully locked signal. </dd></dl>
</div>
</div>
<a id="acf10de1cf640696df379ea421f19e11c" name="acf10de1cf640696df379ea421f19e11c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acf10de1cf640696df379ea421f19e11c">&#9670;&nbsp;</a></span>scr_set()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a> scr_set </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aee18a69a980ee7a704706e063cc24d2a">sdrv_scr_t</a> *&#160;</td>
<td class="paramname"><em>scr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__scr_8h.html#aae0932ec3f0771f7f403c54290c3033d">scr_signal_t</a> *&#160;</td>
<td class="paramname"><em>signal</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t&#160;</td>
<td class="paramname"><em>value</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set value of signal. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">scr</td><td>SCR controller. </td></tr>
<tr><td class="paramname">signal</td><td>Signal defined in "scr_hw.h". </td></tr>
<tr><td class="paramname">value</td><td>Signal value. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>SDRV_STATUS_OK if successfully set. SDRV_SCR_LOCKED if signal is locked, or SDRV_SCR_CANNOT_WRITE if signal is read only. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>
Reference in New Issue View Git Blame Copy Permalink