Merge branch 'master' of ssh://git.gag.com/scm/git/fw/altos
[fw/altos] / src / kernel / ao.h
1 /*
2  * Copyright © 2009 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; version 2 of the License
7  *
8  * This program is distributed in the hope that it will be useful, but
9  * WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public License along
14  * with this program; if not, write to the Free Software Foundation, Inc.,
15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
16  */
17
18 #ifndef _AO_H_
19 #define _AO_H_
20
21 #include <stdint.h>
22 #include <stdio.h>
23 #include <string.h>
24 #include <stddef.h>
25 #include <ao_pins.h>
26 #include <ao_arch.h>
27
28 #define TRUE 1
29 #define FALSE 0
30
31 /* Convert a __data pointer into an __xdata pointer */
32 #ifndef DATA_TO_XDATA
33 #define DATA_TO_XDATA(a)        (a)
34 #endif
35 #ifndef PDATA_TO_XDATA
36 #define PDATA_TO_XDATA(a)       (a)
37 #endif
38 #ifndef CODE_TO_XDATA
39 #define CODE_TO_XDATA(a)        (a)
40 #endif
41
42 #ifndef HAS_TASK
43 #define HAS_TASK        1
44 #endif
45
46 typedef AO_PORT_TYPE ao_port_t;
47
48 #if HAS_TASK
49 #include <ao_task.h>
50 #else
51 #include <ao_notask.h>
52 #endif
53
54 /*
55  * ao_panic.c
56  */
57
58 #define AO_PANIC_NO_TASK        1       /* AO_NUM_TASKS is not large enough */
59 #define AO_PANIC_DMA            2       /* Attempt to start DMA while active */
60 #define AO_PANIC_MUTEX          3       /* Mis-using mutex API */
61 #define AO_PANIC_EE             4       /* Mis-using eeprom API */
62 #define AO_PANIC_LOG            5       /* Failing to read/write log data */
63 #define AO_PANIC_CMD            6       /* Too many command sets registered */
64 #define AO_PANIC_STDIO          7       /* Too many stdio handlers registered */
65 #define AO_PANIC_REBOOT         8       /* Reboot failed */
66 #define AO_PANIC_FLASH          9       /* Invalid flash part (or wrong blocksize) */
67 #define AO_PANIC_USB            10      /* Trying to send USB packet while busy */
68 #define AO_PANIC_BT             11      /* Communications with bluetooth device failed */
69 #define AO_PANIC_STACK          12      /* Stack overflow */
70 #define AO_PANIC_SPI            13      /* SPI communication failure */
71 #define AO_PANIC_CRASH          14      /* Processor crashed */
72 #define AO_PANIC_BUFIO          15      /* Mis-using bufio API */
73 #define AO_PANIC_EXTI           16      /* Mis-using exti API */
74 #define AO_PANIC_FAST_TIMER     17      /* Mis-using fast timer API */
75 #define AO_PANIC_SELF_TEST_CC1120       0x40 | 1        /* Self test failure */
76 #define AO_PANIC_SELF_TEST_HMC5883      0x40 | 2        /* Self test failure */
77 #define AO_PANIC_SELF_TEST_MPU6000      0x40 | 3        /* Self test failure */
78 #define AO_PANIC_SELF_TEST_MS5607       0x40 | 4        /* Self test failure */
79
80 /* Stop the operating system, beeping and blinking the reason */
81 void
82 ao_panic(uint8_t reason);
83
84 /*
85  * ao_timer.c
86  */
87
88 #ifndef AO_TICK_TYPE
89 #define AO_TICK_TYPE    uint16_t
90 #define AO_TICK_SIGNED  int16_t
91 #endif
92
93 extern volatile __data AO_TICK_TYPE ao_tick_count;
94
95 /* Our timer runs at 100Hz */
96 #ifndef AO_HERTZ
97 #define AO_HERTZ                100
98 #endif
99 #define AO_MS_TO_TICKS(ms)      ((ms) / (1000 / AO_HERTZ))
100 #define AO_SEC_TO_TICKS(s)      ((s) * AO_HERTZ)
101
102 /* Returns the current time in ticks */
103 AO_TICK_TYPE
104 ao_time(void);
105
106 /* Suspend the current task until ticks time has passed */
107 void
108 ao_delay(uint16_t ticks);
109
110 /* Set the ADC interval */
111 void
112 ao_timer_set_adc_interval(uint8_t interval);
113
114 /* Timer interrupt */
115 void
116 ao_timer_isr(void) ao_arch_interrupt(9);
117
118 /* Initialize the timer */
119 void
120 ao_timer_init(void);
121
122 /* Initialize the hardware clock. Must be called first */
123 void
124 ao_clock_init(void);
125
126 /*
127  * ao_mutex.c
128  */
129
130 #ifndef ao_mutex_get
131 uint8_t
132 ao_mutex_try(__xdata uint8_t *ao_mutex, uint8_t task_id) __reentrant;
133
134 void
135 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
136
137 void
138 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
139 #endif
140
141 /*
142  * ao_cmd.c
143  */
144
145 enum ao_cmd_status {
146         ao_cmd_success = 0,
147         ao_cmd_lex_error = 1,
148         ao_cmd_syntax_error = 2,
149 };
150
151 extern __pdata uint16_t ao_cmd_lex_i;
152 extern __pdata uint32_t ao_cmd_lex_u32;
153 extern __pdata char     ao_cmd_lex_c;
154 extern __pdata enum ao_cmd_status ao_cmd_status;
155
156 void
157 ao_put_string(__code char *s);
158
159 void
160 ao_cmd_lex(void);
161
162 void
163 ao_cmd_put8(uint8_t v);
164
165 void
166 ao_cmd_put16(uint16_t v);
167
168 uint8_t
169 ao_cmd_is_white(void);
170
171 void
172 ao_cmd_white(void);
173
174 int8_t
175 ao_cmd_hexchar(char c);
176
177 void
178 ao_cmd_hexbyte(void);
179
180 void
181 ao_cmd_hex(void);
182
183 void
184 ao_cmd_decimal(void) __reentrant;
185
186 /* Read a single hex nibble off stdin. */
187 uint8_t
188 ao_getnibble(void);
189
190 uint8_t
191 ao_match_word(__code char *word);
192
193 struct ao_cmds {
194         void            (*func)(void);
195         __code char     *help;
196 };
197
198 void
199 ao_cmd_register(const __code struct ao_cmds *cmds);
200
201 void
202 ao_cmd_init(void);
203
204 #if HAS_CMD_FILTER
205 /*
206  * Provided by an external module to filter raw command lines
207  */
208 uint8_t
209 ao_cmd_filter(void);
210 #endif
211
212 /*
213  * Various drivers
214  */
215 #if HAS_ADC
216 #include <ao_adc.h>
217 #endif
218
219 #if HAS_BEEP
220 #include <ao_beep.h>
221 #endif
222
223 #if LEDS_AVAILABLE
224 #include <ao_led.h>
225 #endif
226
227 #if HAS_USB
228 #include <ao_usb.h>
229 #endif
230
231 #if HAS_EEPROM
232 #include <ao_storage.h>
233 #endif
234
235 #if HAS_LOG
236 #include <ao_log.h>
237 #endif
238
239 #if HAS_FLIGHT
240 #include <ao_flight.h>
241 #include <ao_sample.h>
242 #endif
243
244 /*
245  * ao_report.c
246  */
247
248 #define AO_RDF_INTERVAL_TICKS   AO_SEC_TO_TICKS(5)
249 #define AO_RDF_LENGTH_MS        500
250 #define AO_RDF_CONTINUITY_MS    32
251 #define AO_RDF_CONTINUITY_PAUSE 96
252 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
253
254 /* This assumes that we're generating a 1kHz tone, which
255  * modulates the carrier at 2kbps, or 250kBps
256  */
257 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
258
259 #define AO_RADIO_RDF_LEN        AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
260 #define AO_RADIO_CONT_TONE_LEN  AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
261 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
262 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
263
264 /* returns a value 0-3 to indicate igniter continuity */
265 uint8_t
266 ao_report_igniter(void);
267
268 void
269 ao_report_init(void);
270
271 /*
272  * ao_convert.c
273  *
274  * Given raw data, convert to SI units
275  */
276
277 #if HAS_BARO
278 /* pressure from the sensor to altitude in meters */
279 alt_t
280 ao_pres_to_altitude(pres_t pres) __reentrant;
281
282 pres_t
283 ao_altitude_to_pres(alt_t alt) __reentrant;
284
285 int16_t
286 ao_temp_to_dC(int16_t temp) __reentrant;
287 #endif
288
289 /*
290  * ao_convert_pa.c
291  *
292  * Convert between pressure in Pa and altitude in meters
293  */
294
295 #include <ao_data.h>
296
297 #if HAS_BARO
298 alt_t
299 ao_pa_to_altitude(pres_t pa);
300
301 int32_t
302 ao_altitude_to_pa(alt_t alt);
303 #endif
304
305 #if HAS_DBG
306 #include <ao_dbg.h>
307 #endif
308
309 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
310 #include <ao_serial.h>
311 #endif
312
313 /*
314  * ao_convert_volt.c
315  *
316  * Convert ADC readings to decivolts
317  */
318
319 int16_t
320 ao_battery_decivolt(int16_t adc);
321
322 int16_t
323 ao_ignite_decivolt(int16_t adc);
324
325 /*
326  * ao_spi_slave.c
327  */
328
329 uint8_t
330 ao_spi_slave_recv(void *buf, uint16_t len);
331
332 void
333 ao_spi_slave_send(void *buf, uint16_t len);
334
335 void
336 ao_spi_slave_init(void);
337
338 /* This must be defined by the product; it will get called when chip
339  * select goes low, at which point it should use ao_spi_read and
340  * ao_spi_write to deal with the request
341  */
342
343 void
344 ao_spi_slave(void);
345
346 #include <ao_telemetry.h>
347 /*
348  * ao_gps.c
349  */
350
351 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
352 #define AO_GPS_NUM_SAT_SHIFT    (0)
353
354 #define AO_GPS_VALID            (1 << 4)
355 #define AO_GPS_RUNNING          (1 << 5)
356 #define AO_GPS_DATE_VALID       (1 << 6)
357 #define AO_GPS_COURSE_VALID     (1 << 7)
358
359 #define AO_GPS_NEW_DATA         1
360 #define AO_GPS_NEW_TRACKING     2
361
362 extern __xdata uint8_t ao_gps_new;
363 extern __pdata uint16_t ao_gps_tick;
364 extern __xdata uint8_t ao_gps_mutex;
365 extern __xdata struct ao_telemetry_location ao_gps_data;
366 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
367
368 struct ao_gps_orig {
369         uint8_t                 year;
370         uint8_t                 month;
371         uint8_t                 day;
372         uint8_t                 hour;
373         uint8_t                 minute;
374         uint8_t                 second;
375         uint8_t                 flags;
376         int32_t                 latitude;       /* degrees * 10⁷ */
377         int32_t                 longitude;      /* degrees * 10⁷ */
378         int16_t                 altitude;       /* m */
379         uint16_t                ground_speed;   /* cm/s */
380         uint8_t                 course;         /* degrees / 2 */
381         uint8_t                 hdop;           /* * 5 */
382         int16_t                 climb_rate;     /* cm/s */
383         uint16_t                h_error;        /* m */
384         uint16_t                v_error;        /* m */
385 };
386
387 struct ao_gps_sat_orig {
388         uint8_t         svid;
389         uint8_t         c_n_1;
390 };
391
392 #define AO_MAX_GPS_TRACKING     12
393
394 struct ao_gps_tracking_orig {
395         uint8_t                 channels;
396         struct ao_gps_sat_orig  sats[AO_MAX_GPS_TRACKING];
397 };
398
399 void
400 ao_gps_set_rate(uint8_t rate);
401
402 void
403 ao_gps(void);
404
405 void
406 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
407
408 void
409 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
410
411 void
412 ao_gps_show(void) __reentrant;
413
414 void
415 ao_gps_init(void);
416
417 /*
418  * ao_gps_report.c
419  */
420
421 void
422 ao_gps_report(void);
423
424 void
425 ao_gps_report_init(void);
426
427 /*
428  * ao_gps_report_mega.c
429  */
430
431 void
432 ao_gps_report_mega(void);
433
434 void
435 ao_gps_report_mega_init(void);
436
437 /*
438  * ao_telemetry_orig.c
439  */
440
441 #if LEGACY_MONITOR
442 struct ao_adc_orig {
443         uint16_t        tick;           /* tick when the sample was read */
444         int16_t         accel;          /* accelerometer */
445         int16_t         pres;           /* pressure sensor */
446         int16_t         temp;           /* temperature sensor */
447         int16_t         v_batt;         /* battery voltage */
448         int16_t         sense_d;        /* drogue continuity sense */
449         int16_t         sense_m;        /* main continuity sense */
450 };
451
452 struct ao_telemetry_orig {
453         uint16_t                serial;
454         uint16_t                flight;
455         uint8_t                 flight_state;
456         int16_t                 accel;
457         int16_t                 ground_accel;
458         union {
459                 struct {
460                         int16_t                 speed;
461                         int16_t                 unused;
462                 } k;
463                 int32_t         flight_vel;
464         } u;
465         int16_t                 height;
466         int16_t                 ground_pres;
467         int16_t                 accel_plus_g;
468         int16_t                 accel_minus_g;
469         struct ao_adc_orig      adc;
470         struct ao_gps_orig      gps;
471         char                    callsign[AO_MAX_CALLSIGN];
472         struct ao_gps_tracking_orig     gps_tracking;
473 };
474
475 struct ao_telemetry_tiny {
476         uint16_t                serial;
477         uint16_t                flight;
478         uint8_t                 flight_state;
479         int16_t                 height;         /* AGL in meters */
480         int16_t                 speed;          /* in m/s * 16 */
481         int16_t                 accel;          /* in m/s² * 16 */
482         int16_t                 ground_pres;    /* sensor units */
483         struct ao_adc           adc;            /* raw ADC readings */
484         char                    callsign[AO_MAX_CALLSIGN];
485 };
486
487 struct ao_telemetry_orig_recv {
488         struct ao_telemetry_orig        telemetry_orig;
489         int8_t                          rssi;
490         uint8_t                         status;
491 };
492
493 struct ao_telemetry_tiny_recv {
494         struct ao_telemetry_tiny        telemetry_tiny;
495         int8_t                          rssi;
496         uint8_t                         status;
497 };
498
499 #endif /* LEGACY_MONITOR */
500
501 /* Unfortunately, we've exposed the CC1111 rssi units as the 'usual' method
502  * for reporting RSSI. So, now we use these values everywhere
503  */
504 #define AO_RSSI_FROM_RADIO(radio)       ((int16_t) ((int8_t) (radio) >> 1) - 74)
505 #define AO_RADIO_FROM_RSSI(rssi)        (((int8_t) (rssi) + 74) << 1)
506
507 /*
508  * ao_radio_recv tacks on rssi and status bytes
509  */
510
511 struct ao_telemetry_raw_recv {
512         uint8_t                 packet[AO_MAX_TELEMETRY + 2];
513 };
514
515 /* Set delay between telemetry reports (0 to disable) */
516
517 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
518 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
519 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
520
521 void
522 ao_telemetry_reset_interval(void);
523
524 void
525 ao_telemetry_set_interval(uint16_t interval);
526
527 void
528 ao_rdf_set(uint8_t rdf);
529
530 void
531 ao_telemetry_init(void);
532
533 void
534 ao_telemetry_orig_init(void);
535
536 void
537 ao_telemetry_tiny_init(void);
538
539 /*
540  * ao_radio.c
541  */
542
543 extern __xdata uint8_t  ao_radio_dma;
544
545 extern __xdata int8_t   ao_radio_rssi;
546
547 #ifdef PKT_APPEND_STATUS_1_CRC_OK
548 #define AO_RADIO_STATUS_CRC_OK  PKT_APPEND_STATUS_1_CRC_OK
549 #else
550 #include <ao_fec.h>
551 #define AO_RADIO_STATUS_CRC_OK  AO_FEC_DECODE_CRC_OK
552 #endif
553
554 #ifndef HAS_RADIO_RECV
555 #define HAS_RADIO_RECV HAS_RADIO
556 #endif
557 #ifndef HAS_RADIO_XMIT
558 #define HAS_RADIO_XMIT HAS_RADIO
559 #endif
560
561 #define AO_RADIO_RATE_38400     0
562 #define AO_RADIO_RATE_9600      1
563 #define AO_RADIO_RATE_2400      2
564 #define AO_RADIO_RATE_MAX       AO_RADIO_RATE_2400
565
566 #if defined(HAS_RADIO) && !defined(HAS_RADIO_RATE)
567 #define HAS_RADIO_RATE  HAS_RADIO
568 #endif
569
570 void
571 ao_radio_general_isr(void) ao_arch_interrupt(16);
572
573 #if HAS_RADIO_XMIT
574 void
575 ao_radio_send(const __xdata void *d, uint8_t size) __reentrant;
576 #endif
577
578 #if HAS_RADIO_RECV
579 uint8_t
580 ao_radio_recv(__xdata void *d, uint8_t size, uint8_t timeout) __reentrant;
581
582 void
583 ao_radio_recv_abort(void);
584 #endif
585
586 void
587 ao_radio_test(uint8_t on);
588
589 typedef int16_t (*ao_radio_fill_func)(uint8_t *buffer, int16_t len);
590
591 void
592 ao_radio_send_aprs(ao_radio_fill_func fill);
593
594 /*
595  * ao_radio_pa
596  */
597
598 #if HAS_RADIO_AMP
599 void
600 ao_radio_pa_on(void);
601
602 void
603 ao_radio_pa_off(void);
604
605 void
606 ao_radio_pa_init(void);
607 #else
608 #define ao_radio_pa_on()
609 #define ao_radio_pa_off()
610 #define ao_radio_pa_init()
611 #endif
612
613 /*
614  * Compute the packet length as follows:
615  *
616  * 2000 bps (for a 1kHz tone)
617  * so, for 'ms' milliseconds, we need
618  * 2 * ms bits, or ms / 4 bytes
619  */
620
621 void
622 ao_radio_rdf(void);
623
624 void
625 ao_radio_continuity(uint8_t c);
626
627 void
628 ao_radio_rdf_abort(void);
629
630 void
631 ao_radio_init(void);
632
633 /*
634  * ao_monitor.c
635  */
636
637 #if HAS_MONITOR
638
639 extern const char const * const ao_state_names[];
640
641 #define AO_MONITOR_RING 8
642
643 union ao_monitor {
644         struct ao_telemetry_raw_recv    raw;
645         struct ao_telemetry_all_recv    all;
646 #if LEGACY_MONITOR
647         struct ao_telemetry_orig_recv   orig;
648         struct ao_telemetry_tiny_recv   tiny;
649 #endif
650 };
651
652 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
653
654 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
655 #define ao_monitor_ring_prev(n) (((n) - 1) & (AO_MONITOR_RING - 1))
656
657 extern __data uint8_t ao_monitoring;
658 extern __data uint8_t ao_monitor_head;
659
660 void
661 ao_monitor(void);
662
663 #define AO_MONITORING_OFF       0
664 #define AO_MONITORING_ORIG      1
665
666 void
667 ao_monitor_set(uint8_t monitoring);
668
669 void
670 ao_monitor_disable(void);
671
672 void
673 ao_monitor_enable(void);
674
675 void
676 ao_monitor_init(void) __reentrant;
677
678 #endif
679
680 /*
681  * ao_stdio.c
682  */
683
684 #define AO_READ_AGAIN   (-1)
685
686 struct ao_stdio {
687         int     (*_pollchar)(void);     /* Called with interrupts blocked */
688         void    (*putchar)(char c) __reentrant;
689         void    (*flush)(void);
690         uint8_t echo;
691 };
692
693 extern __xdata struct ao_stdio ao_stdios[];
694 extern __pdata int8_t ao_cur_stdio;
695 extern __pdata int8_t ao_num_stdios;
696
697 void
698 flush(void);
699
700 extern __xdata uint8_t ao_stdin_ready;
701
702 uint8_t
703 ao_echo(void);
704
705 int8_t
706 ao_add_stdio(int (*pollchar)(void),
707              void (*putchar)(char) __reentrant,
708              void (*flush)(void)) __reentrant;
709
710 /*
711  * ao_ignite.c
712  */
713
714 enum ao_igniter {
715         ao_igniter_drogue = 0,
716         ao_igniter_main = 1
717 };
718
719 void
720 ao_ignite(enum ao_igniter igniter);
721
722 enum ao_igniter_status {
723         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
724         ao_igniter_ready,       /* continuity detected */
725         ao_igniter_active,      /* igniter firing */
726         ao_igniter_open,        /* open circuit detected */
727 };
728
729 struct ao_ignition {
730         uint8_t request;
731         uint8_t fired;
732         uint8_t firing;
733 };
734
735 extern __code char * __code ao_igniter_status_names[];
736
737 extern __xdata struct ao_ignition ao_ignition[2];
738
739 enum ao_igniter_status
740 ao_igniter_status(enum ao_igniter igniter);
741
742 extern __pdata uint8_t ao_igniter_present;
743
744 void
745 ao_ignite_set_pins(void);
746
747 void
748 ao_igniter_init(void);
749
750 /*
751  * ao_config.c
752  */
753 #include <ao_config.h>
754
755 #if AO_PYRO_NUM
756 #include <ao_pyro.h>
757 #endif
758
759 #if HAS_FORCE_FREQ
760 /*
761  * Set this to force the frequency to 434.550MHz
762  */
763 extern __xdata uint8_t ao_force_freq;
764 #endif
765
766 /*
767  * ao_rssi.c
768  */
769
770 #ifdef AO_LED_TYPE
771 void
772 ao_rssi_set(int16_t rssi_value);
773
774 void
775 ao_rssi_init(AO_LED_TYPE rssi_led);
776 #endif
777
778 /*
779  * ao_product.c
780  *
781  * values which need to be defined for
782  * each instance of a product
783  */
784
785 extern const char ao_version[];
786 extern const char ao_manufacturer[];
787 extern const char ao_product[];
788
789 /*
790  * Fifos
791  */
792
793 #define AO_FIFO_SIZE    32
794
795 struct ao_fifo {
796         uint8_t insert;
797         uint8_t remove;
798         char    fifo[AO_FIFO_SIZE];
799 };
800
801 #define ao_fifo_insert(f,c) do { \
802         (f).fifo[(f).insert] = (c); \
803         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
804 } while(0)
805
806 #define ao_fifo_remove(f,c) do {\
807         c = (f).fifo[(f).remove]; \
808         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
809 } while(0)
810
811 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
812 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
813
814 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
815 #include <ao_packet.h>
816 #endif
817
818 #if HAS_BTM
819 #include <ao_btm.h>
820 #endif
821
822 #if HAS_COMPANION
823 #include <ao_companion.h>
824 #endif
825
826 #if HAS_LCD
827 #include <ao_lcd.h>
828 #endif
829
830 #if HAS_AES
831 #include <ao_aes.h>
832 #endif
833
834 /* ao_launch.c */
835
836 struct ao_launch_command {
837         uint16_t        tick;
838         uint16_t        serial;
839         uint8_t         cmd;
840         uint8_t         channel;
841         uint16_t        unused;
842 };
843
844 #define AO_LAUNCH_QUERY         1
845
846 struct ao_launch_query {
847         uint16_t        tick;
848         uint16_t        serial;
849         uint8_t         channel;
850         uint8_t         valid;
851         uint8_t         arm_status;
852         uint8_t         igniter_status;
853 };
854
855 #define AO_LAUNCH_ARM           2
856 #define AO_LAUNCH_FIRE          3
857
858 void
859 ao_launch_init(void);
860
861 /*
862  * ao_log_single.c
863  */
864
865 #define AO_LOG_TELESCIENCE_START        ((uint8_t) 's')
866 #define AO_LOG_TELESCIENCE_DATA         ((uint8_t) 'd')
867
868 #define AO_LOG_TELESCIENCE_NUM_ADC      12
869
870 struct ao_log_telescience {
871         uint8_t         type;
872         uint8_t         csum;
873         uint16_t        tick;
874         uint16_t        tm_tick;
875         uint8_t         tm_state;
876         uint8_t         unused;
877         uint16_t        adc[AO_LOG_TELESCIENCE_NUM_ADC];
878 };
879
880 #define AO_LOG_SINGLE_SIZE              32
881
882 union ao_log_single {
883         struct ao_log_telescience       telescience;
884         union ao_telemetry_all          telemetry;
885         uint8_t                         bytes[AO_LOG_SINGLE_SIZE];
886 };
887
888 extern __xdata union ao_log_single      ao_log_single_write_data;
889 extern __xdata union ao_log_single      ao_log_single_read_data;
890
891 void
892 ao_log_single_extra_query(void);
893
894 void
895 ao_log_single_list(void);
896
897 void
898 ao_log_single_main(void);
899
900 uint8_t
901 ao_log_single_write(void);
902
903 uint8_t
904 ao_log_single_read(uint32_t pos);
905
906 void
907 ao_log_single_start(void);
908
909 void
910 ao_log_single_stop(void);
911
912 void
913 ao_log_single_restart(void);
914
915 void
916 ao_log_single_set(void);
917
918 void
919 ao_log_single_delete(void);
920
921 void
922 ao_log_single_init(void);
923
924 void
925 ao_log_single(void);
926
927 /*
928  * ao_pyro_slave.c
929  */
930
931 #define AO_TELEPYRO_NUM_ADC     9
932
933 #ifndef ao_xmemcpy
934 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
935 #define ao_xmemset(d,v,c) memset(d,v,c)
936 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
937 #endif
938
939 /*
940  * ao_terraui.c
941  */
942
943 void
944 ao_terraui_init(void);
945
946 /*
947  * ao_battery.c
948  */
949
950 #ifdef BATTERY_PIN
951 void
952 ao_battery_isr(void) ao_arch_interrupt(1);
953
954 uint16_t
955 ao_battery_get(void);
956
957 void
958 ao_battery_init(void);
959 #endif /* BATTERY_PIN */
960
961 /*
962  * ao_sqrt.c
963  */
964
965 uint32_t
966 ao_sqrt(uint32_t op);
967
968 /*
969  * ao_freq.c
970  */
971
972 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
973
974 /*
975  * ao_ms5607.c
976  */
977
978 void ao_ms5607_init(void);
979
980 #include <ao_arch_funcs.h>
981
982 #endif /* _AO_H_ */