drv_fault_handler.c

/*
 * File:   fault_handler.c
 * Author: M91406
 *
 * Created on December 27, 2019, 12:21 PM
 */
#include <xc.h> // include processor files - each processor file is guarded.  
#include <stdint.h> // include standard integer data types
#include <stdbool.h> // include standard boolean data types
#include <stdlib.h> // include standard library data types and macros
 
#include "drv_fault_handler.h" // 
 
 
 
volatile struct FAULT_OBJECT_s fltObjectClear = 
{
        .Status.bits.CompareType = FLTCMP_NONE,     
        .Status.bits.Enabled = false,               
        .Status.bits.FaultActive = true,            
        .Status.bits.FaultStatus = true,            
        .Counter = 0,                               
        .SourceObject.ptrObject = NULL,             
        .SourceObject.bitMask = 0xFFFF,             
        .ReferenceObject.ptrObject = NULL,          
        .ReferenceObject.bitMask = 0xFFFF,          
        .TripResponse.compareThreshold = 0,         
        .TripResponse.eventThreshold = 0,           
        .TripResponse.ptrResponseFunction = NULL,   
        .RecoveryResponse.compareThreshold = 0,     
        .RecoveryResponse.eventThreshold = 0,       
        .RecoveryResponse.ptrResponseFunction = NULL,  
    };
 
 
volatile uint16_t drv_FaultHandler_CheckObject(volatile struct FAULT_OBJECT_s* fltObject) {
 
    volatile uint16_t retval=1;
    volatile uint16_t source=0;
    
    // If the fault object is not initialized, exit here with error
    if (fltObject == NULL)
        return(0);
 
    // If FAULT CHECK is disabled, exit here
    if (!fltObject->Status.bits.Enabled) {
        fltObject->Counter = 0;                        // Clear Counter
        fltObject->Status.bits.FaultActive = false;   // Clear immediate fault flag
        fltObject->Status.bits.FaultStatus = false;   // Clear fault status flag
        return(1);  // Return success
    }
    
    // If the source object is not initialized, exit here with error
    if (fltObject->SourceObject.ptrObject == NULL)
        return(0);
    
    // Read most recent fault object value with bit-mask
    source = (*fltObject->SourceObject.ptrObject & fltObject->SourceObject.bitMask);
    
    // If a reference object has been defined, read reference object value and override source with 
    // absolute value of difference between source and reference object values
    if(fltObject->ReferenceObject.ptrObject != NULL) {  
        
        uint16_t reference = (*fltObject->ReferenceObject.ptrObject & fltObject->ReferenceObject.bitMask);
        source = (volatile uint16_t)
            abs((volatile int32_t)source - (volatile int32_t)reference); // Load most recent value
    }
 
    // Check fault condition
 
    switch(fltObject->Status.bits.CompareType) {
 
        case FLTCMP_GREATER_THAN:  // Check if SOURCE > TRIP_LEVEL
            
            if (source > fltObject->TripResponse.compareThreshold)  // Check if SOURCE > TRIP_LEVEL
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else if (source < fltObject->RecoveryResponse.compareThreshold) // Check if SOURCE < RECOVERY_LEVEL
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        case FLTCMP_LESS_THAN:
            if(source < fltObject->TripResponse.compareThreshold)  // Check if SOURCE < TRIP_LEVEL
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else if(source > fltObject->RecoveryResponse.compareThreshold) // Check if SOURCE > RECOVERY_LEVEL
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        case FLTCMP_IS_EQUAL:
            if(source == fltObject->TripResponse.compareThreshold)  // Check if SOURCE == TRIP_LEVEL
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else if(source != fltObject->TripResponse.compareThreshold)  // Check if SOURCE != TRIP_LEVEL
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        case FLTCMP_IS_NOT_EQUAL:
            if(source != fltObject->TripResponse.compareThreshold)  // Check if SOURCE != TRIP_LEVEL
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else if(source == fltObject->TripResponse.compareThreshold)  // Check if SOURCE == TRIP_LEVEL
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        case FLTCMP_BETWEEN:
            // Check if SOURCE is between "RECOVERY_LEVEL ti TRIP_LEVEL"
            if((fltObject->RecoveryResponse.compareThreshold < source) && (source < fltObject->TripResponse.compareThreshold))  
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else 
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        case FLTCMP_OUTSIDE:
            // Check if SOURCE is outside "RECOVERY_LEVEL to TRIP_LEVEL"
            if((source < fltObject->RecoveryResponse.compareThreshold) || (fltObject->TripResponse.compareThreshold < source))  
                fltObject->Status.bits.FaultActive = true; // Set FAULT_ACTIVE status flag bit
            else 
                fltObject->Status.bits.FaultActive = false; // Clear FAULT_ACTIVE status flag bit
            break;
 
        default:
            return(0);  // Return=>Error (Ignore fault check if compare type is not defined)
            break;
    
    }
            
    // If a fault condition has been detected while no FAULT has been tripped....
    if ((fltObject->Status.bits.FaultActive) && (!fltObject->Status.bits.FaultStatus)) {
    
        fltObject->Counter++;  // Increment fault event counter
        
        // Trigger on FAULT conditions
        if (fltObject->Counter >= fltObject->TripResponse.eventThreshold)
        {
            fltObject->Status.bits.FaultStatus = true;    // Set FAULT STATUS FLAG BIT
            fltObject->Counter = fltObject->TripResponse.eventThreshold; // Set fault event counter to threshold level
            if (fltObject->TripResponse.ptrResponseFunction != NULL)    // If a user function has been defined,
                retval = fltObject->TripResponse.ptrResponseFunction();   // => call this function and capture return value
        }
 
    }
    // If a FAULT has been tripped but no fault condition has been detected anymore....
    else if ((fltObject->Status.bits.FaultStatus) && (!fltObject->Status.bits.FaultActive)) {
    
        fltObject->Counter++;  // Increment fault event counter
 
        // Trigger on RECOVERY conditions
        if (fltObject->Counter >= fltObject->RecoveryResponse.eventThreshold)
        {
            fltObject->Status.bits.FaultStatus = false;   // Clear FAULT STATUS FLAG BIT
            fltObject->Counter = fltObject->RecoveryResponse.eventThreshold; // Set fault event counter to threshold level
            if (fltObject->RecoveryResponse.ptrResponseFunction != NULL)   // If a user function has been defined,
                retval = fltObject->RecoveryResponse.ptrResponseFunction();  // => call this function and capture return value
        }
    
    }
    // If everything is OK, reset counter
    else
    {
        fltObject->Counter = 0;  // clear fault event counter
    }
 
    
    return (retval); // Fault handler executed successfully
}
 
 
// end of file