oc_mcs.h

Go to the documentation of this file.

#ifndef SYSTEM_PORTABLE_INC_MCS_OC_MCS_H_
#define SYSTEM_PORTABLE_INC_MCS_OC_MCS_H_

#include <oc_interrupts_defs.h>
#include <oc_assert.h>
#include <oc_stdtypes.h>
#include <stdbool.h>
#include <oc_mcs_defs.h>
#include <stddef.h>
#include <oc_memory.h>
#include <oc_errors.h>

#define _________________________________________MACROS_SECTION_____________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_IsStackPushDecrementPointer()                        oC_MCS_STACK_PUSH_DECREMENTS_POINTER

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_AlignStackPointer(Pointer)                           ((void*)oC_MCS_AlignSize((void*)Pointer,oC_MCS_STACK_MEMORY_ALIGNMENT))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_AlignPointer(Pointer)                                ((void*)oC_MCS_AlignSize((void*)Pointer,oC_MCS_MEMORY_ALIGNMENT))
//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_AlignSize(Size,Alignment)                            ((((oC_UInt_t)(Size)) + (Alignment) - 1) & ~((Alignment)-1))

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_IsStackPointerAligned(Pointer)                       (oC_MCS_AlignStackPointer(Pointer) == ((void*)(Pointer)))

//==========================================================================================================================================
//==========================================================================================================================================
#define oC_MCS_IsPointerAligned(Pointer)                            (oC_MCS_AlignPointer(Pointer) == Pointer)

#undef  _________________________________________MACROS_SECTION_____________________________________________________________________________

#define _________________________________________TYPES_SECTION______________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
/* This definition is for removing text "System" from the IRQn enumerator name */
#define System
/* Definition for creating IRQn type enumerator name */
#define IRQn_(NAME,TYPE)                                                                oC_1WORD_FROM_3(TYPE , NAME , _IRQn)
/* Definition for creation of interrupt number enumerator in IRQn_Type */
#define CREATE_INTERRUPT_NUMBER( BASE_NAME , INTERRUPT_TYPE , INTERRUPT_NUMBER , ...)   IRQn_(BASE_NAME , INTERRUPT_TYPE) = INTERRUPT_NUMBER ,

    /* This creates enumerator values from definitions in interrupts defs file */
    oC_MACHINE_INTERRUPTS_LIST(CREATE_INTERRUPT_NUMBER)

/* Removes all definitions that are not needed anymore */
#undef CREATE_INTERRUPT_NUMBER
#undef System
} IRQn_Type;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_InterruptPriority_Error      = 0xFFFFFF ,                           
    oC_InterruptPriority_Minimum    = oC_MINIMUM_INTERRUPT_PRIORITY ,      
    oC_InterruptPriority_Maximum    = oC_MAXIMUM_INTERRUPT_PRIORITY        
} oC_InterruptPriotity_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef void (*oC_ContextHandler_t)( void * ContextParameter );

//==========================================================================================================================================
//==========================================================================================================================================
typedef void (*oC_ContextExitHandler_t)(void);

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    void *      StackPointer;           
    void *      Buffer;                 
    oC_Int_t    BufferSize;             
} oC_StackData_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef struct
{
    const void *        BaseAddress;          
    oC_MemorySize_t     Size;                 
    bool                AlignSize;            
    oC_Power_t          Power;                
    oC_Access_t         UserAccess;           
    oC_Access_t         PrivilegedAccess;     
    bool                Shareable;            
    bool                Cacheable;            
    bool                Bufforable;           
    uint32_t            RegionNumber;         
} oC_MCS_MemoryRegionConfig_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef enum
{
    oC_MCS_MemoryAccessMode_User ,      
    oC_MCS_MemoryAccessMode_Privileged  
} oC_MCS_MemoryAccessMode_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef oC_StackData_t * oC_Stack_t;

//==========================================================================================================================================
//==========================================================================================================================================
typedef void (*oC_FindNextStackHandler_t)( void );

#undef  _________________________________________TYPES_SECTION______________________________________________________________________________



#define _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_InitializeModule( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern void * oC_MCS_GetHardFaultReason( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern void oC_MCS_EnableInterrupts( void );
//==========================================================================================================================================
//==========================================================================================================================================
extern void oC_MCS_DisableInterrupts( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_AreInterruptsEnabled( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_EnableInterrupt( IRQn_Type InterruptNumber );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_DisableInterrupt( IRQn_Type InterruptNumber );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_IsInterruptEnabled( IRQn_Type InterruptNumber );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_SetInterruptPriority( IRQn_Type InterruptNumber , oC_InterruptPriotity_t Priority );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_InterruptPriotity_t oC_MCS_GetInterruptPriority( IRQn_Type InterruptNumber );

//==========================================================================================================================================
//==========================================================================================================================================
extern void oC_MCS_Reboot( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_InitializeStack(
                oC_Stack_t *            outStack ,
                void *                  Buffer ,
                oC_Int_t                BufferSize ,
                oC_ContextHandler_t     ContextHandler  ,
                void *                  HandlerParameter ,
                oC_ContextExitHandler_t ExitHandler
                );

//==========================================================================================================================================
//==========================================================================================================================================
extern void * oC_MCS_GetCurrentProcessStackPointer( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern void * oC_MCS_GetCurrentMainStackPointer( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_Int_t oC_MCS_GetStackSize( oC_Stack_t Stack );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_Int_t oC_MCS_GetFreeStackSize( oC_Stack_t Stack );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_Stack_t oC_MCS_GetCurrentStack( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_Int_t oC_MCS_GetMinimumStackBufferSize( oC_Int_t StackSize );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_SetNextStack( oC_Stack_t Stack );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_ConfigureSystemTimer( oC_UInt_t Prescaler , oC_FindNextStackHandler_t FindNextStackHandler );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_Stack_t oC_MCS_GetSystemStack( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_ReturnToSystemStack( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern void oC_MCS_Delay( register oC_UInt_t Cycles );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_ErrorCode_t oC_MCS_ConfigureMemoryRegion( const oC_MCS_MemoryRegionConfig_t * Config );

//==========================================================================================================================================
//==========================================================================================================================================
extern uint32_t oC_MCS_GetMaximumNumberOfRegions( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern uint32_t oC_MCS_GetNumberOfRegions( void );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_ReadFreeRegionNumber( uint32_t * outFreeRegionNumber );

//==========================================================================================================================================
//==========================================================================================================================================
extern bool oC_MCS_SetMemoryAccessMode( oC_MCS_MemoryAccessMode_t Mode );

//==========================================================================================================================================
//==========================================================================================================================================
extern oC_MCS_MemoryAccessMode_t oC_MCS_GetMemoryAccessMode( void );

#undef  _________________________________________PROTOTYPES_SECTION_________________________________________________________________________

#define _________________________________________GLOBAL_VARIABLES_SECTION___________________________________________________________________

extern int16_t oC_MCS_CriticalSectionCounter;

#undef  _________________________________________GLOBAL_VARIABLES_SECTION___________________________________________________________________


#define _________________________________________STATIC_INLINE_SECTION______________________________________________________________________

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_MCS_ChangeCriticalSectionCounter( int8_t ValueToAdd )
{
    static const int16_t criticalCounterMax     = INT16_MAX - INT8_MAX;

    oC_MCS_CriticalSectionCounter += ValueToAdd;

    /* This assertion fails, when the critical counter was decremented too much time */
    oC_ASSERT(oC_MCS_CriticalSectionCounter >= 0);

    /* This assertion fails, when the critical counter achieve maximum safe value */
    oC_ASSERT(oC_MCS_CriticalSectionCounter < criticalCounterMax);

    return oC_MCS_CriticalSectionCounter == 0;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline void oC_MCS_EnterCriticalSection( void )
{
    /* Add 1 to the critical section counter */
    oC_MCS_ChangeCriticalSectionCounter(1);

    oC_MCS_DisableInterrupts();
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_MCS_ExitCriticalSection( void )
{
    bool interruptsEnabled = false;

    if(oC_MCS_ChangeCriticalSectionCounter(-1))
    {
        oC_MCS_EnableInterrupts();
    }

    return interruptsEnabled;
}

//==========================================================================================================================================
//==========================================================================================================================================
static inline bool oC_MCS_IsCriticalSectionActive( void )
{
    return oC_MCS_ChangeCriticalSectionCounter(0) == false;
}

#undef  _________________________________________STATIC_INLINE_SECTION______________________________________________________________________


#endif /* SYSTEM_PORTABLE_INC_MCS_ARM_ARM_CORTEX_M7_OC_MCS_H_ */