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