GM6000 Digital Heater Controller Branch: main
SDX-1330
Api.h
Go to the documentation of this file.
1#ifndef Bsp_Api_h_
2#define Bsp_Api_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 the common/generic interfaces that all Colony.* BSP
16 are required to support. Note: Many of the common interfaces are defined
17 as C preprocessor macros - this provides the maximum flexibility in
18 implementation for a concrete BSP. Only functions that 'should be' or
19 need to be true function calls are defined in this class.
20 */
21
22
23#include "colony_config.h"
24#include "colony_map.h"
25
26
27// Start C++
28#ifdef __cplusplus
29extern "C" {
30#endif
31
32
33/////////////////////////////////////////////////////////////////////////////
34//
35
36/** This method will initialize the board/low level hardware such that BASIC
37 board operation is possible. Additional initialization of peripherals may
38 be required - see your specific BSP header file for details.
39
40 NOTE: Since this method is intended to be called by the Application - it
41 is 'run' AFTER main() has been entered.
42 */
43void Bsp_Api_initialize( void );
44
45
46 /** This method inserts a single 'nop' instruction
47
48 \b Prototype:
49 void Bsp_Api_nop(void);
50 */
51#define Bsp_Api_nop Bsp_Api_nop_MAP
52
53
54 /////////////////////////////////////////////////////////////////////////////
55 //
56 /** This method will disable ALL interrupts, i.e manipulate the global
57 enable/disable flag in the PSW.
58
59 \b Prototype:
60 void Bsp_Api_disableIrqs( void );
61 */
62#define Bsp_Api_disableIrqs Bsp_Api_disableIrqs_MAP
63
64
65 /** This method will enable ALL interrupts, i.e manipulate the global
66 enable/disable flag in the PSW.
67
68 \b Prototype:
69 void Bsp_Api_enableIrqs( void );
70 */
71#define Bsp_Api_enableIrqs Bsp_Api_enableIrqs_MAP
72
73
74 /** This method will push the current IRQ enabled/disabled flags onto
75 the stack and then disable ALL interrupts. This method should all
76 be called in 'pairs' with the Bsp_Api_popIrqs() method.
77
78 NOTE: This method MAY push the CPU's entire Program Status Word (PSW) onto
79 the stack and the corresponding Bsp_Api_popIrq() will restore the
80 ENTIRE PSW word. What does this mean - usually nothing but things
81 like the zero, carry, overflow flags, etc. are stored in the PSW and
82 we be reverted (when 'pop' is called) to the state of when the 'push'
83 was done.
84
85 \b Prototype:
86 void Bsp_Api_pushAndDisableIrqs( void );
87 */
88#define Bsp_Api_pushAndDisableIrqs Bsp_Api_pushAndDisableIrqs_MAP
89
90
91 /** This method will pop/update the IRQ enabled/disabled flags from
92 a previously push IRQ state value. This method should all
93 be called in 'pairs' with the Bsp_Api_pushAndDisableIrqs() method.
94
95 \b Prototype:
96 void Bsp_Api_popIrqs( void );
97 */
98#define Bsp_Api_popIrqs Bsp_Api_popIrqs_MAP
99
100
101/////////////////////////////////////////////////////////////////////////////
102//
103/** This method will turn on "Debug LED 1". The concept is that every board
104 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
105
106 \b Prototype:
107 void Bsp_Api_turnOn_debug1( void );
108 */
109#define Bsp_Api_turnOn_debug1 Bsp_Api_turnOn_debug1_MAP
110
111
112/** This method will turn off "Debug LED 1". The concept is that every board
113 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
114
115 \b Prototype:
116 void Bsp_Api_turnOff_debug1( void );
117 */
118#define Bsp_Api_turnOff_debug1 Bsp_Api_turnOff_debug1_MAP
119
120/** This method will toggle "Debug LED 1". The concept is that every board
121 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
122
123 \b Prototype:
124 void Bsp_Api_toggle_debug1( void );
125 */
126#define Bsp_Api_toggle_debug1 Bsp_Api_toggle_debug1_MAP
127
128
129
130/** This method will turn on "Debug LED 2". The concept is that every board
131 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
132
133 \b Prototype:
134 void Bsp_Api_turnOn_debug2( void );
135 */
136#define Bsp_Api_turnOn_debug2 Bsp_Api_turnOn_debug2_MAP
137
138
139/** This method will turn off "Debug LED 2". The concept is that every board
140 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
141
142 \b Prototype:
143 void Bsp_Api_turnOff_debug2( void );
144 */
145#define Bsp_Api_turnOff_debug2 Bsp_Api_turnOff_debug2_MAP
146
147/** This method will toggle "Debug LED 2". The concept is that every board
148 has one or more LEDs, IO Pins, etc. that can be used for debugging purposes.
149
150 \b Prototype:
151 void Bsp_Api_toggle_debug2( void );
152 */
153#define Bsp_Api_toggle_debug2 Bsp_Api_toggle_debug2_MAP
154
155
156
157// End C++
158#ifdef __cplusplus
159};
160#endif
161#endif // end header latch
Bsp_Api_initialize
void Bsp_Api_initialize(void)
This method will initialize the board/low level hardware such that BASIC board operation is possible.
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8