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
 351 struct ao_telemetry_sensor {
 352         uint16_t        serial;         /*  0 */
 353         uint16_t        tick;           /*  2 */
 354         uint8_t         type;           /*  4 */
 355
 356         uint8_t         state;          /*  5 flight state */
 357         int16_t         accel;          /*  6 accelerometer (TM only) */
 358         int16_t         pres;           /*  8 pressure sensor */
 359         int16_t         temp;           /* 10 temperature sensor */
 360         int16_t         v_batt;         /* 12 battery voltage */
 361         int16_t         sense_d;        /* 14 drogue continuity sense (TM/Tm) */
 362         int16_t         sense_m;        /* 16 main continuity sense (TM/Tm) */
 363
 364         int16_t         acceleration;   /* 18 m/s² * 16 */
 365         int16_t         speed;          /* 20 m/s * 16 */
 366         int16_t         height;         /* 22 m */
 367
 368         int16_t         ground_pres;    /* 24 average pres on pad */
 369         int16_t         ground_accel;   /* 26 average accel on pad */
 370         int16_t         accel_plus_g;   /* 28 accel calibration at +1g */
 371         int16_t         accel_minus_g;  /* 30 accel calibration at -1g */
 372         /* 32 */
 373 };
 374
 375 #define AO_TELEMETRY_CONFIGURATION      0x04
 376
 377 struct ao_telemetry_configuration {
 378         uint16_t        serial;                         /*  0 */
 379         uint16_t        tick;                           /*  2 */
 380         uint8_t         type;                           /*  4 */
 381
 382         uint8_t         device;                         /*  5 device type */
 383         uint16_t        flight;                         /*  6 flight number */
 384         uint8_t         config_major;                   /*  8 Config major version */
 385         uint8_t         config_minor;                   /*  9 Config minor version */
 386         uint16_t        apogee_delay;                   /* 10 Apogee deploy delay in seconds */
 387         uint16_t        main_deploy;                    /* 12 Main deploy alt in meters */
 388         uint16_t        flight_log_max;                 /* 14 Maximum flight log size in kB */
 389         char            callsign[AO_MAX_CALLSIGN];      /* 16 Radio operator identity */
 390         char            version[AO_MAX_VERSION];        /* 24 Software version */
 391         /* 32 */
 392 };
 393
 394 #define AO_TELEMETRY_LOCATION           0x05
 395
 396 #define AO_GPS_MODE_NOT_VALID           'N'
 397 #define AO_GPS_MODE_AUTONOMOUS          'A'
 398 #define AO_GPS_MODE_DIFFERENTIAL        'D'
 399 #define AO_GPS_MODE_ESTIMATED           'E'
 400 #define AO_GPS_MODE_MANUAL              'M'
 401 #define AO_GPS_MODE_SIMULATED           'S'
 402
 403 struct ao_telemetry_location {
 404         uint16_t        serial;         /*  0 */
 405         uint16_t        tick;           /*  2 */
 406         uint8_t         type;           /*  4 */
 407
 408         uint8_t         flags;          /*  5 Number of sats and other flags */
 409         int16_t         altitude;       /*  6 GPS reported altitude (m) */
 410         int32_t         latitude;       /*  8 latitude (degrees * 10⁷) */
 411         int32_t         longitude;      /* 12 longitude (degrees * 10⁷) */
 412         uint8_t         year;           /* 16 (- 2000) */
 413         uint8_t         month;          /* 17 (1-12) */
 414         uint8_t         day;            /* 18 (1-31) */
 415         uint8_t         hour;           /* 19 (0-23) */
 416         uint8_t         minute;         /* 20 (0-59) */
 417         uint8_t         second;         /* 21 (0-59) */
 418         uint8_t         pdop;           /* 22 (m * 5) */
 419         uint8_t         hdop;           /* 23 (m * 5) */
 420         uint8_t         vdop;           /* 24 (m * 5) */
 421         uint8_t         mode;           /* 25 */
 422         uint16_t        ground_speed;   /* 26 cm/s */
 423         int16_t         climb_rate;     /* 28 cm/s */
 424         uint8_t         course;         /* 30 degrees / 2 */
 425         uint8_t         unused[1];      /* 31 */
 426         /* 32 */
 427 };
 428
 429 #define AO_TELEMETRY_SATELLITE          0x06
 430
 431 struct ao_telemetry_satellite_info {
 432         uint8_t         svid;
 433         uint8_t         c_n_1;
 434 };
 435
 436 struct ao_telemetry_satellite {
 437         uint16_t                                serial;         /*  0 */
 438         uint16_t                                tick;           /*  2 */
 439         uint8_t                                 type;           /*  4 */
 440         uint8_t                                 channels;       /*  5 number of reported sats */
 441
 442         struct ao_telemetry_satellite_info      sats[12];       /* 6 */
 443         uint8_t                                 unused[2];      /* 30 */
 444         /* 32 */
 445 };
 446
 447 #define AO_TELEMETRY_COMPANION          0x07
 448
 449 #define AO_COMPANION_MAX_CHANNELS       12
 450
 451 struct ao_telemetry_companion {
 452         uint16_t                                serial;         /*  0 */
 453         uint16_t                                tick;           /*  2 */
 454         uint8_t                                 type;           /*  4 */
 455         uint8_t                                 board_id;       /*  5 */
 456
 457         uint8_t                                 update_period;  /*  6 */
 458         uint8_t                                 channels;       /*  7 */
 459         uint16_t                                companion_data[AO_COMPANION_MAX_CHANNELS];      /*  8 */
 460         /* 32 */
 461 };
 462
 463 /* #define AO_SEND_ALL_BARO */
 464
 465 #define AO_TELEMETRY_BARO               0x80
 466
 467 /*
 468  * This packet allows the full sampling rate baro
 469  * data to be captured over the RF link so that the
 470  * flight software can be tested using 'real' data.
 471  *
 472  * Along with this telemetry packet, the flight
 473  * code is modified to send full-rate telemetry all the time
 474  * and never send an RDF tone; this ensure that the full radio
 475  * link is available.
 476  */
 477 struct ao_telemetry_baro {
 478         uint16_t                                serial;         /*  0 */
 479         uint16_t                                tick;           /*  2 */
 480         uint8_t                                 type;           /*  4 */
 481         uint8_t                                 samples;        /*  5 number samples */
 482
 483         int16_t                                 baro[12];       /* 6 samples */
 484         /* 32 */
 485 };
 486
 487 union ao_telemetry_all {
 488         struct ao_telemetry_generic             generic;
 489         struct ao_telemetry_sensor              sensor;
 490         struct ao_telemetry_configuration       configuration;
 491         struct ao_telemetry_location            location;
 492         struct ao_telemetry_satellite           satellite;
 493         struct ao_telemetry_companion           companion;
 494         struct ao_telemetry_baro                baro;
 495 };
 496
 497 struct ao_telemetry_all_recv {
 498         union ao_telemetry_all          telemetry;
 499         int8_t                          rssi;
 500         uint8_t                         status;
 501 };
 502
 503 /*
 504  * ao_gps.c
 505  */
 506
 507 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
 508 #define AO_GPS_NUM_SAT_SHIFT    (0)
 509
 510 #define AO_GPS_VALID            (1 << 4)
 511 #define AO_GPS_RUNNING          (1 << 5)
 512 #define AO_GPS_DATE_VALID       (1 << 6)
 513 #define AO_GPS_COURSE_VALID     (1 << 7)
 514
 515 extern __pdata uint16_t ao_gps_tick;
 516 extern __xdata uint8_t ao_gps_mutex;
 517 extern __xdata struct ao_telemetry_location ao_gps_data;
 518 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
 519
 520 struct ao_gps_orig {
 521         uint8_t                 year;
 522         uint8_t                 month;
 523         uint8_t                 day;
 524         uint8_t                 hour;
 525         uint8_t                 minute;
 526         uint8_t                 second;
 527         uint8_t                 flags;
 528         int32_t                 latitude;       /* degrees * 10⁷ */
 529         int32_t                 longitude;      /* degrees * 10⁷ */
 530         int16_t                 altitude;       /* m */
 531         uint16_t                ground_speed;   /* cm/s */
 532         uint8_t                 course;         /* degrees / 2 */
 533         uint8_t                 hdop;           /* * 5 */
 534         int16_t                 climb_rate;     /* cm/s */
 535         uint16_t                h_error;        /* m */
 536         uint16_t                v_error;        /* m */
 537 };
 538
 539 struct ao_gps_sat_orig {
 540         uint8_t         svid;
 541         uint8_t         c_n_1;
 542 };
 543
 544 #define AO_MAX_GPS_TRACKING     12
 545
 546 struct ao_gps_tracking_orig {
 547         uint8_t                 channels;
 548         struct ao_gps_sat_orig  sats[AO_MAX_GPS_TRACKING];
 549 };
 550
 551 void
 552 ao_gps(void);
 553
 554 void
 555 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
 556
 557 void
 558 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
 559
 560 void
 561 ao_gps_init(void);
 562
 563 /*
 564  * ao_gps_report.c
 565  */
 566
 567 void
 568 ao_gps_report(void);
 569
 570 void
 571 ao_gps_report_init(void);
 572
 573 /*
 574  * ao_telemetry_orig.c
 575  */
 576
 577 struct ao_adc_orig {
 578         uint16_t        tick;           /* tick when the sample was read */
 579         int16_t         accel;          /* accelerometer */
 580         int16_t         pres;           /* pressure sensor */
 581         int16_t         temp;           /* temperature sensor */
 582         int16_t         v_batt;         /* battery voltage */
 583         int16_t         sense_d;        /* drogue continuity sense */
 584         int16_t         sense_m;        /* main continuity sense */
 585 };
 586
 587 struct ao_telemetry_orig {
 588         uint16_t                serial;
 589         uint16_t                flight;
 590         uint8_t                 flight_state;
 591         int16_t                 accel;
 592         int16_t                 ground_accel;
 593         union {
 594                 struct {
 595                         int16_t                 speed;
 596                         int16_t                 unused;
 597                 } k;
 598                 int32_t         flight_vel;
 599         } u;
 600         int16_t                 height;
 601         int16_t                 ground_pres;
 602         int16_t                 accel_plus_g;
 603         int16_t                 accel_minus_g;
 604         struct ao_adc_orig      adc;
 605         struct ao_gps_orig      gps;
 606         char                    callsign[AO_MAX_CALLSIGN];
 607         struct ao_gps_tracking_orig     gps_tracking;
 608 };
 609
 610 struct ao_telemetry_tiny {
 611         uint16_t                serial;
 612         uint16_t                flight;
 613         uint8_t                 flight_state;
 614         int16_t                 height;         /* AGL in meters */
 615         int16_t                 speed;          /* in m/s * 16 */
 616         int16_t                 accel;          /* in m/s² * 16 */
 617         int16_t                 ground_pres;    /* sensor units */
 618         struct ao_adc           adc;            /* raw ADC readings */
 619         char                    callsign[AO_MAX_CALLSIGN];
 620 };
 621
 622 struct ao_telemetry_orig_recv {
 623         struct ao_telemetry_orig        telemetry_orig;
 624         int8_t                          rssi;
 625         uint8_t                         status;
 626 };
 627
 628 struct ao_telemetry_tiny_recv {
 629         struct ao_telemetry_tiny        telemetry_tiny;
 630         int8_t                          rssi;
 631         uint8_t                         status;
 632 };
 633
 634 /*
 635  * ao_radio_recv tacks on rssi and status bytes
 636  */
 637
 638 struct ao_telemetry_raw_recv {
 639         uint8_t                 packet[AO_MAX_TELEMETRY + 2];
 640 };
 641
 642 /* Set delay between telemetry reports (0 to disable) */
 643
 644 #ifdef AO_SEND_ALL_BARO
 645 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(100)
 646 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
 647 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(100)
 648 #else
 649 #define AO_TELEMETRY_INTERVAL_PAD       AO_MS_TO_TICKS(1000)
 650 #define AO_TELEMETRY_INTERVAL_FLIGHT    AO_MS_TO_TICKS(100)
 651 #define AO_TELEMETRY_INTERVAL_RECOVER   AO_MS_TO_TICKS(1000)
 652 #endif
 653
 654 void
 655 ao_telemetry_set_interval(uint16_t interval);
 656
 657 void
 658 ao_rdf_set(uint8_t rdf);
 659
 660 void
 661 ao_telemetry_init(void);
 662
 663 void
 664 ao_telemetry_orig_init(void);
 665
 666 void
 667 ao_telemetry_tiny_init(void);
 668
 669 /*
 670  * ao_radio.c
 671  */
 672
 673 extern __xdata uint8_t  ao_radio_dma;
 674 extern __xdata uint8_t ao_radio_dma_done;
 675 extern __xdata uint8_t ao_radio_done;
 676 extern __xdata uint8_t ao_radio_mutex;
 677
 678 void
 679 ao_radio_general_isr(void) ao_arch_interrupt(16);
 680
 681 void
 682 ao_radio_get(uint8_t len);
 683
 684 #define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
 685
 686 void
 687 ao_radio_set_packet(void);
 688
 689 void
 690 ao_radio_send(__xdata void *d, uint8_t size) __reentrant;
 691
 692 uint8_t
 693 ao_radio_recv(__xdata void *d, uint8_t size) __reentrant;
 694
 695 void
 696 ao_radio_recv_abort(void);
 697
 698 /*
 699  * Compute the packet length as follows:
 700  *
 701  * 2000 bps (for a 1kHz tone)
 702  * so, for 'ms' milliseconds, we need
 703  * 2 * ms bits, or ms / 4 bytes
 704  */
 705
 706 #define AO_MS_TO_RDF_LEN(ms) ((ms) > 255 * 4 ? 255 : ((ms) >> 2))
 707
 708 void
 709 ao_radio_rdf(uint8_t pkt_len);
 710
 711 void
 712 ao_radio_rdf_abort(void);
 713
 714 void
 715 ao_radio_idle(void);
 716
 717 void
 718 ao_radio_init(void);
 719
 720 /*
 721  * ao_monitor.c
 722  */
 723
 724 extern const char const * const ao_state_names[];
 725
 726 #define AO_MONITOR_RING 8
 727
 728 union ao_monitor {
 729         struct ao_telemetry_raw_recv    raw;
 730         struct ao_telemetry_all_recv    all;
 731         struct ao_telemetry_orig_recv   orig;
 732         struct ao_telemetry_tiny_recv   tiny;
 733 };
 734
 735 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
 736
 737 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
 738
 739 extern __data uint8_t ao_monitoring;
 740 extern __data uint8_t ao_monitor_head;
 741
 742 void
 743 ao_monitor(void);
 744
 745 #define AO_MONITORING_OFF       0
 746 #define AO_MONITORING_ORIG      1
 747
 748 void
 749 ao_monitor_set(uint8_t monitoring);
 750
 751 void
 752 ao_monitor_disable(void);
 753
 754 void
 755 ao_monitor_enable(void);
 756
 757 void
 758 ao_monitor_init(void) __reentrant;
 759
 760 /*
 761  * ao_stdio.c
 762  */
 763
 764 #define AO_READ_AGAIN   ((char) -1)
 765
 766 struct ao_stdio {
 767         char    (*pollchar)(void);
 768         void    (*putchar)(char c) __reentrant;
 769         void    (*flush)(void);
 770         uint8_t echo;
 771 };
 772
 773 extern __xdata struct ao_stdio ao_stdios[];
 774 extern __pdata int8_t ao_cur_stdio;
 775 extern __pdata int8_t ao_num_stdios;
 776
 777 void
 778 flush(void);
 779
 780 extern __xdata uint8_t ao_stdin_ready;
 781
 782 uint8_t
 783 ao_echo(void);
 784
 785 int8_t
 786 ao_add_stdio(char (*pollchar)(void),
 787              void (*putchar)(char) __reentrant,
 788              void (*flush)(void)) __reentrant;
 789
 790 /*
 791  * ao_ignite.c
 792  */
 793
 794 enum ao_igniter {
 795         ao_igniter_drogue = 0,
 796         ao_igniter_main = 1
 797 };
 798
 799 void
 800 ao_ignite(enum ao_igniter igniter);
 801
 802 enum ao_igniter_status {
 803         ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
 804         ao_igniter_ready,       /* continuity detected */
 805         ao_igniter_active,      /* igniter firing */
 806         ao_igniter_open,        /* open circuit detected */
 807 };
 808
 809 struct ao_ignition {
 810         uint8_t request;
 811         uint8_t fired;
 812         uint8_t firing;
 813 };
 814
 815 extern __xdata struct ao_ignition ao_ignition[2];
 816
 817 enum ao_igniter_status
 818 ao_igniter_status(enum ao_igniter igniter);
 819
 820 extern __pdata uint8_t ao_igniter_present;
 821
 822 void
 823 ao_ignite_set_pins(void);
 824
 825 void
 826 ao_igniter_init(void);
 827
 828 /*
 829  * ao_config.c
 830  */
 831
 832 #define AO_CONFIG_MAJOR 1
 833 #define AO_CONFIG_MINOR 11
 834
 835 #define AO_AES_LEN 16
 836
 837 struct ao_config {
 838         uint8_t         major;
 839         uint8_t         minor;
 840         uint16_t        main_deploy;
 841         int16_t         accel_plus_g;           /* changed for minor version 2 */
 842         uint8_t         _legacy_radio_channel;
 843         char            callsign[AO_MAX_CALLSIGN + 1];
 844         uint8_t         apogee_delay;           /* minor version 1 */
 845         int16_t         accel_minus_g;          /* minor version 2 */
 846         uint32_t        radio_cal;              /* minor version 3 */
 847         uint32_t        flight_log_max;         /* minor version 4 */
 848         uint8_t         ignite_mode;            /* minor version 5 */
 849         uint8_t         pad_orientation;        /* minor version 6 */
 850         uint32_t        radio_setting;          /* minor version 7 */
 851         uint8_t         radio_enable;           /* minor version 8 */
 852         uint8_t         aes_key[AO_AES_LEN];    /* minor version 9 */
 853         uint32_t        frequency;              /* minor version 10 */
 854         uint16_t        apogee_lockout;         /* minor version 11 */
 855 };
 856
 857 #define AO_IGNITE_MODE_DUAL             0
 858 #define AO_IGNITE_MODE_APOGEE           1
 859 #define AO_IGNITE_MODE_MAIN             2
 860
 861 #define AO_PAD_ORIENTATION_ANTENNA_UP   0
 862 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
 863
 864 extern __xdata struct ao_config ao_config;
 865
 866 #define AO_CONFIG_MAX_SIZE      128
 867
 868 void
 869 ao_config_get(void);
 870
 871 void
 872 ao_config_put(void);
 873
 874 void
 875 ao_config_set_radio(void);
 876
 877 void
 878 ao_config_init(void);
 879
 880 /*
 881  * ao_rssi.c
 882  */
 883
 884 void
 885 ao_rssi_set(int rssi_value);
 886
 887 void
 888 ao_rssi_init(uint8_t rssi_led);
 889
 890 /*
 891  * ao_product.c
 892  *
 893  * values which need to be defined for
 894  * each instance of a product
 895  */
 896
 897 extern const char ao_version[];
 898 extern const char ao_manufacturer[];
 899 extern const char ao_product[];
 900
 901 /*
 902  * Fifos
 903  */
 904
 905 #define AO_FIFO_SIZE    32
 906
 907 struct ao_fifo {
 908         uint8_t insert;
 909         uint8_t remove;
 910         char    fifo[AO_FIFO_SIZE];
 911 };
 912
 913 #define ao_fifo_insert(f,c) do { \
 914         (f).fifo[(f).insert] = (c); \
 915         (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
 916 } while(0)
 917
 918 #define ao_fifo_remove(f,c) do {\
 919         c = (f).fifo[(f).remove]; \
 920         (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
 921 } while(0)
 922
 923 #define ao_fifo_full(f)         ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
 924 #define ao_fifo_empty(f)        ((f).insert == (f).remove)
 925
 926 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
 927 #include <ao_packet.h>
 928 #endif
 929
 930 #if HAS_BTM
 931 #include <ao_btm.h>
 932 #endif
 933
 934 #if HAS_COMPANION
 935 #include <ao_companion.h>
 936 #endif
 937
 938 #if HAS_LCD
 939 #include <ao_lcd.h>
 940 #endif
 941
 942 #if HAS_AES
 943 #include <ao_aes.h>
 944 #endif
 945
 946 /* ao_launch.c */
 947
 948 struct ao_launch_command {
 949         uint16_t        tick;
 950         uint16_t        serial;
 951         uint8_t         cmd;
 952         uint8_t         channel;
 953         uint16_t        unused;
 954 };
 955
 956 #define AO_LAUNCH_QUERY         1
 957
 958 struct ao_launch_query {
 959         uint16_t        tick;
 960         uint16_t        serial;
 961         uint8_t         channel;
 962         uint8_t         valid;
 963         uint8_t         arm_status;
 964         uint8_t         igniter_status;
 965 };
 966
 967 #define AO_LAUNCH_ARM           2
 968 #define AO_LAUNCH_FIRE          3
 969
 970 void
 971 ao_launch_init(void);
 972
 973 /*
 974  * ao_log_single.c
 975  */
 976
 977 #define AO_LOG_TELESCIENCE_START        ((uint8_t) 's')
 978 #define AO_LOG_TELESCIENCE_DATA         ((uint8_t) 'd')
 979
 980 #define AO_LOG_TELESCIENCE_NUM_ADC      12
 981
 982 struct ao_log_telescience {
 983         uint8_t         type;
 984         uint8_t         csum;
 985         uint16_t        tick;
 986         uint16_t        tm_tick;
 987         uint8_t         tm_state;
 988         uint8_t         unused;
 989         uint16_t        adc[AO_LOG_TELESCIENCE_NUM_ADC];
 990 };
 991
 992 #define AO_LOG_SINGLE_SIZE              32
 993
 994 union ao_log_single {
 995         struct ao_log_telescience       telescience;
 996         union ao_telemetry_all          telemetry;
 997         uint8_t                         bytes[AO_LOG_SINGLE_SIZE];
 998 };
 999
1000 extern __xdata union ao_log_single      ao_log_single_write_data;
1001 extern __xdata union ao_log_single      ao_log_single_read_data;
1002
1003 void
1004 ao_log_single_extra_query(void);
1005
1006 void
1007 ao_log_single_list(void);
1008
1009 void
1010 ao_log_single_main(void);
1011
1012 uint8_t
1013 ao_log_single_write(void);
1014
1015 uint8_t
1016 ao_log_single_read(uint32_t pos);
1017
1018 void
1019 ao_log_single_start(void);
1020
1021 void
1022 ao_log_single_stop(void);
1023
1024 void
1025 ao_log_single_restart(void);
1026
1027 void
1028 ao_log_single_set(void);
1029
1030 void
1031 ao_log_single_delete(void);
1032
1033 void
1034 ao_log_single_init(void);
1035
1036 void
1037 ao_log_single(void);
1038
1039 /*
1040  * ao_pyro_slave.c
1041  */
1042
1043 #define AO_TELEPYRO_NUM_ADC     9
1044
1045 #ifndef ao_xmemcpy
1046 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
1047 #define ao_xmemset(d,v,c) memset(d,v,c)
1048 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
1049 #endif
1050
1051 /*
1052  * ao_terraui.c
1053  */
1054
1055 void
1056 ao_terraui_init(void);
1057
1058 /*
1059  * ao_battery.c
1060  */
1061
1062 #ifdef BATTERY_PIN
1063 void
1064 ao_battery_isr(void) ao_arch_interrupt(1);
1065
1066 uint16_t
1067 ao_battery_get(void);
1068
1069 void
1070 ao_battery_init(void);
1071 #endif /* BATTERY_PIN */
1072
1073 /*
1074  * ao_sqrt.c
1075  */
1076
1077 uint32_t
1078 ao_sqrt(uint32_t op);
1079
1080 /*
1081  * ao_freq.c
1082  */
1083
1084 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
1085
1086 #include <ao_arch_funcs.h>
1087
1088 /*
1089  * ao_ms5607.c
1090  */
1091
1092 void ao_ms5607_init(void);
1093
1094 #endif /* _AO_H_ */