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