Tinymovr

//  * This file is part of the Tinymovr-Firmware distribution
//  * (https://github.com/yconst/tinymovr-firmware).
//  * Copyright (c) 2020-2023 Ioannis Chatzikonstantinou.
//  * 
//  * 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, version 3.
//  *
//  * 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 <http://www.gnu.org/licenses/>.

#pragma once

/// TINYMOVR CONFIGURATION OPTIONS ///

#define ACLK_FREQ_HZ                (300000000)
#define HCLK_FREQ_HZ                (150000000)
#define CLKREF_FREQ_HZ              (4000000)
#define FRCLK_FREQ_HZ               CLKREF_FREQ_HZ

// Timer clock divider
#define TXCTL_PS_DIV                TXCTL_PS_DIV2

// PWM and Systick frequency
#define PWM_FREQ_HZ              (20000)
#define SYSTICK_FREQ_HZ          (1000)

// Control parameters
#define PWM_LIMIT                   (0.8f)
#define I_INTEGRATOR_DECAY_FACTOR   (0.995f)
#define I_TRIP_MARGIN               (1.5f)
#define VBUS_LOW_THRESHOLD          (10.4f)   // V
#define VEL_HARD_LIMIT              (600000.0f)  // ticks/s
#define I_HARD_LIMIT                (60.0f)    // A
#define MAX_CL_INIT_STEPS           (200)
#define PRE_CL_I_SD_MAX            (0.4f)

// Encoder rectification lookup table size
#define ECN_BITS (6)
#define ECN_SIZE (1 << ECN_BITS)

// UART
#define UART_ENUM UARTB
#define UART_REF PAC55XX_UARTB
#define UART_BAUD_RATE (115200)

#define UART_I_SCALING_FACTOR ( 1000.0f )
#define ONE_OVER_UART_I_SCALING_FACTOR ( 0.001f )

#define UART_R_SCALING_FACTOR ( 1000.0f )
#define ONE_OVER_UART_R_SCALING_FACTOR ( 0.001f )

#define UART_L_SCALING_FACTOR ( 1000.0f )
#define ONE_OVER_UART_L_SCALING_FACTOR ( 0.001f )

#define UART_VEL_GAIN_SCALING_FACTOR ( 1000000.0f )
#define ONE_OVER_UART_VEL_GAIN_SCALING_FACTOR ( 0.000001f )

#define UART_VEL_INT_SCALING_FACTOR ( 1000.0f )
#define ONE_OVER_UART_VEL_INT_SCALING_FACTOR ( 0.001f )

#define UART_IQ_LIMIT_SCALING_FACTOR ( 1000.f )
#define ONE_OVER_UART_IQ_LIMIT_SCALING_FACTOR ( 0.001f )

#define UART_V_SCALING_FACTOR ( 1000.0f )