Files
6CAR/doc/Doxygen/html/sdrv__common_8h.html
2026-04-18 09:16:58 +08:00

217 lines
18 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_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">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="headertitle"><div class="title">sdrv_common.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;types.h&gt;</code><br />
</div>
<p><a href="sdrv__common_8h_source.html">Go to the source code of this file.</a></p>
<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="aef8aef2653fac9cb1b5fbe2a5976314c" name="aef8aef2653fac9cb1b5fbe2a5976314c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aef8aef2653fac9cb1b5fbe2a5976314c">&#9670;&nbsp;</a></span>SDRV_ERROR_STATUS</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_ERROR_STATUS</td>
<td>(</td>
<td class="paramtype">&#160;</td>
<td class="paramname">group, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">&#160;</td>
<td class="paramname">code&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td>&#160;&#160;&#160;(-((group) * (1000U) + (code)))</td>
</tr>
</table>
</div><div class="memdoc">
<p>Construct a status code value from a group and code number. All the error statuses are negetive numbers. </p>
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="aaabdaf7ee58ca7269bd4bf24efcde092" name="aaabdaf7ee58ca7269bd4bf24efcde092"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aaabdaf7ee58ca7269bd4bf24efcde092">&#9670;&nbsp;</a></span>status_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef int32_t <a class="el" href="sdrv__common_8h.html#aaabdaf7ee58ca7269bd4bf24efcde092">status_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type used for all status and error return values. </p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="ae4d5251432e1a9e6803c0240cc492e18" name="ae4d5251432e1a9e6803c0240cc492e18"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae4d5251432e1a9e6803c0240cc492e18">&#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>Common status return code. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="ae4d5251432e1a9e6803c0240cc492e18ad0b8e972f5ce6b290b1b1626dfe919a8" name="ae4d5251432e1a9e6803c0240cc492e18ad0b8e972f5ce6b290b1b1626dfe919a8"></a>SDRV_STATUS_OK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae4d5251432e1a9e6803c0240cc492e18a9d7a977c6615025d7d40ed9925e4ffbf" name="ae4d5251432e1a9e6803c0240cc492e18a9d7a977c6615025d7d40ed9925e4ffbf"></a>SDRV_STATUS_FAIL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae4d5251432e1a9e6803c0240cc492e18ae13effc42538e96be8d35e6a3d234eef" name="ae4d5251432e1a9e6803c0240cc492e18ae13effc42538e96be8d35e6a3d234eef"></a>SDRV_STATUS_BUSY&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae4d5251432e1a9e6803c0240cc492e18ad39b65025f135d1e9277dc40a933bc06" name="ae4d5251432e1a9e6803c0240cc492e18ad39b65025f135d1e9277dc40a933bc06"></a>SDRV_STATUS_TIMEOUT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="ae4d5251432e1a9e6803c0240cc492e18a58edc7383515b11260eb9905bd872ee2" name="ae4d5251432e1a9e6803c0240cc492e18a58edc7383515b11260eb9905bd872ee2"></a>SDRV_STATUS_INVALID_PARAM&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="a19e0f226537905b9e022007ff40c57c6" name="a19e0f226537905b9e022007ff40c57c6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19e0f226537905b9e022007ff40c57c6">&#9670;&nbsp;</a></span>status_groups</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__common_8h.html#a19e0f226537905b9e022007ff40c57c6">status_groups</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Status group numbers. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a5a1aa9a5ba636679f4855475a8f8db8f" name="a19e0f226537905b9e022007ff40c57c6a5a1aa9a5ba636679f4855475a8f8db8f"></a>SDRV_STATUS_GROUP_COMMON&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6afad92cda127221f8ec802df09f536c3f" name="a19e0f226537905b9e022007ff40c57c6afad92cda127221f8ec802df09f536c3f"></a>SDRV_STATUS_GROUP_RESET&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a6cc8de20898748f58ab3eff2920b6df8" name="a19e0f226537905b9e022007ff40c57c6a6cc8de20898748f58ab3eff2920b6df8"></a>SDRV_STATUS_GROUP_CLK&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a2ec8994d06118c807ff76653a5674214" name="a19e0f226537905b9e022007ff40c57c6a2ec8994d06118c807ff76653a5674214"></a>SDRV_STATUS_GROUP_VIC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6acc1bb07642695427c9f10bc8d8ed69ae" name="a19e0f226537905b9e022007ff40c57c6acc1bb07642695427c9f10bc8d8ed69ae"></a>SDRV_STATUS_GROUP_PINCTRL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a0987f77c47343f9d72c8a0413137d0a8" name="a19e0f226537905b9e022007ff40c57c6a0987f77c47343f9d72c8a0413137d0a8"></a>SDRV_STATUS_GROUP_GPIO&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a6321aface9402db0749cca1661ccdbd3" name="a19e0f226537905b9e022007ff40c57c6a6321aface9402db0749cca1661ccdbd3"></a>SDRV_STATUS_GROUP_DMA&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a965609c569f06348e29e73ce390425c0" name="a19e0f226537905b9e022007ff40c57c6a965609c569f06348e29e73ce390425c0"></a>SDRV_STATUS_GROUP_BTM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6abc8f1b7369eab40b56019a0c68581f82" name="a19e0f226537905b9e022007ff40c57c6abc8f1b7369eab40b56019a0c68581f82"></a>SDRV_STATUS_GROUP_FUSE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6aa817691ee76c0acb0b70acb783c25229" name="a19e0f226537905b9e022007ff40c57c6aa817691ee76c0acb0b70acb783c25229"></a>SDRV_STATUS_GROUP_WATCHDOG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a1bf2540750cf21ee86eacaae812b9171" name="a19e0f226537905b9e022007ff40c57c6a1bf2540750cf21ee86eacaae812b9171"></a>SDRV_STATUS_GROUP_CRYPTO&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a8edb659d5f4db4534f833576be6ff6b8" name="a19e0f226537905b9e022007ff40c57c6a8edb659d5f4db4534f833576be6ff6b8"></a>SDRV_STATUS_GROUP_UART&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6aa9d0c007c5e9f3fac5882685b3c89ed8" name="a19e0f226537905b9e022007ff40c57c6aa9d0c007c5e9f3fac5882685b3c89ed8"></a>SDRV_STATUS_GROUP_FLEXCAN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a28373e6ef36add3e11b875352c661c9c" name="a19e0f226537905b9e022007ff40c57c6a28373e6ef36add3e11b875352c661c9c"></a>SDRV_STATUS_GROUP_LIN&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6ae88036e2756434f9839f4832a36db036" name="a19e0f226537905b9e022007ff40c57c6ae88036e2756434f9839f4832a36db036"></a>SDRV_STATUS_GROUP_I2C&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a5958b511fedf5b9db3251ffe7680975c" name="a19e0f226537905b9e022007ff40c57c6a5958b511fedf5b9db3251ffe7680975c"></a>SDRV_STATUS_GROUP_SPI&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a63a049e7146f48e1c2c262d9c5e849a7" name="a19e0f226537905b9e022007ff40c57c6a63a049e7146f48e1c2c262d9c5e849a7"></a>SDRV_STATUS_GROUP_ETH&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a44eb2114b3718b7331652668d723ab24" name="a19e0f226537905b9e022007ff40c57c6a44eb2114b3718b7331652668d723ab24"></a>SDRV_STATUS_GROUP_I2S&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a25d717ce97a247c6684bad1e536d5146" name="a19e0f226537905b9e022007ff40c57c6a25d717ce97a247c6684bad1e536d5146"></a>SDRV_STATUS_GROUP_PDM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6afcd88a0a9a7cd8f37c1bc1e0e76cd0de" name="a19e0f226537905b9e022007ff40c57c6afcd88a0a9a7cd8f37c1bc1e0e76cd0de"></a>SDRV_STATUS_GROUP_EPWM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a7944b52d77a965a3984e2d0a8f2d8364" name="a19e0f226537905b9e022007ff40c57c6a7944b52d77a965a3984e2d0a8f2d8364"></a>SDRV_STATUS_GROUP_ETIMER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a9f8b3c8a5a23b6535db8017831e349c9" name="a19e0f226537905b9e022007ff40c57c6a9f8b3c8a5a23b6535db8017831e349c9"></a>SDRV_STATUS_GROUP_XTRG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a8d98cb6ed55b8264a9c32dd6ab3a24b7" name="a19e0f226537905b9e022007ff40c57c6a8d98cb6ed55b8264a9c32dd6ab3a24b7"></a>SDRV_STATUS_GROUP_ADC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a74a565762cc7c7054dd3882537e67823" name="a19e0f226537905b9e022007ff40c57c6a74a565762cc7c7054dd3882537e67823"></a>SDRV_STATUS_GROUP_ACMP&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a63b5b7341e8bb47d7ac7b52becade5af" name="a19e0f226537905b9e022007ff40c57c6a63b5b7341e8bb47d7ac7b52becade5af"></a>SDRV_STATUS_GROUP_ASW&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6ae92ac43cbfdc9a1a75d226d8c9e1bc27" name="a19e0f226537905b9e022007ff40c57c6ae92ac43cbfdc9a1a75d226d8c9e1bc27"></a>SDRV_STATUS_GROUP_DISPSS&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a01abde245e92a6f9ee82b2a6416a0c12" name="a19e0f226537905b9e022007ff40c57c6a01abde245e92a6f9ee82b2a6416a0c12"></a>SDRV_STATUS_GROUP_CAMERA&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a979f3a2a389e9a8d3174ac698d9dca16" name="a19e0f226537905b9e022007ff40c57c6a979f3a2a389e9a8d3174ac698d9dca16"></a>SDRV_STATUS_GROUP_G2DLITE&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a2e8b92ecdeb521bf34135a7a147d598c" name="a19e0f226537905b9e022007ff40c57c6a2e8b92ecdeb521bf34135a7a147d598c"></a>SDRV_STATUS_GROUP_PMU&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6aa6e5792662896e234c220987cea91c4c" name="a19e0f226537905b9e022007ff40c57c6aa6e5792662896e234c220987cea91c4c"></a>SDRV_STATUS_GROUP_POWER&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a6347a31d9e96a8c455363668aa4a2345" name="a19e0f226537905b9e022007ff40c57c6a6347a31d9e96a8c455363668aa4a2345"></a>SDRV_STATUS_GROUP_SMC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a9f976f6bdfa0e690e03a2d3aa31cc3cc" name="a19e0f226537905b9e022007ff40c57c6a9f976f6bdfa0e690e03a2d3aa31cc3cc"></a>SDRV_STATUS_GROUP_RTC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a52bc38b378ea7771c6f98ae54619bb9c" name="a19e0f226537905b9e022007ff40c57c6a52bc38b378ea7771c6f98ae54619bb9c"></a>SDRV_STATUS_GROUP_SCR&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a5d560b6fa7fef2478093b2e077c5fb32" name="a19e0f226537905b9e022007ff40c57c6a5d560b6fa7fef2478093b2e077c5fb32"></a>SDRV_STATUS_GROUP_PVT&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6aba05ef4807a5d70e736d831458a25a5e" name="a19e0f226537905b9e022007ff40c57c6aba05ef4807a5d70e736d831458a25a5e"></a>SDRV_STATUS_GROUP_SDRAMC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a3f86b34a1c63c139e65bd0099ab952bb" name="a19e0f226537905b9e022007ff40c57c6a3f86b34a1c63c139e65bd0099ab952bb"></a>SDRV_STATUS_GROUP_MBOX&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a410c74db51864071249ceb7cb42b1e64" name="a19e0f226537905b9e022007ff40c57c6a410c74db51864071249ceb7cb42b1e64"></a>SDRV_STATUS_GROUP_SEMAG&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a4ae275c1bca5d4c6eb9082bab1c4f5fb" name="a19e0f226537905b9e022007ff40c57c6a4ae275c1bca5d4c6eb9082bab1c4f5fb"></a>SDRV_STATUS_GROUP_XSPI&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a06857592503e9de9f2e9909a9f506017" name="a19e0f226537905b9e022007ff40c57c6a06857592503e9de9f2e9909a9f506017"></a>SDRV_STATUS_GROUP_MMC&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6ae366c8c2c92e3e0376b934a69d20765f" name="a19e0f226537905b9e022007ff40c57c6ae366c8c2c92e3e0376b934a69d20765f"></a>SDRV_STATUS_GROUP_XSPI_MST_SLV&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a6f971e50c0a1bd3af1ea32b5bc633376" name="a19e0f226537905b9e022007ff40c57c6a6f971e50c0a1bd3af1ea32b5bc633376"></a>SDRV_STATUS_GROUP_FLEXRAY&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a1819c12a8789de2c7215d6537431b637" name="a19e0f226537905b9e022007ff40c57c6a1819c12a8789de2c7215d6537431b637"></a>SDRV_STATUS_GROUP_FIREWALL&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="a19e0f226537905b9e022007ff40c57c6a0a6c523f8e232315c32efafbaba2ec40" name="a19e0f226537905b9e022007ff40c57c6a0a6c523f8e232315c32efafbaba2ec40"></a>SDRV_STATUS_GROUP_OTHER&#160;</td><td class="fielddoc"></td></tr>
</table>
</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>