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