RP2040-Decoder
Loading...
Searching...
No Matches
core0.h File Reference
#include "shared.h"
#include "CV.h"

Go to the source code of this file.

Macros

#define SIZE_BYTE_ARRAY   5
 
#define MESSAGE_3_BYTES   0b11111111110000000000000000000000000001
 
#define MESSAGE_MASK_3_BYTES   0b11111111111000000001000000001000000001
 
#define MESSAGE_4_BYTES   0b11111111110000000000000000000000000000000000001
 
#define MESSAGE_MASK_4_BYTES   0b11111111111000000001000000001000000001000000001
 
#define MESSAGE_5_BYTES   0b11111111110000000000000000000000000000000000000000000001
 
#define MESSAGE_MASK_5_BYTES   0b11111111111000000001000000001000000001000000001000000001
 

Functions

float two_std_dev (const float arr[], uint32_t length)
 Function returns average of values deviating less than twice the standard deviation from original average.
 
void adc_offset_adjustment (uint32_t n)
 Measures ADC offset and saves the offset value to flash memory.
 
void acknowledge ()
 Function for acknowledging a CV write or CV verify instruction.
 
void verify_cv_bit (uint16_t cv_address, bool bit_val, uint8_t bit_pos)
 Function for verifying a single bit of a CV.
 
void verify_cv_byte (uint16_t cv_address, uint8_t cv_data)
 Function for verifying a CV byte.
 
void write_cv_byte (uint16_t cv_address, uint8_t cv_data)
 Function for writing a CV byte.
 
void program_mode (uint8_t number_of_bytes, const uint8_t byte_array[])
 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.
Refers to NMRA Standard 9.2.3 ("Service Mode Programming") or RCN-216

 
void set_outputs (uint32_t functions_to_set_bitmask)
 Set outputs according to function mapping in CV257 to CV512.
 
void update_active_functions (uint32_t new_function_bitmask, uint8_t clr_bit_ind, bool direction_change)
 
bool error_detection (int8_t number_of_bytes, const uint8_t *byte_array)
 
bool is_long_address (uint8_t number_of_bytes, const uint8_t byte_array[])
 
bool address_evaluation (uint8_t number_of_bytes, const uint8_t byte_array[])
 
void instruction_evaluation (uint8_t number_of_bytes, const uint8_t byte_array[])
 
bool reset_message_check (uint8_t number_of_bytes, const uint8_t *const byte_array)
 
int8_t verify_dcc_message ()
 
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)
 Track signal rising edge interrupt callback function.
 
void track_signal_fall (unsigned int gpio, long unsigned int events)
 Track signal falling edge interrupt callback function.
 
void init_outputs ()
 Output initialization function.
 
void cv_setup_check ()
 Checks various CV values in order to detect factory condition or pending calibrations.
 
void init_motor_pwm (uint8_t gpio)
 Function initializes motor PWM for pin specified.
 
void init_adc ()
 Initializes ADC.
 

Variables

const uint32_t clr_bit_arr [6]
 Bitmasks used for clearing bits corresponding to function blocks.
 

Detailed Description

Used exclusively by core0

Function Documentation

◆ acknowledge()

void acknowledge ( )

Function for acknowledging a CV write or CV verify instruction.

Acknowledgement works by creating a spike in current consumption, normally realized by running the motor in alternating directions. This current increase is detected by the command station. Refers to NMRA S-9.2.3 Section D and RCN-216 Section 3

◆ adc_offset_adjustment()

void adc_offset_adjustment ( uint32_t n)

Measures ADC offset and saves the offset value to flash memory.

Parameters
nAmount of measurements to be done

◆ cv_setup_check()

void cv_setup_check ( )

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

◆ init_adc()

void init_adc ( )

Initializes ADC.

Function initializes ADC, corresponding GPIO pins and ADC FIFO

◆ init_motor_pwm()

void init_motor_pwm ( uint8_t gpio)

Function initializes motor PWM for pin specified.

Parameters
gpioGPIO pin

◆ init_outputs()

void init_outputs ( )

Output initialization function.

Initializes all allowed GPIO outputs as outputs
Sets PWM functionality for GPIOs configured as PWM pins CV_112 - CV_115 (see CV.h for reference)
PWM frequency and clock divider are configured according to CV_116 - CV_171 (see CV.h for reference)

◆ program_mode()

void program_mode ( uint8_t number_of_bytes,
const uint8_t byte_array[] )

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.
Refers to NMRA Standard 9.2.3 ("Service Mode Programming") or RCN-216

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
Parameters
number_of_bytesNumber of bytes in byte_array[]
byte_arrayPointer to byte_array[]

◆ set_outputs()

void set_outputs ( uint32_t functions_to_set_bitmask)

Set outputs according to function mapping in CV257 to CV512.

This function maps the functions and direction to the mapped outputs configured in CV257 to CV512. Also enables PWM when enabled according to CV112 to CV115.

Parameters
functions_to_set_bitmaskFunction bitmask F0 is bit0, F1 is bit1, ...

◆ track_signal_fall()

void track_signal_fall ( unsigned int gpio,
long unsigned int events )

Track signal falling edge interrupt callback function.

Saves timer counter value using get_absolute_time(), then calculates time difference between rising and falling edge. When the time difference is greater than 87us, this bit is interpreted as a logical 0. Refers to NMRA S-9.1 and RCN-210 standards Puts the latest bit value into buffer, then evaluates complete buffer using evaluate_message(). Parameters are unused.

Parameters
gpioUnused parameter
eventsUnused parameter

◆ track_signal_rise()

void track_signal_rise ( unsigned int gpio,
long unsigned int events )

Track signal rising edge interrupt callback function.

Saves timer counter value using get_absolute_time(), then disables rising edge IRQ and enables falling edge IRQ. Parameters are unused.

Parameters
gpioUnused parameter
eventsUnused parameter

◆ two_std_dev()

float two_std_dev ( const float arr[],
uint32_t length )

Function returns average of values deviating less than twice the standard deviation from original average.

Parameters
arrinput array
lengthamount of elements in input array
Returns
average value of values deviating less than 2*standard_dev.

◆ verify_cv_bit()

void verify_cv_bit ( uint16_t cv_address,
bool bit_val,
uint8_t bit_pos )

Function for verifying a single bit of a CV.

Parameters
cv_addressCV Address
bit_valValue of bit to be verified
bit_posPosition of bit to be verified

◆ verify_cv_byte()

void verify_cv_byte ( uint16_t cv_address,
uint8_t cv_data )

Function for verifying a CV byte.

Parameters
cv_addressCV Address
cv_dataByte to be verified

◆ write_cv_byte()

void write_cv_byte ( uint16_t cv_address,
uint8_t cv_data )

Function for writing a CV byte.

Parameters
cv_address
cv_data

Variable Documentation

◆ clr_bit_arr

const uint32_t clr_bit_arr[6]
Initial value:
= {
0b11111111111111111111111111100000,
0b11111111111111111111111000011111,
0b11111111111111111110000111111111,
0b11111111111000000001111111111111,
0b11100000000111111111111111111111,
0b00011111111111111111111111111111,
}

Bitmasks used for clearing bits corresponding to function blocks.

[0] = F0-F4 [1] = F5-F8 [2] = F9-F12 [3] = F13-F20 [4] = F21-F28 [5] = F29-F31