Yeppp!
 All Data Structures Functions Variables Typedefs Enumerations Enumerator Groups Pages
Functions

Functions

enum YepStatus yepLibrary_GetTimerTicks (Yep64u *ticks)
 Returns the number of ticks of the high-resolution system timer. More...
 
enum YepStatus yepLibrary_GetTimerFrequency (Yep64u *frequency)
 Returns the number of ticks of the system timer per second. More...
 
enum YepStatus yepLibrary_GetTimerAccuracy (Yep64u *accuracy)
 Returns the minimum time difference in nanoseconds which can be measured by the high-resolution system timer. More...
 

Detailed Description

Function Documentation

enum YepStatus yepLibrary_GetTimerTicks ( Yep64u ticks)

Returns the number of ticks of the high-resolution system timer.

Parameters
[out]ticksPointer to a variable where the number of timer ticks will be stored. If the function fails, the value of the variable at this address is not changed.
Return values
YepStatusOkThe number of timer ticks is successfully stored to the variable pointed by ticks parameter.
YepStatusNullPointerThe ticks pointer is null.
YepStatusSystemErrorAn attempt to read the high-resolution timer failed inside the OS kernel.
Examples:
Entropy.c, Polynomial.c, and SystemTimer.c.
enum YepStatus yepLibrary_GetTimerFrequency ( Yep64u frequency)

Returns the number of ticks of the system timer per second.

Parameters
[out]frequencyPointer to a variable where the number of timer ticks per second will be stored.
Return values
YepStatusOkThe number of timer ticks is successfully stored to the variable pointed by frequency parameter.
YepStatusNullPointerThe frequency pointer is null.
YepStatusSystemErrorAn attempt to query the high-resolution timer parameters failed inside the OS kernel.
Examples:
Entropy.c, Polynomial.c, and SystemTimer.c.
enum YepStatus yepLibrary_GetTimerAccuracy ( Yep64u accuracy)

Returns the minimum time difference in nanoseconds which can be measured by the high-resolution system timer.

Parameters
[out]accuracyPointer to a variable where the timer accuracy will be stored.
Return values
YepStatusOkThe accuracy of the timer is successfully stored to the variable pointed by accuracy parameter.
YepStatusNullPointerThe accuracy pointer is null.
YepStatusSystemErrorAn attempt to measure the accuracy of high-resolution timer failed inside the OS kernel.