esos/include/esos.h File Reference

#include "all_generic.h"
#include "esos_task.h"
#include "esos_comm.h"
#include "esos_irq.h"

Detailed Description

Embedded Systems Operating System (ESOS)

Definition in file esos.h.

Define Documentation

#define esos_ClearUserFlag ( mask )

Clears bits in the global user flags provided by ESOS

Parameters:

mask

An uint16 value composed of the OR-ed user mask flag masks, where each flag in the OR will be cleared

Note:

User should use the provided bits masks like ESOS_USER_FLAG_0 and ESOS_USER_FLAG_1 and ... ESOS_USER_FLAG_F to create their own readable constants

 #define HEADLIGHTS_ARE_ON         ESOS_USER_FLAG_3
 #define MY_USER_FRIENDLY_FLAG     ESOS_USER_FLAG_7
 esos_ClearUserFlag( HEADLIGHTS_ARE_ON | MY_USER_FRIENDLY_FLAG);

See also:

esos_SetUserFlag

esos_IsUserFlagSet

esos_IsUserFlagClear

Definition at line 328 of file esos.h.

#define esos_GetFutureSystemTick ( deltaT )

Returns the system tick value of a future time

Parameters:

deltaT

the number of ticks in the future you'd like the system tick value for

Returns:: The uint32 number corresponding to the system tick value of that future time

See also:: esos_GetSystemTick

Definition at line 290 of file esos.h.

#define esos_GetNumberRegisteredTasks ( )

Get the current number of user task registered with the ESOS scheduler.

Returns:: The uint8 number of currently registered user tasks

Note:: This value does not include the number of child tasks (tasks of the type ESOS_CHILD_TASK ), just the tasks of the type ESOS_USER_TASK

Definition at line 279 of file esos.h.

#define esos_GetNumberRunningTimers ( )

Get the current number of user software timers registers (running) in the ESOS timer services

Returns:: The uint8 number of currently registered user tasks

Definition at line 391 of file esos.h.

#define esos_GetSystemTick ( )

Get the current value of the ESOS system tick counter In the current implementation of ESOS, a tick equal 1.0ms. Therefore, the value returned by this function is approximately equal to the number of milliseconds since the since was last reset.

Returns:: The uint32 value of current value of the ESOS system tick counter

Note:: This counter value will roll-over every 49.7 days.

Definition at line 256 of file esos.h.

#define esos_IsTimerRunning ( hndl )

Determines if the software timer represented by the handle is currently running

Parameters:

hndl

The ESOS_TMR_HANDLE of a software timer

Return values:

	TRUE	if the timer is currently running
	FALSE	if the timer is not currently running

See also:

ESOS_USER_TIMER

esos_UnregisterTimer

esos_GetTimerHandle

esos_ChangeTimerPeriod

Definition at line 404 of file esos.h.

#define esos_IsUserFlagClear ( mask )

Queries whether the global user flags provided by ESOS are clear

Parameters:

mask

An uint16 value composed of the OR-ed user mask flag masks, where each flag in the OR will be checked for being clear

Return values:

	TRUE	if at least one of the flags is clear
	FALSE	if none of the flags are clear

Note:

User should use the provided bits masks like ESOS_USER_FLAG_0 and ESOS_USER_FLAG_1 and ... ESOS_USER_FLAG_F to create their own readable constants

 #define HEADLIGHTS_ARE_ON         ESOS_USER_FLAG_3
 #define MY_USER_FRIENDLY_FLAG     ESOS_USER_FLAG_7
 esos_ClearUserFlag( HEADLIGHTS_ARE_ON | MY_USER_FRIENDLY_FLAG);
 while(esos_IsUserFlagClear( HEADLIGHTS_ARE_ON));  // infinite loop

See also:

esos_SetUserFlag

esos_ClearUserFlag

esos_IsUserFlagSet

Definition at line 372 of file esos.h.

#define esos_IsUserFlagSet ( mask )

Queries whether the global user flags provided by ESOS are set

Parameters:

mask

An uint16 value composed of the OR-ed user mask flag masks, where each flag in the OR will be checked for being set

Return values:

	TRUE	if at least one of the flags is set
	FALSE	if none of the flags are set

Note:

User should use the provided bits masks like ESOS_USER_FLAG_0 and ESOS_USER_FLAG_1 and ... ESOS_USER_FLAG_F to create their own readable constants

 #define HEADLIGHTS_ARE_ON         ESOS_USER_FLAG_3
 #define MY_USER_FRIENDLY_FLAG     ESOS_USER_FLAG_7
 esos_ClearUserFlag( HEADLIGHTS_ARE_ON | MY_USER_FRIENDLY_FLAG);
 while(esos_IsUserFlagSet( HEADLIGHTS_ARE_ON));  // falls through

See also:

esos_SetUserFlag

esos_ClearUserFlag

esos_IsUserFlagClear

Definition at line 350 of file esos.h.

#define esos_SetUserFlag ( mask )

Sets bits in the global user flags provided by ESOS

Parameters:

mask

An uint16 value composed of the OR-ed user mask flag masks, where each flag in the OR will be set

Note:

User should use the provided bits masks like ESOS_USER_FLAG_0 to create their own readable constants

 #define HEADLIGHTS_ARE_ON         ESOS_USER_FLAG_3
 #define MY_USER_FRIENDLY_FLAG     ESOS_USER_FLAG_7
 esos_SetUserFlag( HEADLIGHTS_ARE_ON | MY_USER_FRIENDLY_FLAG);

See also:

esos_ClearUserFlag

esos_IsUserFlagSet

esos_IsUserFlagClear

Definition at line 308 of file esos.h.

#define ESOS_USER_FLAG_0