new light / driver: HDR boost driver by thefreeman

(works well in a FW3A host)

3 files changed, 386 insertions, 0 deletions

diff --git a/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.c b/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.c
new file mode 100644
index 0000000..555167e
--- /dev/null
+++ b/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.c
@@ -0,0 +1,90 @@
+// thefreeman boost driver 2.1 output helper functions
+// Copyright (C) 2023 Selene ToyKeeper
+// SPDX-License-Identifier: GPL-3.0-or-later
+#pragma once
+
+#include "chan-rgbaux.c"
+
+void set_level_zero();
+
+void set_level_main(uint8_t level);
+bool gradual_tick_main(uint8_t gt);
+
+
+Channel channels[] = {
+    { // channel 1 only
+        .set_level    = set_level_main,
+        .gradual_tick = gradual_tick_main
+    },
+    RGB_AUX_CHANNELS
+};
+
+
+void set_level_zero() {
+    DAC_LVL  = 0;  // DAC off
+    DAC_VREF = V055;  // low Vref
+    HDR_ENABLE_PORT &= ~(1 << HDR_ENABLE_PIN);  // HDR off
+
+    // prevent post-off flash
+    IN_NFET_ENABLE_PORT |= (1 << IN_NFET_ENABLE_PIN);
+    delay_4ms(IN_NFET_DELAY_TIME/4);
+    IN_NFET_ENABLE_PORT &= ~(1 << IN_NFET_ENABLE_PIN);
+
+    // turn off boost last
+    BST_ENABLE_PORT &= ~(1 << BST_ENABLE_PIN);  // BST off
+}
+
+// single set of LEDs with 1 regulated power channel
+// and low/high HDR plus low/high Vref as different "gears"
+void set_level_main(uint8_t level) {
+    uint8_t noflash = 0;
+
+    // when turning on from off, use IN_NFET to prevent a flash
+    if ((! actual_level) && (level < HDR_ENABLE_LEVEL_MIN)) {
+        noflash = 1;
+        IN_NFET_ENABLE_PORT |= (1 << IN_NFET_ENABLE_PIN);
+    }
+
+    // BST on first, to give it a few extra microseconds to spin up
+    BST_ENABLE_PORT |= (1 << BST_ENABLE_PIN);
+
+    // pre-load ramp data so it can be assigned faster later
+    PWM_DATATYPE dac_lvl  = PWM_GET(pwm1_levels, level);
+    PWM_DATATYPE dac_vref = PWM_GET(pwm_tops, level);
+
+    // enable HDR on top half of ramp
+    if (level >= (HDR_ENABLE_LEVEL_MIN-1))
+        HDR_ENABLE_PORT |= (1 << HDR_ENABLE_PIN);
+    else
+        HDR_ENABLE_PORT &= ~(1 << HDR_ENABLE_PIN);
+
+    // set these in successive clock cycles to avoid getting out of sync
+    // (minimizes ramp bumps when changing gears)
+    DAC_LVL  = dac_lvl;
+    DAC_VREF = dac_vref;
+
+    if (noflash) {
+        // wait for flash prevention to finish
+        delay_4ms(IN_NFET_DELAY_TIME/4);
+        IN_NFET_ENABLE_PORT &= ~(1 << IN_NFET_ENABLE_PIN);
+    }
+}
+
+bool gradual_tick_main(uint8_t gt) {
+    // if HDR and Vref "engine gear" is the same, do a small adjustment...
+    // otherwise, simply jump to the next ramp level
+    //   and let set_level() handle any gear changes
+
+    PWM_DATATYPE dac_next  = PWM_GET(pwm1_levels, gt);
+    PWM_DATATYPE vref_next = PWM_GET(pwm_tops, gt);
+
+    // different gear = full adjustment
+    if (vref_next != DAC_VREF) return true;  // let parent set_level() for us
+
+    // same gear = small adjustment
+    GRADUAL_ADJUST_SIMPLE(dac_next, DAC_LVL);
+    if (dac_next == DAC_LVL) return true;  // done
+
+    return false;  // not done yet
+}
+
diff --git a/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.h b/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.h
new file mode 100644
index 0000000..cf9a443
--- /dev/null
+++ b/hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.h
@@ -0,0 +1,180 @@
+// hwdef for thefreeman's boost driver 2.1 w/ MP3431, DAC, ARGB
+// Copyright (C) 2023 TBD (thefreeman), Selene ToyKeeper
+// SPDX-License-Identifier: GPL-3.0-or-later
+#pragma once
+
+/* thefreeman’s Boost driver based on MP3431 and attiny1616
+ * with high dynamic range and DAC control, AUX : RGB + button
+ * hardware version : 2.0+
+ * compatible with BST20-FWxA v1.0 (no button LED A)
+ *
+ * Pin / Name / Function
+ *   1    PA2   
+ *   2    PA3   
+ *   3    GND   GND
+ *   4    VCC   VCC
+ *   5    PA4   
+ *   6    PA5   
+ *   7    PA6   DAC
+ *   8    PA7   
+ *   9    PB5   IN- NFET
+ *  10    PB4   HDR
+ *  11    PB3   B: blue aux LED
+ *  12    PB2   G: green aux LED
+ *  13    PB1   R: red aux LED
+ *  14    PB0   
+ *  15    PC0   boost enable
+ *  16    PC1   A: button LED
+ *  17    PC2   e-switch
+ *  18    PC3   
+ *  19    PA0   UDPI
+ *  20    PA1   
+ *
+ * BST EN enable the boost regulator and Op-Amp
+ * DAC sets the current, max current depends on Vset voltage divider and Rsense
+ * HDR FET switches between high value Rsense (low current range, pin low),
+ *         and low value Rsense (high current range, pin high)
+ * IN- NFET : pull up after BST enable to eliminate startup flash, pull down otherwise
+ */
+
+#define ATTINY 1616
+#include <avr/io.h>
+
+#define HWDEF_C_FILE hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.c
+
+// allow using aux LEDs as extra channel modes
+#include "chan-rgbaux.h"
+
+// channel modes:
+// * 0. main LEDs
+// * 1+. aux RGB
+#define NUM_CHANNEL_MODES   (1 + NUM_RGB_AUX_CHANNEL_MODES)
+enum CHANNEL_MODES {
+    CM_MAIN = 0,
+    RGB_AUX_ENUMS
+};
+
+#define DEFAULT_CHANNEL_MODE  CM_MAIN
+
+// right-most bit first, modes are in fedcba9876543210 order
+#define CHANNEL_MODES_ENABLED 0b0000000000000001
+
+
+#define PWM_CHANNELS  1  // old, remove this
+
+#define PWM_BITS      8         // 8-bit DAC
+#define PWM_GET       PWM_GET8
+#define PWM_DATATYPE  uint8_t
+#define PWM_DATATYPE2 uint16_t  // only needs 32-bit if ramp values go over 255
+#define PWM1_DATATYPE uint8_t   // main LED ramp
+
+// main LED outputs
+#define DAC_LVL   DAC0.DATA    // 0 to 255, for 0V to Vref
+#define DAC_VREF  VREF.CTRLA   // 0.55V or 2.5V
+#define PWM_TOP_INIT  255      // highest value used in top half of ramp (unused?)
+// Vref values
+#define V055  16
+#define V11   17
+#define V25   18
+#define V43   19
+#define V15   20
+
+// BST enable
+#define BST_ENABLE_PIN   PIN0_bp
+#define BST_ENABLE_PORT  PORTC_OUT
+
+// HDR
+// turns ON HDR FET for the high current range
+#define HDR_ENABLE_PIN   PIN4_bp
+#define HDR_ENABLE_PORT  PORTB_OUT
+
+// IN- NFET
+// pull high to force output to zero to eliminate the startup flash
+#define IN_NFET_DELAY_TIME   8  // (ms)
+#define IN_NFET_ENABLE_PIN   PIN5_bp
+#define IN_NFET_ENABLE_PORT  PORTB_OUT
+
+// e-switch
+#ifndef SWITCH_PIN
+#define SWITCH_PIN      PIN2_bp
+#define SWITCH_PORT     VPORTC.IN
+#define SWITCH_ISC_REG  PORTC.PIN2CTRL
+#define SWITCH_VECT     PORTC_PORT_vect
+#define SWITCH_INTFLG   VPORTC.INTFLAGS
+#define SWITCH_PCINT    PCINT0
+#define PCINT_vect      PCINT0_vect
+#endif
+
+// average drop across diode on this hardware
+#ifndef VOLTAGE_FUDGE_FACTOR
+#define VOLTAGE_FUDGE_FACTOR 0  // using a PFET so no appreciable drop
+#endif
+
+// this driver allows for aux LEDs under the optic
+#define AUXLED_R_PIN  PIN1_bp
+#define AUXLED_G_PIN  PIN2_bp
+#define AUXLED_B_PIN  PIN3_bp
+#define AUXLED_RGB_PORT PORTB  // PORTA or PORTB or PORTC
+
+// this light has three aux LED channels: R, G, B
+#define USE_AUX_RGB_LEDS
+
+// A: button LED
+#ifndef BUTTON_LED_PIN
+#define BUTTON_LED_PIN  PIN1_bp
+#define BUTTON_LED_PORT PORTC
+#endif
+
+
+inline void hwdef_setup() {
+
+    // TODO: for this DAC controlled-light, try to decrease the clock speed or use the ULP
+    // set up the system clock to run at 10 MHz to match other attiny1616 lights
+    _PROTECTED_WRITE( CLKCTRL.MCLKCTRLB,
+                      CLKCTRL_PDIV_2X_gc | CLKCTRL_PEN_bm );
+
+    VPORTA.DIR = PIN6_bm;  // DAC
+    VPORTB.DIR = PIN1_bm   // R
+               | PIN2_bm   // G
+               | PIN3_bm   // B
+               | PIN4_bm   // HDR
+               | PIN5_bm;  // IN- NFET
+    VPORTC.DIR = PIN0_bm   // BST EN
+               | PIN1_bm;  // A
+
+    // enable pullups on the input pins to reduce power
+    PORTA.PIN0CTRL = PORT_PULLUPEN_bm;
+    PORTA.PIN1CTRL = PORT_PULLUPEN_bm;
+    PORTA.PIN2CTRL = PORT_PULLUPEN_bm;
+    PORTA.PIN3CTRL = PORT_PULLUPEN_bm;
+    PORTA.PIN4CTRL = PORT_PULLUPEN_bm;
+    PORTA.PIN5CTRL = PORT_PULLUPEN_bm;
+    //PORTA.PIN6CTRL = PORT_PULLUPEN_bm;  // DAC
+    PORTA.PIN7CTRL = PORT_PULLUPEN_bm;
+
+    PORTB.PIN0CTRL = PORT_PULLUPEN_bm;
+    //PORTB.PIN1CTRL = PORT_PULLUPEN_bm;  // R
+    //PORTB.PIN2CTRL = PORT_PULLUPEN_bm;  // G
+    //PORTB.PIN3CTRL = PORT_PULLUPEN_bm;  // B
+    //PORTB.PIN4CTRL = PORT_PULLUPEN_bm;  // HDR
+    //PORTB.PIN5CTRL = PORT_PULLUPEN_bm;  // IN- NFET
+
+    //PORTC.PIN0CTRL = PORT_PULLUPEN_bm;  // EN
+    //PORTC.PIN1CTRL = PORT_PULLUPEN_bm;  // A
+    PORTC.PIN2CTRL = PORT_PULLUPEN_bm | PORT_ISC_BOTHEDGES_gc; // e-switch
+    PORTC.PIN3CTRL = PORT_PULLUPEN_bm;
+
+    // set up the DAC
+    // https://ww1.microchip.com/downloads/en/DeviceDoc/ATtiny1614-16-17-DataSheet-DS40002204A.pdf
+    // DAC ranges from 0V to (255 * Vref) / 256
+    // also VREF_DAC0REFSEL_0V55_gc and VREF_DAC0REFSEL_1V1_gc and VREF_DAC0REFSEL_2V5_gc 
+    VREF.CTRLA |= VREF_DAC0REFSEL_2V5_gc;
+    VREF.CTRLB |= VREF_DAC0REFEN_bm;
+    DAC0.CTRLA = DAC_ENABLE_bm | DAC_OUTEN_bm;
+    DAC0.DATA = 255; // set the output voltage
+
+}
+
+
+#define LAYOUT_DEFINED
+
diff --git a/spaghetti-monster/anduril/cfg-thefreeman-boost21-6a.h b/spaghetti-monster/anduril/cfg-thefreeman-boost21-6a.h
new file mode 100644
index 0000000..76ea9ab
--- /dev/null
+++ b/spaghetti-monster/anduril/cfg-thefreeman-boost21-6a.h
@@ -0,0 +1,116 @@
+// thefreeman's BST21 BST20-FWxA (no button LED)
+// Copyright (C) 2023 TBD (thefreeman), Selene ToyKeeper
+// SPDX-License-Identifier: GPL-3.0-or-later
+#pragma once
+
+#define MODEL_NUMBER "1631"
+#include "hwdef-thefreeman-boost21-mp3431-hdr-dac-argb.h"
+// ATTINY: 1616
+
+// HPRsense : 1.7+0.3+5 = 7mR (DMN22M5UFG+trace resistance+5mR)
+// Vsense=42.46mV, R1= 191k
+// LPRsense : 1R
+// transition DAC level 8, ramp level 45
+// fifth power ramp 0.1mA to 6066mA
+
+#define RAMP_SIZE 150
+
+// 4 ramp segments:
+//   - low 0.55V
+//   - low 2.5V
+//   - high 0.55V
+//   - high 2.5V
+// PWM1: DAC Data
+#define PWM1_LEVELS  2,  3,  4,  5,  7,  9, 11, 13, 16, 19, 23, 28, 33, 39, 45, 53, 61, 71, 81, 93,106,121,137,155,175,196,220,246, \
+                    60, 67, 74, 82, 91,100,110,121,133,146,159,174,190,207,224,244, \
+                     8,  9,  9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 20, 21, 23, 24, 26, 27, 29, 31, 33, 35, 37, 40, 42, 45, 47, 50, 53, 56, 59, 62, 66, 69, 73, 77, 81, 85, 90, 94, 99,104,109,114,120,126,132,138,144,151,158,165,173,180,188,196,205,214,223,232,242,252, \
+                    57, 60, 62, 65, 67, 70, 73, 76, 78, 82, 85, 88, 91, 95, 98,102,105,109,113,117,121,126,130,135,139,144,149,154,159,164,170,175,181,187,193,199,206,212,219,225,232,240,247,255
+// PWM Tops: VREF selector (0.55V=16,1.1V=17, 2.5V=18, 4.3V=19, 1.5V=20)
+#define PWM_TOPS    16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, \
+                    18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, \
+                    16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, 16, \
+                    18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18, 18
+
+#define MAX_1x7135           44
+#define DEFAULT_LEVEL        44
+#define HDR_ENABLE_LEVEL_MIN 45 // when HDR FET turns ON
+
+// no PWM, so MCU clock speed can be slow
+#define HALFSPEED_LEVEL      41
+#define QUARTERSPEED_LEVEL   40  // seems to run fine at 10kHz/4, try reducing more
+
+#define RAMP_SMOOTH_FLOOR    1
+#define RAMP_SMOOTH_CEIL     130  // 50% / 3A / 1000 lm
+// 1 22 [44] 65 87 108 130
+#define RAMP_DISCRETE_FLOOR  1
+#define RAMP_DISCRETE_CEIL   130
+#define RAMP_DISCRETE_STEPS  7
+
+// 20 [45] 70 95 120
+#define SIMPLE_UI_FLOOR      20
+#define SIMPLE_UI_CEIL       120  // ~2.25A / ~750 lm
+#define SIMPLE_UI_STEPS      5
+
+// don't blink mid-ramp
+#ifdef BLINK_AT_RAMP_MIDDLE
+#undef BLINK_AT_RAMP_MIDDLE
+#endif
+
+// thermal config
+
+// temperature limit
+#define THERM_FASTER_LEVEL  130 // stop panicking at 50%/3A
+#define MIN_THERM_STEPDOWN  MAX_1x7135
+
+//#define THERM_LOOKAHEAD 4 // 4 by default -> decrease for longer turbo
+#define THERM_NEXT_WARNING_THRESHOLD 48 // 24 by default -> increase for fewer adjustments (more stable output on large time scale)
+#define THERM_RESPONSE_MAGNITUDE 32 // 64 by default -> decrease for smaller adjustments (removes dip post turbo)
+//#define THERM_WINDOW_SIZE 1 // 2 by default -> decrease for tighter temperature regulation
+
+
+// UI
+
+//#define SIMPLE_UI_ACTIVE 1 // advanced UI by default
+
+// allow Aux Config and Strobe Modes in Simple UI
+#define USE_EXTENDED_SIMPLE_UI
+
+// Allow 3C in Simple UI for switching between smooth and stepped ramping
+#define USE_SIMPLE_UI_RAMPING_TOGGLE
+
+#define DEFAULT_2C_STYLE 1 // enable 2 click turbo
+
+
+// AUX
+
+//#define USE_BUTTON_LED
+
+// this light has three aux LED channels: R, G, B
+#define USE_AUX_RGB_LEDS
+
+// show each channel while it scroll by in the menu
+#define USE_CONFIG_COLORS
+
+// blink numbers on the main LEDs by default
+#define DEFAULT_BLINK_CHANNEL  CM_MAIN
+
+// use aux red + aux blue for police strobe
+#define USE_POLICE_COLOR_STROBE_MODE
+#define POLICE_STROBE_USES_AUX
+#define POLICE_COLOR_STROBE_CH1        CM_AUXRED
+#define POLICE_COLOR_STROBE_CH2        CM_AUXBLU
+
+// the aux LEDs are front-facing, so turn them off while main LEDs are on
+#ifdef USE_INDICATOR_LED_WHILE_RAMPING
+#undef USE_INDICATOR_LED_WHILE_RAMPING
+#endif
+
+
+// Misc
+
+#define PARTY_STROBE_ONTIME 1 // slow down party strobe
+#define STROBE_OFF_LEVEL 1  // keep the regulator chip on between pulses
+
+// enable 13H factory reset so it can be used on tail e-switch lights
+#define USE_SOFT_FACTORY_RESET
+