git.gag.com Git - fw/altos/blob - src/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 "cc1111.h"
  26 #include "ao_pins.h"
  27
  28 #define TRUE 1
  29 #define FALSE 0
  30
  31 /* Convert a __data pointer into an __xdata pointer */
  32 #define DATA_TO_XDATA(a)        ((void __xdata *) ((uint8_t) (a) | 0xff00))
  33
  34 /* Stack runs from above the allocated __data space to 0xfe, which avoids
  35  * writing to 0xff as that triggers the stack overflow indicator
  36  */
  37 #define AO_STACK_START  0x90
  38 #define AO_STACK_END    0xfe
  39 #define AO_STACK_SIZE   (AO_STACK_END - AO_STACK_START + 1)
  40
  41 /* An AltOS task */
  42 struct ao_task {
  43         __xdata void *wchan;            /* current wait channel (NULL if running) */
  44         uint16_t alarm;                 /* abort ao_sleep time */
  45         uint8_t stack_count;            /* amount of saved stack */
  46         uint8_t task_id;                /* unique id */
  47         __code char *name;              /* task name */
  48         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  49 };
  50
  51 extern __xdata struct ao_task *__data ao_cur_task;
  52
  53 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  54 #define AO_NO_TASK              0       /* no task id */
  55
  56 /*
  57  ao_task.c
  58  */
  59
  60 /* Suspend the current task until wchan is awoken.
  61  * returns:
  62  *  0 on normal wake
  63  *  1 on alarm
  64  */
  65 uint8_t
  66 ao_sleep(__xdata void *wchan);
  67
  68 /* Wake all tasks sleeping on wchan */
  69 void
  70 ao_wakeup(__xdata void *wchan);
  71
  72 /* set an alarm to go off in 'delay' ticks */
  73 void
  74 ao_alarm(uint16_t delay);
  75
  76 /* Yield the processor to another task */
  77 void
  78 ao_yield(void) __naked;
  79
  80 /* Add a task to the run queue */
  81 void
  82 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
  83
  84 /* Terminate the current task */
  85 void
  86 ao_exit(void);
  87
  88 /* Dump task info to console */
  89 void
  90 ao_task_info(void);
  91
  92 /* Start the scheduler. This will not return */
  93 void
  94 ao_start_scheduler(void);
  95
  96 /*
  97  * ao_panic.c
  98  */
  99
 100 #define AO_PANIC_NO_TASK        1       /* AO_NUM_TASKS is not large enough */
 101 #define AO_PANIC_DMA            2       /* Attempt to start DMA while active */
 102 #define AO_PANIC_MUTEX          3       /* Mis-using mutex API */
 103 #define AO_PANIC_EE             4       /* Mis-using eeprom API */
 104 #define AO_PANIC_LOG            5       /* Failing to read/write log data */
 105 #define AO_PANIC_CMD            6       /* Too many command sets registered */
 106 #define AO_PANIC_STDIO          7       /* Too many stdio handlers registered */
 107 #define AO_PANIC_REBOOT         8       /* Reboot failed */
 108 #define AO_PANIC_FLASH          9       /* Invalid flash part (or wrong blocksize) */
 109 #define AO_PANIC_USB            10      /* Trying to send USB packet while busy */
 110 #define AO_PANIC_BT             11      /* Communications with bluetooth device failed */
 111
 112 /* Stop the operating system, beeping and blinking the reason */
 113 void
 114 ao_panic(uint8_t reason);
 115
 116 /*
 117  * ao_timer.c
 118  */
 119
 120 /* Our timer runs at 100Hz */
 121 #define AO_HERTZ                100
 122 #define AO_MS_TO_TICKS(ms)      ((ms) / (1000 / AO_HERTZ))
 123 #define AO_SEC_TO_TICKS(s)      ((s) * AO_HERTZ)
 124
 125 /* Returns the current time in ticks */
 126 uint16_t
 127 ao_time(void);
 128
 129 /* Suspend the current task until ticks time has passed */
 130 void
 131 ao_delay(uint16_t ticks);
 132
 133 /* Set the ADC interval */
 134 void
 135 ao_timer_set_adc_interval(uint8_t interval) __critical;
 136
 137 /* Timer interrupt */
 138 void
 139 ao_timer_isr(void) __interrupt 9;
 140
 141 /* Initialize the timer */
 142 void
 143 ao_timer_init(void);
 144
 145 /* Initialize the hardware clock. Must be called first */
 146 void
 147 ao_clock_init(void);
 148
 149 /*
 150  * One set of samples read from the A/D converter or telemetry
 151  */
 152 struct ao_adc {
 153         uint16_t        tick;           /* tick when the sample was read */
 154         int16_t         accel;          /* accelerometer */
 155         int16_t         pres;           /* pressure sensor */
 156         int16_t         temp;           /* temperature sensor */
 157         int16_t         v_batt;         /* battery voltage */
 158         int16_t         sense_d;        /* drogue continuity sense */
 159         int16_t         sense_m;        /* main continuity sense */
 160 };
 161
 162 #ifndef HAS_ADC
 163 #error Please define HAS_ADC
 164 #endif
 165
 166 #if HAS_ADC
 167
 168 #if HAS_ACCEL
 169 #ifndef HAS_ACCEL_REF
 170 #error Please define HAS_ACCEL_REF
 171 #endif
 172 #else
 173 #define HAS_ACCEL_REF 0
 174 #endif
 175
 176 /*
 177  * ao_adc.c
 178  */
 179
 180 #define AO_ADC_RING     32
 181 #define ao_adc_ring_next(n)     (((n) + 1) & (AO_ADC_RING - 1))
 182 #define ao_adc_ring_prev(n)     (((n) - 1) & (AO_ADC_RING - 1))
 183
 184
 185 /*
 186  * A/D data is stored in a ring, with the next sample to be written
 187  * at ao_adc_head
 188  */
 189 extern volatile __xdata struct ao_adc   ao_adc_ring[AO_ADC_RING];
 190 extern volatile __data uint8_t          ao_adc_head;
 191 #if HAS_ACCEL_REF
 192 extern volatile __xdata uint16_t        ao_accel_ref[AO_ADC_RING];
 193 #endif
 194
 195 /* Trigger a conversion sequence (called from the timer interrupt) */
 196 void
 197 ao_adc_poll(void);
 198
 199 /* Suspend the current task until another A/D sample is converted */
 200 void
 201 ao_adc_sleep(void);
 202
 203 /* Get a copy of the last complete A/D sample set */
 204 void
 205 ao_adc_get(__xdata struct ao_adc *packet);
 206
 207 /* The A/D interrupt handler */
 208
 209 void
 210 ao_adc_isr(void) __interrupt 1;
 211
 212 /* Initialize the A/D converter */
 213 void
 214 ao_adc_init(void);
 215
 216 #endif /* HAS_ADC */
 217
 218 /*
 219  * ao_beep.c
 220  */
 221
 222 /*
 223  * Various pre-defined beep frequencies
 224  *
 225  * frequency = 1/2 (24e6/32) / beep
 226  */
 227
 228 #define AO_BEEP_LOW     150     /* 2500Hz */
 229 #define AO_BEEP_MID     94      /* 3989Hz */
 230 #define AO_BEEP_HIGH    75      /* 5000Hz */
 231 #define AO_BEEP_OFF     0       /* off */
 232
 233 #define AO_BEEP_g       240     /* 1562.5Hz */
 234 #define AO_BEEP_gs      227     /* 1652Hz (1655Hz) */
 235 #define AO_BEEP_aa      214     /* 1752Hz (1754Hz) */
 236 #define AO_BEEP_bbf     202     /* 1856Hz (1858Hz) */
 237 #define AO_BEEP_bb      190     /* 1974Hz (1969Hz) */
 238 #define AO_BEEP_cc      180     /* 2083Hz (2086Hz) */
 239 #define AO_BEEP_ccs     170     /* 2205Hz (2210Hz) */
 240 #define AO_BEEP_dd      160     /* 2344Hz (2341Hz) */
 241 #define AO_BEEP_eef     151     /* 2483Hz (2480Hz) */
 242 #define AO_BEEP_ee      143     /* 2622Hz (2628Hz) */
 243 #define AO_BEEP_ff      135     /* 2778Hz (2784Hz) */
 244 #define AO_BEEP_ffs     127     /* 2953Hz (2950Hz) */
 245 #define AO_BEEP_gg      120     /* 3125Hz */
 246 #define AO_BEEP_ggs     113     /* 3319Hz (3311Hz) */
 247 #define AO_BEEP_aaa     107     /* 3504Hz (3508Hz) */
 248 #define AO_BEEP_bbbf    101     /* 3713Hz (3716Hz) */
 249 #define AO_BEEP_bbb     95      /* 3947Hz (3937Hz) */
 250 #define AO_BEEP_ccc     90      /* 4167Hz (4171Hz) */
 251 #define AO_BEEP_cccs    85      /* 4412Hz (4419Hz) */
 252 #define AO_BEEP_ddd     80      /* 4688Hz (4682Hz) */
 253 #define AO_BEEP_eeef    76      /* 4934Hz (4961Hz) */
 254 #define AO_BEEP_eee     71      /* 5282Hz (5256Hz) */
 255 #define AO_BEEP_fff     67      /* 5597Hz (5568Hz) */
 256 #define AO_BEEP_fffs    64      /* 5859Hz (5899Hz) */
 257 #define AO_BEEP_ggg     60      /* 6250Hz */
 258
 259 /* Set the beeper to the specified tone */
 260 void
 261 ao_beep(uint8_t beep);
 262
 263 /* Turn on the beeper for the specified time */
 264 void
 265 ao_beep_for(uint8_t beep, uint16_t ticks) __reentrant;
 266
 267 /* Initialize the beeper */
 268 void
 269 ao_beep_init(void);
 270
 271 /*
 272  * ao_led.c
 273  */
 274
 275 #define AO_LED_NONE     0
 276
 277 /* Turn on the specified LEDs */
 278 void
 279 ao_led_on(uint8_t colors);
 280
 281 /* Turn off the specified LEDs */
 282 void
 283 ao_led_off(uint8_t colors);
 284
 285 /* Set all of the LEDs to the specified state */
 286 void
 287 ao_led_set(uint8_t colors);
 288
 289 /* Toggle the specified LEDs */
 290 void
 291 ao_led_toggle(uint8_t colors);
 292
 293 /* Turn on the specified LEDs for the indicated interval */
 294 void
 295 ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
 296
 297 /* Initialize the LEDs */
 298 void
 299 ao_led_init(uint8_t enable);
 300
 301 /*
 302  * ao_romconfig.c
 303  */
 304
 305 #define AO_ROMCONFIG_VERSION    2
 306
 307 extern __code __at (0x00a0) uint16_t ao_romconfig_version;
 308 extern __code __at (0x00a2) uint16_t ao_romconfig_check;
 309 extern __code __at (0x00a4) uint16_t ao_serial_number;
 310 extern __code __at (0x00a6) uint32_t ao_radio_cal;
 311
 312 #ifndef HAS_USB
 313 #error Please define HAS_USB
 314 #endif
 315
 316 #if HAS_USB
 317 extern __code __at (0x00aa) uint8_t ao_usb_descriptors [];
 318 #endif
 319
 320 /*
 321  * ao_usb.c
 322  */
 323
 324 /* Put one character to the USB output queue */
 325 void
 326 ao_usb_putchar(char c);
 327
 328 /* Get one character from the USB input queue */
 329 char
 330 ao_usb_getchar(void);
 331
 332 /* Poll for a charcter on the USB input queue.
 333  * returns AO_READ_AGAIN if none are available
 334  */
 335 char
 336 ao_usb_pollchar(void);
 337
 338 /* Flush the USB output queue */
 339 void
 340 ao_usb_flush(void);
 341
 342 #if HAS_USB
 343 /* USB interrupt handler */
 344 void
 345 ao_usb_isr(void) __interrupt 6;
 346 #endif
 347
 348 /* Enable the USB controller */
 349 void
 350 ao_usb_enable(void);
 351
 352 /* Disable the USB controller */
 353 void
 354 ao_usb_disable(void);
 355
 356 /* Initialize the USB system */
 357 void
 358 ao_usb_init(void);
 359
 360 /*
 361  * ao_cmd.c
 362  */
 363
 364 enum ao_cmd_status {
 365         ao_cmd_success = 0,
 366         ao_cmd_lex_error = 1,
 367         ao_cmd_syntax_error = 2,
 368 };
 369
 370 extern __xdata uint16_t ao_cmd_lex_i;
 371 extern __xdata uint32_t ao_cmd_lex_u32;
 372 extern __xdata char     ao_cmd_lex_c;
 373 extern __xdata enum ao_cmd_status ao_cmd_status;
 374
 375 void
 376 ao_cmd_lex(void);
 377
 378 void
 379 ao_cmd_put8(uint8_t v);
 380
 381 void
 382 ao_cmd_put16(uint16_t v);
 383
 384 void
 385 ao_cmd_white(void);
 386
 387 void
 388 ao_cmd_hex(void);
 389
 390 void
 391 ao_cmd_decimal(void);
 392
 393 uint8_t
 394 ao_match_word(__code char *word);
 395
 396 struct ao_cmds {
 397         void            (*func)(void);
 398         const char      *help;
 399 };
 400
 401 void
 402 ao_cmd_register(__code struct ao_cmds *cmds);
 403
 404 void
 405 ao_cmd_init(void);
 406
 407 #if HAS_CMD_FILTER
 408 /*
 409  * Provided by an external module to filter raw command lines
 410  */
 411 uint8_t
 412 ao_cmd_filter(void);
 413 #endif
 414
 415 /*
 416  * ao_dma.c
 417  */
 418
 419 /* Allocate a DMA channel. the 'done' parameter will be set when the
 420  * dma is finished and will be used to wakeup any waiters
 421  */
 422
 423 uint8_t
 424 ao_dma_alloc(__xdata uint8_t * done);
 425
 426 /* Setup a DMA channel */
 427 void
 428 ao_dma_set_transfer(uint8_t id,
 429                     void __xdata *srcaddr,
 430                     void __xdata *dstaddr,
 431                     uint16_t count,
 432                     uint8_t cfg0,
 433                     uint8_t cfg1);
 434
 435 /* Start a DMA channel */
 436 void
 437 ao_dma_start(uint8_t id);
 438
 439 /* Manually trigger a DMA channel */
 440 void
 441 ao_dma_trigger(uint8_t id);
 442
 443 /* Abort a running DMA transfer */
 444 void
 445 ao_dma_abort(uint8_t id);
 446
 447 /* DMA interrupt routine */
 448 void
 449 ao_dma_isr(void) __interrupt 8;
 450
 451 /*
 452  * ao_mutex.c
 453  */
 454
 455 void
 456 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
 457
 458 void
 459 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 460
 461 /*
 462  * Storage interface, provided by one of the eeprom or flash
 463  * drivers
 464  */
 465
 466 /* Total bytes of available storage */
 467 extern __xdata uint32_t ao_storage_total;
 468
 469 /* Block size - device is erased in these units. At least 256 bytes */
 470 extern __xdata uint32_t ao_storage_block;
 471
 472 /* Byte offset of config block. Will be ao_storage_block bytes long */
 473 extern __xdata uint32_t ao_storage_config;
 474
 475 /* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
 476 extern __xdata uint16_t ao_storage_unit;
 477
 478 #define AO_STORAGE_ERASE_LOG    (ao_storage_config + AO_CONFIG_MAX_SIZE)
 479
 480 /* Initialize above values. Can only be called once the OS is running */
 481 void
 482 ao_storage_setup(void) __reentrant;
 483
 484 /* Write data. Returns 0 on failure, 1 on success */
 485 uint8_t
 486 ao_storage_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 487
 488 /* Read data. Returns 0 on failure, 1 on success */
 489 uint8_t
 490 ao_storage_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 491
 492 /* Erase a block of storage. This always clears ao_storage_block bytes */
 493 uint8_t
 494 ao_storage_erase(uint32_t pos) __reentrant;
 495
 496 /* Flush any pending writes to stable storage */
 497 void
 498 ao_storage_flush(void) __reentrant;
 499
 500 /* Initialize the storage code */
 501 void
 502 ao_storage_init(void);
 503
 504 /*
 505  * Low-level functions wrapped by ao_storage.c
 506  */
 507
 508 /* Read data within a storage unit */
 509 uint8_t
 510 ao_storage_device_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 511
 512 /* Write data within a storage unit */
 513 uint8_t
 514 ao_storage_device_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 515
 516 /* Initialize low-level device bits */
 517 void
 518 ao_storage_device_init(void);
 519
 520 /* Print out information about flash chips */
 521 void
 522 ao_storage_device_info(void) __reentrant;
 523
 524 /*
 525  * ao_log.c
 526  */
 527
 528 /* We record flight numbers in the first record of
 529  * the log. Tasks may wait for this to be initialized
 530  * by sleeping on this variable.
 531  */
 532 extern __xdata uint16_t ao_flight_number;
 533
 534 extern __pdata uint32_t ao_log_current_pos;
 535 extern __pdata uint32_t ao_log_end_pos;
 536 extern __pdata uint32_t ao_log_start_pos;
 537 extern __xdata uint8_t  ao_log_running;
 538 extern __xdata enum flight_state ao_log_state;
 539
 540 /* required functions from the underlying log system */
 541
 542 /* Return the flight number from the given log slot, 0 if none */
 543 uint16_t
 544 ao_log_flight(uint8_t slot);
 545
 546 /* Flush the log */
 547 void
 548 ao_log_flush(void);
 549
 550 /* Logging thread main routine */
 551 void
 552 ao_log(void);
 553
 554 /* functions provided in ao_log.c */
 555
 556 /* Figure out the current flight number */
 557 void
 558 ao_log_scan(void) __reentrant;
 559
 560 /* Return the position of the start of the given log slot */
 561 uint32_t
 562 ao_log_pos(uint8_t slot);
 563
 564 /* Start logging to eeprom */
 565 void
 566 ao_log_start(void);
 567
 568 /* Stop logging */
 569 void
 570 ao_log_stop(void);
 571
 572 /* Initialize the logging system */
 573 void
 574 ao_log_init(void);
 575
 576 /* Write out the current flight number to the erase log */
 577 void
 578 ao_log_write_erase(uint8_t pos);
 579
 580 /* Returns true if there are any logs stored in eeprom */
 581 uint8_t
 582 ao_log_present(void);
 583
 584 /* Returns true if there is no more storage space available */
 585 uint8_t
 586 ao_log_full(void);
 587
 588 /*
 589  * ao_log_big.c
 590  */
 591
 592 /*
 593  * The data log is recorded in the eeprom as a sequence
 594  * of data packets.
 595  *
 596  * Each packet starts with a 4-byte header that has the
 597  * packet type, the packet checksum and the tick count. Then
 598  * they all contain 2 16 bit values which hold packet-specific
 599  * data.
 600  *
 601  * For each flight, the first packet
 602  * is FLIGHT packet, indicating the serial number of the
 603  * device and a unique number marking the number of flights
 604  * recorded by this device.
 605  *
 606  * During flight, data from the accelerometer and barometer
 607  * are recorded in SENSOR packets, using the raw 16-bit values
 608  * read from the A/D converter.
 609  *
 610  * Also during flight, but at a lower rate, the deployment
 611  * sensors are recorded in DEPLOY packets. The goal here is to
 612  * detect failure in the deployment circuits.
 613  *
 614  * STATE packets hold state transitions as the flight computer
 615  * transitions through different stages of the flight.
 616  */
 617 #define AO_LOG_FLIGHT           'F'
 618 #define AO_LOG_SENSOR           'A'
 619 #define AO_LOG_TEMP_VOLT        'T'
 620 #define AO_LOG_DEPLOY           'D'
 621 #define AO_LOG_STATE            'S'
 622 #define AO_LOG_GPS_TIME         'G'
 623 #define AO_LOG_GPS_LAT          'N'
 624 #define AO_LOG_GPS_LON          'W'
 625 #define AO_LOG_GPS_ALT          'H'
 626 #define AO_LOG_GPS_SAT          'V'
 627 #define AO_LOG_GPS_DATE         'Y'
 628
 629 #define AO_LOG_POS_NONE         (~0UL)
 630
 631 struct ao_log_record {
 632         char                    type;
 633         uint8_t                 csum;
 634         uint16_t                tick;
 635         union {
 636                 struct {
 637                         int16_t         ground_accel;
 638                         uint16_t        flight;
 639                 } flight;
 640                 struct {
 641                         int16_t         accel;
 642                         int16_t         pres;
 643                 } sensor;
 644                 struct {
 645                         int16_t         temp;
 646                         int16_t         v_batt;
 647                 } temp_volt;
 648                 struct {
 649                         int16_t         drogue;
 650                         int16_t         main;
 651                 } deploy;
 652                 struct {
 653                         uint16_t        state;
 654                         uint16_t        reason;
 655                 } state;
 656                 struct {
 657                         uint8_t         hour;
 658                         uint8_t         minute;
 659                         uint8_t         second;
 660                         uint8_t         flags;
 661                 } gps_time;
 662                 int32_t         gps_latitude;
 663                 int32_t         gps_longitude;
 664                 struct {
 665                         int16_t         altitude;
 666                         uint16_t        unused;
 667                 } gps_altitude;
 668                 struct {
 669                         uint16_t        svid;
 670                         uint8_t         unused;
 671                         uint8_t         c_n;
 672                 } gps_sat;
 673                 struct {
 674                         uint8_t         year;
 675                         uint8_t         month;
 676                         uint8_t         day;
 677                         uint8_t         extra;
 678                 } gps_date;
 679                 struct {
 680                         uint16_t        d0;
 681                         uint16_t        d1;
 682                 } anon;
 683         } u;
 684 };
 685
 686 /* Write a record to the eeprom log */
 687 uint8_t
 688 ao_log_data(__xdata struct ao_log_record *log) __reentrant;
 689
 690 /*
 691  * ao_flight.c
 692  */
 693
 694 enum ao_flight_state {
 695         ao_flight_startup = 0,
 696         ao_flight_idle = 1,
 697         ao_flight_pad = 2,
 698         ao_flight_boost = 3,
 699         ao_flight_fast = 4,
 700         ao_flight_coast = 5,
 701         ao_flight_drogue = 6,
 702         ao_flight_main = 7,
 703         ao_flight_landed = 8,
 704         ao_flight_invalid = 9
 705 };
 706
 707 extern __pdata enum ao_flight_state     ao_flight_state;
 708
 709 extern __pdata uint16_t                 ao_launch_time;
 710 extern __xdata uint8_t                  ao_flight_force_idle;
 711
 712 /* Flight thread */
 713 void
 714 ao_flight(void);
 715
 716 /* Initialize flight thread */
 717 void
 718 ao_flight_init(void);
 719
 720 /*
 721  * ao_flight_nano.c
 722  */
 723
 724 void
 725 ao_flight_nano_init(void);
 726
 727 /*
 728  * ao_sample.c
 729  */
 730
 731 /*
 732  * Barometer calibration
 733  *
 734  * We directly sample the barometer. The specs say:
 735  *
 736  * Pressure range: 15-115 kPa
 737  * Voltage at 115kPa: 2.82
 738  * Output scale: 27mV/kPa
 739  *
 740  * If we want to detect launch with the barometer, we need
 741  * a large enough bump to not be fooled by noise. At typical
 742  * launch elevations (0-2000m), a 200Pa pressure change cooresponds
 743  * to about a 20m elevation change. This is 5.4mV, or about 3LSB.
 744  * As all of our calculations are done in 16 bits, we'll actually see a change
 745  * of 16 times this though
 746  *
 747  * 27 mV/kPa * 32767 / 3300 counts/mV = 268.1 counts/kPa
 748  */
 749
 750 /* Accelerometer calibration
 751  *
 752  * We're sampling the accelerometer through a resistor divider which
 753  * consists of 5k and 10k resistors. This multiplies the values by 2/3.
 754  * That goes into the cc1111 A/D converter, which is running at 11 bits
 755  * of precision with the bits in the MSB of the 16 bit value. Only positive
 756  * values are used, so values should range from 0-32752 for 0-3.3V. The
 757  * specs say we should see 40mV/g (uncalibrated), multiply by 2/3 for what
 758  * the A/D converter sees (26.67 mV/g). We should see 32752/3300 counts/mV,
 759  * for a final computation of:
 760  *
 761  * 26.67 mV/g * 32767/3300 counts/mV = 264.8 counts/g
 762  *
 763  * Zero g was measured at 16000 (we would expect 16384).
 764  * Note that this value is only require to tell if the
 765  * rocket is standing upright. Once that is determined,
 766  * the value of the accelerometer is averaged for 100 samples
 767  * to find the resting accelerometer value, which is used
 768  * for all further flight computations
 769  */
 770
 771 #define GRAVITY 9.80665
 772
 773 /*
 774  * Above this height, the baro sensor doesn't work
 775  */
 776 #define AO_MAX_BARO_HEIGHT      12000
 777
 778 /*
 779  * Above this speed, baro measurements are unreliable
 780  */
 781 #define AO_MAX_BARO_SPEED       200
 782
 783 #define ACCEL_NOSE_UP   (ao_accel_2g >> 2)
 784
 785 /*
 786  * Speed and acceleration are scaled by 16 to provide a bit more
 787  * resolution while still having reasonable range. Note that this
 788  * limits speed to 2047m/s (around mach 6) and acceleration to
 789  * 2047m/s² (over 200g)
 790  */
 791
 792 #define AO_M_TO_HEIGHT(m)       ((int16_t) (m))
 793 #define AO_MS_TO_SPEED(ms)      ((int16_t) ((ms) * 16))
 794 #define AO_MSS_TO_ACCEL(mss)    ((int16_t) ((mss) * 16))
 795
 796 extern __pdata uint16_t ao_sample_tick;         /* time of last data */
 797 extern __pdata int16_t  ao_sample_pres;         /* most recent pressure sensor reading */
 798 extern __pdata int16_t  ao_sample_alt;          /* MSL of ao_sample_pres */
 799 extern __pdata int16_t  ao_sample_height;       /* AGL of ao_sample_pres */
 800 extern __data uint8_t   ao_sample_adc;          /* Ring position of last processed sample */
 801
 802 #if HAS_ACCEL
 803 extern __pdata int16_t  ao_sample_accel;        /* most recent accel sensor reading */
 804 #endif
 805
 806 extern __xdata int16_t  ao_ground_pres;         /* startup pressure */
 807 extern __xdata int16_t  ao_ground_height;       /* MSL of ao_ground_pres */
 808
 809 #if HAS_ACCEL
 810 extern __xdata int16_t  ao_ground_accel;        /* startup acceleration */
 811 extern __xdata int16_t  ao_accel_2g;            /* factory accel calibration */
 812 extern __xdata int32_t  ao_accel_scale;         /* sensor to m/s² conversion */
 813 #endif
 814
 815 void ao_sample_init(void);
 816
 817 /* returns FALSE in preflight mode, TRUE in flight mode */
 818 uint8_t ao_sample(void);
 819
 820 /*
 821  * ao_kalman.c
 822  */
 823
 824 #define to_fix16(x) ((int16_t) ((x) * 65536.0 + 0.5))
 825 #define to_fix32(x) ((int32_t) ((x) * 65536.0 + 0.5))
 826 #define from_fix(x)     ((x) >> 16)
 827
 828 extern __pdata int16_t                  ao_height;      /* meters */
 829 extern __pdata int16_t                  ao_speed;       /* m/s * 16 */
 830 extern __pdata int16_t                  ao_accel;       /* m/s² * 16 */
 831 extern __pdata int16_t                  ao_max_height;  /* max of ao_height */
 832
 833 extern __pdata int16_t                  ao_error_h;
 834 extern __pdata int16_t                  ao_error_h_sq_avg;
 835
 836 #if HAS_ACCEL
 837 extern __pdata int16_t                  ao_error_a;
 838 #endif
 839
 840 void ao_kalman(void);
 841
 842 /*
 843  * ao_report.c
 844  */
 845
 846 void
 847 ao_report_init(void);
 848
 849 /*
 850  * ao_convert.c
 851  *
 852  * Given raw data, convert to SI units
 853  */
 854
 855 /* pressure from the sensor to altitude in meters */
 856 int16_t
 857 ao_pres_to_altitude(int16_t pres) __reentrant;
 858
 859 int16_t
 860 ao_altitude_to_pres(int16_t alt) __reentrant;
 861
 862 int16_t
 863 ao_temp_to_dC(int16_t temp) __reentrant;
 864
 865 /*
 866  * ao_dbg.c
 867  *
 868  * debug another telemetrum board
 869  */
 870
 871 /* Send a byte to the dbg target */
 872 void
 873 ao_dbg_send_byte(uint8_t byte);
 874
 875 /* Receive a byte from the dbg target */
 876 uint8_t
 877 ao_dbg_recv_byte(void);
 878
 879 /* Start a bulk transfer to/from dbg target memory */
 880 void
 881 ao_dbg_start_transfer(uint16_t addr);
 882
 883 /* End a bulk transfer to/from dbg target memory */
 884 void
 885 ao_dbg_end_transfer(void);
 886
 887 /* Write a byte to dbg target memory */
 888 void
 889 ao_dbg_write_byte(uint8_t byte);
 890
 891 /* Read a byte from dbg target memory */
 892 uint8_t
 893 ao_dbg_read_byte(void);
 894
 895 /* Enable dbg mode, switching use of the pins */
 896 void
 897 ao_dbg_debug_mode(void);
 898
 899 /* Reset the dbg target */
 900 void
 901 ao_dbg_reset(void);
 902
 903 void
 904 ao_dbg_init(void);
 905
 906 /*
 907  * ao_serial.c
 908  */
 909
 910 #ifndef HAS_SERIAL_1
 911 #error Please define HAS_SERIAL_1
 912 #endif
 913
 914 #if HAS_SERIAL_1
 915 #ifndef USE_SERIAL_STDIN
 916 #error Please define USE_SERIAL_STDIN
 917 #endif
 918
 919 void
 920 ao_serial_rx1_isr(void) __interrupt 3;
 921
 922 void
 923 ao_serial_tx1_isr(void) __interrupt 14;
 924
 925 char
 926 ao_serial_getchar(void) __critical;
 927
 928 #if USE_SERIAL_STDIN
 929 char
 930 ao_serial_pollchar(void) __critical;
 931
 932 void
 933 ao_serial_set_stdin(uint8_t stdin);
 934 #endif
 935
 936 void
 937 ao_serial_putchar(char c) __critical;
 938
 939 void
 940 ao_serial_drain(void) __critical;
 941
 942 #define AO_SERIAL_SPEED_4800    0
 943 #define AO_SERIAL_SPEED_9600    1
 944 #define AO_SERIAL_SPEED_19200   2
 945 #define AO_SERIAL_SPEED_57600   3
 946
 947 void
 948 ao_serial_set_speed(uint8_t speed);
 949
 950 void
 951 ao_serial_init(void);
 952 #endif
 953
 954 /*
 955  * ao_spi.c
 956  */
 957
 958 void
 959 ao_spi_send(void __xdata *block, uint16_t len) __reentrant;
 960
 961 void
 962 ao_spi_recv(void __xdata *block, uint16_t len) __reentrant;
 963
 964 void
 965 ao_spi_init(void);
 966
 967 /*
 968  * ao_gps.c
 969  */
 970
 971 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
 972 #define AO_GPS_NUM_SAT_SHIFT    (0)
 973
 974 #define AO_GPS_VALID            (1 << 4)
 975 #define AO_GPS_RUNNING          (1 << 5)
 976 #define AO_GPS_DATE_VALID       (1 << 6)
 977 #define AO_GPS_COURSE_VALID     (1 << 7)
 978
 979 extern __xdata uint16_t ao_gps_tick;
 980
 981 struct ao_gps_data {
 982         uint8_t                 year;
 983         uint8_t                 month;
 984         uint8_t                 day;
 985         uint8_t                 hour;
 986         uint8_t                 minute;
 987         uint8_t                 second;
 988         uint8_t                 flags;
 989         int32_t                 latitude;       /* degrees * 10⁷ */
 990         int32_t                 longitude;      /* degrees * 10⁷ */
 991         int16_t                 altitude;       /* m */
 992         uint16_t                ground_speed;   /* cm/s */
 993         uint8_t                 course;         /* degrees / 2 */
 994         uint8_t                 hdop;           /* * 5 */
 995         int16_t                 climb_rate;     /* cm/s */
 996         uint16_t                h_error;        /* m */
 997         uint16_t                v_error;        /* m */
 998 };
 999
1000 struct ao_gps_sat_data {
1001         uint8_t         svid;
1002         uint8_t         c_n_1;
1003 };
1004
1005 #define AO_MAX_GPS_TRACKING     12
1006
1007 struct ao_gps_tracking_data {
1008         uint8_t                 channels;
1009         struct ao_gps_sat_data  sats[AO_MAX_GPS_TRACKING];
1010 };
1011
1012 extern __xdata uint8_t ao_gps_mutex;
1013 extern __xdata struct ao_gps_data ao_gps_data;
1014 extern __xdata struct ao_gps_tracking_data ao_gps_tracking_data;
1015
1016 void
1017 ao_gps(void);
1018
1019 void
1020 ao_gps_print(__xdata struct ao_gps_data *gps_data);
1021
1022 void
1023 ao_gps_tracking_print(__xdata struct ao_gps_tracking_data *gps_tracking_data);
1024
1025 void
1026 ao_gps_init(void);
1027
1028 /*
1029  * ao_gps_report.c
1030  */
1031
1032 void
1033 ao_gps_report(void);
1034
1035 void
1036 ao_gps_report_init(void);
1037
1038 /*
1039  * ao_telemetry.c
1040  */
1041
1042 #define AO_MAX_CALLSIGN                 8
1043
1044 struct ao_telemetry {
1045         uint16_t                serial;
1046         uint16_t                flight;
1047         uint8_t                 flight_state;
1048         int16_t                 accel;
1049         int16_t                 ground_accel;
1050         union {
1051                 struct {
1052                         int16_t                 speed;
1053                         int16_t                 unused;
1054                 } k;
1055                 int32_t         flight_vel;
1056         } u;
1057         int16_t                 height;
1058         int16_t                 ground_pres;
1059         int16_t                 accel_plus_g;
1060         int16_t                 accel_minus_g;
1061         struct ao_adc           adc;
1062         struct ao_gps_data      gps;
1063         char                    callsign[AO_MAX_CALLSIGN];
1064         struct ao_gps_tracking_data     gps_tracking;
1065 };
1066
1067 struct ao_telemetry_tiny {
1068         uint16_t                serial;
1069         uint16_t                flight;
1070         uint8_t                 flight_state;
1071         int16_t                 height;         /* AGL in meters */
1072         int16_t                 speed;          /* in m/s * 16 */
1073         int16_t                 accel;          /* in m/s² * 16 */
1074         int16_t                 ground_pres;    /* sensor units */
1075         struct ao_adc           adc;            /* raw ADC readings */
1076         char                    callsign[AO_MAX_CALLSIGN];
1077 };
1078
1079 /*
1080  * ao_radio_recv tacks on rssi and status bytes
1081  */
1082 struct ao_telemetry_recv {
1083         struct ao_telemetry     telemetry;
1084         int8_t                  rssi;
1085         uint8_t                 status;
1086 };
1087
1088 struct ao_telemetry_tiny_recv {
1089         struct ao_telemetry_tiny        telemetry_tiny;
1090         int8_t                          rssi;
1091         uint8_t                         status;
1092 };
1093
1094 /* Set delay between telemetry reports (0 to disable) */
1095
1096 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
1097 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
1098 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
1099
1100 void
1101 ao_telemetry_set_interval(uint16_t interval);
1102
1103 void
1104 ao_rdf_set(uint8_t rdf);
1105
1106 void
1107 ao_telemetry_init(void);
1108
1109 void
1110 ao_telemetry_tiny_init(void);
1111
1112 /*
1113  * ao_radio.c
1114  */
1115
1116 extern __xdata uint8_t  ao_radio_dma;
1117 extern __xdata uint8_t ao_radio_dma_done;
1118 extern __xdata uint8_t ao_radio_done;
1119 extern __xdata uint8_t ao_radio_mutex;
1120
1121 void
1122 ao_radio_general_isr(void) __interrupt 16;
1123
1124 void
1125 ao_radio_get(uint8_t len);
1126
1127 #define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
1128
1129 void
1130 ao_radio_set_packet(void);
1131
1132 void
1133 ao_radio_send(__xdata void *data, uint8_t size) __reentrant;
1134
1135 uint8_t
1136 ao_radio_recv(__xdata void *data, uint8_t size) __reentrant;
1137
1138 void
1139 ao_radio_recv_abort(void);
1140
1141 void
1142 ao_radio_rdf(int ms);
1143
1144 void
1145 ao_radio_rdf_abort(void);
1146
1147 void
1148 ao_radio_idle(void);
1149
1150 void
1151 ao_radio_init(void);
1152
1153 /*
1154  * ao_monitor.c
1155  */
1156
1157 extern const char const * const ao_state_names[];
1158
1159 void
1160 ao_monitor(void);
1161
1162 #define AO_MONITORING_OFF       0
1163 #define AO_MONITORING_FULL      1
1164 #define AO_MONITORING_TINY      2
1165
1166 void
1167 ao_set_monitor(uint8_t monitoring);
1168
1169 void
1170 ao_monitor_init(uint8_t led, uint8_t monitoring) __reentrant;
1171
1172 /*
1173  * ao_stdio.c
1174  */
1175
1176 #define AO_READ_AGAIN   ((char) -1)
1177
1178 struct ao_stdio {
1179         char    (*pollchar)(void);
1180         void    (*putchar)(char c) __reentrant;
1181         void    (*flush)(void);
1182         uint8_t echo;
1183 };
1184
1185 extern __xdata struct ao_stdio ao_stdios[];
1186 extern __data int8_t ao_cur_stdio;
1187 extern __data int8_t ao_num_stdios;
1188
1189 void
1190 flush(void);
1191
1192 extern __xdata uint8_t ao_stdin_ready;
1193
1194 uint8_t
1195 ao_echo(void);
1196
1197 int8_t
1198 ao_add_stdio(char (*pollchar)(void),
1199              void (*putchar)(char) __reentrant,
1200              void (*flush)(void)) __reentrant;
1201
1202 /*
1203  * ao_ignite.c
1204  */
1205
1206 enum ao_igniter {
1207         ao_igniter_drogue = 0,
1208         ao_igniter_main = 1
1209 };
1210
1211 void
1212 ao_ignite(enum ao_igniter igniter);
1213
1214 enum ao_igniter_status {
1215         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
1216         ao_igniter_ready,       /* continuity detected */
1217         ao_igniter_active,      /* igniter firing */
1218         ao_igniter_open,        /* open circuit detected */
1219 };
1220
1221 enum ao_igniter_status
1222 ao_igniter_status(enum ao_igniter igniter);
1223
1224 void
1225 ao_igniter_init(void);
1226
1227 /*
1228  * ao_config.c
1229  */
1230
1231 #define AO_CONFIG_MAJOR 1
1232 #define AO_CONFIG_MINOR 4
1233
1234 struct ao_config {
1235         uint8_t         major;
1236         uint8_t         minor;
1237         uint16_t        main_deploy;
1238         int16_t         accel_plus_g;           /* changed for minor version 2 */
1239         uint8_t         radio_channel;
1240         char            callsign[AO_MAX_CALLSIGN + 1];
1241         uint8_t         apogee_delay;           /* minor version 1 */
1242         int16_t         accel_minus_g;          /* minor version 2 */
1243         uint32_t        radio_cal;              /* minor version 3 */
1244         uint32_t        flight_log_max;         /* minor version 4 */
1245 };
1246
1247 extern __xdata struct ao_config ao_config;
1248
1249 #define AO_CONFIG_MAX_SIZE      128
1250
1251 void
1252 ao_config_get(void);
1253
1254 void
1255 ao_config_put(void);
1256
1257 void
1258 ao_config_init(void);
1259
1260 /*
1261  * ao_rssi.c
1262  */
1263
1264 void
1265 ao_rssi_set(int rssi_value);
1266
1267 void
1268 ao_rssi_init(uint8_t rssi_led);
1269
1270 /*
1271  * ao_product.c
1272  *
1273  * values which need to be defined for
1274  * each instance of a product
1275  */
1276
1277 extern const char ao_version[];
1278 extern const char ao_manufacturer[];
1279 extern const char ao_product[];
1280
1281 /*
1282  * Fifos
1283  */
1284
1285 #define AO_FIFO_SIZE    32
1286
1287 struct ao_fifo {
1288         uint8_t insert;
1289         uint8_t remove;
1290         char    fifo[AO_FIFO_SIZE];
1291 };
1292
1293 #define ao_fifo_insert(f,c) do { \
1294         (f).fifo[(f).insert] = (c); \
1295         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
1296 } while(0)
1297
1298 #define ao_fifo_remove(f,c) do {\
1299         c = (f).fifo[(f).remove]; \
1300         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
1301 } while(0)
1302
1303 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
1304 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
1305
1306 /*
1307  * ao_packet.c
1308  *
1309  * Packet-based command interface
1310  */
1311
1312 #define AO_PACKET_MAX           64
1313 #define AO_PACKET_SYN           (uint8_t) 0xff
1314
1315 struct ao_packet {
1316         uint8_t         addr;
1317         uint8_t         len;
1318         uint8_t         seq;
1319         uint8_t         ack;
1320         uint8_t         d[AO_PACKET_MAX];
1321         uint8_t         callsign[AO_MAX_CALLSIGN];
1322 };
1323
1324 struct ao_packet_recv {
1325         struct ao_packet        packet;
1326         int8_t                  rssi;
1327         uint8_t                 status;
1328 };
1329
1330 extern __xdata struct ao_packet_recv ao_rx_packet;
1331 extern __xdata struct ao_packet ao_tx_packet;
1332 extern __xdata struct ao_task   ao_packet_task;
1333 extern __xdata uint8_t ao_packet_enable;
1334 extern __xdata uint8_t ao_packet_master_sleeping;
1335 extern __pdata uint8_t ao_packet_rx_len, ao_packet_rx_used, ao_packet_tx_used;
1336
1337 void
1338 ao_packet_send(void);
1339
1340 uint8_t
1341 ao_packet_recv(void);
1342
1343 void
1344 ao_packet_flush(void);
1345
1346 void
1347 ao_packet_putchar(char c) __reentrant;
1348
1349 char
1350 ao_packet_pollchar(void) __critical;
1351
1352 /* ao_packet_master.c */
1353
1354 void
1355 ao_packet_master_init(void);
1356
1357 /* ao_packet_slave.c */
1358
1359 void
1360 ao_packet_slave_start(void);
1361
1362 void
1363 ao_packet_slave_stop(void);
1364
1365 void
1366 ao_packet_slave_init(uint8_t enable);
1367
1368 /* ao_btm.c */
1369
1370 /* If bt_link is on P2, this interrupt is shared by USB, so the USB
1371  * code calls this function. Otherwise, it's a regular ISR.
1372  */
1373
1374 void
1375 ao_btm_isr(void)
1376 #if BT_LINK_ON_P1
1377         __interrupt 15
1378 #endif
1379         ;
1380
1381
1382 void
1383 ao_btm_init(void);
1384
1385 #endif /* _AO_H_ */