src/libpolarssl/timing.h

   1 /**
   2  * \file timing.h
   3  *
   4  * \brief Portable interface to the CPU cycle counter
   5  *
   6  *  Copyright (C) 2006-2014, Brainspark B.V.
   7  *
   8  *  This file is part of PolarSSL (http://www.polarssl.org)
   9  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
  10  *
  11  *  All rights reserved.
  12  *
  13  *  This program is free software; you can redistribute it and/or modify
  14  *  it under the terms of the GNU General Public License as published by
  15  *  the Free Software Foundation; either version 2 of the License, or
  16  *  (at your option) any later version.
  17  *
  18  *  This program is distributed in the hope that it will be useful,
  19  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  *  GNU General Public License for more details.
  22  *
  23  *  You should have received a copy of the GNU General Public License along
  24  *  with this program; if not, write to the Free Software Foundation, Inc.,
  25  *  51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  26  */
  27 #ifndef POLARSSL_TIMING_H
  28 #define POLARSSL_TIMING_H
  29
  30 #if !defined(POLARSSL_CONFIG_FILE)
  31 #include "config.h"
  32 #else
  33 #include POLARSSL_CONFIG_FILE
  34 #endif
  35
  36 #if !defined(POLARSSL_TIMING_ALT)
  37 // Regular implementation
  38 //
  39
  40 #ifdef __cplusplus
  41 extern "C" {
  42 #endif
  43
  44 /**
  45  * \brief          timer structure
  46  */
  47 struct hr_time
  48 {
  49     unsigned char opaque[32];
  50 };
  51
  52 extern volatile int alarmed;
  53
  54 /**
  55  * \brief          Return the CPU cycle counter value
  56  */
  57 unsigned long hardclock( void );
  58
  59 /**
  60  * \brief          Return the elapsed time in milliseconds
  61  *
  62  * \param val      points to a timer structure
  63  * \param reset    if set to 1, the timer is restarted
  64  */
  65 unsigned long get_timer( struct hr_time *val, int reset );
  66
  67 /**
  68  * \brief          Setup an alarm clock
  69  *
  70  * \param seconds  delay before the "alarmed" flag is set
  71  */
  72 void set_alarm( int seconds );
  73
  74 /**
  75  * \brief          Sleep for a certain amount of time
  76  *
  77  * \param milliseconds  delay in milliseconds
  78  */
  79 void m_sleep( int milliseconds );
  80
  81 #if defined(POLARSSL_SELF_TEST)
  82 /**
  83  * \brief          Checkup routine
  84  *
  85  * \return         0 if successful, or 1 if a test failed
  86  */
  87 int timing_self_test( int verbose );
  88 #endif
  89
  90 #ifdef __cplusplus
  91 }
  92 #endif
  93
  94 #else  /* POLARSSL_TIMING_ALT */
  95 #include "timing_alt.h"
  96 #endif /* POLARSSL_TIMING_ALT */
  97
  98 #endif /* timing.h */