renamed tk*.h to arch/*.h or fsm/*.h (part 1)

to get them out of the root dir, and to start cleaning up mcu/arch code

1 files changed, 178 insertions, 0 deletions

diff --git a/arch/voltage.h b/arch/voltage.h
new file mode 100644
index 0000000..36ce9c8
--- /dev/null
+++ b/arch/voltage.h
@@ -0,0 +1,178 @@
+// tk-voltage.h: Voltage / battcheck functions.
+// Copyright (C) 2015-2023 Selene ToyKeeper
+// SPDX-License-Identifier: GPL-3.0-or-later
+#pragma once
+
+#include "tk-attiny.h"
+#include "tk-calibration.h"
+
+#if defined(TEMPERATURE_MON) || defined(THERMAL_REGULATION)
+#ifdef TEMP_10bit
+#define NEED_ADC_10bit
+#define get_temperature read_adc_10bit
+#else
+#define get_temperature read_adc_8bit
+#endif
+
+inline void ADC_on_temperature() {
+    // TODO: (?) enable ADC Noise Reduction Mode, Section 17.7 on page 128
+    //       (apparently can only read while the CPU is in idle mode though)
+    // select ADC4 by writing 0b00001111 to ADMUX
+    // 1.1v reference, left-adjust, ADC4
+    #ifdef TEMP_10bit
+    ADMUX  = (1 << V_REF) | (0 << ADLAR) | TEMP_CHANNEL;
+    #else
+    ADMUX  = (1 << V_REF) | (1 << ADLAR) | TEMP_CHANNEL;
+    #endif
+    // disable digital input on ADC pin to reduce power consumption
+    //DIDR0 |= (1 << TEMP_DIDR);
+    // enable, start, prescale
+    ADCSRA = (1 << ADEN ) | (1 << ADSC ) | ADC_PRSCL;
+}
+#endif  // TEMPERATURE_MON
+
+#ifdef VOLTAGE_MON
+#define NEED_ADC_8bit
+inline void ADC_on() {
+    // disable digital input on ADC pin to reduce power consumption
+    DIDR0 |= (1 << ADC_DIDR);
+    // 1.1v reference, left-adjust, ADC1/PB2
+    ADMUX  = (1 << V_REF) | (1 << ADLAR) | ADC_CHANNEL;
+    // enable, start, prescale
+    ADCSRA = (1 << ADEN ) | (1 << ADSC ) | ADC_PRSCL;
+}
+
+#define get_voltage read_adc_8bit
+#else
+inline void ADC_off() {
+    ADCSRA &= ~(1<<7); //ADC off
+}
+#endif
+
+#ifdef NEED_ADC_8bit
+uint8_t read_adc_8bit() {
+    // Start conversion
+    ADCSRA |= (1 << ADSC);
+    // Wait for completion
+    while (ADCSRA & (1 << ADSC));
+    // Send back the result
+    return ADCH;
+}
+#endif
+
+#ifdef NEED_ADC_10bit
+uint16_t read_adc_10bit() {
+    // Start conversion
+    ADCSRA |= (1 << ADSC);
+    // Wait for completion
+    while (ADCSRA & (1 << ADSC));
+    // Send back the result
+    //return (ADCH<<8) | (ADCL);  // ADLAR=0
+    //return (ADCH<<2) | (ADCL>>6);  // ADLAR=1
+    ADCSRA |= 0x10;  // clear ADIF flag, else only first reading works
+    return ADC;  // ADLAR=0
+}
+#endif
+
+#ifdef USE_BATTCHECK
+#ifdef BATTCHECK_4bars
+PROGMEM const uint8_t voltage_blinks[] = {
+               // 0 blinks for less than 1%
+    ADC_0p,    // 1 blink  for 1%-25%
+    ADC_25p,   // 2 blinks for 25%-50%
+    ADC_50p,   // 3 blinks for 50%-75%
+    ADC_75p,   // 4 blinks for 75%-100%
+    ADC_100p,  // 5 blinks for >100%
+    255,       // Ceiling, don't remove  (6 blinks means "error")
+};
+#endif  // BATTCHECK_4bars
+#ifdef BATTCHECK_8bars
+PROGMEM const uint8_t voltage_blinks[] = {
+               // 0 blinks for less than 1%
+    ADC_30,    // 1 blink  for 1%-12.5%
+    ADC_33,    // 2 blinks for 12.5%-25%
+    ADC_35,    // 3 blinks for 25%-37.5%
+    ADC_37,    // 4 blinks for 37.5%-50%
+    ADC_38,    // 5 blinks for 50%-62.5%
+    ADC_39,    // 6 blinks for 62.5%-75%
+    ADC_40,    // 7 blinks for 75%-87.5%
+    ADC_41,    // 8 blinks for 87.5%-100%
+    ADC_42,    // 9 blinks for >100%
+    255,       // Ceiling, don't remove  (10 blinks means "error")
+};
+#endif  // BATTCHECK_8bars
+#ifdef BATTCHECK_VpT
+/*
+PROGMEM const uint8_t v_whole_blinks[] = {
+               // 0 blinks for (shouldn't happen)
+    0,         // 1 blink for (shouldn't happen)
+    ADC_20,    // 2 blinks for 2V
+    ADC_30,    // 3 blinks for 3V
+    ADC_40,    // 4 blinks for 4V
+    255,       // Ceiling, don't remove
+};
+PROGMEM const uint8_t v_tenth_blinks[] = {
+               // 0 blinks for less than 1%
+    ADC_30,
+    ADC_33,
+    ADC_35,
+    ADC_37,
+    ADC_38,
+    ADC_39,
+    ADC_40,
+    ADC_41,
+    ADC_42,
+    255,       // Ceiling, don't remove
+};
+*/
+PROGMEM const uint8_t voltage_blinks[] = {
+    // 0 blinks for (shouldn't happen)
+    ADC_25,(2<<5)+5,
+    ADC_26,(2<<5)+6,
+    ADC_27,(2<<5)+7,
+    ADC_28,(2<<5)+8,
+    ADC_29,(2<<5)+9,
+    ADC_30,(3<<5)+0,
+    ADC_31,(3<<5)+1,
+    ADC_32,(3<<5)+2,
+    ADC_33,(3<<5)+3,
+    ADC_34,(3<<5)+4,
+    ADC_35,(3<<5)+5,
+    ADC_36,(3<<5)+6,
+    ADC_37,(3<<5)+7,
+    ADC_38,(3<<5)+8,
+    ADC_39,(3<<5)+9,
+    ADC_40,(4<<5)+0,
+    ADC_41,(4<<5)+1,
+    ADC_42,(4<<5)+2,
+    ADC_43,(4<<5)+3,
+    ADC_44,(4<<5)+4,
+    255,   (1<<5)+1,  // Ceiling, don't remove
+};
+inline uint8_t battcheck() {
+    // Return an composite int, number of "blinks", for approximate battery charge
+    // Uses the table above for return values
+    // Return value is 3 bits of whole volts and 5 bits of tenths-of-a-volt
+    uint8_t i, voltage;
+    voltage = get_voltage();
+    // figure out how many times to blink
+    for (i=0;
+         voltage > pgm_read_byte(voltage_blinks + i);
+         i += 2) {}
+    return pgm_read_byte(voltage_blinks + i + 1);
+}
+#else  // #ifdef BATTCHECK_VpT
+inline uint8_t battcheck() {
+    // Return an int, number of "blinks", for approximate battery charge
+    // Uses the table above for return values
+    uint8_t i, voltage;
+    voltage = get_voltage();
+    // figure out how many times to blink
+    for (i=0;
+         voltage > pgm_read_byte(voltage_blinks + i);
+         i ++) {}
+    return i;
+}
+#endif  // BATTCHECK_VpT
+#endif
+