GM6000 Digital Heater Controller Branch: main
SDX-1330
Api.h
Go to the documentation of this file.
1#ifndef Bsp_grand_central_m4_Api_h_
2#define Bsp_grand_central_m4_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) 2017 John T. Taylor
10*
11* Redistributions of the source code must retain the above copyright notice.
12*----------------------------------------------------------------------------*/
13/** @file
14
15
16 This BSP is developed/build with a 'just-in-time' approach. This means
17 as functional is added to the BSP incrementally as there is 'client'
18 need for. This BSP does not claim to provide full/complete functional
19 and/or APIs for everything the board supports.
20
21
22 DO NOT include this file directly! Instead include the generic BSP
23 interface - src/Bsp/Api.h - and then configure your project's
24 'colony_map.h' to include THIS file.
25
26*----------------------------------------------------------------------------*/
27
28
29#include "colony_config.h"
30#include "FreeRTOS.h"
31#include "USBAPI.h"
32#include "HardwareSerial.h"
33#include "variant.h"
34
35//////////////////////////////////////////////////////////
36/// Board Specific APIs
37//////////////////////////////////////////////////////////
38/** Initialize the primary serial port AND it waits for
39 a Host to connect to the serial port.
40*/
41void Bsp_beginArduinoSerialObject( unsigned long baudrate, uint16_t frameConfig );
42
43/** This method initializes and start the SdFat file system on the onboard 8MB
44 data flash
45 */
46void Bsp_beginFileSystem();
47
48/** Returns a reference to the Primary Serial Port Object. This is implicitly
49 exposed (can't directly expose it due to racing conditions on how the colony_map.h
50 header files work). This means that the application must cut-n-paste the following
51 extern statement to get access to this method.
52
53 extern Cpl::Io::InputOutput& Bsp_Serial(void);
54*/
55
56/* Serial Object's Frame Configuration Options. Note: These
57 values are copied from HardwareSerial.h header file because
58 including the HardwareSerial.h file directly breaks all sorts
59 of things (i.e. the Arduino stuff is not namespace protected)
60*/
61#define HARDSER_PARITY_EVEN (0x1ul)
62#define HARDSER_PARITY_ODD (0x2ul)
63#define HARDSER_PARITY_NONE (0x3ul)
64#define HARDSER_PARITY_MASK (0xFul)
65
66#define HARDSER_STOP_BIT_1 (0x10ul)
67#define HARDSER_STOP_BIT_1_5 (0x20ul)
68#define HARDSER_STOP_BIT_2 (0x30ul)
69#define HARDSER_STOP_BIT_MASK (0xF0ul)
70
71#define HARDSER_DATA_5 (0x100ul)
72#define HARDSER_DATA_6 (0x200ul)
73#define HARDSER_DATA_7 (0x300ul)
74#define HARDSER_DATA_8 (0x400ul)
75#define HARDSER_DATA_MASK (0xF00ul)
76
77#define SERIAL_5N1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_NONE | HARDSER_DATA_5)
78#define SERIAL_6N1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_NONE | HARDSER_DATA_6)
79#define SERIAL_7N1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_NONE | HARDSER_DATA_7)
80#define SERIAL_8N1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_NONE | HARDSER_DATA_8)
81#define SERIAL_5N2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_NONE | HARDSER_DATA_5)
82#define SERIAL_6N2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_NONE | HARDSER_DATA_6)
83#define SERIAL_7N2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_NONE | HARDSER_DATA_7)
84#define SERIAL_8N2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_NONE | HARDSER_DATA_8)
85#define SERIAL_5E1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_EVEN | HARDSER_DATA_5)
86#define SERIAL_6E1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_EVEN | HARDSER_DATA_6)
87#define SERIAL_7E1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_EVEN | HARDSER_DATA_7)
88#define SERIAL_8E1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_EVEN | HARDSER_DATA_8)
89#define SERIAL_5E2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_EVEN | HARDSER_DATA_5)
90#define SERIAL_6E2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_EVEN | HARDSER_DATA_6)
91#define SERIAL_7E2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_EVEN | HARDSER_DATA_7)
92#define SERIAL_8E2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_EVEN | HARDSER_DATA_8)
93#define SERIAL_5O1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_ODD | HARDSER_DATA_5)
94#define SERIAL_6O1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_ODD | HARDSER_DATA_6)
95#define SERIAL_7O1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_ODD | HARDSER_DATA_7)
96#define SERIAL_8O1 (HARDSER_STOP_BIT_1 | HARDSER_PARITY_ODD | HARDSER_DATA_8)
97#define SERIAL_5O2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_ODD | HARDSER_DATA_5)
98#define SERIAL_6O2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_ODD | HARDSER_DATA_6)
99#define SERIAL_7O2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_ODD | HARDSER_DATA_7)
100#define SERIAL_8O2 (HARDSER_STOP_BIT_2 | HARDSER_PARITY_ODD | HARDSER_DATA_8)
101
102//////////////////////////////////////////////////////////
103/// Board Specific APIs
104//////////////////////////////////////////////////////////
105
106/// Arduino Pin Number
107#define PIN_ONBOARD_IDT PIN_A0
108
109/// Arduino Pin Number
110#define PIN_BUTTON_A 12
111
112/// Arduino Pin Number
113#define PIN_BUTTON_B 11
114
115/// Arduino Pin Number
116#define PIN_BUTTON_X 10
117
118/// Arduino Pin Number
119#define PIN_BUTTON_Y 9
120
121/// Arduino Pin Number
122#define PIN_HW_SAFETY 8
123
124/// Arduino Pin Number
125#define PIN_RESET_LCD 7
126
127/// Arduino Pin Number
128#define PIN_LCD_DC 6
129
130/// Arduino Pin Number
131#define PIN_PWM_LED_RED 5
132
133/// Arduino Pin Number
134#define PIN_PWM_LED_GREEN 4
135
136/// Arduino Pin Number
137#define PIN_PWM_LED_BLUE 3
138
139/// Arduino Pin Number
140#define PIN_PWM_LCD_BACKLIGHT 2
141
142/// Arduino Pin Number
143#define PIN_LCD_CS 53
144
145/// Arduino Pin Number
146#define PIN_PWM_HEATER 18
147
148/// Arduino Pin Number
149#define PIN_PWM_FAN 19
150
151/// Arduino Pin Number (alias)
152#define PIN_LCD_SPI_CLK PIN_SPI_SCK
153
154/// Arduino Pin Number (alias)
155#define PIN_LCD_SPI_MOSI PIN_SPI_MOSI
156
157/// Arduino Pin Number (alias)
158#define PIN_LCD_SPI_MISO PIN_SPI_MISO
159
160/// Arduino SPI driver instance (alias)
161#define LCD_SPI_DRIVER SPI
162
163
164/// Arduino Pin Number (alias)
165#define PIN_I2C_BUS_SCK PIN_WIRE_SCL
166
167/// Arduino Pin Number (alias)
168#define PIN_I2C_BUS_SDA PIN_WIRE_SDA
169
170/// Arduino I2C driver instance (alias)
171#define I2C_BUS_DRIVER Wire
172
173/// 7bit address for the offboard EEPROM
174#define BSP_I2C_ADDRESS_EEPROM 0x50
175
176
177//////////////////////////////////////////////////////////
178/// ARM Specific APIs
179//////////////////////////////////////////////////////////
180
181/// Disable a specific interrupt (with memory barrier protection)
182#define Bsp_NVIC_disableIRQ( irqNum ) do { NVIC_DisableIRQ(irqNum); __DSB(); __ISB(); } while(0)
183
184/// Enable a specific interrupt (with memory barrier protection)
185#define Bsp_NVIC_enableIRQ( irqNum ) do { NVIC_EnableIRQ(irqNum); __DSB(); __ISB(); } while(0)
186
187/// Resets the MCU
188#define Bsp_Api_reset_MCU() NVIC_SystemReset()
189
190//////////////////////////////////////////////////////////
191/// Generic APIs
192//////////////////////////////////////////////////////////
193
194/// Generic API
195#define Bsp_Api_nop_MAP() __asm("nop")
196
197/// Generic API
198#define Bsp_Api_disableIrqs_MAP() taskENTER_CRITICAL()
199
200/// Generic API
201#define Bsp_Api_enableIrqs_MAP() taskEXIT_CRITICAL()
202
203/// Generic API
204#define Bsp_Api_pushAndDisableIrqs_MAP() taskENTER_CRITICAL() // FIXME: This really needs to PUSH the IRQ state!!!
205
206/// Generic API
207#define Bsp_Api_popIrqs_MAP() taskEXIT_CRITICAL() // FIXME: This really needs to POP the IRQ state!!!!
208
209
210
211
212/// Default Mapping for the "debug LED 1"
213#ifndef OPTION_BSP_DEBUG_LED1_INDEX
214#define OPTION_BSP_DEBUG_LED1_INDEX PIN_LED
215#endif
216
217/// Default Mapping for the "debug LED 2"
218#ifndef OPTION_BSP_DEBUG_LED2_INDEX
219#define OPTION_BSP_DEBUG_LED2_INDEX DEBUG_LED_IS_NOT_SUPPORTED
220#endif
221
222
223/// Generic API
224#define Bsp_Api_turnOn_debug1_MAP() digitalWrite( OPTION_BSP_DEBUG_LED1_INDEX, HIGH )
225
226/// Generic API
227#define Bsp_Api_turnOff_debug1_MAP() digitalWrite( OPTION_BSP_DEBUG_LED1_INDEX, LOW )
228
229/// Generic API
230#define Bsp_Api_toggle_debug1_MAP() digitalWrite( OPTION_BSP_DEBUG_LED1_INDEX, !digitalRead(OPTION_BSP_DEBUG_LED1_INDEX) )
231
232
233/// Generic API
234#define Bsp_Api_turnOn_debug2_MAP() digitalWrite( OPTION_BSP_DEBUG_LED2_INDEX, HIGH )
235
236/// Generic API
237#define Bsp_Api_turnOff_debug2_MAP() digitalWrite( OPTION_BSP_DEBUG_LED2_INDEX, LOW )
238
239/// Generic API
240#define Bsp_Api_toggle_debug2_MAP() digitalWrite( OPTION_BSP_DEBUG_LED2_INDEX, !digitalRead(OPTION_BSP_DEBUG_LED2_INDEX) )
241
242
243
244#endif // end header latch
Bsp_beginArduinoSerialObject
void Bsp_beginArduinoSerialObject(unsigned long baudrate, uint16_t frameConfig)
Board Specific APIs.
Bsp_beginFileSystem
void Bsp_beginFileSystem()
This method initializes and start the SdFat file system on the onboard 8MB data flash.
Generated on Sat Jan 18 2025 22:23:55 for GM6000 Digital Heater Controller by doxygen 1.9.8