Status LED visual feedback for buttons and battery
[heater.git] / firmware / main.c
1 /*
2  * OVERVIEW
3  *
4  * Powering up:
5  * Immediately after reset, we power down the entire system.
6  * We wake up only after the button is pressed for a sufficiently long time.
7  *
8  * Heater output:
9  * The heater output is driven by Timer/Counter 1 in PWM mode.
10  * We want to be able to measure the battery voltage both when the
11  * output is on, and when the output is off. So we set the T/C1 clock
12  * prescaler so that the T/C1 is slow enough, we enable the T/C1 interrupts
13  * both on compare match and on overflow. After the interrupt, we trigger
14  * the battery voltage measurement with ADC.
15  *
16  * ADC:
17  * To avoid transients, we measure each battery state (when the heater is on
18  * and when it is off) separately, and we drop the first few readings.
19  * We calculate a running average of the readings to achieve higher accuracy.
20  *
21  * Buttons:
22  * There are two buttons (+ and -). Any button can wake the system up from
23  * the power-down state.
24  * TODO: When the system is woken up by the "-" button,
25  * it starts with the minimum output power, when it is woken up by the "+"
26  * button, it start with the maximum output power.
27  * When running, the "-" button is used for decreasing the output power,
28  * the "+" button is for increasing it.
29  * When on the lowest power state, the "-" button switches the system off.
30  * Long "-" button press switches the system off, long "+" button
31  * press sets the output power to maximum.
32  *
33  * Status LED:
34  * When powering up by a button press, the LED goes on to provide a visual
35  * feedback, and is switched off after the button is released.
36  * After a button press, the # of blinks of the LED reflects the
37  * chosen output power level for some time. Afterwards, it displays
38  * the battery level.
39  * When the battery is completely exhausted, the output power is switched
40  * off, the LED keeps blinking for some time, and then the whole system is
41  * switched off to avoid deep discharge of the battery.
42  *
43  * Timing:
44  * The firmware is timed by the Watchdog Timer interrupt. Most of the
45  * processing is done from the main loop, IRQs only set various flags
46  * or trigger other events.
47  */
48
49 #include <avr/interrupt.h>
50 #include <avr/io.h>
51 #include <avr/power.h>
52 #include <avr/sleep.h>
53 #include <avr/wdt.h>
54 #include <util/delay.h>
55
56 #include "logging.h"
57
58 /* waking up from the power down state by a button press */
59 #define WAKEUP_POLL 50  // msec
60 #define WAKEUP_LIMIT 5  // times WAKEUP_POLL
61
62 /* which state (output on or output off) are we measuring now */
63 static volatile unsigned char adc_type, adc_drop;
64 #define ADC_RUNAVG_SHIFT 5      // running average shift on batt_on, batt_off
65 static volatile uint16_t batt_on, batt_off; // measured voltage
66
67 /*
68  * The voltage divider has 1M5 and 300K resistors (i.e. it measures 1/6th of
69  * the real voltage), ADC uses 1.1V internal reference.
70  * Macro to calculate upper eight bits of the ADC running-averaged value
71  * from the voltage in milivolts.
72  */
73 #define ADC_1100MV_VALUE        1071    // measured, not exactly 1100
74 #define MV_TO_ADC8(mV)  ((unsigned char)(((uint32_t)(1UL << ADC_RUNAVG_SHIFT) \
75                                 * (1024UL * (mV)) \
76                                 / (6UL * ADC_1100MV_VALUE)) >> 8))
77 static unsigned char batt_levels[] = {
78         MV_TO_ADC8(3350),
79         MV_TO_ADC8(3700),
80         MV_TO_ADC8(3900),
81 };
82 #define BATT_N_LEVELS   (sizeof(batt_levels) / sizeof(batt_levels[0]))
83
84 /* output power and PWM calculation */
85 #define PWM_TOP 255
86 #define PWM_MAX (PWM_TOP - 8)   // to allow for ADC "batt_off" measurements
87
88 /*
89  * The values in power_levels[] array are voltages at which the load
90  * would give the expected power (we don't have sqrt() function,
91  * so we cannot use mW values directly. They can be calculated as
92  * voltage[V] = sqrt(load_resistance[Ohm] * expected_power[W])
93  * or
94  * voltage[mV] = sqrt(load_resistance[mOhm] * expected_power[mW])
95  *
96  * I use 1.25 W as minimum power, each step is sqrt(2)*previous_step,
97  * so the 5th step is 5 W.
98  */
99 static unsigned char power_levels[] = {
100         MV_TO_ADC8(1581),       // 1250 mW for 2 Ohm load
101         MV_TO_ADC8(1880),       // 1768 mW for 2 Ohm load
102         MV_TO_ADC8(2236),       // 2500 mW for 2 Ohm load
103         MV_TO_ADC8(2659),       // 3536 mW for 2 Ohm load
104         MV_TO_ADC8(3162),       // 5000 mW for 2 Ohm load
105 };
106 #define N_POWER_LEVELS  (sizeof(power_levels) / sizeof(power_levels[0]))
107
108 static unsigned char power_level = 0; // selected power level
109 static unsigned char power_level_changed; // for visual feedback
110
111 #define LED_PWRCHANGE_COUNT     3
112 #define LED_BATTEMPTY_COUNT     60
113
114 /* timing by WDT */
115 static volatile unsigned char jiffies, next_clock_tick;
116
117 /* button press duration (in jiffies) */
118 #define BUTTON_SHORT_MIN        1
119 #define BUTTON_LONG_MIN         10
120
121
122 /* ========= Analog to Digital Converter (battery voltage) ========== */
123 static void adc_init()
124 {
125         power_adc_enable();
126
127         ADCSRA = _BV(ADEN)                      // enable
128                 | _BV(ADPS1) | _BV(ADPS0)       // clk/8 = 125 kHz
129                 | _BV(ADIE);                    // enable IRQ
130         ADMUX = _BV(REFS1) | _BV(MUX1) | _BV(MUX0);
131                 // 1.1V reference, PB3 pin, single-ended
132         DIDR0 |= _BV(ADC3D);    // PB3 pin as analog input
133 }
134
135 static void adc_susp()
136 {
137         ADCSRA &= ~_BV(ADEN);   // disable ADC
138         DIDR0 &= ~_BV(ADC3D);   // disable analog input on PB3
139
140         power_adc_disable();
141 }
142
143 static void adc_start_measurement()
144 {
145         ADCSRA |= _BV(ADSC);
146 }
147
148 ISR(ADC_vect)
149 {
150         uint16_t adcw = ADCW;
151
152         if (adc_drop) {
153                 adc_drop--;
154                 ADCSRA |= _BV(ADSC);
155                 return;
156         }
157
158         // TODO: We may want to disable ADC after here to save power,
159         // but compared to the heater power it would be negligible,
160         // so don't bother with it.
161         if (adc_type == 0) {
162                 if (batt_off) {
163                         batt_off += adcw - (batt_off >> ADC_RUNAVG_SHIFT);
164                 } else {
165                         batt_off = adcw << ADC_RUNAVG_SHIFT;
166                 }
167         } else {
168                 if (batt_on) {
169                         batt_on += adcw - (batt_on >> ADC_RUNAVG_SHIFT);
170                 } else {
171                         batt_on = adcw << ADC_RUNAVG_SHIFT;
172                 }
173         }
174 }
175
176 /* ===================== Timer/Counter1 for PWM ===================== */
177 static void pwm_init()
178 {
179         power_timer1_enable();
180
181         DDRB |= _BV(PB4);
182
183         // TCCR1 = _BV(CS10); // clk/1 = 1 MHz
184         TCCR1 = _BV(CS11) | _BV(CS13); // clk/512 = 2 kHz
185         GTCCR = _BV(COM1B1) | _BV(PWM1B);
186         OCR1C = PWM_TOP;
187         // OCR1B = steps[0];
188         OCR1B = 0;
189         TIMSK = _BV(OCIE1B) | _BV(TOIE1);
190 }
191
192 static void pwm_susp()
193 {
194         TCCR1 = 0;
195 }
196
197 ISR(TIM1_OVF_vect)
198 {
199         adc_drop = 2;
200         adc_type = 1;
201         adc_start_measurement();
202 }
203
204 ISR(TIM1_COMPB_vect)
205 {
206         adc_drop = 2;
207         adc_type = 0;
208         adc_start_measurement();
209 }
210
211 static void pwm_set(unsigned char pwm)
212 {
213         OCR1B = pwm;
214 }
215
216 /* ===================== Status LED on pin PB2 ======================= */
217 static void status_led_init()
218 {
219         DDRB |= _BV(PB2);
220         PORTB &= ~_BV(PB2);
221 }
222
223 static void status_led_on()
224 {
225         PORTB |= _BV(PB2);
226 }
227
228 static void status_led_off()
229 {
230         PORTB &= ~_BV(PB2);
231 }
232
233 static unsigned char status_led_is_on()
234 {
235         return PORTB & _BV(PB2) ? 1 : 0;
236 }
237
238 /* ================== Buttons on pin PB0 and PB1 ===================== */
239 static void buttons_init()
240 {
241         DDRB &= ~(_BV(PB0) | _BV(PB1)); // set as input
242         PORTB |= _BV(PB0) | _BV(PB1);   // internal pull-up
243
244         GIMSK &= ~_BV(PCIE); // disable pin-change IRQs
245         PCMSK = 0; // disable pin-change IRQs on all pins of port B
246 }
247
248 static void buttons_susp()
249 {
250         buttons_init();
251
252         GIMSK |= _BV(PCIE);
253         PCMSK |= _BV(PCINT0) | _BV(PCINT1);
254 }
255
256 static unsigned char buttons_pressed()
257 {
258         return (
259                 (PINB & _BV(PB0) ? 0 : 1)
260                 |
261                 (PINB & _BV(PB1) ? 0 : 2)
262         );
263 }
264
265 static unsigned char buttons_wait_for_release()
266 {
267         uint16_t wake_count = 0;
268
269         do {
270                 if (++wake_count > WAKEUP_LIMIT)
271                         status_led_on(); // inform the user
272
273                 _delay_ms(WAKEUP_POLL);
274         } while (buttons_pressed());
275
276         status_led_off();
277
278         return wake_count > WAKEUP_LIMIT;
279 }
280
281 ISR(PCINT0_vect)
282 {
283         // empty - let it wake us from sleep, but do nothing else
284 }
285
286 /* ==== Watchdog Timer for timing blinks and other periodic tasks ==== */
287 static void wdt_init()
288 {
289         next_clock_tick = 0;
290         jiffies = 0;
291         WDTCR = _BV(WDIE) | _BV(WDP1); // interrupt mode, 64 ms
292 }
293
294 static void wdt_susp()
295 {
296         wdt_disable();
297 }
298
299 ISR(WDT_vect) {
300         next_clock_tick = 1;
301         jiffies++;
302 }
303
304 /* ====== Hardware init, teardown, powering down and waking up ====== */
305 static void hw_setup()
306 {
307         power_all_disable();
308
309         pwm_init();
310         adc_init();
311         status_led_init();
312         wdt_init();
313 }
314
315 static void hw_suspend()
316 {
317         adc_susp();
318         pwm_susp();
319         status_led_init(); // we don't have a separate _susp() here
320         buttons_susp();
321         wdt_susp();
322
323         power_all_disable();
324 }
325
326 static void power_down()
327 {
328         hw_suspend();
329
330         do {
331                 // G'night
332                 set_sleep_mode(SLEEP_MODE_PWR_DOWN);
333                 sleep_enable();
334                 sleep_bod_disable();
335                 sei();
336                 sleep_cpu();
337
338                 // G'morning
339                 cli();
340                 sleep_disable();
341
342                 // allow wakeup by long button-press only
343         } while (!buttons_wait_for_release());
344
345         // OK, wake up now
346         hw_setup();
347 }
348
349 /* ============ Status LED blinking =================================== */
350 static unsigned char blink_on_time, blink_off_time, n_blinks;
351 static unsigned char blink_counter;
352
353 static unsigned char battery_level()
354 {
355         unsigned char i, adc8;
356
357         // NOTE: we use 8-bit value only, so we don't need lock to protect
358         // us against concurrently running ADC IRQ handler:
359         adc8 = batt_off >> 8;
360
361         for (i = 0; i < BATT_N_LEVELS; i++)
362                 if (batt_levels[i] > adc8)
363                         break;
364
365         return i;
366 }
367
368 static void status_led_next_pattern()
369 {
370         static unsigned char battery_exhausted;
371
372         if (power_level_changed) {
373                 power_level_changed--;
374                 n_blinks = power_level + 1;
375         } else {
376                 unsigned char b_level = battery_level();
377                 if (b_level) {
378                         battery_exhausted = 0;
379                 } else if (battery_exhausted) {
380                         if (!--battery_exhausted)
381                                 power_down();
382                 } else {
383                         battery_exhausted = LED_BATTEMPTY_COUNT;
384                 }
385
386                 n_blinks = b_level + 1;
387         }
388
389         blink_on_time = 2;
390         blink_off_time = 1;
391         blink_counter = 10;
392 }
393
394 static void timer_blink()
395 {
396         if (blink_counter) {
397                 blink_counter--;
398         } else if (!status_led_is_on()) {
399                 status_led_on();
400                 blink_counter = blink_on_time;
401         } else if (n_blinks) {
402                 --n_blinks;
403                 status_led_off();
404                 blink_counter = blink_off_time;
405         } else {
406                 status_led_next_pattern();
407         }
408 }
409
410 /* ======== Button press detection and  handling ===================== */
411 static void button_pressed(unsigned char button, unsigned char long_press)
412 {
413         // ignore simlultaneous button 1 and 2 press
414         // Note: we set power_level_changed after each button press,
415         // even when the power is at maximum, to provide visual feedback
416         // with status LED.
417         if (long_press) {
418                 if (button == 1) {
419                         power_down();
420                         return;
421                 } else if (button == 2) {
422                         power_level = N_POWER_LEVELS-1;
423                 }
424         } else { // short press
425                 if (button == 1) {
426                         if (power_level > 0) {
427                                 --power_level;
428                         } else {
429                                 power_down();
430                                 return;
431                         }
432                 } else if (button == 2) {
433                         if (power_level < N_POWER_LEVELS-1) {
434                                 ++power_level;
435                         }
436                 }
437         }
438         power_level_changed = LED_PWRCHANGE_COUNT;
439         status_led_next_pattern();
440 }
441
442 static unsigned char button_state, button_state_time;
443
444 static void timer_check_buttons()
445 {
446         unsigned char newstate = buttons_pressed();
447
448         if (newstate == button_state) {
449                 if (newstate && button_state_time < BUTTON_LONG_MIN)
450                         ++button_state_time;
451
452                 if (newstate && button_state_time >= BUTTON_LONG_MIN) {
453                         status_led_on();
454                 }
455                 return;
456         }
457
458         if (newstate) {
459                 button_state = newstate;
460                 button_state_time = 0;
461                 return;
462         }
463
464         // just released
465         if (button_state_time >= BUTTON_SHORT_MIN)
466                 button_pressed(button_state,
467                         button_state_time >= BUTTON_LONG_MIN ? 1 : 0);
468
469         button_state = newstate;
470         button_state_time = 0;
471 }
472
473 /* ===================== Output power control ======================== */
474 static void calculate_power_level()
475 {
476         uint32_t pwm;
477         unsigned char batt_on8;
478
479         if (battery_level() == 0 || batt_on == 0) {
480                 pwm_set(0);
481                 // TODO power_down() after some time
482                 return;
483         }
484
485         batt_on8 = batt_on >> 8;
486
487         pwm = (uint32_t)PWM_TOP * power_levels[power_level]
488                 * power_levels[power_level];
489         pwm /= (uint32_t)batt_on8 * batt_on8;
490
491         if (pwm > PWM_MAX)
492                 pwm = PWM_MAX;
493
494         log_byte(0x10 + power_level);
495         log_byte(batt_on8);
496         log_byte(pwm & 0xFF);
497
498         pwm_set(pwm);
499 }
500
501 int main()
502 {
503         log_init();
504
505 #if 0
506         log_word(batt_levels[0]);
507         log_word(batt_levels[1]);
508         log_word(batt_levels[2]);
509         log_flush();
510 #endif
511         log_byte(power_levels[0]);
512         log_byte(power_levels[4]);
513         log_flush();
514
515         power_down();
516
517         sei();
518
519         // we try to be completely IRQ-driven, so just wait for IRQs here
520         while(1) {
521                 cli();
522                 set_sleep_mode(SLEEP_MODE_IDLE);
523                 sleep_enable();
524                 // keep BOD active, no sleep_bod_disable();
525                 sei();
526                 sleep_cpu();
527                 sleep_disable();
528
529                 // FIXME: Maybe handle new ADC readings as well?
530                 if (next_clock_tick) {
531                         next_clock_tick = 0;
532                         timer_blink();
533                         // this has to be after the timer_blink() call
534                         // to override the status LED during long button press
535                         timer_check_buttons();
536
537                         if ((jiffies & 0x0F) == 0) {
538                                 calculate_power_level();
539 #if 0
540                                 log_byte(0xcc);
541                                 log_byte(i);
542                                 log_byte(batt_off >> 8);
543                                 log_byte(batt_on >> 8);
544 #endif
545                         }
546                         log_flush();
547                 }
548         }
549 }