fd1d12765a5d3513240514f8184b18cf00fd779b
[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 uint16_t ao_cmd_lex_i;
164 extern uint32_t ao_cmd_lex_u32;
165 extern char     ao_cmd_lex_c;
166 extern enum ao_cmd_status ao_cmd_status;
167
168 void
169 ao_put_string(const char *s);
170
171 void
172 ao_cmd_readline(void);
173
174 char
175 ao_cmd_lex(void);
176
177 void
178 ao_cmd_put8(uint8_t v);
179
180 void
181 ao_cmd_put16(uint16_t v);
182
183 uint8_t
184 ao_cmd_is_white(void);
185
186 void
187 ao_cmd_white(void);
188
189 int8_t
190 ao_cmd_hexchar(char c);
191
192 void
193 ao_cmd_hexbyte(void);
194
195 void
196 ao_cmd_hex(void);
197
198 void
199 ao_cmd_decimal(void);
200
201 /* Read a single hex nibble off stdin. */
202 uint8_t
203 ao_getnibble(void);
204
205 uint8_t
206 ao_match_word(const char *word);
207
208 struct ao_cmds {
209         void            (*func)(void);
210         const char      *help;
211 };
212
213 void
214 ao_cmd_register(const struct ao_cmds *cmds);
215
216 void
217 ao_cmd_init(void);
218
219 void
220 ao_cmd(void);
221
222 #if HAS_CMD_FILTER
223 /*
224  * Provided by an external module to filter raw command lines
225  */
226 uint8_t
227 ao_cmd_filter(void);
228 #endif
229
230 /*
231  * Various drivers
232  */
233 #if HAS_ADC
234 #include <ao_adc.h>
235 #endif
236
237 #if HAS_BEEP
238 #include <ao_beep.h>
239 #endif
240
241 #if LEDS_AVAILABLE
242 #include <ao_led.h>
243 #endif
244
245 #if HAS_USB
246 #include <ao_usb.h>
247 #endif
248
249 #if HAS_EEPROM
250 #include <ao_storage.h>
251 #endif
252
253 #if HAS_LOG
254 #include <ao_log.h>
255 #endif
256
257 #if HAS_FLIGHT
258 #include <ao_flight.h>
259 #include <ao_sample.h>
260 #endif
261
262 /*
263  * ao_report.c
264  */
265
266 #define AO_RDF_INTERVAL_TICKS   AO_SEC_TO_TICKS(5)
267 #define AO_RDF_LENGTH_MS        500
268 #define AO_RDF_CONTINUITY_MS    32
269 #define AO_RDF_CONTINUITY_PAUSE 96
270 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
271
272 /* This assumes that we're generating a 1kHz tone, which
273  * modulates the carrier at 2kbps, or 250kBps
274  */
275 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
276
277 #define AO_RADIO_RDF_LEN        AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
278 #define AO_RADIO_CONT_TONE_LEN  AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
279 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
280 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
281
282 /* returns a value 0-3 to indicate igniter continuity */
283 uint8_t
284 ao_report_igniter(void);
285
286 void
287 ao_report_init(void);
288
289 /*
290  * ao_convert.c
291  *
292  * Given raw data, convert to SI units
293  */
294
295 #if HAS_BARO
296 /* pressure from the sensor to altitude in meters */
297 alt_t
298 ao_pres_to_altitude(pres_t pres);
299
300 pres_t
301 ao_altitude_to_pres(alt_t alt);
302
303 int16_t
304 ao_temp_to_dC(int16_t temp);
305 #endif
306
307 /*
308  * ao_convert_pa.c
309  *
310  * Convert between pressure in Pa and altitude in meters
311  */
312
313 #include <ao_data.h>
314
315 #if HAS_BARO
316 alt_t
317 ao_pa_to_altitude(pres_t pa);
318
319 int32_t
320 ao_altitude_to_pa(alt_t alt);
321 #endif
322
323 #if HAS_DBG
324 #include <ao_dbg.h>
325 #endif
326
327 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
328 #include <ao_serial.h>
329 #endif
330
331 /*
332  * ao_convert_volt.c
333  *
334  * Convert ADC readings to decivolts
335  */
336
337 int16_t
338 ao_battery_decivolt(int16_t adc);
339
340 int16_t
341 ao_ignite_decivolt(int16_t adc);
342
343 /*
344  * ao_spi_slave.c
345  */
346
347 uint8_t
348 ao_spi_slave_recv(void *buf, uint16_t len);
349
350 void
351 ao_spi_slave_send(void *buf, uint16_t len);
352
353 void
354 ao_spi_slave_init(void);
355
356 /* This must be defined by the product; it will get called when chip
357  * select goes low, at which point it should use ao_spi_read and
358  * ao_spi_write to deal with the request
359  */
360
361 void
362 ao_spi_slave(void);
363
364 #include <ao_telemetry.h>
365 /*
366  * ao_gps.c
367  */
368
369 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
370 #define AO_GPS_NUM_SAT_SHIFT    (0)
371
372 #define AO_GPS_VALID            (1 << 4)
373 #define AO_GPS_RUNNING          (1 << 5)
374 #define AO_GPS_DATE_VALID       (1 << 6)
375 #define AO_GPS_COURSE_VALID     (1 << 7)
376
377 #define AO_GPS_NEW_DATA         1
378 #define AO_GPS_NEW_TRACKING     2
379
380 extern uint8_t ao_gps_new;
381 extern uint16_t ao_gps_tick;
382 extern uint8_t ao_gps_mutex;
383 extern struct ao_telemetry_location ao_gps_data;
384 extern struct ao_telemetry_satellite ao_gps_tracking_data;
385
386 struct ao_gps_orig {
387         uint8_t                 year;
388         uint8_t                 month;
389         uint8_t                 day;
390         uint8_t                 hour;
391         uint8_t                 minute;
392         uint8_t                 second;
393         uint8_t                 flags;
394         int32_t                 latitude;       /* degrees * 10⁷ */
395         int32_t                 longitude;      /* degrees * 10⁷ */
396         int16_t                 altitude;       /* m */
397         uint16_t                ground_speed;   /* cm/s */
398         uint8_t                 course;         /* degrees / 2 */
399         uint8_t                 hdop;           /* * 5 */
400         int16_t                 climb_rate;     /* cm/s */
401         uint16_t                h_error;        /* m */
402         uint16_t                v_error;        /* m */
403 };
404
405 struct ao_gps_sat_orig {
406         uint8_t         svid;
407         uint8_t         c_n_1;
408 };
409
410 #define AO_MAX_GPS_TRACKING     12
411
412 struct ao_gps_tracking_orig {
413         uint8_t                 channels;
414         struct ao_gps_sat_orig  sats[AO_MAX_GPS_TRACKING];
415 };
416
417 void
418 ao_gps_set_rate(uint8_t rate);
419
420 void
421 ao_gps(void);
422
423 void
424 ao_gps_print(struct ao_gps_orig *gps_data);
425
426 void
427 ao_gps_tracking_print(struct ao_gps_tracking_orig *gps_tracking_data);
428
429 void
430 ao_gps_show(void);
431
432 void
433 ao_gps_init(void);
434
435 /*
436  * ao_gps_report.c
437  */
438
439 void
440 ao_gps_report(void);
441
442 void
443 ao_gps_report_init(void);
444
445 /*
446  * ao_gps_report_mega.c
447  */
448
449 void
450 ao_gps_report_mega(void);
451
452 void
453 ao_gps_report_mega_init(void);
454
455 /*
456  * ao_telemetry_orig.c
457  */
458
459 #if LEGACY_MONITOR
460 struct ao_adc_orig {
461         uint16_t        tick;           /* tick when the sample was read */
462         int16_t         accel;          /* accelerometer */
463         int16_t         pres;           /* pressure sensor */
464         int16_t         temp;           /* temperature sensor */
465         int16_t         v_batt;         /* battery voltage */
466         int16_t         sense_d;        /* drogue continuity sense */
467         int16_t         sense_m;        /* main continuity sense */
468 };
469
470 struct ao_telemetry_orig {
471         uint16_t                serial;
472         uint16_t                flight;
473         uint8_t                 flight_state;
474         int16_t                 accel;
475         int16_t                 ground_accel;
476         union {
477                 struct {
478                         int16_t                 speed;
479                         int16_t                 unused;
480                 } k;
481                 int32_t         flight_vel;
482         } u;
483         int16_t                 height;
484         int16_t                 ground_pres;
485         int16_t                 accel_plus_g;
486         int16_t                 accel_minus_g;
487         struct ao_adc_orig      adc;
488         struct ao_gps_orig      gps;
489         char                    callsign[AO_MAX_CALLSIGN];
490         struct ao_gps_tracking_orig     gps_tracking;
491 };
492
493 struct ao_telemetry_tiny {
494         uint16_t                serial;
495         uint16_t                flight;
496         uint8_t                 flight_state;
497         int16_t                 height;         /* AGL in meters */
498         int16_t                 speed;          /* in m/s * 16 */
499         int16_t                 accel;          /* in m/s² * 16 */
500         int16_t                 ground_pres;    /* sensor units */
501         struct ao_adc           adc;            /* raw ADC readings */
502         char                    callsign[AO_MAX_CALLSIGN];
503 };
504
505 struct ao_telemetry_orig_recv {
506         struct ao_telemetry_orig        telemetry_orig;
507         int8_t                          rssi;
508         uint8_t                         status;
509 };
510
511 struct ao_telemetry_tiny_recv {
512         struct ao_telemetry_tiny        telemetry_tiny;
513         int8_t                          rssi;
514         uint8_t                         status;
515 };
516
517 #endif /* LEGACY_MONITOR */
518
519 /* Unfortunately, we've exposed the CC1111 rssi units as the 'usual' method
520  * for reporting RSSI. So, now we use these values everywhere
521  */
522 #define AO_RSSI_FROM_RADIO(radio)       ((int16_t) ((int8_t) (radio) >> 1) - 74)
523 #define AO_RADIO_FROM_RSSI(rssi)        (((int8_t) (rssi) + 74) << 1)
524
525 /*
526  * ao_radio_recv tacks on rssi and status bytes
527  */
528
529 struct ao_telemetry_raw_recv {
530         uint8_t                 packet[AO_MAX_TELEMETRY + 2];
531 };
532
533 /* Set delay between telemetry reports (0 to disable) */
534
535 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
536 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
537 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
538
539 void
540 ao_telemetry_reset_interval(void);
541
542 void
543 ao_telemetry_set_interval(uint16_t interval);
544
545 void
546 ao_rdf_set(uint8_t rdf);
547
548 void
549 ao_telemetry_init(void);
550
551 void
552 ao_telemetry_orig_init(void);
553
554 void
555 ao_telemetry_tiny_init(void);
556
557 /*
558  * ao_radio.c
559  */
560
561 extern uint8_t  ao_radio_dma;
562
563 extern int8_t   ao_radio_rssi;
564
565 #ifdef PKT_APPEND_STATUS_1_CRC_OK
566 #define AO_RADIO_STATUS_CRC_OK  PKT_APPEND_STATUS_1_CRC_OK
567 #else
568 #include <ao_fec.h>
569 #define AO_RADIO_STATUS_CRC_OK  AO_FEC_DECODE_CRC_OK
570 #endif
571
572 #ifndef HAS_RADIO_RECV
573 #define HAS_RADIO_RECV HAS_RADIO
574 #endif
575 #ifndef HAS_RADIO_XMIT
576 #define HAS_RADIO_XMIT HAS_RADIO
577 #endif
578
579 #define AO_RADIO_RATE_38400     0
580 #define AO_RADIO_RATE_9600      1
581 #define AO_RADIO_RATE_2400      2
582 #define AO_RADIO_RATE_MAX       AO_RADIO_RATE_2400
583
584 #if defined(HAS_RADIO) && !defined(HAS_RADIO_RATE)
585 #define HAS_RADIO_RATE  HAS_RADIO
586 #endif
587
588 void
589 ao_radio_general_isr(void) ao_arch_interrupt(16);
590
591 #if HAS_RADIO_XMIT
592 void
593 ao_radio_send(const void *d, uint8_t size);
594 #endif
595
596 #if HAS_RADIO_RECV
597 uint8_t
598 ao_radio_recv(void *d, uint8_t size, uint8_t timeout);
599
600 void
601 ao_radio_recv_abort(void);
602 #endif
603
604 void
605 ao_radio_test(uint8_t on);
606
607 typedef int16_t (*ao_radio_fill_func)(uint8_t *buffer, int16_t len);
608
609 void
610 ao_radio_send_aprs(ao_radio_fill_func fill);
611
612 /*
613  * ao_radio_pa
614  */
615
616 #if HAS_RADIO_AMP
617 void
618 ao_radio_pa_on(void);
619
620 void
621 ao_radio_pa_off(void);
622
623 void
624 ao_radio_pa_init(void);
625 #else
626 #define ao_radio_pa_on()
627 #define ao_radio_pa_off()
628 #define ao_radio_pa_init()
629 #endif
630
631 /*
632  * Compute the packet length as follows:
633  *
634  * 2000 bps (for a 1kHz tone)
635  * so, for 'ms' milliseconds, we need
636  * 2 * ms bits, or ms / 4 bytes
637  */
638
639 void
640 ao_radio_rdf(void);
641
642 void
643 ao_radio_continuity(uint8_t c);
644
645 void
646 ao_radio_rdf_abort(void);
647
648 void
649 ao_radio_test_on(void);
650
651 void
652 ao_radio_test_off(void);
653
654 void
655 ao_radio_init(void);
656
657 /*
658  * ao_monitor.c
659  */
660
661 #if HAS_MONITOR
662
663 extern const char * const ao_state_names[];
664
665 #define AO_MONITOR_RING 8
666
667 union ao_monitor {
668         struct ao_telemetry_raw_recv    raw;
669         struct ao_telemetry_all_recv    all;
670 #if LEGACY_MONITOR
671         struct ao_telemetry_orig_recv   orig;
672         struct ao_telemetry_tiny_recv   tiny;
673 #endif
674 };
675
676 extern union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
677
678 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
679 #define ao_monitor_ring_prev(n) (((n) - 1) & (AO_MONITOR_RING - 1))
680
681 extern uint8_t ao_monitoring_mutex;
682 extern uint8_t ao_monitoring;
683 extern uint8_t ao_monitor_head;
684
685 void
686 ao_monitor(void);
687
688 #define AO_MONITORING_OFF       0
689 #define AO_MONITORING_ORIG      1
690
691 void
692 ao_monitor_set(uint8_t monitoring);
693
694 void
695 ao_monitor_disable(void);
696
697 void
698 ao_monitor_enable(void);
699
700 void
701 ao_monitor_init(void);
702
703 #endif
704
705 /*
706  * ao_stdio.c
707  */
708
709 #define AO_READ_AGAIN   (-1)
710
711 struct ao_stdio {
712         int     (*_pollchar)(void);     /* Called with interrupts blocked */
713         void    (*putchar)(char c);
714         void    (*flush)(void);
715         uint8_t echo;
716 };
717
718 extern struct ao_stdio ao_stdios[];
719 extern int8_t ao_cur_stdio;
720 extern int8_t ao_num_stdios;
721
722 void
723 flush(void);
724
725 extern uint8_t ao_stdin_ready;
726
727 uint8_t
728 ao_echo(void);
729
730 int8_t
731 ao_add_stdio(int (*pollchar)(void),
732              void (*putchar)(char) ,
733              void (*flush)(void));
734
735 /*
736  * ao_ignite.c
737  */
738
739 enum ao_igniter {
740         ao_igniter_drogue = 0,
741         ao_igniter_main = 1
742 };
743
744 void
745 ao_ignite(enum ao_igniter igniter);
746
747 enum ao_igniter_status {
748         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
749         ao_igniter_ready,       /* continuity detected */
750         ao_igniter_active,      /* igniter firing */
751         ao_igniter_open,        /* open circuit detected */
752 };
753
754 struct ao_ignition {
755         uint8_t request;
756         uint8_t fired;
757         uint8_t firing;
758 };
759
760 extern const char * const ao_igniter_status_names[];
761
762 extern struct ao_ignition ao_ignition[2];
763
764 enum ao_igniter_status
765 ao_igniter_status(enum ao_igniter igniter);
766
767 extern uint8_t ao_igniter_present;
768
769 void
770 ao_ignite_set_pins(void);
771
772 void
773 ao_igniter_init(void);
774
775 /*
776  * ao_config.c
777  */
778 #include <ao_config.h>
779
780 #if AO_PYRO_NUM
781 #include <ao_pyro.h>
782 #endif
783
784 #if HAS_FORCE_FREQ
785 /*
786  * Set this to force the frequency to 434.550MHz
787  */
788 extern uint8_t ao_force_freq;
789 #endif
790
791 /*
792  * ao_rssi.c
793  */
794
795 #ifdef AO_LED_TYPE
796 void
797 ao_rssi_set(int16_t rssi_value);
798
799 void
800 ao_rssi_init(AO_LED_TYPE rssi_led);
801 #endif
802
803 /*
804  * ao_product.c
805  *
806  * values which need to be defined for
807  * each instance of a product
808  */
809
810 extern const char ao_version[];
811 extern const char ao_manufacturer[];
812 extern const char ao_product[];
813
814 /*
815  * Fifos
816  */
817
818 #define AO_FIFO_SIZE    32
819
820 struct ao_fifo {
821         uint8_t insert;
822         uint8_t remove;
823         char    fifo[AO_FIFO_SIZE];
824 };
825
826 #define ao_fifo_insert(f,c) do { \
827         (f).fifo[(f).insert] = (c); \
828         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
829 } while(0)
830
831 #define ao_fifo_remove(f,c) do {\
832         c = (f).fifo[(f).remove]; \
833         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
834 } while(0)
835
836 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
837 #define ao_fifo_mostly(f)       ((((f).insert - (f).remove) & (AO_FIFO_SIZE-1)) >= (AO_FIFO_SIZE * 3 / 4))
838 #define ao_fifo_barely(f)       ((((f).insert - (f).remove) & (AO_FIFO_SIZE-1)) >= (AO_FIFO_SIZE * 1 / 4))
839 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
840
841 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
842 #include <ao_packet.h>
843 #endif
844
845 #if HAS_BTM
846 #include <ao_btm.h>
847 #endif
848
849 #if HAS_COMPANION
850 #include <ao_companion.h>
851 #endif
852
853 #if HAS_LCD
854 #include <ao_lcd.h>
855 #endif
856
857 #if HAS_AES
858 #include <ao_aes.h>
859 #endif
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 union ao_log_single      ao_log_single_write_data;
889 extern 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);
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_ */