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