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)
54 #define AO_PANIC_NO_TASK 1 /* AO_NUM_TASKS is not large enough */
55 #define AO_PANIC_DMA 2 /* Attempt to start DMA while active */
56 #define AO_PANIC_MUTEX 3 /* Mis-using mutex API */
57 #define AO_PANIC_EE 4 /* Mis-using eeprom API */
58 #define AO_PANIC_LOG 5 /* Failing to read/write log data */
59 #define AO_PANIC_CMD 6 /* Too many command sets registered */
60 #define AO_PANIC_STDIO 7 /* Too many stdio handlers registered */
61 #define AO_PANIC_REBOOT 8 /* Reboot failed */
62 #define AO_PANIC_FLASH 9 /* Invalid flash part (or wrong blocksize) */
63 #define AO_PANIC_USB 10 /* Trying to send USB packet while busy */
64 #define AO_PANIC_BT 11 /* Communications with bluetooth device failed */
65 #define AO_PANIC_STACK 12 /* Stack overflow */
66 #define AO_PANIC_SPI 13 /* SPI communication failure */
67 #define AO_PANIC_CRASH 14 /* Processor crashed */
68 #define AO_PANIC_SELF_TEST_CC1120 0x40 | 1 /* Self test failure */
69 #define AO_PANIC_SELF_TEST_HMC5883 0x40 | 2 /* Self test failure */
70 #define AO_PANIC_SELF_TEST_MPU6000 0x40 | 3 /* Self test failure */
71 #define AO_PANIC_SELF_TEST_MS5607 0x40 | 4 /* Self test failure */
73 /* Stop the operating system, beeping and blinking the reason */
75 ao_panic(uint8_t reason);
82 #define AO_TICK_TYPE uint16_t
83 #define AO_TICK_SIGNED int16_t
86 extern volatile __data AO_TICK_TYPE ao_tick_count;
88 /* Our timer runs at 100Hz */
92 #define AO_MS_TO_TICKS(ms) ((ms) / (1000 / AO_HERTZ))
93 #define AO_SEC_TO_TICKS(s) ((s) * AO_HERTZ)
95 /* Returns the current time in ticks */
99 /* Suspend the current task until ticks time has passed */
101 ao_delay(uint16_t ticks);
103 /* Set the ADC interval */
105 ao_timer_set_adc_interval(uint8_t interval);
107 /* Timer interrupt */
109 ao_timer_isr(void) ao_arch_interrupt(9);
111 /* Initialize the timer */
115 /* Initialize the hardware clock. Must be called first */
125 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
128 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
137 ao_cmd_lex_error = 1,
138 ao_cmd_syntax_error = 2,
141 extern __pdata uint16_t ao_cmd_lex_i;
142 extern __pdata uint32_t ao_cmd_lex_u32;
143 extern __pdata char ao_cmd_lex_c;
144 extern __pdata enum ao_cmd_status ao_cmd_status;
150 ao_cmd_put8(uint8_t v);
153 ao_cmd_put16(uint16_t v);
156 ao_cmd_is_white(void);
162 ao_cmd_hexchar(char c);
165 ao_cmd_hexbyte(void);
171 ao_cmd_decimal(void);
174 ao_match_word(__code char *word);
182 ao_cmd_register(const __code struct ao_cmds *cmds);
189 * Provided by an external module to filter raw command lines
215 #include <ao_storage.h>
223 #include <ao_flight.h>
224 #include <ao_sample.h>
231 #define AO_RDF_INTERVAL_TICKS AO_SEC_TO_TICKS(5)
232 #define AO_RDF_LENGTH_MS 500
233 #define AO_RDF_CONTINUITY_MS 32
234 #define AO_RDF_CONTINUITY_PAUSE 96
235 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
237 /* This assumes that we're generating a 1kHz tone, which
238 * modulates the carrier at 2kbps, or 250kBps
240 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
242 #define AO_RADIO_RDF_LEN AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
243 #define AO_RADIO_CONT_TONE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
244 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
245 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
247 /* returns a value 0-3 to indicate igniter continuity */
249 ao_report_igniter(void);
252 ao_report_init(void);
257 * Given raw data, convert to SI units
260 /* pressure from the sensor to altitude in meters */
262 ao_pres_to_altitude(int16_t pres) __reentrant;
265 ao_altitude_to_pres(int16_t alt) __reentrant;
268 ao_temp_to_dC(int16_t temp) __reentrant;
273 * Convert between pressure in Pa and altitude in meters
279 ao_pa_to_altitude(int32_t pa);
282 ao_altitude_to_pa(alt_t alt);
288 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
289 #include <ao_serial.h>
298 ao_spi_slave_recv(uint8_t *buf, uint8_t len);
301 ao_spi_slave_send(uint8_t *buf, uint8_t len);
304 ao_spi_slave_init(void);
306 /* This must be defined by the product; it will get called when chip
307 * select goes low, at which point it should use ao_spi_read and
308 * ao_spi_write to deal with the request
314 #include <ao_telemetry.h>
319 #define AO_GPS_NUM_SAT_MASK (0xf << 0)
320 #define AO_GPS_NUM_SAT_SHIFT (0)
322 #define AO_GPS_VALID (1 << 4)
323 #define AO_GPS_RUNNING (1 << 5)
324 #define AO_GPS_DATE_VALID (1 << 6)
325 #define AO_GPS_COURSE_VALID (1 << 7)
327 extern __pdata uint16_t ao_gps_tick;
328 extern __xdata uint8_t ao_gps_mutex;
329 extern __xdata struct ao_telemetry_location ao_gps_data;
330 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
340 int32_t latitude; /* degrees * 10⁷ */
341 int32_t longitude; /* degrees * 10⁷ */
342 int16_t altitude; /* m */
343 uint16_t ground_speed; /* cm/s */
344 uint8_t course; /* degrees / 2 */
345 uint8_t hdop; /* * 5 */
346 int16_t climb_rate; /* cm/s */
347 uint16_t h_error; /* m */
348 uint16_t v_error; /* m */
351 struct ao_gps_sat_orig {
356 #define AO_MAX_GPS_TRACKING 12
358 struct ao_gps_tracking_orig {
360 struct ao_gps_sat_orig sats[AO_MAX_GPS_TRACKING];
367 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
370 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
383 ao_gps_report_init(void);
386 * ao_gps_report_mega.c
390 ao_gps_report_mega(void);
393 ao_gps_report_mega_init(void);
396 * ao_telemetry_orig.c
401 uint16_t tick; /* tick when the sample was read */
402 int16_t accel; /* accelerometer */
403 int16_t pres; /* pressure sensor */
404 int16_t temp; /* temperature sensor */
405 int16_t v_batt; /* battery voltage */
406 int16_t sense_d; /* drogue continuity sense */
407 int16_t sense_m; /* main continuity sense */
410 struct ao_telemetry_orig {
413 uint8_t flight_state;
415 int16_t ground_accel;
425 int16_t accel_plus_g;
426 int16_t accel_minus_g;
427 struct ao_adc_orig adc;
428 struct ao_gps_orig gps;
429 char callsign[AO_MAX_CALLSIGN];
430 struct ao_gps_tracking_orig gps_tracking;
433 struct ao_telemetry_tiny {
436 uint8_t flight_state;
437 int16_t height; /* AGL in meters */
438 int16_t speed; /* in m/s * 16 */
439 int16_t accel; /* in m/s² * 16 */
440 int16_t ground_pres; /* sensor units */
441 struct ao_adc adc; /* raw ADC readings */
442 char callsign[AO_MAX_CALLSIGN];
445 struct ao_telemetry_orig_recv {
446 struct ao_telemetry_orig telemetry_orig;
451 struct ao_telemetry_tiny_recv {
452 struct ao_telemetry_tiny telemetry_tiny;
457 #endif /* LEGACY_MONITOR */
459 /* Unfortunately, we've exposed the CC1111 rssi units as the 'usual' method
460 * for reporting RSSI. So, now we use these values everywhere
462 #define AO_RSSI_FROM_RADIO(radio) ((int16_t) ((int8_t) (radio) >> 1) - 74)
463 #define AO_RADIO_FROM_RSSI(rssi) (((int8_t) (rssi) + 74) << 1)
466 * ao_radio_recv tacks on rssi and status bytes
469 struct ao_telemetry_raw_recv {
470 uint8_t packet[AO_MAX_TELEMETRY + 2];
473 /* Set delay between telemetry reports (0 to disable) */
475 #ifdef AO_SEND_ALL_BARO
476 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(100)
477 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
478 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(100)
480 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(1000)
481 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
482 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(1000)
486 ao_telemetry_set_interval(uint16_t interval);
489 ao_rdf_set(uint8_t rdf);
492 ao_telemetry_init(void);
495 ao_telemetry_orig_init(void);
498 ao_telemetry_tiny_init(void);
504 extern __xdata uint8_t ao_radio_dma;
506 #ifdef PKT_APPEND_STATUS_1_CRC_OK
507 #define AO_RADIO_STATUS_CRC_OK PKT_APPEND_STATUS_1_CRC_OK
510 #define AO_RADIO_STATUS_CRC_OK AO_FEC_DECODE_CRC_OK
514 ao_radio_general_isr(void) ao_arch_interrupt(16);
517 ao_radio_send(const __xdata void *d, uint8_t size) __reentrant;
520 ao_radio_recv(__xdata void *d, uint8_t size) __reentrant;
523 ao_radio_recv_abort(void);
526 ao_radio_test(uint8_t on);
529 * Compute the packet length as follows:
531 * 2000 bps (for a 1kHz tone)
532 * so, for 'ms' milliseconds, we need
533 * 2 * ms bits, or ms / 4 bytes
540 ao_radio_continuity(uint8_t c);
543 ao_radio_rdf_abort(void);
554 extern const char const * const ao_state_names[];
556 #define AO_MONITOR_RING 8
559 struct ao_telemetry_raw_recv raw;
560 struct ao_telemetry_all_recv all;
562 struct ao_telemetry_orig_recv orig;
563 struct ao_telemetry_tiny_recv tiny;
567 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
569 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
571 extern __data uint8_t ao_monitoring;
572 extern __data uint8_t ao_monitor_head;
577 #define AO_MONITORING_OFF 0
578 #define AO_MONITORING_ORIG 1
581 ao_monitor_set(uint8_t monitoring);
584 ao_monitor_disable(void);
587 ao_monitor_enable(void);
590 ao_monitor_init(void) __reentrant;
598 #define AO_READ_AGAIN ((char) -1)
601 char (*pollchar)(void);
602 void (*putchar)(char c) __reentrant;
607 extern __xdata struct ao_stdio ao_stdios[];
608 extern __pdata int8_t ao_cur_stdio;
609 extern __pdata int8_t ao_num_stdios;
614 extern __xdata uint8_t ao_stdin_ready;
620 ao_add_stdio(char (*pollchar)(void),
621 void (*putchar)(char) __reentrant,
622 void (*flush)(void)) __reentrant;
629 ao_igniter_drogue = 0,
634 ao_ignite(enum ao_igniter igniter);
636 enum ao_igniter_status {
637 ao_igniter_unknown, /* unknown status (ambiguous voltage) */
638 ao_igniter_ready, /* continuity detected */
639 ao_igniter_active, /* igniter firing */
640 ao_igniter_open, /* open circuit detected */
649 extern __xdata struct ao_ignition ao_ignition[2];
651 enum ao_igniter_status
652 ao_igniter_status(enum ao_igniter igniter);
654 extern __pdata uint8_t ao_igniter_present;
657 ao_ignite_set_pins(void);
660 ao_igniter_init(void);
672 * Set this to force the frequency to 434.550MHz
674 extern __xdata uint8_t ao_force_freq;
677 #define AO_CONFIG_MAJOR 1
678 #define AO_CONFIG_MINOR 12
680 #define AO_AES_LEN 16
682 extern __xdata uint8_t ao_config_aes_seq;
687 uint16_t main_deploy;
688 int16_t accel_plus_g; /* changed for minor version 2 */
689 uint8_t _legacy_radio_channel;
690 char callsign[AO_MAX_CALLSIGN + 1];
691 uint8_t apogee_delay; /* minor version 1 */
692 int16_t accel_minus_g; /* minor version 2 */
693 uint32_t radio_cal; /* minor version 3 */
694 uint32_t flight_log_max; /* minor version 4 */
695 uint8_t ignite_mode; /* minor version 5 */
696 uint8_t pad_orientation; /* minor version 6 */
697 uint32_t radio_setting; /* minor version 7 */
698 uint8_t radio_enable; /* minor version 8 */
699 uint8_t aes_key[AO_AES_LEN]; /* minor version 9 */
700 uint32_t frequency; /* minor version 10 */
701 uint16_t apogee_lockout; /* minor version 11 */
703 struct ao_pyro pyro[AO_PYRO_NUM]; /* minor version 12 */
707 #define AO_IGNITE_MODE_DUAL 0
708 #define AO_IGNITE_MODE_APOGEE 1
709 #define AO_IGNITE_MODE_MAIN 2
711 #define AO_PAD_ORIENTATION_ANTENNA_UP 0
712 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
714 extern __xdata struct ao_config ao_config;
716 #define AO_CONFIG_MAX_SIZE 128
719 _ao_config_edit_start(void);
722 _ao_config_edit_finish(void);
731 ao_config_set_radio(void);
734 ao_config_init(void);
741 ao_rssi_set(int rssi_value);
744 ao_rssi_init(uint8_t rssi_led);
749 * values which need to be defined for
750 * each instance of a product
753 extern const char ao_version[];
754 extern const char ao_manufacturer[];
755 extern const char ao_product[];
761 #define AO_FIFO_SIZE 32
766 char fifo[AO_FIFO_SIZE];
769 #define ao_fifo_insert(f,c) do { \
770 (f).fifo[(f).insert] = (c); \
771 (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
774 #define ao_fifo_remove(f,c) do {\
775 c = (f).fifo[(f).remove]; \
776 (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
779 #define ao_fifo_full(f) ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
780 #define ao_fifo_empty(f) ((f).insert == (f).remove)
782 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
783 #include <ao_packet.h>
791 #include <ao_companion.h>
804 struct ao_launch_command {
812 #define AO_LAUNCH_QUERY 1
814 struct ao_launch_query {
820 uint8_t igniter_status;
823 #define AO_LAUNCH_ARM 2
824 #define AO_LAUNCH_FIRE 3
827 ao_launch_init(void);
833 #define AO_LOG_TELESCIENCE_START ((uint8_t) 's')
834 #define AO_LOG_TELESCIENCE_DATA ((uint8_t) 'd')
836 #define AO_LOG_TELESCIENCE_NUM_ADC 12
838 struct ao_log_telescience {
845 uint16_t adc[AO_LOG_TELESCIENCE_NUM_ADC];
848 #define AO_LOG_SINGLE_SIZE 32
850 union ao_log_single {
851 struct ao_log_telescience telescience;
852 union ao_telemetry_all telemetry;
853 uint8_t bytes[AO_LOG_SINGLE_SIZE];
856 extern __xdata union ao_log_single ao_log_single_write_data;
857 extern __xdata union ao_log_single ao_log_single_read_data;
860 ao_log_single_extra_query(void);
863 ao_log_single_list(void);
866 ao_log_single_main(void);
869 ao_log_single_write(void);
872 ao_log_single_read(uint32_t pos);
875 ao_log_single_start(void);
878 ao_log_single_stop(void);
881 ao_log_single_restart(void);
884 ao_log_single_set(void);
887 ao_log_single_delete(void);
890 ao_log_single_init(void);
899 #define AO_TELEPYRO_NUM_ADC 9
902 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
903 #define ao_xmemset(d,v,c) memset(d,v,c)
904 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
912 ao_terraui_init(void);
920 ao_battery_isr(void) ao_arch_interrupt(1);
923 ao_battery_get(void);
926 ao_battery_init(void);
927 #endif /* BATTERY_PIN */
934 ao_sqrt(uint32_t op);
940 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
946 void ao_ms5607_init(void);
948 #include <ao_arch_funcs.h>