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