oc_machine.h

Go to the documentation of this file.

#ifndef SYSTEM_PORTABLE_INC_OC_MACHINE_H_
#define SYSTEM_PORTABLE_INC_OC_MACHINE_H_

#include <stdbool.h>
#include <oc_stdtypes.h>
#include <oc_rmaps.h>
#include <oc_channels.h>
#include <oc_pins.h>
#include <oc_ba.h>
#include <oc_registers.h>
#include <oc_assert.h>
#include <oc_mcs.h>
#include <oc_machine_defs.h>

#define _________________________________________MACROS_SECTION_____________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaSignalType_(NAME)                 oC_1WORD_FROM_2(oC_Machine_DmaSignalType_ , NAME)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC , ...)              oC_1WORD_FROM_6(oC_Machine_DmaChannelAssignment_ , DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignmentIndex_( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC , ...)         oC_1WORD_FROM_6(oC_Machine_DmaChannelAssignmentIndex_ , DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_RegisterIndirectDynamic(BaseAddress , RegisterOffset)      (*((oC_Register_t*)(((void*)BaseAddress)+((oC_UInt_t)RegisterOffset))))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_RegisterIndirectStaticOffset(BaseAddress , REGISTER_NAME)  oC_RegisterByBaseAddress(BaseAddress,REGISTER_NAME)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_RegisterIndirectStatic(BASE_NAME,REGISTER_NAME)            oC_Register(BASE_NAME,REGISTER_NAME)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_Register(Channel,REGISTER_NAME)                            oC_Machine_RegisterIndirectStaticOffset(oC_Channel_GetBaseAddress(Channel),REGISTER_NAME)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_GetRegisterAddress(Channel,REGISTER_NAME)                  ((void*)(oC_Channel_GetBaseAddress(Channel) + oC_RegisterOffset_(REGISTER_NAME)))

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_IsRegisterWritable(REGISTER_NAME)                          (oC_RegisterAccess_(REGISTER_NAME) & oC_Access_(W))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_IsRegisterReadable(REGISTER_NAME)                          (oC_RegisterAccess_(REGISTER_NAME) & oC_Access_(R))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_WriteRegisterDirectStaticOffset(Channel,REGISTER_NAME,Value)     oC_Machine_WriteRegisterDirectDynamic(Channel,oC_RegisterOffset_(REGISTER_NAME),Value)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_WriteRegister(Channel,REGISTER_NAME,Value)                       oC_Machine_WriteRegisterDirectStaticOffset(Channel,REGISTER_NAME,Value)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_ReadRegisterDirectStaticOffset(Channel,REGISTER_NAME)            oC_Machine_ReadRegisterDirectDynamic(Channel,oC_RegisterOffset_(REGISTER_NAME))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_ReadRegister(Channel,REGISTER_NAME)                              oC_Machine_ReadRegisterDirectStaticOffset(Channel,REGISTER_NAME)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaSignalTypeMask                                                ((1<<(oC_MACHINE_DMA_SIGNAL_TYPE_WIDTH))-1)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaEncodingValueMask                                             ((1<<oC_MACHINE_DMA_ENCODING_VALUE_WIDTH)-1)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaChannelMaskWidth                         (oC_CHANNEL_MASK_WIDTH)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_ChannelMaskWidth                            (oC_CHANNEL_MASK_WIDTH)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskWidth                      (oC_MACHINE_DMA_SIGNAL_TYPE_WIDTH)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskWidth                   (oC_MACHINE_DMA_ENCODING_VALUE_WIDTH)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_MaskWidth                                   (\
                                                                                     oC_Machine_DmaChannelAssignment_DmaChannelMaskWidth    + \
                                                                                     oC_Machine_DmaChannelAssignment_ChannelMaskWidth       + \
                                                                                     oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskWidth + \
                                                                                     oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskWidth)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaChannelMaskStartBit                      (0)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_ChannelMaskStartBit                         (oC_Machine_DmaChannelAssignment_DmaChannelMaskStartBit     + oC_Machine_DmaChannelAssignment_DmaChannelMaskWidth)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskStartBit                   (oC_Machine_DmaChannelAssignment_ChannelMaskStartBit        + oC_Machine_DmaChannelAssignment_ChannelMaskWidth)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskStartBit                (oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskStartBit  + oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskWidth)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaChannelMask                              ((oC_ChannelMask)                   << oC_Machine_DmaChannelAssignment_DmaChannelMaskStartBit)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_ChannelMask                                 ((oC_ChannelMask)                   << oC_Machine_DmaChannelAssignment_ChannelMaskStartBit)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaSignalTypeMask                           ((oC_Machine_DmaSignalTypeMask)     << oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskStartBit)
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_DmaEncodingValueMask                        ((oC_Machine_DmaEncodingValueMask)  << oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskStartBit)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignmentMask                                         ((1<<(oC_Machine_DmaChannelAssignment_MaskWidth))-1)

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_GetDmaChannel(Assignment)                   (((Assignment) & oC_Machine_DmaChannelAssignment_DmaChannelMask)        >>  (oC_Machine_DmaChannelAssignment_DmaChannelMaskStartBit))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_GetChannel(Assignment)                      (((Assignment) & oC_Machine_DmaChannelAssignment_ChannelMask)           >>  (oC_Machine_DmaChannelAssignment_ChannelMaskStartBit))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_GetDmaSignalType(Assignment)                (((Assignment) & oC_Machine_DmaChannelAssignment_DmaSignalTypeMask)     >>  (oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskStartBit))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_Machine_DmaChannelAssignment_GetDmaEncodingValue(Assignment)             (((Assignment) & oC_Machine_DmaChannelAssignment_DmaEncodingValueMask)  >>  (oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskStartBit))

#undef  _________________________________________MACROS_SECTION_____________________________________________________________________________

#define _________________________________________TYPES_SECTION______________________________________________________________________________

#if oC_MACHINE_DMA_ENCODING_VALUE_WIDTH < 8
//==========================================================================================================================================
//==========================================================================================================================================
typedef uint8_t oC_Machine_DmaEncodingValue_t;
#elif oC_MACHINE_DMA_ENCODING_VALUE_WIDTH < 16
//==========================================================================================================================================
//==========================================================================================================================================
typedef uint16_t oC_Machine_DmaEncodingValue_t;
#elif oC_MACHINE_DMA_ENCODING_VALUE_WIDTH < 32
//==========================================================================================================================================
//==========================================================================================================================================
typedef uint32_t oC_Machine_DmaEncodingValue_t;
#elif oC_MACHINE_DMA_ENCODING_VALUE_WIDTH < 64
//==========================================================================================================================================
//==========================================================================================================================================
typedef uint64_t oC_Machine_DmaEncodingValue_t;
#else
#   error oC_MACHINE_DMA_ENCODING_VALUE_WIDTH is too big!
#endif

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
#define DEFINE_DMA_SIGNAL_TYPE(NAME)                    oC_Machine_DmaSignalType_(NAME) ,
    oC_MACHINE_DMA_SIGNAL_TYPE_LIST(DEFINE_DMA_SIGNAL_TYPE)
#undef DEFINE_DMA_SIGNAL_TYPE
    oC_Machine_DmaSignalType_NumberOfElements
} oC_Machine_DmaSignalType_t;

#if oC_Machine_DmaSignalType_NumberOfElements > oC_Machine_DmaSignalTypeMask
#   error oC_MACHINE_DMA_SIGNAL_TYPE_WIDTH is too small!
#endif

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
#define DEFINE_DMA_CHANNEL_ASSIGNMENT( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC )               \
     oC_Machine_DmaChannelAssignment_( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC ) =  \
    ( (oC_Channel_(DMA_CHANNEL_NAME)            << oC_Machine_DmaChannelAssignment_DmaChannelMaskStartBit )         & oC_Machine_DmaChannelAssignment_DmaChannelMask )      | \
    ( (oC_Channel_(CHANNEL_NAME)                << oC_Machine_DmaChannelAssignment_ChannelMaskStartBit )            & oC_Machine_DmaChannelAssignment_ChannelMask )         | \
    ( (oC_Machine_DmaSignalType_(SIGNAL_TYPE)   << oC_Machine_DmaChannelAssignment_DmaSignalTypeMaskStartBit )      & oC_Machine_DmaChannelAssignment_DmaSignalTypeMask )   | \
    ( (ENC                                      << oC_Machine_DmaChannelAssignment_DmaEncodingValueMaskStartBit )   & oC_Machine_DmaChannelAssignment_DmaEncodingValueMask ),

    oC_MACHINE_DMA_CHANNELS_ASSIGNMENTS_LIST(DEFINE_DMA_CHANNEL_ASSIGNMENT)
#undef DEFINE_DMA_CHANNEL_ASSIGNMENT
} oC_Machine_DmaChannelAssignment_t;

#if oC_Machine_DmaChannelAssignment_MaskWidth > 64
#error oC_Machine_DmaChannelAssignment_t type is too big! (it needs more than 64 bits!)
#endif

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
#define DEFINE_DMA_CHANNEL_ASSIGNMENT( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC )               \
    oC_Machine_DmaChannelAssignmentIndex_( DMA_CHANNEL_NAME , CHANNEL_NAME , SIGNAL_TYPE , TYPE , ENC ) ,
    oC_MACHINE_DMA_CHANNELS_ASSIGNMENTS_LIST(DEFINE_DMA_CHANNEL_ASSIGNMENT)
    oC_Machine_DmaChannelAssignmentIndex_NumberOfElements
#undef DEFINE_DMA_CHANNEL_ASSIGNMENT
} oC_Machine_DmaChannelAssignmentIndex_t;

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________

#define _________________________________________VARIABLES_SECTION__________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
const oC_Machine_DmaChannelAssignment_t oC_DmaChannelAssignments[oC_Machine_DmaChannelAssignmentIndex_NumberOfElements];

#undef  _________________________________________VARIABLES_SECTION__________________________________________________________________________


#define _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________


#undef  _________________________________________INTERFACE_FUNCTIONS_SECTION________________________________________________________________

#define _________________________________________STATIC_INLINE_SECTION______________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Machine_IsPowerRegisterSet( oC_Channel_t Channel )
{
    return oC_Channel_PowerBaseAddressExist(Channel) &&
           oC_Channel_PowerBitIndexExist(Channel) &&
           oC_Channel_PowerOffsetExist(Channel);
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline oC_Power_t oC_Machine_GetPowerStateForChannel( oC_Channel_t Channel )
{
    oC_Power_t power = oC_Power_Invalid;

    if(Channel < oC_Channel_MaximumChannelNumber)
    {
        if(oC_Machine_IsPowerRegisterSet(Channel))
        {
            oC_PowerBaseAddress_t powerBaseAddress = oC_Channel_GetPowerBaseAddress(Channel);
            oC_PowerBit_t         powerBit         = oC_Channel_GetPowerBitIndex(Channel);
            oC_PowerOffset_t      powerOffset      = oC_Channel_GetPowerOffset(Channel);

            if(oC_Machine_RegisterIndirectDynamic(powerBaseAddress,powerOffset) & (1<<powerBit))
            {
                power = oC_Power_On;
            }
            else
            {
                power = oC_Power_Off;
            }
        }
        else
        {
            power = oC_Power_NotHandled;
        }
    }

    return power;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Machine_SetPowerStateForChannel( oC_Channel_t Channel , oC_Power_t Power )
{
    bool success = false;

    if(Channel < oC_Channel_MaximumChannelNumber)
    {
        if(oC_Machine_IsPowerRegisterSet(Channel))
        {
            oC_PowerBaseAddress_t powerBaseAddress = oC_Channel_GetPowerBaseAddress(Channel);
            oC_PowerBit_t         powerBit         = oC_Channel_GetPowerBitIndex(Channel);
            oC_PowerOffset_t      powerOffset      = oC_Channel_GetPowerOffset(Channel);

            success = true;

            if(Power == oC_Power_On)
            {
                oC_Machine_RegisterIndirectDynamic(powerBaseAddress,powerOffset) |= (1<<powerBit);
            }
            else if(Power == oC_Power_Off)
            {
                oC_Machine_RegisterIndirectDynamic(powerBaseAddress,powerOffset) &= ~(1<<powerBit);
            }
            else
            {
                success = false;
            }
        }
        else
        {
            success = Power == oC_Power_On;
        }
    }

    return success;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Machine_IsChannelPoweredOn( oC_Channel_t Channel )
{
    oC_Power_t powerState = oC_Machine_GetPowerStateForChannel(Channel);
    return powerState == oC_Power_On || powerState == oC_Power_NotHandled;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline const char * oC_Machine_GetChannelName( oC_Channel_t Channel )
{
    return oC_Channel_GetName(Channel);
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_Machine_WriteRegisterDirectDynamic( oC_Channel_t Channel , oC_RegisterOffset_t RegisterOffset , oC_Register_t Value )
{
    bool success = false;

    if(Channel < oC_Channel_MaximumChannelNumber)
    {
        if(oC_Machine_IsChannelPoweredOn(Channel))
        {
            oC_Machine_RegisterIndirectDynamic(oC_Channel_GetBaseAddress(Channel),RegisterOffset) = Value;
            success = true;
        }
        else
        {
            /* Channel is not powered on */
            oC_IMPLEMENT_FAILURE();
        }
    }
    else
    {
        /* Channel is not correct */
        oC_IMPLEMENT_FAILURE();
    }

    return success;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline oC_Register_t oC_Machine_ReadRegisterDirectDynamic( oC_Channel_t Channel , oC_RegisterOffset_t RegisterOffset )
{
    oC_Register_t value = 0;

    if(Channel < oC_Channel_MaximumChannelNumber)
    {
        if(oC_Machine_IsChannelPoweredOn(Channel))
        {
            value = oC_Machine_RegisterIndirectDynamic(oC_Channel_GetBaseAddress(Channel),RegisterOffset);
        }
        else
        {
            /* Channel is not powered on */
            oC_IMPLEMENT_FAILURE();
        }
    }
    else
    {
        /* Channel is not correct */
        oC_IMPLEMENT_FAILURE();
    }

    return value;
}



#undef  _________________________________________STATIC_INLINE_SECTION______________________________________________________________________

#endif /* SYSTEM_PORTABLE_INC_OC_MACHINE_H_ */