Hwi.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020, Texas Instruments Incorporated - https://www.ti.com
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */
/*
 * ======== Hwi.h ========
 */

/* BIOS 6.x compatibility, use -Dxdc_std__include to disable */
#include <xdc/std.h>
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>

#include <ti/sysbios/BIOS.h>

#include <ti/sysbios/runtime/Error.h>

/*
 * First time Hwi.h is included within a compilation unit:
 *  -undefine any previous Hwi_ short names
 *  -do short-to-long name conversions.
 *  -include all short-named Hwi API definitions.
 *
 * All subsequent includes:
 *  -undefine any previous Hwi_ short names
 *  -perform short-to-long name converions
 *  -Do not include short-named Hwi API definitins
 *   because the long name Hwi API definitions are
 *   already known to the compiler.
 */

#define do_hwi_undef_short_names
#define do_hwi_short_to_long_name_conversion
#include "Hwi_defs.h"
#ifndef ti_sysbios_family_arm_m3_Hwi__include
#define ti_sysbios_family_arm_m3_Hwi__include

#include <ti/sysbios/hal/Hwi.h>
#ifdef __cplusplus
extern "C" {
#endif

/*
 * Error and Assert Ids
 */
#define Hwi_E_badIntNum        "intnum: %d is out of range"

#define Hwi_E_alreadyDefined   "Hwi already defined: intr# %d"

#define Hwi_E_hwiLimitExceeded "Too many interrupts defined"

#define Hwi_E_exception        "hardware exception id = %d, pc = 0x%08x"

#define Hwi_E_noIsr            "no ISR, id = %d, pc = 0x%08x"

#define Hwi_E_NMI              "NMI: %s"

#define Hwi_E_hardFault        "Hard-fault: %s"

#define Hwi_E_memFault         "Mem-fault: %s, addresss: 0x%08x"

#define Hwi_E_busFault         "Bus-fault: %s, address: 0x%08x"

#define Hwi_E_usageFault       "Usage-fault: %s"

#define Hwi_E_svCall           "SvCall: svNum = %d"

#define Hwi_E_debugMon         "Debug-monitor: %s"

#define Hwi_E_reserved         "reserved %s %d"

#define Hwi_E_stackOverflow    "ISR stack overflow"

typedef struct Hwi_Struct Hwi_Struct;
typedef struct Hwi_Struct Hwi_Object;
typedef Hwi_Struct* Hwi_Handle;
typedef Hwi_Struct* Hwi_Instance;

/* included for backward compatibility with DPL but not required otherwise */
typedef struct Hwi_Struct Hwi_Struct2;
typedef struct Hwi_Struct2__ Hwi_Struct2__;
typedef struct Hwi_HookSet Hwi_HookSet;
typedef struct Hwi_Module_State Hwi_Module_State;
typedef struct Hwi_Params Hwi_Params;

typedef struct Hwi_NVIC Hwi_NVIC;
typedef struct Hwi_ExcContext Hwi_ExcContext;
typedef struct Hwi_StackInfo Hwi_StackInfo;

typedef void (*Hwi_FuncPtr)(uintptr_t);

typedef void (*Hwi_VectorFuncPtr)(void );

typedef void (*Hwi_ExceptionHookFuncPtr)(Hwi_ExcContext* arg1);

/* ExcHookFunc */
typedef Hwi_ExceptionHookFuncPtr Hwi_ExcHookFunc;

struct Hwi_HookSet {
    void (*registerFxn)(int arg1);
    void (*createFxn)(Hwi_Handle arg1, Error_Block* arg2);
    void (*beginFxn)(Hwi_Handle arg1);
    void (*endFxn)(Hwi_Handle arg1);
    void (*deleteFxn)(Hwi_Handle arg1);
};

typedef struct { int length; const Hwi_HookSet *elem; } Hwi_Hook;

enum Hwi_MaskingOption {
    Hwi_MaskingOption_NONE,
    Hwi_MaskingOption_ALL,
    Hwi_MaskingOption_SELF,
    Hwi_MaskingOption_BITMASK,
    Hwi_MaskingOption_LOWER
};

typedef enum Hwi_MaskingOption Hwi_MaskingOption;

struct Hwi_StackInfo {
    size_t hwiStackPeak;
    size_t hwiStackSize;
    void * hwiStackBase;
};

struct Hwi_CCR {
    uint8_t STKALIGN;
    uint8_t BFHFNMIGN;
    uint8_t DIV_0_TRP;
    uint8_t UNALIGN_TRP;
    uint8_t USERSETMPEND;
    uint8_t NONEBASETHRDENA;
};
struct Hwi_NVIC {
    uint32_t RES_00;       
    uint32_t ICTR;         
    uint32_t RES_08;       
    uint32_t RES_0C;       
    uint32_t STCSR;        
    uint32_t STRVR;        
    uint32_t STCVR;        
    uint32_t STCALIB;      
    uint32_t RES_20 [56];  
    uint32_t ISER [8];     
    uint32_t RES_120 [24]; 
    uint32_t ICER [8];     
    uint32_t RES_1A0 [24]; 
    uint32_t ISPR [8];     
    uint32_t RES_220 [24]; 
    uint32_t ICPR [8];     
    uint32_t RES_2A0 [24]; 
    uint32_t IABR [8];     
    uint32_t RES_320 [56]; 
    uint8_t  IPR [240];    
    uint32_t RES_4F0 [516];
    uint32_t CPUIDBR;      
    uint32_t ICSR;         
    uint32_t VTOR;         
    uint32_t AIRCR;        
    uint32_t SCR;          
    uint32_t CCR;          
    uint8_t  SHPR[12];     
    uint32_t SHCSR;        
    uint8_t  MMFSR;        
    uint8_t  BFSR;         
    uint16_t UFSR;         
    uint32_t HFSR;         
    uint32_t DFSR;         
    uint32_t MMAR;         
    uint32_t BFAR;         
    uint32_t AFSR;         
    uint32_t PFR0;         
    uint32_t PFR1;         
    uint32_t DFR0;         
    uint32_t AFR0;         
    uint32_t MMFR0;        
    uint32_t MMFR1;        
    uint32_t MMFR2;        
    uint32_t MMFR3;        
    uint32_t ISAR0;        
    uint32_t ISAR1;        
    uint32_t ISAR2;        
    uint32_t ISAR3;        
    uint32_t ISAR4;        
    uint32_t RES_D74[5];   
    uint32_t CPACR;        
    uint32_t RES_D8C[93];  
    uint32_t STI;          
    uint32_t RES_F04[12];  
    uint32_t FPCCR;        
    uint32_t FPCAR;        
    uint32_t FPDSCR;       
    uint32_t MVFR0;        
    uint32_t MVFR1;        
    uint32_t RES_F48[34];  
    uint32_t PID4;         
    uint32_t PID5;         
    uint32_t PID6;         
    uint32_t PID7;         
    uint32_t PID0;         
    uint32_t PID1;         
    uint32_t PID2;         
    uint32_t PID3;         
    uint32_t CID0;         
    uint32_t CID1;         
    uint32_t CID2;         
    uint32_t CID3;         
};

extern volatile Hwi_NVIC Hwi_nvic;

struct Hwi_ExcContext {
    BIOS_ThreadType threadType;
    void * threadHandle;
    void * threadStack;
    size_t threadStackSize;
    void * r0;
    void * r1;
    void * r2;
    void * r3;
    void * r4;
    void * r5;
    void * r6;
    void * r7;
    void * r8;
    void * r9;
    void * r10;
    void * r11;
    void * r12;
    void * sp;
    void * lr;
    void * pc;
    void * psr;
    void * ICSR;
    void * MMFSR;
    void * BFSR;
    void * UFSR;
    void * HFSR;
    void * DFSR;
    void * MMAR;
    void * BFAR;
    void * AFSR;
};

/* Module_State */
struct Hwi_Module_State {
    char *taskSP;           /* 0x0 */
    bool excActive;         /* 0x4 */
    void * excContext;         /* 0x8 */
    void * excStack;           /* 0xc */
    void * isrStack;           /* 0x10 */
    void * isrStackBase;       /* 0x14 */
    unsigned int swiTaskKeys;       /* 0x18 */
    void * isrStackSize;      
    void * vectorTableBase;
    void * dispatchTable;
    volatile bool vnvicFlushRequired;
    uint8_t *intAffinity;
    uint32_t *intAffinityMasks;
    Hwi_VectorFuncPtr *vectorTable;
    bool initDone;
};

/* Object */
struct Hwi_Struct {
    uintptr_t arg;
    Hwi_FuncPtr fxn;
    uintptr_t irp;
    uint8_t priority;
    int16_t intNum;
    void * *hookEnv;
};

typedef void (*Hwi_ExcHandlerFuncPtr)(unsigned int* arg1, unsigned int arg2);

extern const bool Hwi_dispatcherAutoNestingSupport;

extern const bool Hwi_dispatcherSwiSupport;

extern const bool Hwi_dispatcherTaskSupport;

extern const bool Hwi_dispatcherIrpTrackingSupport;
extern const int Hwi_NUM_INTERRUPTS;

extern const int Hwi_NUM_PRIORITIES;

extern const Hwi_Hook Hwi_hooks;

extern const Hwi_VectorFuncPtr Hwi_nullIsrFunc;

extern const Hwi_ExcHandlerFuncPtr Hwi_excHandlerFunc;
extern const Hwi_ExcHookFunc Hwi_excHookFunc;

extern const unsigned int Hwi_disablePriority;

extern const unsigned int Hwi_priGroup;

extern const unsigned int Hwi_numSparseInterrupts;

extern const uint32_t Hwi_ccr;
struct Hwi_Params {
    Hwi_MaskingOption maskSetting;
    uintptr_t arg;
    bool enableInt;
    int eventId;
    int priority;
    bool useDispatcher;
};

extern unsigned int Hwi_Disable();

extern unsigned int Hwi_Enable();

extern void Hwi_Restore(uint32_t key);
 
extern void Hwi_init(void);

/* Instance_init */
extern int Hwi_Instance_init(Hwi_Object *obj, int intNum, Hwi_FuncPtr hwiFxn, const Hwi_Params *prms, Error_Block *eb);

/* Instance_finalize */
extern void Hwi_Instance_finalize(Hwi_Object *obj, int ec);
extern Hwi_Handle Hwi_create(int intNum, Hwi_FuncPtr hwiFxn, const Hwi_Params *prms, Error_Block *eb);

extern Hwi_Handle Hwi_construct(Hwi_Struct *obj, int intNum, Hwi_FuncPtr hwiFxn, const Hwi_Params *prms, Error_Block *eb);

extern void Hwi_delete(Hwi_Handle *handle);

extern void Hwi_destruct(Hwi_Struct *obj);

extern bool Hwi_getStackInfo(Hwi_StackInfo *stkInfo, bool computeStackDepth);

extern bool Hwi_getCoreStackInfo(Hwi_StackInfo *stkInfo, bool computeStackDepth, unsigned int coreId);
extern void Hwi_startup(void);

extern void Hwi_switchFromBootStack(void);
extern void Hwi_post(unsigned int intNum);

extern char *Hwi_getTaskSP(void);
extern unsigned int Hwi_disableInterrupt(unsigned int intNum);

extern unsigned int Hwi_enableInterrupt(unsigned int intNum);

extern void Hwi_restoreInterrupt(unsigned int intNum, unsigned int key);

extern void Hwi_clearInterrupt(unsigned int intNum);

extern Hwi_FuncPtr Hwi_getFunc(Hwi_Handle hwi, uintptr_t *arg);

extern void Hwi_setFunc(Hwi_Handle hwi, Hwi_FuncPtr fxn, uintptr_t arg);

extern void * Hwi_getHookContext(Hwi_Handle hwi, int id);

extern void Hwi_setHookContext(Hwi_Handle hwi, int id, void * hookContext);

extern uintptr_t Hwi_getIrp(Hwi_Handle hwi);

extern void Hwi_plug(unsigned int intNum, void *fxn);

extern Hwi_Handle Hwi_getHandle(unsigned int intNum);

extern void Hwi_setPriority(unsigned int intNum, unsigned int priority);

extern void Hwi_excSetBuffers(void * excContextBuffer, void * excStackBuffer);

extern void Hwi_reconfig(Hwi_Handle hwi, Hwi_FuncPtr fxn, const Hwi_Params *params);

extern Hwi_Handle Hwi_construct2(Hwi_Struct2 *hwi, int intNum, Hwi_FuncPtr hwiFxn, const Hwi_Params *prms);
extern void Hwi_initNVIC(void);
extern void Hwi_initStacks(void * hwiStack);
extern int Hwi_postInit(Hwi_Object *hwi, Error_Block *eb);
extern void Hwi_excHandlerAsm(void);
extern void Hwi_excHandler(unsigned int *excStack, unsigned int lr);
extern void Hwi_excHandlerMin(unsigned int *excStack, unsigned int lr);
extern void Hwi_excHandlerMax(unsigned int *excStack, unsigned int lr);
extern void Hwi_excFillContext(unsigned int *excStack);
extern void Hwi_excNmi(unsigned int *excStack);
extern void Hwi_excHardFault(unsigned int *excStack);
extern void Hwi_excMemFault(unsigned int *excStack);
extern void Hwi_excBusFault(unsigned int *excStack);
extern void Hwi_excUsageFault(unsigned int *excStack);
extern void Hwi_excSvCall(unsigned int *excStack);
extern void Hwi_excDebugMon(unsigned int *excStack);
extern void Hwi_excReserved(unsigned int *excStack, unsigned int excNum);
extern void Hwi_excNoIsr(unsigned int *excStack, unsigned int excNum);
extern void Hwi_excDumpRegs(unsigned int lr);
extern void Hwi_pendSV(void);
extern void Hwi_setStackLimit(void * stackBase);
extern unsigned int Hwi_swiDisableNull(void);
extern void Hwi_swiRestoreNull(unsigned int key);
extern void Hwi_dispatch(void);
extern unsigned int Hwi_dispatchC(uintptr_t irp, uint32_t dummy1, uint32_t dummy2, Hwi_Object *hwi);
extern void Hwi_doSwiRestore(unsigned int tskKey);
extern void Hwi_doTaskRestore(unsigned int tskKey);
extern unsigned int Hwi_swiDisable();
extern void Hwi_swiRestore(unsigned int key);
extern void Hwi_swiRestoreHwi(unsigned int key);
extern unsigned int Hwi_taskDisable();
extern void Hwi_taskRestoreHwi(unsigned int key);
extern void Hwi_switchFromBootStack(void);

/* checkStack */
extern void Hwi_checkStack(void);

/* initStack */
extern void Hwi_initStack(void);

/* initStackMin */
extern void Hwi_initStackMin(void);

/* switchAndRunFunc */
extern void Hwi_switchAndRunFunc(void (*func)(void));
/*
 * ======== SYSTEM FUNCTIONS ========
 */

/* Params_init */
extern void Hwi_Params_init(Hwi_Params *prms);

/* Params_copy */
extern void Hwi_Params_copy(Hwi_Params *dst, Hwi_Params *src);
/* Object_first */
extern Hwi_Handle Hwi_Object_first(void);

/* Object_next */
extern Hwi_Handle Hwi_Object_next(Hwi_Object *obj);

/*
 * ======== STATE STRUCTURES ========
 */

extern Hwi_Module_State Hwi_Module_state;

#define Hwi_module ((Hwi_Module_State *) &(Hwi_Module_state))

#define Hwi_Object_heap() NULL

static inline Hwi_Handle Hwi_handle(Hwi_Struct *str)
{  
    return ((Hwi_Handle)str);
}

static inline Hwi_Struct * Hwi_struct(Hwi_Handle h)
{
    return ((Hwi_Struct *)h);
}
#ifdef __cplusplus
}
#endif

#endif /* ti_sysbios_family_arm_m3__Hwi__include */

#if defined(ti_sysbios_family_arm_m3_Hwi__nolocalnames)
#define do_hwi_undef_short_names
#include "Hwi_defs.h"
#endif