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