126 lines
5.0 KiB
C
126 lines
5.0 KiB
C
/**
|
|
* Marlin 3D Printer Firmware
|
|
*
|
|
* Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
|
* Copyright (c) 2016 Bob Cousins bobcousins42@googlemail.com
|
|
* Copyright (c) 2017 Victor Perez
|
|
*
|
|
* This program 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.
|
|
*
|
|
* This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
|
|
*
|
|
*/
|
|
#pragma once
|
|
|
|
#include <stdint.h>
|
|
#include "../../inc/MarlinConfig.h"
|
|
|
|
// ------------------------
|
|
// Defines
|
|
// ------------------------
|
|
|
|
#define FORCE_INLINE __attribute__((always_inline)) inline
|
|
|
|
// STM32 timers may be 16 or 32 bit. Limiting HAL_TIMER_TYPE_MAX to 16 bits
|
|
// avoids issues with STM32F0 MCUs, which seem to pause timers if UINT32_MAX
|
|
// is written to the register. STM32F4 timers do not manifest this issue,
|
|
// even when writing to 16 bit timers.
|
|
//
|
|
// The range of the timer can be queried at runtime using IS_TIM_32B_COUNTER_INSTANCE.
|
|
// This is a more expensive check than a simple compile-time constant, so its
|
|
// implementation is deferred until the desire for a 32-bit range outweighs the cost
|
|
// of adding a run-time check and HAL_TIMER_TYPE_MAX is refactored to allow unique
|
|
// values for each timer.
|
|
#define hal_timer_t uint32_t
|
|
#define HAL_TIMER_TYPE_MAX UINT16_MAX
|
|
|
|
#ifndef STEP_TIMER_NUM
|
|
#define STEP_TIMER_NUM 0 // Timer Index for Stepper
|
|
#endif
|
|
#ifndef PULSE_TIMER_NUM
|
|
#define PULSE_TIMER_NUM STEP_TIMER_NUM
|
|
#endif
|
|
#ifndef TEMP_TIMER_NUM
|
|
#define TEMP_TIMER_NUM 1 // Timer Index for Temperature
|
|
#endif
|
|
|
|
#define TEMP_TIMER_FREQUENCY 1000 // Temperature::isr() is expected to be called at around 1kHz
|
|
|
|
// TODO: get rid of manual rate/prescale/ticks/cycles taken for procedures in stepper.cpp
|
|
#define STEPPER_TIMER_RATE 2000000 // 2 Mhz
|
|
extern uint32_t GetStepperTimerClkFreq();
|
|
#define STEPPER_TIMER_PRESCALE (GetStepperTimerClkFreq() / (STEPPER_TIMER_RATE))
|
|
#define STEPPER_TIMER_TICKS_PER_US ((STEPPER_TIMER_RATE) / 1000000) // stepper timer ticks per µs
|
|
|
|
#define PULSE_TIMER_RATE STEPPER_TIMER_RATE
|
|
#define PULSE_TIMER_PRESCALE STEPPER_TIMER_PRESCALE
|
|
#define PULSE_TIMER_TICKS_PER_US STEPPER_TIMER_TICKS_PER_US
|
|
|
|
#define ENABLE_STEPPER_DRIVER_INTERRUPT() HAL_timer_enable_interrupt(STEP_TIMER_NUM)
|
|
#define DISABLE_STEPPER_DRIVER_INTERRUPT() HAL_timer_disable_interrupt(STEP_TIMER_NUM)
|
|
#define STEPPER_ISR_ENABLED() HAL_timer_interrupt_enabled(STEP_TIMER_NUM)
|
|
|
|
#define ENABLE_TEMPERATURE_INTERRUPT() HAL_timer_enable_interrupt(TEMP_TIMER_NUM)
|
|
#define DISABLE_TEMPERATURE_INTERRUPT() HAL_timer_disable_interrupt(TEMP_TIMER_NUM)
|
|
|
|
extern void Step_Handler();
|
|
extern void Temp_Handler();
|
|
|
|
#ifndef HAL_STEP_TIMER_ISR
|
|
#define HAL_STEP_TIMER_ISR() void Step_Handler()
|
|
#endif
|
|
#ifndef HAL_TEMP_TIMER_ISR
|
|
#define HAL_TEMP_TIMER_ISR() void Temp_Handler()
|
|
#endif
|
|
|
|
// ------------------------
|
|
// Public Variables
|
|
// ------------------------
|
|
|
|
extern HardwareTimer *timer_instance[];
|
|
|
|
// ------------------------
|
|
// Public functions
|
|
// ------------------------
|
|
|
|
void HAL_timer_start(const uint8_t timer_num, const uint32_t frequency);
|
|
void HAL_timer_enable_interrupt(const uint8_t timer_num);
|
|
void HAL_timer_disable_interrupt(const uint8_t timer_num);
|
|
bool HAL_timer_interrupt_enabled(const uint8_t timer_num);
|
|
|
|
// Configure timer priorities for peripherals such as Software Serial or Servos.
|
|
// Exposed here to allow all timer priority information to reside in timers.cpp
|
|
void SetTimerInterruptPriorities();
|
|
|
|
// FORCE_INLINE because these are used in performance-critical situations
|
|
FORCE_INLINE bool HAL_timer_initialized(const uint8_t timer_num) {
|
|
return timer_instance[timer_num] != NULL;
|
|
}
|
|
FORCE_INLINE static hal_timer_t HAL_timer_get_count(const uint8_t timer_num) {
|
|
return HAL_timer_initialized(timer_num) ? timer_instance[timer_num]->getCount() : 0;
|
|
}
|
|
|
|
// NOTE: Method name may be misleading.
|
|
// STM32 has an Auto-Reload Register (ARR) as opposed to a "compare" register
|
|
FORCE_INLINE static void HAL_timer_set_compare(const uint8_t timer_num, const hal_timer_t overflow) {
|
|
if (HAL_timer_initialized(timer_num)) {
|
|
timer_instance[timer_num]->setOverflow(overflow + 1, TICK_FORMAT); // Value decremented by setOverflow()
|
|
// wiki: "force all registers (Autoreload, prescaler, compare) to be taken into account"
|
|
// So, if the new overflow value is less than the count it will trigger a rollover interrupt.
|
|
if (overflow < timer_instance[timer_num]->getCount()) // Added 'if' here because reports say it won't boot without it
|
|
timer_instance[timer_num]->refresh();
|
|
}
|
|
}
|
|
|
|
#define HAL_timer_isr_prologue(TIMER_NUM)
|
|
#define HAL_timer_isr_epilogue(TIMER_NUM)
|