2 * Copyright © 2009 Keith Packard <keithp@keithp.com>
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
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.
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.
30 /* Convert a __data pointer into an __xdata pointer */
31 #define DATA_TO_XDATA(a) ((void __xdata *) ((uint8_t) (a) | 0xff00))
33 /* Stack runs from above the allocated __data space to 0xfe, which avoids
34 * writing to 0xff as that triggers the stack overflow indicator
36 #define AO_STACK_START 0x80
37 #define AO_STACK_END 0xfe
38 #define AO_STACK_SIZE (AO_STACK_END - AO_STACK_START + 1)
42 __xdata void *wchan; /* current wait channel (NULL if running) */
43 uint16_t alarm; /* abort ao_sleep time */
44 uint8_t stack_count; /* amount of saved stack */
45 uint8_t task_id; /* index in the task array */
46 __code char *name; /* task name */
47 uint8_t stack[AO_STACK_SIZE]; /* saved stack */
50 extern __xdata struct ao_task *__data ao_cur_task;
52 #define AO_NUM_TASKS 16 /* maximum number of tasks */
53 #define AO_NO_TASK 0 /* no task id */
59 /* Suspend the current task until wchan is awoken.
65 ao_sleep(__xdata void *wchan);
67 /* Wake all tasks sleeping on wchan */
69 ao_wakeup(__xdata void *wchan);
71 /* Wake up a specific task */
73 ao_wake_task(__xdata struct ao_task *task);
75 /* set an alarm to go off in 'delay' ticks */
77 ao_alarm(uint16_t delay);
79 /* Yield the processor to another task */
81 ao_yield(void) _naked;
83 /* Add a task to the run queue */
85 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
87 /* Terminate the current task */
91 /* Dump task info to console */
95 /* Start the scheduler. This will not return */
97 ao_start_scheduler(void);
103 #define AO_PANIC_NO_TASK 1 /* AO_NUM_TASKS is not large enough */
104 #define AO_PANIC_DMA 2 /* Attempt to start DMA while active */
105 #define AO_PANIC_MUTEX 3 /* Mis-using mutex API */
106 #define AO_PANIC_EE 4 /* Mis-using eeprom API */
107 #define AO_PANIC_LOG 5 /* Failing to read/write log data */
108 #define AO_PANIC_CMD 6 /* Too many command sets registered */
109 #define AO_PANIC_STDIO 7 /* Too many stdio handlers registered */
110 #define AO_PANIC_REBOOT 8 /* Reboot failed */
112 /* Stop the operating system, beeping and blinking the reason */
114 ao_panic(uint8_t reason);
120 /* Our timer runs at 100Hz */
122 #define AO_MS_TO_TICKS(ms) ((ms) / (1000 / AO_HERTZ))
123 #define AO_SEC_TO_TICKS(s) ((s) * AO_HERTZ)
125 /* Returns the current time in ticks */
129 /* Suspend the current task until ticks time has passed */
131 ao_delay(uint16_t ticks);
133 /* Set the ADC interval */
135 ao_timer_set_adc_interval(uint8_t interval) __critical;
137 /* Timer interrupt */
139 ao_timer_isr(void) interrupt 9;
141 /* Initialize the timer */
145 /* Initialize the hardware clock. Must be called first */
153 #define AO_ADC_RING 32
154 #define ao_adc_ring_next(n) (((n) + 1) & (AO_ADC_RING - 1))
155 #define ao_adc_ring_prev(n) (((n) - 1) & (AO_ADC_RING - 1))
158 * One set of samples read from the A/D converter
161 uint16_t tick; /* tick when the sample was read */
162 int16_t accel; /* accelerometer */
163 int16_t pres; /* pressure sensor */
164 int16_t temp; /* temperature sensor */
165 int16_t v_batt; /* battery voltage */
166 int16_t sense_d; /* drogue continuity sense */
167 int16_t sense_m; /* main continuity sense */
171 * A/D data is stored in a ring, with the next sample to be written
174 extern volatile __xdata struct ao_adc ao_adc_ring[AO_ADC_RING];
175 extern volatile __data uint8_t ao_adc_head;
177 /* Trigger a conversion sequence (called from the timer interrupt) */
181 /* Suspend the current task until another A/D sample is converted */
185 /* Get a copy of the last complete A/D sample set */
187 ao_adc_get(__xdata struct ao_adc *packet);
189 /* The A/D interrupt handler */
192 ao_adc_isr(void) interrupt 1;
195 /* Initialize the A/D converter */
204 * Various pre-defined beep frequencies
206 * frequency = 1/2 (24e6/32) / beep
209 #define AO_BEEP_LOW 150 /* 2500Hz */
210 #define AO_BEEP_MID 94 /* 3989Hz */
211 #define AO_BEEP_HIGH 75 /* 5000Hz */
212 #define AO_BEEP_OFF 0 /* off */
214 #define AO_BEEP_g 240 /* 1562.5Hz */
215 #define AO_BEEP_gs 227 /* 1652Hz (1655Hz) */
216 #define AO_BEEP_aa 214 /* 1752Hz (1754Hz) */
217 #define AO_BEEP_bbf 202 /* 1856Hz (1858Hz) */
218 #define AO_BEEP_bb 190 /* 1974Hz (1969Hz) */
219 #define AO_BEEP_cc 180 /* 2083Hz (2086Hz) */
220 #define AO_BEEP_ccs 170 /* 2205Hz (2210Hz) */
221 #define AO_BEEP_dd 160 /* 2344Hz (2341Hz) */
222 #define AO_BEEP_eef 151 /* 2483Hz (2480Hz) */
223 #define AO_BEEP_ee 143 /* 2622Hz (2628Hz) */
224 #define AO_BEEP_ff 135 /* 2778Hz (2784Hz) */
225 #define AO_BEEP_ffs 127 /* 2953Hz (2950Hz) */
226 #define AO_BEEP_gg 120 /* 3125Hz */
227 #define AO_BEEP_ggs 113 /* 3319Hz (3311Hz) */
228 #define AO_BEEP_aaa 107 /* 3504Hz (3508Hz) */
229 #define AO_BEEP_bbbf 101 /* 3713Hz (3716Hz) */
230 #define AO_BEEP_bbb 95 /* 3947Hz (3937Hz) */
231 #define AO_BEEP_ccc 90 /* 4167Hz (4171Hz) */
232 #define AO_BEEP_cccs 85 /* 4412Hz (4419Hz) */
233 #define AO_BEEP_ddd 80 /* 4688Hz (4682Hz) */
234 #define AO_BEEP_eeef 76 /* 4934Hz (4961Hz) */
235 #define AO_BEEP_eee 71 /* 5282Hz (5256Hz) */
236 #define AO_BEEP_fff 67 /* 5597Hz (5568Hz) */
237 #define AO_BEEP_fffs 64 /* 5859Hz (5899Hz) */
238 #define AO_BEEP_ggg 60 /* 6250Hz */
240 /* Set the beeper to the specified tone */
242 ao_beep(uint8_t beep);
244 /* Turn on the beeper for the specified time */
246 ao_beep_for(uint8_t beep, uint16_t ticks) __reentrant;
248 /* Initialize the beeper */
256 #define AO_LED_NONE 0
257 #define AO_LED_GREEN 1
260 /* Turn on the specified LEDs */
262 ao_led_on(uint8_t colors);
264 /* Turn off the specified LEDs */
266 ao_led_off(uint8_t colors);
268 /* Set all of the LEDs to the specified state */
270 ao_led_set(uint8_t colors);
272 /* Toggle the specified LEDs */
274 ao_led_toggle(uint8_t colors);
276 /* Turn on the specified LEDs for the indicated interval */
278 ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
280 /* Initialize the LEDs */
282 ao_led_init(uint8_t enable);
288 /* Put one character to the USB output queue */
290 ao_usb_putchar(char c);
292 /* Get one character from the USB input queue */
294 ao_usb_getchar(void);
296 /* Poll for a charcter on the USB input queue.
297 * returns AO_READ_AGAIN if none are available
300 ao_usb_pollchar(void);
302 /* Flush the USB output queue */
306 /* USB interrupt handler */
308 ao_usb_isr(void) interrupt 6;
310 /* Enable the USB controller */
314 /* Disable the USB controller */
316 ao_usb_disable(void);
318 /* Initialize the USB system */
328 ao_cmd_lex_error = 1,
329 ao_cmd_syntax_error = 2,
332 extern __xdata uint16_t ao_cmd_lex_i;
333 extern __xdata char ao_cmd_lex_c;
334 extern __xdata enum ao_cmd_status ao_cmd_status;
340 ao_cmd_put8(uint8_t v);
343 ao_cmd_put16(uint16_t v);
352 ao_cmd_decimal(void);
355 ao_match_word(__code char *word);
364 ao_cmd_register(__code struct ao_cmds *cmds);
373 /* Allocate a DMA channel. the 'done' parameter will be set
374 * when the dma is finished or aborted and will be used to
378 #define AO_DMA_DONE 1
379 #define AO_DMA_ABORTED 2
382 ao_dma_alloc(__xdata uint8_t * done);
384 /* Setup a DMA channel */
386 ao_dma_set_transfer(uint8_t id,
387 void __xdata *srcaddr,
388 void __xdata *dstaddr,
393 /* Start a DMA channel */
395 ao_dma_start(uint8_t id);
397 /* Manually trigger a DMA channel */
399 ao_dma_trigger(uint8_t id);
401 /* Abort a running DMA transfer */
403 ao_dma_abort(uint8_t id);
405 /* DMA interrupt routine */
407 ao_dma_isr(void) interrupt 8;
414 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
417 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
424 * We reserve the last block on the device for
425 * configuration space. Writes and reads in this
426 * area return errors.
429 #define AO_EE_BLOCK_SIZE ((uint16_t) (256))
430 #define AO_EE_DEVICE_SIZE ((uint32_t) 128 * (uint32_t) 1024)
431 #define AO_EE_DATA_SIZE (AO_EE_DEVICE_SIZE - (uint32_t) AO_EE_BLOCK_SIZE)
432 #define AO_EE_CONFIG_BLOCK ((uint16_t) (AO_EE_DATA_SIZE / AO_EE_BLOCK_SIZE))
435 ao_ee_flush(void) __reentrant;
437 /* Write to the eeprom */
439 ao_ee_write(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
441 /* Read from the eeprom */
443 ao_ee_read(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
445 /* Write the config block (at the end of the eeprom) */
447 ao_ee_write_config(uint8_t *buf, uint16_t len) __reentrant;
449 /* Read the config block (at the end of the eeprom) */
451 ao_ee_read_config(uint8_t *buf, uint16_t len) __reentrant;
453 /* Initialize the EEPROM code */
462 * The data log is recorded in the eeprom as a sequence
465 * Each packet starts with a 4-byte header that has the
466 * packet type, the packet checksum and the tick count. Then
467 * they all contain 2 16 bit values which hold packet-specific
470 * For each flight, the first packet
471 * is FLIGHT packet, indicating the serial number of the
472 * device and a unique number marking the number of flights
473 * recorded by this device.
475 * During flight, data from the accelerometer and barometer
476 * are recorded in SENSOR packets, using the raw 16-bit values
477 * read from the A/D converter.
479 * Also during flight, but at a lower rate, the deployment
480 * sensors are recorded in DEPLOY packets. The goal here is to
481 * detect failure in the deployment circuits.
483 * STATE packets hold state transitions as the flight computer
484 * transitions through different stages of the flight.
486 #define AO_LOG_FLIGHT 'F'
487 #define AO_LOG_SENSOR 'A'
488 #define AO_LOG_TEMP_VOLT 'T'
489 #define AO_LOG_DEPLOY 'D'
490 #define AO_LOG_STATE 'S'
491 #define AO_LOG_GPS_TIME 'G'
492 #define AO_LOG_GPS_LAT 'N'
493 #define AO_LOG_GPS_LON 'W'
494 #define AO_LOG_GPS_ALT 'H'
495 #define AO_LOG_GPS_SAT 'V'
496 #define AO_LOG_GPS_DATE 'Y'
498 #define AO_LOG_POS_NONE (~0UL)
500 struct ao_log_record {
506 int16_t ground_accel;
531 int32_t gps_latitude;
532 int32_t gps_longitude;
554 /* Write a record to the eeprom log */
556 ao_log_data(struct ao_log_record *log);
562 /* We record flight numbers in the first record of
563 * the log. Tasks may wait for this to be initialized
564 * by sleeping on this variable.
566 extern __xdata uint16_t ao_flight_number;
568 /* Retrieve first log record for the current flight */
570 ao_log_dump_first(void);
572 /* return next log record for the current flight */
574 ao_log_dump_next(void);
576 /* Logging thread main routine */
580 /* Start logging to eeprom */
588 /* Initialize the logging system */
596 enum ao_flight_state {
597 ao_flight_startup = 0,
603 ao_flight_drogue = 6,
605 ao_flight_landed = 8,
606 ao_flight_invalid = 9
609 extern __xdata struct ao_adc ao_flight_data;
610 extern __pdata enum ao_flight_state ao_flight_state;
611 extern __pdata uint16_t ao_flight_tick;
612 extern __pdata int16_t ao_flight_accel;
613 extern __pdata int16_t ao_flight_pres;
614 extern __pdata int32_t ao_flight_vel;
615 extern __pdata int16_t ao_ground_pres;
616 extern __pdata int16_t ao_ground_accel;
617 extern __pdata int16_t ao_min_pres;
618 extern __pdata uint16_t ao_launch_time;
624 /* Initialize flight thread */
626 ao_flight_init(void);
633 ao_report_init(void);
638 * Given raw data, convert to SI units
641 /* pressure from the sensor to altitude in meters */
643 ao_pres_to_altitude(int16_t pres) __reentrant;
646 ao_altitude_to_pres(int16_t alt) __reentrant;
649 ao_temp_to_dC(int16_t temp) __reentrant;
654 * debug another telemetrum board
657 /* Send a byte to the dbg target */
659 ao_dbg_send_byte(uint8_t byte);
661 /* Receive a byte from the dbg target */
663 ao_dbg_recv_byte(void);
665 /* Start a bulk transfer to/from dbg target memory */
667 ao_dbg_start_transfer(uint16_t addr);
669 /* End a bulk transfer to/from dbg target memory */
671 ao_dbg_end_transfer(void);
673 /* Write a byte to dbg target memory */
675 ao_dbg_write_byte(uint8_t byte);
677 /* Read a byte from dbg target memory */
679 ao_dbg_read_byte(void);
681 /* Enable dbg mode, switching use of the pins */
683 ao_dbg_debug_mode(void);
685 /* Reset the dbg target */
696 #if !AO_NO_SERIAL_ISR
698 ao_serial_rx1_isr(void) interrupt 3;
701 ao_serial_tx1_isr(void) interrupt 14;
705 ao_serial_getchar(void) __critical;
708 ao_serial_putchar(char c) __critical;
710 #define AO_SERIAL_SPEED_4800 0
711 #define AO_SERIAL_SPEED_9600 1
712 #define AO_SERIAL_SPEED_57600 2
715 ao_serial_set_speed(uint8_t speed);
718 ao_serial_init(void);
724 #define AO_GPS_NUM_SAT_MASK (0xf << 0)
725 #define AO_GPS_NUM_SAT_SHIFT (0)
727 #define AO_GPS_VALID (1 << 4)
728 #define AO_GPS_RUNNING (1 << 5)
729 #define AO_GPS_DATE_VALID (1 << 6)
739 int32_t latitude; /* degrees * 10⁷ */
740 int32_t longitude; /* degrees * 10⁷ */
741 int16_t altitude; /* m */
742 uint16_t ground_speed; /* cm/s */
743 uint8_t course; /* degrees / 2 */
744 uint8_t hdop; /* * 5 */
745 int16_t climb_rate; /* cm/s */
746 uint16_t h_error; /* m */
747 uint16_t v_error; /* m */
750 struct ao_gps_sat_data {
755 struct ao_gps_tracking_data {
757 struct ao_gps_sat_data sats[12];
760 extern __xdata uint8_t ao_gps_mutex;
761 extern __xdata struct ao_gps_data ao_gps_data;
762 extern __xdata struct ao_gps_tracking_data ao_gps_tracking_data;
768 ao_gps_print(__xdata struct ao_gps_data *gps_data);
771 ao_gps_tracking_print(__xdata struct ao_gps_tracking_data *gps_tracking_data);
784 ao_gps_report_init(void);
790 #define AO_MAX_CALLSIGN 8
791 #define AO_TELEMETRY_VERSION 2
793 struct ao_telemetry {
796 uint8_t flight_state;
797 int16_t flight_accel;
798 int16_t ground_accel;
802 int16_t accel_plus_g;
803 int16_t accel_minus_g;
805 struct ao_gps_data gps;
806 char callsign[AO_MAX_CALLSIGN];
807 struct ao_gps_tracking_data gps_tracking;
810 /* Set delay between telemetry reports (0 to disable) */
812 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(1000)
813 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(50)
814 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(1000)
817 ao_telemetry_set_interval(uint16_t interval);
820 ao_rdf_set(uint8_t rdf);
823 ao_telemetry_init(void);
829 extern __xdata uint8_t ao_radio_dma;
830 extern __xdata uint8_t ao_radio_dma_done;
831 extern __xdata uint8_t ao_radio_done;
832 extern __xdata uint8_t ao_radio_mutex;
835 ao_radio_general_isr(void) interrupt 16;
838 ao_radio_set_telemetry(void);
841 ao_radio_set_packet(void);
844 ao_radio_set_rdf(void);
847 ao_radio_send(__xdata struct ao_telemetry *telemetry) __reentrant;
849 struct ao_radio_recv {
850 struct ao_telemetry telemetry;
856 ao_radio_recv(__xdata struct ao_radio_recv *recv) __reentrant;
859 ao_radio_rdf(int ms);
862 ao_radio_abort(void);
865 ao_radio_rdf_abort(void);
877 extern const char const * const ao_state_names[];
883 ao_set_monitor(uint8_t monitoring);
886 ao_monitor_init(uint8_t led, uint8_t monitoring) __reentrant;
892 #define AO_READ_AGAIN ((char) -1)
895 char (*pollchar)(void);
896 void (*putchar)(char c) __reentrant;
903 extern __xdata uint8_t ao_stdin_ready;
906 ao_add_stdio(char (*pollchar)(void),
907 void (*putchar)(char) __reentrant,
908 void (*flush)(void));
915 ao_igniter_drogue = 0,
920 ao_ignite(enum ao_igniter igniter);
922 enum ao_igniter_status {
923 ao_igniter_unknown, /* unknown status (ambiguous voltage) */
924 ao_igniter_ready, /* continuity detected */
925 ao_igniter_active, /* igniter firing */
926 ao_igniter_open, /* open circuit detected */
929 enum ao_igniter_status
930 ao_igniter_status(enum ao_igniter igniter);
933 ao_igniter_init(void);
939 #define AO_CONFIG_MAJOR 1
940 #define AO_CONFIG_MINOR 2
945 uint16_t main_deploy;
946 int16_t accel_plus_g;
947 uint8_t radio_channel;
948 char callsign[AO_MAX_CALLSIGN + 1];
949 uint8_t apogee_delay;
950 int16_t accel_minus_g;
953 extern __xdata struct ao_config ao_config;
959 ao_config_init(void);
966 ao_rssi_set(int rssi_value);
969 ao_rssi_init(uint8_t rssi_led);
974 * values which need to be defined for
975 * each instance of a product
978 extern const uint8_t ao_usb_descriptors [];
979 extern const uint16_t ao_serial_number;
980 extern const char ao_version[];
981 extern const char ao_manufacturer[];
982 extern const char ao_product[];
988 #define AO_FIFO_SIZE 32
993 char fifo[AO_FIFO_SIZE];
996 #define ao_fifo_insert(f,c) do { \
997 (f).fifo[(f).insert] = (c); \
998 (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
1001 #define ao_fifo_remove(f,c) do {\
1002 c = (f).fifo[(f).remove]; \
1003 (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
1006 #define ao_fifo_full(f) ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
1007 #define ao_fifo_empty(f) ((f).insert == (f).remove)
1012 * Packet-based command interface
1015 #define AO_PACKET_MAX 8
1016 #define AO_PACKET_SYN (uint8_t) 0xff
1023 uint8_t d[AO_PACKET_MAX];
1026 struct ao_packet_recv {
1027 struct ao_packet packet;
1032 extern __xdata struct ao_packet_recv ao_rx_packet;
1033 extern __xdata struct ao_packet ao_tx_packet;
1034 extern __xdata struct ao_task ao_packet_task;
1035 extern __xdata uint8_t ao_packet_enable;
1036 extern __xdata uint8_t ao_packet_master_sleeping;
1037 extern __pdata uint8_t ao_packet_rx_len, ao_packet_rx_used, ao_packet_tx_used;
1040 ao_packet_send(void);
1043 ao_packet_recv(void);
1046 ao_packet_flush(void);
1049 ao_packet_putchar(char c) __reentrant;
1052 ao_packet_pollchar(void) __critical;
1054 /* ao_packet_master.c */
1057 ao_packet_master_init(void);
1059 /* ao_packet_slave.c */
1062 ao_packet_slave_start(void);
1065 ao_packet_slave_stop(void);
1068 ao_packet_slave_init(void);