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