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