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