git.gag.com Git - fw/altos/blob - src/drivers/ao_lco.h

   1 /*
   2  * Copyright © 2012 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful, but
  10  * WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  17  */
  18
  19 #ifndef _AO_LCO_H_
  20 #define _AO_LCO_H_
  21
  22 #include <ao_lco_func.h>
  23
  24 #ifndef AO_LCO_DRAG
  25 #define AO_LCO_DRAG     1
  26 #endif
  27
  28 #define DEBUG   1
  29
  30 #if DEBUG
  31 extern uint8_t  ao_lco_debug;
  32 #define PRINTD(...) do { if (!ao_lco_debug) break; printf ("\r%5lu %s: ", (unsigned long) ao_tick_count, __func__); printf(__VA_ARGS__); flush(); } while(0)
  33 #else
  34 #define PRINTD(...)
  35 #endif
  36
  37 #if AO_LCO_DRAG
  38 extern uint8_t  ao_lco_drag_race;       /* true when drag race mode enabled */
  39 #endif
  40
  41 extern uint8_t  ao_lco_pad;             /* Currently selected pad */
  42 extern int16_t  ao_lco_box;             /* Currently selected box */
  43
  44 extern uint8_t  ao_lco_armed;           /* armed mode active */
  45 extern uint8_t  ao_lco_firing;          /* fire button pressed */
  46
  47 extern struct ao_pad_query      ao_pad_query;   /* Last received QUERY from pad */
  48
  49 #ifdef AO_LCO_DRAG_RACE_BOX
  50 #define AO_LCO_BOX_DRAG         0               /* Box number to enable drag race mode (old LCO bits) */
  51 #define AO_LCO_BOX_FIRST        AO_LCO_BOX_DRAG
  52 #else
  53 #define AO_LCO_LCO_VOLTAGE      0               /* Box number to show LCO voltage */
  54 # ifdef AO_LCO_HAS_BACKLIGHT
  55 #   define AO_LCO_BACKLIGHT     -2
  56 #   ifndef AO_LCO_BOX_FIRST
  57 #    define AO_LCO_BOX_FIRST AO_LCO_BACKLIGHT
  58 #   endif
  59 # endif
  60 # ifdef AO_LCO_HAS_CONTRAST
  61 #  define AO_LCO_CONTRAST       -1
  62 #  ifndef AO_LCO_BOX_FIRST
  63 #   define AO_LCO_BOX_FIRST     AO_LCO_CONTRAST
  64 #  endif
  65 # endif
  66 # ifndef AO_LCO_BOX_FIRST
  67 #  define AO_LCO_BOX_FIRST      AO_LCO_LCO_VOLTAGE
  68 # endif
  69 #endif
  70 #define AO_LCO_PAD_VOLTAGE      0               /* Pad number to show box voltage */
  71
  72 static inline bool
  73 ao_lco_box_pseudo(int16_t box)
  74 {
  75         switch (box) {
  76 #ifdef AO_LCO_LCO_VOLTAGE
  77         case AO_LCO_LCO_VOLTAGE:
  78                 return true;
  79 #endif
  80 #ifdef AO_LCO_DRAG_RACE_BOX
  81         case AO_LCO_BOX_DRAG:
  82                 return true;
  83 #endif
  84 #ifdef AO_LCO_CONTRAST
  85         case AO_LCO_CONTRAST:
  86                 return true;
  87 #endif
  88 #ifdef AO_LCO_BACKLIGHT
  89         case AO_LCO_BACKLIGHT:
  90                 return true;
  91 #endif
  92         default:
  93                 return false;
  94         }
  95 }
  96
  97 extern int16_t  ao_lco_min_box, ao_lco_max_box;
  98
  99 #define AO_LCO_MASK_SIZE(n)     (((n) + 7) >> 3)
 100 #define AO_LCO_MASK_ID(n)       ((n) >> 3)
 101 #define AO_LCO_MASK_SHIFT(n)    ((n) & 7)
 102
 103 extern uint8_t  ao_lco_box_mask[AO_LCO_MASK_SIZE(AO_PAD_MAX_BOXES)];
 104
 105 /*
 106  * Shared functions
 107  */
 108
 109 void
 110 ao_lco_igniter_status(void);
 111
 112 void
 113 ao_lco_update(void);
 114
 115 uint8_t
 116 ao_lco_pad_present(int16_t box, uint8_t pad);
 117
 118 uint8_t
 119 ao_lco_pad_first(int16_t box);
 120
 121 void
 122 ao_lco_set_pad(uint8_t new_pad);
 123
 124 void
 125 ao_lco_step_pad(int8_t dir);
 126
 127 void
 128 ao_lco_set_box(int16_t new_box);
 129
 130 void
 131 ao_lco_step_box(int8_t dir);
 132
 133 void
 134 ao_lco_set_armed(uint8_t armed);
 135
 136 void
 137 ao_lco_set_firing(uint8_t firing);
 138
 139 void
 140 ao_lco_pretend(void);
 141
 142 void
 143 ao_lco_toggle_drag(void);
 144
 145 void
 146 ao_lco_search(void);
 147
 148 void
 149 ao_lco_monitor(void);
 150
 151 extern uint8_t                  ao_lco_drag_beep_count;
 152
 153 /* enable drag race mode */
 154 void
 155 ao_lco_drag_enable(void);
 156
 157 /* disable drag race mode */
 158 void
 159 ao_lco_drag_disable(void);
 160
 161 /* Handle drag beeps, return new delay */
 162 AO_TICK_TYPE
 163 ao_lco_drag_beep_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
 164
 165 /* Check if it's time to beep during drag race. Return new delay */
 166 AO_TICK_TYPE
 167 ao_lco_drag_warn_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
 168
 169 /* Request 'beeps' additional drag race beeps */
 170 void
 171 ao_lco_drag_add_beeps(uint8_t beeps);
 172
 173 /* task function for beeping while arm is active */
 174 void
 175 ao_lco_arm_warn(void);
 176
 177 /*
 178  * Provided by the hw-specific driver code
 179  */
 180
 181 void
 182 ao_lco_show_pad(uint8_t pad);
 183
 184 void
 185 ao_lco_show_box(int16_t box);
 186
 187 void
 188 ao_lco_show(void);
 189
 190 void
 191 ao_lco_init(void);
 192
 193 uint8_t
 194 ao_lco_box_present(int16_t box);
 195
 196 #ifdef AO_LCO_HAS_CONTRAST
 197 void
 198 ao_lco_set_contrast(int32_t contrast);
 199
 200 int32_t
 201 ao_lco_get_contrast(void);
 202 #endif
 203
 204 #ifdef AO_LCO_HAS_BACKLIGHT
 205 void
 206 ao_lco_set_backlight(int32_t backlight);
 207
 208 int32_t
 209 ao_lco_get_backlight(void);
 210 #endif
 211
 212 #ifdef AO_LCO_SEARCH_API
 213
 214 void
 215 ao_lco_search_start(void);
 216
 217 void
 218 ao_lco_search_box_check(int16_t box);
 219
 220 void
 221 ao_lco_search_box_present(int16_t box);
 222
 223 void
 224 ao_lco_search_done(void);
 225
 226 #endif /* AO_LCO_SEARCH_API */
 227
 228 #endif /* _AO_LCO_H_ */