/* stepper.c - stepper motor driver: executes motion plans using stepper motors Part of Grbl Copyright (c) 2018-2022 Jens Weiß Copyright (c) 2017-2018 Gauthier Briere Copyright (c) 2011-2016 Sungeun K. Jeon for Gnea Research LLC Copyright (c) 2009-2011 Simen Svale Skogsrud 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 . */ #include "grbl.h" #include "memorymap.h" #include "fast_math_board.h" #include #include "sd_mmc_apk.h" #include "Config/mmc_config.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) #ifdef STEP_DATA_FILE_TRANSFER uint32_t segment_number = 0; uint8_t file_tring[10]; #endif // Stepper ISR data struct. Contains the running data for the main stepper ISR. typedef struct { // Used by the bresenham line algorithm uint32_t counter_x; // Counter variables for the bresenham line tracer uint32_t counter_y; uint32_t counter_z; uint32_t counter_a; uint32_t counter_b; uint32_t counter_c; #ifdef STEP_PULSE_DELAY uint8_t step_bits; // Stores out_bits output to complete the step pulse delay #endif 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; 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. uint32_t exec_block_adress; // Address to the block data for the segment being executed uint32_t exec_segment_adress; // Address to the segment being executed //locale variables inside FPGA uint8_t segment_buffer_tail; uint8_t segment_buffer_head; int32_t sys_position[N_AXIS]; uint8_t step_port_invert_mask; uint8_t dir_port_invert_mask; //step block data uint8_t step_block_directionbits; uint32_t step_event_count; uint32_t steps[N_AXIS]; uint8_t pwm_adjusted; } stepper_t; static stepper_t st; // Step segment ring buffer indices static uint8_t segment_next_head; // Used to avoid ISR nesting of the "Stepper Driver Interrupt". Should never occur though. static volatile uint8_t busy; // 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 plan_block_t *pl_block; // Pointer to the planner block being prepped static uint32_t st_prep_block_adress; // Pointer to the stepper block data being prepped // 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. uint16_t current_spindle_pwm; } st_prep_t; static st_prep_t prep; /* 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. */ // 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 st_wake_up() { uint16_t step_pulse_time = 0; st.step_port_invert_mask = readSRAMByte_protected(STEP_PORT_INVERT_MASK); st.dir_port_invert_mask = readSRAMByte_protected(DIR_PORT_INVERT_MASK); if (bit_istrue(settings.flags,BITFLAG_INVERT_ST_ENABLE)) { STEPPERS_DISABLE_PORT |= (1< //ffwrites(file_tring); itoa(st_exec_segment_prescaler, file_tring, 10); strcat(file_tring, ";"); //---> //ffwrites(file_tring); utoa(st_exec_segment_cycles, file_tring, 10); strcat(file_tring, ";"); //---> //ffwrites(file_tring); utoa(st_exec_segment_n_step, file_tring, 10); strcat(file_tring, ";"); //---> //ffwrites(file_tring); itoa(st_exec_segment_block_index, file_tring, 10); strcat(file_tring, ";"); //---> //ffwrites(file_tring); utoa(st_exec_segment_spindle_pwm, file_tring, 10); strcat(file_tring, "\n"); //---> //ffwrites(file_tring); segment_number++; } STEPPER_RESET_TIMER.CNT = 0; STEPPER_RESET_TIMER.CTRLA = TC_CLKSEL_DIV1_gc; //restart timer #endif if(st_exec_segment_prescaler == 1) STEPPER_DRIVER_TIMER.CTRLA = TC_CLKSEL_DIV1_gc; else if(st_exec_segment_prescaler == 2) STEPPER_DRIVER_TIMER.CTRLA = TC_CLKSEL_DIV8_gc; else if(st_exec_segment_prescaler == 3) STEPPER_DRIVER_TIMER.CTRLA = TC_CLKSEL_DIV64_gc; // Initialize step segment timing per step and load number of steps to execute. STEPPER_DRIVER_TIMER.PER = st_exec_segment_cycles; 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_block_index ) { st.exec_block_index = st_exec_segment_block_index; st.exec_block_adress = (uint32_t)(ST_BLOCK_BUFFER_BASE + (st.exec_block_index * ST_BLOCK_SIZE)); st.step_event_count = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEP_EVENT_COUNT); st.step_block_directionbits = readSRAMByte_protected(st.exec_block_adress + ST_BLOCK_DIR_BITS); st.dir_outbits = st.step_block_directionbits ^ st.dir_port_invert_mask; st.pwm_adjusted = readSRAMByte_protected(st.exec_block_adress + ST_BLOCK_PWM_ADJUSTED); // Initialize Bresenham line and distance counters #if N_AXIS == 4 st.counter_x = (st.step_event_count >> 1); st.steps[AXIS_1] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_X); st.counter_y = (st.step_event_count >> 1); st.steps[AXIS_2] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Y); st.counter_z = (st.step_event_count >> 1); st.steps[AXIS_3] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Z); st.counter_a = (st.step_event_count >> 1); st.steps[AXIS_4] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_A); #elif N_AXIS == 5 st.counter_x = (st.step_event_count >> 1); st.steps[AXIS_1] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_X); st.counter_y = (st.step_event_count >> 1); st.steps[AXIS_2] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Y); st.counter_z = (st.step_event_count >> 1); st.steps[AXIS_3] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Z); st.counter_a = (st.step_event_count >> 1); st.steps[AXIS_4] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_A); st.counter_b = (st.step_event_count >> 1); st.steps[AXIS_5] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_B); #elif N_AXIS == 6 st.counter_x = (st.step_event_count >> 1); st.steps[AXIS_1] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_X); st.counter_y = (st.step_event_count >> 1); st.steps[AXIS_2] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Y); st.counter_z = (st.step_event_count >> 1); st.steps[AXIS_3] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Z); st.counter_a = (st.step_event_count >> 1); st.steps[AXIS_4] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_A); st.counter_b = (st.step_event_count >> 1); st.steps[AXIS_5] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_B); st.counter_c = (st.step_event_count >> 1); st.steps[AXIS_6] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_C); #else st.counter_x = (st.step_event_count >> 1); st.steps[AXIS_1] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_X); st.counter_y = (st.step_event_count >> 1); st.steps[AXIS_2] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Y); st.counter_z = (st.step_event_count >> 1); st.steps[AXIS_3] = readSRAMDWord_protected(st.exec_block_adress + ST_BLOCK_STEPS_AXIS_Z); #endif } // Set real-time spindle output as segment is loaded, just prior to the first step. spindle_set_speed(st_exec_segment_spindle_pwm); } else { // Segment buffer empty. Shutdown. st_go_idle(); // Ensure pwm is set properly upon completion of rate-controlled motion. if (st.pwm_adjusted) { spindle_set_speed(SPINDLE_PWM_OFF_VALUE); } system_set_exec_state_flag(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_state_monitor(); } // Reset step out bits. st.step_outbits = 0; // Execute step displacement profile by Bresenham line algorithm st.counter_x += st.steps[AXIS_1]; //counter += st.exec_block->steps[AXIS_1]; if (st.counter_x > st.step_event_count) { //counter > st.exec_block->step_event_count st.step_outbits |= (1<step_event_count; if (st.step_block_directionbits & (1<direction_bits & (1< st.step_event_count) { st.step_outbits |= (1< st.step_event_count) { st.step_outbits |= (1< 3 st.counter_a += st.steps[AXIS_4]; if (st.counter_a > st.step_event_count) { st.step_outbits |= (1< 3 #if N_AXIS > 4 st.counter_b += st.steps[AXIS_5]; if (st.counter_b > st.step_event_count) { st.step_outbits |= (1< 4 #if N_AXIS > 5 st.counter_c += st.steps[AXIS_6]; if (st.counter_c > st.step_event_count) { st.step_outbits |= (1< 5 // 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_adress = 0; if ( ++st.segment_buffer_tail == SEGMENT_BUFFER_SIZE) { st.segment_buffer_tail = 0; } writeSRAMByte_protected(SEGMENT_BUFFER_TAIL, st.segment_buffer_tail); } st.step_outbits ^= st.step_port_invert_mask; // Apply step port invert mask busy = false; set_sys_position(st.sys_position); DEBUG_PORT &= ~(1< 3 STEP_PORT = (STEP_PORT & ~(1 << A_STEP_BIT)) | step_port_invert_mask; DIRECTION_PORT = (DIRECTION_PORT & ~(1 << A_DIRECTION_BIT)) | dir_port_invert_mask; #endif #if N_AXIS > 4 STEP_PORT = (STEP_PORT & ~(1 << B_STEP_BIT)) | step_port_invert_mask; DIRECTION_PORT = (DIRECTION_PORT & ~(1 << B_DIRECTION_BIT)) | dir_port_invert_mask; #endif #if N_AXIS > 5 STEP_PORT = (STEP_PORT & ~(1 << C_STEP_BIT)) | step_port_invert_mask; DIRECTION_PORT = (DIRECTION_PORT & ~(1 << C_DIRECTION_BIT)) | dir_port_invert_mask; #endif } // Initialize and start the stepper motor subsystem void stepper_init() { // Configure step and direction interface pins STEP_DDR |= STEP_MASK; DIRECTION_DDR |= DIRECTION_MASK; STEPPERS_DISABLE_DDR |= (1<entry_speed_sqr = prep.current_speed*prep.current_speed; // Update entry speed. pl_block = NULL; // Flag st_prep_segment() to load and check active velocity profile. } } // Increments the step segment buffer block data ring buffer. static uint8_t st_next_block_index(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 st_parking_setup_buffer() { // 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 = NULL; // Always reset parking motion to reload new block. } // Restores the step segment buffer to the normal run state after a parking motion. void st_parking_restore_buffer() { // 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]; st_prep_block_adress = (uint32_t)(ST_BLOCK_BUFFER_BASE + (prep.last_st_block_index * ST_BLOCK_SIZE)); // writeSRAMDWord(ST_PREP_BLOCK_ADRESS, st_prep_block_adress); 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 st_prep_buffer() { uint8_t segment_buffer_head = readSRAMByte_protected(SEGMENT_BUFFER_HEAD); uint8_t segment_buffer_tail = readSRAMByte_protected(SEGMENT_BUFFER_TAIL); // Block step prep buffer, while in a suspend state and there is no suspend motion to execute. if (bit_istrue(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 == NULL) { // Query planner for a queued block if (sys.step_control & STEP_CONTROL_EXECUTE_SYS_MOTION) { pl_block = plan_get_system_motion_block(); } else { pl_block = plan_get_current_block(); } if (pl_block == NULL) { return; } // No planner blocks. Exit. // 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 { // Load the Bresenham stepping data for the block. prep.st_block_index = st_next_block_index(prep.st_block_index); // Prepare and copy Bresenham algorithm segment data from the new planner block, so that // when the segment buffer completes the planner block, it may be discarded when the // segment buffer finishes the prepped block, but the stepper ISR is still executing it. st_prep_block_adress = (uint32_t)(ST_BLOCK_BUFFER_BASE + (prep.st_block_index * ST_BLOCK_SIZE)); writeSRAMByte_protected(st_prep_block_adress + ST_BLOCK_DIR_BITS, pl_block->direction_bits); uint8_t idx; for (idx=0; idxsteps[idx] << 1); } writeSRAMDWord_protected(st_prep_block_adress + ST_BLOCK_STEP_EVENT_COUNT, pl_block->step_event_count << 1); // Initialize segment buffer data for generating the segments. prep.steps_remaining = (float)pl_block->step_event_count; prep.step_per_mm = prep.steps_remaining/pl_block->millimeters; prep.req_mm_increment = REQ_MM_INCREMENT_SCALAR/prep.step_per_mm; prep.dt_remainder = 0.0; // Reset for new segment block if ((sys.step_control & STEP_CONTROL_EXECUTE_HOLD) || (prep.recalculate_flag & PREP_FLAG_DECEL_OVERRIDE)) { // New block loaded mid-hold. Override planner block entry speed to enforce deceleration. prep.current_speed = prep.exit_speed; pl_block->entry_speed_sqr = prep.exit_speed*prep.exit_speed; prep.recalculate_flag &= ~(PREP_FLAG_DECEL_OVERRIDE); } else { prep.current_speed = sqrt(pl_block->entry_speed_sqr); } // Setup laser mode variables. PWM rate adjusted motions will always complete a motion with the // spindle off. writeSRAMByte_protected(st_prep_block_adress + ST_BLOCK_PWM_ADJUSTED, false); if (settings.flags & BITFLAG_LASER_MODE) { if (pl_block->condition & PL_COND_FLAG_SPINDLE_CCW) { // Pre-compute inverse programmed rate to speed up PWM updating per step segment. prep.inv_rate = 1.0/pl_block->programmed_rate; writeSRAMByte_protected(st_prep_block_adress + ST_BLOCK_PWM_ADJUSTED, true); } } } /* --------------------------------------------------------------------------------- Compute the velocity profile of a new planner block based on its entry and exit speeds, or recompute the profile of a partially-completed planner block if the planner has updated it. For a commanded forced-deceleration, such as from a feed hold, override the planner velocities and decelerate to the target exit speed. */ prep.mm_complete = 0.0; // Default velocity profile complete at 0.0mm from end of block. float inv_2_accel = 0.5/pl_block->acceleration; if (sys.step_control & STEP_CONTROL_EXECUTE_HOLD) { // [Forced Deceleration to Zero Velocity] // Compute velocity profile parameters for a feed hold in-progress. This profile overrides // the planner block profile, enforcing a deceleration to zero speed. prep.ramp_type = RAMP_DECEL; // Compute decelerate distance relative to end of block. float decel_dist = pl_block->millimeters - inv_2_accel*pl_block->entry_speed_sqr; if (decel_dist < 0.0) { // Deceleration through entire planner block. End of feed hold is not in this block. prep.exit_speed = sqrt(pl_block->entry_speed_sqr-2*pl_block->acceleration*pl_block->millimeters); } else { prep.mm_complete = decel_dist; // End of feed hold. prep.exit_speed = 0.0; } } else { // [Normal Operation] // Compute or recompute velocity profile parameters of the prepped planner block. prep.ramp_type = RAMP_ACCEL; // Initialize as acceleration ramp. prep.accelerate_until = pl_block->millimeters; float exit_speed_sqr; float nominal_speed; if (sys.step_control & STEP_CONTROL_EXECUTE_SYS_MOTION) { prep.exit_speed = exit_speed_sqr = 0.0; // Enforce stop at end of system motion. } else { exit_speed_sqr = plan_get_exec_block_exit_speed_sqr(); prep.exit_speed = sqrt(exit_speed_sqr); } nominal_speed = plan_compute_profile_nominal_speed(pl_block); float nominal_speed_sqr = nominal_speed*nominal_speed; float intersect_distance = 0.5*(pl_block->millimeters+inv_2_accel*(pl_block->entry_speed_sqr-exit_speed_sqr)); if (pl_block->entry_speed_sqr > nominal_speed_sqr) { // Only occurs during override reductions. prep.accelerate_until = pl_block->millimeters - inv_2_accel*(pl_block->entry_speed_sqr-nominal_speed_sqr); if (prep.accelerate_until <= 0.0) { // Deceleration-only. prep.ramp_type = RAMP_DECEL; // prep.decelerate_after = pl_block->millimeters; // prep.maximum_speed = prep.current_speed; // Compute override block exit speed since it doesn't match the planner exit speed. prep.exit_speed = sqrt(pl_block->entry_speed_sqr - 2*pl_block->acceleration*pl_block->millimeters); prep.recalculate_flag |= PREP_FLAG_DECEL_OVERRIDE; // Flag to load next block as deceleration override. // TODO: Determine correct handling of parameters in deceleration-only. // Can be tricky since entry speed will be current speed, as in feed holds. // Also, look into near-zero speed handling issues with this. } else { // Decelerate to cruise or cruise-decelerate types. Guaranteed to intersect updated plan. prep.decelerate_after = inv_2_accel*(nominal_speed_sqr-exit_speed_sqr); prep.maximum_speed = nominal_speed; prep.ramp_type = RAMP_DECEL_OVERRIDE; } } else if (intersect_distance > 0.0) { if (intersect_distance < pl_block->millimeters) { // Either trapezoid or triangle types // NOTE: For acceleration-cruise and cruise-only types, following calculation will be 0.0. prep.decelerate_after = inv_2_accel*(nominal_speed_sqr-exit_speed_sqr); if (prep.decelerate_after < intersect_distance) { // Trapezoid type prep.maximum_speed = nominal_speed; if (pl_block->entry_speed_sqr == nominal_speed_sqr) { // Cruise-deceleration or cruise-only type. prep.ramp_type = RAMP_CRUISE; } else { // Full-trapezoid or acceleration-cruise types prep.accelerate_until -= inv_2_accel*(nominal_speed_sqr-pl_block->entry_speed_sqr); } } else { // Triangle type prep.accelerate_until = intersect_distance; prep.decelerate_after = intersect_distance; prep.maximum_speed = sqrt(2.0*pl_block->acceleration*intersect_distance+exit_speed_sqr); } } else { // Deceleration-only type prep.ramp_type = RAMP_DECEL; // prep.decelerate_after = pl_block->millimeters; // prep.maximum_speed = prep.current_speed; } } else { // Acceleration-only type prep.accelerate_until = 0.0; // prep.decelerate_after = 0.0; prep.maximum_speed = prep.exit_speed; } } bit_true(sys.step_control, STEP_CONTROL_UPDATE_SPINDLE_PWM); // Force update whenever updating block. } // Initialize new segment uint32_t prep_segment_adress = SEG_BLOCK_BUFFER_BASE + (segment_buffer_head * SEG_BLOCK_SIZE); // Set new segment to point to the current segment data block. writeSRAMByte_protected(prep_segment_adress + SEG_STEP_BLOCK_INDEX, prep.st_block_index); // prep_segment->st_block_index = prep.st_block_index; /*------------------------------------------------------------------------------------ Compute the average velocity of this new segment by determining the total distance traveled over the segment time DT_SEGMENT. The following code first attempts to create a full segment based on the current ramp conditions. If the segment time is incomplete when terminating at a ramp state change, the code will continue to loop through the progressing ramp states to fill the remaining segment execution time. However, if an incomplete segment terminates at the end of the velocity profile, the segment is considered completed despite having a truncated execution time less than DT_SEGMENT. The velocity profile is always assumed to progress through the ramp sequence: acceleration ramp, cruising state, and deceleration ramp. Each ramp's travel distance may range from zero to the length of the block. Velocity profiles can end either at the end of planner block (typical) or mid-block at the end of a forced deceleration, such as from a feed hold. */ float dt_max = DT_SEGMENT; // Maximum segment time float dt = 0.0; // Initialize segment time float time_var = dt_max; // Time worker variable float mm_var; // mm-Distance worker variable float speed_var; // Speed worker variable float mm_remaining = pl_block->millimeters; // New segment distance from end of block. float minimum_mm = mm_remaining-prep.req_mm_increment; // Guarantee at least one step. if (minimum_mm < 0.0) { minimum_mm = 0.0; } do { switch (prep.ramp_type) { case RAMP_DECEL_OVERRIDE: speed_var = pl_block->acceleration*time_var; if (prep.current_speed-prep.maximum_speed <= speed_var) { // Cruise or cruise-deceleration types only for deceleration override. mm_remaining = prep.accelerate_until; time_var = 2.0*(pl_block->millimeters-mm_remaining)/(prep.current_speed+prep.maximum_speed); prep.ramp_type = RAMP_CRUISE; prep.current_speed = prep.maximum_speed; } else { // Mid-deceleration override ramp. mm_remaining -= time_var*(prep.current_speed - 0.5*speed_var); prep.current_speed -= speed_var; } break; case RAMP_ACCEL: // NOTE: Acceleration ramp only computes during first do-while loop. speed_var = pl_block->acceleration*time_var; mm_remaining -= time_var*(prep.current_speed + 0.5*speed_var); if (mm_remaining < prep.accelerate_until) { // End of acceleration ramp. // Acceleration-cruise, acceleration-deceleration ramp junction, or end of block. mm_remaining = prep.accelerate_until; // NOTE: 0.0 at EOB time_var = 2.0*(pl_block->millimeters-mm_remaining)/(prep.current_speed+prep.maximum_speed); if (mm_remaining == prep.decelerate_after) { prep.ramp_type = RAMP_DECEL; } else { prep.ramp_type = RAMP_CRUISE; } prep.current_speed = prep.maximum_speed; } else { // Acceleration only. prep.current_speed += speed_var; } break; case RAMP_CRUISE: // NOTE: mm_var used to retain the last mm_remaining for incomplete segment time_var calculations. // NOTE: If maximum_speed*time_var value is too low, round-off can cause mm_var to not change. To // prevent this, simply enforce a minimum speed threshold in the planner. mm_var = mm_remaining - prep.maximum_speed*time_var; if (mm_var < prep.decelerate_after) { // End of cruise. // Cruise-deceleration junction or end of block. time_var = (mm_remaining - prep.decelerate_after)/prep.maximum_speed; mm_remaining = prep.decelerate_after; // NOTE: 0.0 at EOB prep.ramp_type = RAMP_DECEL; } else { // Cruising only. mm_remaining = mm_var; } break; default: // case RAMP_DECEL: // NOTE: mm_var used as a misc worker variable to prevent errors when near zero speed. speed_var = pl_block->acceleration*time_var; // Used as delta speed (mm/min) if (prep.current_speed > speed_var) { // Check if at or below zero speed. // Compute distance from end of segment to end of block. mm_var = mm_remaining - time_var*(prep.current_speed - 0.5*speed_var); // (mm) if (mm_var > prep.mm_complete) { // Typical case. In deceleration ramp. mm_remaining = mm_var; prep.current_speed -= speed_var; break; // Segment complete. Exit switch-case statement. Continue do-while loop. } } // Otherwise, at end of block or end of forced-deceleration. time_var = 2.0*(mm_remaining-prep.mm_complete)/(prep.current_speed+prep.exit_speed); mm_remaining = prep.mm_complete; prep.current_speed = prep.exit_speed; } dt += time_var; // Add computed ramp time to total segment time. if (dt < dt_max) { time_var = dt_max - dt; } // **Incomplete** At ramp junction. else { if (mm_remaining > minimum_mm) { // Check for very slow segments with zero steps. // Increase segment time to ensure at least one step in segment. Override and loop // through distance calculations until minimum_mm or mm_complete. dt_max += DT_SEGMENT; time_var = dt_max - dt; } else { break; // **Complete** Exit loop. Segment execution time maxed. } } } while (mm_remaining > prep.mm_complete); // **Complete** Exit loop. Profile complete. /* ----------------------------------------------------------------------------------- Compute spindle speed PWM output for step segment */ if (readSRAMByte_protected(st_prep_block_adress + ST_BLOCK_PWM_ADJUSTED) || (sys.step_control & STEP_CONTROL_UPDATE_SPINDLE_PWM)) { if (pl_block->condition & (PL_COND_FLAG_SPINDLE_CW | PL_COND_FLAG_SPINDLE_CCW)) { float rpm = pl_block->spindle_speed; // NOTE: Feed and rapid overrides are independent of PWM value and do not alter laser power/rate. if (readSRAMByte_protected(st_prep_block_adress + ST_BLOCK_PWM_ADJUSTED)) { rpm *= (prep.current_speed * prep.inv_rate); } // If current_speed is zero, then may need to be rpm_min*(100/MAX_SPINDLE_SPEED_OVERRIDE) // but this would be instantaneous only and during a motion. May not matter at all. prep.current_spindle_pwm = spindle_compute_pwm_value(rpm); } else { sys.spindle_speed = 0.0; prep.current_spindle_pwm = SPINDLE_PWM_OFF_VALUE; } bit_false(sys.step_control,STEP_CONTROL_UPDATE_SPINDLE_PWM); } writeSRAMWord_protected(prep_segment_adress + SEG_SPINDLE_PWM, prep.current_spindle_pwm); // Reload segment PWM value /* ----------------------------------------------------------------------------------- Compute segment step rate, steps to execute, and apply necessary rate corrections. NOTE: Steps are computed by direct scalar conversion of the millimeter distance remaining in the block, rather than incrementally tallying the steps executed per segment. This helps in removing floating point round-off issues of several additions. However, since floats have only 7.2 significant digits, long moves with extremely high step counts can exceed the precision of floats, which can lead to lost steps. Fortunately, this scenario is highly unlikely and unrealistic in CNC machines supported by Grbl (i.e. exceeding 10 meters axis travel at 200 step/mm). */ float step_dist_remaining = prep.step_per_mm*mm_remaining; // Convert mm_remaining to steps float n_steps_remaining = ceil(step_dist_remaining); // Round-up current steps remaining float last_n_steps_remaining = ceil(prep.steps_remaining); // Round-up last steps remaining writeSRAMWord_protected(prep_segment_adress + SEG_N_STEP, last_n_steps_remaining-n_steps_remaining); // Compute number of steps to execute. // Bail if we are at the end of a feed hold and don't have a step to execute. if (readSRAMWord_protected(prep_segment_adress + SEG_N_STEP) == 0) { if (sys.step_control & STEP_CONTROL_EXECUTE_HOLD) { // Less than one step to decelerate to zero speed, but already very close. AMASS // requires full steps to execute. So, just bail. bit_true(sys.step_control,STEP_CONTROL_END_MOTION); #ifdef PARKING_ENABLE if (!(prep.recalculate_flag & PREP_FLAG_PARKING)) { prep.recalculate_flag |= PREP_FLAG_HOLD_PARTIAL_BLOCK; } #endif return; // Segment not generated, but current step data still retained. } } // Compute segment step rate. Since steps are integers and mm distances traveled are not, // the end of every segment can have a partial step of varying magnitudes that are not // executed, because the stepper ISR requires whole steps due to the AMASS algorithm. To // compensate, we track the time to execute the previous segment's partial step and simply // apply it with the partial step distance to the current segment, so that it minutely // adjusts the whole segment rate to keep step output exact. These rate adjustments are // typically very small and do not adversely effect performance, but ensures that Grbl // outputs the exact acceleration and velocity profiles as computed by the planner. dt += prep.dt_remainder; // Apply previous segment partial step execute time float inv_rate = dt/(last_n_steps_remaining - step_dist_remaining); // Compute adjusted step rate inverse // Compute CPU cycles per step for the prepped segment. uint32_t cycles = ceil( (TICKS_PER_MICROSECOND*1000000*60)*inv_rate ); // (cycles/step) // Compute step timing and timer prescalar for normal step generation. if (cycles < (1UL << 16)) { // < 65536 (4.1ms @ 16MHz) writeSRAMByte_protected(prep_segment_adress + SEG_PRESCALER, 1); //prep_segment->prescaler = 1; // prescaler: 0 writeSRAMWord_protected(prep_segment_adress + SEG_CYCLES_PER_TICK, cycles); //prep_segment->cycles_per_tick = cycles; } else if (cycles < (1UL << 19)) { // < 524288 (32.8ms@16MHz) writeSRAMByte_protected(prep_segment_adress + SEG_PRESCALER, 2); //prep_segment->prescaler = 2; // prescaler: 8 writeSRAMWord_protected(prep_segment_adress + SEG_CYCLES_PER_TICK, cycles >> 3); //prep_segment->cycles_per_tick = cycles >> 3; } else { writeSRAMByte_protected(prep_segment_adress + SEG_PRESCALER, 3); //prep_segment->prescaler = 3; // prescaler: 64 if (cycles < (1UL << 22)) { // < 4194304 (262ms@16MHz) writeSRAMWord_protected(prep_segment_adress + SEG_CYCLES_PER_TICK, cycles >> 6); //prep_segment->cycles_per_tick = cycles >> 6; } else { // Just set the slowest speed possible. (Around 4 step/sec.) writeSRAMWord_protected(prep_segment_adress + SEG_CYCLES_PER_TICK, 0xFFFF); //prep_segment->cycles_per_tick = 0xffff; } } // Segment complete! Increment segment buffer indices, so stepper ISR can immediately execute it. segment_buffer_head = segment_next_head; writeSRAMByte_protected(SEGMENT_BUFFER_HEAD, segment_buffer_head); if ( ++segment_next_head == SEGMENT_BUFFER_SIZE ) { segment_next_head = 0; } // Update the appropriate planner and segment data. pl_block->millimeters = mm_remaining; prep.steps_remaining = n_steps_remaining; prep.dt_remainder = (n_steps_remaining - step_dist_remaining)*inv_rate; // Check for exit conditions and flag to load next planner block. if (mm_remaining == prep.mm_complete) { // End of planner block or forced-termination. No more distance to be executed. if (mm_remaining > 0.0) { // At end of forced-termination. // Reset prep parameters for resuming and then bail. Allow the stepper ISR to complete // the segment queue, where realtime protocol will set new state upon receiving the // cycle stop flag from the ISR. Prep_segment is blocked until then. bit_true(sys.step_control,STEP_CONTROL_END_MOTION); #ifdef PARKING_ENABLE if (!(prep.recalculate_flag & PREP_FLAG_PARKING)) { prep.recalculate_flag |= PREP_FLAG_HOLD_PARTIAL_BLOCK; } #endif return; // Bail! } else { // End of planner block // The planner block is complete. All steps are set to be executed in the segment buffer. if (sys.step_control & STEP_CONTROL_EXECUTE_SYS_MOTION) { bit_true(sys.step_control,STEP_CONTROL_END_MOTION); return; } pl_block = NULL; // Set pointer to indicate check and load next planner block. plan_discard_current_block(); } } } } // Called by realtime status reporting to fetch the current speed being executed. This value // however is not exactly the current speed, but the speed computed in the last step segment // in the segment buffer. It will always be behind by up to the number of segment blocks (-1) // divided by the ACCELERATION TICKS PER SECOND in seconds. float st_get_realtime_rate() { if (sys.state & (STATE_CYCLE | STATE_HOMING | STATE_HOLD | STATE_JOG | STATE_SAFETY_DOOR)){ return prep.current_speed; } return 0.0f; }