oc_channels.h

Go to the documentation of this file.

#ifndef SYSTEM_PORTABLE_INC_OC_CHANNELS_H_
#define SYSTEM_PORTABLE_INC_OC_CHANNELS_H_

#include <oc_1word.h>
#include <oc_channels_defs.h>
#include <oc_ba.h>
#include <oc_rmaps.h>
#include <oc_registers.h>
#include <oc_interrupts.h>

#define _________________________________________MACROS_SECTION_____________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ChannelMask                                  ( (1<<(oC_CHANNEL_MASK_WIDTH)) - 1 )

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_(CHANNEL_NAME,...)                   oC_1WORD_FROM_2(oC_Channel_ , CHANNEL_NAME)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ChannelModule_(CHANNEL_NAME,...)             oC_1WORD_FROM_2(oC_ChannelModule_ , CHANNEL_NAME)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ChannelStartIndex_(MODULE_NAME,...)          oC_1WORD_FROM_3(oC_Channel_ , MODULE_NAME , _StartIndex )
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ChannelEndIndex_(MODULE_NAME,...)            oC_1WORD_FROM_3(oC_Channel_ , MODULE_NAME , _EndIndex )
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ModuleChannel_(MODULE_NAME,CHANNEL_NAME,...) oC_1WORD_FROM_4(oC_ , MODULE_NAME , _Channel_ , CHANNEL_NAME )

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_InterruptHandlerName(INTERRUPT_TYPE_NAME)                            oC_1WORD_FROM_2( INTERRUPT_TYPE_NAME , ChannelHandler )
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_InterruptHandlerPrototype(INTERRUPT_TYPE_NAME,ChannelVariableName)   static void oC_Channel_InterruptHandlerName(INTERRUPT_TYPE_NAME) ( oC_Channel_t ChannelVariableName )

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Make_ModuleWithChannels(MODULE_NAME)         oC_MODULE_CHANNELS_(MODULE_NAME)(MAKE_CHANNEL)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Make_ChannelForModule(CHANNEL_NAME,...)      oC_ModuleChannel_(MODULE_NAME,CHANNEL_NAME) = oC_Channel_(CHANNEL_NAME) ,

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Make_InterruptHandlerForChannel(CHANNEL_NAME,BASE_NAME,...)        \
    oC_InterruptHandler(BASE_NAME,INTERRUPT_TYPE_NAME) \
    { \
         oC_Channel_InterruptHandlerName(INTERRUPT_TYPE_NAME)(oC_Channel_(CHANNEL_NAME));\
    } \

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ChannelData_(CHANNEL_NAME)                   (&oC_ChannelsData[oC_Channel_(CHANNEL_NAME)])

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_IsModuleDefined(MODULE_NAME)         (defined(oC_MODULE_CHANNELS_##MODULE_NAME))

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetData(Channel)                     (&oC_ChannelsData[Channel])
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_IsCorrect(MODULE_NAME,Channel)       ((((oC_Channel_t)(Channel)) > oC_ChannelStartIndex_(MODULE_NAME)) && (((oC_Channel_t)(Channel)) < oC_ChannelEndIndex_(MODULE_NAME)))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_ToIndex(MODULE_NAME,Channel)         (Channel - oC_ChannelStartIndex_(MODULE_NAME) - 1)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_FromIndex(MODULE_NAME,ChannelIndex)  (ChannelIndex + oC_ChannelStartIndex_(MODULE_NAME) + 1)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetBaseAddress(Channel)              oC_Channel_GetData(Channel)->BaseAddress
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetPowerBaseAddress(Channel)         oC_Channel_GetData(Channel)->PowerBaseAddress
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetPowerOffset(Channel)              oC_Channel_GetData(Channel)->PowerOffset
//=========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetPowerBitIndex(Channel)            oC_Channel_GetData(Channel)->PowerBitIndex
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetRegisterMap(Channel)              oC_Channel_GetData(Channel)->RegisterMap
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_GetName(Channel)                     oC_Channel_GetData(Channel)->ChannelName

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_PowerBaseAddressExist(Channel)       (oC_PowerBaseAddress_Exist( oC_Channel_GetPowerBaseAddress(Channel) ) )
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_PowerOffsetExist(Channel)            (oC_PowerOffset_Exist(      oC_Channel_GetPowerOffset(Channel) ) )
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_PowerBitIndexExist(Channel)          (oC_PowerBit_Exist(    oC_Channel_GetPowerBitIndex(Channel) ) )

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_Register(Channel,REGISTER_NAME)      oC_RegisterByBaseAddress( oC_Channel_GetBaseAddress(Channel) , REGISTER_NAME )

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ModuleChannel_NumberOfElements(MODULE_NAME)  (oC_ChannelEndIndex_(MODULE_NAME) - oC_ChannelStartIndex_(MODULE_NAME) - 1)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_Foreach(MODULE_NAME,Channel)         for(oC_Channel_t Channel = oC_ChannelStartIndex_(MODULE_NAME) + 1 ; Channel < oC_ChannelEndIndex_(MODULE_NAME) ; Channel++)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Channel_InterruptHandler(ChannelVariableName)   \
    oC_Channel_InterruptHandlerPrototype(INTERRUPT_TYPE_NAME,ChannelVariableName);\
    oC_MODULE_CHANNELS_(MODULE_NAME)(oC_Make_InterruptHandlerForChannel)\
    oC_Channel_InterruptHandlerPrototype(INTERRUPT_TYPE_NAME,ChannelVariableName)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_ModuleChannel_DefineType     \
    typedef enum {\
        oC_MODULE_CHANNELS_(MODULE_NAME)(oC_Make_ChannelForModule) \
    } oC_ModuleChannel_(MODULE_NAME,t)

#define oC_Channel_SetInterruptPriority( Channel , INTERRUPT_TYPE , InterruptPriority )         oC_Channel_SetInterruptPriorityFunction( Channel , oC_InterruptType_(INTERRUPT_TYPE) , InterruptPriority )
#define oC_Channel_EnableInterrupt( Channel , INTERRUPT_TYPE )                                  oC_Channel_EnableInterruptFunction( Channel , oC_InterruptType_(INTERRUPT_TYPE) )
#define oC_Channel_DisableInterrupt( Channel , INTERRUPT_TYPE )                                 oC_Channel_DisableInterruptFunction( Channel , oC_InterruptType_(INTERRUPT_TYPE) )
#define oC_Channel_IsInterruptEnabled( Channel , INTERRUPT_TYPE )                               oC_Channel_IsInterruptEnabledFunction( Channel , oC_InterruptType_(INTERRUPT_TYPE) )

#undef  _________________________________________MACROS_SECTION_____________________________________________________________________________

#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
#define MAKE_MODULE(MODULE_NAME)                                                    \
        oC_ChannelStartIndex_(MODULE_NAME), \
        oC_MODULE_CHANNELS_(MODULE_NAME)(MAKE_CHANNEL) \
        oC_ChannelEndIndex_(MODULE_NAME),
#define MAKE_CHANNEL(CHANNEL_NAME,BASE_ADDRESS_NAME,REGISTER_MAP_NAME,...)          oC_Channel_(CHANNEL_NAME) ,
    oC_MODULES_LIST(MAKE_MODULE)
    oC_Channel_MaximumChannelNumber ,
    oC_Channel_System                   = oC_Channel_MaximumChannelNumber,
    oC_Channel_Software                 = oC_Channel_MaximumChannelNumber
#undef MAKE_CHANNEL
#undef MAKE_MODULE
} oC_Channel_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef oC_Channel_t oC_ChannelIndex_t;

#if oC_Channel_MaximumChannelNumber > oC_ChannelMask
# error Channel mask width is too small!
#endif

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    oC_BaseAddress_t        BaseAddress;            
    oC_PowerBaseAddress_t   PowerBaseAddress;       
    oC_PowerOffset_t        PowerOffset;            
    oC_PowerBit_t           PowerBitIndex;          
    oC_RegisterMap_t        RegisterMap;            
    const char *            ChannelName;            
} oC_ChannelData_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
#define MAKE_MODULE(MODULE_NAME)        oC_ChannelModule_(MODULE_NAME) ,
    oC_MODULES_LIST(MAKE_MODULE)
#undef MAKE_MODULE
} oC_ChannelModule_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef void (*oC_ChannelInterruptHandler_t)( oC_Channel_t Channel );

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

extern bool oC_Channel_SetInterruptPriorityFunction(       oC_Channel_t Channel , oC_InterruptType_t InterruptType , oC_InterruptPriotity_t Priority  );
extern bool oC_Channel_EnableInterruptFunction(    oC_Channel_t Channel , oC_InterruptType_t InterruptType );
extern bool oC_Channel_DisableInterruptFunction(   oC_Channel_t Channel , oC_InterruptType_t InterruptType );
extern bool oC_Channel_IsInterruptEnabledFunction( oC_Channel_t Channel , oC_InterruptType_t InterruptType );

#undef  _________________________________________PROTOTYPES_SECTION_________________________________________________________________________


#define _________________________________________VARIABLES_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
extern const oC_ChannelData_t oC_ChannelsData[];

#undef  _________________________________________VARIABLES_SECTION__________________________________________________________________________

#endif /* SYSTEM_PORTABLE_INC_OC_CHANNELS_H_ */