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