drv_fault_handler.h

 
/* 
 * File:   fault_handler.h
 * Author: M91406
 * Comments: Global, generic fault handler header file
 * Revision history: 
 */
 
// This is a guard condition so that contents of this file are not included
// more than once.  
#ifndef FAULT_HANDLER_H
#define FAULT_HANDLER_H
 
 
 
#include <xc.h> // include processor files - each processor file is guarded.  
#include <stdint.h> // include standard integer types 
#include <stdbool.h> // include standard boolean types  
#include <stddef.h> // include standard definitions  
 
 
typedef enum FLT_COMPARE_TYPE_e {
    
    FLTCMP_NONE             = 0, 
    FLTCMP_GREATER_THAN     = 1, 
    FLTCMP_LESS_THAN        = 2, 
    FLTCMP_IS_EQUAL         = 3, 
    FLTCMP_IS_NOT_EQUAL     = 4, 
    FLTCMP_BETWEEN          = 5, 
    FLTCMP_OUTSIDE          = 6  
        
} FLT_COMPARE_TYPE_t;
 
 
 
typedef struct FLT_OBJECT_STATUS_s{
 
    union {
    struct {
        volatile bool FaultStatus : 1;                      
        volatile bool FaultActive : 1;                      
        volatile unsigned : 6;                              
        volatile enum FLT_COMPARE_TYPE_e CompareType: 3;    
        volatile unsigned : 4;                              
        volatile bool Enabled : 1;                          
    } __attribute__((packed)) bits;            // Fault object status bit field for single bit access  
 
    volatile uint16_t value;        // Fault object status word  
    };
    
} FLT_OBJECT_STATUS_t;  // Fault object status
 
 
 
typedef struct FLT_COMPARE_OBJECT_s {
    
    volatile uint16_t* ptrObject;   
    volatile uint16_t bitMask;      
    
} FLT_COMPARE_OBJECT_t; // Fault compare object
 
 
 
typedef struct FLT_EVENT_RESPONSE_s {
    
    volatile uint16_t compareThreshold;             
    volatile uint16_t eventThreshold;               
    volatile uint16_t (*ptrResponseFunction)(void); 
    
} FLT_EVENT_RESPONSE_t; // Fault monitor event response object
 
 
 
typedef struct FAULT_OBJECT_s {
 
    volatile struct FLT_OBJECT_STATUS_s  Status;           
    volatile uint16_t Counter;                             
    volatile struct FLT_COMPARE_OBJECT_s SourceObject;     
    volatile struct FLT_COMPARE_OBJECT_s ReferenceObject;  
    volatile struct FLT_EVENT_RESPONSE_s TripResponse;     
    volatile struct FLT_EVENT_RESPONSE_s RecoveryResponse; 
 
} FAULT_OBJECT_t; 
 // end of group
 
 
// Public Fault Configuration Templates
extern volatile struct FAULT_OBJECT_s fltObjectClear;
 
// Public Function Prototypes
extern volatile uint16_t drv_FaultHandler_CheckObject(volatile struct FAULT_OBJECT_s* fltobj);
 
#endif  /* FAULT_HANDLER_H */