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