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.
31 /* Convert a __data pointer into an __xdata pointer */
33 #define DATA_TO_XDATA(a) (a)
35 #ifndef PDATA_TO_XDATA
36 #define PDATA_TO_XDATA(a) (a)
39 #define CODE_TO_XDATA(a) (a)
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 */
52 extern __xdata struct ao_task *__data ao_cur_task;
54 #define AO_NUM_TASKS 16 /* maximum number of tasks */
55 #define AO_NO_TASK 0 /* no task id */
61 /* Suspend the current task until wchan is awoken.
67 ao_sleep(__xdata void *wchan);
69 /* Wake all tasks sleeping on wchan */
71 ao_wakeup(__xdata void *wchan);
73 /* set an alarm to go off in 'delay' ticks */
75 ao_alarm(uint16_t delay);
77 /* Clear any pending alarm */
81 /* Yield the processor to another task */
83 ao_yield(void) ao_arch_naked_declare;
85 /* Add a task to the run queue */
87 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
89 /* Terminate the current task */
93 /* Dump task info to console */
97 /* Start the scheduler. This will not return */
99 ao_start_scheduler(void);
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 */
120 /* Stop the operating system, beeping and blinking the reason */
122 ao_panic(uint8_t reason);
128 /* Our timer runs at 100Hz */
130 #define AO_MS_TO_TICKS(ms) ((ms) / (1000 / AO_HERTZ))
131 #define AO_SEC_TO_TICKS(s) ((s) * AO_HERTZ)
133 /* Returns the current time in ticks */
137 /* Suspend the current task until ticks time has passed */
139 ao_delay(uint16_t ticks);
141 /* Set the ADC interval */
143 ao_timer_set_adc_interval(uint8_t interval) __critical;
145 /* Timer interrupt */
147 ao_timer_isr(void) ao_arch_interrupt(9);
149 /* Initialize the timer */
153 /* Initialize the hardware clock. Must be called first */
162 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
165 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
173 ao_cmd_lex_error = 1,
174 ao_cmd_syntax_error = 2,
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;
186 ao_cmd_put8(uint8_t v);
189 ao_cmd_put16(uint16_t v);
192 ao_cmd_is_white(void);
198 ao_cmd_hexchar(char c);
201 ao_cmd_hexbyte(void);
207 ao_cmd_decimal(void);
210 ao_match_word(__code char *word);
218 ao_cmd_register(const __code struct ao_cmds *cmds);
225 * Provided by an external module to filter raw command lines
251 #include <ao_storage.h>
259 #include <ao_flight.h>
260 #include <ao_sample.h>
267 #define AO_RDF_INTERVAL_TICKS AO_SEC_TO_TICKS(5)
268 #define AO_RDF_LENGTH_MS 500
269 #define AO_RDF_CONTINUITY_MS 32
270 #define AO_RDF_CONTINUITY_PAUSE 96
271 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
273 /* This assumes that we're generating a 1kHz tone, which
274 * modulates the carrier at 2kbps, or 250kBps
276 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
278 #define AO_RADIO_RDF_LEN AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
279 #define AO_RADIO_CONT_TONE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
280 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
281 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
283 /* returns a value 0-3 to indicate igniter continuity */
285 ao_report_igniter(void);
288 ao_report_init(void);
293 * Given raw data, convert to SI units
296 /* pressure from the sensor to altitude in meters */
298 ao_pres_to_altitude(int16_t pres) __reentrant;
301 ao_altitude_to_pres(int16_t alt) __reentrant;
304 ao_temp_to_dC(int16_t temp) __reentrant;
309 * Convert between pressure in Pa and altitude in meters
313 ao_pa_to_altitude(int32_t pa);
316 ao_altitude_to_pa(int32_t alt);
322 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
323 #include <ao_serial.h>
332 ao_spi_slave_recv(uint8_t *buf, uint8_t len);
335 ao_spi_slave_send(uint8_t *buf, uint8_t len);
338 ao_spi_slave_init(void);
340 /* This must be defined by the product; it will get called when chip
341 * select goes low, at which point it should use ao_spi_read and
342 * ao_spi_write to deal with the request
348 #include <ao_telemetry.h>
353 #define AO_GPS_NUM_SAT_MASK (0xf << 0)
354 #define AO_GPS_NUM_SAT_SHIFT (0)
356 #define AO_GPS_VALID (1 << 4)
357 #define AO_GPS_RUNNING (1 << 5)
358 #define AO_GPS_DATE_VALID (1 << 6)
359 #define AO_GPS_COURSE_VALID (1 << 7)
361 extern __pdata uint16_t ao_gps_tick;
362 extern __xdata uint8_t ao_gps_mutex;
363 extern __xdata struct ao_telemetry_location ao_gps_data;
364 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
374 int32_t latitude; /* degrees * 10⁷ */
375 int32_t longitude; /* degrees * 10⁷ */
376 int16_t altitude; /* m */
377 uint16_t ground_speed; /* cm/s */
378 uint8_t course; /* degrees / 2 */
379 uint8_t hdop; /* * 5 */
380 int16_t climb_rate; /* cm/s */
381 uint16_t h_error; /* m */
382 uint16_t v_error; /* m */
385 struct ao_gps_sat_orig {
390 #define AO_MAX_GPS_TRACKING 12
392 struct ao_gps_tracking_orig {
394 struct ao_gps_sat_orig sats[AO_MAX_GPS_TRACKING];
401 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
404 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
417 ao_gps_report_init(void);
420 * ao_gps_report_mega.c
424 ao_gps_report_mega(void);
427 ao_gps_report_mega_init(void);
430 * ao_telemetry_orig.c
434 uint16_t tick; /* tick when the sample was read */
435 int16_t accel; /* accelerometer */
436 int16_t pres; /* pressure sensor */
437 int16_t temp; /* temperature sensor */
438 int16_t v_batt; /* battery voltage */
439 int16_t sense_d; /* drogue continuity sense */
440 int16_t sense_m; /* main continuity sense */
443 struct ao_telemetry_orig {
446 uint8_t flight_state;
448 int16_t ground_accel;
458 int16_t accel_plus_g;
459 int16_t accel_minus_g;
460 struct ao_adc_orig adc;
461 struct ao_gps_orig gps;
462 char callsign[AO_MAX_CALLSIGN];
463 struct ao_gps_tracking_orig gps_tracking;
466 struct ao_telemetry_tiny {
469 uint8_t flight_state;
470 int16_t height; /* AGL in meters */
471 int16_t speed; /* in m/s * 16 */
472 int16_t accel; /* in m/s² * 16 */
473 int16_t ground_pres; /* sensor units */
474 struct ao_adc adc; /* raw ADC readings */
475 char callsign[AO_MAX_CALLSIGN];
478 struct ao_telemetry_orig_recv {
479 struct ao_telemetry_orig telemetry_orig;
484 struct ao_telemetry_tiny_recv {
485 struct ao_telemetry_tiny telemetry_tiny;
491 * ao_radio_recv tacks on rssi and status bytes
494 struct ao_telemetry_raw_recv {
495 uint8_t packet[AO_MAX_TELEMETRY + 2];
498 /* Set delay between telemetry reports (0 to disable) */
500 #ifdef AO_SEND_ALL_BARO
501 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(100)
502 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
503 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(100)
505 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(1000)
506 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
507 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(1000)
511 ao_telemetry_set_interval(uint16_t interval);
514 ao_rdf_set(uint8_t rdf);
517 ao_telemetry_init(void);
520 ao_telemetry_orig_init(void);
523 ao_telemetry_tiny_init(void);
529 extern __xdata uint8_t ao_radio_dma;
530 extern __xdata uint8_t ao_radio_dma_done;
531 extern __xdata uint8_t ao_radio_done;
532 extern __xdata uint8_t ao_radio_mutex;
534 #ifdef PKT_APPEND_STATUS_1_CRC_OK
535 #define AO_RADIO_STATUS_CRC_OK PKT_APPEND_STATUS_1_CRC_OK
538 #define AO_RADIO_STATUS_CRC_OK AO_FEC_DECODE_CRC_OK
542 ao_radio_general_isr(void) ao_arch_interrupt(16);
545 ao_radio_send(const __xdata void *d, uint8_t size) __reentrant;
548 ao_radio_recv(__xdata void *d, uint8_t size) __reentrant;
551 ao_radio_recv_abort(void);
554 * Compute the packet length as follows:
556 * 2000 bps (for a 1kHz tone)
557 * so, for 'ms' milliseconds, we need
558 * 2 * ms bits, or ms / 4 bytes
565 ao_radio_continuity(uint8_t c);
568 ao_radio_rdf_abort(void);
577 extern const char const * const ao_state_names[];
579 #define AO_MONITOR_RING 8
582 struct ao_telemetry_raw_recv raw;
583 struct ao_telemetry_all_recv all;
584 struct ao_telemetry_orig_recv orig;
585 struct ao_telemetry_tiny_recv tiny;
588 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
590 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
592 extern __data uint8_t ao_monitoring;
593 extern __data uint8_t ao_monitor_head;
598 #define AO_MONITORING_OFF 0
599 #define AO_MONITORING_ORIG 1
602 ao_monitor_set(uint8_t monitoring);
605 ao_monitor_disable(void);
608 ao_monitor_enable(void);
611 ao_monitor_init(void) __reentrant;
617 #define AO_READ_AGAIN ((char) -1)
620 char (*pollchar)(void);
621 void (*putchar)(char c) __reentrant;
626 extern __xdata struct ao_stdio ao_stdios[];
627 extern __pdata int8_t ao_cur_stdio;
628 extern __pdata int8_t ao_num_stdios;
633 extern __xdata uint8_t ao_stdin_ready;
639 ao_add_stdio(char (*pollchar)(void),
640 void (*putchar)(char) __reentrant,
641 void (*flush)(void)) __reentrant;
648 ao_igniter_drogue = 0,
653 ao_ignite(enum ao_igniter igniter);
655 enum ao_igniter_status {
656 ao_igniter_unknown, /* unknown status (ambiguous voltage) */
657 ao_igniter_ready, /* continuity detected */
658 ao_igniter_active, /* igniter firing */
659 ao_igniter_open, /* open circuit detected */
668 extern __xdata struct ao_ignition ao_ignition[2];
670 enum ao_igniter_status
671 ao_igniter_status(enum ao_igniter igniter);
673 extern __pdata uint8_t ao_igniter_present;
676 ao_ignite_set_pins(void);
679 ao_igniter_init(void);
685 #define AO_CONFIG_MAJOR 1
686 #define AO_CONFIG_MINOR 11
688 #define AO_AES_LEN 16
693 uint16_t main_deploy;
694 int16_t accel_plus_g; /* changed for minor version 2 */
695 uint8_t _legacy_radio_channel;
696 char callsign[AO_MAX_CALLSIGN + 1];
697 uint8_t apogee_delay; /* minor version 1 */
698 int16_t accel_minus_g; /* minor version 2 */
699 uint32_t radio_cal; /* minor version 3 */
700 uint32_t flight_log_max; /* minor version 4 */
701 uint8_t ignite_mode; /* minor version 5 */
702 uint8_t pad_orientation; /* minor version 6 */
703 uint32_t radio_setting; /* minor version 7 */
704 uint8_t radio_enable; /* minor version 8 */
705 uint8_t aes_key[AO_AES_LEN]; /* minor version 9 */
706 uint32_t frequency; /* minor version 10 */
707 uint16_t apogee_lockout; /* minor version 11 */
710 #define AO_IGNITE_MODE_DUAL 0
711 #define AO_IGNITE_MODE_APOGEE 1
712 #define AO_IGNITE_MODE_MAIN 2
714 #define AO_PAD_ORIENTATION_ANTENNA_UP 0
715 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
717 extern __xdata struct ao_config ao_config;
719 #define AO_CONFIG_MAX_SIZE 128
728 ao_config_set_radio(void);
731 ao_config_init(void);
738 ao_rssi_set(int rssi_value);
741 ao_rssi_init(uint8_t rssi_led);
746 * values which need to be defined for
747 * each instance of a product
750 extern const char ao_version[];
751 extern const char ao_manufacturer[];
752 extern const char ao_product[];
758 #define AO_FIFO_SIZE 32
763 char fifo[AO_FIFO_SIZE];
766 #define ao_fifo_insert(f,c) do { \
767 (f).fifo[(f).insert] = (c); \
768 (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
771 #define ao_fifo_remove(f,c) do {\
772 c = (f).fifo[(f).remove]; \
773 (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
776 #define ao_fifo_full(f) ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
777 #define ao_fifo_empty(f) ((f).insert == (f).remove)
779 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
780 #include <ao_packet.h>
788 #include <ao_companion.h>
801 struct ao_launch_command {
809 #define AO_LAUNCH_QUERY 1
811 struct ao_launch_query {
817 uint8_t igniter_status;
820 #define AO_LAUNCH_ARM 2
821 #define AO_LAUNCH_FIRE 3
824 ao_launch_init(void);
830 #define AO_LOG_TELESCIENCE_START ((uint8_t) 's')
831 #define AO_LOG_TELESCIENCE_DATA ((uint8_t) 'd')
833 #define AO_LOG_TELESCIENCE_NUM_ADC 12
835 struct ao_log_telescience {
842 uint16_t adc[AO_LOG_TELESCIENCE_NUM_ADC];
845 #define AO_LOG_SINGLE_SIZE 32
847 union ao_log_single {
848 struct ao_log_telescience telescience;
849 union ao_telemetry_all telemetry;
850 uint8_t bytes[AO_LOG_SINGLE_SIZE];
853 extern __xdata union ao_log_single ao_log_single_write_data;
854 extern __xdata union ao_log_single ao_log_single_read_data;
857 ao_log_single_extra_query(void);
860 ao_log_single_list(void);
863 ao_log_single_main(void);
866 ao_log_single_write(void);
869 ao_log_single_read(uint32_t pos);
872 ao_log_single_start(void);
875 ao_log_single_stop(void);
878 ao_log_single_restart(void);
881 ao_log_single_set(void);
884 ao_log_single_delete(void);
887 ao_log_single_init(void);
896 #define AO_TELEPYRO_NUM_ADC 9
899 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
900 #define ao_xmemset(d,v,c) memset(d,v,c)
901 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
909 ao_terraui_init(void);
917 ao_battery_isr(void) ao_arch_interrupt(1);
920 ao_battery_get(void);
923 ao_battery_init(void);
924 #endif /* BATTERY_PIN */
931 ao_sqrt(uint32_t op);
937 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
939 #include <ao_arch_funcs.h>
945 void ao_ms5607_init(void);