A(rduino) OS
Simple Task Scheduler for Arduino Development Board
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
aos_constants.h File Reference

Provides implementation of all the enumerations and constant system specific values. More...

#include "aos_config.h"

Go to the source code of this file.

Typedefs

typedef enum _aos_hook_t aos_hook_t
 hook types enumeration More...
 
typedef enum _aos_sys_status_t aos_sys_status_t
 system status definition More...
 
typedef enum _aos_task_state_t aos_task_state_t
 possible state in which task can reside More...
 
typedef enum _aos_task_priority_t aos_task_priority_t
 predefined task priority values More...
 

Enumerations

enum  _aos_hook_t {
  AOS_HOOK_IDLE = 0, AOS_HOOK_TASK_EXIT, AOS_HOOK_STACK_CORRUPTION, AOS_HOOK_OOM,
  AOS_HOOK_RESET, AOS_HOOK_LAST
}
 hook types enumeration More...
 
enum  _aos_sys_status_t {
  AOS_SYS_UNINITIALIZED = 0, AOS_SYS_READY, AOS_SYS_RUNNING, AOS_SYS_HALTED,
  AOS_SYS_STATUS_LAST
}
 system status definition More...
 
enum  _aos_task_state_t {
  AOS_TASK_SUSPENDED = 0, AOS_TASK_READY, AOS_TASK_RUNNING, AOS_TASK_PAUZED,
  AOS_TASK_STOPPED, AOS_TASK_STATE_LAST
}
 possible state in which task can reside More...
 
enum  _aos_task_priority_t { AOS_TASK_PRIORITY_HIGH = 0, AOS_TASK_PRIORITY_NORMAL = 1, AOS_TASK_PRIORITY_LOW = 2, AOS_TASK_PRIORITY_IDLE }
 predefined task priority values More...
 

Detailed Description

Provides implementation of all the enumerations and constant system specific values.

Definition in file aos_constants.h.

Typedef Documentation

typedef enum _aos_hook_t aos_hook_t

hook types enumeration

system status definition

predefined task priority values

possible state in which task can reside

Enumeration Type Documentation

hook types enumeration

Enumerator
AOS_HOOK_IDLE 

hook executed by the idle task

AOS_HOOK_TASK_EXIT 

hook will be called every time task explicitly will end it's execution (TODO not implemented)

AOS_HOOK_STACK_CORRUPTION 

hook executed when a stack corruption is detected, this specific one, exceptionally should block

AOS_HOOK_OOM 

out of memory hook, may occur during task creation process, should block

AOS_HOOK_RESET 

reset hook - executed when watchdog resets the system, due to a hang (TODO not implemented)

AOS_HOOK_LAST 

used to determine the hook count

Definition at line 35 of file aos_constants.h.

system status definition

Enumerator
AOS_SYS_UNINITIALIZED 

aos_init has not been called yet, system is in unknown condition

AOS_SYS_READY 

aos_init has been called, system is ready

AOS_SYS_RUNNING 

aos_run has been called, tasks are running

AOS_SYS_HALTED 

system is halted due to internal error

AOS_SYS_STATUS_LAST 

used to determine the state count

Definition at line 68 of file aos_constants.h.

predefined task priority values

Enumerator
AOS_TASK_PRIORITY_HIGH 

highest possible priority - those tasks will be granted with maximum amount of quanta

AOS_TASK_PRIORITY_NORMAL 

normal task priority

AOS_TASK_PRIORITY_LOW 

low task priority

AOS_TASK_PRIORITY_IDLE 

lowest possibly priority assigned to idle task. May be used by user tasks to denote very low task importance

Definition at line 113 of file aos_constants.h.

possible state in which task can reside

Enumerator
AOS_TASK_SUSPENDED 

task has been explicitly suspended from execution - it will not be scheduled

AOS_TASK_READY 

task is ready to be executed, waiting for it's time slice

AOS_TASK_RUNNING 

task is currently running

AOS_TASK_PAUZED 

task is pauzed, it either wait's for hardware or for semaphore

AOS_TASK_STOPPED 

task has ended up, it won't be scheduled any more.

AOS_TASK_STATE_LAST 

used to count the number of stack states

Definition at line 89 of file aos_constants.h.