mbed TLS library

Dependents:   HTTPClient-SSL WS_SERVER

Embed: (wiki syntax)

« Back to documentation index

timing.h File Reference

timing.h File Reference

Portable interface to the CPU cycle counter. More...

Go to the source code of this file.

Data Structures

struct  hr_time
 timer structure More...

Functions

unsigned long hardclock (void)
 Return the CPU cycle counter value.
unsigned long get_timer (struct hr_time *val, int reset)
 Return the elapsed time in milliseconds.
void set_alarm (int seconds)
 Setup an alarm clock.
void m_sleep (int milliseconds)
 Sleep for a certain amount of time.
int timing_self_test (int verbose)
 Checkup routine.

Detailed Description

Portable interface to the CPU cycle counter.

Copyright (C) 2006-2014, ARM Limited, All Rights Reserved

This file is part of mbed TLS (https://tls.mbed.org)

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.

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.

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.

Definition in file timing.h.


Function Documentation

unsigned long get_timer ( struct hr_time val,
int  reset 
)

Return the elapsed time in milliseconds.

Parameters:
valpoints to a timer structure
resetif set to 1, the timer is restarted

Definition at line 281 of file timing.c.

unsigned long hardclock ( void   )

Return the CPU cycle counter value.

Definition at line 87 of file timing.c.

void m_sleep ( int  milliseconds )

Sleep for a certain amount of time.

Parameters:
millisecondsdelay in milliseconds

Definition at line 303 of file timing.c.

void set_alarm ( int  seconds )

Setup an alarm clock.

Parameters:
secondsdelay before the "alarmed" flag is set
Warning:
Only one alarm at a time is supported. In a threaded context, this means one for the whole process, not one per thread.

Definition at line 316 of file timing.c.

int timing_self_test ( int  verbose )

Checkup routine.

Returns:
0 if successful, or 1 if a test failed

Definition at line 368 of file timing.c.