altos/telelco*: Make LCO voltage display work on 2.0 and 3.0
[fw/altos] / 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 uint16_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 #define AO_LCO_BOX_FIRST        AO_LCO_LCO_VOLTAGE
55 #endif
56 #define AO_LCO_PAD_VOLTAGE      0               /* Pad number to show box voltage */
57
58 static inline bool
59 ao_lco_box_pseudo(uint16_t box)
60 {
61         switch (box) {
62 #ifdef AO_LCO_LCO_VOLTAGE
63         case AO_LCO_LCO_VOLTAGE:
64                 return true;
65 #endif
66 #ifdef AO_LCO_DRAG_RACE_BOX
67         case AO_LCO_BOX_DRAG:
68                 return true;
69 #endif
70         default:
71                 return false;
72         }
73 }
74
75 extern uint16_t ao_lco_min_box, ao_lco_max_box;
76
77 #define AO_LCO_MASK_SIZE(n)     (((n) + 7) >> 3)
78 #define AO_LCO_MASK_ID(n)       ((n) >> 3)
79 #define AO_LCO_MASK_SHIFT(n)    ((n) & 7)
80
81 extern uint8_t  ao_lco_box_mask[AO_LCO_MASK_SIZE(AO_PAD_MAX_BOXES)];
82
83 /*
84  * Shared functions
85  */
86
87 void
88 ao_lco_igniter_status(void);
89
90 void
91 ao_lco_update(void);
92
93 uint8_t
94 ao_lco_pad_present(uint16_t box, uint8_t pad);
95
96 uint8_t
97 ao_lco_pad_first(uint16_t box);
98
99 void
100 ao_lco_set_pad(uint8_t new_pad);
101
102 void
103 ao_lco_step_pad(int8_t dir);
104
105 void
106 ao_lco_set_box(uint16_t new_box);
107
108 void
109 ao_lco_step_box(int8_t dir);
110
111 void
112 ao_lco_set_armed(uint8_t armed);
113
114 void
115 ao_lco_set_firing(uint8_t firing);
116
117 void
118 ao_lco_pretend(void);
119
120 void
121 ao_lco_toggle_drag(void);
122
123 void
124 ao_lco_search(void);
125
126 void
127 ao_lco_monitor(void);
128
129 extern uint8_t                  ao_lco_drag_beep_count;
130
131 /* enable drag race mode */
132 void
133 ao_lco_drag_enable(void);
134
135 /* disable drag race mode */
136 void
137 ao_lco_drag_disable(void);
138
139 /* Handle drag beeps, return new delay */
140 AO_TICK_TYPE
141 ao_lco_drag_beep_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
142
143 /* Check if it's time to beep during drag race. Return new delay */
144 AO_TICK_TYPE
145 ao_lco_drag_warn_check(AO_TICK_TYPE now, AO_TICK_TYPE delay);
146
147 /* Request 'beeps' additional drag race beeps */
148 void
149 ao_lco_drag_add_beeps(uint8_t beeps);
150
151 /* task function for beeping while arm is active */
152 void
153 ao_lco_arm_warn(void);
154
155 /*
156  * Provided by the hw-specific driver code
157  */
158
159 void
160 ao_lco_show_pad(uint8_t pad);
161
162 void
163 ao_lco_show_box(uint16_t box);
164
165 void
166 ao_lco_show(void);
167
168 void
169 ao_lco_init(void);
170
171 uint8_t
172 ao_lco_box_present(uint16_t box);
173
174 #ifdef AO_LCO_SEARCH_API
175
176 void
177 ao_lco_search_start(void);
178
179 void
180 ao_lco_search_box_check(uint16_t box);
181
182 void
183 ao_lco_search_box_present(uint16_t box);
184
185 void
186 ao_lco_search_done(void);
187
188 #endif /* AO_LCO_SEARCH_API */
189
190 #endif /* _AO_LCO_H_ */