src/libs/StepTicker.cpp

   1 /*
   2       This file is part of Smoothie (http://smoothieware.org/). The motion control part is heavily based on Grbl (https://github.com/simen/grbl).
   3       Smoothie 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.
   4       Smoothie 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.
   5       You should have received a copy of the GNU General Public License along with Smoothie. If not, see <http://www.gnu.org/licenses/>.
   6 */
   7
   8
   9
  10 using namespace std;
  11 #include <vector>
  12 #include "libs/nuts_bolts.h"
  13 #include "libs/Module.h"
  14 #include "libs/Kernel.h"
  15 #include "StepTicker.h"
  16 #include "system_LPC17xx.h" // mbed.h lib
  17
  18 #include <mri.h>
  19
  20 // StepTicker handles the base frequency ticking for the Stepper Motors / Actuators
  21 // It has a list of those, and calls their tick() functions at regular intervals
  22 // They then do Bresenham stuff themselves
  23
  24 StepTicker* global_step_ticker;
  25
  26 StepTicker::StepTicker(){
  27     global_step_ticker = this;
  28     LPC_TIM0->MR0 = 10000000;        // Initial dummy value for Match Register
  29     LPC_TIM0->MCR = 3;              // Match on MR0, reset on MR0, match on MR1
  30     LPC_TIM0->TCR = 1;               // Enable interrupt
  31
  32     LPC_SC->PCONP |= (1 << 2);     // Power Ticker ON
  33     LPC_TIM1->MR0 = 1000000;
  34     LPC_TIM1->MCR = 1;
  35     LPC_TIM1->TCR = 1;               // Enable interrupt
  36
  37     // Default start values
  38     this->moves_finished = false;
  39     this->reset_step_pins = false;
  40     this->debug = 0;
  41     this->has_axes = 0;
  42     this->set_frequency(0.001);
  43     this->set_reset_delay(100);
  44     this->last_duration = 0;
  45     for (int i = 0; i < 12; i++)
  46         this->active_motors[i] = NULL;
  47     this->active_motor_bm = 0;
  48
  49     NVIC_EnableIRQ(TIMER0_IRQn);     // Enable interrupt handler
  50     NVIC_EnableIRQ(TIMER1_IRQn);     // Enable interrupt handler
  51 }
  52
  53 // Set the base stepping frequency
  54 void StepTicker::set_frequency( double frequency ){
  55     this->frequency = frequency;
  56     this->period = int(floor((SystemCoreClock/4)/frequency));  // SystemCoreClock/4 = Timer increments in a second
  57     LPC_TIM0->MR0 = this->period;
  58     if( LPC_TIM0->TC > LPC_TIM0->MR0 ){
  59         LPC_TIM0->TCR = 3;  // Reset
  60         LPC_TIM0->TCR = 1;  // Reset
  61     }
  62 }
  63
  64 // Set the reset delay
  65 void StepTicker::set_reset_delay( double seconds ){
  66     this->delay = int(floor(double(SystemCoreClock/4)*( seconds )));  // SystemCoreClock/4 = Timer increments in a second
  67     LPC_TIM1->MR0 = this->delay;
  68 }
  69
  70 // Add a stepper motor object to our list of steppers we must take care of
  71 StepperMotor* StepTicker::add_stepper_motor(StepperMotor* stepper_motor){
  72     this->stepper_motors.push_back(stepper_motor);
  73     stepper_motor->step_ticker = this;
  74     this->has_axes = true;
  75     return stepper_motor;
  76 }
  77
  78 // Call tick() on each active motor
  79 inline void StepTicker::tick(){
  80     int i;
  81     uint32_t bm;
  82     for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
  83     {
  84         if (this->active_motor_bm & bm)
  85         {
  86             this->active_motors[i]->tick();
  87         }
  88     }
  89 }
  90
  91 // Call signal_mode_finished() on each active motor that asked to be signaled. We do this instead of inside of tick() so that
  92 // all tick()s are called before we do the move finishing
  93 void StepTicker::signal_moves_finished(){
  94     int i;
  95     uint32_t bm;
  96     for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
  97     {
  98         if (this->active_motor_bm & bm)
  99         {
 100             if (this->active_motors[i]->is_move_finished)
 101             {
 102                 this->active_motors[i]->signal_move_finished();
 103                 if (this->active_motors[i]->moving == false)
 104                 {
 105                     if (i > 0)
 106                     {
 107                         i--;
 108                         bm >>= 1;
 109                     }
 110                 }
 111             }
 112         }
 113     }
 114     this->moves_finished = false;
 115 }
 116
 117 // Reset step pins on all active motors
 118 inline void StepTicker::reset_tick(){
 119     int i;
 120     uint32_t bm;
 121     for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
 122     {
 123         if (this->active_motor_bm & bm)
 124             this->active_motors[i]->step_pin->set(0);
 125     }
 126 }
 127
 128 extern "C" void TIMER1_IRQHandler (void){
 129     LPC_TIM1->IR |= 1 << 0;
 130     global_step_ticker->reset_tick();
 131 }
 132
 133
 134 //#pragma GCC push_options
 135 //#pragma GCC optimize ("O0")
 136
 137
 138 // The actual interrupt handler where we do all the work
 139 extern "C" void TIMER0_IRQHandler (void){
 140
 141     LPC_GPIO1->FIODIR |= 1<<18;
 142     LPC_GPIO1->FIOSET = 1<<18;
 143
 144 //     uint32_t initial_tc = LPC_TIM0->TC;
 145
 146     LPC_TIM0->IR |= 1 << 0;
 147
 148     // If no axes enabled, just ignore for now
 149     if( global_step_ticker->active_motor_bm == 0 ){
 150         LPC_GPIO1->FIOCLR = 1<<18;
 151         return;
 152     }
 153
 154     // Do not get out of here before everything is nice and tidy
 155     LPC_TIM0->MR0 = 2000000;
 156
 157     // Step pins
 158     global_step_ticker->tick();
 159
 160     // We may have set a pin on in this tick, now we start the timer to set it off
 161     if( global_step_ticker->reset_step_pins ){
 162         LPC_TIM1->TCR = 3;
 163         LPC_TIM1->TCR = 1;
 164         global_step_ticker->reset_step_pins = false;
 165     }
 166
 167     // If a move finished in this tick, we have to tell the actuator to act accordingly
 168     if( global_step_ticker->moves_finished ){ global_step_ticker->signal_moves_finished(); }
 169
 170 //     uint32_t after_signal = LPC_TIM0->TC;
 171
 172     // If we went over the duration an interrupt is supposed to last, we have a problem
 173     // That can happen tipically when we change blocks, where more than usual computation is done
 174     // This can be OK, if we take notice of it, which we do now
 175     if( LPC_TIM0->TC > global_step_ticker->period ){ // TODO: remove the size condition
 176
 177         LPC_GPIO1->FIODIR |= 1<<19;
 178         LPC_GPIO1->FIOSET = 1<<19;
 179
 180        uint32_t start_tc = LPC_TIM0->TC;
 181
 182         // How many ticks we want to skip ( this does not include the current tick, but we add the time we spent doing this computation last time )
 183         uint32_t ticks_to_skip = (  ( LPC_TIM0->TC + global_step_ticker->last_duration ) / global_step_ticker->period );
 184
 185         // Next step is now to reduce this to how many steps we can *actually* skip
 186         uint32_t ticks_we_actually_can_skip = ticks_to_skip;
 187
 188         int i;
 189         uint32_t bm;
 190         for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
 191         {
 192             if (global_step_ticker->active_motor_bm & bm)
 193                 ticks_we_actually_can_skip =
 194                     min(ticks_we_actually_can_skip,
 195                         (uint32_t)((uint64_t)( (uint64_t)global_step_ticker->active_motors[i]->fx_ticks_per_step - (uint64_t)global_step_ticker->active_motors[i]->fx_counter ) >> 32)
 196                         );
 197         }
 198
 199         // Adding to MR0 for this time is not enough, we must also increment the counters ourself artificially
 200         for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
 201         {
 202             if (global_step_ticker->active_motor_bm & bm)
 203                 global_step_ticker->active_motors[i]->fx_counter += (uint64_t)((uint64_t)(ticks_we_actually_can_skip)<<32);
 204         }
 205
 206         // When must we have our next MR0 ? ( +1 is here to account that we are actually doing a legit MR0 match here too, not only overtime )
 207         // LPC_TIM0->MR0 = ( ticks_we_actually_can_skip + 1 ) * global_step_ticker->period;
 208         LPC_TIM0->MR0 = ( ticks_to_skip + 1 ) * global_step_ticker->period;
 209
 210         // This is so that we know how long this computation takes, and we can take it into account next time
 211         int difference = (int)(LPC_TIM0->TC) - (int)(start_tc);
 212         if( difference > 0 ){ global_step_ticker->last_duration = (uint32_t)difference; }
 213
 214         //if( global_step_ticker->last_duration > 2000 || LPC_TIM0->MR0 > 2000 || LPC_TIM0->TC > 2000 || initial_tc > 2000 ){ __debugbreak(); }
 215
 216         LPC_GPIO1->FIOCLR = 1<<19;
 217
 218     }else{
 219         LPC_TIM0->MR0 = global_step_ticker->period;
 220     }
 221
 222     LPC_GPIO1->FIOCLR = 1<<18;
 223
 224     while( LPC_TIM0->TC > LPC_TIM0->MR0 ){
 225         LPC_TIM0->MR0 += global_step_ticker->period;
 226     }
 227
 228     LPC_GPIO1->FIOCLR = 1<<18;
 229 }
 230
 231
 232 //#pragma GCC pop_options
 233
 234 // We make a list of steppers that want to be called so that we don't call them for nothing
 235 void StepTicker::add_motor_to_active_list(StepperMotor* motor)
 236 {
 237     uint32_t bm;
 238     int i;
 239     for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
 240     {
 241         if (this->active_motors[i] == motor)
 242         {
 243             this->active_motor_bm |= bm;
 244             return;
 245         }
 246         if (this->active_motors[i] == NULL)
 247         {
 248             this->active_motors[i] = motor;
 249             this->active_motor_bm |= bm;
 250             return;
 251         }
 252     }
 253     return;
 254 }
 255
 256 // Remove a stepper from the list of active motors
 257 void StepTicker::remove_motor_from_active_list(StepperMotor* motor)
 258 {
 259     uint32_t bm; int i;
 260     for (i = 0, bm = 1; i < 12; i++, bm <<= 1)
 261     {
 262         if (this->active_motors[i] == motor)
 263         {
 264             this->active_motor_bm &= ~bm;
 265             return;
 266         }
 267     }
 268 }