bldc/encoder/encoder.c

/*
	Copyright 2016 - 2022 Benjamin Vedder	benjamin@vedder.se
	Copyright 2022 Jakub Tomczak

	This file is part of the VESC firmware.

	The VESC firmware 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.

    The VESC firmware 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/>.
 */

#include "encoder.h"
#include "encoder_datatype.h"
#include "encoder_cfg.h"

#include "utils_math.h"
#include "commands.h"
#include "mcpwm_foc.h"
#include "mc_interface.h"
#include "mempools.h"
#include "terminal.h"
#include "app.h"

#include <math.h>

static encoder_type_t encoder_type_now = ENCODER_TYPE_NONE;

// Private functions
static void terminal_encoder(int argc, const char **argv);
static void terminal_encoder_clear_errors(int argc, const char **argv);
static void terminal_encoder_clear_multiturn(int argc, const char **argv);
static void timer_start(float rate);

bool encoder_init(volatile mc_configuration *conf) {
	bool res = false;

	if (encoder_type_now != ENCODER_TYPE_NONE) {
		encoder_deinit();
	}

	nvicDisableVector(HW_ENC_EXTI_CH);
	nvicDisableVector(HW_ENC_TIM_ISR_CH);
	TIM_DeInit(HW_ENC_TIM);

	switch (conf->m_sensor_port_mode) {
	case SENSOR_PORT_MODE_ABI: {
		SENSOR_PORT_5V();

		encoder_cfg_ABI.counts = conf->m_encoder_counts;

		if (!enc_abi_init(&encoder_cfg_ABI)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_ABI;
		res = true;
	} break;

	case SENSOR_PORT_MODE_AS5047_SPI: {
		SENSOR_PORT_3V3();

		if (!enc_as504x_init(&encoder_cfg_as504x)) {
			return false;
		}

		encoder_type_now = ENCODER_TYPE_AS504x;
		timer_start(10000);

		res = true;
	} break;

	case SENSOR_PORT_MODE_MT6816_SPI: {
		SENSOR_PORT_5V();

		if (!enc_mt6816_init(&encoder_cfg_mt6816)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_MT6816;
		timer_start(10000);

		res = true;
	} break;

	case SENSOR_PORT_MODE_AD2S1205: {
		SENSOR_PORT_5V();

		if (!enc_ad2s1205_init(&encoder_cfg_ad2s1205)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_AD2S1205_SPI;
		timer_start(10000);

		res = true;
	} break;

	case SENSOR_PORT_MODE_SINCOS: {
		SENSOR_PORT_5V();

		encoder_cfg_sincos.s_gain = conf->foc_encoder_sin_gain;
		encoder_cfg_sincos.s_offset = conf->foc_encoder_sin_offset;
		encoder_cfg_sincos.c_gain = conf->foc_encoder_cos_gain;
		encoder_cfg_sincos.c_offset =  conf->foc_encoder_cos_offset;
		encoder_cfg_sincos.filter_constant = conf->foc_encoder_sincos_filter_constant;

		if (!enc_sincos_init(&encoder_cfg_sincos)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_SINCOS;
		res = true;
	} break;

	case SENSOR_PORT_MODE_TS5700N8501:
	case SENSOR_PORT_MODE_TS5700N8501_MULTITURN: {
		SENSOR_PORT_5V();
		app_configuration *appconf = mempools_alloc_appconf();
		conf_general_read_app_configuration(appconf);
		if (appconf->app_to_use == APP_ADC ||
				appconf->app_to_use == APP_UART ||
				appconf->app_to_use == APP_PPM_UART ||
				appconf->app_to_use == APP_ADC_UART) {
			appconf->app_to_use = APP_NONE;
			app_set_configuration(appconf);
			conf_general_store_app_configuration(appconf);
		}
		mempools_free_appconf(appconf);

		if (!enc_ts5700n8501_init(&encoder_cfg_TS5700N8501)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_TS5700N8501;
		res = true;
	} break;

	case SENSOR_PORT_MODE_AS5x47U_SPI: {
		SENSOR_PORT_3V3();

		if (!enc_as5x47u_init(&encoder_cfg_as5x47u)) {
			return false;
		}

		encoder_type_now = ENCODER_TYPE_AS5x47U;
		timer_start(10000);

		res = true;
	} break;

	case SENSOR_PORT_MODE_BISSC: {
		SENSOR_PORT_5V();

		encoder_cfg_bissc.enc_res = conf->m_encoder_counts;

		if (!enc_bissc_init(&encoder_cfg_bissc)) {
			encoder_type_now = ENCODER_TYPE_NONE;
			return false;
		}

		encoder_type_now = ENCODER_TYPE_BISSC;
		timer_start(10000);

		res = true;
	} break;

	default:
		SENSOR_PORT_5V();
		encoder_type_now = ENCODER_TYPE_NONE;
		break;
	}

	terminal_register_command_callback(
			"encoder",
			"Prints the status of the AS5047, AS5x47U, AD2S1205, or TS5700N8501 encoder.",
			0,
			terminal_encoder);

	terminal_register_command_callback(
			"encoder_clear_errors",
			"Clear error of the TS5700N8501 encoder.",
			0,
			terminal_encoder_clear_errors);

	terminal_register_command_callback(
			"encoder_clear_multiturn",
			"Clear multiturn counter of the TS5700N8501 encoder.",
			0,
			terminal_encoder_clear_multiturn);

	return res;
}

void encoder_deinit(void) {
	nvicDisableVector(HW_ENC_EXTI_CH);
	nvicDisableVector(HW_ENC_TIM_ISR_CH);
	TIM_DeInit(HW_ENC_TIM);

	if (encoder_type_now == ENCODER_TYPE_AS504x) {
		enc_as504x_deinit(&encoder_cfg_as504x);
	} else if (encoder_type_now == ENCODER_TYPE_MT6816) {
		enc_mt6816_deinit(&encoder_cfg_mt6816);
	} else if (encoder_type_now == ENCODER_TYPE_AD2S1205_SPI) {
		enc_ad2s1205_deinit(&encoder_cfg_ad2s1205);
	} else if (encoder_type_now == ENCODER_TYPE_ABI) {
		enc_abi_deinit(&encoder_cfg_ABI);
	} else if (encoder_type_now == ENCODER_TYPE_SINCOS) {
		enc_sincos_deinit(&encoder_cfg_sincos);
	} else if (encoder_type_now == ENCODER_TYPE_TS5700N8501) {
		enc_ts5700n8501_deinit(&encoder_cfg_TS5700N8501);
	} else if (encoder_type_now == ENCODER_TYPE_AS5x47U) {
		enc_as5x47u_deinit(&encoder_cfg_as5x47u);
	} else if (encoder_type_now == ENCODER_TYPE_BISSC) {
		enc_bissc_deinit(&encoder_cfg_bissc);
	}

	encoder_type_now = ENCODER_TYPE_NONE;
}

float encoder_read_deg(void) {
	if (encoder_type_now == ENCODER_TYPE_AS504x) {
		return AS504x_LAST_ANGLE(&encoder_cfg_as504x);
	} else if (encoder_type_now == ENCODER_TYPE_MT6816) {
		return MT6816_LAST_ANGLE(&encoder_cfg_mt6816);
	} else if (encoder_type_now == ENCODER_TYPE_AD2S1205_SPI) {
		return AD2S1205_LAST_ANGLE(&encoder_cfg_ad2s1205);
	} else if (encoder_type_now == ENCODER_TYPE_ABI) {
		return enc_abi_read_deg(&encoder_cfg_ABI);
	} else if (encoder_type_now == ENCODER_TYPE_SINCOS) {
		return enc_sincos_read_deg(&encoder_cfg_sincos);
	} else if (encoder_type_now == ENCODER_TYPE_TS5700N8501) {
		return enc_ts5700n8501_read_deg(&encoder_cfg_TS5700N8501);
	} else if (encoder_type_now == ENCODER_TYPE_AS5x47U) {
		return AS5x47U_LAST_ANGLE(&encoder_cfg_as5x47u);
	} else if (encoder_type_now == ENCODER_TYPE_BISSC) {
		return BISSC_LAST_ANGLE(&encoder_cfg_bissc);
	}
	return 0.0;
}

float encoder_read_deg_multiturn(void) {
	if (encoder_type_now == ENCODER_TYPE_TS5700N8501) {
		float ts_mt = (float)enc_ts5700n8501_get_abm(&encoder_cfg_TS5700N8501);
		if (fabsf(ts_mt) > 5000.0) {
			ts_mt = 0;
			encoder_reset_multiturn();
		}

		ts_mt += 5000;

		return encoder_read_deg() / 10000.0 + (360 * ts_mt) / 10000.0;
	} else {
		return encoder_read_deg();
	}
}

encoder_type_t encoder_is_configured(void) {
	return encoder_type_now;
}

bool encoder_index_found(void) {
	if (encoder_type_now == ENCODER_TYPE_ABI) {
		return encoder_cfg_ABI.state.index_found;
	} else {
		return true;
	}
}

void encoder_reset_multiturn(void) {
	if (encoder_type_now == ENCODER_TYPE_TS5700N8501) {
		return enc_ts5700n8501_reset_multiturn(&encoder_cfg_TS5700N8501);
	}
}

void encoder_reset_errors(void) {
	if (encoder_type_now == ENCODER_TYPE_TS5700N8501) {
		enc_ts5700n8501_reset_errors(&encoder_cfg_TS5700N8501);
	}
}

// Check for encoder faults that should stop the motor with a fault code.
void encoder_check_faults(volatile mc_configuration *m_conf, bool is_second_motor) {

	// Only generate fault code when the encoder is being used. Note that encoder faults
	// that occur above the sensorless ERPM won't stop the motor.
	bool is_foc_encoder = m_conf->motor_type == MOTOR_TYPE_FOC &&
			m_conf->foc_sensor_mode == FOC_SENSOR_MODE_ENCODER &&
			mcpwm_foc_is_using_encoder();

	if (is_foc_encoder) {
		switch (m_conf->m_sensor_port_mode) {
		case SENSOR_PORT_MODE_AS5047_SPI:
			if (encoder_cfg_as504x.state.spi_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SPI, is_second_motor, false);
			}

			if (encoder_cfg_as504x.sw_spi.mosi_gpio != NULL) {
				AS504x_diag diag = encoder_cfg_as504x.state.sensor_diag;
				if (!diag.is_connected) {
					mc_interface_fault_stop(FAULT_CODE_ENCODER_SPI, is_second_motor, false);
				}

				if (diag.is_Comp_high) {
					mc_interface_fault_stop(FAULT_CODE_ENCODER_NO_MAGNET, is_second_motor, false);
				} else if(diag.is_Comp_low) {
					mc_interface_fault_stop(FAULT_CODE_ENCODER_MAGNET_TOO_STRONG, is_second_motor, false);
				}
			}
			break;

		case SENSOR_PORT_MODE_MT6816_SPI:
			if (encoder_cfg_mt6816.state.encoder_no_magnet_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_NO_MAGNET, is_second_motor, false);
			}
			break;

		case SENSOR_PORT_MODE_SINCOS:
			if (encoder_cfg_sincos.state.signal_low_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SINCOS_BELOW_MIN_AMPLITUDE, is_second_motor, false);
			}
			if (encoder_cfg_sincos.state.signal_above_max_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SINCOS_ABOVE_MAX_AMPLITUDE, is_second_motor, false);
			}
			break;

		case SENSOR_PORT_MODE_AD2S1205:
			if (encoder_cfg_ad2s1205.state.resolver_loss_of_tracking_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_RESOLVER_LOT, is_second_motor, false);
			}
			if (encoder_cfg_ad2s1205.state.resolver_degradation_of_signal_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_RESOLVER_DOS, is_second_motor, false);
			}
			if (encoder_cfg_ad2s1205.state.resolver_loss_of_signal_error_rate > 0.04) {
				mc_interface_fault_stop(FAULT_CODE_RESOLVER_LOS, is_second_motor, false);
			}
			break;

		case SENSOR_PORT_MODE_AS5x47U_SPI:
			if (encoder_cfg_as5x47u.state.spi_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SPI, is_second_motor, false);
			}

			AS5x47U_diag diag = encoder_cfg_as5x47u.state.sensor_diag;
			if (!diag.is_connected) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SPI, is_second_motor, false);
			}

			if (diag.is_Comp_high) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_NO_MAGNET, is_second_motor, false);
			} else if (diag.is_Comp_low) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_MAGNET_TOO_STRONG, is_second_motor, false);
			} else if (diag.is_broken_hall || diag.is_COF || diag.is_wdtst) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_FAULT, is_second_motor, false);
			}

			break;

		case SENSOR_PORT_MODE_BISSC:
			if (encoder_cfg_bissc.state.spi_comm_error_rate > 0.04) {
				mc_interface_fault_stop(FAULT_CODE_ENCODER_SPI, is_second_motor, false);
			}
			if (encoder_cfg_bissc.state.spi_data_error_rate > 0.05) {
				mc_interface_fault_stop(FAULT_CODE_RESOLVER_LOT, is_second_motor, false);
			}
			break;

		default:
			break;
		}
	}
}

void encoder_pin_isr(void) {
	enc_abi_pin_isr(&encoder_cfg_ABI);
}

void encoder_tim_isr(void) {
	switch (encoder_type_now) {
		case ENCODER_TYPE_AS504x:
			enc_as504x_routine(&encoder_cfg_as504x);
			break;

		case ENCODER_TYPE_MT6816:
			enc_mt6816_routine(&encoder_cfg_mt6816);
			break;

		case ENCODER_TYPE_AD2S1205_SPI:
			enc_ad2s1205_routine(&encoder_cfg_ad2s1205);
			break;

		case ENCODER_TYPE_AS5x47U:
			enc_as5x47u_routine(&encoder_cfg_as5x47u);
			break;

		case ENCODER_TYPE_BISSC:
			enc_bissc_routine(&encoder_cfg_bissc);

		default:
			break;
	}
}

static void terminal_encoder(int argc, const char **argv) {
	(void)argc; (void)argv;

	const volatile mc_configuration *mcconf = mc_interface_get_configuration();

	switch (mcconf->m_sensor_port_mode) {
	case SENSOR_PORT_MODE_AS5047_SPI:
		commands_printf("SPI encoder value: %d, errors: %d, error rate: %.3f %%",
				encoder_cfg_as504x.state.spi_val, encoder_cfg_as504x.state.spi_communication_error_count,
				(double)(encoder_cfg_as504x.state.spi_error_rate * 100.0));

		if (encoder_cfg_as504x.sw_spi.mosi_gpio != NULL) {
			commands_printf("\nAS5047 DIAGNOSTICS:\n"
					"Connected : %u\n"
					"AGC       : %u\n"
					"Magnitude : %u\n"
					"COF       : %u\n"
					"OCF       : %u\n"
					"COMP_low  : %u\n"
					"COMP_high : %u",
					encoder_cfg_as504x.state.sensor_diag.is_connected,
					encoder_cfg_as504x.state.sensor_diag.AGC_value,
					encoder_cfg_as504x.state.sensor_diag.magnitude,
					encoder_cfg_as504x.state.sensor_diag.is_COF,
					encoder_cfg_as504x.state.sensor_diag.is_OCF,
					encoder_cfg_as504x.state.sensor_diag.is_Comp_low,
					encoder_cfg_as504x.state.sensor_diag.is_Comp_high);
		}
		break;

	case SENSOR_PORT_MODE_MT6816_SPI:
		commands_printf("Low flux error (no magnet): errors: %d, error rate: %.3f %%",
				encoder_cfg_mt6816.state.encoder_no_magnet_error_cnt,
				(double)(encoder_cfg_mt6816.state.encoder_no_magnet_error_rate * 100.0));
		break;

	case SENSOR_PORT_MODE_TS5700N8501:
	case SENSOR_PORT_MODE_TS5700N8501_MULTITURN: {
		char sf[9];
		char almc[9];
		utils_byte_to_binary(enc_ts5700n8501_get_raw_status(&encoder_cfg_TS5700N8501)[0], sf);
		utils_byte_to_binary(enc_ts5700n8501_get_raw_status(&encoder_cfg_TS5700N8501)[7], almc);
		commands_printf("TS5700N8501 ABM: %d, SF: %s, ALMC: %s", enc_ts5700n8501_get_abm(&encoder_cfg_TS5700N8501), sf, almc);
	} break;

	case SENSOR_PORT_MODE_SINCOS:
		commands_printf("Sin/Cos encoder signal below minimum amplitude: errors: %d, error rate: %.3f %%",
				encoder_cfg_sincos.state.signal_below_min_error_cnt,
				(double)(encoder_cfg_sincos.state.signal_low_error_rate * 100.0));

		commands_printf("Sin/Cos encoder signal above maximum amplitude: errors: %d, error rate: %.3f %%",
				encoder_cfg_sincos.state.signal_above_max_error_cnt,
				(double)(encoder_cfg_sincos.state.signal_above_max_error_rate * 100.0));
		break;

	case SENSOR_PORT_MODE_AD2S1205:
		commands_printf("Resolver Loss Of Tracking (>5%c error): errors: %d, error rate: %.3f %%", 0xB0,
				encoder_cfg_ad2s1205.state.resolver_loss_of_signal_error_cnt,
				(double)(encoder_cfg_ad2s1205.state.resolver_loss_of_signal_error_rate * 100.0));
		commands_printf("Resolver Degradation Of Signal (>33%c error): errors: %d, error rate: %.3f %%", 0xB0,
				encoder_cfg_ad2s1205.state.resolver_degradation_of_signal_error_cnt,
				(double)(encoder_cfg_ad2s1205.state.resolver_degradation_of_signal_error_rate * 100.0));
		commands_printf("Resolver Loss Of Signal (>57%c error): errors: %d, error rate: %.3f %%", 0xB0,
				encoder_cfg_ad2s1205.state.resolver_loss_of_signal_error_cnt,
				(double)(encoder_cfg_ad2s1205.state.resolver_loss_of_signal_error_rate * 100.0));
		break;

	case SENSOR_PORT_MODE_ABI:
		commands_printf("Index found: %d", encoder_index_found());
		break;

	case SENSOR_PORT_MODE_AS5x47U_SPI:
		commands_printf("SPI AS5x47U encoder value: %d, errors: %d, error rate: %.3f %%",
				encoder_cfg_as5x47u.state.spi_val, encoder_cfg_as5x47u.state.spi_communication_error_count,
				(double)(encoder_cfg_as5x47u.state.spi_error_rate * 100.0));

		commands_printf("\nAS5x47U DIAGNOSTICS:\n"
				"Connected   : %u\n"
				"AGC         : %u\n"
				"Magnitude   : %u\n"
				"COF         : %u\n"
				"Hall_Broken : %u\n"
				"Error       : %u\n"
				"COMP_low    : %u\n"
				"COMP_high   : %u\n"
				"WatchdogTest: %u\n"
				"CRC Error   : %u\n"
				"MagHalf     : %u\n"
				"Error Flags : %04X\n"
				"Diag Flags  : %04X\n",
				encoder_cfg_as5x47u.state.sensor_diag.is_connected,
				encoder_cfg_as5x47u.state.sensor_diag.AGC_value,
				encoder_cfg_as5x47u.state.sensor_diag.magnitude,
				encoder_cfg_as5x47u.state.sensor_diag.is_COF,
				encoder_cfg_as5x47u.state.sensor_diag.is_broken_hall,
				encoder_cfg_as5x47u.state.sensor_diag.is_error,
				encoder_cfg_as5x47u.state.sensor_diag.is_Comp_low,
				encoder_cfg_as5x47u.state.sensor_diag.is_Comp_high,
				encoder_cfg_as5x47u.state.sensor_diag.is_wdtst,
				encoder_cfg_as5x47u.state.sensor_diag.is_crc_error,
				encoder_cfg_as5x47u.state.sensor_diag.is_mag_half,
				encoder_cfg_as5x47u.state.sensor_diag.serial_error_flgs,
				encoder_cfg_as5x47u.state.sensor_diag.serial_diag_flgs);
		break;

	case SENSOR_PORT_MODE_BISSC:
		commands_printf("BissC Loss SPI communication (>4%c error): errors: %d, error rate: %.3f %%", 0xB0,
				encoder_cfg_bissc.state.spi_comm_error_cnt,
				(double)(encoder_cfg_bissc.state.spi_comm_error_rate * 100.0));
		commands_printf("BissC Degradation Of Signal (>5%c error): errors: %d, error rate: %.3f %%", 0xB0,
				encoder_cfg_bissc.state.spi_data_error_cnt,
				(double)(encoder_cfg_bissc.state.spi_data_error_rate * 100.0));
		break;

	default:
		commands_printf("No encoder debug info available.");
		break;
	}

	commands_printf(" ");
}

static void terminal_encoder_clear_errors(int argc, const char **argv) {
	(void)argc; (void)argv;
	encoder_reset_errors();
	commands_printf("Done!\n");
}

static void terminal_encoder_clear_multiturn(int argc, const char **argv) {
	(void)argc; (void)argv;
	encoder_reset_multiturn();
	commands_printf("Done!\n");
}

static void timer_start(float rate) {
	TIM_TimeBaseInitTypeDef TIM_TimeBaseStructure;

	// Enable timer clock
	HW_ENC_TIM_CLK_EN();

	// Time Base configuration
	TIM_TimeBaseStructure.TIM_Prescaler = 0;
	TIM_TimeBaseStructure.TIM_CounterMode = TIM_CounterMode_Up;
	TIM_TimeBaseStructure.TIM_Period = ((168000000 / 2 / rate) - 1);
	TIM_TimeBaseStructure.TIM_ClockDivision = 0;
	TIM_TimeBaseStructure.TIM_RepetitionCounter = 0;
	TIM_TimeBaseInit(HW_ENC_TIM, &TIM_TimeBaseStructure);

	// Enable overflow interrupt
	TIM_ITConfig(HW_ENC_TIM, TIM_IT_Update, ENABLE);

	// Enable timer
	TIM_Cmd(HW_ENC_TIM, ENABLE);

	nvicEnableVector(HW_ENC_TIM_ISR_CH, 6);
}