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