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