Digital Power Starter Kit 3 Firmware
dsPIC33C Buck Converter Voltage Mode Control Example
dev_buck_converter.h
1 
33 /*
34  * File: dev_buck_converter.h
35  * Author: M91406
36  * Comments: power controller functions for buck converter
37  * Revision history:
38  * 1.0 initial version
39  */
40 
41 // This is a guard condition so that contents of this file are not included
42 // more than once.
43 #ifndef BUCK_CONVERTER_STATE_MACHINE_H
44 #define BUCK_CONVERTER_STATE_MACHINE_H
45 
46 #include <xc.h> // include processor files - each processor file is guarded.
47 #include <stdint.h> // include standard integer types header file
48 #include <stdbool.h> // include standard boolean types header file
49 
50 #include "dev_buck_typedef.h"
51 
52  // ==============================================================================================
53  // BUCK CONVERTER PUBLIC API FUNCTION CALL PROTOTYPES
54  // ==============================================================================================
55 
56 extern volatile uint16_t drv_BuckConverter_Initialize(volatile struct BUCK_CONVERTER_s* buckInstance);
57 extern volatile uint16_t drv_BuckConverter_Execute(volatile struct BUCK_CONVERTER_s* buckInstance);
58 extern volatile uint16_t drv_BuckConverter_Start(volatile struct BUCK_CONVERTER_s* buckInstance);
59 extern volatile uint16_t drv_BuckConverter_Stop(volatile struct BUCK_CONVERTER_s* buckInstance);
60 extern volatile uint16_t drv_BuckConverter_Suspend(volatile struct BUCK_CONVERTER_s* buckInstance);
61 extern volatile uint16_t drv_BuckConverter_Resume(volatile struct BUCK_CONVERTER_s* buckInstance);
62 
63 #endif /* BUCK_CONVERTER_STATE_MACHINE_H */
64 
65 // END OF FILE
drv_BuckConverter_Resume
volatile uint16_t drv_BuckConverter_Resume(volatile struct BUCK_CONVERTER_s *buckInstance)
This function resume the operation of the buck converter.
Definition: dev_buck_converter.c:294
drv_BuckConverter_Start
volatile uint16_t drv_BuckConverter_Start(volatile struct BUCK_CONVERTER_s *buckInstance)
This function starts the buck converter.
Definition: dev_buck_converter.c:197
drv_BuckConverter_Initialize
volatile uint16_t drv_BuckConverter_Initialize(volatile struct BUCK_CONVERTER_s *buckInstance)
This function initializes all peripheral modules and their instances used by the power controller.
Definition: dev_buck_converter.c:30
drv_BuckConverter_Stop
volatile uint16_t drv_BuckConverter_Stop(volatile struct BUCK_CONVERTER_s *buckInstance)
This function stop the buck converter opration.
Definition: dev_buck_converter.c:240
BUCK_CONVERTER_s
BUCK control & monitoring data structure.
Definition: dev_buck_typedef.h:501
drv_BuckConverter_Execute
volatile uint16_t drv_BuckConverter_Execute(volatile struct BUCK_CONVERTER_s *buckInstance)
This function is the main buck converter state machine executing the most recent state.
Definition: dev_buck_converter.c:82
drv_BuckConverter_Suspend
volatile uint16_t drv_BuckConverter_Suspend(volatile struct BUCK_CONVERTER_s *buckInstance)
This function suspends the operation of the buck converter.
Definition: dev_buck_converter.c:273