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

apps.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: apps.h
24 * Author: M91406
25 * Comments: global defines of this application
26 * Revision history:
27 * v1.0 initial version
28 */
29
30 // This is a guard condition so that contents of this file are not included
31 // more than once.
32 #ifndef APPLICATION_GLOBALS_HEADER_H
33 #define APPLICATION_GLOBALS_HEADER_H
34
35 #include <xc.h> // include processor files - each processor file is guarded.
36 #include <stdint.h> // include standard integer data types
37 #include <stdbool.h> // include standard boolean data types
38 #include <stddef.h> // include standard definition data types
39
40 // APPLICATION LAYER HEADER FILES
41 #include "fault_handler/app_fault_monitor.h"
42 #include "power_control/app_power_control.h"
43 #include "led/app_led.h"
44 #include "lcd/app_lcd.h"
45 #include "push_button/app_push_button.h"
46 // end of group application-tasks
48
49 /*********************************************************************************
50 * @ingroup application-version-macro
51 * @def FIRMWARE_VERSION
52 * @brief 32-bit wide, Integer encoded firmware version number
53 * @details
54 * This macro returns the most recent firmware version as integer encoded
55 * value of format
56 *
57 * [MAJOR][MINOR][REVISION]
58 *
59 * with
60 * - MAJOR being one to three digits wide (without leading zeros)
61 * - MINOR being two digits wide (with leading zeros)
62 * - REVISION being three digits wide (with leading zeros)
63 *
64 * Version 1.2.23 will be encoded as 1.02.023 and shown as integer value of 102023.
65 * The largest firmware version number supported is 999.99.999.
66 *
67 * Firmware modules can use this integer encoded firmware version to conditional
68 * select code sections depending on the availability of firmware version-specific
69 * features or limitations.
70 **********************************************************************************/
71 #define FIRMWARE_VERSION (uint32_t) 103001
72
73 /*********************************************************************************
74 * @ingroup application-version-macro
75 * @def FIRMWARE_VERSION_STRING
76 * @brief Clear-test string of firmware version
77 * @details
78 * This macro returns the most recent firmware version as clear-text string of
79 * fixed length of 10 characters of which the first three are reserved for MAJOR.
80 * followed by a separating dot, followed by two characters for MINOR, followed
81 * by a separating dot and finally three characters reserved for the revision
82 * number REV.
83 * This string may be used to be displayed in terminal windows or LC displays.
84 **********************************************************************************/
85 #define FIRMWARE_VERSION_STRING "001.03.001"
86
87 /*********************************************************************************
88 * @ingroup application-version-macro
89 * @def FIRMWARE_TITLE
90 * @brief Clear-test string of firmware title
91 * @details
92 * This macro returns the most recent firmware title as clear-text string of
93 * fixed length of 16 characters. This string is displayed on the LC display
94 * at power-up or after a CPU reset (splash-screen).
95 **********************************************************************************/
96 #define FIRMWARE_TITLE "==== DPSK-3 ===="
97
98 /*********************************************************************************
99 * @ingroup application-version-macro
100 * @def FIRMWARE_NAME
101 * @brief Clear-test string of firmware name
102 * @details
103 * This macro returns the most recent firmware name as clear-text string of
104 * fixed length of 16 characters. This string is displayed on the LC display
105 * at power-up or after a CPU reset (splash-screen).
106 **********************************************************************************/
107 #define FIRMWARE_NAME "BOOST VMC EXAMPLE"
108
109 #endif /* APPLICATION_GLOBALS_HEADER_H */
110