timer.c File Reference

#include <timer.h>
#include <Hal/AA64/aa64lowlevel.h>
#include <string.h>
#include <aucon.h>
#include <Drivers/uart.h>
#include <_null.h>
#include <signal.h>

Include dependency graph for timer.c:

Classes
struct	_clock_state_

Macros
#define	ITIMER_REAL   0
#define	ITIMER_VIRTUAL   1
#define	ITIMER_PROF   2

Typedefs
typedef struct _clock_state_	AuClockState

Functions
void	AuroraTimerInitialize ()
	AuroraTimerInitialize – initialize aurora timer.
int	AuroraTimerStart (uint32_t delay_ms, AuroraTimerCallback handler, void *param, int idx)
	AuroraTimerStart – start kernel timer in one shot mode.
int	AuroraTimerStartPeriodic (uint32_t interval_ms, AuroraTimerCallback handler, void *param)
	AuroraTimerStartPeriodic – start a periodic timer.
void	AuroraTimerCancel (int tNum)
	AuroraTimerCancel – cancel a timer.
bool	AuroraTimerIsActive (int tNum)
	AuroraTimerIsActive – check if timer is active.
void	AuroraTimerTick ()
	AuroraTimerTick – called by kernel to handle all expired timers.
uint64_t	AuGetCurrentMS ()
uint64_t	AuGetCurrentUS ()
void	__kernel_timer_alarm_callback (void *param)
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

ITIMER_PROF

#define ITIMER_PROF   2

ITIMER_REAL

#define ITIMER_REAL   0

ITIMER_VIRTUAL

#define ITIMER_VIRTUAL   1

Typedef Documentation

AuClockState

typedef struct _clock_state_ AuClockState

Function Documentation

__kernel_timer_alarm_callback()

void __kernel_timer_alarm_callback

(

void *

param

)

AuGetCurrentMS()

uint64_t AuGetCurrentMS

(

)

AuGetCurrentUS()

uint64_t AuGetCurrentUS

(

)

AuGetWalltime()

void AuGetWalltime	(	int64_t *	out_sec,
		int64_t *	out_ns
	)

need credential verifications too, for security

AuroraTimerCancel()

void AuroraTimerCancel

(

int

tNum

)

AuroraTimerCancel – cancel a timer.

Parameters

tNum	– timer number

AuroraTimerInitialize()

void AuroraTimerInitialize

(

)

AuroraTimerInitialize – initialize aurora timer.

AuroraTimerIsActive()

bool AuroraTimerIsActive

(

int

tNum

)

AuroraTimerIsActive – check if timer is active.

Parameters

tNum	– timer index

AuroraTimerStart()

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()

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
	)

need credential verifications too, for security

AuTimerCalculateAlarm()

int AuTimerCalculateAlarm	(	AA64Thread *	thr,
		uint64_t	seconds
	)

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
	)

AuTimerSetITimer()

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

AuTimerSetITimer – posix standard implementation of setting periodic timer.