git.gag.com Git - fw/altos/blob - 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 "cc1111.h"
  25
  26 /* Convert a __data pointer into an __xdata pointer */
  27 #define DATA_TO_XDATA(a)        ((void __xdata *) ((uint8_t) (a) | 0xff00))
  28
  29 /* Stack runs from above the allocated __data space to 0xfe, which avoids
  30  * writing to 0xff as that triggers the stack overflow indicator
  31  */
  32 #define AO_STACK_START  0x68
  33 #define AO_STACK_END    0xfe
  34 #define AO_STACK_SIZE   (AO_STACK_END - AO_STACK_START + 1)
  35
  36 /* An AltOS task */
  37 struct ao_task {
  38         __xdata void *wchan;            /* current wait channel (NULL if running) */
  39         uint8_t stack_count;            /* amount of saved stack */
  40         uint8_t task_id;                /* index in the task array */
  41         __code char *name;              /* task name */
  42         uint8_t stack[AO_STACK_SIZE];   /* saved stack */
  43 };
  44
  45 extern __xdata struct ao_task *__data ao_cur_task;
  46
  47 #define AO_NUM_TASKS            10      /* maximum number of tasks */
  48 #define AO_NO_TASK              0       /* no task id */
  49
  50 /*
  51  ao_task.c
  52  */
  53
  54 /* Suspend the current task until wchan is awoken */
  55 void
  56 ao_sleep(__xdata void *wchan);
  57
  58 /* Wake all tasks sleeping on wchan */
  59 void
  60 ao_wakeup(__xdata void *wchan);
  61
  62 /* Yield the processor to another task */
  63 void
  64 ao_yield(void) _naked;
  65
  66 /* Add a task to the run queue */
  67 void
  68 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name);
  69
  70 /* Dump task info to console */
  71 void
  72 ao_task_info(void);
  73
  74 /* Start the scheduler. This will not return */
  75 void
  76 ao_start_scheduler(void);
  77
  78 /*
  79  * ao_panic.c
  80  */
  81
  82 #define AO_PANIC_NO_TASK        1       /* AO_NUM_TASKS is not large enough */
  83 #define AO_PANIC_DMA            2       /* Attempt to start DMA while active */
  84 #define AO_PANIC_MUTEX          3       /* Mis-using mutex API */
  85 #define AO_PANIC_EE             4       /* Mis-using eeprom API */
  86 #define AO_PANIC_LOG            5       /* Failing to read/write log data */
  87 #define AO_PANIC_CMD            6       /* Too many command sets registered */
  88
  89 /* Stop the operating system, beeping and blinking the reason */
  90 void
  91 ao_panic(uint8_t reason);
  92
  93 /*
  94  * ao_timer.c
  95  */
  96
  97 /* Our timer runs at 100Hz */
  98 #define AO_MS_TO_TICKS(ms)      ((ms) / 10)
  99 #define AO_SEC_TO_TICKS(s)      ((s) * 100)
 100
 101 /* Returns the current time in ticks */
 102 uint16_t
 103 ao_time(void);
 104
 105 /* Suspend the current task until ticks time has passed */
 106 void
 107 ao_delay(uint16_t ticks);
 108
 109 /* Set the ADC interval */
 110 void
 111 ao_timer_set_adc_interval(uint8_t interval) __critical;
 112
 113 /* Timer interrupt */
 114 void
 115 ao_timer_isr(void) interrupt 9;
 116
 117 /* Initialize the timer */
 118 void
 119 ao_timer_init(void);
 120
 121 /*
 122  * ao_adc.c
 123  */
 124
 125 #define AO_ADC_RING     128
 126
 127 /*
 128  * One set of samples read from the A/D converter
 129  */
 130 struct ao_adc {
 131         uint16_t        tick;           /* tick when the sample was read */
 132         int16_t         accel;          /* accelerometer */
 133         int16_t         pres;           /* pressure sensor */
 134         int16_t         temp;           /* temperature sensor */
 135         int16_t         v_batt;         /* battery voltage */
 136         int16_t         sense_d;        /* drogue continuity sense */
 137         int16_t         sense_m;        /* main continuity sense */
 138 };
 139
 140 /*
 141  * A/D data is stored in a ring, with the next sample to be written
 142  * at ao_adc_head
 143  */
 144 extern volatile __xdata struct ao_adc   ao_adc_ring[AO_ADC_RING];
 145 extern volatile __data uint8_t          ao_adc_head;
 146
 147 /* Trigger a conversion sequence (called from the timer interrupt) */
 148 void
 149 ao_adc_poll(void);
 150
 151 /* Suspend the current task until another A/D sample is converted */
 152 void
 153 ao_adc_sleep(void);
 154
 155 /* Get a copy of the last complete A/D sample set */
 156 void
 157 ao_adc_get(__xdata struct ao_adc *packet);
 158
 159 /* The A/D interrupt handler */
 160 #if !AO_NO_ADC_ISR
 161 void
 162 ao_adc_isr(void) interrupt 1;
 163 #endif
 164
 165 /* Initialize the A/D converter */
 166 void
 167 ao_adc_init(void);
 168
 169 /*
 170  * ao_beep.c
 171  */
 172
 173 /*
 174  * Various pre-defined beep frequencies
 175  *
 176  * frequency = 1/2 (24e6/32) / beep
 177  */
 178
 179 #define AO_BEEP_LOW     150     /* 2500Hz */
 180 #define AO_BEEP_MID     94      /* 3989Hz */
 181 #define AO_BEEP_HIGH    75      /* 5000Hz */
 182 #define AO_BEEP_OFF     0       /* off */
 183
 184 #define AO_BEEP_g       240     /* 1562.5Hz */
 185 #define AO_BEEP_gs      227     /* 1652Hz (1655Hz) */
 186 #define AO_BEEP_aa      214     /* 1752Hz (1754Hz) */
 187 #define AO_BEEP_bbf     202     /* 1856Hz (1858Hz) */
 188 #define AO_BEEP_bb      190     /* 1974Hz (1969Hz) */
 189 #define AO_BEEP_cc      180     /* 2083Hz (2086Hz) */
 190 #define AO_BEEP_ccs     170     /* 2205Hz (2210Hz) */
 191 #define AO_BEEP_dd      160     /* 2344Hz (2341Hz) */
 192 #define AO_BEEP_eef     151     /* 2483Hz (2480Hz) */
 193 #define AO_BEEP_ee      143     /* 2622Hz (2628Hz) */
 194 #define AO_BEEP_ff      135     /* 2778Hz (2784Hz) */
 195 #define AO_BEEP_ffs     127     /* 2953Hz (2950Hz) */
 196 #define AO_BEEP_gg      120     /* 3125Hz */
 197 #define AO_BEEP_ggs     113     /* 3319Hz (3311Hz) */
 198 #define AO_BEEP_aaa     107     /* 3504Hz (3508Hz) */
 199 #define AO_BEEP_bbbf    101     /* 3713Hz (3716Hz) */
 200 #define AO_BEEP_bbb     95      /* 3947Hz (3937Hz) */
 201 #define AO_BEEP_ccc     90      /* 4167Hz (4171Hz) */
 202 #define AO_BEEP_cccs    85      /* 4412Hz (4419Hz) */
 203 #define AO_BEEP_ddd     80      /* 4688Hz (4682Hz) */
 204 #define AO_BEEP_eeef    76      /* 4934Hz (4961Hz) */
 205 #define AO_BEEP_eee     71      /* 5282Hz (5256Hz) */
 206 #define AO_BEEP_fff     67      /* 5597Hz (5568Hz) */
 207 #define AO_BEEP_fffs    64      /* 5859Hz (5899Hz) */
 208 #define AO_BEEP_ggg     60      /* 6250Hz */
 209
 210 /* Set the beeper to the specified tone */
 211 void
 212 ao_beep(uint8_t beep);
 213
 214 /* Turn on the beeper for the specified time */
 215 void
 216 ao_beep_for(uint8_t beep, uint16_t ticks);
 217
 218 /* Initialize the beeper */
 219 void
 220 ao_beep_init(void);
 221
 222 /*
 223  * ao_led.c
 224  */
 225
 226 #define AO_LED_NONE     0
 227 #define AO_LED_GREEN    1
 228 #define AO_LED_RED      2
 229
 230 /* Turn on the specified LEDs */
 231 void
 232 ao_led_on(uint8_t colors);
 233
 234 /* Turn off the specified LEDs */
 235 void
 236 ao_led_off(uint8_t colors);
 237
 238 /* Set all of the LEDs to the specified state */
 239 void
 240 ao_led_set(uint8_t colors);
 241
 242 /* Turn on the specified LEDs for the indicated interval */
 243 void
 244 ao_led_for(uint8_t colors, uint16_t ticks);
 245
 246 /* Initialize the LEDs */
 247 void
 248 ao_led_init(void);
 249
 250 /*
 251  * ao_usb.c
 252  */
 253
 254 /* Put one character to the USB output queue */
 255 void
 256 ao_usb_putchar(uint8_t c);
 257
 258 /* Get one character from the USB input queue */
 259 uint8_t
 260 ao_usb_getchar(void);
 261
 262 /* Flush the USB output queue */
 263 void
 264 ao_usb_flush(void);
 265
 266 /* USB interrupt handler */
 267 void
 268 ao_usb_isr(void) interrupt 6;
 269
 270 /* Initialize the USB system */
 271 void
 272 ao_usb_init(void);
 273
 274 /*
 275  * ao_cmd.c
 276  */
 277
 278 enum ao_cmd_status {
 279         ao_cmd_success = 0,
 280         ao_cmd_lex_error = 1,
 281         ao_cmd_syntax_error = 2,
 282 };
 283
 284 extern __xdata uint16_t ao_cmd_lex_i;
 285 extern __xdata uint8_t  ao_cmd_lex_c;
 286 extern __xdata enum ao_cmd_status ao_cmd_status;
 287
 288 void
 289 ao_cmd_lex(void);
 290
 291 void
 292 ao_cmd_put8(uint8_t v);
 293
 294 void
 295 ao_cmd_put16(uint16_t v);
 296
 297 void
 298 ao_cmd_white(void);
 299
 300 void
 301 ao_cmd_hex(void);
 302
 303 struct ao_cmds {
 304         uint8_t         cmd;
 305         void            (*func)(void);
 306         const char      *help;
 307 };
 308
 309 void
 310 ao_cmd_register(__code struct ao_cmds *cmds);
 311
 312 void
 313 ao_cmd_init(void);
 314
 315 /*
 316  * ao_dma.c
 317  */
 318
 319 /* Allocate a DMA channel. the 'done' parameter will be set to 1
 320  * when the dma is finished and will be used to wakeup any waiters
 321  */
 322 uint8_t
 323 ao_dma_alloc(__xdata uint8_t * done);
 324
 325 /* Setup a DMA channel */
 326 void
 327 ao_dma_set_transfer(uint8_t id,
 328                     void __xdata *srcaddr,
 329                     void __xdata *dstaddr,
 330                     uint16_t count,
 331                     uint8_t cfg0,
 332                     uint8_t cfg1);
 333
 334 /* Start a DMA channel */
 335 void
 336 ao_dma_start(uint8_t id);
 337
 338 /* Manually trigger a DMA channel */
 339 void
 340 ao_dma_trigger(uint8_t id);
 341
 342 /* Abort a running DMA transfer */
 343 void
 344 ao_dma_abort(uint8_t id);
 345
 346 /* DMA interrupt routine */
 347 void
 348 ao_dma_isr(void) interrupt 8;
 349
 350 /*
 351  * ao_mutex.c
 352  */
 353
 354 void
 355 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
 356
 357 void
 358 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 359
 360 /*
 361  * ao_ee.c
 362  */
 363
 364 /*
 365  * We reserve the last block on the device for
 366  * configuration space. Writes and reads in this
 367  * area return errors.
 368  */
 369
 370 #define AO_EE_BLOCK_SIZE        ((uint16_t) (256))
 371 #define AO_EE_DEVICE_SIZE       ((uint32_t) 128 * (uint32_t) 1024)
 372 #define AO_EE_DATA_SIZE         (AO_EE_DEVICE_SIZE - (uint32_t) AO_EE_BLOCK_SIZE)
 373 #define AO_EE_CONFIG_BLOCK      ((uint16_t) (AO_EE_DATA_SIZE / AO_EE_BLOCK_SIZE))
 374
 375 void
 376 ao_ee_flush(void) __reentrant;
 377
 378 /* Write to the eeprom */
 379 uint8_t
 380 ao_ee_write(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
 381
 382 /* Read from the eeprom */
 383 uint8_t
 384 ao_ee_read(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
 385
 386 /* Write the config block (at the end of the eeprom) */
 387 uint8_t
 388 ao_ee_write_config(uint8_t *buf, uint16_t len) __reentrant;
 389
 390 /* Read the config block (at the end of the eeprom) */
 391 uint8_t
 392 ao_ee_read_config(uint8_t *buf, uint16_t len) __reentrant;
 393
 394 /* Initialize the EEPROM code */
 395 void
 396 ao_ee_init(void);
 397
 398 /*
 399  * ao_log.c
 400  */
 401
 402 /* Structure containing GPS position, either lat or lon */
 403
 404 struct ao_gps_pos {
 405         uint8_t degrees;
 406         uint8_t minutes;
 407         uint16_t minutes_fraction;      /* in units of 1/10000 minutes */
 408 };
 409
 410 /*
 411  * The data log is recorded in the eeprom as a sequence
 412  * of data packets.
 413  *
 414  * Each packet starts with a 4-byte header that has the
 415  * packet type, the packet checksum and the tick count. Then
 416  * they all contain 2 16 bit values which hold packet-specific
 417  * data.
 418  *
 419  * For each flight, the first packet
 420  * is FLIGHT packet, indicating the serial number of the
 421  * device and a unique number marking the number of flights
 422  * recorded by this device.
 423  *
 424  * During flight, data from the accelerometer and barometer
 425  * are recorded in SENSOR packets, using the raw 16-bit values
 426  * read from the A/D converter.
 427  *
 428  * Also during flight, but at a lower rate, the deployment
 429  * sensors are recorded in DEPLOY packets. The goal here is to
 430  * detect failure in the deployment circuits.
 431  *
 432  * STATE packets hold state transitions as the flight computer
 433  * transitions through different stages of the flight.
 434  */
 435 #define AO_LOG_FLIGHT           'F'
 436 #define AO_LOG_SENSOR           'A'
 437 #define AO_LOG_TEMP_VOLT        'T'
 438 #define AO_LOG_DEPLOY           'D'
 439 #define AO_LOG_STATE            'S'
 440 #define AO_LOG_GPS_TIME         'G'
 441 #define AO_LOG_GPS_LAT          'N'
 442 #define AO_LOG_GPS_LON          'W'
 443 #define AO_LOG_GPS_ALT          'H'
 444
 445 #define AO_LOG_POS_NONE         (~0UL)
 446
 447 struct ao_log_record {
 448         uint8_t                 type;
 449         uint8_t                 csum;
 450         uint16_t                tick;
 451         union {
 452                 struct {
 453                         uint16_t        serial;
 454                         uint16_t        flight;
 455                 } flight;
 456                 struct {
 457                         int16_t         accel;
 458                         int16_t         pres;
 459                 } sensor;
 460                 struct {
 461                         int16_t         temp;
 462                         int16_t         v_batt;
 463                 } temp_volt;
 464                 struct {
 465                         int16_t         drogue;
 466                         int16_t         main;
 467                 } deploy;
 468                 struct {
 469                         uint16_t        state;
 470                         uint16_t        reason;
 471                 } state;
 472                 struct {
 473                         uint8_t         hour;
 474                         uint8_t         minute;
 475                         uint8_t         second;
 476                         uint8_t         flags;
 477                 } gps_time;
 478                 struct ao_gps_pos gps_latitude;
 479                 struct ao_gps_pos gps_longitude;
 480                 struct {
 481                         int16_t         altitude;
 482                         uint16_t        unused;
 483                 } gps_altitude;
 484                 struct {
 485                         uint16_t        d0;
 486                         uint16_t        d1;
 487                 } anon;
 488         } u;
 489 };
 490
 491 /* Write a record to the eeprom log */
 492 void
 493 ao_log_data(struct ao_log_record *log);
 494
 495 /* Flush the log */
 496 void
 497 ao_log_flush(void);
 498
 499 /* Log dumping API:
 500  * ao_log_dump_first() - get first log record
 501  * ao_log_dump_next()  - get next log record
 502  */
 503 extern __xdata struct ao_log_record ao_log_dump;
 504
 505 /* Retrieve first log record for the current flight */
 506 uint8_t
 507 ao_log_dump_first(void);
 508
 509 /* return next log record for the current flight */
 510 uint8_t
 511 ao_log_dump_next(void);
 512
 513 /* Logging thread main routine */
 514 void
 515 ao_log(void);
 516
 517 /* Start logging to eeprom */
 518 void
 519 ao_log_start(void);
 520
 521 /* Stop logging */
 522 void
 523 ao_log_stop(void);
 524
 525 /* Initialize the logging system */
 526 void
 527 ao_log_init(void);
 528
 529 /*
 530  * ao_flight.c
 531  */
 532
 533 enum ao_flight_state {
 534         ao_flight_startup = 0,
 535         ao_flight_idle = 1,
 536         ao_flight_launchpad = 2,
 537         ao_flight_boost = 3,
 538         ao_flight_coast = 4,
 539         ao_flight_apogee = 5,
 540         ao_flight_drogue = 6,
 541         ao_flight_main = 7,
 542         ao_flight_landed = 8,
 543         ao_flight_invalid = 9
 544 };
 545
 546 extern __xdata struct ao_adc            ao_flight_data;
 547 extern __pdata enum flight_state        ao_flight_state;
 548 extern __pdata uint16_t                 ao_flight_tick;
 549 extern __pdata int16_t                  ao_flight_accel;
 550 extern __pdata int16_t                  ao_flight_pres;
 551 extern __pdata int16_t                  ao_ground_pres;
 552 extern __pdata int16_t                  ao_ground_accel;
 553 extern __pdata int16_t                  ao_min_pres;
 554 extern __pdata uint16_t                 ao_launch_time;
 555
 556 /* Flight thread */
 557 void
 558 ao_flight(void);
 559
 560 /* Initialize flight thread */
 561 void
 562 ao_flight_init(void);
 563
 564 /*
 565  * ao_report.c
 566  */
 567
 568 void
 569 ao_report_init(void);
 570
 571 /*
 572  * ao_convert.c
 573  *
 574  * Given raw data, convert to SI units
 575  */
 576
 577 /* pressure from the sensor to altitude in meters */
 578 int16_t
 579 ao_pres_to_altitude(int16_t pres) __reentrant;
 580
 581 int16_t
 582 ao_temp_to_dC(int16_t temp) __reentrant;
 583
 584 int16_t
 585 ao_accel_to_cm_per_s2(int16_t accel) __reentrant;
 586
 587 /*
 588  * ao_dbg.c
 589  *
 590  * debug another telemetrum board
 591  */
 592
 593 /* Send a byte to the dbg target */
 594 void
 595 ao_dbg_send_byte(uint8_t byte);
 596
 597 /* Receive a byte from the dbg target */
 598 uint8_t
 599 ao_dbg_recv_byte(void);
 600
 601 /* Start a bulk transfer to/from dbg target memory */
 602 void
 603 ao_dbg_start_transfer(uint16_t addr);
 604
 605 /* End a bulk transfer to/from dbg target memory */
 606 void
 607 ao_dbg_end_transfer(void);
 608
 609 /* Write a byte to dbg target memory */
 610 void
 611 ao_dbg_write_byte(uint8_t byte);
 612
 613 /* Read a byte from dbg target memory */
 614 uint8_t
 615 ao_dbg_read_byte(void);
 616
 617 /* Enable dbg mode, switching use of the pins */
 618 void
 619 ao_dbg_debug_mode(void);
 620
 621 /* Reset the dbg target */
 622 void
 623 ao_dbg_reset(void);
 624
 625 void
 626 ao_dbg_init(void);
 627
 628 /*
 629  * ao_serial.c
 630  */
 631
 632 #if !AO_NO_SERIAL_ISR
 633 void
 634 ao_serial_rx1_isr(void) interrupt 3;
 635
 636 void
 637 ao_serial_tx1_isr(void) interrupt 14;
 638 #endif
 639
 640 uint8_t
 641 ao_serial_getchar(void) __critical;
 642
 643 void
 644 ao_serial_putchar(uint8_t c) __critical;
 645
 646 void
 647 ao_serial_init(void);
 648
 649 /*
 650  * ao_gps.c
 651  */
 652
 653 #define AO_GPS_NUM_SAT_MASK     (0xf << 0)
 654 #define AO_GPS_NUM_SAT_SHIFT    (0)
 655
 656 #define AO_GPS_VALID            (1 << 4)
 657 #define AO_GPS_LONGITUDE_MASK   (1 << 5)
 658 #define AO_GPS_LONGITUDE_EAST   (0 << 5)
 659 #define AO_GPS_LONGITUDE_WEST   (1 << 5)
 660
 661 #define AO_GPS_LATITUDE_MASK    (1 << 6)
 662 #define AO_GPS_LATITUDE_NORTH   (0 << 6)
 663 #define AO_GPS_LATITUDE_SOUTH   (1 << 6)
 664
 665 struct ao_gps_data {
 666         uint8_t                 hour;
 667         uint8_t                 minute;
 668         uint8_t                 second;
 669         uint8_t                 flags;
 670         struct ao_gps_pos       latitude;
 671         struct ao_gps_pos       longitude;
 672         int16_t                 altitude;
 673 };
 674
 675 extern __xdata uint8_t ao_gps_mutex;
 676 extern __xdata struct ao_gps_data ao_gps_data;
 677
 678 void
 679 ao_gps(void);
 680
 681 void
 682 ao_gps_print(__xdata struct ao_gps_data *gps_data);
 683
 684 void
 685 ao_gps_init(void);
 686
 687 /*
 688  * ao_telemetry.c
 689  */
 690
 691 struct ao_telemetry {
 692         uint8_t                 addr;
 693         uint8_t                 flight_state;
 694         struct ao_adc           adc;
 695         struct ao_gps_data      gps;
 696 };
 697
 698 void
 699 ao_telemetry_send(__xdata struct ao_telemetry *telemetry) __reentrant;
 700
 701 void
 702 ao_telemetry_init(void);
 703
 704 /*
 705  * ao_radio.c
 706  */
 707
 708 void
 709 ao_radio_send(__xdata struct ao_telemetry *telemetry) __reentrant;
 710
 711 struct ao_radio_recv {
 712         struct ao_telemetry     telemetry;
 713         uint8_t                 rssi;
 714         uint8_t                 status;
 715 };
 716
 717 void
 718 ao_radio_recv(__xdata struct ao_radio_recv *recv) __reentrant;
 719
 720 void
 721 ao_radio_init(void);
 722
 723 /*
 724  * ao_monitor.c
 725  */
 726
 727 void
 728 ao_monitor(void);
 729
 730 void
 731 ao_monitor_init(void);
 732
 733 /*
 734  * ao_stdio.c
 735  */
 736
 737 void
 738 flush(void);
 739
 740 #endif /* _AO_H_ */
 741