-
Notifications
You must be signed in to change notification settings - Fork 85
/
driver.h
432 lines (365 loc) · 12.5 KB
/
driver.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
/*
driver.h - driver code for STM32F4xx ARM processors
Part of grblHAL
Copyright (c) 2019-2022 Terje Io
Grbl is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Grbl is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Grbl. If not, see <http://www.gnu.org/licenses/>.
*/
//
// NOTE: do NOT change configuration here - edit my_machine.h instead!
//
#ifndef __DRIVER_H__
#define __DRIVER_H__
#include <stdbool.h>
#include <stdint.h>
#ifndef OVERRIDE_MY_MACHINE
#include "my_machine.h"
#endif
#include "main.h"
#include "grbl/driver_opts.h"
#define BITBAND_PERI(x, b) (*((__IO uint8_t *) (PERIPH_BB_BASE + (((uint32_t)(volatile const uint32_t *)&(x)) - PERIPH_BASE)*32 + (b)*4)))
#define DIGITAL_IN(port, pin) BITBAND_PERI(port->IDR, pin)
#define DIGITAL_OUT(port, pin, on) { BITBAND_PERI((port)->ODR, pin) = on; }
#define timer(t) timerN(t)
#define timerN(t) TIM ## t
#define timerINT(t) timerint(t)
#define timerint(t) TIM ## t ## _IRQn
#define timerHANDLER(t) timerhandler(t)
#define timerhandler(t) TIM ## t ## _IRQHandler
#define timerCCEN(c, n) timerccen(c, n)
#define timerccen(c, n) TIM_CCER_CC ## c ## n ## E
#define timerCCMR(p, c) timerccmr(p, c)
#define timerccmr(p, c) TIM ## p->CCMR ## c
#define timerOCM(p, c) timerocm(p, c)
#define timerocm(p, c) TIM_CCMR ## p ##_OC ## c ## M_1|TIM_CCMR ## p ##_OC ## c ## M_2
#define timerOCMC(p, c) timerocmc(p, c)
#define timerocmc(p, c) (TIM_CCMR ## p ##_OC ## c ## M|TIM_CCMR ## p ##_CC ## c ## S)
#define timerCCR(t, c) timerccr(t, c)
#define timerccr(t, c) TIM ## t->CCR ## c
#define timerCCP(c, n) timerccp(c, n)
#define timerccp(c, n) TIM_CCER_CC ## c ## n ## P
#define timerCR2OIS(c, n) timercr2ois(c, n)
#define timercr2ois(c, n) TIM_CR2_OIS ## c ## n
#define timerAF(t, f) timeraf(t, f)
#define timeraf(t, f) GPIO_AF ## f ## _TIM ## t
#define timerCLKENA(t) timercken(t)
#define timercken(t) __HAL_RCC_TIM ## t ## _CLK_ENABLE
#define usart(t) usartN(t)
#define usartN(t) USART ## t
#define usartINT(t) usartint(t)
#define usartint(t) USART ## t ## _IRQn
#define usartHANDLER(t) usarthandler(t)
#define usarthandler(t) USART ## t ## _IRQHandler
// Configuration, do not change here
#define CNC_BOOSTERPACK 0
// Define GPIO output mode options
#define GPIO_SHIFT0 0
#define GPIO_SHIFT1 1
#define GPIO_SHIFT2 2
#define GPIO_SHIFT3 3
#define GPIO_SHIFT4 4
#define GPIO_SHIFT5 5
#define GPIO_SHIFT6 6
#define GPIO_SHIFT7 7
#define GPIO_SHIFT8 8
#define GPIO_SHIFT9 9
#define GPIO_SHIFT10 10
#define GPIO_SHIFT11 11
#define GPIO_SHIFT12 12
#define GPIO_SHIFT13 13
#define GPIO_MAP 14
#define GPIO_BITBAND 15
#ifndef IS_NUCLEO_DEVKIT
#if defined(NUCLEO_F401) || defined(NUCLEO_F411) || defined(NUCLEO_F446)
#define IS_NUCLEO_DEVKIT 1
#else
#define IS_NUCLEO_DEVKIT 0
#endif
#endif
#ifdef BOARD_BTT_SKR_PRO_1_2
#define BOARD_BTT_SKR_PRO_1_1
#endif
#ifdef BOARD_CNC_BOOSTERPACK
#if N_AXIS > 3
#error Max number of axes is 3!
#endif
#include "cnc_boosterpack_map.h"
#elif defined(BOARD_CNC3040)
#if EEPROM_ENABLE
#error EEPROM plugin not supported!
#endif
#include "cnc3040_map.h"
#elif defined(BOARD_BLACKPILL)
#include "blackpill_map.h"
#elif defined(BOARD_BTT_SKR_PRO_1_1)
#include "btt_skr_pro_v1_1_map.h"
#elif defined(BOARD_BTT_SKR_20)
#include "btt_skr_2.0_map.h"
#elif defined(BOARD_BTT_SKR_20_DAC)
#include "btt_skr_2.0_dac_map.h"
#elif defined(BOARD_FYSETC_S6)
#include "fysetc_s6_map.h"
#elif defined(BOARD_PROTONEER_3XX)
#include "protoneer_3.xx_map.h"
#elif defined(BOARD_GENERIC_UNO)
#include "uno_map.h"
#elif defined(BOARD_MORPHO_CNC)
#include "st_morpho_map.h"
#elif defined(BOARD_MORPHO_DAC_CNC)
#include "st_morpho_dac_map.h"
#elif defined(BOARD_MINI_BLACKPILL)
#include "mini_blackpill_map.h"
#elif defined(BOARD_MY_MACHINE)
#include "my_machine_map.h"
#else // default board
#include "generic_map.h"
#endif
#if IS_NUCLEO_DEVKIT == 1 && !defined(IS_NUCLEO_BOB)
#warning "Board map is not for Nucleo based boards and firmware may not work!"
#endif
#if defined(IS_NUCLEO_BOB) && USB_SERIAL_CDC
#error "Nucleo based boards does not support USB CDC communication!"
#endif
// Define timer allocations.
#define STEPPER_TIMER_N 5
#define STEPPER_TIMER timer(STEPPER_TIMER_N)
#define STEPPER_TIMER_IRQn timerINT(STEPPER_TIMER_N)
#define STEPPER_TIMER_IRQHandler timerHANDLER(STEPPER_TIMER_N)
#define STEPPER_TIMER_CLOCK_ENA timerCLKENA(STEPPER_TIMER_N)
#define PULSE_TIMER_N 4
#define PULSE_TIMER timer(PULSE_TIMER_N)
#define PULSE_TIMER_IRQn timerINT(PULSE_TIMER_N)
#define PULSE_TIMER_IRQHandler timerHANDLER(PULSE_TIMER_N)
#define PULSE_TIMER_CLOCK_ENA timerCLKENA(PULSE_TIMER_N)
#ifdef SPINDLE_PWM_PORT_BASE
#if SPINDLE_PWM_PORT_BASE == GPIOA_BASE
#if SPINDLE_PWM_PIN == 5 // PA5 - TIM2_CH1
#define SPINDLE_PWM_TIMER_N 2
#define SPINDLE_PWM_TIMER_CH 1
#define SPINDLE_PWM_TIMER_INV 0
#define SPINDLE_PWM_TIMER_AF 1
#elif SPINDLE_PWM_PIN == 7 // PA7 - TIM1_CH1N
#define SPINDLE_PWM_TIMER_N 1
#define SPINDLE_PWM_TIMER_CH 1
#define SPINDLE_PWM_TIMER_INV 1
#define SPINDLE_PWM_TIMER_AF 1
#elif SPINDLE_PWM_PIN == 8 // PA8 - TIM1_CH1
#define SPINDLE_PWM_TIMER_N 1
#define SPINDLE_PWM_TIMER_CH 1
#define SPINDLE_PWM_TIMER_INV 0
#define SPINDLE_PWM_TIMER_AF 1
#endif
#elif SPINDLE_PWM_PORT_BASE == GPIOB_BASE
#if SPINDLE_PWM_PIN == 0 // PB0 - TIM1_CH2N
#define SPINDLE_PWM_TIMER_N 1
#define SPINDLE_PWM_TIMER_CH 2
#define SPINDLE_PWM_TIMER_INV 1
#define SPINDLE_PWM_TIMER_AF 1
#elif SPINDLE_PWM_PIN == 3 // PB3 - TIM2_CH2
#define SPINDLE_PWM_TIMER_N 2
#define SPINDLE_PWM_TIMER_CH 2
#define SPINDLE_PWM_TIMER_INV 0
#define SPINDLE_PWM_TIMER_AF 1
#elif SPINDLE_PWM_PIN == 4 // PB4 - TIM3_CH1
#define SPINDLE_PWM_TIMER_N 3
#define SPINDLE_PWM_TIMER_CH 1
#define SPINDLE_PWM_TIMER_INV 0
#define SPINDLE_PWM_TIMER_AF 2
#elif SPINDLE_PWM_PIN == 9 // PB9 - TIM11_CH1
#define SPINDLE_PWM_TIMER_N 11
#define SPINDLE_PWM_TIMER_CH 1
#define SPINDLE_PWM_TIMER_INV 0
#define SPINDLE_PWM_TIMER_AF 3
#endif
#endif
#if SPINDLE_PWM_TIMER_CH == 1 || SPINDLE_PWM_TIMER_CH == 2
#define SPINDLE_PWM_CCR 1
#else
#define SPINDLE_PWM_CCR 2
#endif
#define SPINDLE_PWM_TIMER timer(SPINDLE_PWM_TIMER_N)
#define SPINDLE_PWM_TIMER_CCR timerCCR(SPINDLE_PWM_TIMER_N, SPINDLE_PWM_TIMER_CH)
#define SPINDLE_PWM_TIMER_CCMR timerCCMR(SPINDLE_PWM_TIMER_N, SPINDLE_PWM_CCR)
#define SPINDLE_PWM_CCMR_OCM_SET timerOCM(SPINDLE_PWM_CCR, SPINDLE_PWM_TIMER_CH)
#define SPINDLE_PWM_CCMR_OCM_CLR timerOCMC(SPINDLE_PWM_CCR, SPINDLE_PWM_TIMER_CH)
#if SPINDLE_PWM_TIMER_INV
#define SPINDLE_PWM_CCER_EN timerCCEN(SPINDLE_PWM_TIMER_CH, N)
#define SPINDLE_PWM_CCER_POL timerCCP(SPINDLE_PWM_TIMER_CH, N)
#define SPINDLE_PWM_CR2_OIS timerCR2OIS(SPINDLE_PWM_TIMER_CH, N)
#else
#define SPINDLE_PWM_CCER_EN timerCCEN(SPINDLE_PWM_TIMER_CH, )
#define SPINDLE_PWM_CCER_POL timerCCP(SPINDLE_PWM_TIMER_CH, )
#define SPINDLE_PWM_CR2_OIS timerCR2OIS(SPINDLE_PWM_TIMER_CH, )
#endif
#define SPINDLE_PWM_PORT ((GPIO_TypeDef *)SPINDLE_PWM_PORT_BASE)
#define SPINDLE_PWM_AF timerAF(SPINDLE_PWM_TIMER_N, SPINDLE_PWM_TIMER_AF)
#define SPINDLE_PWM_CLOCK_ENA timerCLKENA(SPINDLE_PWM_TIMER_N)
#endif // SPINDLE_PWM_PORT_BASE
#if defined(SPINDLE_PWM_PIN) && !defined(SPINDLE_PWM_TIMER_N)
#ifdef SPINDLE_PWM_PORT
#error Map spindle port by defining SPINDLE_PWM_PORT_BASE in the map file!
#else
#error Spindle PWM not supported on mapped pin!
#endif
#endif
#define DEBOUNCE_TIMER_N 9
#define DEBOUNCE_TIMER timer(DEBOUNCE_TIMER_N)
#define DEBOUNCE_TIMER_IRQn TIM1_BRK_TIM9_IRQn // !
#define DEBOUNCE_TIMER_IRQHandler TIM1_BRK_TIM9_IRQHandler // !
#define DEBOUNCE_TIMER_CLOCK_ENA timerCLKENA(DEBOUNCE_TIMER_N)
#if SPINDLE_SYNC_ENABLE
#if SPINDLE_PWM_TIMER_N == 2 || SPINDLE_PWM_TIMER_N == 3
#error Timer conflict: spindle sync and spindle PWM!
#endif
#ifndef RPM_COUNTER_N
#define RPM_COUNTER_N 3
#endif
#define RPM_COUNTER timer(RPM_COUNTER_N)
#define RPM_COUNTER_IRQn timerINT(RPM_COUNTER_N)
#define RPM_COUNTER_IRQHandler timerHANDLER(RPM_COUNTER_N)
#define RPM_COUNTER_CLOCK_ENA timerCLKENA(RPM_COUNTER_N)
#ifndef RPM_TIMER_N
#define RPM_TIMER_N 2
#endif
#define RPM_TIMER timer(RPM_TIMER_N)
#define RPM_TIMER_IRQn timerINT(RPM_TIMER_N)
#define RPM_TIMER_IRQHandler timerHANDLER(RPM_TIMER_N)
#define RPM_TIMER_CLOCK_ENA timerCLKENA(RPM_TIMER_N)
#elif PPI_ENABLE
#if SPINDLE_PWM_TIMER_N == 2
#error Timer conflict: laser PPI and spindle PWM!
#endif
#define PPI_TIMER_N 2
#define PPI_TIMER timer(PPI_TIMER_N)
#define PPI_TIMER_IRQn timerINT(PPI_TIMER_N)
#define PPI_TIMER_IRQHandler timerHANDLER(PPI_TIMER_N)
#define PPI_TIMER_CLOCK_ENA timerCLKENA(PPI_TIMER_N)
#endif
// Adjust STEP_PULSE_LATENCY to get accurate step pulse length when required, e.g if using high step rates.
// The default value is calibrated for 10 microseconds length.
// NOTE: step output mode, number of axes and compiler optimization settings may all affect this value.
#ifndef STEP_PULSE_LATENCY
#define STEP_PULSE_LATENCY 1.0f // microseconds
#endif
// End configuration
#if EEPROM_ENABLE == 0
#define FLASH_ENABLE 1
#else
#define FLASH_ENABLE 0
#endif
#if MODBUS_ENABLE
#include "spindle/modbus.h"
#endif
#if MODBUS_ENABLE
#define MODBUS_TEST 1
#else
#define MODBUS_TEST 0
#endif
#if TRINAMIC_UART_ENABLE && !defined(MOTOR_UARTX_PORT)
#define TRINAMIC_TEST 1
#else
#define TRINAMIC_TEST 0
#endif
#if MPG_ENABLE
#define MPG_TEST 1
#else
#define MPG_TEST 0
#endif
#if KEYPAD_ENABLE == 2 && MPG_ENABLE == 0
#define KEYPAD_TEST 1
#else
#define KEYPAD_TEST 0
#endif
#if MODBUS_TEST + KEYPAD_TEST + MPG_TEST + TRINAMIC_TEST + BLUETOOTH_ENABLE > 1
#error "Only one option that uses the serial port can be enabled!"
#endif
#if MODBUS_TEST || KEYPAD_TEST || MPG_TEST || TRINAMIC_TEST || BLUETOOTH_ENABLE
#if IS_NUCLEO_DEVKIT
#define SERIAL2_MOD 1
#else
#define SERIAL2_MOD 2
#endif
#endif
#undef MODBUS_TEST
#undef KEYPAD_TEST
#undef MPG_TEST
#undef TRINAMIC_TEST
#if MPG_MODE == 1 && !defined(MPG_MODE_PIN)
#error "MPG_MODE_PIN must be defined!"
#endif
#if TRINAMIC_ENABLE
#include "motors/trinamic.h"
#ifndef TRINAMIC_MIXED_DRIVERS
#define TRINAMIC_MIXED_DRIVERS 1
#endif
#endif
// End configuration
#if KEYPAD_ENABLE == 1 && !defined(I2C_STROBE_PORT)
#error Keypad plugin not supported!
#elif I2C_STROBE_ENABLE && !defined(I2C_STROBE_PORT)
#error I2C strobe not supported!
#endif
#if SDCARD_ENABLE && !defined(SD_CS_PORT)
#error SD card plugin not supported!
#endif
#if I2C_ENABLE && !defined(I2C_PORT)
#define I2C_PORT 2 // GPIOB, SCL_PIN = 10, SDA_PIN = 11
#endif
#if SPI_ENABLE && !defined(SPI_PORT)
#define SPI_PORT 1
#endif
#ifndef STEP_PINMODE
#define STEP_PINMODE PINMODE_OUTPUT
#endif
#ifndef DIRECTION_PINMODE
#define DIRECTION_PINMODE PINMODE_OUTPUT
#endif
#ifndef STEPPERS_ENABLE_PINMODE
#define STEPPERS_ENABLE_PINMODE PINMODE_OUTPUT
#endif
typedef struct {
pin_function_t id;
GPIO_TypeDef *port;
uint8_t pin;
uint32_t bit;
pin_group_t group;
volatile bool active;
volatile bool debounce;
pin_irq_mode_t irq_mode;
pin_mode_t cap;
ioport_interrupt_callback_ptr interrupt_callback;
const char *description;
} input_signal_t;
typedef struct {
pin_function_t id;
GPIO_TypeDef *port;
uint8_t pin;
pin_group_t group;
pin_mode_t mode;
const char *description;
} output_signal_t;
typedef struct {
uint8_t n_pins;
union {
input_signal_t *inputs;
output_signal_t *outputs;
} pins;
} pin_group_pins_t;
bool driver_init (void);
void Driver_IncTick (void);
#ifdef HAS_BOARD_INIT
void board_init (void);
#endif
#ifdef HAS_IOPORTS
void ioports_init(pin_group_pins_t *aux_inputs, pin_group_pins_t *aux_outputs);
void ioports_event (uint32_t bit);
#endif
#endif // __DRIVER_H__