firmware/lights.h

   1 #ifndef LIGHTS_H__
   2 #define LIGHTS_H__ 1
   3
   4 #define TESTING_FW 1
   5
   6 #define N_LEDS 4
   7 #define N_STATUS_LED 1
   8 #define N_ILLUM_LED 2
   9 #define N_LASER_LED 4
  10
  11 #define N_PWMLEDS 3
  12 #define N_PWMLED_MODES 3
  13
  14 #define N_BUTTONS 2
  15
  16 /* logging.c */
  17 #ifdef USE_LOGGING
  18 void init_log(unsigned char mcusr);
  19 void log_set_state(unsigned char val);
  20 void log_flush();
  21 void log_byte(unsigned char byte);
  22 void log_word(uint16_t word);
  23 #else
  24 void inline init_log(unsigned char mcusr) { }
  25 void inline log_set_state(unsigned char val) { }
  26 void inline log_flush() { }
  27 void inline log_byte(unsigned char byte) { }
  28 void inline log_word(uint16_t word) { }
  29 #endif
  30
  31 /* adc.c */
  32 #define PWMLED_ADC_SHIFT 1 /* 1<<1 measurements per single callback */
  33 void init_adc();
  34 void susp_adc();
  35 void timer_start_slow_adcs();
  36 extern volatile unsigned char adc_is_on;
  37
  38 /* pwm.c */
  39 /*
  40  * The real Timer/Counter 1 frequency should not be too close to the
  41  * A/D converter frequency (125 kHz). Note that this is not the Top
  42  * value of T/C 1, it is shifted by PWM_STEP_SHIFT as described in pwm.c
  43  */
  44 #define PWM_MAX 0x780
  45 extern volatile unsigned char channels_running;
  46 #define PWM_IS_ON(n)    (channels_running & (1 << (n)))
  47 #define TIMER1_IS_ON()  (channels_running)
  48 void init_pwm();
  49 void susp_pwm();
  50 void pwm_off(unsigned char n);
  51 void pwm_set(unsigned char n, uint16_t stride);
  52 void pwm_timer();
  53 void pwm_disable_if_not_needed();
  54
  55 /* tmr.c */
  56 extern volatile uint16_t jiffies;
  57 void init_tmr();
  58 void susp_tmr();
  59
  60 /* pwmled.c */
  61 void init_pwmled();
  62 void pwmled_adc(unsigned char n, uint16_t adcval);
  63 void pwmled_set_mode(unsigned char n, unsigned char mode);
  64 void pwmled_set_brightness(uint16_t brightness);
  65 #define PWMLED_BRIGHTNESS(l0_lo, l0_hi, l1, l2_lo, l2_hi) ( \
  66            (uint16_t)(l0_lo) \
  67         | ((uint16_t)(l0_hi) << 3) \
  68         | ((uint16_t)(l1)    << 6) \
  69         | ((uint16_t)(l2_lo) << 9) \
  70         | ((uint16_t)(l2_hi) << 12) \
  71         )
  72
  73 /* gpio.c */
  74 void init_gpio();
  75 void susp_gpio();
  76 void gpio_set(unsigned char n, unsigned char on);
  77
  78 /* ambient.c */
  79 #define AMBIENT_ADC_SHIFT 0     /* 1 measurement per callback */
  80 #define N_AMBIENT_ZONES 4
  81 void init_ambient();
  82 void susp_ambient();
  83 void ambient_log_min_max();
  84 extern volatile unsigned char ambient_zone;
  85 void ambient_adc(uint16_t adc_val);
  86
  87 /* pattern.c */
  88 typedef struct {
  89         unsigned char mode: 5;
  90         unsigned char duration_fib: 3;
  91 } pattern_t;
  92
  93 #define PATTERN_END { 0, 0 }
  94 #define D_1 1
  95 #define D_2 2
  96 #define D_3 3
  97 #define D_5 4
  98 #define D_8 5
  99 #define D_13 6
 100 #define D_21 7
 101
 102 #define PWM_PAT(L2, L1, L0)     ( \
 103         (((L2) & 3) << 3) | \
 104         (((L1) & 1) << 2) | \
 105         (((L0) & 3)) )
 106
 107 void init_pattern();
 108 void patterns_next_tick();
 109 void led_set_pattern(unsigned char led, pattern_t *pattern);
 110 pattern_t *number_pattern(unsigned char num, unsigned char inv);
 111 void pattern_reload();
 112 void pwmleds_update_mode();
 113
 114 /* buttons.c */
 115 #define N_USER_PARAMS 3
 116 void init_buttons();
 117 void susp_buttons();
 118 void timer_check_buttons();
 119 void button_adc(uint16_t adcval);
 120 unsigned char get_user_param(unsigned char param);
 121 unsigned char buttons_wait_for_release();
 122 unsigned char buttons_setup_in_progress();
 123 pattern_t *buttons_setup_status0_pattern_select();
 124 pattern_t *buttons_setup_status1_pattern_select();
 125
 126 /* battery.c */
 127 void battery_adc();
 128 void init_battery();
 129 unsigned char battery_gauge();
 130
 131 /* control.c */
 132 extern pattern_t on_pattern[];
 133 typedef union {
 134         unsigned char any_flag;
 135         struct {
 136                 unsigned char booting : 1;
 137                 unsigned char braking : 1;
 138                 unsigned char err_battery : 1;
 139                 unsigned char err_pwmled0 : 1;
 140                 unsigned char err_pwmled1 : 1;
 141                 unsigned char err_pwmled2 : 1;
 142         };
 143 } err_flags_t;
 144 extern volatile err_flags_t err_flags;
 145
 146 void init_control();
 147 void brake_on();
 148 void brake_off();
 149 void toggle_dim_mode();
 150 void set_panic_mode();
 151 pattern_t *pwmled_pattern_select();
 152 pattern_t *status_led_pattern_select();
 153 pattern_t *illumination_led_pattern_select();
 154 pattern_t *laser_pattern_select();
 155 void pwmled_select_brightness();
 156
 157 /* main.c */
 158 void power_down(unsigned char err);
 159
 160 #endif /* !LIGHTS_H__ */
 161