Chris O'Byrne - YAVRTOS

Function return values


Defines

#define YAVRTOS_OK   0
 OK.
#define YAVRTOS_INVALID_TASK   1
 Invalid task state.
#define YAVRTOS_IDLE_TASK   2
 Invalid function for idle task.
#define YAVRTOS_ISR   3
 Invalid function for an ISR.
#define YAVRTOS_TIMEOUT   4
 Timeout.
#define YAVRTOS_NOT_OWNER   5
 Not the mutex owner.
#define YAVRTOS_RTOS_NOT_STARTED   6
 RTOS not started.
#define YAVRTOS_MBOX_NOT_EMPTY   7
 Mailbox not empty.
#define YAVRTOS_ALREADY_STOPPED   8
 The task was already stopped.

Typedefs

typedef uint8_t yavrtos_result_t
 Function return value.

Define Documentation

#define YAVRTOS_ALREADY_STOPPED   8

The task was already stopped.

#define YAVRTOS_IDLE_TASK   2

Invalid function for idle task.

The function could not be performed because the task making the request is an idle task.

#define YAVRTOS_INVALID_TASK   1

Invalid task state.

The function could not be performed because the task making the request was not valid (eg a lower-priority task trying to stop a higher-priority task).

#define YAVRTOS_ISR   3

Invalid function for an ISR.

The function could not be performed because the task making the request is an ISR.

#define YAVRTOS_MBOX_NOT_EMPTY   7

Mailbox not empty.

#define YAVRTOS_NOT_OWNER   5

Not the mutex owner.

The current task doesn't own the mutex in question.

#define YAVRTOS_OK   0

OK.

The function completed successfully.

#define YAVRTOS_RTOS_NOT_STARTED   6

RTOS not started.

#define YAVRTOS_TIMEOUT   4

Timeout.

The function timed out on a timeout semaphore.


Typedef Documentation

typedef uint8_t yavrtos_result_t

Function return value.

Return value contains an error code for the function call


YAVRTOS and YAVRTOS documentation Copyright © 2007-2009 Chris O'Byrne. Email - chris <at> obyrne <dot> com