Refactor Motor PWM init and ADC init; Added doxygen documentation for some functions; Changed some settings in Doxyfile

This commit is contained in:
gk6394s committed 2024-01-02 16:10:00 +01:00
1 parent 8fb10e212e
commit e0c0424f87
6 files changed
+100 -46

No files matched your search

+66 -7
View File
@@ -1,9 +1,9 @@
//////////////////////////
// RP2040-Decoder //
// Gabriel Koppenstein //
// core0.h //
//////////////////////////
/*!
*
* \file core0.h
* Used exclusively by core0
*
*/
#pragma once
#include "shared.h"
#include "CV.h"
@@ -37,6 +37,23 @@ void regular_cv_write(uint16_t cv_index, uint8_t cv_data);
#define ProgramInstrWriteByte 0b11
#define ProgramCmd(instr, adrmsbits) ((instr<<2) | (adrmsbits))
/*!
* \brief CV Programming mode function
* Used on entering programming mode in order to write CV values to persistent flash memory or verify/read bits/bytes from flash. <br>
* Refers to NMRA Standard 9.2.3 ("Service Mode Programming") or RCN-216<br>
*
* Procedure:
* 1. Checks for valid programming command
* 2. Disables core1 timers
* 3. Resets core1
* 4. Saves interrupts
* 5. Evaluates the type of programming instruction Write byte / Verify byte / Verify bit and runs corresponding function
* 6. Restores interrupts
* 7. Launch core1
*
* \param number_of_bytes Number of bytes in byte_array[]
* \param byte_array Pointer to byte_array[]
*/
void program_mode(uint8_t number_of_bytes, const uint8_t byte_array[]);
void set_outputs(uint32_t functions_to_set_bitmask);
void update_active_functions(uint32_t new_function_bitmask, uint8_t clr_bit_ind, bool direction_change);
@@ -50,8 +67,50 @@ void bits_to_byte_array(int8_t number_of_bytes,uint8_t byte_array[]);
void evaluate_message();
void track_signal_rise(unsigned int gpio, long unsigned int events);
void track_signal_fall(unsigned int gpio, long unsigned int events);
/*!
* \brief Output initialization function
*
* Initializes all allowed GPIO outputs as outputs <br>
* Sets PWM functionality for GPIOs configured as PWM pins CV_112 - CV_115 (see CV.h for reference) <br>
* PWM frequency and clock divider are configured according to CV_116 - CV_171 (see CV.h for reference) <br>
*/
void init_outputs();
/*!
* \brief Measures base pwm duty cycles at which the motor barely starts moving.
*
* Function starts with 1/20 of the maximum duty cycle then increases the duty cycle by 1/500 of the maximum until
* the motor movement can be measured. This is done for the specified amount of iterations.
* The array with raw measurements values is then passed to two_std_dev() in order to detect outliers and
* calculate the average.An additional correction factor is applied and the overall measurement result is then
* returned. In case no motor movement could be measured a value of 0 is returned and normally written to flash,
* indicating a pending calibration next time the decoder starts, rerunning the calibration.
* \param direction Specifies direction which is to be measured
* \param iterations Specifies the amount of iterations the measurement is to be repeated and averaged out over
* \return Measurement
*/
uint16_t measure_base_pwm(bool direction, uint8_t iterations);
/*!
* \brief Checks various CV values in order to detect factory condition or pending calibrations
*
* Procedure:
* 1. Check for flash memory factory condition when found write default values specified in CV.h to flash memory
* 2. Check for existing ADC offset setup when not found write 7 to read-only CV_7 in order to trigger a ADC offset measurement/calibration
* 3. Check for base PWM configuration/calibration, run calibration when none is found
*/
void cv_setup_check();
/*!
* \brief Function initializes motor PWM for pin specified
* \param gpio GPIO pin
*/
void init_motor_pwm(uint8_t gpio);
void init_gpio_adc();
/*!
* \brief Initializes ADC
*
* Function initializes ADC, corresponding GPIO pins and ADC FIFO
*/
void init_adc();