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