liumin/E3_boot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
Files
3159b3723bd3c34c4ce3f33be6f900f3ad606ec9
E3_boot/doc/Doxygen/html/sdrv__pvt_8h.html
liumin 7dc1e89694 增加所有文件
2025-11-07 10:05:24 +08:00

701 lines
38 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_pvt.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="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">sdrv_pvt.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__pvt_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="structsdrv__pvt__level__alarm__config.html">sdrv_pvt_level_alarm_config</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">union &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="unionsdrv__pvt__alarm__config.html">sdrv_pvt_alarm_config</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__pvt__core.html">sdrv_pvt_core</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__pvt.html">sdrv_pvt</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:a70d8660aec64b6b2c3f6531fdebd1b68"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="sdrv__pvt_8h.html#abdee7c14b2e81e9224d91a3ecd3072a6">sdrv_pvt_core_id</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a></td></tr>
<tr class="separator:a70d8660aec64b6b2c3f6531fdebd1b68"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a971fcaf5834809cf5175634da767d13a"><td class="memItemLeft" align="right" valign="top">typedef enum <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6">sdrv_pvt_alarm</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a></td></tr>
<tr class="separator:a971fcaf5834809cf5175634da767d13a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab003ba30fede418b3c0c61195b7d7717"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsdrv__pvt__level__alarm__config.html">sdrv_pvt_level_alarm_config</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#ab003ba30fede418b3c0c61195b7d7717">sdrv_pvt_level_alarm_config_t</a></td></tr>
<tr class="separator:ab003ba30fede418b3c0c61195b7d7717"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac36c461d32fbe35a60244104f0a22c21"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structsdrv__pvt__core.html">sdrv_pvt_core</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#ac36c461d32fbe35a60244104f0a22c21">sdrv_pvt_core_t</a></td></tr>
<tr class="separator:ac36c461d32fbe35a60244104f0a22c21"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:abdee7c14b2e81e9224d91a3ecd3072a6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#abdee7c14b2e81e9224d91a3ecd3072a6">sdrv_pvt_core_id</a> </td></tr>
<tr class="separator:abdee7c14b2e81e9224d91a3ecd3072a6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abc988c59577065d0eca192ce34373be6"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6">sdrv_pvt_alarm</a> { <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6a4a933daa6e0412f1c13eead80881c244">PVT_HIGH_LEVEL_ALARM</a> = 0
, <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6a2f8e7427f7021f0ac7820e1f0ef3db60">PVT_LOW_LEVEL_ALARM</a>
, <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6a40752138da2260ab5f01438b5b78708c">PVT_ALARM_NR</a>
}</td></tr>
<tr class="separator:abc988c59577065d0eca192ce34373be6"><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:a6378f2c9db6856adcad1c9dfe2a52c85"><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__pvt_8h.html#a6378f2c9db6856adcad1c9dfe2a52c85">sdrv_pvt_init</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev)</td></tr>
<tr class="separator:a6378f2c9db6856adcad1c9dfe2a52c85"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aec3804f95e5c4285298a1617c4646b5c"><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__pvt_8h.html#aec3804f95e5c4285298a1617c4646b5c">sdrv_pvt_deinit</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev)</td></tr>
<tr class="separator:aec3804f95e5c4285298a1617c4646b5c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53a4c2e069bd3fc70bd048aae22e44bc"><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__pvt_8h.html#a53a4c2e069bd3fc70bd048aae22e44bc">sdrv_pvt_start</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev)</td></tr>
<tr class="separator:a53a4c2e069bd3fc70bd048aae22e44bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae0f1c97c559aa90602bf5f13f7e38a50"><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__pvt_8h.html#ae0f1c97c559aa90602bf5f13f7e38a50">sdrv_pvt_stop</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev)</td></tr>
<tr class="separator:ae0f1c97c559aa90602bf5f13f7e38a50"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a20103e5ff7d67b8684196d183d6e4045"><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__pvt_8h.html#a20103e5ff7d67b8684196d183d6e4045">sdrv_pvt_power_down</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev)</td></tr>
<tr class="separator:a20103e5ff7d67b8684196d183d6e4045"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0344931a141aee8f0ef4e1c38f71d9b4"><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__pvt_8h.html#a0344931a141aee8f0ef4e1c38f71d9b4">sdrv_pvt_get</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev, <a class="el" href="sdrv__pvt_8h.html#ac997759a7cfbf5e97ae0bb69f0681fda">sdrv_pvt_type</a> *temperature)</td></tr>
<tr class="separator:a0344931a141aee8f0ef4e1c38f71d9b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac70adfc58cc40f753d226c9665a4fbb8"><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__pvt_8h.html#ac70adfc58cc40f753d226c9665a4fbb8">sdrv_pvt_register_alarm_cb</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev, <a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a> core, <a class="el" href="sdrv__pvt_8h.html#af441254a7a63944827ad0f032d16dca4">sdrv_pvt_alarm_cb_t</a> alarm_cb, void *arg)</td></tr>
<tr class="separator:ac70adfc58cc40f753d226c9665a4fbb8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0f4866f41e066abb6765d2fcc88c966d"><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__pvt_8h.html#a0f4866f41e066abb6765d2fcc88c966d">sdrv_pvt_enable_alarm</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev, <a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a> core, <a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a> alarm, const <a class="el" href="sdrv__pvt_8h.html#a35b5290ac398950854134c012932d245">sdrv_pvt_alarm_config_t</a> *config)</td></tr>
<tr class="separator:a0f4866f41e066abb6765d2fcc88c966d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6ef80ec469e73a9673c946105bd597"><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__pvt_8h.html#adc6ef80ec469e73a9673c946105bd597">sdrv_pvt_disable_alarm</a> (<a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *dev, <a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a> core, <a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a> alarm)</td></tr>
<tr class="separator:adc6ef80ec469e73a9673c946105bd597"><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="a85c4551ba0a2b73f2992f66c0c457a9a" name="a85c4551ba0a2b73f2992f66c0c457a9a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85c4551ba0a2b73f2992f66c0c457a9a">&#9670;&nbsp;</a></span>PVT_TEMPERATURE_MAX</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PVT_TEMPERATURE_MAX&#160;&#160;&#160;(230.7f) /* dout_to_celsius(0xfff) */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="adeb8ff4a7e61690475def9e293cf3212" name="adeb8ff4a7e61690475def9e293cf3212"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adeb8ff4a7e61690475def9e293cf3212">&#9670;&nbsp;</a></span>PVT_TEMPERATURE_MIN</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define PVT_TEMPERATURE_MIN&#160;&#160;&#160;(-75.9f) /* dout_to_celsius(0x0) */</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="afc159bb298bd9747adbeb0c55d4fff1a" name="afc159bb298bd9747adbeb0c55d4fff1a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afc159bb298bd9747adbeb0c55d4fff1a">&#9670;&nbsp;</a></span>SDRV_PVT_USE_EDGE_ALARM</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define SDRV_PVT_USE_EDGE_ALARM&#160;&#160;&#160;0</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Typedef Documentation</h2>
<a id="af441254a7a63944827ad0f032d16dca4" name="af441254a7a63944827ad0f032d16dca4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#af441254a7a63944827ad0f032d16dca4">&#9670;&nbsp;</a></span>sdrv_pvt_alarm_cb_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef void(* sdrv_pvt_alarm_cb_t) (struct <a class="el" href="structsdrv__pvt.html">sdrv_pvt</a> *dev, <a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a> core, <a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a> alarm, void *arg)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Temperature alarm callback. </p>
</div>
</div>
<a id="a35b5290ac398950854134c012932d245" name="a35b5290ac398950854134c012932d245"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a35b5290ac398950854134c012932d245">&#9670;&nbsp;</a></span>sdrv_pvt_alarm_config_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef union <a class="el" href="unionsdrv__pvt__alarm__config.html">sdrv_pvt_alarm_config</a> <a class="el" href="sdrv__pvt_8h.html#a35b5290ac398950854134c012932d245">sdrv_pvt_alarm_config_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Hysterisis alarm configuration. </p>
</div>
</div>
<a id="a971fcaf5834809cf5175634da767d13a" name="a971fcaf5834809cf5175634da767d13a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a971fcaf5834809cf5175634da767d13a">&#9670;&nbsp;</a></span>sdrv_pvt_alarm_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6">sdrv_pvt_alarm</a> <a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Temperature sensor alarm modes. </p>
<dl class="section note"><dt>Note</dt><dd>Do not change the order of this structure. </dd></dl>
</div>
</div>
<a id="a70d8660aec64b6b2c3f6531fdebd1b68" name="a70d8660aec64b6b2c3f6531fdebd1b68"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70d8660aec64b6b2c3f6531fdebd1b68">&#9670;&nbsp;</a></span>sdrv_pvt_core_id_e</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef enum <a class="el" href="sdrv__pvt_8h.html#abdee7c14b2e81e9224d91a3ecd3072a6">sdrv_pvt_core_id</a> <a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PVT core logics. </p>
<p >The sensor has 2 cores, both of which have identical logics, but different interrupt numbers. </p>
</div>
</div>
<a id="ac36c461d32fbe35a60244104f0a22c21" name="ac36c461d32fbe35a60244104f0a22c21"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac36c461d32fbe35a60244104f0a22c21">&#9670;&nbsp;</a></span>sdrv_pvt_core_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__pvt__core.html">sdrv_pvt_core</a> <a class="el" href="sdrv__pvt_8h.html#ac36c461d32fbe35a60244104f0a22c21">sdrv_pvt_core_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PVT core logic structure. </p>
<p >The controller has 2 cores, which have unique interrupt number and configuration registers. </p>
</div>
</div>
<a id="ab003ba30fede418b3c0c61195b7d7717" name="ab003ba30fede418b3c0c61195b7d7717"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab003ba30fede418b3c0c61195b7d7717">&#9670;&nbsp;</a></span>sdrv_pvt_level_alarm_config_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__pvt__level__alarm__config.html">sdrv_pvt_level_alarm_config</a> <a class="el" href="sdrv__pvt_8h.html#ab003ba30fede418b3c0c61195b7d7717">sdrv_pvt_level_alarm_config_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Level alarm configuration. </p>
<p >Temperature alarm thresholds, between PVT_TEMPERATURE_MIN and PVT_TEMPERATURE_MAX. </p>
</div>
</div>
<a id="a3fa453e2ad47d78da74395e2a160a75c" name="a3fa453e2ad47d78da74395e2a160a75c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3fa453e2ad47d78da74395e2a160a75c">&#9670;&nbsp;</a></span>sdrv_pvt_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structsdrv__pvt.html">sdrv_pvt</a> <a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Process and temperature sensor structure. </p>
</div>
</div>
<a id="ac997759a7cfbf5e97ae0bb69f0681fda" name="ac997759a7cfbf5e97ae0bb69f0681fda"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac997759a7cfbf5e97ae0bb69f0681fda">&#9670;&nbsp;</a></span>sdrv_pvt_type</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef float <a class="el" href="sdrv__pvt_8h.html#ac997759a7cfbf5e97ae0bb69f0681fda">sdrv_pvt_type</a></td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="abc988c59577065d0eca192ce34373be6" name="abc988c59577065d0eca192ce34373be6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abc988c59577065d0eca192ce34373be6">&#9670;&nbsp;</a></span>sdrv_pvt_alarm</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__pvt_8h.html#abc988c59577065d0eca192ce34373be6">sdrv_pvt_alarm</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Temperature sensor alarm modes. </p>
<dl class="section note"><dt>Note</dt><dd>Do not change the order of this structure. </dd></dl>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abc988c59577065d0eca192ce34373be6a4a933daa6e0412f1c13eead80881c244" name="abc988c59577065d0eca192ce34373be6a4a933daa6e0412f1c13eead80881c244"></a>PVT_HIGH_LEVEL_ALARM&#160;</td><td class="fielddoc"><p >Alarm asserted when DOUT is above HYST_H thresholds. Alarm asserted when DOUT is below HYST_L thresholds. </p>
</td></tr>
<tr><td class="fieldname"><a id="abc988c59577065d0eca192ce34373be6a2f8e7427f7021f0ac7820e1f0ef3db60" name="abc988c59577065d0eca192ce34373be6a2f8e7427f7021f0ac7820e1f0ef3db60"></a>PVT_LOW_LEVEL_ALARM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abc988c59577065d0eca192ce34373be6a40752138da2260ab5f01438b5b78708c" name="abc988c59577065d0eca192ce34373be6a40752138da2260ab5f01438b5b78708c"></a>PVT_ALARM_NR&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="abdee7c14b2e81e9224d91a3ecd3072a6" name="abdee7c14b2e81e9224d91a3ecd3072a6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#abdee7c14b2e81e9224d91a3ecd3072a6">&#9670;&nbsp;</a></span>sdrv_pvt_core_id</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__pvt_8h.html#abdee7c14b2e81e9224d91a3ecd3072a6">sdrv_pvt_core_id</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PVT core logics. </p>
<p >The sensor has 2 cores, both of which have identical logics, but different interrupt numbers. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="abdee7c14b2e81e9224d91a3ecd3072a6a4cdd2caf9ffaea5b5d5c35f3f694eb9f" name="abdee7c14b2e81e9224d91a3ecd3072a6a4cdd2caf9ffaea5b5d5c35f3f694eb9f"></a>PVT_CORE0&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abdee7c14b2e81e9224d91a3ecd3072a6a6388b72505892d0e55efeedc02f14455" name="abdee7c14b2e81e9224d91a3ecd3072a6a6388b72505892d0e55efeedc02f14455"></a>PVT_CORE1&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="abdee7c14b2e81e9224d91a3ecd3072a6af043cd6526474aa886692787dbda1eaa" name="abdee7c14b2e81e9224d91a3ecd3072a6af043cd6526474aa886692787dbda1eaa"></a>PVT_CORE_NR&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<a id="add31df86ac9f5fdfe4b93c0ff2f6a64d" name="add31df86ac9f5fdfe4b93c0ff2f6a64d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#add31df86ac9f5fdfe4b93c0ff2f6a64d">&#9670;&nbsp;</a></span>sdrv_pvt_error</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="sdrv__pvt_8h.html#add31df86ac9f5fdfe4b93c0ff2f6a64d">sdrv_pvt_error</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>PVT error code. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="add31df86ac9f5fdfe4b93c0ff2f6a64daab221d24d81799a8b00a563470752084" name="add31df86ac9f5fdfe4b93c0ff2f6a64daab221d24d81799a8b00a563470752084"></a>SDRV_PVT_INVALID_PARAM&#160;</td><td class="fielddoc"></td></tr>
<tr><td class="fieldname"><a id="add31df86ac9f5fdfe4b93c0ff2f6a64da165a5526ca9b667b26cf38fb49c5a874" name="add31df86ac9f5fdfe4b93c0ff2f6a64da165a5526ca9b667b26cf38fb49c5a874"></a>SDRV_PVT_NOT_STARTED&#160;</td><td class="fielddoc"></td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="aec3804f95e5c4285298a1617c4646b5c" name="aec3804f95e5c4285298a1617c4646b5c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aec3804f95e5c4285298a1617c4646b5c">&#9670;&nbsp;</a></span>sdrv_pvt_deinit()</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> sdrv_pvt_deinit </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>De-initialize the PVT device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="adc6ef80ec469e73a9673c946105bd597" name="adc6ef80ec469e73a9673c946105bd597"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6ef80ec469e73a9673c946105bd597">&#9670;&nbsp;</a></span>sdrv_pvt_disable_alarm()</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> sdrv_pvt_disable_alarm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a>&#160;</td>
<td class="paramname"><em>core</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a>&#160;</td>
<td class="paramname"><em>alarm</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable Temperature sensor alarm. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Temperature sensor device. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">core</td><td>Temperature sensor core. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>The alarm to disable. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0f4866f41e066abb6765d2fcc88c966d" name="a0f4866f41e066abb6765d2fcc88c966d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0f4866f41e066abb6765d2fcc88c966d">&#9670;&nbsp;</a></span>sdrv_pvt_enable_alarm()</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> sdrv_pvt_enable_alarm </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a>&#160;</td>
<td class="paramname"><em>core</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a971fcaf5834809cf5175634da767d13a">sdrv_pvt_alarm_e</a>&#160;</td>
<td class="paramname"><em>alarm</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="el" href="sdrv__pvt_8h.html#a35b5290ac398950854134c012932d245">sdrv_pvt_alarm_config_t</a> *&#160;</td>
<td class="paramname"><em>config</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable Temperature sensor alarm. </p>
<p >This function enables temperature sensor alarms.</p>
<dl class="section note"><dt>Note</dt><dd>When high level alarm is enabled and triggered in Safety PVT sensor Core 0, internal power-down/reset request is sent from Safety PVT to PMU by default.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Temperature sensor device. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">core</td><td>Temperature sensor core. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alarm</td><td>The alarm to enable. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">config</td><td>Alarm configurations. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a0344931a141aee8f0ef4e1c38f71d9b4" name="a0344931a141aee8f0ef4e1c38f71d9b4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0344931a141aee8f0ef4e1c38f71d9b4">&#9670;&nbsp;</a></span>sdrv_pvt_get()</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> sdrv_pvt_get </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#ac997759a7cfbf5e97ae0bb69f0681fda">sdrv_pvt_type</a> *&#160;</td>
<td class="paramname"><em>temperature</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read temperature sensor value. </p>
<dl class="section note"><dt>Note</dt><dd>Temperature value is not ready until 280ms after <a class="el" href="sdrv__pvt_8h.html#a53a4c2e069bd3fc70bd048aae22e44bc" title="Start temperature sensor.">sdrv_pvt_start()</a> is called.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">temperature</td><td>Junction temperature value. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a6378f2c9db6856adcad1c9dfe2a52c85" name="a6378f2c9db6856adcad1c9dfe2a52c85"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6378f2c9db6856adcad1c9dfe2a52c85">&#9670;&nbsp;</a></span>sdrv_pvt_init()</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> sdrv_pvt_init </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Initialize the PVT device. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a20103e5ff7d67b8684196d183d6e4045" name="a20103e5ff7d67b8684196d183d6e4045"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a20103e5ff7d67b8684196d183d6e4045">&#9670;&nbsp;</a></span>sdrv_pvt_power_down()</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> sdrv_pvt_power_down </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Power down T-sensor and P-sensor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac70adfc58cc40f753d226c9665a4fbb8" name="ac70adfc58cc40f753d226c9665a4fbb8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac70adfc58cc40f753d226c9665a4fbb8">&#9670;&nbsp;</a></span>sdrv_pvt_register_alarm_cb()</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> sdrv_pvt_register_alarm_cb </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a70d8660aec64b6b2c3f6531fdebd1b68">sdrv_pvt_core_id_e</a>&#160;</td>
<td class="paramname"><em>core</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#af441254a7a63944827ad0f032d16dca4">sdrv_pvt_alarm_cb_t</a>&#160;</td>
<td class="paramname"><em>alarm_cb</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *&#160;</td>
<td class="paramname"><em>arg</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Register temperature alarm callback. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Sensor device. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">core</td><td>Sensor core. </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">alarm_cb</td><td>Temperature alarm callback function. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a53a4c2e069bd3fc70bd048aae22e44bc" name="a53a4c2e069bd3fc70bd048aae22e44bc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53a4c2e069bd3fc70bd048aae22e44bc">&#9670;&nbsp;</a></span>sdrv_pvt_start()</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> sdrv_pvt_start </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Start temperature sensor. </p>
<p >After this function is called, the sensor automatically update temperature value every 280ms.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ae0f1c97c559aa90602bf5f13f7e38a50" name="ae0f1c97c559aa90602bf5f13f7e38a50"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0f1c97c559aa90602bf5f13f7e38a50">&#9670;&nbsp;</a></span>sdrv_pvt_stop()</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> sdrv_pvt_stop </td>
<td>(</td>
<td class="paramtype"><a class="el" href="sdrv__pvt_8h.html#a3fa453e2ad47d78da74395e2a160a75c">sdrv_pvt_t</a> *&#160;</td>
<td class="paramname"><em>dev</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Stop temperature sensor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>PVT sensor device. </td></tr>
</table>
</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