<!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.5"/>
<title>PolarSSL v1.3.8: timing.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="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 style="padding-left: 0.5em;">
<div id="projectname">PolarSSL v1.3.8
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_6a9bbd12bf4e19a18c45e270f8fae3fd.html">include</a></li><li class="navelem"><a class="el" href="dir_04272d44da4745cf8b8bfc767d6c6523.html">polarssl</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#func-members">Functions</a> |
<a href="#var-members">Variables</a> </div>
<div class="headertitle">
<div class="title">timing.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Portable interface to the CPU cycle counter.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include "<a class="el" href="config_8h_source.html">config.h</a>"</code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for timing.h:</div>
<div class="dyncontent">
<div class="center"><img src="timing_8h__incl.png" border="0" usemap="#timing_8h" alt=""/></div>
<map name="timing_8h" id="timing_8h">
</map>
</div>
</div>
<p><a href="timing_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 name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structhr__time.html">hr_time</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">timer structure <a href="structhr__time.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a1bd62cd344b57b3239087cd8f11f9793"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#a1bd62cd344b57b3239087cd8f11f9793">hardclock</a> (void)</td></tr>
<tr class="memdesc:a1bd62cd344b57b3239087cd8f11f9793"><td class="mdescLeft"> </td><td class="mdescRight">Return the CPU cycle counter value. <a href="#a1bd62cd344b57b3239087cd8f11f9793">More...</a><br/></td></tr>
<tr class="separator:a1bd62cd344b57b3239087cd8f11f9793"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2ec17acf139f35dd91410755c6b124ff"><td class="memItemLeft" align="right" valign="top">unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#a2ec17acf139f35dd91410755c6b124ff">get_timer</a> (struct <a class="el" href="structhr__time.html">hr_time</a> *val, int reset)</td></tr>
<tr class="memdesc:a2ec17acf139f35dd91410755c6b124ff"><td class="mdescLeft"> </td><td class="mdescRight">Return the elapsed time in milliseconds. <a href="#a2ec17acf139f35dd91410755c6b124ff">More...</a><br/></td></tr>
<tr class="separator:a2ec17acf139f35dd91410755c6b124ff"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a940cbcc4a316f194ae7f9812b0360bba"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#a940cbcc4a316f194ae7f9812b0360bba">set_alarm</a> (int seconds)</td></tr>
<tr class="memdesc:a940cbcc4a316f194ae7f9812b0360bba"><td class="mdescLeft"> </td><td class="mdescRight">Setup an alarm clock. <a href="#a940cbcc4a316f194ae7f9812b0360bba">More...</a><br/></td></tr>
<tr class="separator:a940cbcc4a316f194ae7f9812b0360bba"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7926912635a914e5e14c8aa543bf6a00"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#a7926912635a914e5e14c8aa543bf6a00">m_sleep</a> (int milliseconds)</td></tr>
<tr class="memdesc:a7926912635a914e5e14c8aa543bf6a00"><td class="mdescLeft"> </td><td class="mdescRight">Sleep for a certain amount of time. <a href="#a7926912635a914e5e14c8aa543bf6a00">More...</a><br/></td></tr>
<tr class="separator:a7926912635a914e5e14c8aa543bf6a00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adaed3c7084ac1a7b753e683cea58f42c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#adaed3c7084ac1a7b753e683cea58f42c">timing_self_test</a> (int verbose)</td></tr>
<tr class="memdesc:adaed3c7084ac1a7b753e683cea58f42c"><td class="mdescLeft"> </td><td class="mdescRight">Checkup routine. <a href="#adaed3c7084ac1a7b753e683cea58f42c">More...</a><br/></td></tr>
<tr class="separator:adaed3c7084ac1a7b753e683cea58f42c"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="var-members"></a>
Variables</h2></td></tr>
<tr class="memitem:a0dbcdd16cf86ffb66a016f3acf2b6cbc"><td class="memItemLeft" align="right" valign="top">volatile int </td><td class="memItemRight" valign="bottom"><a class="el" href="timing_8h.html#a0dbcdd16cf86ffb66a016f3acf2b6cbc">alarmed</a></td></tr>
<tr class="separator:a0dbcdd16cf86ffb66a016f3acf2b6cbc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Portable interface to the CPU cycle counter. </p>
<p>Copyright (C) 2006-2014, Brainspark B.V.</p>
<p>This file is part of PolarSSL (<a href="http://www.polarssl.org">http://www.polarssl.org</a>) Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org></p>
<p>All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.</p>
<p>This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.</p>
<p>You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. </p>
<p>Definition in file <a class="el" href="timing_8h_source.html">timing.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="a2ec17acf139f35dd91410755c6b124ff"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long get_timer </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structhr__time.html">hr_time</a> * </td>
<td class="paramname"><em>val</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>reset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the elapsed time in milliseconds. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">val</td><td>points to a timer structure </td></tr>
<tr><td class="paramname">reset</td><td>if set to 1, the timer is restarted </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a1bd62cd344b57b3239087cd8f11f9793"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned long hardclock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the CPU cycle counter value. </p>
</div>
</div>
<a class="anchor" id="a7926912635a914e5e14c8aa543bf6a00"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void m_sleep </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>milliseconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sleep for a certain amount of time. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">milliseconds</td><td>delay in milliseconds </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a940cbcc4a316f194ae7f9812b0360bba"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void set_alarm </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>seconds</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Setup an alarm clock. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">seconds</td><td>delay before the "alarmed" flag is set </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="adaed3c7084ac1a7b753e683cea58f42c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int timing_self_test </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>verbose</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checkup routine. </p>
<dl class="section return"><dt>Returns</dt><dd>0 if successful, or 1 if a test failed </dd></dl>
</div>
</div>
<h2 class="groupheader">Variable Documentation</h2>
<a class="anchor" id="a0dbcdd16cf86ffb66a016f3acf2b6cbc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">volatile int alarmed</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Thu Jul 31 2014 11:35:56 for PolarSSL v1.3.8 by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
