framework/c/inc/le_basics.h

Go to the documentation of this file.

#ifndef LEGATO_BASICS_INCLUDE_GUARD
#define LEGATO_BASICS_INCLUDE_GUARD

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_OK = 0,              
    LE_NOT_FOUND = -1,      
    LE_NOT_POSSIBLE = -2,   
    LE_OUT_OF_RANGE = -3,   
    LE_NO_MEMORY = -4,      
    LE_NOT_PERMITTED = -5,  
    LE_FAULT = -6,          
    LE_COMM_ERROR = -7,     
    LE_TIMEOUT = -8,        
    LE_OVERFLOW = -9,       
    LE_UNDERFLOW = -10,     
    LE_WOULD_BLOCK = -11,   
    LE_DEADLOCK = -12,      
    LE_FORMAT_ERROR = -13,  
    LE_DUPLICATE = -14,     
    LE_BAD_PARAMETER = -15, 
    LE_CLOSED = -16,        
    LE_BUSY = -17,          
}
le_result_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
typedef enum
{
    LE_OFF = 0,
    LE_ON  = 1,
}
le_onoff_t;


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define BIT0        0x01
#define BIT1        0x02
#define BIT2        0x04
#define BIT3        0x08
#define BIT4        0x10
#define BIT5        0x20
#define BIT6        0x40
#define BIT7        0x80
// @}

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define CONTAINER_OF(memberPtr, type, member)                                                       \
    ((type*)(((uint8_t*)(memberPtr))-((size_t)(&(((type*)0)->member)))))


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define NUM_ARRAY_MEMBERS(array) \
    (sizeof(array) / sizeof((array)[0]))


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define INDEX_OF_ARRAY_MEMBER(array, memberPtr) \
    ((((size_t)memberPtr) - ((size_t)array)) / sizeof(*(memberPtr)))


//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define STRINGIZE(x)  STRINGIZE_EXPAND(x)

//--------------------------------------------------------------------------------------------------
//--------------------------------------------------------------------------------------------------
#define STRINGIZE_EXPAND(x)     #x   // Needed to expand macros.


#endif // LEGATO_BASICS_INCLUDE_GUARD