timer.h File Reference

#include <aurora.h>
#include <Hal/AA64/sched.h>

Include dependency graph for timer.h:

Go to the source code of this file.

Classes
struct	_kernel_timer_
struct	_itimerval_
struct	_timeval_t_

Macros
#define	AURORA_MAX_TIMER   32

Typedefs
typedef void(*	AuroraTimerCallback) (void *param)
typedef struct _kernel_timer_	AuKernelTimer
typedef struct _itimerval_	itimerval_t
typedef struct _timeval_t_	timeval_t

Functions
void	AuroraTimerInitialize ()
	AuroraTimerInitialize – initialize aurora timer.
AU_EXTERN AU_EXPORT int	AuroraTimerStart (uint32_t delay_ms, AuroraTimerCallback handler, void *param, int idx)
	AuroraTimerStart – start kernel timer in one shot mode.
AU_EXTERN AU_EXPORT int	AuroraTimerStartPeriodic (uint32_t interval_ms, AuroraTimerCallback handler, void *param)
	AuroraTimerStartPeriodic – start a periodic timer.
AU_EXTERN AU_EXPORT bool	AuroraTimerIsActive (int tNum)
	AuroraTimerIsActive – check if timer is active.
AU_EXTERN AU_EXPORT void	AuroraTimerCancel (int tNum)
	AuroraTimerCancel – cancel a timer.
void	AuroraTimerTick ()
	AuroraTimerTick – called by kernel to handle all expired timers.
AU_EXTERN AU_EXPORT uint64_t	AuGetCurrentMS ()
AU_EXTERN AU_EXPORT uint64_t	AuGetCurrentUS ()
int	AuTimerCalculateAlarm (AA64Thread *thr, uint64_t seconds)
	AuTimerCalculateAlarm – schedule a timer to one-shot mode respective to given seconds.
int	AuTimerSetITimer (AA64Thread *thr, int which, const itimerval_t *newval, itimerval_t *oldval)
	AuTimerSetITimer – posix standard implementation of setting periodic timer.
int	AuTimerGetITimer (AA64Thread *thr, int which, itimerval_t *curr_value)
void	AuSetWalltime (int64_t sec, int64_t nsec)
void	AuGetWalltime (int64_t *out_sec, int64_t *out_ns)

Detailed Description

BSD 2-Clause License

Copyright (c) 2022-2023, Manas Kamal Choudhury All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Macro Definition Documentation

AURORA_MAX_TIMER

#define AURORA_MAX_TIMER   32

Typedef Documentation

AuKernelTimer

typedef struct _kernel_timer_ AuKernelTimer

AuroraTimerCallback

typedef void(* AuroraTimerCallback) (void *param)

itimerval_t

typedef struct _itimerval_ itimerval_t

timeval_t

typedef struct _timeval_t_ timeval_t

Function Documentation

AuGetCurrentMS()

AU_EXTERN AU_EXPORT uint64_t AuGetCurrentMS

(

)

AuGetCurrentUS()

AU_EXTERN AU_EXPORT uint64_t AuGetCurrentUS

(

)

AuGetWalltime()

void AuGetWalltime ( int64_t *  out_sec, int64_t *  out_ns  )

extern

need credential verifications too, for security

AuroraTimerCancel()

AU_EXTERN AU_EXPORT void AuroraTimerCancel

(

int

tNum

)

AuroraTimerCancel – cancel a timer.

Parameters

tNum	– timer number

AuroraTimerInitialize()

void AuroraTimerInitialize ( )

extern

AuroraTimerInitialize – initialize aurora timer.

AuroraTimerIsActive()

AU_EXTERN AU_EXPORT bool AuroraTimerIsActive

(

int

tNum

)

AuroraTimerIsActive – check if timer is active.

Parameters

tNum	– timer index

AuroraTimerStart()

AU_EXTERN AU_EXPORT int AuroraTimerStart	(	uint32_t	delay_ms,
		AuroraTimerCallback	handler,
		void *	param,
		int	idx
	)

AuroraTimerStart – start kernel timer in one shot mode.

Parameters

delay_ms	– at what millisecond it should fire from now
handler	– handler function
param	– extra param data to pass to handler

AuroraTimerStartPeriodic()

AU_EXTERN AU_EXPORT int AuroraTimerStartPeriodic	(	uint32_t	interval_ms,
		AuroraTimerCallback	handler,
		void *	param
	)

AuroraTimerStartPeriodic – start a periodic timer.

Parameters

interval_ms	– interval between one shot to another shot
handler	– handler function
param	– extra data to pass to handler

AuroraTimerTick()

void AuroraTimerTick

(

)

AuroraTimerTick – called by kernel to handle all expired timers.

AuSetWalltime()

void AuSetWalltime ( int64_t  sec, int64_t  nsec  )

extern

need credential verifications too, for security

AuTimerCalculateAlarm()

int AuTimerCalculateAlarm ( AA64Thread *  thr, uint64_t  seconds  )

extern

AuTimerCalculateAlarm – schedule a timer to one-shot mode respective to given seconds.

Parameters

thr	– pointer to thread which requires one-shot timer
seconds	– amount of second to wait

AuTimerGetITimer()

int AuTimerGetITimer ( AA64Thread *  thr, int  which, itimerval_t *  curr_value  )

extern

AuTimerSetITimer()

int AuTimerSetITimer ( AA64Thread *  thr, int  which, const itimerval_t *  newval, itimerval_t *  oldval  )

extern

AuTimerSetITimer – posix standard implementation of setting periodic timer.