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  0x80
  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
 111 /* Stop the operating system, beeping and blinking the reason */
 112 void
 113 ao_panic(uint8_t reason);
 114
 115 /*
 116  * ao_timer.c
 117  */
 118
 119 /* Our timer runs at 100Hz */
 120 #define AO_HERTZ                100
 121 #define AO_MS_TO_TICKS(ms)      ((ms) / (1000 / AO_HERTZ))
 122 #define AO_SEC_TO_TICKS(s)      ((s) * AO_HERTZ)
 123
 124 /* Returns the current time in ticks */
 125 uint16_t
 126 ao_time(void);
 127
 128 /* Suspend the current task until ticks time has passed */
 129 void
 130 ao_delay(uint16_t ticks);
 131
 132 /* Set the ADC interval */
 133 void
 134 ao_timer_set_adc_interval(uint8_t interval) __critical;
 135
 136 /* Timer interrupt */
 137 void
 138 ao_timer_isr(void) __interrupt 9;
 139
 140 /* Initialize the timer */
 141 void
 142 ao_timer_init(void);
 143
 144 /* Initialize the hardware clock. Must be called first */
 145 void
 146 ao_clock_init(void);
 147
 148 /*
 149  * One set of samples read from the A/D converter or telemetry
 150  */
 151 struct ao_adc {
 152         uint16_t        tick;           /* tick when the sample was read */
 153         int16_t         accel;          /* accelerometer */
 154         int16_t         pres;           /* pressure sensor */
 155         int16_t         temp;           /* temperature sensor */
 156         int16_t         v_batt;         /* battery voltage */
 157         int16_t         sense_d;        /* drogue continuity sense */
 158         int16_t         sense_m;        /* main continuity sense */
 159 };
 160
 161 #ifndef HAS_ADC
 162 #error Please define HAS_ADC
 163 #endif
 164
 165 #if HAS_ADC
 166
 167 #ifndef HAS_ACCEL_REF
 168 #error Please define HAS_ACCEL_REF
 169 #endif
 170
 171 /*
 172  * ao_adc.c
 173  */
 174
 175 #define AO_ADC_RING     32
 176 #define ao_adc_ring_next(n)     (((n) + 1) & (AO_ADC_RING - 1))
 177 #define ao_adc_ring_prev(n)     (((n) - 1) & (AO_ADC_RING - 1))
 178
 179
 180 /*
 181  * A/D data is stored in a ring, with the next sample to be written
 182  * at ao_adc_head
 183  */
 184 extern volatile __xdata struct ao_adc   ao_adc_ring[AO_ADC_RING];
 185 extern volatile __data uint8_t          ao_adc_head;
 186 #if HAS_ACCEL_REF
 187 extern volatile __xdata uint16_t        ao_accel_ref[AO_ADC_RING];
 188 #endif
 189
 190 /* Trigger a conversion sequence (called from the timer interrupt) */
 191 void
 192 ao_adc_poll(void);
 193
 194 /* Suspend the current task until another A/D sample is converted */
 195 void
 196 ao_adc_sleep(void);
 197
 198 /* Get a copy of the last complete A/D sample set */
 199 void
 200 ao_adc_get(__xdata struct ao_adc *packet);
 201
 202 /* The A/D interrupt handler */
 203
 204 void
 205 ao_adc_isr(void) __interrupt 1;
 206
 207 /* Initialize the A/D converter */
 208 void
 209 ao_adc_init(void);
 210
 211 #endif /* HAS_ADC */
 212
 213 /*
 214  * ao_beep.c
 215  */
 216
 217 /*
 218  * Various pre-defined beep frequencies
 219  *
 220  * frequency = 1/2 (24e6/32) / beep
 221  */
 222
 223 #define AO_BEEP_LOW     150     /* 2500Hz */
 224 #define AO_BEEP_MID     94      /* 3989Hz */
 225 #define AO_BEEP_HIGH    75      /* 5000Hz */
 226 #define AO_BEEP_OFF     0       /* off */
 227
 228 #define AO_BEEP_g       240     /* 1562.5Hz */
 229 #define AO_BEEP_gs      227     /* 1652Hz (1655Hz) */
 230 #define AO_BEEP_aa      214     /* 1752Hz (1754Hz) */
 231 #define AO_BEEP_bbf     202     /* 1856Hz (1858Hz) */
 232 #define AO_BEEP_bb      190     /* 1974Hz (1969Hz) */
 233 #define AO_BEEP_cc      180     /* 2083Hz (2086Hz) */
 234 #define AO_BEEP_ccs     170     /* 2205Hz (2210Hz) */
 235 #define AO_BEEP_dd      160     /* 2344Hz (2341Hz) */
 236 #define AO_BEEP_eef     151     /* 2483Hz (2480Hz) */
 237 #define AO_BEEP_ee      143     /* 2622Hz (2628Hz) */
 238 #define AO_BEEP_ff      135     /* 2778Hz (2784Hz) */
 239 #define AO_BEEP_ffs     127     /* 2953Hz (2950Hz) */
 240 #define AO_BEEP_gg      120     /* 3125Hz */
 241 #define AO_BEEP_ggs     113     /* 3319Hz (3311Hz) */
 242 #define AO_BEEP_aaa     107     /* 3504Hz (3508Hz) */
 243 #define AO_BEEP_bbbf    101     /* 3713Hz (3716Hz) */
 244 #define AO_BEEP_bbb     95      /* 3947Hz (3937Hz) */
 245 #define AO_BEEP_ccc     90      /* 4167Hz (4171Hz) */
 246 #define AO_BEEP_cccs    85      /* 4412Hz (4419Hz) */
 247 #define AO_BEEP_ddd     80      /* 4688Hz (4682Hz) */
 248 #define AO_BEEP_eeef    76      /* 4934Hz (4961Hz) */
 249 #define AO_BEEP_eee     71      /* 5282Hz (5256Hz) */
 250 #define AO_BEEP_fff     67      /* 5597Hz (5568Hz) */
 251 #define AO_BEEP_fffs    64      /* 5859Hz (5899Hz) */
 252 #define AO_BEEP_ggg     60      /* 6250Hz */
 253
 254 /* Set the beeper to the specified tone */
 255 void
 256 ao_beep(uint8_t beep);
 257
 258 /* Turn on the beeper for the specified time */
 259 void
 260 ao_beep_for(uint8_t beep, uint16_t ticks) __reentrant;
 261
 262 /* Initialize the beeper */
 263 void
 264 ao_beep_init(void);
 265
 266 /*
 267  * ao_led.c
 268  */
 269
 270 #define AO_LED_NONE     0
 271
 272 /* Turn on the specified LEDs */
 273 void
 274 ao_led_on(uint8_t colors);
 275
 276 /* Turn off the specified LEDs */
 277 void
 278 ao_led_off(uint8_t colors);
 279
 280 /* Set all of the LEDs to the specified state */
 281 void
 282 ao_led_set(uint8_t colors);
 283
 284 /* Toggle the specified LEDs */
 285 void
 286 ao_led_toggle(uint8_t colors);
 287
 288 /* Turn on the specified LEDs for the indicated interval */
 289 void
 290 ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
 291
 292 /* Initialize the LEDs */
 293 void
 294 ao_led_init(uint8_t enable);
 295
 296 /*
 297  * ao_romconfig.c
 298  */
 299
 300 #define AO_ROMCONFIG_VERSION    2
 301
 302 extern __code __at (0x00a0) uint16_t ao_romconfig_version;
 303 extern __code __at (0x00a2) uint16_t ao_romconfig_check;
 304 extern __code __at (0x00a4) uint16_t ao_serial_number;
 305 extern __code __at (0x00a6) uint32_t ao_radio_cal;
 306 extern __code __at (0x00aa) uint8_t ao_usb_descriptors [];
 307
 308 /*
 309  * ao_usb.c
 310  */
 311
 312 /* Put one character to the USB output queue */
 313 void
 314 ao_usb_putchar(char c);
 315
 316 /* Get one character from the USB input queue */
 317 char
 318 ao_usb_getchar(void);
 319
 320 /* Poll for a charcter on the USB input queue.
 321  * returns AO_READ_AGAIN if none are available
 322  */
 323 char
 324 ao_usb_pollchar(void);
 325
 326 /* Flush the USB output queue */
 327 void
 328 ao_usb_flush(void);
 329
 330 /* USB interrupt handler */
 331 void
 332 ao_usb_isr(void) __interrupt 6;
 333
 334 /* Enable the USB controller */
 335 void
 336 ao_usb_enable(void);
 337
 338 /* Disable the USB controller */
 339 void
 340 ao_usb_disable(void);
 341
 342 /* Initialize the USB system */
 343 void
 344 ao_usb_init(void);
 345
 346 /*
 347  * ao_cmd.c
 348  */
 349
 350 enum ao_cmd_status {
 351         ao_cmd_success = 0,
 352         ao_cmd_lex_error = 1,
 353         ao_cmd_syntax_error = 2,
 354 };
 355
 356 extern __xdata uint16_t ao_cmd_lex_i;
 357 extern __xdata uint32_t ao_cmd_lex_u32;
 358 extern __xdata char     ao_cmd_lex_c;
 359 extern __xdata enum ao_cmd_status ao_cmd_status;
 360
 361 void
 362 ao_cmd_lex(void);
 363
 364 void
 365 ao_cmd_put8(uint8_t v);
 366
 367 void
 368 ao_cmd_put16(uint16_t v);
 369
 370 void
 371 ao_cmd_white(void);
 372
 373 void
 374 ao_cmd_hex(void);
 375
 376 void
 377 ao_cmd_decimal(void);
 378
 379 uint8_t
 380 ao_match_word(__code char *word);
 381
 382 struct ao_cmds {
 383         char            cmd;
 384         void            (*func)(void);
 385         const char      *help;
 386 };
 387
 388 void
 389 ao_cmd_register(__code struct ao_cmds *cmds);
 390
 391 void
 392 ao_cmd_init(void);
 393
 394 /*
 395  * ao_dma.c
 396  */
 397
 398 /* Allocate a DMA channel. the 'done' parameter will be set when the
 399  * dma is finished and will be used to wakeup any waiters
 400  */
 401
 402 uint8_t
 403 ao_dma_alloc(__xdata uint8_t * done);
 404
 405 /* Setup a DMA channel */
 406 void
 407 ao_dma_set_transfer(uint8_t id,
 408                     void __xdata *srcaddr,
 409                     void __xdata *dstaddr,
 410                     uint16_t count,
 411                     uint8_t cfg0,
 412                     uint8_t cfg1);
 413
 414 /* Start a DMA channel */
 415 void
 416 ao_dma_start(uint8_t id);
 417
 418 /* Manually trigger a DMA channel */
 419 void
 420 ao_dma_trigger(uint8_t id);
 421
 422 /* Abort a running DMA transfer */
 423 void
 424 ao_dma_abort(uint8_t id);
 425
 426 /* DMA interrupt routine */
 427 void
 428 ao_dma_isr(void) __interrupt 8;
 429
 430 /*
 431  * ao_mutex.c
 432  */
 433
 434 void
 435 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
 436
 437 void
 438 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 439
 440 /*
 441  * Storage interface, provided by one of the eeprom or flash
 442  * drivers
 443  */
 444
 445 /* Total bytes of available storage */
 446 extern __xdata uint32_t ao_storage_total;
 447
 448 /* Block size - device is erased in these units. At least 256 bytes */
 449 extern __xdata uint32_t ao_storage_block;
 450
 451 /* Byte offset of config block. Will be ao_storage_block bytes long */
 452 extern __xdata uint32_t ao_storage_config;
 453
 454 /* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
 455 extern __xdata uint16_t ao_storage_unit;
 456
 457 #define AO_STORAGE_ERASE_LOG    (ao_storage_config + AO_CONFIG_MAX_SIZE)
 458
 459 /* Initialize above values. Can only be called once the OS is running */
 460 void
 461 ao_storage_setup(void);
 462
 463 /* Write data. Returns 0 on failure, 1 on success */
 464 uint8_t
 465 ao_storage_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 466
 467 /* Read data. Returns 0 on failure, 1 on success */
 468 uint8_t
 469 ao_storage_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 470
 471 /* Erase a block of storage. This always clears ao_storage_block bytes */
 472 uint8_t
 473 ao_storage_erase(uint32_t pos) __reentrant;
 474
 475 /* Flush any pending writes to stable storage */
 476 void
 477 ao_storage_flush(void) __reentrant;
 478
 479 /* Initialize the storage code */
 480 void
 481 ao_storage_init(void);
 482
 483 /*
 484  * Low-level functions wrapped by ao_storage.c
 485  */
 486
 487 /* Read data within a storage unit */
 488 uint8_t
 489 ao_storage_device_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 490
 491 /* Write data within a storage unit */
 492 uint8_t
 493 ao_storage_device_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 494
 495 /* Initialize low-level device bits */
 496 void
 497 ao_storage_device_init(void);
 498
 499 /* Print out information about flash chips */
 500 void
 501 ao_storage_device_info(void) __reentrant;
 502
 503 /*
 504  * ao_log.c
 505  */
 506
 507 /*
 508  * The data log is recorded in the eeprom as a sequence
 509  * of data packets.
 510  *
 511  * Each packet starts with a 4-byte header that has the
 512  * packet type, the packet checksum and the tick count. Then
 513  * they all contain 2 16 bit values which hold packet-specific
 514  * data.
 515  *
 516  * For each flight, the first packet
 517  * is FLIGHT packet, indicating the serial number of the
 518  * device and a unique number marking the number of flights
 519  * recorded by this device.
 520  *
 521  * During flight, data from the accelerometer and barometer
 522  * are recorded in SENSOR packets, using the raw 16-bit values
 523  * read from the A/D converter.
 524  *
 525  * Also during flight, but at a lower rate, the deployment
 526  * sensors are recorded in DEPLOY packets. The goal here is to
 527  * detect failure in the deployment circuits.
 528  *
 529  * STATE packets hold state transitions as the flight computer
 530  * transitions through different stages of the flight.
 531  */
 532 #define AO_LOG_FLIGHT           'F'
 533 #define AO_LOG_SENSOR           'A'
 534 #define AO_LOG_TEMP_VOLT        'T'
 535 #define AO_LOG_DEPLOY           'D'
 536 #define AO_LOG_STATE            'S'
 537 #define AO_LOG_GPS_TIME         'G'
 538 #define AO_LOG_GPS_LAT          'N'
 539 #define AO_LOG_GPS_LON          'W'
 540 #define AO_LOG_GPS_ALT          'H'
 541 #define AO_LOG_GPS_SAT          'V'
 542 #define AO_LOG_GPS_DATE         'Y'
 543
 544 #define AO_LOG_POS_NONE         (~0UL)
 545
 546 struct ao_log_record {
 547         char                    type;
 548         uint8_t                 csum;
 549         uint16_t                tick;
 550         union {
 551                 struct {
 552                         int16_t         ground_accel;
 553                         uint16_t        flight;
 554                 } flight;
 555                 struct {
 556                         int16_t         accel;
 557                         int16_t         pres;
 558                 } sensor;
 559                 struct {
 560                         int16_t         temp;
 561                         int16_t         v_batt;
 562                 } temp_volt;
 563                 struct {
 564                         int16_t         drogue;
 565                         int16_t         main;
 566                 } deploy;
 567                 struct {
 568                         uint16_t        state;
 569                         uint16_t        reason;
 570                 } state;
 571                 struct {
 572                         uint8_t         hour;
 573                         uint8_t         minute;
 574                         uint8_t         second;
 575                         uint8_t         flags;
 576                 } gps_time;
 577                 int32_t         gps_latitude;
 578                 int32_t         gps_longitude;
 579                 struct {
 580                         int16_t         altitude;
 581                         uint16_t        unused;
 582                 } gps_altitude;
 583                 struct {
 584                         uint16_t        svid;
 585                         uint8_t         unused;
 586                         uint8_t         c_n;
 587                 } gps_sat;
 588                 struct {
 589                         uint8_t         year;
 590                         uint8_t         month;
 591                         uint8_t         day;
 592                         uint8_t         extra;
 593                 } gps_date;
 594                 struct {
 595                         uint16_t        d0;
 596                         uint16_t        d1;
 597                 } anon;
 598         } u;
 599 };
 600
 601 /* Write a record to the eeprom log */
 602 uint8_t
 603 ao_log_data(__xdata struct ao_log_record *log) __reentrant;
 604
 605 /* Flush the log */
 606 void
 607 ao_log_flush(void);
 608
 609 /* We record flight numbers in the first record of
 610  * the log. Tasks may wait for this to be initialized
 611  * by sleeping on this variable.
 612  */
 613 extern __xdata uint16_t ao_flight_number;
 614
 615 /* Logging thread main routine */
 616 void
 617 ao_log(void);
 618
 619 /* Start logging to eeprom */
 620 void
 621 ao_log_start(void);
 622
 623 /* Stop logging */
 624 void
 625 ao_log_stop(void);
 626
 627 /* Initialize the logging system */
 628 void
 629 ao_log_init(void);
 630
 631 /* Write out the current flight number to the erase log */
 632 void
 633 ao_log_write_erase(uint8_t pos);
 634
 635 /* Returns true if there are any logs stored in eeprom */
 636 uint8_t
 637 ao_log_present(void);
 638
 639 /* Returns true if there is no more storage space available */
 640 uint8_t
 641 ao_log_full(void);
 642
 643 /*
 644  * ao_flight.c
 645  */
 646
 647 enum ao_flight_state {
 648         ao_flight_startup = 0,
 649         ao_flight_idle = 1,
 650         ao_flight_pad = 2,
 651         ao_flight_boost = 3,
 652         ao_flight_fast = 4,
 653         ao_flight_coast = 5,
 654         ao_flight_drogue = 6,
 655         ao_flight_main = 7,
 656         ao_flight_landed = 8,
 657         ao_flight_invalid = 9
 658 };
 659
 660 extern __data uint8_t                   ao_flight_adc;
 661 extern __pdata enum ao_flight_state     ao_flight_state;
 662 extern __pdata uint16_t                 ao_flight_tick;
 663 extern __pdata int16_t                  ao_flight_accel;
 664 extern __pdata int16_t                  ao_flight_pres;
 665 extern __pdata int32_t                  ao_flight_vel;
 666 extern __pdata int16_t                  ao_ground_pres;
 667 extern __pdata int16_t                  ao_ground_accel;
 668 extern __pdata int16_t                  ao_min_pres;
 669 extern __pdata uint16_t                 ao_launch_time;
 670 extern __xdata uint8_t                  ao_flight_force_idle;
 671
 672 /* Flight thread */
 673 void
 674 ao_flight(void);
 675
 676 /* Initialize flight thread */
 677 void
 678 ao_flight_init(void);
 679
 680 /*
 681  * ao_report.c
 682  */
 683
 684 void
 685 ao_report_init(void);
 686
 687 /*
 688  * ao_convert.c
 689  *
 690  * Given raw data, convert to SI units
 691  */
 692
 693 /* pressure from the sensor to altitude in meters */
 694 int16_t
 695 ao_pres_to_altitude(int16_t pres) __reentrant;
 696
 697 int16_t
 698 ao_altitude_to_pres(int16_t alt) __reentrant;
 699
 700 int16_t
 701 ao_temp_to_dC(int16_t temp) __reentrant;
 702
 703 /*
 704  * ao_dbg.c
 705  *
 706  * debug another telemetrum board
 707  */
 708
 709 /* Send a byte to the dbg target */
 710 void
 711 ao_dbg_send_byte(uint8_t byte);
 712
 713 /* Receive a byte from the dbg target */
 714 uint8_t
 715 ao_dbg_recv_byte(void);
 716
 717 /* Start a bulk transfer to/from dbg target memory */
 718 void
 719 ao_dbg_start_transfer(uint16_t addr);
 720
 721 /* End a bulk transfer to/from dbg target memory */
 722 void
 723 ao_dbg_end_transfer(void);
 724
 725 /* Write a byte to dbg target memory */
 726 void
 727 ao_dbg_write_byte(uint8_t byte);
 728
 729 /* Read a byte from dbg target memory */
 730 uint8_t
 731 ao_dbg_read_byte(void);
 732
 733 /* Enable dbg mode, switching use of the pins */
 734 void
 735 ao_dbg_debug_mode(void);
 736
 737 /* Reset the dbg target */
 738 void
 739 ao_dbg_reset(void);
 740
 741 void
 742 ao_dbg_init(void);
 743
 744 /*
 745  * ao_serial.c
 746  */
 747
 748 #ifndef HAS_SERIAL_1
 749 #error Please define HAS_SERIAL_1
 750 #endif
 751
 752 #if HAS_SERIAL_1
 753 void
 754 ao_serial_rx1_isr(void) __interrupt 3;
 755
 756 void
 757 ao_serial_tx1_isr(void) __interrupt 14;
 758
 759 char
 760 ao_serial_getchar(void) __critical;
 761
 762 void
 763 ao_serial_putchar(char c) __critical;
 764
 765 #define AO_SERIAL_SPEED_4800    0
 766 #define AO_SERIAL_SPEED_9600    1
 767 #define AO_SERIAL_SPEED_57600   2
 768
 769 void
 770 ao_serial_set_speed(uint8_t speed);
 771
 772 void
 773 ao_serial_init(void);
 774 #endif
 775
 776 /*
 777  * ao_spi.c
 778  */
 779
 780 void
 781 ao_spi_send(void __xdata *block, uint16_t len) __reentrant;
 782
 783 void
 784 ao_spi_recv(void __xdata *block, uint16_t len) __reentrant;
 785
 786 void
 787 ao_spi_init(void);
 788
 789 /*
 790  * ao_gps.c
 791  */
 792
 793 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
 794 #define AO_GPS_NUM_SAT_SHIFT    (0)
 795
 796 #define AO_GPS_VALID            (1 << 4)
 797 #define AO_GPS_RUNNING          (1 << 5)
 798 #define AO_GPS_DATE_VALID       (1 << 6)
 799
 800 extern __xdata uint16_t ao_gps_tick;
 801
 802 struct ao_gps_data {
 803         uint8_t                 year;
 804         uint8_t                 month;
 805         uint8_t                 day;
 806         uint8_t                 hour;
 807         uint8_t                 minute;
 808         uint8_t                 second;
 809         uint8_t                 flags;
 810         int32_t                 latitude;       /* degrees * 10⁷ */
 811         int32_t                 longitude;      /* degrees * 10⁷ */
 812         int16_t                 altitude;       /* m */
 813         uint16_t                ground_speed;   /* cm/s */
 814         uint8_t                 course;         /* degrees / 2 */
 815         uint8_t                 hdop;           /* * 5 */
 816         int16_t                 climb_rate;     /* cm/s */
 817         uint16_t                h_error;        /* m */
 818         uint16_t                v_error;        /* m */
 819 };
 820
 821 struct ao_gps_sat_data {
 822         uint8_t         svid;
 823         uint8_t         c_n_1;
 824 };
 825
 826 #define AO_MAX_GPS_TRACKING     12
 827
 828 struct ao_gps_tracking_data {
 829         uint8_t                 channels;
 830         struct ao_gps_sat_data  sats[AO_MAX_GPS_TRACKING];
 831 };
 832
 833 extern __xdata uint8_t ao_gps_mutex;
 834 extern __xdata struct ao_gps_data ao_gps_data;
 835 extern __xdata struct ao_gps_tracking_data ao_gps_tracking_data;
 836
 837 void
 838 ao_gps(void);
 839
 840 void
 841 ao_gps_print(__xdata struct ao_gps_data *gps_data);
 842
 843 void
 844 ao_gps_tracking_print(__xdata struct ao_gps_tracking_data *gps_tracking_data);
 845
 846 void
 847 ao_gps_init(void);
 848
 849 /*
 850  * ao_gps_report.c
 851  */
 852
 853 void
 854 ao_gps_report(void);
 855
 856 void
 857 ao_gps_report_init(void);
 858
 859 /*
 860  * ao_telemetry.c
 861  */
 862
 863 #define AO_MAX_CALLSIGN         8
 864 #define AO_TELEMETRY_VERSION    3
 865
 866 struct ao_telemetry {
 867         uint16_t                serial;
 868         uint16_t                flight;
 869         uint8_t                 flight_state;
 870         int16_t                 flight_accel;
 871         int16_t                 ground_accel;
 872         int32_t                 flight_vel;
 873         int16_t                 flight_pres;
 874         int16_t                 ground_pres;
 875         int16_t                 accel_plus_g;
 876         int16_t                 accel_minus_g;
 877         struct ao_adc           adc;
 878         struct ao_gps_data      gps;
 879         char                    callsign[AO_MAX_CALLSIGN];
 880         struct ao_gps_tracking_data     gps_tracking;
 881 };
 882
 883 /*
 884  * ao_radio_recv tacks on rssi and status bytes
 885  */
 886 struct ao_telemetry_recv {
 887         struct ao_telemetry     telemetry;
 888         int8_t                  rssi;
 889         uint8_t                 status;
 890 };
 891
 892 /* Set delay between telemetry reports (0 to disable) */
 893
 894 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
 895 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(50)
 896 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
 897
 898 void
 899 ao_telemetry_set_interval(uint16_t interval);
 900
 901 void
 902 ao_rdf_set(uint8_t rdf);
 903
 904 void
 905 ao_telemetry_init(void);
 906
 907 /*
 908  * ao_radio.c
 909  */
 910
 911 extern __xdata uint8_t  ao_radio_dma;
 912 extern __xdata uint8_t ao_radio_dma_done;
 913 extern __xdata uint8_t ao_radio_done;
 914 extern __xdata uint8_t ao_radio_mutex;
 915
 916 void
 917 ao_radio_general_isr(void) __interrupt 16;
 918
 919 void
 920 ao_radio_get(void);
 921
 922 #define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
 923
 924 void
 925 ao_radio_set_telemetry(void);
 926
 927 void
 928 ao_radio_set_packet(void);
 929
 930 void
 931 ao_radio_set_rdf(void);
 932
 933 void
 934 ao_radio_send(__xdata void *data, uint8_t size) __reentrant;
 935
 936 uint8_t
 937 ao_radio_recv(__xdata void *data, uint8_t size) __reentrant;
 938
 939 void
 940 ao_radio_recv_abort(void);
 941
 942 void
 943 ao_radio_rdf(int ms);
 944
 945 void
 946 ao_radio_rdf_abort(void);
 947
 948 void
 949 ao_radio_idle(void);
 950
 951 void
 952 ao_radio_init(void);
 953
 954 /*
 955  * ao_monitor.c
 956  */
 957
 958 extern const char const * const ao_state_names[];
 959
 960 void
 961 ao_monitor(void);
 962
 963 void
 964 ao_set_monitor(uint8_t monitoring);
 965
 966 void
 967 ao_monitor_init(uint8_t led, uint8_t monitoring) __reentrant;
 968
 969 /*
 970  * ao_stdio.c
 971  */
 972
 973 #define AO_READ_AGAIN   ((char) -1)
 974
 975 struct ao_stdio {
 976         char    (*pollchar)(void);
 977         void    (*putchar)(char c) __reentrant;
 978         void    (*flush)(void);
 979 };
 980
 981 void
 982 flush(void);
 983
 984 extern __xdata uint8_t ao_stdin_ready;
 985
 986 void
 987 ao_add_stdio(char (*pollchar)(void),
 988              void (*putchar)(char) __reentrant,
 989              void (*flush)(void));
 990
 991 /*
 992  * ao_ignite.c
 993  */
 994
 995 enum ao_igniter {
 996         ao_igniter_drogue = 0,
 997         ao_igniter_main = 1
 998 };
 999
1000 void
1001 ao_ignite(enum ao_igniter igniter);
1002
1003 enum ao_igniter_status {
1004         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
1005         ao_igniter_ready,       /* continuity detected */
1006         ao_igniter_active,      /* igniter firing */
1007         ao_igniter_open,        /* open circuit detected */
1008 };
1009
1010 enum ao_igniter_status
1011 ao_igniter_status(enum ao_igniter igniter);
1012
1013 void
1014 ao_igniter_init(void);
1015
1016 /*
1017  * ao_config.c
1018  */
1019
1020 #define AO_CONFIG_MAJOR 1
1021 #define AO_CONFIG_MINOR 4
1022
1023 struct ao_config {
1024         uint8_t         major;
1025         uint8_t         minor;
1026         uint16_t        main_deploy;
1027         int16_t         accel_plus_g;           /* changed for minor version 2 */
1028         uint8_t         radio_channel;
1029         char            callsign[AO_MAX_CALLSIGN + 1];
1030         uint8_t         apogee_delay;           /* minor version 1 */
1031         int16_t         accel_minus_g;          /* minor version 2 */
1032         uint32_t        radio_cal;              /* minor version 3 */
1033         uint32_t        flight_log_max;         /* minor version 4 */
1034 };
1035
1036 extern __xdata struct ao_config ao_config;
1037
1038 #define AO_CONFIG_MAX_SIZE      128
1039
1040 void
1041 ao_config_get(void);
1042
1043 void
1044 ao_config_put(void);
1045
1046 void
1047 ao_config_init(void);
1048
1049 /*
1050  * ao_rssi.c
1051  */
1052
1053 void
1054 ao_rssi_set(int rssi_value);
1055
1056 void
1057 ao_rssi_init(uint8_t rssi_led);
1058
1059 /*
1060  * ao_product.c
1061  *
1062  * values which need to be defined for
1063  * each instance of a product
1064  */
1065
1066 extern __code __at(0x00aa) uint8_t ao_usb_descriptors [];
1067 extern const char ao_version[];
1068 extern const char ao_manufacturer[];
1069 extern const char ao_product[];
1070
1071 /*
1072  * Fifos
1073  */
1074
1075 #define AO_FIFO_SIZE    32
1076
1077 struct ao_fifo {
1078         uint8_t insert;
1079         uint8_t remove;
1080         char    fifo[AO_FIFO_SIZE];
1081 };
1082
1083 #define ao_fifo_insert(f,c) do { \
1084         (f).fifo[(f).insert] = (c); \
1085         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
1086 } while(0)
1087
1088 #define ao_fifo_remove(f,c) do {\
1089         c = (f).fifo[(f).remove]; \
1090         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
1091 } while(0)
1092
1093 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
1094 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
1095
1096 /*
1097  * ao_packet.c
1098  *
1099  * Packet-based command interface
1100  */
1101
1102 #define AO_PACKET_MAX           64
1103 #define AO_PACKET_SYN           (uint8_t) 0xff
1104
1105 struct ao_packet {
1106         uint8_t         addr;
1107         uint8_t         len;
1108         uint8_t         seq;
1109         uint8_t         ack;
1110         uint8_t         d[AO_PACKET_MAX];
1111         uint8_t         callsign[AO_MAX_CALLSIGN];
1112 };
1113
1114 struct ao_packet_recv {
1115         struct ao_packet        packet;
1116         int8_t                  rssi;
1117         uint8_t                 status;
1118 };
1119
1120 extern __xdata struct ao_packet_recv ao_rx_packet;
1121 extern __xdata struct ao_packet ao_tx_packet;
1122 extern __xdata struct ao_task   ao_packet_task;
1123 extern __xdata uint8_t ao_packet_enable;
1124 extern __xdata uint8_t ao_packet_master_sleeping;
1125 extern __pdata uint8_t ao_packet_rx_len, ao_packet_rx_used, ao_packet_tx_used;
1126
1127 void
1128 ao_packet_send(void);
1129
1130 uint8_t
1131 ao_packet_recv(void);
1132
1133 void
1134 ao_packet_flush(void);
1135
1136 void
1137 ao_packet_putchar(char c) __reentrant;
1138
1139 char
1140 ao_packet_pollchar(void) __critical;
1141
1142 /* ao_packet_master.c */
1143
1144 void
1145 ao_packet_master_init(void);
1146
1147 /* ao_packet_slave.c */
1148
1149 void
1150 ao_packet_slave_start(void);
1151
1152 void
1153 ao_packet_slave_stop(void);
1154
1155 void
1156 ao_packet_slave_init(void);
1157
1158 #endif /* _AO_H_ */