<!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"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>mbed TLS v2.7.3: timing.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="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: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">mbed TLS v2.7.3
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_b4d146e9a6d8dd56ed4afb2480a97fd3.html">mbedtls</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">timing.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="timing_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> </div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">/*</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * SPDX-License-Identifier: Apache-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> *</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License"); you may</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * not use this file except in compliance with the License.</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * You may obtain a copy of the License at</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"> * http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> *</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * limitations under the License.</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"> * This file is part of mbed TLS (https://tls.mbed.org)</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"> */</span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#ifndef MBEDTLS_TIMING_H</span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor">#define MBEDTLS_TIMING_H</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> </div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#if !defined(MBEDTLS_CONFIG_FILE)</span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="preprocessor">#include "<a class="code" href="config_8h.html">config.h</a>"</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#else</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor">#include MBEDTLS_CONFIG_FILE</span></div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> </div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="preprocessor">#if !defined(MBEDTLS_TIMING_ALT)</span></div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment">// Regular implementation</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="l00037"></a><span class="lineno"> 37</span> <span class="preprocessor">#include <stdint.h></span></div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> </div><div class="line"><a name="l00046"></a><span class="lineno"><a class="line" href="structmbedtls__timing__hr__time.html"> 46</a></span> <span class="keyword">struct </span><a class="code" href="structmbedtls__timing__hr__time.html">mbedtls_timing_hr_time</a></div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span> {</div><div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="structmbedtls__timing__hr__time.html#a5ad2da97c4ec844c558bb9a49d62ba2f"> 48</a></span>  <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> <a class="code" href="structmbedtls__timing__hr__time.html#a5ad2da97c4ec844c558bb9a49d62ba2f">opaque</a>[32];</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span> };</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span> </div><div class="line"><a name="l00054"></a><span class="lineno"><a class="line" href="structmbedtls__timing__delay__context.html"> 54</a></span> <span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span> {</div><div class="line"><a name="l00056"></a><span class="lineno"><a class="line" href="structmbedtls__timing__delay__context.html#abf629e677a656c08a5aa3e5ba0cbf2d5"> 56</a></span>  <span class="keyword">struct </span><a class="code" href="structmbedtls__timing__hr__time.html">mbedtls_timing_hr_time</a> timer;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="structmbedtls__timing__delay__context.html#a9887c5bc1eb16059afbc163052ca1cb8"> 57</a></span>  uint32_t <a class="code" href="structmbedtls__timing__delay__context.html#a9887c5bc1eb16059afbc163052ca1cb8">int_ms</a>;</div><div class="line"><a name="l00058"></a><span class="lineno"><a class="line" href="structmbedtls__timing__delay__context.html#af31d3fb6212e38581dbe3b97afc45f55"> 58</a></span>  uint32_t <a class="code" href="structmbedtls__timing__delay__context.html#af31d3fb6212e38581dbe3b97afc45f55">fin_ms</a>;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> } <a class="code" href="structmbedtls__timing__delay__context.html">mbedtls_timing_delay_context</a>;</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="keyword">extern</span> <span class="keyword">volatile</span> <span class="keywordtype">int</span> <a class="code" href="timing_8h.html#af5df1e20d5197a5af9f5daba5b6ca654">mbedtls_timing_alarmed</a>;</div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div><div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="timing_8h.html#aeec9ae2577ce34ab01f2d213b99d07e1">mbedtls_timing_hardclock</a>( <span class="keywordtype">void</span> );</div><div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <a class="code" href="timing_8h.html#a427660928e1e0339d497390c167f895c">mbedtls_timing_get_timer</a>( <span class="keyword">struct</span> <a class="code" href="structmbedtls__timing__hr__time.html">mbedtls_timing_hr_time</a> *val, <span class="keywordtype">int</span> reset );</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span> </div><div class="line"><a name="l00104"></a><span class="lineno"> 104</span> <span class="keywordtype">void</span> <a class="code" href="timing_8h.html#a7ea7574e836da0dc51b4b16c4033ede3">mbedtls_set_alarm</a>( <span class="keywordtype">int</span> seconds );</div><div class="line"><a name="l00105"></a><span class="lineno"> 105</span> </div><div class="line"><a name="l00120"></a><span class="lineno"> 120</span> <span class="keywordtype">void</span> <a class="code" href="timing_8h.html#aeb3497ab85adabf7db89d81c34e2ef92">mbedtls_timing_set_delay</a>( <span class="keywordtype">void</span> *data, uint32_t int_ms, uint32_t fin_ms );</div><div class="line"><a name="l00121"></a><span class="lineno"> 121</span> </div><div class="line"><a name="l00134"></a><span class="lineno"> 134</span> <span class="keywordtype">int</span> <a class="code" href="timing_8h.html#afb1705e8c4227b0ec03089aa7fc54d9b">mbedtls_timing_get_delay</a>( <span class="keywordtype">void</span> *data );</div><div class="line"><a name="l00135"></a><span class="lineno"> 135</span> </div><div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00137"></a><span class="lineno"> 137</span> }</div><div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00139"></a><span class="lineno"> 139</span> </div><div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="preprocessor">#else </span><span class="comment">/* MBEDTLS_TIMING_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="preprocessor">#include "timing_alt.h"</span></div><div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="preprocessor">#endif </span><span class="comment">/* MBEDTLS_TIMING_ALT */</span><span class="preprocessor"></span></div><div class="line"><a name="l00143"></a><span class="lineno"> 143</span> </div><div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {</div><div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00147"></a><span class="lineno"> 147</span> </div><div class="line"><a name="l00148"></a><span class="lineno"> 148</span> <span class="preprocessor">#if defined(MBEDTLS_SELF_TEST)</span></div><div class="line"><a name="l00149"></a><span class="lineno"> 149</span> </div><div class="line"><a name="l00154"></a><span class="lineno"> 154</span> <span class="keywordtype">int</span> <a class="code" href="timing_8h.html#aa832a2e14723215d909150c337199f53">mbedtls_timing_self_test</a>( <span class="keywordtype">int</span> verbose );</div><div class="line"><a name="l00155"></a><span class="lineno"> 155</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00156"></a><span class="lineno"> 156</span> </div><div class="line"><a name="l00157"></a><span class="lineno"> 157</span> <span class="preprocessor">#ifdef __cplusplus</span></div><div class="line"><a name="l00158"></a><span class="lineno"> 158</span> }</div><div class="line"><a name="l00159"></a><span class="lineno"> 159</span> <span class="preprocessor">#endif</span></div><div class="line"><a name="l00160"></a><span class="lineno"> 160</span> </div><div class="line"><a name="l00161"></a><span class="lineno"> 161</span> <span class="preprocessor">#endif </span><span class="comment">/* timing.h */</span><span class="preprocessor"></span></div><div class="ttc" id="structmbedtls__timing__delay__context_html_a9887c5bc1eb16059afbc163052ca1cb8"><div class="ttname"><a href="structmbedtls__timing__delay__context.html#a9887c5bc1eb16059afbc163052ca1cb8">mbedtls_timing_delay_context::int_ms</a></div><div class="ttdeci">uint32_t int_ms</div><div class="ttdef"><b>Definition:</b> <a href="timing_8h_source.html#l00057">timing.h:57</a></div></div>
<div class="ttc" id="timing_8h_html_aeec9ae2577ce34ab01f2d213b99d07e1"><div class="ttname"><a href="timing_8h.html#aeec9ae2577ce34ab01f2d213b99d07e1">mbedtls_timing_hardclock</a></div><div class="ttdeci">unsigned long mbedtls_timing_hardclock(void)</div><div class="ttdoc">Return the CPU cycle counter value. </div></div>
<div class="ttc" id="structmbedtls__timing__hr__time_html_a5ad2da97c4ec844c558bb9a49d62ba2f"><div class="ttname"><a href="structmbedtls__timing__hr__time.html#a5ad2da97c4ec844c558bb9a49d62ba2f">mbedtls_timing_hr_time::opaque</a></div><div class="ttdeci">unsigned char opaque[32]</div><div class="ttdef"><b>Definition:</b> <a href="timing_8h_source.html#l00048">timing.h:48</a></div></div>
<div class="ttc" id="config_8h_html"><div class="ttname"><a href="config_8h.html">config.h</a></div><div class="ttdoc">Configuration options (set of defines) </div></div>
<div class="ttc" id="timing_8h_html_aeb3497ab85adabf7db89d81c34e2ef92"><div class="ttname"><a href="timing_8h.html#aeb3497ab85adabf7db89d81c34e2ef92">mbedtls_timing_set_delay</a></div><div class="ttdeci">void mbedtls_timing_set_delay(void *data, uint32_t int_ms, uint32_t fin_ms)</div><div class="ttdoc">Set a pair of delays to watch (See mbedtls_timing_get_delay().) </div></div>
<div class="ttc" id="structmbedtls__timing__delay__context_html_af31d3fb6212e38581dbe3b97afc45f55"><div class="ttname"><a href="structmbedtls__timing__delay__context.html#af31d3fb6212e38581dbe3b97afc45f55">mbedtls_timing_delay_context::fin_ms</a></div><div class="ttdeci">uint32_t fin_ms</div><div class="ttdef"><b>Definition:</b> <a href="timing_8h_source.html#l00058">timing.h:58</a></div></div>
<div class="ttc" id="structmbedtls__timing__delay__context_html"><div class="ttname"><a href="structmbedtls__timing__delay__context.html">mbedtls_timing_delay_context</a></div><div class="ttdoc">Context for mbedtls_timing_set/get_delay() </div><div class="ttdef"><b>Definition:</b> <a href="timing_8h_source.html#l00054">timing.h:54</a></div></div>
<div class="ttc" id="timing_8h_html_af5df1e20d5197a5af9f5daba5b6ca654"><div class="ttname"><a href="timing_8h.html#af5df1e20d5197a5af9f5daba5b6ca654">mbedtls_timing_alarmed</a></div><div class="ttdeci">volatile int mbedtls_timing_alarmed</div></div>
<div class="ttc" id="timing_8h_html_a7ea7574e836da0dc51b4b16c4033ede3"><div class="ttname"><a href="timing_8h.html#a7ea7574e836da0dc51b4b16c4033ede3">mbedtls_set_alarm</a></div><div class="ttdeci">void mbedtls_set_alarm(int seconds)</div><div class="ttdoc">Setup an alarm clock. </div></div>
<div class="ttc" id="timing_8h_html_aa832a2e14723215d909150c337199f53"><div class="ttname"><a href="timing_8h.html#aa832a2e14723215d909150c337199f53">mbedtls_timing_self_test</a></div><div class="ttdeci">int mbedtls_timing_self_test(int verbose)</div><div class="ttdoc">Checkup routine. </div></div>
<div class="ttc" id="timing_8h_html_a427660928e1e0339d497390c167f895c"><div class="ttname"><a href="timing_8h.html#a427660928e1e0339d497390c167f895c">mbedtls_timing_get_timer</a></div><div class="ttdeci">unsigned long mbedtls_timing_get_timer(struct mbedtls_timing_hr_time *val, int reset)</div><div class="ttdoc">Return the elapsed time in milliseconds. </div></div>
<div class="ttc" id="structmbedtls__timing__hr__time_html"><div class="ttname"><a href="structmbedtls__timing__hr__time.html">mbedtls_timing_hr_time</a></div><div class="ttdoc">timer structure </div><div class="ttdef"><b>Definition:</b> <a href="timing_8h_source.html#l00046">timing.h:46</a></div></div>
<div class="ttc" id="timing_8h_html_afb1705e8c4227b0ec03089aa7fc54d9b"><div class="ttname"><a href="timing_8h.html#afb1705e8c4227b0ec03089aa7fc54d9b">mbedtls_timing_get_delay</a></div><div class="ttdeci">int mbedtls_timing_get_delay(void *data)</div><div class="ttdoc">Get the status of delays (Memory helper: number of delays passed.) </div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Tue May 8 2018 21:08:41 for mbed TLS v2.7.3 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
