| Digital Power Starter Kit 3 Firmware dsPIC33C Boost Converter Voltage Mode Control Example |

dev_boost_special_functions.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:
24 * Author:
25 * Comments:
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 BOOST_CONVERTER_SPECIAL_FUNCTIONS_H
32 #define BOOST_CONVERTER_SPECIAL_FUNCTIONS_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 /****************************************************************************************************
40 * @ingroup lib-layer-boost-specialfn-properties-data-types
41 * @enum BOOST_SPECIAL_FUNCTIONS_e
42 * @brief Enumeration of special function sub-states
43 * @details
44 * This enumeration provides labels for indices of the private array BoostConverterSpecialFunctions[].
45 * External functions call special functions by calling the high level function
46 * drv_BoostConverter_SpecialFunctionExecute() by handing in a pointer to a power converter object
47 * and the Special Function state to execute. This allows the extension of state machine to include
48 * Special Functions available.
49 **************************************************************************************************** */
50 typedef enum BOOST_SPECIAL_FUNCTIONS_e
51 {
52 CS_OFSET_CALIBRATION
53
54 } BOOST_SPECIAL_FUNCTIONS_t; // Enumeration of special function sub-states
55
56
57 /* PUBLIC FUNCTION CALL PROTOTYPES */
58
59 extern volatile uint16_t drv_BoostConverter_SpecialFunctionExecute (
60 volatile struct BOOST_CONVERTER_s * boostInstance,
61 volatile enum BOOST_SPECIAL_FUNCTIONS_e specialFunction);
62
63 #endif /* BOOST_CONVERTER_SPECIAL_FUNCTIONS_H */
64
65 // end of file
BOOST_CONVERTER_s
BOOST control & monitoring data structure.
Definition: dev_boost_typedef.h:527