altos: Use stdbool true/false instead of TRUE/FALSE
[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%5u %s: ", 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 #define AO_LCO_PAD_VOLTAGE      0               /* Pad number to show box voltage */
50
51 extern uint8_t  ao_lco_min_box, ao_lco_max_box;
52
53 #define AO_LCO_MASK_SIZE(n)     (((n) + 7) >> 3)
54 #define AO_LCO_MASK_ID(n)       ((n) >> 3)
55 #define AO_LCO_MASK_SHIFT(n)    ((n) & 7)
56
57 extern uint8_t  ao_lco_box_mask[AO_LCO_MASK_SIZE(AO_PAD_MAX_BOXES)];
58
59 /*
60  * Shared functions
61  */
62
63 void
64 ao_lco_igniter_status(void);
65
66 void
67 ao_lco_update(void);
68
69 uint8_t
70 ao_lco_pad_present(uint8_t box, uint8_t pad);
71
72 uint8_t
73 ao_lco_pad_first(uint8_t box);
74
75 void
76 ao_lco_set_pad(uint8_t new_pad);
77
78 void
79 ao_lco_step_pad(int8_t dir);
80
81 void
82 ao_lco_set_box(uint16_t new_box);
83
84 void
85 ao_lco_set_armed(uint8_t armed);
86
87 void
88 ao_lco_set_firing(uint8_t firing);
89
90 void
91 ao_lco_toggle_drag(void);
92
93 void
94 ao_lco_search(void);
95
96 void
97 ao_lco_monitor(void);
98
99 extern uint8_t                  ao_lco_drag_beep_count;
100
101 /* enable drag race mode */
102 void
103 ao_lco_drag_enable(void);
104
105 /* disable drag race mode */
106 void
107 ao_lco_drag_disable(void);
108
109 /* Handle drag beeps, return new delay */
110 uint16_t
111 ao_lco_drag_beep_check(uint16_t now, uint16_t delay);
112
113 /* Check if it's time to beep during drag race. Return new delay */
114 uint16_t
115 ao_lco_drag_warn_check(uint16_t now, uint16_t delay);
116
117 /* Request 'beeps' additional drag race beeps */
118 void
119 ao_lco_drag_add_beeps(uint8_t beeps);
120
121 /* task function for beeping while arm is active */
122 void
123 ao_lco_arm_warn(void);
124
125 /*
126  * Provided by the hw-specific driver code
127  */
128
129 void
130 ao_lco_show_pad(uint8_t pad);
131
132 void
133 ao_lco_show_box(uint16_t box);
134
135 void
136 ao_lco_show(void);
137
138 void
139 ao_lco_init(void);
140
141 uint8_t
142 ao_lco_box_present(uint16_t box);
143
144 #endif /* _AO_LCO_H_ */