forked from grblHAL/core
-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathgcode.c
4000 lines (3279 loc) · 172 KB
/
gcode.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
/*
gcode.c - rs274/ngc parser.
Part of grblHAL
Copyright (c) 2017-2025 Terje Io
Copyright (c) 2011-2016 Sungeun K. Jeon for Gnea Research LLC
Copyright (c) 2009-2011 Simen Svale Skogsrud
grblHAL 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.
grblHAL 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 grblHAL. If not, see <http://www.gnu.org/licenses/>.
*/
#include <math.h>
#include <string.h>
#include <stdlib.h>
#include "hal.h"
#include "motion_control.h"
#include "protocol.h"
#include "state_machine.h"
#if NGC_PARAMETERS_ENABLE
#include "ngc_params.h"
#endif
#if NGC_EXPRESSIONS_ENABLE
#include "ngc_expr.h"
#include "ngc_flowctrl.h"
//#include "string_registers.h"
#ifndef NGC_N_ASSIGN_PARAMETERS_PER_BLOCK
#define NGC_N_ASSIGN_PARAMETERS_PER_BLOCK 10
#endif
#endif
// NOTE: Max line number is defined by the g-code standard to be 99999. It seems to be an
// arbitrary value, and some GUIs may require more. So we increased it based on a max safe
// value when converting a float (7.2 digit precision) to an integer.
#define MAX_LINE_NUMBER 10000000
#define MAX_TOOL_NUMBER 4294967294 // Limited by max unsigned 32-bit value - 1
#define MACH3_SCALING
#ifdef NO_SETTINGS_DESCRIPTIONS
#define GCODE_ADVANCED 0
#else
#define GCODE_ADVANCED 1
#endif
// Do not change, must be same as axis indices
#define I_VALUE X_AXIS
#define J_VALUE Y_AXIS
#define K_VALUE Z_AXIS
// Define modal groups internal bitfield for checking multiple command violations and tracking the
// type of command that is called in the block. A modal group is a group of g-code commands that are
// mutually exclusive, or cannot exist on the same line, because they each toggle a state or execute
// a unique motion. These are defined in the NIST RS274-NGC v3 g-code standard, available online,
// and are similar/identical to other g-code interpreters by manufacturers (Haas,Fanuc,Mazak,etc).
typedef union {
uint32_t mask;
struct {
uint32_t G0 :1, //!< [G4,G10,G28,G28.1,G30,G30.1,G53,G92,G92.1] Non-modal
G1 :1, //!< [G0,G1,G2,G3,G33,G33.1,G38.2,G38.3,G38.4,G38.5,G76,G80] Motion
G2 :1, //!< [G17,G18,G19] Plane selection
G3 :1, //!< [G90,G91] Distance mode
G4 :1, //!< [G91.1] Arc IJK distance mode
G5 :1, //!< [G93,G94,G95] Feed rate mode
G6 :1, //!< [G20,G21] Units
G7 :1, //!< [G40] Cutter radius compensation mode. G41/42 NOT SUPPORTED.
G8 :1, //!< [G43,G43.1,G49] Tool length offset
G10 :1, //!< [G98,G99] Return mode in canned cycles
G11 :1, //!< [G50,G51] Scaling
G12 :1, //!< [G54,G55,G56,G57,G58,G59,G59.1,G59.2,G59.3] Coordinate system selection
G13 :1, //!< [G61] Control mode
G14 :1, //!< [G96,G97] Spindle Speed Mode
G15 :1, //!< [G7,G8] Lathe Diameter Mode
M4 :1, //!< [M0,M1,M2,M30] Stopping
M5 :1, //!< [M62,M63,M64,M65,M66,M67,M68] Aux I/O
M6 :1, //!< [M6] Tool change
M7 :1, //!< [M3,M4,M5] Spindle turning
M8 :1, //!< [M7,M8,M9] Coolant control
M9 :1, //!< [M49,M50,M51,M53,M56] Override control
M10 :1; //!< User defined M commands
};
} modal_groups_t;
typedef enum {
AxisCommand_None = 0,
AxisCommand_NonModal,
AxisCommand_MotionMode,
AxisCommand_ToolLengthOffset,
AxisCommand_Scaling
} axis_command_t;
typedef struct {
parameter_words_t parameter;
modal_groups_t modal_group;
} word_bit_t;
typedef union {
uint_fast8_t mask;
struct {
uint_fast8_t i :1,
j :1,
k :1;
};
} ijk_words_t;
// Declare gc extern struct
parser_state_t gc_state;
#define FAIL(status) return(status);
static output_command_t *output_commands = NULL; // Linked list
static scale_factor_t scale_factor = {
.ijk[X_AXIS] = 1.0f,
.ijk[Y_AXIS] = 1.0f,
.ijk[Z_AXIS] = 1.0f
#ifdef A_AXIS
, .ijk[A_AXIS] = 1.0f
#endif
#ifdef B_AXIS
, .ijk[B_AXIS] = 1.0f
#endif
#ifdef C_AXIS
, .ijk[C_AXIS] = 1.0f
#endif
#ifdef U_AXIS
, .ijk[U_AXIS] = 1.0f
#endif
#ifdef V_AXIS
, .ijk[V_AXIS] = 1.0f
#endif
};
// Simple hypotenuse computation function.
inline static float hypot_f (float x, float y)
{
return sqrtf(x * x + y * y);
}
inline static bool motion_is_lasercut (motion_mode_t motion)
{
return motion == MotionMode_Linear || motion == MotionMode_CwArc || motion == MotionMode_CcwArc || motion == MotionMode_CubicSpline || motion == MotionMode_QuadraticSpline;
}
inline static bool no_word_value (char letter)
{
return letter == '\0' || (letter >= 'A' && letter <= 'Z') || letter == '$';
}
parser_state_t *gc_get_state (void)
{
return &gc_state;
}
static void set_spindle_override (spindle_t *spindle, bool disable)
{
if(spindle->hal && spindle->hal->param->state.override_disable != disable) {
if((spindle->state.override_disable = spindle->hal->param->state.override_disable = disable))
spindle_set_override(gc_state.spindle->hal, DEFAULT_SPINDLE_RPM_OVERRIDE);
}
}
static void set_scaling (float factor)
{
uint_fast8_t idx = N_AXIS;
axes_signals_t state = gc_get_g51_state();
do {
scale_factor.ijk[--idx] = factor;
#ifdef MACH3_SCALING
scale_factor.xyz[idx] = 0.0f;
#endif
} while(idx);
gc_state.modal.scaling_active = factor != 1.0f;
if(state.value != gc_get_g51_state().value)
system_add_rt_report(Report_Scaling);
}
float *gc_get_scaling (void)
{
return scale_factor.ijk;
}
axes_signals_t gc_get_g51_state (void)
{
uint_fast8_t idx = N_AXIS;
axes_signals_t scaled = {0};
do {
scaled.value <<= 1;
if(scale_factor.ijk[--idx] != 1.0f)
scaled.value |= 0x01;
} while(idx);
return scaled;
}
float gc_get_offset (uint_fast8_t idx, bool real_time)
{
offset_id_t offset_id;
if(real_time &&
!(settings.status_report.machine_position && settings.status_report.sync_on_wco_change) &&
(offset_id = st_get_offset_id()) >= 0)
return gc_state.modal.coord_system.xyz[idx] + gc_state.offset_queue[offset_id].values[idx] + gc_state.tool_length_offset[idx];
else
return gc_state.modal.coord_system.xyz[idx] + gc_state.g92_coord_offset[idx] + gc_state.tool_length_offset[idx];
}
inline static float gc_get_block_offset (parser_block_t *gc_block, uint_fast8_t idx)
{
return gc_block->modal.coord_system.xyz[idx] + gc_state.g92_coord_offset[idx] + gc_state.tool_length_offset[idx];
}
void gc_set_tool_offset (tool_offset_mode_t mode, uint_fast8_t idx, int32_t offset)
{
bool tlo_changed = false;
switch(mode) {
case ToolLengthOffset_Cancel:
idx = N_AXIS;
do {
idx--;
tlo_changed |= gc_state.tool_length_offset[idx] != 0.0f;
gc_state.tool_length_offset[idx] = 0.0f;
if(grbl.tool_table.n_tools == 0)
gc_state.tool->offset[idx] = 0.0f;
} while(idx);
break;
case ToolLengthOffset_EnableDynamic:
{
float new_offset = offset / settings.axis[idx].steps_per_mm;
tlo_changed |= gc_state.tool_length_offset[idx] != new_offset;
gc_state.tool_length_offset[idx] = new_offset;
if(grbl.tool_table.n_tools == 0)
gc_state.tool->offset[idx] = new_offset;
}
break;
default:
break;
}
gc_state.modal.tool_offset_mode = mode;
if(tlo_changed) {
system_add_rt_report(Report_ToolOffset);
system_flag_wco_change();
}
}
plane_t *gc_get_plane_data (plane_t *plane, plane_select_t select)
{
switch (select) {
case PlaneSelect_XY:
plane->axis_0 = X_AXIS;
plane->axis_1 = Y_AXIS;
plane->axis_linear = Z_AXIS;
break;
case PlaneSelect_ZX:
plane->axis_0 = Z_AXIS;
plane->axis_1 = X_AXIS;
plane->axis_linear = Y_AXIS;
break;
default: // case PlaneSelect_YZ:
plane->axis_0 = Y_AXIS;
plane->axis_1 = Z_AXIS;
plane->axis_linear = X_AXIS;
}
return plane;
}
#if ENABLE_ACCELERATION_PROFILES
//Acceleration Profiles for G187 P[x] in percent of maximum machine acceleration.
float gc_get_accel_factor (uint8_t profile)
{
static const float lookup[] = {
1.0f, // 100% - Roughing - Max Acceleration Default
0.8f, // 80% - Semi Roughing
0.6f, // 60% - Semi Finish
0.4f, // 40% - Finish
0.2f // 20% - Slow AF Mode
};
return lookup[profile >= (sizeof(lookup) / sizeof(float)) ? 0 : profile];
}
#endif // ENABLE_ACCELERATION_PROFILES
void gc_init (bool stop)
{
#if COMPATIBILITY_LEVEL > 1
memset(&gc_state, 0, sizeof(parser_state_t));
gc_state.tool = &grbl.tool_table.tool[0];
if(grbl.tool_table.n_tools == 0)
memset(grbl.tool_table.tool, 0, sizeof(tool_data_t));
#else
if(sys.cold_start) {
memset(&gc_state, 0, sizeof(parser_state_t));
gc_state.tool = &grbl.tool_table.tool[0];
if(grbl.tool_table.n_tools == 0)
memset(grbl.tool_table.tool, 0, sizeof(tool_data_t));
} else {
coord_system_id_t coord_system_id = gc_state.modal.coord_system.id;
tool_offset_mode_t tool_offset_mode = gc_state.modal.tool_offset_mode;
memset(&gc_state, 0, offsetof(parser_state_t, g92_coord_offset));
gc_state.tool_pending = gc_state.tool->tool_id;
if(hal.tool.select)
hal.tool.select(gc_state.tool, false);
if(stop) {
// Restore offsets, tool offset mode
gc_state.modal.coord_system.id = coord_system_id;
gc_state.modal.tool_offset_mode = tool_offset_mode;
}
}
#endif
// Clear any pending output commands
gc_clear_output_commands(output_commands);
// Load default override status
gc_state.modal.override_ctrl = sys.override.control;
#if N_SYS_SPINDLE > 1
gc_state.spindle = &gc_state.modal.spindle[0];
gc_state.modal.spindle[0].hal = spindle_get(0);
#else
gc_state.spindle = &gc_state.modal.spindle;
gc_state.modal.spindle.hal = spindle_get(0);
#endif
set_scaling(1.0f);
// Load default G54 coordinate system.
if (!settings_read_coord_data(gc_state.modal.coord_system.id, &gc_state.modal.coord_system.xyz))
grbl.report.status_message(Status_SettingReadFail);
if(sys.cold_start && !settings.flags.g92_is_volatile) {
if(!settings_read_coord_data(CoordinateSystem_G92, &gc_state.g92_coord_offset))
grbl.report.status_message(Status_SettingReadFail);
else
memcpy(&gc_state.offset_queue[gc_state.offset_id], &gc_state.g92_coord_offset, sizeof(coord_data_t));
}
if(grbl.on_wco_changed && (!sys.cold_start ||
!is0_position_vector(gc_state.modal.coord_system.xyz) ||
!is0_position_vector(gc_state.g92_coord_offset)))
grbl.on_wco_changed();
#if NGC_EXPRESSIONS_ENABLE
ngc_flowctrl_init();
#endif
#if NGC_PARAMETERS_ENABLE
ngc_modal_state_invalidate();
#endif
#if ENABLE_ACCELERATION_PROFILES
gc_state.modal.acceleration_factor = gc_get_accel_factor(0); // Initialize machine with default
#endif
// if(settings.flags.lathe_mode)
// gc_state.modal.plane_select = PlaneSelect_ZX;
if(grbl.on_parser_init)
grbl.on_parser_init(&gc_state);
}
inline static bool is_single_spindle_block (parser_block_t *gc_block, modal_groups_t command_words)
{
return gc_block->words.s ||
(command_words.G1 && (gc_block->modal.motion == MotionMode_SpindleSynchronized ||
gc_block->modal.motion == MotionMode_RigidTapping ||
gc_block->modal.motion == MotionMode_Threading)) ||
(command_words.G5 && gc_block->modal.feed_mode == FeedMode_UnitsPerRev) ||
command_words.G14 ||
(command_words.M9 && gc_block->override_command == Override_SpindleSpeed);
}
// Set dynamic laser power mode to PPI (Pulses Per Inch)
// Returns true if driver uses hardware implementation.
// Driver support for pulsing the laser on signal is required for this to work.
bool gc_laser_ppi_enable (uint_fast16_t ppi, uint_fast16_t pulse_length)
{
gc_state.is_laser_ppi_mode = ppi > 0 && pulse_length > 0;
return grbl.on_laser_ppi_enable && grbl.on_laser_ppi_enable(ppi, pulse_length);
}
spindle_t *gc_spindle_get (spindle_num_t spindle)
{
#if N_SYS_SPINDLE > 1
return spindle < 0 ? gc_state.spindle : &gc_state.modal.spindle[spindle];
#else
return &gc_state.modal.spindle;
#endif
}
void gc_spindle_off (void)
{
#if N_SYS_SPINDLE > 1
uint_fast8_t idx;
for(idx = 0; idx < N_SYS_SPINDLE; idx++) {
memset(&gc_state.modal.spindle[idx], 0, offsetof(spindle_t, hal));
}
#else
memset(&gc_state.modal.spindle, 0, offsetof(spindle_t, hal));
#endif
spindle_all_off();
system_add_rt_report(Report_Spindle);
}
void gc_coolant (coolant_state_t state)
{
gc_state.modal.coolant = state;
hal.coolant.set_state(gc_state.modal.coolant);
system_add_rt_report(Report_Coolant);
}
static void add_offset (void)
{
gc_state.offset_id = (gc_state.offset_id + 1) & (MAX_OFFSET_ENTRIES - 1);
memcpy(&gc_state.offset_queue[gc_state.offset_id], &gc_state.g92_coord_offset, sizeof(coord_data_t));
system_flag_wco_change();
}
static tool_data_t *tool_get_pending (tool_id_t tool_id)
{
static tool_data_t tool_data = {0};
if(grbl.tool_table.n_tools)
return &grbl.tool_table.tool[tool_id];
memcpy(&tool_data, gc_state.tool, sizeof(tool_data_t));
tool_data.tool_id = tool_id;
return &tool_data;
}
static inline void tool_set (tool_data_t *tool)
{
if(grbl.tool_table.n_tools)
gc_state.tool = tool;
else
gc_state.tool->tool_id = tool->tool_id;
}
// Add output command to linked list
static bool add_output_command (output_command_t *command)
{
output_command_t *add_cmd;
if((add_cmd = malloc(sizeof(output_command_t)))) {
memcpy(add_cmd, command, sizeof(output_command_t));
if(output_commands == NULL)
output_commands = add_cmd;
else {
output_command_t *cmd = output_commands;
while(cmd->next)
cmd = cmd->next;
cmd->next = add_cmd;
}
}
return add_cmd != NULL;
}
// Free linked list of output commands
void gc_clear_output_commands (output_command_t *cmd)
{
while(cmd) {
output_command_t *next = cmd->next;
free(cmd);
cmd = next;
}
}
#if GCODE_ADVANCED
static gc_thread_data thread;
static status_code_t init_sync_motion (plan_line_data_t *pl_data, float pitch)
{
if(pl_data->spindle.hal->get_data == NULL)
FAIL(Status_GcodeUnsupportedCommand); // [Spindle not sync capable]
pl_data->condition.inverse_time = Off;
pl_data->feed_rate = gc_state.distance_per_rev = pitch;
pl_data->spindle.css = NULL; // Switch off CSS.
pl_data->overrides = sys.override.control; // Use current override flags and
pl_data->overrides.sync = On; // set to sync overrides on execution of motion.
// Disable feed rate and spindle overrides for the duration of the cycle.
pl_data->overrides.spindle_rpm_disable = sys.override.control.spindle_rpm_disable = On;
pl_data->overrides.feed_rate_disable = sys.override.control.feed_rate_disable = On;
pl_data->spindle.hal->param->override_pct = DEFAULT_SPINDLE_RPM_OVERRIDE;
// TODO: need for gc_state.distance_per_rev to be reset on modal change?
float feed_rate = pl_data->feed_rate * pl_data->spindle.hal->get_data(SpindleData_RPM)->rpm;
if(feed_rate == 0.0f)
FAIL(Status_GcodeSpindleNotRunning); // [Spindle not running]
if(feed_rate > settings.axis[Z_AXIS].max_rate * 0.9f)
FAIL(Status_GcodeMaxFeedRateExceeded); // [Feed rate too high]
return Status_OK;
}
#endif // GCODE_ADVANCED
// Output and free previously allocated message
void gc_output_message (char *message)
{
if(message) {
if(grbl.on_gcode_message)
grbl.on_gcode_message(message);
if(*message)
report_message(message, Message_Plain);
free(message);
}
}
#if NGC_PARAMETERS_ENABLE
static parameter_words_t g65_words = {0};
parameter_words_t gc_get_g65_arguments (void)
{
return g65_words;
}
bool gc_modal_state_restore (gc_modal_t *copy)
{
bool ok = false;
if((ok = !!copy && !ABORTED)) {
copy->auto_restore = false;
copy->motion = gc_state.modal.motion;
if(copy->coolant.value != gc_state.modal.coolant.value)
coolant_restore(copy->coolant, settings.coolant.on_delay);
#if N_SYS_SPINDLE > 1
uint_fast8_t idx = N_SYS_SPINDLE;
spindle_t *spindle, *spindle_copy;
do {
if((spindle = &gc_state.modal.spindle[--idx])->hal) {
spindle_copy = ©->spindle[idx];
if(!memcmp(spindle_copy, spindle, offsetof(spindle_t, hal)))
spindle_restore(spindle->hal, spindle_copy->state, spindle_copy->rpm, settings.spindle.on_delay);
}
} while(idx);
#else
if(!memcmp(©->spindle, &gc_state.modal.spindle, offsetof(spindle_t, hal)))
spindle_restore(gc_state.modal.spindle.hal, copy->spindle.state, copy->spindle.rpm, settings.spindle.on_delay);
#endif
memcpy(&gc_state.modal, copy, sizeof(gc_modal_t));
gc_state.feed_rate = gc_state.modal.feed_rate;
}
return ok;
}
#endif // NGC_PARAMETERS_ENABLE
// Remove whitespace, control characters, comments and if block delete is active block delete lines
// else the block delete character. Remaining characters are converted to upper case.
// If the driver handles message comments then the first is extracted and returned in a dynamically
// allocated memory block, the caller must free this after the message has been processed.
char *gc_normalize_block (char *block, status_code_t *status, char **message)
{
char c, *s1, *s2, *comment = NULL;
// Remove leading whitespace & control characters
while(*block && *block <= ' ')
block++;
if(*block == ';' || (*block == '/' && sys.flags.block_delete_enabled)) {
*block = '\0';
return block;
}
if(*block == '/')
block++;
s1 = s2 = block;
while((c = *s1) != '\0') {
if(c > ' ') switch(c) {
case ';':
if(!comment) {
*s1 = '\0';
continue;
}
break;
case '(':
// TODO: generate error if a left parenthesis is found inside a comment...
comment = s1 + 1;
break;
case ')':
if(comment && !gc_state.skip_blocks) {
*s1 = '\0';
if(!hal.driver_cap.no_gcode_message_handling) {
if(message && *message == NULL) {
if(grbl.on_process_gcode_comment)
*message = grbl.on_process_gcode_comment(comment);
if(*message == NULL) {
size_t len = s1 - comment - 3;
if(!strncasecmp(comment, "MSG,", 4) && (*message = malloc(len))) {
comment += 4;
while(*comment == ' ') {
comment++;
len--;
}
memcpy(*message, comment, len);
}
}
}
}
if(*comment && (message == NULL || *message == NULL) && grbl.on_gcode_comment)
*status = grbl.on_gcode_comment(comment);
}
comment = NULL;
break;
default:
if(comment == NULL)
*s2++ = CAPS(c);
break;
}
s1++;
}
*s2 = '\0';
return block;
}
// Parses and executes one block (line) of 0-terminated G-Code.
// In this function, all units and positions are converted and exported to internal functions
// in terms of (mm, mm/min) and absolute machine coordinates, respectively.
status_code_t gc_execute_block (char *block)
{
static const parameter_words_t axis_words_mask = {
.x = On,
.y = On,
.z = On
#ifdef A_AXIS
, .a = On
#endif
#ifdef B_AXIS
, .b = On
#endif
#ifdef C_AXIS
, .c = On
#endif
#if LATHE_UVW_OPTION
, .u = On
, .v = On
, .w = On
#else
#ifdef U_AXIS
, .u = On
#endif
#ifdef V_AXIS
, .v = On
#endif
#endif
};
#if GCODE_ADVANCED
static const parameter_words_t pq_words = {
.p = On,
.q = On
};
static const parameter_words_t ij_words = {
.i = On,
.j = On
};
#endif
static const parameter_words_t positive_only_words = {
.d = On,
.f = On,
.h = On,
.n = On,
.o = On,
.t = On,
.s = On
};
static const modal_groups_t jog_groups = {
.G0 = On,
.G3 = On,
.G6 = On
};
static parser_block_t gc_block;
#if NGC_EXPRESSIONS_ENABLE
static const parameter_words_t o_label = {
.o = On
};
static ngc_param_t ngc_params[NGC_N_ASSIGN_PARAMETERS_PER_BLOCK];
uint_fast8_t ngc_param_count = 0;
// NOTE: this array has to match the parameter_words_t order!
PROGMEM static const gc_value_ptr_t gc_value_ptr[] = {
{ NULL, ValueType_NA }, // $
#if N_AXIS > 3
{ &gc_block.values.xyz[A_AXIS], ValueType_Float },
#else
{ NULL, ValueType_NA },
#endif
#if N_AXIS > 4
{ &gc_block.values.xyz[B_AXIS], ValueType_Float },
#else
{ NULL, ValueType_NA },
#endif
#if N_AXIS > 5
{ &gc_block.values.xyz[C_AXIS], ValueType_Float },
#else
{ NULL, ValueType_NA },
#endif
{ &gc_block.values.ijk[I_VALUE], ValueType_Float },
{ &gc_block.values.ijk[J_VALUE], ValueType_Float },
{ &gc_block.values.ijk[K_VALUE], ValueType_Float },
{ &gc_block.values.d, ValueType_Float },
{ &gc_block.values.e, ValueType_Float },
{ &gc_block.values.f, ValueType_Float },
{ NULL, ValueType_NA }, // G
{ &gc_block.values.h, ValueType_UInt32 },
{ NULL, ValueType_NA }, // L
{ &gc_block.values.m, ValueType_Float },
{ NULL, ValueType_NA }, // N
{ NULL, ValueType_NA }, // O
{ NULL, ValueType_NA }, // P
{ &gc_block.values.q, ValueType_Float },
{ &gc_block.values.r, ValueType_Float },
{ &gc_block.values.s, ValueType_Float },
{ &gc_block.values.t, ValueType_UInt32 },
#if N_AXIS > 6
{ &gc_block.values.xyz[U_AXIS], ValueType_Float },
#else
{ NULL, ValueType_NA },
#endif
#if N_AXIS > 7
{ &gc_block.values.xyz[V_AXIS], ValueType_Float },
#else
{ NULL, ValueType_NA },
#endif
{ NULL, ValueType_NA }, // W
{ &gc_block.values.xyz[X_AXIS], ValueType_Float },
{ &gc_block.values.xyz[Y_AXIS], ValueType_Float },
{ &gc_block.values.xyz[Z_AXIS], ValueType_Float }
};
#endif
char *message = NULL;
status_code_t status = Status_OK;
struct {
float f;
uint32_t o;
float s;
tool_id_t t;
} single_meaning_value = {0};
bool fs_changed;
if((fs_changed = gc_state.file_stream ? hal.stream.file == NULL : hal.stream.file != NULL))
gc_state.file_stream = hal.stream.file != NULL;
block = gc_normalize_block(block, &status, &message);
if(status != Status_OK)
FAIL(status);
// Determine if the line is a program start/end marker.
if(block[0] == CMD_PROGRAM_DEMARCATION && block[1] == '\0') {
block[0] = '\0';
if(gc_state.file_stream) {
if(!fs_changed && !gc_state.file_run)
status = Status_UnexpectedDemarcation;
else if(!(gc_state.file_run = fs_changed)) {
protocol_buffer_synchronize(); // Empty planner buffer
grbl.report.feedback_message(Message_ProgramEnd);
if(grbl.on_program_completed)
grbl.on_program_completed(ProgramFlow_EndPercent, state_get() == STATE_CHECK_MODE);
}
} else
gc_state.file_run = !gc_state.file_run;
if(status == Status_OK && grbl.on_file_demarcate)
grbl.on_file_demarcate(gc_state.file_run);
}
if(block[0] == '\0') {
if(message)
gc_output_message(message);
return status;
}
/* -------------------------------------------------------------------------------------
STEP 1: Initialize parser block struct and copy current g-code state modes. The parser
updates these modes and commands as the block line is parsed and will only be used and
executed after successful error-checking. The parser block struct also contains a block
values struct, word tracking variables, and a non-modal commands tracker for the new
block. This struct contains all of the necessary information to execute the block. */
memset(&gc_block, 0, sizeof(gc_block)); // Initialize the parser block struct.
memcpy(&gc_block.modal, &gc_state.modal, sizeof(gc_state.modal)); // Copy current modes
bool set_tool = false, spindle_event = false;
axis_command_t axis_command = AxisCommand_None;
io_mcode_t port_command = (io_mcode_t)0;
spindle_t *sspindle = gc_state.spindle;
plane_t plane;
// Initialize bitflag tracking variables for axis indices compatible operations.
axes_signals_t axis_words = {0}; // XYZ tracking
ijk_words_t ijk_words = {0}; // IJK tracking
// Initialize command and value words and parser flags variables.
modal_groups_t command_words = {0}; // Bitfield for tracking G and M command words. Also used for modal group violations.
gc_parser_flags_t gc_parser_flags = {0}; // Parser flags for handling special cases.
parameter_words_t user_words = {0}; // User M-code words "taken"
// Determine if the line is a jogging motion or a normal g-code block.
if (block[0] == '$') { // NOTE: `$J=` already parsed when passed to this function.
// Set G1 and G94 enforced modes to ensure accurate error checks.
gc_parser_flags.jog_motion = On;
gc_block.modal.motion = MotionMode_Linear;
gc_block.modal.feed_mode = FeedMode_UnitsPerMin;
gc_block.spindle_modal.rpm_mode = SpindleSpeedMode_RPM;
gc_block.values.n = JOG_LINE_NUMBER; // Initialize default line number reported during jog.
}
/* -------------------------------------------------------------------------------------
STEP 2: Import all g-code words in the block. A g-code word is a letter followed by
a number, which can either be a 'G'/'M' command or sets/assigns a command value. Also,
perform initial error-checks for command word modal group violations, for any repeated
words, and for negative values set for the value words F, N, P, T, and S. */
uint_fast8_t char_counter = gc_parser_flags.jog_motion ? 3 /* Start parsing after `$J=` */ : 0;
char letter;
float value;
uint32_t int_value = 0;
uint_fast16_t mantissa = 0;
user_mcode_type_t user_mcode = UserMCode_Unsupported;
word_bit_t word_bit = { .parameter = {0}, .modal_group = {0} }; // Bit-value for assigning tracking variables
while ((letter = block[char_counter++]) != '\0') { // Loop until no more g-code words in block.
// Import the next g-code word, expecting a letter followed by a value. Otherwise, error out.
#if NGC_EXPRESSIONS_ENABLE
status_code_t status;
if(letter == '#') {
if(gc_state.skip_blocks)
return Status_OK;
if(block[char_counter] == '<') {
char name[NGC_MAX_PARAM_LENGTH + 1];
if((status = ngc_read_name(block, &char_counter, name)) == Status_OK) {
if(block[char_counter++] != '=')
status = Status_BadNumberFormat; // [Expected equal sign]
else if((status = ngc_read_real_value(block, &char_counter, &value)) == Status_OK) {
if(!ngc_named_param_set(name, value))
status = Status_BadNumberFormat; // [Out of memory or attempt to write RO parameter]
} // else: [Expected value]
} // else: [Expected parameter name]
} else {
float param;
if((status = ngc_read_real_value(block, &char_counter, ¶m)) == Status_OK) {
if(!ngc_param_is_rw((ngc_param_id_t)param))
status = Status_GcodeValueOutOfRange; // [Parameter does not exist or is read only]
else if(block[char_counter++] != '=')
status = Status_BadNumberFormat; // [Expected equal sign]
else if((status = ngc_read_real_value(block, &char_counter, &value)) == Status_OK) {
if(ngc_param_count < NGC_N_ASSIGN_PARAMETERS_PER_BLOCK) {
ngc_params[ngc_param_count].id = (ngc_param_id_t)param;
ngc_params[ngc_param_count++].value = value;
} else
FAIL(Status_BadNumberFormat); // [Too many parameters in block]
} // else: [Expected parameter value]
} // else: [Expected parameter number]
}
if(status != Status_OK)
FAIL(status);
continue;
} else if(letter == 'O') {
gc_block.words.n = Off; // Hack to allow line number with O word
if(block[char_counter] == '[') {
int32_t value;
if((status = ngc_read_integer_value(block, &char_counter, &value)) == Status_OK) {
gc_block.words.o = On;
gc_block.values.o = (uint32_t)value;
char_counter++;
} else
FAIL(status);
} else if(block[char_counter] == '<') {
char o_slabel[NGC_MAX_PARAM_LENGTH + 1];
if((status = ngc_read_name(block, &char_counter, o_slabel)) != Status_OK)
FAIL(status);
gc_block.words.o = On;
if((gc_block.values.o = ngc_string_param_set_name(o_slabel)) == 0)
FAIL(Status_FlowControlOutOfMemory);
continue;
}
}
if((gc_block.words.mask & o_label.mask) && (gc_block.words.mask & ~o_label.mask) == 0) {
char_counter--;
return ngc_flowctrl(gc_block.values.o, block, &char_counter, &gc_state.skip_blocks);
}
if((letter < 'A' && letter != '$') || letter > 'Z')
FAIL(Status_ExpectedCommandLetter); // [Expected word letter]
if(user_mcode == UserMCode_NoValueWords && no_word_value(block[char_counter]))
value = NAN;
else if((status = ngc_read_real_value(block, &char_counter, &value)) != Status_OK)
return status;
if(gc_state.skip_blocks && letter != 'O')
return Status_OK;
if(user_mcode != UserMCode_NoValueWords && isnan(value))
FAIL(Status_BadNumberFormat); // [Expected word value]
g65_words.value = 0;
#else