git.gag.com Git - fw/altos/blob - src/core/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 "ao_pins.h"
  26 #include <ao_arch.h>
  27
  28 #define TRUE 1
  29 #define FALSE 0
  30
  31 /* Convert a __data pointer into an __xdata pointer */
  32 #ifndef DATA_TO_XDATA
  33 #define DATA_TO_XDATA(a)        (a)
  34 #endif
  35 #ifndef PDATA_TO_XDATA
  36 #define PDATA_TO_XDATA(a)       (a)
  37 #endif
  38 #ifndef CODE_TO_XDATA
  39 #define CODE_TO_XDATA(a)        (a)
  40 #endif
  41
  42 /* An AltOS task */
  43 struct ao_task {
  44         __xdata void *wchan;            /* current wait channel (NULL if running) */
  45         uint16_t alarm;                 /* abort ao_sleep time */
  46         ao_arch_task_members            /* any architecture-specific fields */
  47         uint8_t task_id;                /* unique id */
  48         __code char *name;              /* task name */
  49         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  50 };
  51
  52 extern __xdata struct ao_task *__data ao_cur_task;
  53
  54 #define AO_NUM_TASKS            16      /* maximum number of tasks */
  55 #define AO_NO_TASK              0       /* no task id */
  56
  57 /*
  58  ao_task.c
  59  */
  60
  61 /* Suspend the current task until wchan is awoken.
  62  * returns:
  63  *  0 on normal wake
  64  *  1 on alarm
  65  */
  66 uint8_t
  67 ao_sleep(__xdata void *wchan);
  68
  69 /* Wake all tasks sleeping on wchan */
  70 void
  71 ao_wakeup(__xdata void *wchan);
  72
  73 /* set an alarm to go off in 'delay' ticks */
  74 void
  75 ao_alarm(uint16_t delay);
  76
  77 /* Clear any pending alarm */
  78 void
  79 ao_clear_alarm(void);
  80
  81 /* Yield the processor to another task */
  82 void
  83 ao_yield(void) ao_arch_naked_declare;
  84
  85 /* Add a task to the run queue */
  86 void
  87 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
  88
  89 /* Terminate the current task */
  90 void
  91 ao_exit(void);
  92
  93 /* Dump task info to console */
  94 void
  95 ao_task_info(void);
  96
  97 /* Start the scheduler. This will not return */
  98 void
  99 ao_start_scheduler(void);
 100
 101 /*
 102  * ao_panic.c
 103  */
 104
 105 #define AO_PANIC_NO_TASK        1       /* AO_NUM_TASKS is not large enough */
 106 #define AO_PANIC_DMA            2       /* Attempt to start DMA while active */
 107 #define AO_PANIC_MUTEX          3       /* Mis-using mutex API */
 108 #define AO_PANIC_EE             4       /* Mis-using eeprom API */
 109 #define AO_PANIC_LOG            5       /* Failing to read/write log data */
 110 #define AO_PANIC_CMD            6       /* Too many command sets registered */
 111 #define AO_PANIC_STDIO          7       /* Too many stdio handlers registered */
 112 #define AO_PANIC_REBOOT         8       /* Reboot failed */
 113 #define AO_PANIC_FLASH          9       /* Invalid flash part (or wrong blocksize) */
 114 #define AO_PANIC_USB            10      /* Trying to send USB packet while busy */
 115 #define AO_PANIC_BT             11      /* Communications with bluetooth device failed */
 116 #define AO_PANIC_STACK          12      /* Stack overflow */
 117 #define AO_PANIC_SPI            13      /* SPI communication failure */
 118 #define AO_PANIC_SELF_TEST      14      /* Self test failure */
 119
 120 /* Stop the operating system, beeping and blinking the reason */
 121 void
 122 ao_panic(uint8_t reason);
 123
 124 /*
 125  * ao_timer.c
 126  */
 127
 128 /* Our timer runs at 100Hz */
 129 #define AO_HERTZ                100
 130 #define AO_MS_TO_TICKS(ms)      ((ms) / (1000 / AO_HERTZ))
 131 #define AO_SEC_TO_TICKS(s)      ((s) * AO_HERTZ)
 132
 133 /* Returns the current time in ticks */
 134 uint16_t
 135 ao_time(void);
 136
 137 /* Suspend the current task until ticks time has passed */
 138 void
 139 ao_delay(uint16_t ticks);
 140
 141 /* Set the ADC interval */
 142 void
 143 ao_timer_set_adc_interval(uint8_t interval) __critical;
 144
 145 /* Timer interrupt */
 146 void
 147 ao_timer_isr(void) ao_arch_interrupt(9);
 148
 149 /* Initialize the timer */
 150 void
 151 ao_timer_init(void);
 152
 153 /* Initialize the hardware clock. Must be called first */
 154 void
 155 ao_clock_init(void);
 156
 157 /*
 158  * ao_mutex.c
 159  */
 160
 161 void
 162 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
 163
 164 void
 165 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 166
 167 /*
 168  * ao_cmd.c
 169  */
 170
 171 enum ao_cmd_status {
 172         ao_cmd_success = 0,
 173         ao_cmd_lex_error = 1,
 174         ao_cmd_syntax_error = 2,
 175 };
 176
 177 extern __pdata uint16_t ao_cmd_lex_i;
 178 extern __pdata uint32_t ao_cmd_lex_u32;
 179 extern __pdata char     ao_cmd_lex_c;
 180 extern __pdata enum ao_cmd_status ao_cmd_status;
 181
 182 void
 183 ao_cmd_lex(void);
 184
 185 void
 186 ao_cmd_put8(uint8_t v);
 187
 188 void
 189 ao_cmd_put16(uint16_t v);
 190
 191 uint8_t
 192 ao_cmd_is_white(void);
 193
 194 void
 195 ao_cmd_white(void);
 196
 197 int8_t
 198 ao_cmd_hexchar(char c);
 199
 200 void
 201 ao_cmd_hexbyte(void);
 202
 203 void
 204 ao_cmd_hex(void);
 205
 206 void
 207 ao_cmd_decimal(void);
 208
 209 uint8_t
 210 ao_match_word(__code char *word);
 211
 212 struct ao_cmds {
 213         void            (*func)(void);
 214         __code char     *help;
 215 };
 216
 217 void
 218 ao_cmd_register(const __code struct ao_cmds *cmds);
 219
 220 void
 221 ao_cmd_init(void);
 222
 223 #if HAS_CMD_FILTER
 224 /*
 225  * Provided by an external module to filter raw command lines
 226  */
 227 uint8_t
 228 ao_cmd_filter(void);
 229 #endif
 230
 231 /*
 232  * Various drivers
 233  */
 234 #if HAS_ADC
 235 #include <ao_adc.h>
 236 #endif
 237
 238 #if HAS_BEEP
 239 #include <ao_beep.h>
 240 #endif
 241
 242 #if LEDS_AVAILABLE
 243 #include <ao_led.h>
 244 #endif
 245
 246 #if HAS_USB
 247 #include <ao_usb.h>
 248 #endif
 249
 250 #if HAS_EEPROM
 251 #include <ao_storage.h>
 252 #endif
 253
 254 #if HAS_LOG
 255 #include <ao_log.h>
 256 #endif
 257
 258 #if HAS_FLIGHT
 259 #include <ao_flight.h>
 260 #include <ao_sample.h>
 261 #endif
 262
 263 /*
 264  * ao_report.c
 265  */
 266
 267 void
 268 ao_report_init(void);
 269
 270 /*
 271  * ao_convert.c
 272  *
 273  * Given raw data, convert to SI units
 274  */
 275
 276 /* pressure from the sensor to altitude in meters */
 277 int16_t
 278 ao_pres_to_altitude(int16_t pres) __reentrant;
 279
 280 int16_t
 281 ao_altitude_to_pres(int16_t alt) __reentrant;
 282
 283 int16_t
 284 ao_temp_to_dC(int16_t temp) __reentrant;
 285
 286 /*
 287  * ao_convert_pa.c
 288  *
 289  * Convert between pressure in Pa and altitude in meters
 290  */
 291
 292 int32_t
 293 ao_pa_to_altitude(int32_t pa);
 294
 295 int32_t
 296 ao_altitude_to_pa(int32_t alt);
 297
 298 #if HAS_DBG
 299 #include <ao_dbg.h>
 300 #endif
 301
 302 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
 303 #include <ao_serial.h>
 304 #endif
 305
 306
 307 /*
 308  * ao_spi_slave.c
 309  */
 310
 311 uint8_t
 312 ao_spi_slave_recv(uint8_t *buf, uint8_t len);
 313
 314 void
 315 ao_spi_slave_send(uint8_t *buf, uint8_t len);
 316
 317 void
 318 ao_spi_slave_init(void);
 319
 320 /* This must be defined by the product; it will get called when chip
 321  * select goes low, at which point it should use ao_spi_read and
 322  * ao_spi_write to deal with the request
 323  */
 324
 325 void
 326 ao_spi_slave(void);
 327
 328 /*
 329  * ao_telemetry.c
 330  */
 331 #define AO_MAX_CALLSIGN                 8
 332 #define AO_MAX_VERSION                  8
 333 #if LEGACY_MONITOR
 334 #define AO_MAX_TELEMETRY                128
 335 #else
 336 #define AO_MAX_TELEMETRY                32
 337 #endif
 338
 339 struct ao_telemetry_generic {
 340         uint16_t        serial;         /* 0 */
 341         uint16_t        tick;           /* 2 */
 342         uint8_t         type;           /* 4 */
 343         uint8_t         payload[27];    /* 5 */
 344         /* 32 */
 345 };
 346
 347 #define AO_TELEMETRY_SENSOR_TELEMETRUM  0x01
 348 #define AO_TELEMETRY_SENSOR_TELEMINI    0x02
 349 #define AO_TELEMETRY_SENSOR_TELENANO    0x03
 350 #define AO_TELEMETRY_SENSOR_MEGAMETRUM  0x08
 351
 352 struct ao_telemetry_sensor {
 353         uint16_t        serial;         /*  0 */
 354         uint16_t        tick;           /*  2 */
 355         uint8_t         type;           /*  4 */
 356
 357         uint8_t         state;          /*  5 flight state */
 358         int16_t         accel;          /*  6 accelerometer (TM only) */
 359         int16_t         pres;           /*  8 pressure sensor */
 360         int16_t         temp;           /* 10 temperature sensor */
 361         int16_t         v_batt;         /* 12 battery voltage */
 362         int16_t         sense_d;        /* 14 drogue continuity sense (TM/Tm) */
 363         int16_t         sense_m;        /* 16 main continuity sense (TM/Tm) */
 364
 365         int16_t         acceleration;   /* 18 m/s² * 16 */
 366         int16_t         speed;          /* 20 m/s * 16 */
 367         int16_t         height;         /* 22 m */
 368
 369         int16_t         ground_pres;    /* 24 average pres on pad */
 370         int16_t         ground_accel;   /* 26 average accel on pad */
 371         int16_t         accel_plus_g;   /* 28 accel calibration at +1g */
 372         int16_t         accel_minus_g;  /* 30 accel calibration at -1g */
 373         /* 32 */
 374 };
 375
 376 #define AO_TELEMETRY_CONFIGURATION      0x04
 377
 378 struct ao_telemetry_configuration {
 379         uint16_t        serial;                         /*  0 */
 380         uint16_t        tick;                           /*  2 */
 381         uint8_t         type;                           /*  4 */
 382
 383         uint8_t         device;                         /*  5 device type */
 384         uint16_t        flight;                         /*  6 flight number */
 385         uint8_t         config_major;                   /*  8 Config major version */
 386         uint8_t         config_minor;                   /*  9 Config minor version */
 387         uint16_t        apogee_delay;                   /* 10 Apogee deploy delay in seconds */
 388         uint16_t        main_deploy;                    /* 12 Main deploy alt in meters */
 389         uint16_t        flight_log_max;                 /* 14 Maximum flight log size in kB */
 390         char            callsign[AO_MAX_CALLSIGN];      /* 16 Radio operator identity */
 391         char            version[AO_MAX_VERSION];        /* 24 Software version */
 392         /* 32 */
 393 };
 394
 395 #define AO_TELEMETRY_LOCATION           0x05
 396
 397 #define AO_GPS_MODE_NOT_VALID           'N'
 398 #define AO_GPS_MODE_AUTONOMOUS          'A'
 399 #define AO_GPS_MODE_DIFFERENTIAL        'D'
 400 #define AO_GPS_MODE_ESTIMATED           'E'
 401 #define AO_GPS_MODE_MANUAL              'M'
 402 #define AO_GPS_MODE_SIMULATED           'S'
 403
 404 struct ao_telemetry_location {
 405         uint16_t        serial;         /*  0 */
 406         uint16_t        tick;           /*  2 */
 407         uint8_t         type;           /*  4 */
 408
 409         uint8_t         flags;          /*  5 Number of sats and other flags */
 410         int16_t         altitude;       /*  6 GPS reported altitude (m) */
 411         int32_t         latitude;       /*  8 latitude (degrees * 10⁷) */
 412         int32_t         longitude;      /* 12 longitude (degrees * 10⁷) */
 413         uint8_t         year;           /* 16 (- 2000) */
 414         uint8_t         month;          /* 17 (1-12) */
 415         uint8_t         day;            /* 18 (1-31) */
 416         uint8_t         hour;           /* 19 (0-23) */
 417         uint8_t         minute;         /* 20 (0-59) */
 418         uint8_t         second;         /* 21 (0-59) */
 419         uint8_t         pdop;           /* 22 (m * 5) */
 420         uint8_t         hdop;           /* 23 (m * 5) */
 421         uint8_t         vdop;           /* 24 (m * 5) */
 422         uint8_t         mode;           /* 25 */
 423         uint16_t        ground_speed;   /* 26 cm/s */
 424         int16_t         climb_rate;     /* 28 cm/s */
 425         uint8_t         course;         /* 30 degrees / 2 */
 426         uint8_t         unused[1];      /* 31 */
 427         /* 32 */
 428 };
 429
 430 #define AO_TELEMETRY_SATELLITE          0x06
 431
 432 struct ao_telemetry_satellite_info {
 433         uint8_t         svid;
 434         uint8_t         c_n_1;
 435 };
 436
 437 struct ao_telemetry_satellite {
 438         uint16_t                                serial;         /*  0 */
 439         uint16_t                                tick;           /*  2 */
 440         uint8_t                                 type;           /*  4 */
 441         uint8_t                                 channels;       /*  5 number of reported sats */
 442
 443         struct ao_telemetry_satellite_info      sats[12];       /* 6 */
 444         uint8_t                                 unused[2];      /* 30 */
 445         /* 32 */
 446 };
 447
 448 #define AO_TELEMETRY_COMPANION          0x07
 449
 450 #define AO_COMPANION_MAX_CHANNELS       12
 451
 452 struct ao_telemetry_companion {
 453         uint16_t                                serial;         /*  0 */
 454         uint16_t                                tick;           /*  2 */
 455         uint8_t                                 type;           /*  4 */
 456         uint8_t                                 board_id;       /*  5 */
 457
 458         uint8_t                                 update_period;  /*  6 */
 459         uint8_t                                 channels;       /*  7 */
 460         uint16_t                                companion_data[AO_COMPANION_MAX_CHANNELS];      /*  8 */
 461         /* 32 */
 462 };
 463
 464 /* #define AO_SEND_ALL_BARO */
 465
 466 #define AO_TELEMETRY_BARO               0x80
 467
 468 /*
 469  * This packet allows the full sampling rate baro
 470  * data to be captured over the RF link so that the
 471  * flight software can be tested using 'real' data.
 472  *
 473  * Along with this telemetry packet, the flight
 474  * code is modified to send full-rate telemetry all the time
 475  * and never send an RDF tone; this ensure that the full radio
 476  * link is available.
 477  */
 478 struct ao_telemetry_baro {
 479         uint16_t                                serial;         /*  0 */
 480         uint16_t                                tick;           /*  2 */
 481         uint8_t                                 type;           /*  4 */
 482         uint8_t                                 samples;        /*  5 number samples */
 483
 484         int16_t                                 baro[12];       /* 6 samples */
 485         /* 32 */
 486 };
 487
 488 union ao_telemetry_all {
 489         struct ao_telemetry_generic             generic;
 490         struct ao_telemetry_sensor              sensor;
 491         struct ao_telemetry_configuration       configuration;
 492         struct ao_telemetry_location            location;
 493         struct ao_telemetry_satellite           satellite;
 494         struct ao_telemetry_companion           companion;
 495         struct ao_telemetry_baro                baro;
 496 };
 497
 498 struct ao_telemetry_all_recv {
 499         union ao_telemetry_all          telemetry;
 500         int8_t                          rssi;
 501         uint8_t                         status;
 502 };
 503
 504 /*
 505  * ao_gps.c
 506  */
 507
 508 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
 509 #define AO_GPS_NUM_SAT_SHIFT    (0)
 510
 511 #define AO_GPS_VALID            (1 << 4)
 512 #define AO_GPS_RUNNING          (1 << 5)
 513 #define AO_GPS_DATE_VALID       (1 << 6)
 514 #define AO_GPS_COURSE_VALID     (1 << 7)
 515
 516 extern __pdata uint16_t ao_gps_tick;
 517 extern __xdata uint8_t ao_gps_mutex;
 518 extern __xdata struct ao_telemetry_location ao_gps_data;
 519 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
 520
 521 struct ao_gps_orig {
 522         uint8_t                 year;
 523         uint8_t                 month;
 524         uint8_t                 day;
 525         uint8_t                 hour;
 526         uint8_t                 minute;
 527         uint8_t                 second;
 528         uint8_t                 flags;
 529         int32_t                 latitude;       /* degrees * 10⁷ */
 530         int32_t                 longitude;      /* degrees * 10⁷ */
 531         int16_t                 altitude;       /* m */
 532         uint16_t                ground_speed;   /* cm/s */
 533         uint8_t                 course;         /* degrees / 2 */
 534         uint8_t                 hdop;           /* * 5 */
 535         int16_t                 climb_rate;     /* cm/s */
 536         uint16_t                h_error;        /* m */
 537         uint16_t                v_error;        /* m */
 538 };
 539
 540 struct ao_gps_sat_orig {
 541         uint8_t         svid;
 542         uint8_t         c_n_1;
 543 };
 544
 545 #define AO_MAX_GPS_TRACKING     12
 546
 547 struct ao_gps_tracking_orig {
 548         uint8_t                 channels;
 549         struct ao_gps_sat_orig  sats[AO_MAX_GPS_TRACKING];
 550 };
 551
 552 void
 553 ao_gps(void);
 554
 555 void
 556 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
 557
 558 void
 559 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
 560
 561 void
 562 ao_gps_init(void);
 563
 564 /*
 565  * ao_gps_report.c
 566  */
 567
 568 void
 569 ao_gps_report(void);
 570
 571 void
 572 ao_gps_report_init(void);
 573
 574 /*
 575  * ao_telemetry_orig.c
 576  */
 577
 578 struct ao_adc_orig {
 579         uint16_t        tick;           /* tick when the sample was read */
 580         int16_t         accel;          /* accelerometer */
 581         int16_t         pres;           /* pressure sensor */
 582         int16_t         temp;           /* temperature sensor */
 583         int16_t         v_batt;         /* battery voltage */
 584         int16_t         sense_d;        /* drogue continuity sense */
 585         int16_t         sense_m;        /* main continuity sense */
 586 };
 587
 588 struct ao_telemetry_orig {
 589         uint16_t                serial;
 590         uint16_t                flight;
 591         uint8_t                 flight_state;
 592         int16_t                 accel;
 593         int16_t                 ground_accel;
 594         union {
 595                 struct {
 596                         int16_t                 speed;
 597                         int16_t                 unused;
 598                 } k;
 599                 int32_t         flight_vel;
 600         } u;
 601         int16_t                 height;
 602         int16_t                 ground_pres;
 603         int16_t                 accel_plus_g;
 604         int16_t                 accel_minus_g;
 605         struct ao_adc_orig      adc;
 606         struct ao_gps_orig      gps;
 607         char                    callsign[AO_MAX_CALLSIGN];
 608         struct ao_gps_tracking_orig     gps_tracking;
 609 };
 610
 611 struct ao_telemetry_tiny {
 612         uint16_t                serial;
 613         uint16_t                flight;
 614         uint8_t                 flight_state;
 615         int16_t                 height;         /* AGL in meters */
 616         int16_t                 speed;          /* in m/s * 16 */
 617         int16_t                 accel;          /* in m/s² * 16 */
 618         int16_t                 ground_pres;    /* sensor units */
 619         struct ao_adc           adc;            /* raw ADC readings */
 620         char                    callsign[AO_MAX_CALLSIGN];
 621 };
 622
 623 struct ao_telemetry_orig_recv {
 624         struct ao_telemetry_orig        telemetry_orig;
 625         int8_t                          rssi;
 626         uint8_t                         status;
 627 };
 628
 629 struct ao_telemetry_tiny_recv {
 630         struct ao_telemetry_tiny        telemetry_tiny;
 631         int8_t                          rssi;
 632         uint8_t                         status;
 633 };
 634
 635 /*
 636  * ao_radio_recv tacks on rssi and status bytes
 637  */
 638
 639 struct ao_telemetry_raw_recv {
 640         uint8_t                 packet[AO_MAX_TELEMETRY + 2];
 641 };
 642
 643 /* Set delay between telemetry reports (0 to disable) */
 644
 645 #ifdef AO_SEND_ALL_BARO
 646 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(100)
 647 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
 648 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(100)
 649 #else
 650 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
 651 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
 652 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
 653 #endif
 654
 655 void
 656 ao_telemetry_set_interval(uint16_t interval);
 657
 658 void
 659 ao_rdf_set(uint8_t rdf);
 660
 661 void
 662 ao_telemetry_init(void);
 663
 664 void
 665 ao_telemetry_orig_init(void);
 666
 667 void
 668 ao_telemetry_tiny_init(void);
 669
 670 /*
 671  * ao_radio.c
 672  */
 673
 674 extern __xdata uint8_t  ao_radio_dma;
 675 extern __xdata uint8_t ao_radio_dma_done;
 676 extern __xdata uint8_t ao_radio_done;
 677 extern __xdata uint8_t ao_radio_mutex;
 678
 679 void
 680 ao_radio_general_isr(void) ao_arch_interrupt(16);
 681
 682 void
 683 ao_radio_get(uint8_t len);
 684
 685 #define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
 686
 687 void
 688 ao_radio_set_packet(void);
 689
 690 void
 691 ao_radio_send(__xdata void *d, uint8_t size) __reentrant;
 692
 693 uint8_t
 694 ao_radio_recv(__xdata void *d, uint8_t size) __reentrant;
 695
 696 void
 697 ao_radio_recv_abort(void);
 698
 699 /*
 700  * Compute the packet length as follows:
 701  *
 702  * 2000 bps (for a 1kHz tone)
 703  * so, for 'ms' milliseconds, we need
 704  * 2 * ms bits, or ms / 4 bytes
 705  */
 706
 707 #define AO_MS_TO_RDF_LEN(ms) ((ms) > 255 * 4 ? 255 : ((ms) >> 2))
 708
 709 void
 710 ao_radio_rdf(uint8_t pkt_len);
 711
 712 void
 713 ao_radio_rdf_abort(void);
 714
 715 void
 716 ao_radio_idle(void);
 717
 718 void
 719 ao_radio_init(void);
 720
 721 /*
 722  * ao_monitor.c
 723  */
 724
 725 extern const char const * const ao_state_names[];
 726
 727 #define AO_MONITOR_RING 8
 728
 729 union ao_monitor {
 730         struct ao_telemetry_raw_recv    raw;
 731         struct ao_telemetry_all_recv    all;
 732         struct ao_telemetry_orig_recv   orig;
 733         struct ao_telemetry_tiny_recv   tiny;
 734 };
 735
 736 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
 737
 738 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
 739
 740 extern __data uint8_t ao_monitoring;
 741 extern __data uint8_t ao_monitor_head;
 742
 743 void
 744 ao_monitor(void);
 745
 746 #define AO_MONITORING_OFF       0
 747 #define AO_MONITORING_ORIG      1
 748
 749 void
 750 ao_monitor_set(uint8_t monitoring);
 751
 752 void
 753 ao_monitor_disable(void);
 754
 755 void
 756 ao_monitor_enable(void);
 757
 758 void
 759 ao_monitor_init(void) __reentrant;
 760
 761 /*
 762  * ao_stdio.c
 763  */
 764
 765 #define AO_READ_AGAIN   ((char) -1)
 766
 767 struct ao_stdio {
 768         char    (*pollchar)(void);
 769         void    (*putchar)(char c) __reentrant;
 770         void    (*flush)(void);
 771         uint8_t echo;
 772 };
 773
 774 extern __xdata struct ao_stdio ao_stdios[];
 775 extern __pdata int8_t ao_cur_stdio;
 776 extern __pdata int8_t ao_num_stdios;
 777
 778 void
 779 flush(void);
 780
 781 extern __xdata uint8_t ao_stdin_ready;
 782
 783 uint8_t
 784 ao_echo(void);
 785
 786 int8_t
 787 ao_add_stdio(char (*pollchar)(void),
 788              void (*putchar)(char) __reentrant,
 789              void (*flush)(void)) __reentrant;
 790
 791 /*
 792  * ao_ignite.c
 793  */
 794
 795 enum ao_igniter {
 796         ao_igniter_drogue = 0,
 797         ao_igniter_main = 1
 798 };
 799
 800 void
 801 ao_ignite(enum ao_igniter igniter);
 802
 803 enum ao_igniter_status {
 804         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
 805         ao_igniter_ready,       /* continuity detected */
 806         ao_igniter_active,      /* igniter firing */
 807         ao_igniter_open,        /* open circuit detected */
 808 };
 809
 810 struct ao_ignition {
 811         uint8_t request;
 812         uint8_t fired;
 813         uint8_t firing;
 814 };
 815
 816 extern __xdata struct ao_ignition ao_ignition[2];
 817
 818 enum ao_igniter_status
 819 ao_igniter_status(enum ao_igniter igniter);
 820
 821 extern __pdata uint8_t ao_igniter_present;
 822
 823 void
 824 ao_ignite_set_pins(void);
 825
 826 void
 827 ao_igniter_init(void);
 828
 829 /*
 830  * ao_config.c
 831  */
 832
 833 #define AO_CONFIG_MAJOR 1
 834 #define AO_CONFIG_MINOR 11
 835
 836 #define AO_AES_LEN 16
 837
 838 struct ao_config {
 839         uint8_t         major;
 840         uint8_t         minor;
 841         uint16_t        main_deploy;
 842         int16_t         accel_plus_g;           /* changed for minor version 2 */
 843         uint8_t         _legacy_radio_channel;
 844         char            callsign[AO_MAX_CALLSIGN + 1];
 845         uint8_t         apogee_delay;           /* minor version 1 */
 846         int16_t         accel_minus_g;          /* minor version 2 */
 847         uint32_t        radio_cal;              /* minor version 3 */
 848         uint32_t        flight_log_max;         /* minor version 4 */
 849         uint8_t         ignite_mode;            /* minor version 5 */
 850         uint8_t         pad_orientation;        /* minor version 6 */
 851         uint32_t        radio_setting;          /* minor version 7 */
 852         uint8_t         radio_enable;           /* minor version 8 */
 853         uint8_t         aes_key[AO_AES_LEN];    /* minor version 9 */
 854         uint32_t        frequency;              /* minor version 10 */
 855         uint16_t        apogee_lockout;         /* minor version 11 */
 856 };
 857
 858 #define AO_IGNITE_MODE_DUAL             0
 859 #define AO_IGNITE_MODE_APOGEE           1
 860 #define AO_IGNITE_MODE_MAIN             2
 861
 862 #define AO_PAD_ORIENTATION_ANTENNA_UP   0
 863 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
 864
 865 extern __xdata struct ao_config ao_config;
 866
 867 #define AO_CONFIG_MAX_SIZE      128
 868
 869 void
 870 ao_config_get(void);
 871
 872 void
 873 ao_config_put(void);
 874
 875 void
 876 ao_config_set_radio(void);
 877
 878 void
 879 ao_config_init(void);
 880
 881 /*
 882  * ao_rssi.c
 883  */
 884
 885 void
 886 ao_rssi_set(int rssi_value);
 887
 888 void
 889 ao_rssi_init(uint8_t rssi_led);
 890
 891 /*
 892  * ao_product.c
 893  *
 894  * values which need to be defined for
 895  * each instance of a product
 896  */
 897
 898 extern const char ao_version[];
 899 extern const char ao_manufacturer[];
 900 extern const char ao_product[];
 901
 902 /*
 903  * Fifos
 904  */
 905
 906 #define AO_FIFO_SIZE    32
 907
 908 struct ao_fifo {
 909         uint8_t insert;
 910         uint8_t remove;
 911         char    fifo[AO_FIFO_SIZE];
 912 };
 913
 914 #define ao_fifo_insert(f,c) do { \
 915         (f).fifo[(f).insert] = (c); \
 916         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
 917 } while(0)
 918
 919 #define ao_fifo_remove(f,c) do {\
 920         c = (f).fifo[(f).remove]; \
 921         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
 922 } while(0)
 923
 924 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
 925 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
 926
 927 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
 928 #include <ao_packet.h>
 929 #endif
 930
 931 #if HAS_BTM
 932 #include <ao_btm.h>
 933 #endif
 934
 935 #if HAS_COMPANION
 936 #include <ao_companion.h>
 937 #endif
 938
 939 #if HAS_LCD
 940 #include <ao_lcd.h>
 941 #endif
 942
 943 #if HAS_AES
 944 #include <ao_aes.h>
 945 #endif
 946
 947 /* ao_launch.c */
 948
 949 struct ao_launch_command {
 950         uint16_t        tick;
 951         uint16_t        serial;
 952         uint8_t         cmd;
 953         uint8_t         channel;
 954         uint16_t        unused;
 955 };
 956
 957 #define AO_LAUNCH_QUERY         1
 958
 959 struct ao_launch_query {
 960         uint16_t        tick;
 961         uint16_t        serial;
 962         uint8_t         channel;
 963         uint8_t         valid;
 964         uint8_t         arm_status;
 965         uint8_t         igniter_status;
 966 };
 967
 968 #define AO_LAUNCH_ARM           2
 969 #define AO_LAUNCH_FIRE          3
 970
 971 void
 972 ao_launch_init(void);
 973
 974 /*
 975  * ao_log_single.c
 976  */
 977
 978 #define AO_LOG_TELESCIENCE_START        ((uint8_t) 's')
 979 #define AO_LOG_TELESCIENCE_DATA         ((uint8_t) 'd')
 980
 981 #define AO_LOG_TELESCIENCE_NUM_ADC      12
 982
 983 struct ao_log_telescience {
 984         uint8_t         type;
 985         uint8_t         csum;
 986         uint16_t        tick;
 987         uint16_t        tm_tick;
 988         uint8_t         tm_state;
 989         uint8_t         unused;
 990         uint16_t        adc[AO_LOG_TELESCIENCE_NUM_ADC];
 991 };
 992
 993 #define AO_LOG_SINGLE_SIZE              32
 994
 995 union ao_log_single {
 996         struct ao_log_telescience       telescience;
 997         union ao_telemetry_all          telemetry;
 998         uint8_t                         bytes[AO_LOG_SINGLE_SIZE];
 999 };
1000
1001 extern __xdata union ao_log_single      ao_log_single_write_data;
1002 extern __xdata union ao_log_single      ao_log_single_read_data;
1003
1004 void
1005 ao_log_single_extra_query(void);
1006
1007 void
1008 ao_log_single_list(void);
1009
1010 void
1011 ao_log_single_main(void);
1012
1013 uint8_t
1014 ao_log_single_write(void);
1015
1016 uint8_t
1017 ao_log_single_read(uint32_t pos);
1018
1019 void
1020 ao_log_single_start(void);
1021
1022 void
1023 ao_log_single_stop(void);
1024
1025 void
1026 ao_log_single_restart(void);
1027
1028 void
1029 ao_log_single_set(void);
1030
1031 void
1032 ao_log_single_delete(void);
1033
1034 void
1035 ao_log_single_init(void);
1036
1037 void
1038 ao_log_single(void);
1039
1040 /*
1041  * ao_pyro_slave.c
1042  */
1043
1044 #define AO_TELEPYRO_NUM_ADC     9
1045
1046 #ifndef ao_xmemcpy
1047 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
1048 #define ao_xmemset(d,v,c) memset(d,v,c)
1049 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
1050 #endif
1051
1052 /*
1053  * ao_terraui.c
1054  */
1055
1056 void
1057 ao_terraui_init(void);
1058
1059 /*
1060  * ao_battery.c
1061  */
1062
1063 #ifdef BATTERY_PIN
1064 void
1065 ao_battery_isr(void) ao_arch_interrupt(1);
1066
1067 uint16_t
1068 ao_battery_get(void);
1069
1070 void
1071 ao_battery_init(void);
1072 #endif /* BATTERY_PIN */
1073
1074 /*
1075  * ao_sqrt.c
1076  */
1077
1078 uint32_t
1079 ao_sqrt(uint32_t op);
1080
1081 /*
1082  * ao_freq.c
1083  */
1084
1085 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
1086
1087 #include <ao_arch_funcs.h>
1088
1089 /*
1090  * ao_ms5607.c
1091  */
1092
1093 void ao_ms5607_init(void);
1094
1095 #endif /* _AO_H_ */