core/include/types.h File Reference

Basic types. More...

Defines

#define NULL   ((void*)0)
 Symbolic Null pointer.
#define OS_VERSION_DEF(MAJOR, MINOR, BUILD)   ((MAJOR<<24)+(MINOR<<16)+(BUILD))
 Macro builds single number from parts of the version numbers.
#define OS_MAJOR   1
 Major number of system version.
#define OS_MINOR   0
 Minor version of system version.
#define OS_BUILD   5
 Number of the system build.
#define OS_VERSION   OS_VERSION_DEF( OS_MAJOR, OS_MINOR, OS_BUILD )
 Identification of the system version.
#define OS_STATUS_OK   0
 Function terminated without errors.
#define OS_ERROR   -1
 An error occurred during function execution.
#define OS_TIMEOUT   -2
 Timeout has appeared on function call.
#define OS_WOULD_WAIT   -3
 Code returned by os_mutex_tryget() and os_sema_tryget() functions. It means that wait object cannot be got.
#define OS_PREEMPT_DIS   -4
 Signals that preemption is disabled, hence function returned immediately. Otherwise it might block.
#define OS_ERROR_NO_MEMORY   -5
 Cannot allocate memory for created object.
#define OS_FULL   -6
 The container (e.g. ring buffer) is full.
#define OS_EMPTY   -7
 The container (e.g. ring buffer) is empty.
#define OS_INVALID_PTR   -8
 Pointer specified as an argument is invalid.

Typedefs

typedef short int os_result_t
 The type for representation of the result code of the functions.

Detailed Description

Basic types.

Author:
Piotr Romaniuk, (c) ELESOFTROM
Version:
1.0 Apr 8, 2011

Define Documentation

#define NULL   ((void*)0)

Symbolic Null pointer.

Warning:
pointers are 16 bits wide in msp430, when _large_model is used pointer is 20 bits wide and is stored in 32 bits space in memory.
#define OS_VERSION   OS_VERSION_DEF( OS_MAJOR, OS_MINOR, OS_BUILD )

Identification of the system version.

Use OS_VERSION for check of compatibility of user code and the system.

#define OS_VERSION_DEF (   MAJOR,
  MINOR,
  BUILD 
)    ((MAJOR<<24)+(MINOR<<16)+(BUILD))

Macro builds single number from parts of the version numbers.

Parameters:
[in]MAJORmajor number
[in]MINORminor number
[in]BUILDbuild number
Returns:
Compact version number (unsigned long)