NetBurner 3.3
NBRTOS Real Time Operating System

Modules

 NBRTOS Error Codes
 
 NBRTOS Task Status
 

Classes

class  TickTimeout
 TickTimeouts are used to facilitate sequential function calls with timeout parameters that need to index from an initial start time and be proof against TimeTick rollover. More...
 
class  OS_SEM
 Semaphores are used to control access to shared resource critical section, or to communicate between tasks. More...
 
class  OS_MBOX
 Mailboxes are used to communicate between tasks. More...
 
class  OS_Q
 A queue functions as a fixed size FIFO for communication between tasks. More...
 
class  OS_FIFO
 A FIFO is used to pass structures from one task to another. Note: Structures to be passed must have an unused (void *) pointer as its first element. This precludes passing C++ objects with virtual member functions. More...
 
class  OS_CRIT
 An OS_CRIT object is used to establish critical sections of code that can only be run by one task at a time. Tasks that try to claim a critical section which is currently claimed by another task will stop and wait for that task to leave the critical section before continuing execution. More...
 
class  OS_FLAGS
 An OS_FLAGS object is used to set, clear, and pend on a set of flags that is held and maintained by the object. More...
 
class  OSLockObj
 A simple wrapper class that helps use OS locks effectively. More...
 
class  OSCriticalSectionObj
 A simple wrapper class that helps utilize OS_CRIT objects more effectively. More...
 
class  OSLockAndCritObj
 A simple wrapper class that helps utilize OS_CRIT objects to lock tasks and enter critical sections more effectively. More...
 
class  OSSpinCrit
 A simple wrapper class that uses an OS_CRIT object to try and claim a critical section, and will continue the attempt until it is able to do so. More...
 

Macros

#define WAIT_FOREVER   0
 
#define OSSimpleTaskCreatewName(x, p, n)
 This macro functions the same as OSTaskCreatewName(). More...
 

Functions

void OSFlagSet (OS_FLAGS *flags, uint32_t bits_to_set)
 This function sets the corresponding bits asserted in bits_to_set of an OS_FLAGS object pointed to by *flags. More...
 
void OSFlagClear (OS_FLAGS *flags, uint32_t bits_to_clr)
 This function clears the bits asserted in bits_to_clr of an OS_FLAGS object pointed to by *flags.. More...
 
uint8_t OSFlagPendAny (OS_FLAGS *flags, uint32_t bit_mask, uint16_t timeout)
 This function waits a number of time ticks specified by timeout until any of the flags indicated by bit_mask are set. More...
 
uint8_t OSFlagPendAnyNoWait (OS_FLAGS *flags, uint32_t bit_mask)
 This function immediately checks to see if any of the flag bits indicated by bit_mask are set; it does not wait. More...
 
uint8_t OSFlagPendAll (OS_FLAGS *flags, uint32_t bit_mask, uint16_t timeout)
 This function waits a number of time ticks specified by timeout until all the flags indicated by bit_mask are set. More...
 
uint8_t OSFlagPendAllNoWait (OS_FLAGS *flags, uint32_t bit_mask)
 This function immediately checks to see if all the flag bits indicated by bit_mask are set; it does not wait. More...
 
uint32_t OSFlagState (OS_FLAGS *flags)
 This function returns the current values of the flags stored in the OS_FLAGS object structure. More...
 
uint8_t OSTaskCreatewName (void(*task)(void *dptr), void *data, void *pstktop, void *pstkbot, uint8_t prio, const char *name)
 This function creates a new task. More...
 
void OSTimeDly (uint32_t to_count)
 Delay the task until the specified value of the system timer ticks. The number of system ticks per second is defined by the constant: TICKS_PER_SECOND in <nburn_install>/nbrtos/include/constants.h. The default value is 20 ticks per second. More...
 
void OSTaskDelete (void)
 This function deletes the current calling task, but we do not recommend the use of this function because it can cause memory leaks. More...
 
uint8_t OSChangePrio (uint32_t newp)
 This function changes the priority of the calling task. More...
 
void OSLock (void)
 Calling the OSLock function will prevent the OS from changing tasks. More...
 
void OSUnlock (void)
 This function unlocks the OS. More...
 
uint8_t OSSemInit (OS_SEM *psem, long value)
 Initializes a semaphore. More...
 
uint8_t OSSemPost (OS_SEM *psem)
 Increases the value of the semaphore by one. Note: If any higher priority tasks were waiting on the semaphore - it releases them. More...
 
uint8_t OSSemPend (OS_SEM *psem, uint16_t timeout)
 Wait timeout ticks for the value of the semaphore to be non zero. Note: A timeout value of 0 (zero) waits forever. More...
 
uint8_t OSSemPendNoWait (OS_SEM *psem)
 OSSemPendNoWait() is identical to OSSemPend(), but it does not wait. More...
 
uint8_t OSMboxInit (OS_MBOX *pmbox, void *msg)
 This function is used to initialize an OS_MBOX structure. More...
 
uint8_t OSMboxPost (OS_MBOX *pmbox, void *msg)
 This function posts a message to a Mail box. More...
 
void * OSMboxPend (OS_MBOX *pmbox, uint16_t timeout, uint8_t *err)
 Wait timeout ticks for some other task to post to the Mailbox. More...
 
void * OSMboxPendNoWait (OS_MBOX *pmbox, uint8_t *err)
 OSMboxPendNoWait() is identical to OSMboxPend(), but it does not wait. More...
 
uint8_t OSQInit (OS_Q *pq, void **start, uint8_t size)
 A queue functions as a fixed size FIFO for communication between tasks. This function initializes an OS_Q structure. More...
 
uint8_t OSQPost (OS_Q *pq, void *msg)
 This function posts a message to a Queue. More...
 
uint8_t OSQPostFirst (OS_Q *pq, void *msg)
 This function posts a message like OSQPost, but posts the message at the head of the queue. More...
 
uint8_t OSQPostUnique (OS_Q *pq, void *msg)
 This function posts a message like OSQPost, but only if the message isn't already in the queue The function performs a brute force check to see if the message is already in the queue. More...
 
uint8_t OSQPostUniqueFirst (OS_Q *pq, void *msg)
 This function posts a message like OSQPostFirst, but only if the message isn't already in the queue The function performs a brute force check to see if the message is already in the queue. More...
 
void * OSQPend (OS_Q *pq, uint16_t timeout, uint8_t *err)
 Wait timeout ticks for another task to post to the queue. More...
 
void * OSQPendNoWait (OS_Q *pq, uint8_t *err)
 OSQPendNoWait() is identical to the OSQPend() function but it does not wait. More...
 
uint8_t OSFifoInit (OS_FIFO *pFifo)
 Initialize a FIFO, which is used to pass structures from one task to another. More...
 
uint8_t OSFifoPost (OS_FIFO *pFifo, OS_FIFO_EL *pToPost)
 This function posts to a FIFO. More...
 
uint8_t OSFifoPostFirst (OS_FIFO *pFifo, OS_FIFO_EL *pToPost)
 This function is identical to OSFifoPost(), but the element posted is put at the beginning of the FIFO list. More...
 
OS_FIFO_EL * OSFifoPend (OS_FIFO *pFifo, uint16_t timeout)
 This function pends on a FIFO. More...
 
OS_FIFO_EL * OSFifoPendNoWait (OS_FIFO *pFifo)
 This function is identical to the OSFifoPen() function, but it does not wait. More...
 
uint8_t OSCritInit (OS_CRIT *pCrit)
 This function initializes the critical section. More...
 
uint8_t OSCritEnter (OS_CRIT *pCrit, uint16_t timeout)
 This function tries to enter or claim the critical section. More...
 
uint8_t OSCritEnterNoWait (OS_CRIT *pCrit)
 This function tries to enter or claim the critical section. More...
 
uint8_t OSCritLeave (OS_CRIT *pCrit)
 This function releases the critical section. More...
 
void OSChangeTaskDly (uint16_t task_prio, uint32_t to_count)
 This function allows the User to modify the timeout delay for a task that is waiting. More...
 
void OSDumpTCBStacks (void)
 This function dumps information about the UCOS stacks and tasks to stdout. This function is useful for debugging. Note: This function is only valid when NBRTOS_STACKCHECK is defined. More...
 
void OSDumpTasks (void)
 This function dumps the state and call stack for every task to stdout. This function is useful for debugging. Note: This function is only valid when NBRTOS_STACKCHECK is defined. More...
 
void ShowTaskList (void)
 This functions dumps the current RTOS task states to stdio. More...
 

Detailed Description

The NetBurner Real-Time OS

Macro Definition Documentation

◆ OSSimpleTaskCreatewName

#define OSSimpleTaskCreatewName (   x,
  p,
 
)
Value:
{ \
static uint32_t func_##x_Stk[USER_TASK_STK_SIZE] __attribute__((aligned(4))); \
OSTaskCreatewName(x, NULL, (void *)&func_##x_Stk[USER_TASK_STK_SIZE], (void *)func_##x_Stk, p, n); \
}

This macro functions the same as OSTaskCreatewName().

Parameters
xThe address of the function where this task will start executing.
pThe priority for this new task (OS_MAX_PRIOS is lowest priority and 1 is highest). Look in <nburn_install>/nbrtos/include/constants.h to see which priorities are used by the OS.
nThe optional name of the task.
See also
OSTaskCreatewName()
OSTaskDelete()
OSChangePrio()

◆ WAIT_FOREVER

#define WAIT_FOREVER   0

Can be used for parameters that have a 0 value

Function Documentation

◆ OSChangePrio()

uint8_t OSChangePrio ( uint32_t  newp)

This function changes the priority of the calling task.

Note: The uC/OS can only have one task at each priority level. Task priorities can range from 1 to OS_MAX_PRIOS, where OS_MAX_PRIOS is the lowest priority level and 1 is highest priority level. Priorities 1-4 and the NetBurner system priority levels are reserved as described below. The recommended user priority levels for your application are in the range of 46 to OS_MAX_PRIOS-1. This avoids any conflicts with network communications.

System priorities are defined in <nburn_install>/nbrtos/include/constants.h for all platforms.

Parameters
newpThe new priority of the calling task
Return values
OS_NO_ERRIf successful
OS_PRIO_EXISTIf the requested priority already exists
See also
NBRTOS Error Codes
OSTaskCreatewName()

◆ OSChangeTaskDly()

void OSChangeTaskDly ( uint16_t  task_prio,
uint32_t  to_count 
)
inline

This function allows the User to modify the timeout delay for a task that is waiting.

Warning: Use of this function is discouraged.

Parameters
task_prioThe task's priority
to_countThe new number of ticks to delay
Returns
Nothing
See also
OSTimeDly() - Delay or Sleep for a fixed interval

◆ OSCritEnter()

uint8_t OSCritEnter ( OS_CRIT pCrit,
uint16_t  timeout 
)
inline

This function tries to enter or claim the critical section.

Parameters
pCritA pointer to the critical section.
timeoutHow many time ticks do we want to wait for this critical section? Note: A timeout of 0 (zero) waits forever.
Returns
OS_NO_ERR - If we were successful in claiming the critical section, or if our task owns it
OS_TIMEOUT - If we were unable to claim the section
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_CRIT for current usage.

◆ OSCritEnterNoWait()

uint8_t OSCritEnterNoWait ( OS_CRIT pCrit)
inline

This function tries to enter or claim the critical section.

Parameters
pCritA pointer to the critical section.
Returns
OS_NO_ERR - If we were successful in claiming the critical section, or if our task owns it
OS_TIMEOUT - If we were unable to claim the section
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_CRIT for current usage.

◆ OSCritInit()

uint8_t OSCritInit ( OS_CRIT pCrit)
inline

This function initializes the critical section.

Parameters
pCritA pointer to the critical section.
Returns
OS_NO_ERR - If successful
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_CRIT for current usage.

◆ OSCritLeave()

uint8_t OSCritLeave ( OS_CRIT pCrit)
inline

This function releases the critical section.

Parameters
pCritA pointer to the critical section we want to leave/release.
Returns
OS_NO_ERR - If we were successful in releasing the critical section
OS_CRIT_ERR - If we are trying to release a critical section that we do not own
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_CRIT for current usage.

◆ OSDumpTasks()

void OSDumpTasks ( void  )

This function dumps the state and call stack for every task to stdout. This function is useful for debugging. Note: This function is only valid when NBRTOS_STACKCHECK is defined.

See also
OSDumpTCBStacks()

◆ OSDumpTCBStacks()

void OSDumpTCBStacks ( void  )

This function dumps information about the UCOS stacks and tasks to stdout. This function is useful for debugging. Note: This function is only valid when NBRTOS_STACKCHECK is defined.

See also
OSDumpTasks()

◆ OSFifoInit()

uint8_t OSFifoInit ( OS_FIFO pFifo)
inline

Initialize a FIFO, which is used to pass structures from one task to another.

Parameters
pFifoA pointer to an OS_FIFO structure.
Returns
OS_NO_ERR - If successful
OS_CRIT_ERR - If pFifo is NULL
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_FIFO for current usage.

◆ OSFifoPend()

OS_FIFO_EL* OSFifoPend ( OS_FIFO pFifo,
uint16_t  timeout 
)
inline

This function pends on a FIFO.

Parameters
pFifoA pointer to an OS_FIFO structure.
timeoutThe number of ticks to wait on the FIFO.
Returns
A pointer to the posted structure if successful, or NULL if it timed out.
Deprecated:
This function is now deprecated. Please see OS_FIFO for current usage.

◆ OSFifoPendNoWait()

OS_FIFO_EL* OSFifoPendNoWait ( OS_FIFO pFifo)
inline

This function is identical to the OSFifoPen() function, but it does not wait.

Parameters
pFifoA pointer to an OS_FIFO structure.
Returns
A pointer to the posted structure if successful, or NULL if it timed out.

◆ OSFifoPost()

uint8_t OSFifoPost ( OS_FIFO pFifo,
OS_FIFO_EL *  pToPost 
)
inline

This function posts to a FIFO.

Parameters
pFifoA pointer to an OS_FIFO structure.
pToPostA pointer to the user's structure cast as an OS_FIFO_EL to be posted to the FIFO.
Returns
OS_NO_ERR - If successful
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_FIFO for current usage.

◆ OSFifoPostFirst()

uint8_t OSFifoPostFirst ( OS_FIFO pFifo,
OS_FIFO_EL *  pToPost 
)
inline

This function is identical to OSFifoPost(), but the element posted is put at the beginning of the FIFO list.

Parameters
pFifoA pointer to an OS_FIFO structure.
pToPostA pointer to the user's structure cast as an OS_FIFO_EL to be posted to the FIFO.
Returns
OS_NO_ERR - If successful
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_FIFO for current usage.

◆ OSFlagClear()

void OSFlagClear ( OS_FLAGS flags,
uint32_t  bits_to_clr 
)
inline

This function clears the bits asserted in bits_to_clr of an OS_FLAGS object pointed to by *flags..

Parameters
flagsA pointer to the OS_FLAGS object to be configured.
bits_to_clrA bit or set of bits to be cleared.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagPendAll()

uint8_t OSFlagPendAll ( OS_FLAGS flags,
uint32_t  bit_mask,
uint16_t  timeout 
)
inline

This function waits a number of time ticks specified by timeout until all the flags indicated by bit_mask are set.

Parameters
flagsA pointer to the OS_FLAGS object with the desired flag bits.
bit_maskA bit or set of bits to wait on.
timeoutNumber of time ticks to wait for all specified flag bits to be set.
Return values
OS_NO_ERRIf the flags condition is satisfied
OS_TIMEOUTIf the timeout expired
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagPendAllNoWait()

uint8_t OSFlagPendAllNoWait ( OS_FLAGS flags,
uint32_t  bit_mask 
)
inline

This function immediately checks to see if all the flag bits indicated by bit_mask are set; it does not wait.

Parameters
flagsA pointer to the OS_FLAGS object with the desired flag bits.
bit_maskA bit or set of bits to wait on.
Return values
OS_NO_ERRAll flags indicated by bit_mask are set.
OS_TIMEOUTNot all of the flags indicated by bit_mask are set.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagPendAny()

uint8_t OSFlagPendAny ( OS_FLAGS flags,
uint32_t  bit_mask,
uint16_t  timeout 
)
inline

This function waits a number of time ticks specified by timeout until any of the flags indicated by bit_mask are set.

Parameters
flagsA pointer to the OS_FLAGS object with the desired flag bits.
bit_maskA bit or set of bits to wait on.
timeoutNumber of time ticks to wait for all specified flag bits to be set.
Return values
OS_NO_ERRAt least one of the flag bits are set before timeout expires.
OS_TIMEOUTNone of the flag bits are set before timeout expires.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagPendAnyNoWait()

uint8_t OSFlagPendAnyNoWait ( OS_FLAGS flags,
uint32_t  bit_mask 
)
inline

This function immediately checks to see if any of the flag bits indicated by bit_mask are set; it does not wait.

Parameters
flagsA pointer to the OS_FLAGS object with the desired flag bits.
bit_maskA bit or set of bits to wait on.
Return values
OS_NO_ERRAt least one of the flags indicated by bit_mask are set.
OS_TIMEOUTNone of the flags indicated by bit_mask are set.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagSet()

void OSFlagSet ( OS_FLAGS flags,
uint32_t  bits_to_set 
)
inline

This function sets the corresponding bits asserted in bits_to_set of an OS_FLAGS object pointed to by *flags.

Parameters
flagsA pointer to the OS_FLAGS object to be configured.
bits_to_setA bit or set of bits to be set.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSFlagState()

uint32_t OSFlagState ( OS_FLAGS flags)
inline

This function returns the current values of the flags stored in the OS_FLAGS object structure.

Parameters
flagsA pointer to the OS_FLAGS object whose flag states are to be returned.
Returns
The state of the OS_FLAGS object.
Deprecated:
This function is now deprecated. Please see OS_FLAGS for current usage.

◆ OSLock()

void OSLock ( void  )

Calling the OSLock function will prevent the OS from changing tasks.

This is used to protect critical variables that must be accessed one task at a time. Use the OSUnlock function to release your lock. Important: You must call OSUnlock() once for each call to OSLock.

Warning: Do not keep a task locked for a long period of time, or the performance of the network subsystem will degrade, and eventually loose packets.

See also
OSUnlock()
OSLockObj()

◆ OSMboxInit()

uint8_t OSMboxInit ( OS_MBOX pmbox,
void *  msg 
)
inline

This function is used to initialize an OS_MBOX structure.

Parameters
pmboxA pointer to the OS_MBOX structure to initialize.
msgThe initial mail box message (NULL) for none.
Returns
OS_NO_ERR - If successful
OS_CRIT_ERR - If pmbox is NULL
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_MBOX for current usage.

◆ OSMboxPend()

void* OSMboxPend ( OS_MBOX pmbox,
uint16_t  timeout,
uint8_t *  err 
)
inline

Wait timeout ticks for some other task to post to the Mailbox.

Parameters
pmboxA pointer to the OS_MBOX structure.
timeoutThe number of time ticks to wait.
[out]errA variable to receive the result code (OS_NO_ERR if successful or OS_TIMEOUT if it fails).
Returns
The posted message if successful, or NULL if timed out.
Deprecated:
This function is now deprecated. Please see OS_MBOX for current usage.

◆ OSMboxPendNoWait()

void* OSMboxPendNoWait ( OS_MBOX pmbox,
uint8_t *  err 
)
inline

OSMboxPendNoWait() is identical to OSMboxPend(), but it does not wait.

Parameters
pmboxA pointer to the OS_MBOX structure.
errA variable to receive the result code (OS_NO_ERR if successful or OS_TIMEOUT if it fails).
Returns
The posted message if successful, or NULL if it fails.
Deprecated:
This function is now deprecated. Please see OS_MBOX for current usage.

◆ OSMboxPost()

uint8_t OSMboxPost ( OS_MBOX pmbox,
void *  msg 
)
inline

This function posts a message to a Mail box.

Parameters
pmboxA pointer to the OS_MBOX structure.
msgThe message to post.
Returns
OS_NO_ERR - If successful
OS_MBOX_FULL - If the mailbox is full
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_MBOX for current usage.

◆ OSQInit()

uint8_t OSQInit ( OS_Q pq,
void **  start,
uint8_t  size 
)
inline

A queue functions as a fixed size FIFO for communication between tasks. This function initializes an OS_Q structure.

Parameters
pqA pointer to the OS_Q structure.
startA pointer to an array of (void *) pointers to hold queue messages.
sizeThe number of pointers in the Q data storage area.
Returns
OS_NO_ERR - If Successful
OS_CRIT_ERR - If start or pq is NULL
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPend()

void* OSQPend ( OS_Q pq,
uint16_t  timeout,
uint8_t *  err 
)
inline

Wait timeout ticks for another task to post to the queue.

Parameters
pqA pointer to the OS_Q structure.
timeoutThe number of ticks to wait.
[out]errA variable to receive the result code, either OS_NO_ERR on receiving a posted message, or OS_TIMEOUT on a timeout.
Returns
The posted message, or NULL if the function failed
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPendNoWait()

void* OSQPendNoWait ( OS_Q pq,
uint8_t *  err 
)
inline

OSQPendNoWait() is identical to the OSQPend() function but it does not wait.

Parameters
pqA pointer to the OS_Q structure.
[out]errA variable to receive the result code, either OS_NO_ERR on receiving a posted message, or OS_TIMEOUT on a timeout.
Returns
The posted message, or NULL if the function failed
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPost()

uint8_t OSQPost ( OS_Q pq,
void *  msg 
)
inline

This function posts a message to a Queue.

Parameters
pqA pointer to the OS_Q structure.
msgThe message to be posted to the queue.
Returns
OS_NO_ERR - If Successful
OS_Q_FULL - If the queue is full and has no more room
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPostFirst()

uint8_t OSQPostFirst ( OS_Q pq,
void *  msg 
)
inline

This function posts a message like OSQPost, but posts the message at the head of the queue.

Parameters
pqA pointer to the OS_Q structure.
msgThe message to post at the head of the queue.
Returns
OS_NO_ERR - If Successful
OS_Q_FULL - If the queue is full and has no more room
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPostUnique()

uint8_t OSQPostUnique ( OS_Q pq,
void *  msg 
)
inline

This function posts a message like OSQPost, but only if the message isn't already in the queue The function performs a brute force check to see if the message is already in the queue.

Parameters
pqA pointer to the OS_Q structure.
msgThe message to post at the head of the queue.
Returns
OS_NO_ERR - If Successful
OS_Q_FULL - If the queue is full and has no more room
OS_Q_EXISTS - If the message already exists in the queue
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSQPostUniqueFirst()

uint8_t OSQPostUniqueFirst ( OS_Q pq,
void *  msg 
)
inline

This function posts a message like OSQPostFirst, but only if the message isn't already in the queue The function performs a brute force check to see if the message is already in the queue.

Parameters
pqA pointer to the OS_Q structure.
msgThe message to post at the head of the queue.
Returns
OS_NO_ERR - If Successful
OS_Q_FULL - If the queue is full and has no more room
OS_Q_EXISTS - If the message already exists in the queue
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_Q for current usage.

◆ OSSemInit()

uint8_t OSSemInit ( OS_SEM psem,
long  value 
)
inline

Initializes a semaphore.

Parameters
psemA pointer to the OS_SEM structure to initialize.
valueThe initial count value for the semaphore.
Returns
OS_NO_ERR - If successful
OS_SEM_ERR - If value is < 0 (zero), it cannot initialize
OS_CRIT_ERR - If psem is NULL
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_SEM for current usage.

◆ OSSemPend()

uint8_t OSSemPend ( OS_SEM psem,
uint16_t  timeout 
)
inline

Wait timeout ticks for the value of the semaphore to be non zero. Note: A timeout value of 0 (zero) waits forever.

Parameters
psemA pointer to the OS_SEM structure.
timeoutThe number of time ticks to wait
Returns
OS_NO_ERR - If successful
OS_TIMEOUT - If the function timed out or if the NoWait function failed
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_SEM for current usage.

◆ OSSemPendNoWait()

uint8_t OSSemPendNoWait ( OS_SEM psem)
inline

OSSemPendNoWait() is identical to OSSemPend(), but it does not wait.

Parameters
psemA pointer to the OS_SEM structure
Returns
OS_NO_ERR - If successful
OS_TIMEOUT - If it fails
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_SEM for current usage.

◆ OSSemPost()

uint8_t OSSemPost ( OS_SEM psem)
inline

Increases the value of the semaphore by one. Note: If any higher priority tasks were waiting on the semaphore - it releases them.

Parameters
psemA pointer to the OS_SEM structure.
Returns
OS_NO_ERR - If successful
OS_SEM_OVF - If the value of the semaphore overflows
See also
NBRTOS Error Codes
Deprecated:
This function is now deprecated. Please see OS_SEM for current usage.

◆ OSTaskCreatewName()

uint8_t OSTaskCreatewName ( void(*)(void *dptr)  task,
void *  data,
void *  pstktop,
void *  pstkbot,
uint8_t  prio,
const char *  name 
)

This function creates a new task.

You must allocate storage for the stack that this new task will use and it must be 4 byte aligned. Task priorities can range from 1 to OS_MAX_PRIOS, where OS_MAX_PRIOS is the lowest priority level and 1 is highest priority level. The recommended user priority levels for your application are in the range of 46 to OS_MAX_PRIOS-1. This avoids any conflicts with network communications. The maximum number of tasks your application can run is defined by OS_MAX_TASKS. Both OS_MAX_PRIOS and OS_MAX_TASKS are defined in <nburn_install>/nbrtos/include/constants.h.

Important:The uC/OS can only have one task at each priority.

Parameters
taskThe address of the function where this task will start executing.
dataThe data to pass to the task function.
pstktopThe highest address of the stack space.
pstkbotThe lowest address of the stack space.
prioThe priority for this new task (OS_MAX_PRIOS is lowest priority and 1 is highest). Look in <nburn_install>/nbrtos/include/constants.h to see which priorities are used by the OS.
nameThe name of the task
Return values
OS_NO_ERRIf successful
OS_PRIO_EXISTIf the requested priority already exists
See also
OSTaskDelete()
OSChangePrio()
NBRTOS Error Codes

◆ OSTaskDelete()

void OSTaskDelete ( void  )

This function deletes the current calling task, but we do not recommend the use of this function because it can cause memory leaks.

The preferred method for terminating a task is to set a flag or semaphore that the task is listening for. The flag can then be set by an outside task, which enables the task to be deleted to free any resources and terminate gracefully by simply returning.

See also
OSTaskCreatewName()
OSChangePrio()

◆ OSTimeDly()

void OSTimeDly ( uint32_t  to_count)
inline

Delay the task until the specified value of the system timer ticks. The number of system ticks per second is defined by the constant: TICKS_PER_SECOND in <nburn_install>/nbrtos/include/constants.h. The default value is 20 ticks per second.

Parameters
to_countThe number of system ticks to delay.
See also
OSChangeTaskDly()

◆ OSUnlock()

void OSUnlock ( void  )

This function unlocks the OS.

Important: You must call OSUnlock() once for each call to OSLock().

See also
OSLock()
OSLockObj()

◆ ShowTaskList()

void ShowTaskList ( void  )

This functions dumps the current RTOS task states to stdio.

The output takes on multiple lines of the following format for each logged state:

at t= [T] [Message]

Followed by a tally of the number of task states logged since system start:

Total messages: [N]

[T] represents the number of ticks in hexadecimal since system start; [N] represents the number of task state messages in decimal logged since system start; [Message] represents one of the output messages listed in the below table.

Message Description
Wait for Semaphore Task is asleep and pending for semaphore
Wake from Semaphore Task gets a semaphore and wakes up
Task locked Task becomes locked
Task lock++ Task gets an added nested lock
Task lock-- Task get a nested lock unlocked
Task unlocked Task becomes completely unlocked
Task priority changed The task's priority level is changed
Unknown flag [F] The flag value defining the task's state is undefined
Switched to Task [P] Task priority [P] (in decimal) gets control
Switched to Task [P] PC=[X] Task priority [P] gets control with the program counter containing the address [X] (in hexadecimal) of the instruction being executed


Note: Usage of this function is valid only when defining NBRTOS_TASKLIST in debug mode. In order to enable this macro definition, it must be uncommented in \Nburn\include\predef.h, followed by rebuilding the system files to incorporate the modification. Attempting to load a compiled non-debug application image with the macro defined will cause a trap error.