D:/Documents and Settings/nxp16889/My Documents/lpcxpresso/workspace/OSAL/inc/OSAL.h File Reference

Enter brief Description of this module. More...

#include "typedefs.h"

Go to the source code of this file.

Enumerations

enum  OSAL_QUEUE_LOCATION { OSAL_QUEUE_FRONT, OSAL_QUEUE_BACK }
 

Enumerates the possible location when writing to a queue. FRONT means that the message will be put in front of all other messages in a queue. BACK means messages will be added as last message. BACK is the normal mode.

More...
enum  OSAL_ERROR { OSAL_ERROR_NONE }
 

Used OS abstraction layer error codes.

More...

Functions

__EXTERN__ void OSALIdleHook ()
 OSAL's IdleHook function which can be overwritten by the application code. Doing this just implement this function with exactly the same name.
__EXTERN__ void OSALStackOverflowHook (OSAL_TASK *pHandle, OSAL_NAME *pTaskName)
 OSAL's StackOverflowHook function with default implementation. This function can be overwritten by the application layer. Doing this implement the function with exactly the same name.
__EXTERN__ void OSALSysTickHook ()
 OSAL's SysTick timer hook function as default implementation. Application layer can overwrite this function and implement the needed action. For overwriting this function, just implement this with exactly the same name and build project.

Detailed Description

Enter brief Description of this module.

Version:
1.0
Date:
02.06.2010
Author:
nxp16889

Enter detailed description of this module.

----------------------------------------------------------------------------
Software that is described herein is for illustrative purposes only which provides customers with programming information regarding the products. This software is supplied "AS IS" without any warranties. NXP Semiconductors assumes no responsibility or liability for the use of the software, conveys no license or title under any patent, copyright, or mask work right to the product. NXP Semiconductors reserves the right to make changes in the software without notification. NXP Semiconductors also make no representation or warranty that such application will be suitable for the specified use without further testing or modification. ----------------------------------------------------------------------------

Definition in file OSAL.h.


Enumeration Type Documentation

enum OSAL_ERROR

Used OS abstraction layer error codes.

Enumerator:
OSAL_ERROR_NONE 

Enumeration 1

Definition at line 91 of file OSAL.h.

Enumerates the possible location when writing to a queue. FRONT means that the message will be put in front of all other messages in a queue. BACK means messages will be added as last message. BACK is the normal mode.

Enumerator:
OSAL_QUEUE_FRONT 

Message will be sent to front of queue.

OSAL_QUEUE_BACK 

Message will be sent to back of queue.

Definition at line 62 of file OSAL.h.


Function Documentation

void OSALIdleHook (  ) 

OSAL's IdleHook function which can be overwritten by the application code. Doing this just implement this function with exactly the same name.

Returns:
void

Definition at line 244 of file OSAL.c.

Referenced by vApplicationIdleHook().

void OSALStackOverflowHook ( OSAL_TASK *  pHandle,
OSAL_NAME *  pTaskName 
)

OSAL's StackOverflowHook function with default implementation. This function can be overwritten by the application layer. Doing this implement the function with exactly the same name.

Parameters:
[in] pHandle Task handle.
[in] pTaskName Pointer to the Task Name.
Returns:
void

Referenced by vApplicationStackOverflowHook().

void OSALSysTickHook (  ) 

OSAL's SysTick timer hook function as default implementation. Application layer can overwrite this function and implement the needed action. For overwriting this function, just implement this with exactly the same name and build project.

Returns:
void

Definition at line 284 of file OSAL.c.

Referenced by vApplicationTickHook().

Generated on Fri Sep 3 15:37:21 2010 for DocumentGeneration by  doxygen 1.6.3