-
Notifications
You must be signed in to change notification settings - Fork 87
/
Copy pathStepper.c
1509 lines (1314 loc) · 60.4 KB
/
Stepper.c
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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
Stepper.c - stepper motor driver: executes motion plans using stepper motors
Part of Grbl-Advanced
Copyright (c) 2011-2016 Sungeun K. Jeon for Gnea Research LLC
Copyright (c) 2009-2011 Simen Svale Skogsrud
Copyright (c) 2017-2020 Patrick F.
Grbl-Advanced 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-Advanced 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-Advanced. If not, see <http://www.gnu.org/licenses/>.
*/
#include <stdint.h>
#include <string.h>
#include <stdlib.h>
#include "Config.h"
#include "Planner.h"
#include "Probe.h"
#include "GCode.h"
#include "SpindleControl.h"
#include "System.h"
#include "Settings.h"
#include "util.h"
#include "TIM.h"
#include "Stepper.h"
#include "GPIO.h"
#include "System32.h"
// Some useful constants.
#define DT_SEGMENT (1.0/(ACCELERATION_TICKS_PER_SECOND*60.0)) // min/segment
#define REQ_MM_INCREMENT_SCALAR 1.25
#define RAMP_ACCEL 0
#define RAMP_CRUISE 1
#define RAMP_DECEL 2
#define RAMP_DECEL_OVERRIDE 3
#define PREP_FLAG_RECALCULATE BIT(0)
#define PREP_FLAG_HOLD_PARTIAL_BLOCK BIT(1)
#define PREP_FLAG_PARKING BIT(2)
#define PREP_FLAG_DECEL_OVERRIDE BIT(3)
// Define Adaptive Multi-Axis Step-Smoothing(AMASS) levels and cutoff frequencies. The highest level
// frequency bin starts at 0Hz and ends at its cutoff frequency. The next lower level frequency bin
// starts at the next higher cutoff frequency, and so on. The cutoff frequencies for each level must
// be considered carefully against how much it over-drives the stepper ISR, the accuracy of the 16-bit
// timer, and the CPU overhead. Level 0 (no AMASS, normal operation) frequency bin starts at the
// Level 1 cutoff frequency and up to as fast as the CPU allows (over 30kHz in limited testing).
// NOTE: AMASS cutoff frequency multiplied by ISR overdrive factor must not exceed maximum step frequency.
// NOTE: Current settings are set to overdrive the ISR to no more than 16kHz, balancing CPU overhead
// and timer accuracy. Do not alter these settings unless you know what you are doing.
#define MAX_AMASS_LEVEL 5
// AMASS_LEVEL0: Normal operation. No AMASS. No upper cutoff frequency. Starts at LEVEL1 cutoff frequency.
#define AMASS_LEVEL1 (uint32_t)(F_TIMER_STEPPER / 8000) // Over-drives ISR (x2). Defined as F_TIMER_STEPPER/(Cutoff frequency in Hz)
#define AMASS_LEVEL2 (uint32_t)(F_TIMER_STEPPER / 4000) // Over-drives ISR (x4)
#define AMASS_LEVEL3 (uint32_t)(F_TIMER_STEPPER / 2000) // Over-drives ISR (x8)
#define AMASS_LEVEL4 (uint32_t)(F_TIMER_STEPPER / 1000) // Over-drives ISR (x16)
#define AMASS_LEVEL5 (uint32_t)(F_TIMER_STEPPER / 500) // Over-drives ISR (x32)
#if MAX_AMASS_LEVEL <= 0
error "AMASS must have 1 or more levels to operate correctly."
#endif
#ifdef MAX_STEP_RATE_HZ
#define STEP_TIMER_MIN (uint16_t)(F_TIMER_STEPPER / MAX_STEP_RATE_HZ)
#else
#define STEP_TIMER_MIN (uint16_t)((F_TIMER_STEPPER / 120000))
#pragma message("Max stepper rate: 120KHz")
#endif
#define G96_UPDATE_CNT 20
// Stores the planner block Bresenham algorithm execution data for the segments in the segment
// buffer. Normally, this buffer is partially in-use, but, for the worst case scenario, it will
// never exceed the number of accessible stepper buffer segments (SEGMENT_BUFFER_SIZE-1).
// NOTE: This data is copied from the prepped planner blocks so that the planner blocks may be
// discarded when entirely consumed and completed by the segment buffer. Also, AMASS alters this
// data for its own use.
typedef struct
{
uint32_t steps[N_AXIS];
uint32_t step_event_count;
uint8_t direction_bits;
uint8_t is_pwm_rate_adjusted; // Tracks motions that require constant laser power/rate
} Stepper_Block_t;
// Primary stepper segment ring buffer. Contains small, short line segments for the stepper
// algorithm to execute, which are "checked-out" incrementally from the first block in the
// planner buffer. Once "checked-out", the steps in the segments buffer cannot be modified by
// the planner, where the remaining planner block steps still can.
typedef struct
{
uint16_t n_step; // Number of step events to be executed for this segment
uint16_t cycles_per_tick; // Step distance traveled per ISR tick, aka step rate.
uint8_t st_block_index; // Stepper block data index. Uses this information to execute this segment.
uint8_t amass_level; // Indicates AMASS level for the ISR to execute this segment
uint8_t spindle_pwm;
uint8_t backlash_motion;
} Stepper_Segment_t;
// Stepper ISR data struct. Contains the running data for the main stepper ISR.
typedef struct
{
// Used by the bresenham line algorithm
// Counter variables for the bresenham line tracer
uint32_t counter_x, counter_y, counter_z, counter_a, counter_b;
uint8_t execute_step; // Flags step execution for each interrupt.
uint8_t step_pulse_time; // Step pulse reset time after step rise
uint8_t step_outbits; // The next stepping-bits to be output
uint8_t dir_outbits;
uint32_t steps[N_AXIS];
uint16_t step_count; // Steps remaining in line segment motion
uint8_t exec_block_index; // Tracks the current st_block index. Change indicates new block.
Stepper_Block_t *exec_block; // Pointer to the block data for the segment being executed
Stepper_Segment_t *exec_segment; // Pointer to the segment being executed
} Stepper_t;
// Segment preparation data struct. Contains all the necessary information to compute new segments
// based on the current executing planner block.
typedef struct
{
uint8_t st_block_index; // Index of stepper common data block being prepped
uint8_t recalculate_flag;
float dt_remainder;
float steps_remaining;
float step_per_mm;
float req_mm_increment;
#ifdef PARKING_ENABLE
uint8_t last_st_block_index;
float last_steps_remaining;
float last_step_per_mm;
float last_dt_remainder;
#endif
uint8_t ramp_type; // Current segment ramp state
float mm_complete; // End of velocity profile from end of current planner block in (mm).
// NOTE: This value must coincide with a step(no mantissa) when converted.
float current_speed; // Current speed at the end of the segment buffer (mm/min)
float maximum_speed; // Maximum speed of executing block. Not always nominal speed. (mm/min)
float exit_speed; // Exit speed of executing block (mm/min)
float accelerate_until; // Acceleration ramp end measured from end of block (mm)
float decelerate_after; // Deceleration ramp start measured from end of block (mm)
float inv_rate; // Used by PWM laser mode to speed up segment calculations.
uint8_t current_spindle_pwm;
} Stepper_PrepData_t;
static Stepper_Block_t st_block_buffer[SEGMENT_BUFFER_SIZE-1];
static Stepper_Segment_t segment_buffer[SEGMENT_BUFFER_SIZE];
static Stepper_t st;
// Step segment ring buffer indices
static volatile uint8_t segment_buffer_tail;
static uint8_t segment_buffer_head;
static uint8_t segment_next_head;
// Step and direction port invert masks.
static uint8_t step_port_invert_mask;
static uint8_t dir_port_invert_mask;
// Pointers for the step segment being prepped from the planner buffer. Accessed only by the
// main program. Pointers may be planning segments or planner blocks ahead of what being executed.
static Planner_Block_t *pl_block; // Pointer to the planner block being prepped
static Stepper_Block_t *st_prep_block; // Pointer to the stepper block data being prepped
static Stepper_PrepData_t prep;
static float tim_ovr = 0;
static uint8_t update_g96 = G96_UPDATE_CNT;
float current_backlash[N_AXIS] = {};
/* BLOCK VELOCITY PROFILE DEFINITION
__________________________
/| |\ _________________ ^
/ | | \ /| |\ |
/ | | \ / | | \ s
/ | | | | | \ p
/ | | | | | \ e
+-----+------------------------+---+--+---------------+----+ e
| BLOCK 1 ^ BLOCK 2 | d
|
time -----> EXAMPLE: Block 2 entry speed is at max junction velocity
The planner block buffer is planned assuming constant acceleration velocity profiles and are
continuously joined at block junctions as shown above. However, the planner only actively computes
the block entry speeds for an optimal velocity plan, but does not compute the block internal
velocity profiles. These velocity profiles are computed ad-hoc as they are executed by the
stepper algorithm and consists of only 7 possible types of profiles: cruise-only, cruise-
deceleration, acceleration-cruise, acceleration-only, deceleration-only, full-trapezoid, and
triangle(no cruise).
maximum_speed (< nominal_speed) -> +
+--------+ <- maximum_speed (= nominal_speed) /|\
/ \ / | \
current_speed -> + \ / | + <- exit_speed
| + <- exit_speed / | |
+-------------+ current_speed -> +----+--+
time --> ^ ^ ^ ^
| | | |
decelerate_after(in mm) decelerate_after(in mm)
^ ^ ^ ^
| | | |
accelerate_until(in mm) accelerate_until(in mm)
The step segment buffer computes the executing block velocity profile and tracks the critical
parameters for the stepper algorithm to accurately trace the profile. These critical parameters
are shown and defined in the above illustration.
*/
// Initialize and start the stepper motor subsystem
void Stepper_Init(void)
{
// Configure step and direction interface pins
GPIO_InitGPIO(GPIO_STEPPER);
// Init TIM9
TIM9_Init();
if(BIT_IS_TRUE(settings.flags, BITFLAG_HOMING_ENABLE))
{
Stepper_Disable(1);
}
tim_ovr = 0;
update_g96 = G96_UPDATE_CNT;
for(int i = 0; i < N_AXIS; i++)
{
current_backlash[i] = 0.0;
}
}
// Stepper state initialization. Cycle should only start if the st.cycle_start flag is
// enabled. Startup init and limits call this function but shouldn't start the cycle.
void Stepper_WakeUp(void)
{
// Enable stepper drivers.
if(BIT_IS_TRUE(settings.flags, BITFLAG_INVERT_ST_ENABLE))
{
GPIO_SetBits(GPIO_ENABLE_PORT, GPIO_ENABLE_PIN);
}
else
{
GPIO_ResetBits(GPIO_ENABLE_PORT, GPIO_ENABLE_PIN);
}
// Give steppers some time to wake up
Delay_ms(10);
// Initialize stepper output bits to ensure first ISR call does not step.
//st.step_outbits = step_port_invert_mask;
st.step_outbits = 0;
// Enable Stepper Driver Interrupt
TIM_Cmd(TIM9, ENABLE);
}
// Stepper shutdown
void Stepper_Disable(uint8_t ovr_disable)
{
// Disable Stepper Driver Interrupt.
TIM_Cmd(TIM9, DISABLE);
Delay_us(1);
// Reset stepper pins
Stepper_PortResetISR();
// Set stepper driver idle state, disabled or enabled, depending on settings and circumstances.
bool pin_state = false; // Keep enabled.
if(((settings.stepper_idle_lock_time != 0xFF) || sys_rt_exec_alarm || sys.state == STATE_SLEEP) && sys.state != STATE_HOMING)
{
// Force stepper dwell to lock axes for a defined amount of time to ensure the axes come to a complete
// stop and not drift from residual inertial forces at the end of the last movement.
Delay_ms(settings.stepper_idle_lock_time);
pin_state = true; // Override. Disable steppers.
}
if(ovr_disable)
{
// Disable
pin_state = true;
}
if(BIT_IS_TRUE(settings.flags, BITFLAG_INVERT_ST_ENABLE))
{
pin_state = !pin_state;
} // Apply pin invert.
if(pin_state)
{
GPIO_SetBits(GPIO_ENABLE_PORT, GPIO_ENABLE_PIN);
}
else
{
GPIO_ResetBits(GPIO_ENABLE_PORT, GPIO_ENABLE_PIN);
}
}
void Stepper_Ovr(float ovr)
{
tim_ovr = ovr;
}
/* "The Stepper Driver Interrupt" - This timer interrupt is the workhorse of Grbl. Grbl employs
the venerable Bresenham line algorithm to manage and exactly synchronize multi-axis moves.
Unlike the popular DDA algorithm, the Bresenham algorithm is not susceptible to numerical
round-off errors and only requires fast integer counters, meaning low computational overhead
and maximizing the Arduino's capabilities. However, the downside of the Bresenham algorithm
is, for certain multi-axis motions, the non-dominant axes may suffer from un-smooth step
pulse trains, or aliasing, which can lead to strange audible noises or shaking. This is
particularly noticeable or may cause motion issues at low step frequencies (0-5kHz), but
is usually not a physical problem at higher frequencies, although audible.
To improve Bresenham multi-axis performance, Grbl uses what we call an Adaptive Multi-Axis
Step Smoothing (AMASS) algorithm, which does what the name implies. At lower step frequencies,
AMASS artificially increases the Bresenham resolution without effecting the algorithm's
innate exactness. AMASS adapts its resolution levels automatically depending on the step
frequency to be executed, meaning that for even lower step frequencies the step smoothing
level increases. Algorithmically, AMASS is acheived by a simple bit-shifting of the Bresenham
step count for each AMASS level. For example, for a Level 1 step smoothing, we bit shift
the Bresenham step event count, effectively multiplying it by 2, while the axis step counts
remain the same, and then double the stepper ISR frequency. In effect, we are allowing the
non-dominant Bresenham axes step in the intermediate ISR tick, while the dominant axis is
stepping every two ISR ticks, rather than every ISR tick in the traditional sense. At AMASS
Level 2, we simply bit-shift again, so the non-dominant Bresenham axes can step within any
of the four ISR ticks, the dominant axis steps every four ISR ticks, and quadruple the
stepper ISR frequency. And so on. This, in effect, virtually eliminates multi-axis aliasing
issues with the Bresenham algorithm and does not significantly alter Grbl's performance, but
in fact, more efficiently utilizes unused CPU cycles overall throughout all configurations.
AMASS retains the Bresenham algorithm exactness by requiring that it always executes a full
Bresenham step, regardless of AMASS Level. Meaning that for an AMASS Level 2, all four
intermediate steps must be completed such that baseline Bresenham (Level 0) count is always
retained. Similarly, AMASS Level 3 means all eight intermediate steps must be executed.
Although the AMASS Levels are in reality arbitrary, where the baseline Bresenham counts can
be multiplied by any integer value, multiplication by powers of two are simply used to ease
CPU overhead with bitshift integer operations.
This interrupt is simple and dumb by design. All the computational heavy-lifting, as in
determining accelerations, is performed elsewhere. This interrupt pops pre-computed segments,
defined as constant velocity over n number of steps, from the step segment buffer and then
executes them by pulsing the stepper pins appropriately via the Bresenham algorithm. This
ISR is supported by The Stepper Port Reset Interrupt which it uses to reset the stepper port
after each pulse. The bresenham line tracer algorithm controls all stepper outputs
simultaneously with these two interrupts.
NOTE: This interrupt must be as efficient as possible and complete before the next ISR tick,
which for Grbl must be less than 33.3usec (@30kHz ISR rate). Oscilloscope measured time in
ISR is 5usec typical and 25usec maximum, well below requirement.
NOTE: This ISR expects at least one step to be executed per segment.
*/
void Stepper_MainISR(void)
{
if(st.step_outbits & (1<<X_STEP_BIT))
{
if(step_port_invert_mask & (1<<X_STEP_BIT))
{
// Low pulse
GPIO_ResetBits(GPIO_STEP_X_PORT, GPIO_STEP_X_PIN);
}
else
{
// High pulse
GPIO_SetBits(GPIO_STEP_X_PORT, GPIO_STEP_X_PIN);
}
}
if (BIT_IS_FALSE(settings.flags_ext, BITFLAG_LATHE_MODE))
{
if (st.step_outbits & (1 << Y_STEP_BIT))
{
if (step_port_invert_mask & (1 << Y_STEP_BIT))
{
// Low pulse
GPIO_ResetBits(GPIO_STEP_Y_PORT, GPIO_STEP_Y_PIN);
}
else
{
// High pulse
GPIO_SetBits(GPIO_STEP_Y_PORT, GPIO_STEP_Y_PIN);
}
}
}
if(st.step_outbits & (1<<Z_STEP_BIT))
{
if(step_port_invert_mask & (1<<Z_STEP_BIT))
{
// Low pulse
GPIO_ResetBits(GPIO_STEP_Z_PORT, GPIO_STEP_Z_PIN);
}
else
{
// High pulse
GPIO_SetBits(GPIO_STEP_Z_PORT, GPIO_STEP_Z_PIN);
}
}
if(st.step_outbits & (1<<A_STEP_BIT))
{
if(step_port_invert_mask & (1<<A_STEP_BIT))
{
// Low pulse
GPIO_ResetBits(GPIO_STEP_A_PORT, GPIO_STEP_A_PIN);
}
else
{
// High pulse
GPIO_SetBits(GPIO_STEP_A_PORT, GPIO_STEP_A_PIN);
}
}
if(st.step_outbits & (1<<B_STEP_BIT))
{
if(step_port_invert_mask & (1<<B_STEP_BIT))
{
// Low pulse
//GPIO_ResetBits(GPIO_STEP_B_PORT, GPIO_STEP_B_PIN);
}
else
{
// High pulse
//GPIO_SetBits(GPIO_STEP_B_PORT, GPIO_STEP_B_PIN);
}
}
// If there is no step segment, attempt to pop one from the stepper buffer
if(st.exec_segment == 0)
{
// Anything in the buffer? If so, load and initialize next step segment.
if(segment_buffer_head != segment_buffer_tail)
{
// Initialize new step segment and load number of steps to execute
st.exec_segment = &segment_buffer[segment_buffer_tail];
// Initialize step segment timing per step and load number of steps to execute.
// Limit ISR frequency
if(st.exec_segment->cycles_per_tick < STEP_TIMER_MIN)
{
st.exec_segment->cycles_per_tick = STEP_TIMER_MIN;
}
int32_t new_cycles_per_tick = st.exec_segment->cycles_per_tick;
if(sys.sync_move == 1)
{
new_cycles_per_tick = st.exec_segment->cycles_per_tick * tim_ovr;
new_cycles_per_tick = st.exec_segment->cycles_per_tick + new_cycles_per_tick;
if (new_cycles_per_tick > 0xFFFF)
{
new_cycles_per_tick = 0xFFFF;
}
if(new_cycles_per_tick < STEP_TIMER_MIN-50)
{
new_cycles_per_tick = STEP_TIMER_MIN-50;
}
}
// Update TIM9 register for next interrupt
//TIM9->ARR = st.exec_segment->cycles_per_tick;
//TIM9->CCR1 = (uint16_t)(st.exec_segment->cycles_per_tick * 0.6);
TIM9->ARR = (uint16_t)new_cycles_per_tick;
TIM9->CCR1 = (uint16_t)(new_cycles_per_tick * 0.6);
st.step_count = st.exec_segment->n_step; // NOTE: Can sometimes be zero when moving slow.
// If the new segment starts a new planner block, initialize stepper variables and counters.
// NOTE: When the segment data index changes, this indicates a new planner block.
if(st.exec_block_index != st.exec_segment->st_block_index)
{
st.exec_block_index = st.exec_segment->st_block_index;
st.exec_block = &st_block_buffer[st.exec_block_index];
// Initialize Bresenham line and distance counters
st.counter_x = st.counter_y = st.counter_z = st.counter_a = st.counter_b = (st.exec_block->step_event_count >> 1);
}
st.dir_outbits = st.exec_block->direction_bits ^ dir_port_invert_mask;
// Set the direction pins directly here to make sure that the signal is valid when stepping the steppers
// Some driver e.g. require a setup time of a few us.
if(st.dir_outbits & (1<<X_DIRECTION_BIT))
{
GPIO_SetBits(GPIO_DIR_X_PORT, GPIO_DIR_X_PIN);
}
else
{
GPIO_ResetBits(GPIO_DIR_X_PORT, GPIO_DIR_X_PIN);
}
if (BIT_IS_FALSE(settings.flags_ext, BITFLAG_LATHE_MODE))
{
if (st.dir_outbits & (1 << Y_DIRECTION_BIT))
{
GPIO_SetBits(GPIO_DIR_Y_PORT, GPIO_DIR_Y_PIN);
}
else
{
GPIO_ResetBits(GPIO_DIR_Y_PORT, GPIO_DIR_Y_PIN);
}
}
if(st.dir_outbits & (1<<Z_DIRECTION_BIT))
{
GPIO_SetBits(GPIO_DIR_Z_PORT, GPIO_DIR_Z_PIN);
}
else
{
GPIO_ResetBits(GPIO_DIR_Z_PORT, GPIO_DIR_Z_PIN);
}
if(st.dir_outbits & (1<<A_DIRECTION_BIT))
{
GPIO_SetBits(GPIO_DIR_A_PORT, GPIO_DIR_A_PIN);
}
else
{
GPIO_ResetBits(GPIO_DIR_A_PORT, GPIO_DIR_A_PIN);
}
if(st.dir_outbits & (1<<B_DIRECTION_BIT))
{
//GPIO_SetBits(GPIO_DIR_B_PORT, GPIO_DIR_B_PIN);
}
else
{
//GPIO_ResetBits(GPIO_DIR_B_PORT, GPIO_DIR_B_PIN);
}
// With AMASS enabled, adjust Bresenham axis increment counters according to AMASS level.
st.steps[X_AXIS] = st.exec_block->steps[X_AXIS] >> st.exec_segment->amass_level;
st.steps[Y_AXIS] = st.exec_block->steps[Y_AXIS] >> st.exec_segment->amass_level;
st.steps[Z_AXIS] = st.exec_block->steps[Z_AXIS] >> st.exec_segment->amass_level;
st.steps[A_AXIS] = st.exec_block->steps[A_AXIS] >> st.exec_segment->amass_level;
st.steps[B_AXIS] = st.exec_block->steps[B_AXIS] >> st.exec_segment->amass_level;
if(gc_state.modal.spindle_mode == SPINDLE_RPM_MODE)
{
// Set real-time spindle output as segment is loaded, just prior to the first step.
Spindle_SetSpeed(st.exec_segment->spindle_pwm);
}
else if(st.exec_segment->spindle_pwm != SPINDLE_PWM_OFF_VALUE)
{
if(--update_g96 == 0)
{
sys.x_pos = (sys_position[X_AXIS] / settings.steps_per_mm[X_AXIS]) - (gc_state.coord_system[X_AXIS] + gc_state.coord_offset[X_AXIS] + gc_state.tool_length_offset_dynamic[X_AXIS] + gc_state.tool_length_offset[X_AXIS]);
Spindle_SetSurfaceSpeed(sys.x_pos);
update_g96 = G96_UPDATE_CNT;
}
}
}
else
{
// Segment buffer empty. Shutdown.
Stepper_Disable(0);
// Ensure pwm is set properly upon completion of rate-controlled motion.
if(st.exec_block->is_pwm_rate_adjusted)
{
Spindle_SetSpeed(SPINDLE_PWM_OFF_VALUE);
}
System_SetExecStateFlag(EXEC_CYCLE_STOP); // Flag main program for cycle end
return; // Nothing to do but exit.
}
}
// Check probing state.
if(sys_probe_state == PROBE_ACTIVE)
{
Probe_StateMonitor();
}
// Reset step out bits.
st.step_outbits = 0;
// Execute step displacement profile by Bresenham line algorithm
st.counter_x += st.steps[X_AXIS];
if(st.counter_x > st.exec_block->step_event_count)
{
st.step_outbits |= (1<<X_STEP_BIT);
st.counter_x -= st.exec_block->step_event_count;
if (st.exec_block->direction_bits & (1 << X_DIRECTION_BIT))
{
sys_position[X_AXIS]--;
}
else
{
sys_position[X_AXIS]++;
}
if (fabsf(current_backlash[X_AXIS]) > 0.5)
{
if (current_backlash[X_AXIS] > 0.0)
{
current_backlash[X_AXIS] -= 1.0;
sys_position[X_AXIS]--;
}
else
{
current_backlash[X_AXIS] += 1.0;
sys_position[X_AXIS]++;
}
}
}
st.counter_y += st.steps[Y_AXIS];
if (st.counter_y > st.exec_block->step_event_count)
{
st.step_outbits |= (1 << Y_STEP_BIT);
st.counter_y -= st.exec_block->step_event_count;
if (st.exec_block->direction_bits & (1 << Y_DIRECTION_BIT))
{
sys_position[Y_AXIS]--;
}
else
{
sys_position[Y_AXIS]++;
}
if (fabsf(current_backlash[Y_AXIS]) > 0.5)
{
if (current_backlash[Y_AXIS] > 0.0)
{
current_backlash[Y_AXIS] -= 1.0;
sys_position[Y_AXIS]--;
}
else
{
current_backlash[Y_AXIS] += 1.0;
sys_position[Y_AXIS]++;
}
}
}
st.counter_z += st.steps[Z_AXIS];
if (st.counter_z > st.exec_block->step_event_count)
{
st.step_outbits |= (1 << Z_STEP_BIT);
st.counter_z -= st.exec_block->step_event_count;
if (st.exec_block->direction_bits & (1 << Z_DIRECTION_BIT))
{
sys_position[Z_AXIS]--;
}
else
{
sys_position[Z_AXIS]++;
}
if (fabsf(current_backlash[Z_AXIS]) > 0.5)
{
if (current_backlash[Z_AXIS] > 0.0)
{
current_backlash[Z_AXIS] -= 1.0;
sys_position[Z_AXIS]--;
}
else
{
current_backlash[Z_AXIS] += 1.0;
sys_position[Z_AXIS]++;
}
}
}
st.counter_a += st.steps[A_AXIS];
if(st.counter_a > st.exec_block->step_event_count)
{
st.step_outbits |= (1<<A_STEP_BIT);
st.counter_a -= st.exec_block->step_event_count;
//if(st.exec_segment->backlash_motion == 0)
{
if(st.exec_block->direction_bits & (1<<A_DIRECTION_BIT))
{
sys_position[A_AXIS]--;
}
else
{
sys_position[A_AXIS]++;
}
}
}
st.counter_b += st.steps[B_AXIS];
if(st.counter_b > st.exec_block->step_event_count)
{
st.step_outbits |= (1<<B_STEP_BIT);
st.counter_b -= st.exec_block->step_event_count;
//if(st.exec_segment->backlash_motion == 0)
{
if(st.exec_block->direction_bits & (1<<B_DIRECTION_BIT))
{
sys_position[B_AXIS]--;
}
else
{
sys_position[B_AXIS]++;
}
}
}
// During a homing cycle, lock out and prevent desired axes from moving.
if(sys.state == STATE_HOMING)
{
st.step_outbits &= sys.homing_axis_lock;
}
st.step_count--; // Decrement step events count
if(st.step_count == 0)
{
// Segment is complete. Discard current segment and advance segment indexing.
st.exec_segment = 0;
if(++segment_buffer_tail == SEGMENT_BUFFER_SIZE)
{
segment_buffer_tail = 0;
}
}
}
/* The Stepper Port Reset Interrupt: Timer9 OVF interrupt handles the falling edge of the step
pulse.
NOTE: Interrupt collisions between the serial and stepper interrupts can cause delays by
a few microseconds, if they execute right before one another. Not a big deal, but can
cause issues at high step rates if another high frequency asynchronous interrupt is
added to Grbl.
*/
void Stepper_PortResetISR(void)
{
// Reset stepping pins (leave the direction pins)
// X
if(step_port_invert_mask & (1<<X_STEP_BIT))
{
GPIO_SetBits(GPIO_STEP_X_PORT, GPIO_STEP_X_PIN);
}
else
{
GPIO_ResetBits(GPIO_STEP_X_PORT, GPIO_STEP_X_PIN);
}
// Y
if (BIT_IS_FALSE(settings.flags_ext, BITFLAG_LATHE_MODE))
{
if (step_port_invert_mask & (1 << Y_STEP_BIT))
{
GPIO_SetBits(GPIO_STEP_Y_PORT, GPIO_STEP_Y_PIN);
}
else
{
GPIO_ResetBits(GPIO_STEP_Y_PORT, GPIO_STEP_Y_PIN);
}
}
// Z
if(step_port_invert_mask & (1<<Z_STEP_BIT))
{
GPIO_SetBits(GPIO_STEP_Z_PORT, GPIO_STEP_Z_PIN);
}
else
{
GPIO_ResetBits(GPIO_STEP_Z_PORT, GPIO_STEP_Z_PIN);
}
// A
if(step_port_invert_mask & (1<<A_STEP_BIT))
{
GPIO_SetBits(GPIO_STEP_A_PORT, GPIO_STEP_A_PIN);
}
else
{
GPIO_ResetBits(GPIO_STEP_A_PORT, GPIO_STEP_A_PIN);
}
// B
if(step_port_invert_mask & (1<<B_STEP_BIT))
{
//GPIO_SetBits(GPIO_STEP_B_PORT, GPIO_STEP_B_PIN);
}
else
{
//GPIO_ResetBits(GPIO_STEP_B_PORT, GPIO_STEP_B_PIN);
}
}
// Generates the step and direction port invert masks used in the Stepper Interrupt Driver.
void Stepper_GenerateStepDirInvertMasks(void)
{
uint8_t idx;
step_port_invert_mask = 0;
dir_port_invert_mask = 0;
for(idx = 0; idx < N_AXIS; idx++)
{
if(BIT_IS_TRUE(settings.step_invert_mask, BIT(idx)))
{
step_port_invert_mask |= Settings_GetStepPinMask(idx);
}
if(BIT_IS_TRUE(settings.dir_invert_mask, BIT(idx)))
{
dir_port_invert_mask |= Settings_GetDirectionPinMask(idx);
}
}
}
// Reset and clear stepper subsystem variables
void Stepper_Reset(void)
{
// Initialize stepper driver idle state.
Stepper_Disable(0);
// Initialize stepper algorithm variables.
memset(&prep, 0, sizeof(Stepper_PrepData_t));
memset(&st, 0, sizeof(Stepper_t));
st.exec_segment = 0;
pl_block = 0; // Planner block pointer used by segment buffer
segment_buffer_tail = 0;
segment_buffer_head = 0; // empty = tail
segment_next_head = 1;
Stepper_GenerateStepDirInvertMasks();
st.dir_outbits = dir_port_invert_mask; // Initialize direction bits to default.
// Initialize step and direction port pins.
// Reset Step Pins
Stepper_PortResetISR();
// Reset Direction Pins
// ToDo: Use invert mask?
GPIO_ResetBits(GPIO_DIR_X_PORT, GPIO_DIR_X_PIN);
if (BIT_IS_FALSE(settings.flags_ext, BITFLAG_LATHE_MODE))
{
GPIO_ResetBits(GPIO_DIR_Y_PORT, GPIO_DIR_Y_PIN);
}
GPIO_ResetBits(GPIO_DIR_Z_PORT, GPIO_DIR_Z_PIN);
GPIO_ResetBits(GPIO_DIR_A_PORT, GPIO_DIR_A_PIN);
//GPIO_ResetBits(GPIO_DIR_B_PORT, GPIO_DIR_B_PIN);
}
// Called by planner_recalculate() when the executing block is updated by the new plan.
void Stepper_UpdatePlannerBlockParams(void)
{
if(pl_block != 0) // Ignore if at start of a new block.
{
prep.recalculate_flag |= PREP_FLAG_RECALCULATE;
pl_block->entry_speed_sqr = prep.current_speed*prep.current_speed; // Update entry speed.
pl_block = 0; // Flag st_prep_segment() to load and check active velocity profile.
}
}
// Increments the step segment buffer block data ring buffer.
static uint8_t Stepper_NextBlockIndex(uint8_t block_index)
{
block_index++;
if(block_index == (SEGMENT_BUFFER_SIZE-1))
{
return(0);
}
return block_index;
}
#ifdef PARKING_ENABLE
// Changes the run state of the step segment buffer to execute the special parking motion.
void Stepper_ParkingSetupBuffer()
{
// Store step execution data of partially completed block, if necessary.
if(prep.recalculate_flag & PREP_FLAG_HOLD_PARTIAL_BLOCK)
{
prep.last_st_block_index = prep.st_block_index;
prep.last_steps_remaining = prep.steps_remaining;
prep.last_dt_remainder = prep.dt_remainder;
prep.last_step_per_mm = prep.step_per_mm;
}
// Set flags to execute a parking motion
prep.recalculate_flag |= PREP_FLAG_PARKING;
prep.recalculate_flag &= ~(PREP_FLAG_RECALCULATE);
pl_block = 0; // Always reset parking motion to reload new block.
}
// Restores the step segment buffer to the normal run state after a parking motion.
void Stepper_ParkingRestoreBuffer()
{
// Restore step execution data and flags of partially completed block, if necessary.
if(prep.recalculate_flag & PREP_FLAG_HOLD_PARTIAL_BLOCK)
{
st_prep_block = &st_block_buffer[prep.last_st_block_index];
prep.st_block_index = prep.last_st_block_index;
prep.steps_remaining = prep.last_steps_remaining;
prep.dt_remainder = prep.last_dt_remainder;
prep.step_per_mm = prep.last_step_per_mm;
prep.recalculate_flag = (PREP_FLAG_HOLD_PARTIAL_BLOCK | PREP_FLAG_RECALCULATE);
prep.req_mm_increment = REQ_MM_INCREMENT_SCALAR/prep.step_per_mm; // Recompute this value.
}
else
{
prep.recalculate_flag = false;
}
pl_block = NULL; // Set to reload next block.
}
#endif
/* Prepares step segment buffer. Continuously called from main program.
The segment buffer is an intermediary buffer interface between the execution of steps
by the stepper algorithm and the velocity profiles generated by the planner. The stepper
algorithm only executes steps within the segment buffer and is filled by the main program
when steps are "checked-out" from the first block in the planner buffer. This keeps the
step execution and planning optimization processes atomic and protected from each other.
The number of steps "checked-out" from the planner buffer and the number of segments in
the segment buffer is sized and computed such that no operation in the main program takes
longer than the time it takes the stepper algorithm to empty it before refilling it.
Currently, the segment buffer conservatively holds roughly up to 40-50 msec of steps.
NOTE: Computation units are in steps, millimeters, and minutes.
*/
void Stepper_PrepareBuffer(void)
{
// Block step prep buffer, while in a suspend state and there is no suspend motion to execute.
if(BIT_IS_TRUE(sys.step_control,STEP_CONTROL_END_MOTION))
{
return;
}
while(segment_buffer_tail != segment_next_head) // Check if we need to fill the buffer.
{
// Determine if we need to load a new planner block or if the block needs to be recomputed.
if(pl_block == 0)
{
// Query planner for a queued block
if(sys.step_control & STEP_CONTROL_EXECUTE_SYS_MOTION)
{
pl_block = Planner_GetSystemMotionBlock();
}
else
{
pl_block = Planner_GetCurrentBlock();
}
if(pl_block == 0)
{
// No planner blocks. Exit.
return;
}
// Check if we need to only recompute the velocity profile or load a new block.
if(prep.recalculate_flag & PREP_FLAG_RECALCULATE)
{
#ifdef PARKING_ENABLE
if(prep.recalculate_flag & PREP_FLAG_PARKING)
{
prep.recalculate_flag &= ~(PREP_FLAG_RECALCULATE);
}
else
{
prep.recalculate_flag = false;
}
#else
prep.recalculate_flag = false;
#endif
}
else
{