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_INFO
  55 #  define AO_LCO_INFO           -3
  56 #  ifndef AO_LCO_BOX_FIRST
  57 #   define AO_LCO_BOX_FIRST AO_LCO_INFO
  58 #  endif
  59 # endif
  60 # ifdef AO_LCO_HAS_BACKLIGHT
  61 #   define AO_LCO_BACKLIGHT     -2
  62 #   ifndef AO_LCO_BOX_FIRST
  63 #    define AO_LCO_BOX_FIRST AO_LCO_BACKLIGHT
  64 #   endif
  65 # endif
  66 # ifdef AO_LCO_HAS_CONTRAST
  67 #  define AO_LCO_CONTRAST       -1
  68 #  ifndef AO_LCO_BOX_FIRST
  69 #   define AO_LCO_BOX_FIRST     AO_LCO_CONTRAST
  70 #  endif
  71 # endif
  72 # ifndef AO_LCO_BOX_FIRST
  73 #  define AO_LCO_BOX_FIRST      AO_LCO_LCO_VOLTAGE
  74 # endif
  75 #endif
  76 #define AO_LCO_PAD_VOLTAGE      0               /* Pad number to show box voltage */
  77
  78 static inline bool
  79 ao_lco_box_pseudo(int16_t box)
  80 {
  81         switch (box) {
  82 #ifdef AO_LCO_LCO_VOLTAGE
  83         case AO_LCO_LCO_VOLTAGE:
  84                 return true;
  85 #endif
  86 #ifdef AO_LCO_DRAG_RACE_BOX
  87         case AO_LCO_BOX_DRAG:
  88                 return true;
  89 #endif
  90 #ifdef AO_LCO_CONTRAST
  91         case AO_LCO_CONTRAST:
  92                 return true;
  93 #endif
  94 #ifdef AO_LCO_BACKLIGHT
  95         case AO_LCO_BACKLIGHT:
  96                 return true;
  97 #endif
  98 #ifdef AO_LCO_INFO
  99         case AO_LCO_INFO:
 100                 return true;
 101 #endif
 102         default:
 103                 return false;
 104         }
 105 }
 106
 107 extern int16_t  ao_lco_min_box, ao_lco_max_box;
 108
 109 #define AO_LCO_MASK_SIZE(n)     (((n) + 7) >> 3)
 110 #define AO_LCO_MASK_ID(n)       ((n) >> 3)
 111 #define AO_LCO_MASK_SHIFT(n)    ((n) & 7)
 112
 113 extern uint8_t  ao_lco_box_mask[AO_LCO_MASK_SIZE(AO_PAD_MAX_BOXES)];
 114
 115 /*
 116  * Shared functions
 117  */
 118
 119 void
 120 ao_lco_igniter_status(void);
 121
 122 void
 123 ao_lco_update(void);
 124
 125 uint8_t
 126 ao_lco_pad_present(int16_t box, uint8_t pad);
 127
 128 uint8_t
 129 ao_lco_pad_first(int16_t box);
 130
 131 void
 132 ao_lco_set_pad(uint8_t new_pad);
 133
 134 void
 135 ao_lco_step_pad(int8_t dir);
 136
 137 void
 138 ao_lco_set_box(int16_t new_box);
 139
 140 void
 141 ao_lco_step_box(int8_t dir);
 142
 143 void
 144 ao_lco_set_armed(uint8_t armed);
 145
 146 void
 147 ao_lco_set_firing(uint8_t firing);
 148
 149 void
 150 ao_lco_pretend(void);
 151
 152 void
 153 ao_lco_toggle_drag(void);
 154
 155 void
 156 ao_lco_search(void);
 157
 158 void
 159 ao_lco_monitor(void);
 160
 161 extern uint8_t                  ao_lco_drag_beep_count;
 162
 163 /* enable drag race mode */
 164 void
 165 ao_lco_drag_enable(void);
 166
 167 /* disable drag race mode */
 168 void
 169 ao_lco_drag_disable(void);
 170
 171 /* Handle drag beeps, return new delay */
 172 AO_TICK_TYPE
 173 ao_lco_drag_beep_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
 174
 175 /* Check if it's time to beep during drag race. Return new delay */
 176 AO_TICK_TYPE
 177 ao_lco_drag_warn_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
 178
 179 /* Request 'beeps' additional drag race beeps */
 180 void
 181 ao_lco_drag_add_beeps(uint8_t beeps);
 182
 183 /* task function for beeping while arm is active */
 184 void
 185 ao_lco_arm_warn(void);
 186
 187 /*
 188  * Provided by the hw-specific driver code
 189  */
 190
 191 void
 192 ao_lco_show_pad(uint8_t pad);
 193
 194 void
 195 ao_lco_show_box(int16_t box);
 196
 197 void
 198 ao_lco_show(void);
 199
 200 void
 201 ao_lco_init(void);
 202
 203 uint8_t
 204 ao_lco_box_present(int16_t box);
 205
 206 #ifdef AO_LCO_HAS_CONTRAST
 207 void
 208 ao_lco_set_contrast(int32_t contrast);
 209
 210 int32_t
 211 ao_lco_get_contrast(void);
 212 #endif
 213
 214 #ifdef AO_LCO_HAS_BACKLIGHT
 215 void
 216 ao_lco_set_backlight(int32_t backlight);
 217
 218 int32_t
 219 ao_lco_get_backlight(void);
 220 #endif
 221
 222 #ifdef AO_LCO_SEARCH_API
 223
 224 void
 225 ao_lco_search_start(void);
 226
 227 void
 228 ao_lco_search_box_check(int16_t box);
 229
 230 void
 231 ao_lco_search_box_present(int16_t box);
 232
 233 void
 234 ao_lco_search_done(void);
 235
 236 #endif /* AO_LCO_SEARCH_API */
 237
 238 #endif /* _AO_LCO_H_ */