git.gag.com Git - fw/altos/blob - src/core/ao.h

   1 /*
   2  * Copyright © 2009 Keith Packard <keithp@keithp.com>
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; version 2 of the License
   7  *
   8  * This program is distributed in the hope that it will be useful, but
   9  * WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
  16  */
  17
  18 #ifndef _AO_H_
  19 #define _AO_H_
  20
  21 #include <stdint.h>
  22 #include <stdio.h>
  23 #include <string.h>
  24 #include <stddef.h>
  25 #include "ao_pins.h"
  26 #include <ao_arch.h>
  27
  28 #define TRUE 1
  29 #define FALSE 0
  30
  31 /* Convert a __data pointer into an __xdata pointer */
  32 #ifndef DATA_TO_XDATA
  33 #define DATA_TO_XDATA(a)        (a)
  34 #endif
  35 #ifndef PDATA_TO_XDATA
  36 #define PDATA_TO_XDATA(a)       (a)
  37 #endif
  38 #ifndef CODE_TO_XDATA
  39 #define CODE_TO_XDATA(a)        (a)
  40 #endif
  41
  42 /* An AltOS task */
  43 struct ao_task {
  44         __xdata void *wchan;            /* current wait channel (NULL if running) */
  45         uint16_t alarm;                 /* abort ao_sleep time */
  46         ao_arch_task_members            /* any architecture-specific fields */
  47         uint8_t task_id;                /* unique id */
  48         __code char *name;              /* task name */
  49         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  50 };
  51
  52 extern __xdata struct ao_task *__data ao_cur_task;
  53
  54 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  55 #define AO_NO_TASK              0       /* no task id */
  56
  57 /*
  58  ao_task.c
  59  */
  60
  61 /* Suspend the current task until wchan is awoken.
  62  * returns:
  63  *  0 on normal wake
  64  *  1 on alarm
  65  */
  66 uint8_t
  67 ao_sleep(__xdata void *wchan);
  68
  69 /* Wake all tasks sleeping on wchan */
  70 void
  71 ao_wakeup(__xdata void *wchan);
  72
  73 /* set an alarm to go off in 'delay' ticks */
  74 void
  75 ao_alarm(uint16_t delay);
  76
  77 /* Clear any pending alarm */
  78 void
  79 ao_clear_alarm(void);
  80
  81 /* Yield the processor to another task */
  82 void
  83 ao_yield(void) ao_arch_naked_declare;
  84
  85 /* Add a task to the run queue */
  86 void
  87 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
  88
  89 /* Terminate the current task */
  90 void
  91 ao_exit(void);
  92
  93 /* Dump task info to console */
  94 void
  95 ao_task_info(void);
  96
  97 /* Start the scheduler. This will not return */
  98 void
  99 ao_start_scheduler(void);
 100
 101 /*
 102  * ao_panic.c
 103  */
 104
 105 #define AO_PANIC_NO_TASK        1       /* AO_NUM_TASKS is not large enough */
 106 #define AO_PANIC_DMA            2       /* Attempt to start DMA while active */
 107 #define AO_PANIC_MUTEX          3       /* Mis-using mutex API */
 108 #define AO_PANIC_EE             4       /* Mis-using eeprom API */
 109 #define AO_PANIC_LOG            5       /* Failing to read/write log data */
 110 #define AO_PANIC_CMD            6       /* Too many command sets registered */
 111 #define AO_PANIC_STDIO          7       /* Too many stdio handlers registered */
 112 #define AO_PANIC_REBOOT         8       /* Reboot failed */
 113 #define AO_PANIC_FLASH          9       /* Invalid flash part (or wrong blocksize) */
 114 #define AO_PANIC_USB            10      /* Trying to send USB packet while busy */
 115 #define AO_PANIC_BT             11      /* Communications with bluetooth device failed */
 116
 117 /* Stop the operating system, beeping and blinking the reason */
 118 void
 119 ao_panic(uint8_t reason);
 120
 121 /*
 122  * ao_timer.c
 123  */
 124
 125 /* Our timer runs at 100Hz */
 126 #define AO_HERTZ                100
 127 #define AO_MS_TO_TICKS(ms)      ((ms) / (1000 / AO_HERTZ))
 128 #define AO_SEC_TO_TICKS(s)      ((s) * AO_HERTZ)
 129
 130 /* Returns the current time in ticks */
 131 uint16_t
 132 ao_time(void);
 133
 134 /* Suspend the current task until ticks time has passed */
 135 void
 136 ao_delay(uint16_t ticks);
 137
 138 /* Set the ADC interval */
 139 void
 140 ao_timer_set_adc_interval(uint8_t interval) __critical;
 141
 142 /* Timer interrupt */
 143 void
 144 ao_timer_isr(void) ao_arch_interrupt(9);
 145
 146 /* Initialize the timer */
 147 void
 148 ao_timer_init(void);
 149
 150 /* Initialize the hardware clock. Must be called first */
 151 void
 152 ao_clock_init(void);
 153
 154 /*
 155  * One set of samples read from the A/D converter or telemetry
 156  */
 157
 158 #if HAS_ADC
 159
 160 /*
 161  * ao_adc.c
 162  */
 163
 164 #define ao_adc_ring_next(n)     (((n) + 1) & (AO_ADC_RING - 1))
 165 #define ao_adc_ring_prev(n)     (((n) - 1) & (AO_ADC_RING - 1))
 166
 167
 168 /*
 169  * A/D data is stored in a ring, with the next sample to be written
 170  * at ao_adc_head
 171  */
 172 extern volatile __xdata struct ao_adc   ao_adc_ring[AO_ADC_RING];
 173 extern volatile __data uint8_t          ao_adc_head;
 174 #if HAS_ACCEL_REF
 175 extern volatile __xdata uint16_t        ao_accel_ref[AO_ADC_RING];
 176 #endif
 177
 178 /* Trigger a conversion sequence (called from the timer interrupt) */
 179 void
 180 ao_adc_poll(void);
 181
 182 /* Suspend the current task until another A/D sample is converted */
 183 void
 184 ao_adc_sleep(void);
 185
 186 /* Get a copy of the last complete A/D sample set */
 187 void
 188 ao_adc_get(__xdata struct ao_adc *packet);
 189
 190 /* The A/D interrupt handler */
 191
 192 void
 193 ao_adc_isr(void) ao_arch_interrupt(1);
 194
 195 /* Initialize the A/D converter */
 196 void
 197 ao_adc_init(void);
 198
 199 #endif /* HAS_ADC */
 200
 201 /*
 202  * ao_beep.c
 203  */
 204
 205 /*
 206  * Various pre-defined beep frequencies
 207  *
 208  * frequency = 1/2 (24e6/32) / beep
 209  */
 210
 211 #define AO_BEEP_LOW     150     /* 2500Hz */
 212 #define AO_BEEP_MID     94      /* 3989Hz */
 213 #define AO_BEEP_HIGH    75      /* 5000Hz */
 214 #define AO_BEEP_OFF     0       /* off */
 215
 216 #define AO_BEEP_g       240     /* 1562.5Hz */
 217 #define AO_BEEP_gs      227     /* 1652Hz (1655Hz) */
 218 #define AO_BEEP_aa      214     /* 1752Hz (1754Hz) */
 219 #define AO_BEEP_bbf     202     /* 1856Hz (1858Hz) */
 220 #define AO_BEEP_bb      190     /* 1974Hz (1969Hz) */
 221 #define AO_BEEP_cc      180     /* 2083Hz (2086Hz) */
 222 #define AO_BEEP_ccs     170     /* 2205Hz (2210Hz) */
 223 #define AO_BEEP_dd      160     /* 2344Hz (2341Hz) */
 224 #define AO_BEEP_eef     151     /* 2483Hz (2480Hz) */
 225 #define AO_BEEP_ee      143     /* 2622Hz (2628Hz) */
 226 #define AO_BEEP_ff      135     /* 2778Hz (2784Hz) */
 227 #define AO_BEEP_ffs     127     /* 2953Hz (2950Hz) */
 228 #define AO_BEEP_gg      120     /* 3125Hz */
 229 #define AO_BEEP_ggs     113     /* 3319Hz (3311Hz) */
 230 #define AO_BEEP_aaa     107     /* 3504Hz (3508Hz) */
 231 #define AO_BEEP_bbbf    101     /* 3713Hz (3716Hz) */
 232 #define AO_BEEP_bbb     95      /* 3947Hz (3937Hz) */
 233 #define AO_BEEP_ccc     90      /* 4167Hz (4171Hz) */
 234 #define AO_BEEP_cccs    85      /* 4412Hz (4419Hz) */
 235 #define AO_BEEP_ddd     80      /* 4688Hz (4682Hz) */
 236 #define AO_BEEP_eeef    76      /* 4934Hz (4961Hz) */
 237 #define AO_BEEP_eee     71      /* 5282Hz (5256Hz) */
 238 #define AO_BEEP_fff     67      /* 5597Hz (5568Hz) */
 239 #define AO_BEEP_fffs    64      /* 5859Hz (5899Hz) */
 240 #define AO_BEEP_ggg     60      /* 6250Hz */
 241
 242 /* Set the beeper to the specified tone */
 243 void
 244 ao_beep(uint8_t beep);
 245
 246 /* Turn on the beeper for the specified time */
 247 void
 248 ao_beep_for(uint8_t beep, uint16_t ticks) __reentrant;
 249
 250 /* Initialize the beeper */
 251 void
 252 ao_beep_init(void);
 253
 254 /*
 255  * ao_led.c
 256  */
 257
 258 #define AO_LED_NONE     0
 259
 260 /* Turn on the specified LEDs */
 261 void
 262 ao_led_on(uint8_t colors);
 263
 264 /* Turn off the specified LEDs */
 265 void
 266 ao_led_off(uint8_t colors);
 267
 268 /* Set all of the LEDs to the specified state */
 269 void
 270 ao_led_set(uint8_t colors);
 271
 272 /* Toggle the specified LEDs */
 273 void
 274 ao_led_toggle(uint8_t colors);
 275
 276 /* Turn on the specified LEDs for the indicated interval */
 277 void
 278 ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
 279
 280 /* Initialize the LEDs */
 281 void
 282 ao_led_init(uint8_t enable);
 283
 284 /*
 285  * ao_usb.c
 286  */
 287
 288 /* Put one character to the USB output queue */
 289 void
 290 ao_usb_putchar(char c);
 291
 292 /* Get one character from the USB input queue */
 293 char
 294 ao_usb_getchar(void);
 295
 296 /* Poll for a charcter on the USB input queue.
 297  * returns AO_READ_AGAIN if none are available
 298  */
 299 char
 300 ao_usb_pollchar(void);
 301
 302 /* Flush the USB output queue */
 303 void
 304 ao_usb_flush(void);
 305
 306 #if HAS_USB
 307 /* USB interrupt handler */
 308 void
 309 ao_usb_isr(void) ao_arch_interrupt(6);
 310 #endif
 311
 312 /* Enable the USB controller */
 313 void
 314 ao_usb_enable(void);
 315
 316 /* Disable the USB controller */
 317 void
 318 ao_usb_disable(void);
 319
 320 /* Initialize the USB system */
 321 void
 322 ao_usb_init(void);
 323
 324 #if HAS_USB
 325 extern __code __at (0x00aa) uint8_t ao_usb_descriptors [];
 326 #endif
 327
 328 /*
 329  * ao_cmd.c
 330  */
 331
 332 enum ao_cmd_status {
 333         ao_cmd_success = 0,
 334         ao_cmd_lex_error = 1,
 335         ao_cmd_syntax_error = 2,
 336 };
 337
 338 extern __pdata uint16_t ao_cmd_lex_i;
 339 extern __pdata uint32_t ao_cmd_lex_u32;
 340 extern __pdata char     ao_cmd_lex_c;
 341 extern __pdata enum ao_cmd_status ao_cmd_status;
 342
 343 void
 344 ao_cmd_lex(void);
 345
 346 void
 347 ao_cmd_put8(uint8_t v);
 348
 349 void
 350 ao_cmd_put16(uint16_t v);
 351
 352 void
 353 ao_cmd_white(void);
 354
 355 int8_t
 356 ao_cmd_hexchar(char c);
 357
 358 void
 359 ao_cmd_hexbyte(void);
 360
 361 void
 362 ao_cmd_hex(void);
 363
 364 void
 365 ao_cmd_decimal(void);
 366
 367 uint8_t
 368 ao_match_word(__code char *word);
 369
 370 struct ao_cmds {
 371         void            (*func)(void);
 372         __code char     *help;
 373 };
 374
 375 void
 376 ao_cmd_register(__code struct ao_cmds *cmds);
 377
 378 void
 379 ao_cmd_init(void);
 380
 381 #if HAS_CMD_FILTER
 382 /*
 383  * Provided by an external module to filter raw command lines
 384  */
 385 uint8_t
 386 ao_cmd_filter(void);
 387 #endif
 388
 389 /*
 390  * ao_dma.c
 391  */
 392
 393 /* Allocate a DMA channel. the 'done' parameter will be set when the
 394  * dma is finished and will be used to wakeup any waiters
 395  */
 396
 397 uint8_t
 398 ao_dma_alloc(__xdata uint8_t * done);
 399
 400 /* Setup a DMA channel */
 401 void
 402 ao_dma_set_transfer(uint8_t id,
 403                     void __xdata *srcaddr,
 404                     void __xdata *dstaddr,
 405                     uint16_t count,
 406                     uint8_t cfg0,
 407                     uint8_t cfg1);
 408
 409 /* Start a DMA channel */
 410 void
 411 ao_dma_start(uint8_t id);
 412
 413 /* Manually trigger a DMA channel */
 414 void
 415 ao_dma_trigger(uint8_t id);
 416
 417 /* Abort a running DMA transfer */
 418 void
 419 ao_dma_abort(uint8_t id);
 420
 421 /* DMA interrupt routine */
 422 void
 423 ao_dma_isr(void) ao_arch_interrupt(8);
 424
 425 /*
 426  * ao_mutex.c
 427  */
 428
 429 void
 430 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
 431
 432 void
 433 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 434
 435 /*
 436  * Storage interface, provided by one of the eeprom or flash
 437  * drivers
 438  */
 439
 440 /* Total bytes of available storage */
 441 extern __pdata uint32_t ao_storage_total;
 442
 443 /* Block size - device is erased in these units. At least 256 bytes */
 444 extern __pdata uint32_t ao_storage_block;
 445
 446 /* Byte offset of config block. Will be ao_storage_block bytes long */
 447 extern __pdata uint32_t ao_storage_config;
 448
 449 /* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
 450 extern __pdata uint16_t ao_storage_unit;
 451
 452 #define AO_STORAGE_ERASE_LOG    (ao_storage_config + AO_CONFIG_MAX_SIZE)
 453
 454 /* Initialize above values. Can only be called once the OS is running */
 455 void
 456 ao_storage_setup(void) __reentrant;
 457
 458 /* Write data. Returns 0 on failure, 1 on success */
 459 uint8_t
 460 ao_storage_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 461
 462 /* Read data. Returns 0 on failure, 1 on success */
 463 uint8_t
 464 ao_storage_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 465
 466 /* Erase a block of storage. This always clears ao_storage_block bytes */
 467 uint8_t
 468 ao_storage_erase(uint32_t pos) __reentrant;
 469
 470 /* Flush any pending writes to stable storage */
 471 void
 472 ao_storage_flush(void) __reentrant;
 473
 474 /* Initialize the storage code */
 475 void
 476 ao_storage_init(void);
 477
 478 /*
 479  * Low-level functions wrapped by ao_storage.c
 480  */
 481
 482 /* Read data within a storage unit */
 483 uint8_t
 484 ao_storage_device_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 485
 486 /* Write data within a storage unit */
 487 uint8_t
 488 ao_storage_device_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 489
 490 /* Initialize low-level device bits */
 491 void
 492 ao_storage_device_init(void);
 493
 494 /* Print out information about flash chips */
 495 void
 496 ao_storage_device_info(void) __reentrant;
 497
 498 /*
 499  * ao_log.c
 500  */
 501
 502 /* We record flight numbers in the first record of
 503  * the log. Tasks may wait for this to be initialized
 504  * by sleeping on this variable.
 505  */
 506 extern __xdata uint16_t ao_flight_number;
 507
 508 extern __pdata uint32_t ao_log_current_pos;
 509 extern __pdata uint32_t ao_log_end_pos;
 510 extern __pdata uint32_t ao_log_start_pos;
 511 extern __xdata uint8_t  ao_log_running;
 512 extern __pdata enum flight_state ao_log_state;
 513
 514 /* required functions from the underlying log system */
 515
 516 #define AO_LOG_FORMAT_UNKNOWN           0       /* unknown; altosui will have to guess */
 517 #define AO_LOG_FORMAT_FULL              1       /* 8 byte typed log records */
 518 #define AO_LOG_FORMAT_TINY              2       /* two byte state/baro records */
 519 #define AO_LOG_FORMAT_TELEMETRY         3       /* 32 byte ao_telemetry records */
 520 #define AO_LOG_FORMAT_TELESCIENCE       4       /* 32 byte typed telescience records */
 521 #define AO_LOG_FORMAT_NONE              127     /* No log at all */
 522
 523 extern __code uint8_t ao_log_format;
 524
 525 /* Return the flight number from the given log slot, 0 if none */
 526 uint16_t
 527 ao_log_flight(uint8_t slot);
 528
 529 /* Flush the log */
 530 void
 531 ao_log_flush(void);
 532
 533 /* Logging thread main routine */
 534 void
 535 ao_log(void);
 536
 537 /* functions provided in ao_log.c */
 538
 539 /* Figure out the current flight number */
 540 void
 541 ao_log_scan(void) __reentrant;
 542
 543 /* Return the position of the start of the given log slot */
 544 uint32_t
 545 ao_log_pos(uint8_t slot);
 546
 547 /* Start logging to eeprom */
 548 void
 549 ao_log_start(void);
 550
 551 /* Stop logging */
 552 void
 553 ao_log_stop(void);
 554
 555 /* Initialize the logging system */
 556 void
 557 ao_log_init(void);
 558
 559 /* Write out the current flight number to the erase log */
 560 void
 561 ao_log_write_erase(uint8_t pos);
 562
 563 /* Returns true if there are any logs stored in eeprom */
 564 uint8_t
 565 ao_log_present(void);
 566
 567 /* Returns true if there is no more storage space available */
 568 uint8_t
 569 ao_log_full(void);
 570
 571 /*
 572  * ao_log_big.c
 573  */
 574
 575 /*
 576  * The data log is recorded in the eeprom as a sequence
 577  * of data packets.
 578  *
 579  * Each packet starts with a 4-byte header that has the
 580  * packet type, the packet checksum and the tick count. Then
 581  * they all contain 2 16 bit values which hold packet-specific
 582  * data.
 583  *
 584  * For each flight, the first packet
 585  * is FLIGHT packet, indicating the serial number of the
 586  * device and a unique number marking the number of flights
 587  * recorded by this device.
 588  *
 589  * During flight, data from the accelerometer and barometer
 590  * are recorded in SENSOR packets, using the raw 16-bit values
 591  * read from the A/D converter.
 592  *
 593  * Also during flight, but at a lower rate, the deployment
 594  * sensors are recorded in DEPLOY packets. The goal here is to
 595  * detect failure in the deployment circuits.
 596  *
 597  * STATE packets hold state transitions as the flight computer
 598  * transitions through different stages of the flight.
 599  */
 600 #define AO_LOG_FLIGHT           'F'
 601 #define AO_LOG_SENSOR           'A'
 602 #define AO_LOG_TEMP_VOLT        'T'
 603 #define AO_LOG_DEPLOY           'D'
 604 #define AO_LOG_STATE            'S'
 605 #define AO_LOG_GPS_TIME         'G'
 606 #define AO_LOG_GPS_LAT          'N'
 607 #define AO_LOG_GPS_LON          'W'
 608 #define AO_LOG_GPS_ALT          'H'
 609 #define AO_LOG_GPS_SAT          'V'
 610 #define AO_LOG_GPS_DATE         'Y'
 611
 612 #define AO_LOG_POS_NONE         (~0UL)
 613
 614 struct ao_log_record {
 615         char                    type;
 616         uint8_t                 csum;
 617         uint16_t                tick;
 618         union {
 619                 struct {
 620                         int16_t         ground_accel;
 621                         uint16_t        flight;
 622                 } flight;
 623                 struct {
 624                         int16_t         accel;
 625                         int16_t         pres;
 626                 } sensor;
 627                 struct {
 628                         int16_t         temp;
 629                         int16_t         v_batt;
 630                 } temp_volt;
 631                 struct {
 632                         int16_t         drogue;
 633                         int16_t         main;
 634                 } deploy;
 635                 struct {
 636                         uint16_t        state;
 637                         uint16_t        reason;
 638                 } state;
 639                 struct {
 640                         uint8_t         hour;
 641                         uint8_t         minute;
 642                         uint8_t         second;
 643                         uint8_t         flags;
 644                 } gps_time;
 645                 int32_t         gps_latitude;
 646                 int32_t         gps_longitude;
 647                 struct {
 648                         int16_t         altitude;
 649                         uint16_t        unused;
 650                 } gps_altitude;
 651                 struct {
 652                         uint16_t        svid;
 653                         uint8_t         unused;
 654                         uint8_t         c_n;
 655                 } gps_sat;
 656                 struct {
 657                         uint8_t         year;
 658                         uint8_t         month;
 659                         uint8_t         day;
 660                         uint8_t         extra;
 661                 } gps_date;
 662                 struct {
 663                         uint16_t        d0;
 664                         uint16_t        d1;
 665                 } anon;
 666         } u;
 667 };
 668
 669 /* Write a record to the eeprom log */
 670 uint8_t
 671 ao_log_data(__xdata struct ao_log_record *log) __reentrant;
 672
 673 /*
 674  * ao_flight.c
 675  */
 676
 677 enum ao_flight_state {
 678         ao_flight_startup = 0,
 679         ao_flight_idle = 1,
 680         ao_flight_pad = 2,
 681         ao_flight_boost = 3,
 682         ao_flight_fast = 4,
 683         ao_flight_coast = 5,
 684         ao_flight_drogue = 6,
 685         ao_flight_main = 7,
 686         ao_flight_landed = 8,
 687         ao_flight_invalid = 9
 688 };
 689
 690 extern __pdata enum ao_flight_state     ao_flight_state;
 691
 692 extern __pdata uint16_t                 ao_launch_time;
 693 extern __pdata uint8_t                  ao_flight_force_idle;
 694
 695 /* Flight thread */
 696 void
 697 ao_flight(void);
 698
 699 /* Initialize flight thread */
 700 void
 701 ao_flight_init(void);
 702
 703 /*
 704  * ao_flight_nano.c
 705  */
 706
 707 void
 708 ao_flight_nano_init(void);
 709
 710 /*
 711  * ao_sample.c
 712  */
 713
 714 /*
 715  * Barometer calibration
 716  *
 717  * We directly sample the barometer. The specs say:
 718  *
 719  * Pressure range: 15-115 kPa
 720  * Voltage at 115kPa: 2.82
 721  * Output scale: 27mV/kPa
 722  *
 723  * If we want to detect launch with the barometer, we need
 724  * a large enough bump to not be fooled by noise. At typical
 725  * launch elevations (0-2000m), a 200Pa pressure change cooresponds
 726  * to about a 20m elevation change. This is 5.4mV, or about 3LSB.
 727  * As all of our calculations are done in 16 bits, we'll actually see a change
 728  * of 16 times this though
 729  *
 730  * 27 mV/kPa * 32767 / 3300 counts/mV = 268.1 counts/kPa
 731  */
 732
 733 /* Accelerometer calibration
 734  *
 735  * We're sampling the accelerometer through a resistor divider which
 736  * consists of 5k and 10k resistors. This multiplies the values by 2/3.
 737  * That goes into the cc1111 A/D converter, which is running at 11 bits
 738  * of precision with the bits in the MSB of the 16 bit value. Only positive
 739  * values are used, so values should range from 0-32752 for 0-3.3V. The
 740  * specs say we should see 40mV/g (uncalibrated), multiply by 2/3 for what
 741  * the A/D converter sees (26.67 mV/g). We should see 32752/3300 counts/mV,
 742  * for a final computation of:
 743  *
 744  * 26.67 mV/g * 32767/3300 counts/mV = 264.8 counts/g
 745  *
 746  * Zero g was measured at 16000 (we would expect 16384).
 747  * Note that this value is only require to tell if the
 748  * rocket is standing upright. Once that is determined,
 749  * the value of the accelerometer is averaged for 100 samples
 750  * to find the resting accelerometer value, which is used
 751  * for all further flight computations
 752  */
 753
 754 #define GRAVITY 9.80665
 755
 756 /*
 757  * Above this height, the baro sensor doesn't work
 758  */
 759 #define AO_MAX_BARO_HEIGHT      12000
 760
 761 /*
 762  * Above this speed, baro measurements are unreliable
 763  */
 764 #define AO_MAX_BARO_SPEED       200
 765
 766 #define ACCEL_NOSE_UP   (ao_accel_2g >> 2)
 767
 768 /*
 769  * Speed and acceleration are scaled by 16 to provide a bit more
 770  * resolution while still having reasonable range. Note that this
 771  * limits speed to 2047m/s (around mach 6) and acceleration to
 772  * 2047m/s² (over 200g)
 773  */
 774
 775 #define AO_M_TO_HEIGHT(m)       ((int16_t) (m))
 776 #define AO_MS_TO_SPEED(ms)      ((int16_t) ((ms) * 16))
 777 #define AO_MSS_TO_ACCEL(mss)    ((int16_t) ((mss) * 16))
 778
 779 extern __pdata uint16_t ao_sample_tick;         /* time of last data */
 780 extern __pdata int16_t  ao_sample_pres;         /* most recent pressure sensor reading */
 781 extern __pdata int16_t  ao_sample_alt;          /* MSL of ao_sample_pres */
 782 extern __pdata int16_t  ao_sample_height;       /* AGL of ao_sample_pres */
 783 extern __data uint8_t   ao_sample_adc;          /* Ring position of last processed sample */
 784
 785 #if HAS_ACCEL
 786 extern __pdata int16_t  ao_sample_accel;        /* most recent accel sensor reading */
 787 #endif
 788
 789 extern __pdata int16_t  ao_ground_pres;         /* startup pressure */
 790 extern __pdata int16_t  ao_ground_height;       /* MSL of ao_ground_pres */
 791
 792 #if HAS_ACCEL
 793 extern __pdata int16_t  ao_ground_accel;        /* startup acceleration */
 794 extern __pdata int16_t  ao_accel_2g;            /* factory accel calibration */
 795 extern __pdata int32_t  ao_accel_scale;         /* sensor to m/s² conversion */
 796 #endif
 797
 798 void ao_sample_init(void);
 799
 800 /* returns FALSE in preflight mode, TRUE in flight mode */
 801 uint8_t ao_sample(void);
 802
 803 /*
 804  * ao_kalman.c
 805  */
 806
 807 #define to_fix16(x) ((int16_t) ((x) * 65536.0 + 0.5))
 808 #define to_fix32(x) ((int32_t) ((x) * 65536.0 + 0.5))
 809 #define from_fix(x)     ((x) >> 16)
 810
 811 extern __pdata int16_t                  ao_height;      /* meters */
 812 extern __pdata int16_t                  ao_speed;       /* m/s * 16 */
 813 extern __pdata int16_t                  ao_accel;       /* m/s² * 16 */
 814 extern __pdata int16_t                  ao_max_height;  /* max of ao_height */
 815 extern __pdata int16_t                  ao_avg_height;  /* running average of height */
 816
 817 extern __pdata int16_t                  ao_error_h;
 818 extern __pdata int16_t                  ao_error_h_sq_avg;
 819
 820 #if HAS_ACCEL
 821 extern __pdata int16_t                  ao_error_a;
 822 #endif
 823
 824 void ao_kalman(void);
 825
 826 /*
 827  * ao_report.c
 828  */
 829
 830 void
 831 ao_report_init(void);
 832
 833 /*
 834  * ao_convert.c
 835  *
 836  * Given raw data, convert to SI units
 837  */
 838
 839 /* pressure from the sensor to altitude in meters */
 840 int16_t
 841 ao_pres_to_altitude(int16_t pres) __reentrant;
 842
 843 int16_t
 844 ao_altitude_to_pres(int16_t alt) __reentrant;
 845
 846 int16_t
 847 ao_temp_to_dC(int16_t temp) __reentrant;
 848
 849 /*
 850  * ao_dbg.c
 851  *
 852  * debug another telemetrum board
 853  */
 854
 855 /* Send a byte to the dbg target */
 856 void
 857 ao_dbg_send_byte(uint8_t byte);
 858
 859 /* Receive a byte from the dbg target */
 860 uint8_t
 861 ao_dbg_recv_byte(void);
 862
 863 /* Start a bulk transfer to/from dbg target memory */
 864 void
 865 ao_dbg_start_transfer(uint16_t addr);
 866
 867 /* End a bulk transfer to/from dbg target memory */
 868 void
 869 ao_dbg_end_transfer(void);
 870
 871 /* Write a byte to dbg target memory */
 872 void
 873 ao_dbg_write_byte(uint8_t byte);
 874
 875 /* Read a byte from dbg target memory */
 876 uint8_t
 877 ao_dbg_read_byte(void);
 878
 879 /* Enable dbg mode, switching use of the pins */
 880 void
 881 ao_dbg_debug_mode(void);
 882
 883 /* Reset the dbg target */
 884 void
 885 ao_dbg_reset(void);
 886
 887 void
 888 ao_dbg_init(void);
 889
 890 /*
 891  * ao_serial.c
 892  */
 893
 894 #ifndef HAS_SERIAL_1
 895 #error Please define HAS_SERIAL_1
 896 #endif
 897
 898 #if HAS_SERIAL_1
 899 #ifndef USE_SERIAL_STDIN
 900 #error Please define USE_SERIAL_STDIN
 901 #endif
 902
 903 void
 904 ao_serial_rx1_isr(void) ao_arch_interrupt(3);
 905
 906 void
 907 ao_serial_tx1_isr(void) ao_arch_interrupt(14);
 908
 909 char
 910 ao_serial_getchar(void) __critical;
 911
 912 #if USE_SERIAL_STDIN
 913 char
 914 ao_serial_pollchar(void) __critical;
 915
 916 void
 917 ao_serial_set_stdin(uint8_t stdin);
 918 #endif
 919
 920 void
 921 ao_serial_putchar(char c) __critical;
 922
 923 void
 924 ao_serial_drain(void) __critical;
 925
 926 #define AO_SERIAL_SPEED_4800    0
 927 #define AO_SERIAL_SPEED_9600    1
 928 #define AO_SERIAL_SPEED_19200   2
 929 #define AO_SERIAL_SPEED_57600   3
 930
 931 void
 932 ao_serial_set_speed(uint8_t speed);
 933
 934 void
 935 ao_serial_init(void);
 936 #endif
 937
 938 /*
 939  * ao_spi.c
 940  */
 941
 942 extern __xdata uint8_t  ao_spi_mutex;
 943
 944 #define ao_spi_get_mask(reg,mask) do {\
 945         ao_mutex_get(&ao_spi_mutex); \
 946         (reg) &= ~(mask); \
 947         } while (0)
 948
 949 #define ao_spi_put_mask(reg,mask) do { \
 950         (reg) |= (mask); \
 951         ao_mutex_put(&ao_spi_mutex); \
 952         } while (0)
 953
 954 #define ao_spi_get_bit(bit) do {\
 955         ao_mutex_get(&ao_spi_mutex); \
 956         (bit) = 0; \
 957         } while (0)
 958
 959 #define ao_spi_put_bit(bit) do { \
 960         (bit) = 1; \
 961         ao_mutex_put(&ao_spi_mutex); \
 962         } while (0)
 963
 964 /*
 965  * The SPI mutex must be held to call either of these
 966  * functions -- this mutex covers the entire SPI operation,
 967  * from chip select low to chip select high
 968  */
 969
 970 void
 971 ao_spi_send(void __xdata *block, uint16_t len) __reentrant;
 972
 973 void
 974 ao_spi_recv(void __xdata *block, uint16_t len) __reentrant;
 975
 976 void
 977 ao_spi_init(void);
 978
 979 /*
 980  * ao_spi_slave.c
 981  */
 982
 983 uint8_t
 984 ao_spi_slave_recv(uint8_t *buf, uint8_t len);
 985
 986 void
 987 ao_spi_slave_send(uint8_t *buf, uint8_t len);
 988
 989 void
 990 ao_spi_slave_init(void);
 991
 992 /* This must be defined by the product; it will get called when chip
 993  * select goes low, at which point it should use ao_spi_read and
 994  * ao_spi_write to deal with the request
 995  */
 996
 997 void
 998 ao_spi_slave(void);
 999
1000 /*
1001  * ao_telemetry.c
1002  */
1003 #define AO_MAX_CALLSIGN                 8
1004 #define AO_MAX_VERSION                  8
1005 #if LEGACY_MONITOR
1006 #define AO_MAX_TELEMETRY                128
1007 #else
1008 #define AO_MAX_TELEMETRY                32
1009 #endif
1010
1011 struct ao_telemetry_generic {
1012         uint16_t        serial;         /* 0 */
1013         uint16_t        tick;           /* 2 */
1014         uint8_t         type;           /* 4 */
1015         uint8_t         payload[27];    /* 5 */
1016         /* 32 */
1017 };
1018
1019 #define AO_TELEMETRY_SENSOR_TELEMETRUM  0x01
1020 #define AO_TELEMETRY_SENSOR_TELEMINI    0x02
1021 #define AO_TELEMETRY_SENSOR_TELENANO    0x03
1022
1023 struct ao_telemetry_sensor {
1024         uint16_t        serial;         /*  0 */
1025         uint16_t        tick;           /*  2 */
1026         uint8_t         type;           /*  4 */
1027
1028         uint8_t         state;          /*  5 flight state */
1029         int16_t         accel;          /*  6 accelerometer (TM only) */
1030         int16_t         pres;           /*  8 pressure sensor */
1031         int16_t         temp;           /* 10 temperature sensor */
1032         int16_t         v_batt;         /* 12 battery voltage */
1033         int16_t         sense_d;        /* 14 drogue continuity sense (TM/Tm) */
1034         int16_t         sense_m;        /* 16 main continuity sense (TM/Tm) */
1035
1036         int16_t         acceleration;   /* 18 m/s² * 16 */
1037         int16_t         speed;          /* 20 m/s * 16 */
1038         int16_t         height;         /* 22 m */
1039
1040         int16_t         ground_pres;    /* 24 average pres on pad */
1041         int16_t         ground_accel;   /* 26 average accel on pad */
1042         int16_t         accel_plus_g;   /* 28 accel calibration at +1g */
1043         int16_t         accel_minus_g;  /* 30 accel calibration at -1g */
1044         /* 32 */
1045 };
1046
1047 #define AO_TELEMETRY_CONFIGURATION      0x04
1048
1049 struct ao_telemetry_configuration {
1050         uint16_t        serial;                         /*  0 */
1051         uint16_t        tick;                           /*  2 */
1052         uint8_t         type;                           /*  4 */
1053
1054         uint8_t         device;                         /*  5 device type */
1055         uint16_t        flight;                         /*  6 flight number */
1056         uint8_t         config_major;                   /*  8 Config major version */
1057         uint8_t         config_minor;                   /*  9 Config minor version */
1058         uint16_t        apogee_delay;                   /* 10 Apogee deploy delay in seconds */
1059         uint16_t        main_deploy;                    /* 12 Main deploy alt in meters */
1060         uint16_t        flight_log_max;                 /* 14 Maximum flight log size in kB */
1061         char            callsign[AO_MAX_CALLSIGN];      /* 16 Radio operator identity */
1062         char            version[AO_MAX_VERSION];        /* 24 Software version */
1063         /* 32 */
1064 };
1065
1066 #define AO_TELEMETRY_LOCATION           0x05
1067
1068 #define AO_GPS_MODE_NOT_VALID           'N'
1069 #define AO_GPS_MODE_AUTONOMOUS          'A'
1070 #define AO_GPS_MODE_DIFFERENTIAL        'D'
1071 #define AO_GPS_MODE_ESTIMATED           'E'
1072 #define AO_GPS_MODE_MANUAL              'M'
1073 #define AO_GPS_MODE_SIMULATED           'S'
1074
1075 struct ao_telemetry_location {
1076         uint16_t        serial;         /*  0 */
1077         uint16_t        tick;           /*  2 */
1078         uint8_t         type;           /*  4 */
1079
1080         uint8_t         flags;          /*  5 Number of sats and other flags */
1081         int16_t         altitude;       /*  6 GPS reported altitude (m) */
1082         int32_t         latitude;       /*  8 latitude (degrees * 10⁷) */
1083         int32_t         longitude;      /* 12 longitude (degrees * 10⁷) */
1084         uint8_t         year;           /* 16 (- 2000) */
1085         uint8_t         month;          /* 17 (1-12) */
1086         uint8_t         day;            /* 18 (1-31) */
1087         uint8_t         hour;           /* 19 (0-23) */
1088         uint8_t         minute;         /* 20 (0-59) */
1089         uint8_t         second;         /* 21 (0-59) */
1090         uint8_t         pdop;           /* 22 (m * 5) */
1091         uint8_t         hdop;           /* 23 (m * 5) */
1092         uint8_t         vdop;           /* 24 (m * 5) */
1093         uint8_t         mode;           /* 25 */
1094         uint16_t        ground_speed;   /* 26 cm/s */
1095         int16_t         climb_rate;     /* 28 cm/s */
1096         uint8_t         course;         /* 30 degrees / 2 */
1097         uint8_t         unused[1];      /* 31 */
1098         /* 32 */
1099 };
1100
1101 #define AO_TELEMETRY_SATELLITE          0x06
1102
1103 struct ao_telemetry_satellite_info {
1104         uint8_t         svid;
1105         uint8_t         c_n_1;
1106 };
1107
1108 struct ao_telemetry_satellite {
1109         uint16_t                                serial;         /*  0 */
1110         uint16_t                                tick;           /*  2 */
1111         uint8_t                                 type;           /*  4 */
1112         uint8_t                                 channels;       /*  5 number of reported sats */
1113
1114         struct ao_telemetry_satellite_info      sats[12];       /* 6 */
1115         uint8_t                                 unused[2];      /* 30 */
1116         /* 32 */
1117 };
1118
1119 #define AO_TELEMETRY_COMPANION          0x07
1120
1121 #define AO_COMPANION_MAX_CHANNELS       12
1122
1123 struct ao_telemetry_companion {
1124         uint16_t                                serial;         /*  0 */
1125         uint16_t                                tick;           /*  2 */
1126         uint8_t                                 type;           /*  4 */
1127         uint8_t                                 board_id;       /*  5 */
1128
1129         uint8_t                                 update_period;  /*  6 */
1130         uint8_t                                 channels;       /*  7 */
1131         uint16_t                                companion_data[AO_COMPANION_MAX_CHANNELS];      /*  8 */
1132         /* 32 */
1133 };
1134
1135 /* #define AO_SEND_ALL_BARO */
1136
1137 #define AO_TELEMETRY_BARO               0x80
1138
1139 /*
1140  * This packet allows the full sampling rate baro
1141  * data to be captured over the RF link so that the
1142  * flight software can be tested using 'real' data.
1143  *
1144  * Along with this telemetry packet, the flight
1145  * code is modified to send full-rate telemetry all the time
1146  * and never send an RDF tone; this ensure that the full radio
1147  * link is available.
1148  */
1149 struct ao_telemetry_baro {
1150         uint16_t                                serial;         /*  0 */
1151         uint16_t                                tick;           /*  2 */
1152         uint8_t                                 type;           /*  4 */
1153         uint8_t                                 samples;        /*  5 number samples */
1154
1155         int16_t                                 baro[12];       /* 6 samples */
1156         /* 32 */
1157 };
1158
1159 union ao_telemetry_all {
1160         struct ao_telemetry_generic             generic;
1161         struct ao_telemetry_sensor              sensor;
1162         struct ao_telemetry_configuration       configuration;
1163         struct ao_telemetry_location            location;
1164         struct ao_telemetry_satellite           satellite;
1165         struct ao_telemetry_companion           companion;
1166         struct ao_telemetry_baro                baro;
1167 };
1168
1169 struct ao_telemetry_all_recv {
1170         union ao_telemetry_all          telemetry;
1171         int8_t                          rssi;
1172         uint8_t                         status;
1173 };
1174
1175 /*
1176  * ao_gps.c
1177  */
1178
1179 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
1180 #define AO_GPS_NUM_SAT_SHIFT    (0)
1181
1182 #define AO_GPS_VALID            (1 << 4)
1183 #define AO_GPS_RUNNING          (1 << 5)
1184 #define AO_GPS_DATE_VALID       (1 << 6)
1185 #define AO_GPS_COURSE_VALID     (1 << 7)
1186
1187 extern __pdata uint16_t ao_gps_tick;
1188 extern __xdata uint8_t ao_gps_mutex;
1189 extern __xdata struct ao_telemetry_location ao_gps_data;
1190 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
1191
1192 struct ao_gps_orig {
1193         uint8_t                 year;
1194         uint8_t                 month;
1195         uint8_t                 day;
1196         uint8_t                 hour;
1197         uint8_t                 minute;
1198         uint8_t                 second;
1199         uint8_t                 flags;
1200         int32_t                 latitude;       /* degrees * 10⁷ */
1201         int32_t                 longitude;      /* degrees * 10⁷ */
1202         int16_t                 altitude;       /* m */
1203         uint16_t                ground_speed;   /* cm/s */
1204         uint8_t                 course;         /* degrees / 2 */
1205         uint8_t                 hdop;           /* * 5 */
1206         int16_t                 climb_rate;     /* cm/s */
1207         uint16_t                h_error;        /* m */
1208         uint16_t                v_error;        /* m */
1209 };
1210
1211 struct ao_gps_sat_orig {
1212         uint8_t         svid;
1213         uint8_t         c_n_1;
1214 };
1215
1216 #define AO_MAX_GPS_TRACKING     12
1217
1218 struct ao_gps_tracking_orig {
1219         uint8_t                 channels;
1220         struct ao_gps_sat_orig  sats[AO_MAX_GPS_TRACKING];
1221 };
1222
1223 void
1224 ao_gps(void);
1225
1226 void
1227 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
1228
1229 void
1230 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
1231
1232 void
1233 ao_gps_init(void);
1234
1235 /*
1236  * ao_gps_report.c
1237  */
1238
1239 void
1240 ao_gps_report(void);
1241
1242 void
1243 ao_gps_report_init(void);
1244
1245 /*
1246  * ao_telemetry_orig.c
1247  */
1248
1249 struct ao_telemetry_orig {
1250         uint16_t                serial;
1251         uint16_t                flight;
1252         uint8_t                 flight_state;
1253         int16_t                 accel;
1254         int16_t                 ground_accel;
1255         union {
1256                 struct {
1257                         int16_t                 speed;
1258                         int16_t                 unused;
1259                 } k;
1260                 int32_t         flight_vel;
1261         } u;
1262         int16_t                 height;
1263         int16_t                 ground_pres;
1264         int16_t                 accel_plus_g;
1265         int16_t                 accel_minus_g;
1266         struct ao_adc           adc;
1267         struct ao_gps_orig      gps;
1268         char                    callsign[AO_MAX_CALLSIGN];
1269         struct ao_gps_tracking_orig     gps_tracking;
1270 };
1271
1272 struct ao_telemetry_tiny {
1273         uint16_t                serial;
1274         uint16_t                flight;
1275         uint8_t                 flight_state;
1276         int16_t                 height;         /* AGL in meters */
1277         int16_t                 speed;          /* in m/s * 16 */
1278         int16_t                 accel;          /* in m/s² * 16 */
1279         int16_t                 ground_pres;    /* sensor units */
1280         struct ao_adc           adc;            /* raw ADC readings */
1281         char                    callsign[AO_MAX_CALLSIGN];
1282 };
1283
1284 struct ao_telemetry_orig_recv {
1285         struct ao_telemetry_orig        telemetry_orig;
1286         int8_t                          rssi;
1287         uint8_t                         status;
1288 };
1289
1290 struct ao_telemetry_tiny_recv {
1291         struct ao_telemetry_tiny        telemetry_tiny;
1292         int8_t                          rssi;
1293         uint8_t                         status;
1294 };
1295
1296 /*
1297  * ao_radio_recv tacks on rssi and status bytes
1298  */
1299
1300 struct ao_telemetry_raw_recv {
1301         uint8_t                 packet[AO_MAX_TELEMETRY + 2];
1302 };
1303
1304 /* Set delay between telemetry reports (0 to disable) */
1305
1306 #ifdef AO_SEND_ALL_BARO
1307 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(100)
1308 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
1309 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(100)
1310 #else
1311 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
1312 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
1313 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
1314 #endif
1315
1316 void
1317 ao_telemetry_set_interval(uint16_t interval);
1318
1319 void
1320 ao_rdf_set(uint8_t rdf);
1321
1322 void
1323 ao_telemetry_init(void);
1324
1325 void
1326 ao_telemetry_orig_init(void);
1327
1328 void
1329 ao_telemetry_tiny_init(void);
1330
1331 /*
1332  * ao_radio.c
1333  */
1334
1335 extern __xdata uint8_t  ao_radio_dma;
1336 extern __xdata uint8_t ao_radio_dma_done;
1337 extern __xdata uint8_t ao_radio_done;
1338 extern __xdata uint8_t ao_radio_mutex;
1339
1340 void
1341 ao_radio_general_isr(void) ao_arch_interrupt(16);
1342
1343 void
1344 ao_radio_get(uint8_t len);
1345
1346 #define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
1347
1348 void
1349 ao_radio_set_packet(void);
1350
1351 void
1352 ao_radio_send(__xdata void *data, uint8_t size) __reentrant;
1353
1354 uint8_t
1355 ao_radio_recv(__xdata void *data, uint8_t size) __reentrant;
1356
1357 void
1358 ao_radio_recv_abort(void);
1359
1360 /*
1361  * Compute the packet length as follows:
1362  *
1363  * 2000 bps (for a 1kHz tone)
1364  * so, for 'ms' milliseconds, we need
1365  * 2 * ms bits, or ms / 4 bytes
1366  */
1367
1368 #define AO_MS_TO_RDF_LEN(ms) ((ms) > 255 * 4 ? 255 : ((ms) >> 2))
1369
1370 void
1371 ao_radio_rdf(uint8_t pkt_len);
1372
1373 void
1374 ao_radio_rdf_abort(void);
1375
1376 void
1377 ao_radio_idle(void);
1378
1379 void
1380 ao_radio_init(void);
1381
1382 /*
1383  * ao_monitor.c
1384  */
1385
1386 extern const char const * const ao_state_names[];
1387
1388 #define AO_MONITOR_RING 8
1389
1390 union ao_monitor {
1391         struct ao_telemetry_raw_recv    raw;
1392         struct ao_telemetry_all_recv    all;
1393         struct ao_telemetry_orig_recv   orig;
1394         struct ao_telemetry_tiny_recv   tiny;
1395 };
1396
1397 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
1398
1399 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
1400
1401 extern __data uint8_t ao_monitoring;
1402 extern __data uint8_t ao_monitor_head;
1403
1404 void
1405 ao_monitor(void);
1406
1407 #define AO_MONITORING_OFF       0
1408 #define AO_MONITORING_ORIG      1
1409 #define AO_MONITORING_TINY      2
1410
1411 void
1412 ao_set_monitor(uint8_t monitoring);
1413
1414 void
1415 ao_monitor_init(uint8_t led, uint8_t monitoring) __reentrant;
1416
1417 /*
1418  * ao_stdio.c
1419  */
1420
1421 #define AO_READ_AGAIN   ((char) -1)
1422
1423 struct ao_stdio {
1424         char    (*pollchar)(void);
1425         void    (*putchar)(char c) __reentrant;
1426         void    (*flush)(void);
1427         uint8_t echo;
1428 };
1429
1430 extern __xdata struct ao_stdio ao_stdios[];
1431 extern __pdata int8_t ao_cur_stdio;
1432 extern __pdata int8_t ao_num_stdios;
1433
1434 void
1435 flush(void);
1436
1437 extern __xdata uint8_t ao_stdin_ready;
1438
1439 uint8_t
1440 ao_echo(void);
1441
1442 int8_t
1443 ao_add_stdio(char (*pollchar)(void),
1444              void (*putchar)(char) __reentrant,
1445              void (*flush)(void)) __reentrant;
1446
1447 /*
1448  * ao_ignite.c
1449  */
1450
1451 enum ao_igniter {
1452         ao_igniter_drogue = 0,
1453         ao_igniter_main = 1
1454 };
1455
1456 void
1457 ao_ignite(enum ao_igniter igniter);
1458
1459 enum ao_igniter_status {
1460         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
1461         ao_igniter_ready,       /* continuity detected */
1462         ao_igniter_active,      /* igniter firing */
1463         ao_igniter_open,        /* open circuit detected */
1464 };
1465
1466 struct ao_ignition {
1467         uint8_t request;
1468         uint8_t fired;
1469         uint8_t firing;
1470 };
1471
1472 extern __xdata struct ao_ignition ao_ignition[2];
1473
1474 enum ao_igniter_status
1475 ao_igniter_status(enum ao_igniter igniter);
1476
1477 extern __pdata uint8_t ao_igniter_present;
1478
1479 void
1480 ao_ignite_set_pins(void);
1481
1482 void
1483 ao_igniter_init(void);
1484
1485 /*
1486  * ao_config.c
1487  */
1488
1489 #define AO_CONFIG_MAJOR 1
1490 #define AO_CONFIG_MINOR 9
1491 #define AO_AES_LEN 16
1492
1493 struct ao_config {
1494         uint8_t         major;
1495         uint8_t         minor;
1496         uint16_t        main_deploy;
1497         int16_t         accel_plus_g;           /* changed for minor version 2 */
1498         uint8_t         radio_channel;
1499         char            callsign[AO_MAX_CALLSIGN + 1];
1500         uint8_t         apogee_delay;           /* minor version 1 */
1501         int16_t         accel_minus_g;          /* minor version 2 */
1502         uint32_t        radio_cal;              /* minor version 3 */
1503         uint32_t        flight_log_max;         /* minor version 4 */
1504         uint8_t         ignite_mode;            /* minor version 5 */
1505         uint8_t         pad_orientation;        /* minor version 6 */
1506         uint32_t        radio_setting;          /* minor version 7 */
1507         uint8_t         radio_enable;           /* minor version 8 */
1508         uint8_t         aes_key[AO_AES_LEN];    /* minor version 9 */
1509 };
1510
1511 #define AO_IGNITE_MODE_DUAL             0
1512 #define AO_IGNITE_MODE_APOGEE           1
1513 #define AO_IGNITE_MODE_MAIN             2
1514
1515 #define AO_PAD_ORIENTATION_ANTENNA_UP   0
1516 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
1517
1518 extern __xdata struct ao_config ao_config;
1519
1520 #define AO_CONFIG_MAX_SIZE      128
1521
1522 void
1523 ao_config_get(void);
1524
1525 void
1526 ao_config_put(void);
1527
1528 void
1529 ao_config_init(void);
1530
1531 /*
1532  * ao_rssi.c
1533  */
1534
1535 void
1536 ao_rssi_set(int rssi_value);
1537
1538 void
1539 ao_rssi_init(uint8_t rssi_led);
1540
1541 /*
1542  * ao_product.c
1543  *
1544  * values which need to be defined for
1545  * each instance of a product
1546  */
1547
1548 extern const char ao_version[];
1549 extern const char ao_manufacturer[];
1550 extern const char ao_product[];
1551
1552 /*
1553  * Fifos
1554  */
1555
1556 #define AO_FIFO_SIZE    32
1557
1558 struct ao_fifo {
1559         uint8_t insert;
1560         uint8_t remove;
1561         char    fifo[AO_FIFO_SIZE];
1562 };
1563
1564 #define ao_fifo_insert(f,c) do { \
1565         (f).fifo[(f).insert] = (c); \
1566         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
1567 } while(0)
1568
1569 #define ao_fifo_remove(f,c) do {\
1570         c = (f).fifo[(f).remove]; \
1571         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
1572 } while(0)
1573
1574 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
1575 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
1576
1577 /*
1578  * ao_packet.c
1579  *
1580  * Packet-based command interface
1581  */
1582
1583 #define AO_PACKET_MAX           64
1584 #define AO_PACKET_SYN           (uint8_t) 0xff
1585
1586 struct ao_packet {
1587         uint8_t         addr;
1588         uint8_t         len;
1589         uint8_t         seq;
1590         uint8_t         ack;
1591         uint8_t         d[AO_PACKET_MAX];
1592         uint8_t         callsign[AO_MAX_CALLSIGN];
1593 };
1594
1595 struct ao_packet_recv {
1596         struct ao_packet        packet;
1597         int8_t                  rssi;
1598         uint8_t                 status;
1599 };
1600
1601 extern __xdata struct ao_packet_recv ao_rx_packet;
1602 extern __xdata struct ao_packet ao_tx_packet;
1603 extern __xdata struct ao_task   ao_packet_task;
1604 extern __xdata uint8_t ao_packet_enable;
1605 extern __xdata uint8_t ao_packet_master_sleeping;
1606 extern __pdata uint8_t ao_packet_rx_len, ao_packet_rx_used, ao_packet_tx_used;
1607
1608 void
1609 ao_packet_send(void);
1610
1611 uint8_t
1612 ao_packet_recv(void);
1613
1614 void
1615 ao_packet_flush(void);
1616
1617 void
1618 ao_packet_putchar(char c) __reentrant;
1619
1620 char
1621 ao_packet_pollchar(void) __critical;
1622
1623 /* ao_packet_master.c */
1624
1625 void
1626 ao_packet_master_init(void);
1627
1628 /* ao_packet_slave.c */
1629
1630 void
1631 ao_packet_slave_start(void);
1632
1633 void
1634 ao_packet_slave_stop(void);
1635
1636 void
1637 ao_packet_slave_init(uint8_t enable);
1638
1639 /* ao_btm.c */
1640
1641 /* If bt_link is on P2, this interrupt is shared by USB, so the USB
1642  * code calls this function. Otherwise, it's a regular ISR.
1643  */
1644
1645 void
1646 ao_btm_isr(void)
1647 #if BT_LINK_ON_P1
1648         __interrupt 15
1649 #endif
1650         ;
1651
1652 void
1653 ao_btm_init(void);
1654
1655 /* ao_companion.c */
1656
1657 #define AO_COMPANION_SETUP              1
1658 #define AO_COMPANION_FETCH              2
1659 #define AO_COMPANION_NOTIFY             3
1660
1661 struct ao_companion_command {
1662         uint8_t         command;
1663         uint8_t         flight_state;
1664         uint16_t        tick;
1665         uint16_t        serial;
1666         uint16_t        flight;
1667 };
1668
1669 struct ao_companion_setup {
1670         uint16_t        board_id;
1671         uint16_t        board_id_inverse;
1672         uint8_t         update_period;
1673         uint8_t         channels;
1674 };
1675
1676 extern __pdata uint8_t                          ao_companion_running;
1677 extern __xdata uint8_t                          ao_companion_mutex;
1678 extern __xdata struct ao_companion_command      ao_companion_command;
1679 extern __xdata struct ao_companion_setup        ao_companion_setup;
1680 extern __xdata uint16_t                         ao_companion_data[AO_COMPANION_MAX_CHANNELS];
1681
1682 void
1683 ao_companion_init(void);
1684
1685 /* ao_lcd.c */
1686
1687 void
1688 ao_lcd_putchar(uint8_t data);
1689
1690 void
1691 ao_lcd_putstring(char *string);
1692
1693 void
1694 ao_lcd_contrast_set(uint8_t contrast);
1695
1696 void
1697 ao_lcd_clear(void);
1698
1699 #define AO_LCD_ADDR(row,col)    ((row << 6) | (col))
1700
1701 void
1702 ao_lcd_goto(uint8_t addr);
1703
1704 void
1705 ao_lcd_start(void);
1706
1707 void
1708 ao_lcd_init(void);
1709
1710 /* ao_lcd_port.c */
1711
1712 void
1713 ao_lcd_port_put_nibble(uint8_t rs, uint8_t data);
1714
1715 void
1716 ao_lcd_port_init(void);
1717
1718 /* ao_aes.c */
1719
1720 __xdata uint8_t ao_aes_mutex;
1721
1722 /* AES keys and blocks are 128 bits */
1723
1724 enum ao_aes_mode {
1725         ao_aes_mode_cbc_mac
1726 };
1727
1728 #if HAS_AES
1729 void
1730 ao_aes_isr(void) __interrupt 4;
1731 #endif
1732
1733 void
1734 ao_aes_set_mode(enum ao_aes_mode mode);
1735
1736 void
1737 ao_aes_set_key(__xdata uint8_t *in);
1738
1739 void
1740 ao_aes_zero_iv(void);
1741
1742 void
1743 ao_aes_run(__xdata uint8_t *in,
1744            __xdata uint8_t *out);
1745
1746 void
1747 ao_aes_init(void);
1748
1749 /* ao_radio_cmac.c */
1750
1751 int8_t
1752 ao_radio_cmac_send(__xdata void *packet, uint8_t len) __reentrant;
1753
1754 #define AO_RADIO_CMAC_OK        0
1755 #define AO_RADIO_CMAC_LEN_ERROR -1
1756 #define AO_RADIO_CMAC_CRC_ERROR -2
1757 #define AO_RADIO_CMAC_MAC_ERROR -3
1758 #define AO_RADIO_CMAC_TIMEOUT   -4
1759
1760 int8_t
1761 ao_radio_cmac_recv(__xdata void *packet, uint8_t len, uint16_t timeout) __reentrant;
1762
1763 void
1764 ao_radio_cmac_init(void);
1765
1766 /* ao_launch.c */
1767
1768 struct ao_launch_command {
1769         uint16_t        tick;
1770         uint16_t        serial;
1771         uint8_t         cmd;
1772         uint8_t         channel;
1773         uint16_t        unused;
1774 };
1775
1776 #define AO_LAUNCH_QUERY         1
1777
1778 struct ao_launch_query {
1779         uint16_t        tick;
1780         uint16_t        serial;
1781         uint8_t         channel;
1782         uint8_t         valid;
1783         uint8_t         arm_status;
1784         uint8_t         igniter_status;
1785 };
1786
1787 #define AO_LAUNCH_ARM           2
1788 #define AO_LAUNCH_FIRE          3
1789
1790 void
1791 ao_launch_init(void);
1792
1793 /*
1794  * ao_log_single.c
1795  */
1796
1797 #define AO_LOG_TELESCIENCE_START        ((uint8_t) 's')
1798 #define AO_LOG_TELESCIENCE_DATA         ((uint8_t) 'd')
1799
1800 #define AO_LOG_TELESCIENCE_NUM_ADC      12
1801
1802 struct ao_log_telescience {
1803         uint8_t         type;
1804         uint8_t         csum;
1805         uint16_t        tick;
1806         uint16_t        tm_tick;
1807         uint8_t         tm_state;
1808         uint8_t         unused;
1809         uint16_t        adc[AO_LOG_TELESCIENCE_NUM_ADC];
1810 };
1811
1812 #define AO_LOG_SINGLE_SIZE              32
1813
1814 union ao_log_single {
1815         struct ao_log_telescience       telescience;
1816         union ao_telemetry_all          telemetry;
1817         uint8_t                         bytes[AO_LOG_SINGLE_SIZE];
1818 };
1819
1820 extern __xdata union ao_log_single      ao_log_single_write_data;
1821 extern __xdata union ao_log_single      ao_log_single_read_data;
1822
1823 void
1824 ao_log_single_extra_query(void);
1825
1826 void
1827 ao_log_single_list(void);
1828
1829 void
1830 ao_log_single_main(void);
1831
1832 uint8_t
1833 ao_log_single_write(void);
1834
1835 uint8_t
1836 ao_log_single_read(uint32_t pos);
1837
1838 void
1839 ao_log_single_start(void);
1840
1841 void
1842 ao_log_single_stop(void);
1843
1844 void
1845 ao_log_single_restart(void);
1846
1847 void
1848 ao_log_single_set(void);
1849
1850 void
1851 ao_log_single_delete(void);
1852
1853 void
1854 ao_log_single_init(void);
1855
1856 void
1857 ao_log_single(void);
1858
1859 /*
1860  * ao_pyro_slave.c
1861  */
1862
1863 #define AO_TELEPYRO_NUM_ADC     9
1864
1865 #ifndef ao_xmemcpy
1866 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
1867 #define ao_xmemset(d,v,c) memset(d,v,c)
1868 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
1869 #endif
1870
1871 /*
1872  * ao_terraui.c
1873  */
1874
1875 void
1876 ao_terraui_init(void);
1877
1878 /*
1879  * ao_battery.c
1880  */
1881
1882 #ifdef BATTERY_PIN
1883 void
1884 ao_battery_isr(void) ao_arch_interrupt(1);
1885
1886 uint16_t
1887 ao_battery_get(void);
1888
1889 void
1890 ao_battery_init(void);
1891 #endif /* BATTERY_PIN */
1892
1893 /*
1894  * ao_sqrt.c
1895  */
1896
1897 uint32_t
1898 ao_sqrt(uint32_t op);
1899
1900 #endif /* _AO_H_ */