oc_module.h

Go to the documentation of this file.

#ifndef SYSTEM_LIBRARIES_INC_OC_MODULE_H_
#define SYSTEM_LIBRARIES_INC_OC_MODULE_H_

#include <stdbool.h>
#include <oc_stdtypes.h>
#include <oc_bits.h>
#include <oc_errors.h>

#define _________________________________________TYPES_SECTION______________________________________________________________________________

#define MAX_REQUIRED_MODULES        5

typedef enum
{
    oC_Module_None = 0,
    oC_Module_GPIO ,
    oC_Module_CLOCK_LLD ,
    oC_Module_MEM_LLD ,
    oC_Module_SYS_LLD ,
    oC_Module_GPIO_LLD ,
    oC_Module_UART_LLD ,
    oC_Module_LCDTFT_LLD ,
    oC_Module_LCDTFT ,
    oC_Module_FMC ,
    oC_Module_FMC_LLD ,
    oC_Module_ScreenMan ,
    oC_Module_ETH ,
    oC_Module_ETH_LLD ,
    oC_Module_NetifMan ,
    oC_Module_Udp ,
    oC_Module_ExcHan ,
    oC_Module_Icmp ,
    oC_Module_Tcp ,
    oC_Module_PortMan ,
    oC_Module_ServiceMan ,
    oC_Module_ProcessMan ,
    oC_Module_ThreadMan ,

    /* This should be always at the end of the list */
    oC_Module_NumberOfModules ,
    oC_Module_MaxRequiredModules  = MAX_REQUIRED_MODULES,
} oC_Module_t;

typedef oC_ErrorCode_t (*oC_Module_TurnFunction_t)( void );

typedef oC_Module_t oC_Module_RequiredArray_t[MAX_REQUIRED_MODULES];

typedef struct
{
    const char *                    Name;
    oC_Module_t                     Module;
    oC_Module_TurnFunction_t        TurnOnFunction;
    oC_Module_TurnFunction_t        TurnOffFunction;
    oC_Module_RequiredArray_t       RequiredModules;
} oC_Module_Registration_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________VARIABLES_SECTION__________________________________________________________________________

extern uint32_t oC_Module_EnabledFlags[ oC_Module_NumberOfModules/32 + ((oC_Module_NumberOfModules%32) ? 1 : 0)];

#undef  _________________________________________VARIABLES_SECTION__________________________________________________________________________


#define _________________________________________STATIC_INLINE_SECTION______________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Module_IsTurnedOn( oC_Module_t Module )
{
    return (Module < oC_Module_NumberOfModules) && (oC_Bits_IsBitSetU32(oC_Module_EnabledFlags[Module/32],Module % 32));
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Module_TurnOnVerification( oC_ErrorCode_t * outErrorCode , oC_Module_t Module )
{
    return oC_AssignErrorCodeIfFalse( outErrorCode , oC_Module_IsTurnedOn(Module) , oC_ErrorCode_ModuleNotStartedYet );
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Module_TurnOffVerification( oC_ErrorCode_t * outErrorCode , oC_Module_t Module )
{
    return oC_AssignErrorCodeIfFalse( outErrorCode , !oC_Module_IsTurnedOn(Module) , oC_ErrorCode_ModuleIsTurnedOn );
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline void oC_Module_TurnOn( oC_Module_t Module )
{
    oC_Bits_SetBitU32(&oC_Module_EnabledFlags[Module/32],Module % 32);
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline void oC_Module_TurnOff( oC_Module_t Module )
{
    oC_Bits_ClearBitU32(&oC_Module_EnabledFlags[Module/32],Module % 32);
}
#undef  _________________________________________STATIC_INLINE_SECTION______________________________________________________________________


#endif /* SYSTEM_LIBRARIES_INC_OC_MODULE_H_ */