Digital Power Starter Kit 3 Firmware
dsPIC33C Buck Converter Voltage Mode Control Example
app_fault_monitor.h
1 /* Microchip Technology Inc. and its subsidiaries. You may use this software
2  * and any derivatives exclusively with Microchip products.
3  *
4  * THIS SOFTWARE IS SUPPLIED BY MICROCHIP "AS IS". NO WARRANTIES, WHETHER
5  * EXPRESS, IMPLIED OR STATUTORY, APPLY TO THIS SOFTWARE, INCLUDING ANY IMPLIED
6  * WARRANTIES OF NON-INFRINGEMENT, MERCHANTABILITY, AND FITNESS FOR A
7  * PARTICULAR PURPOSE, OR ITS INTERACTION WITH MICROCHIP PRODUCTS, COMBINATION
8  * WITH ANY OTHER PRODUCTS, OR USE IN ANY APPLICATION.
9  *
10  * IN NO EVENT WILL MICROCHIP BE LIABLE FOR ANY INDIRECT, SPECIAL, PUNITIVE,
11  * INCIDENTAL OR CONSEQUENTIAL LOSS, DAMAGE, COST OR EXPENSE OF ANY KIND
12  * WHATSOEVER RELATED TO THE SOFTWARE, HOWEVER CAUSED, EVEN IF MICROCHIP HAS
13  * BEEN ADVISED OF THE POSSIBILITY OR THE DAMAGES ARE FORESEEABLE. TO THE
14  * FULLEST EXTENT ALLOWED BY LAW, MICROCHIP'S TOTAL LIABILITY ON ALL CLAIMS
15  * IN ANY WAY RELATED TO THIS SOFTWARE WILL NOT EXCEED THE AMOUNT OF FEES, IF
16  * ANY, THAT YOU HAVE PAID DIRECTLY TO MICROCHIP FOR THIS SOFTWARE.
17  *
18  * MICROCHIP PROVIDES THIS SOFTWARE CONDITIONALLY UPON YOUR ACCEPTANCE OF THESE
19  * TERMS.
20  */
21 
22 /*
23  * File: app_fault_monitor.h
24  * Author: M91406
25  * Comments: global fault handler application layer API
26  * Revision history:
27  */
28 
29 // This is a guard condition so that contents of this file are not included
30 // more than once.
31 #ifndef APPLICATION_LAYER_FAULTS_HEADER_H
32 #define APPLICATION_LAYER_FAULTS_HEADER_H
33 
34 #include <xc.h> // include processor files - each processor file is guarded.
35 #include <stdint.h> // include standard integer data types
36 #include <stdbool.h> // include standard boolean data types
37 #include <stddef.h> // include standard definition data types
38 
39 #include "drivers/drv_fault_handler.h"
40 
41 // Public Variable Declaration
42 extern volatile struct FAULT_OBJECT_s fltobj_BuckUVLO;
43 extern volatile struct FAULT_OBJECT_s fltobj_BuckOVLO;
44 extern volatile struct FAULT_OBJECT_s fltobj_BuckRegErr;
45 extern volatile struct FAULT_OBJECT_s fltobj_BuckOCP;
46 
47 // PUBLIC FUNCTION PROTOTYPE DECLARATIONS
48 extern volatile uint16_t appFaultMonitor_Initialize(void);
49 extern volatile uint16_t appFaultMonitor_Execute(void);
50 extern volatile uint16_t appFaultMonitor_Dispose(void);
51 
52 #endif /* APPLICATION_LAYER_FAULTS_HEADER_H */
53 
fltobj_BuckRegErr
volatile struct FAULT_OBJECT_s fltobj_BuckRegErr
Regulation Error Fault Object.
Definition: app_fault_monitor.c:53
fltobj_BuckUVLO
volatile struct FAULT_OBJECT_s fltobj_BuckUVLO
Under Voltage Lock Out Fault Object.
Definition: app_fault_monitor.c:50
FAULT_OBJECT_s
This data structure is a collection of data structures for fault handling.
Definition: drv_fault_handler.h:131
fltobj_BuckOVLO
volatile struct FAULT_OBJECT_s fltobj_BuckOVLO
Over Voltage Lock Out Fault Object.
Definition: app_fault_monitor.c:51
fltobj_BuckOCP
volatile struct FAULT_OBJECT_s fltobj_BuckOCP
Over Current Protection Fault Object.
Definition: app_fault_monitor.c:52
appFaultMonitor_Execute
volatile uint16_t appFaultMonitor_Execute(void)
Application wide fault object monitoring routine.
Definition: app_fault_monitor.c:56
appFaultMonitor_Dispose
volatile uint16_t appFaultMonitor_Dispose(void)
Function clearing all fault object settings.
Definition: app_fault_monitor.c:165
appFaultMonitor_Initialize
volatile uint16_t appFaultMonitor_Initialize(void)
Initialization of user-defined fault objects.
Definition: app_fault_monitor.c:138