include/tropicssl/timing.h

   1 /**
   2  * \file timing.h
   3  *
   4  *  Based on XySSL: Copyright (C) 2006-2008  Christophe Devine
   5  *
   6  *  Copyright (C) 2009  Paul Bakker <polarssl_maintainer at polarssl dot org>
   7  *
   8  *  All rights reserved.
   9  *
  10  *  Redistribution and use in source and binary forms, with or without
  11  *  modification, are permitted provided that the following conditions
  12  *  are met:
  13  *
  14  *    * Redistributions of source code must retain the above copyright
  15  *      notice, this list of conditions and the following disclaimer.
  16  *    * Redistributions in binary form must reproduce the above copyright
  17  *      notice, this list of conditions and the following disclaimer in the
  18  *      documentation and/or other materials provided with the distribution.
  19  *    * Neither the names of PolarSSL or XySSL nor the names of its contributors
  20  *      may be used to endorse or promote products derived from this software
  21  *      without specific prior written permission.
  22  *
  23  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  24  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  25  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  26  *  FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  27  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  28  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
  29  *  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  30  *  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
  31  *  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
  32  *  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  33  *  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  34  */
  35 #ifndef TROPICSSL_TIMING_H
  36 #define TROPICSSL_TIMING_H
  37
  38 /**
  39  * \brief          timer structure
  40  */
  41 struct hr_time {
  42         unsigned char opaque[32];
  43 };
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49         extern volatile int alarmed;
  50
  51         /**
  52          * \brief          Return the CPU cycle counter value
  53          */
  54         unsigned long hardclock(void);
  55
  56         /**
  57          * \brief          Return the elapsed time in milliseconds
  58          *
  59          * \param val      points to a timer structure
  60          * \param reset    if set to 1, the timer is restarted
  61          */
  62         unsigned long get_timer(struct hr_time *val, int reset);
  63
  64         /**
  65          * \brief          Setup an alarm clock
  66          *
  67          * \param seconds  delay before the "alarmed" flag is set
  68          */
  69         void set_alarm(int seconds);
  70
  71         /**
  72          * \brief          Sleep for a certain amount of time
  73          */
  74         void m_sleep(int milliseconds);
  75
  76 #ifdef __cplusplus
  77 }
  78 #endif
  79 #endif                          /* timing.h */