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