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