GM6000 Digital Heater Controller Branch: main
SDX-1330
Execution.h
Go to the documentation of this file.
1#ifndef Bsp_Execution_h_
2#define Bsp_Execution_h_
3/*-----------------------------------------------------------------------------
4* This file is part of the Colony.Core Project. The Colony.Core Project is an
5* open source project with a BSD type of licensing agreement. See the license
6* agreement (license.txt) in the top/ directory or on the Internet at
7* http://integerfox.com/colony.core/license.txt
8*
9* Copyright (c) 2014-2019 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file
14
15 This file defines a common/generic interface for restarting, rebooting,
16 etc. and application and/or a physical device. The actual implementation
17 is obviously platform dependent and as such the specific behavior is NOT
18 guarantied on ALL platforms. However, what is GUARENTIED for ALL
19 platforms is that the execution of the application will be stopped - at
20 least momentarily.
21
22 ALL Colony.* BSPs are ENCOURAGED to support this interface. The default
23 implementation maps to a forever loop with interrupts disabled. Use the
24 config preprocessor symbols HAVE_BSP_EXECUTION_xxx to disable and/or turn
25 off the default implementation.
26 */
27
28
29#include "Bsp/Api.h"
30
31
32// Start C++
33#ifdef __cplusplus
34extern "C" {
35#endif
36
37
38/////////////////////////////////////////////////////////////////////////////
39//
40
41/// Reset type unknown or not supported
42#define BSP_EXECUTION_RESET_UNKNOWN BSP_EXECUTION_RESET_UNKNOWN_MAP
43
44/// Cold boot
45#define BSP_EXECUTION_RESET_COLD BSP_EXECUTION_RESET_COLD_MAP
46
47/// Warm boot
48#define BSP_EXECUTION_RESET_WARM BSP_EXECUTION_RESET_WARM_MAP
49
50/// Reset due to drop in Voltage
51#define BSP_EXECUTION_RESET_BROWN_OUT BSP_EXECUTION_RESET_BROWN_OUT_MAP
52
53/// Reset due to an unhandled CPU exception/error
54#define BSP_EXECUTION_RESET_EXECPTION BSP_EXECUTION_RESET_EXECPTION_MAP
55
56
57/** This method returns information about the how the application's platform
58 was last came out of reset. See the above BSP_EXECUTION_RESET_xxxx
59 macros for the possible return values. The application/platform is free
60 define additional reason codes
61
62
63 \b Prototype:
64 uint32_t Bsp_Execution_getResetType(void);
65 */
66#define Bsp_Execution_getResetType Bsp_Execution_getResetType_MAP
67
68
69
70/////////////////////////////////////////////////////////////////////////////
71//
72/** This method reboots the application's platform. There are no guaranties on
73 how gracefully or safe the reboot is.
74
75 \b Prototype:
76 void Bsp_Execution_reboot( void );
77 */
78#define Bsp_Execution_reboot Bsp_Execution_reboot_MAP
79
80
81/** This method shuts down the application's platform. There are no guaranties on
82 how gracefully or safe the shutdown is.
83
84 \b Prototype:
85 void Bsp_Execution_shutdown( void );
86 */
87#define Bsp_Execution_shutdown Bsp_Execution_shutdown_MAP
88
89
90
91
92/////////////////////////////////////////////////////////////////////////////
93// DEFAULT IMPLEMENATION
94/////////////////////////////////////////////////////////////////////////////
95
96#ifndef DOXYGEN_WILL_SKIP_THIS
97
98#ifndef HAVE_BSP_EXECUTION_REBOOT
99#define Bsp_Execution_reboot_MAP() {Bsp_Api_disableIrqs();for(;;);}
100#endif
101
102#ifndef HAVE_BSP_EXECUTION_SHUTDOWN
103#define Bsp_Execution_shutdown_MAP() {Bsp_Api_disableIrqs();for(;;);}
104#endif
105
106
107#ifndef HAVE_BSP_EXECUTION_GET_RESET_TYPE
108#define BSP_EXECUTION_RESET_UNKNOWN_MAP 0
109#define BSP_EXECUTION_RESET_COLD_MAP 1
110#define BSP_EXECUTION_RESET_WARM_MAP 2
111#define BSP_EXECUTION_RESET_BROWN_OUT_MAP 3
112#define BSP_EXECUTION_RESET_EXECPTION_MAP 4
113
114#define Bsp_Execution_getResetType_MAP() BSP_EXECUTION_RESET_UNKNOWN
115#endif
116
117
118#endif // end DOXYGEN_WILL_SKIP_THIS
119
120#ifdef __cplusplus
121};
122#endif
123
124
125#endif // end header latch
Api.h
This file defines the common/generic interfaces that all Colony.
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8