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