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)
49 #include <ao_notask.h>
56 #define AO_PANIC_NO_TASK 1 /* AO_NUM_TASKS is not large enough */
57 #define AO_PANIC_DMA 2 /* Attempt to start DMA while active */
58 #define AO_PANIC_MUTEX 3 /* Mis-using mutex API */
59 #define AO_PANIC_EE 4 /* Mis-using eeprom API */
60 #define AO_PANIC_LOG 5 /* Failing to read/write log data */
61 #define AO_PANIC_CMD 6 /* Too many command sets registered */
62 #define AO_PANIC_STDIO 7 /* Too many stdio handlers registered */
63 #define AO_PANIC_REBOOT 8 /* Reboot failed */
64 #define AO_PANIC_FLASH 9 /* Invalid flash part (or wrong blocksize) */
65 #define AO_PANIC_USB 10 /* Trying to send USB packet while busy */
66 #define AO_PANIC_BT 11 /* Communications with bluetooth device failed */
67 #define AO_PANIC_STACK 12 /* Stack overflow */
68 #define AO_PANIC_SPI 13 /* SPI communication failure */
69 #define AO_PANIC_CRASH 14 /* Processor crashed */
70 #define AO_PANIC_BUFIO 15 /* Mis-using bufio API */
71 #define AO_PANIC_SELF_TEST_CC1120 0x40 | 1 /* Self test failure */
72 #define AO_PANIC_SELF_TEST_HMC5883 0x40 | 2 /* Self test failure */
73 #define AO_PANIC_SELF_TEST_MPU6000 0x40 | 3 /* Self test failure */
74 #define AO_PANIC_SELF_TEST_MS5607 0x40 | 4 /* Self test failure */
76 /* Stop the operating system, beeping and blinking the reason */
78 ao_panic(uint8_t reason);
85 #define AO_TICK_TYPE uint16_t
86 #define AO_TICK_SIGNED int16_t
89 extern volatile __data AO_TICK_TYPE ao_tick_count;
91 /* Our timer runs at 100Hz */
95 #define AO_MS_TO_TICKS(ms) ((ms) / (1000 / AO_HERTZ))
96 #define AO_SEC_TO_TICKS(s) ((s) * AO_HERTZ)
98 /* Returns the current time in ticks */
102 /* Suspend the current task until ticks time has passed */
104 ao_delay(uint16_t ticks);
106 /* Set the ADC interval */
108 ao_timer_set_adc_interval(uint8_t interval);
110 /* Timer interrupt */
112 ao_timer_isr(void) ao_arch_interrupt(9);
114 /* Initialize the timer */
118 /* Initialize the hardware clock. Must be called first */
128 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
131 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
140 ao_cmd_lex_error = 1,
141 ao_cmd_syntax_error = 2,
144 extern __pdata uint16_t ao_cmd_lex_i;
145 extern __pdata uint32_t ao_cmd_lex_u32;
146 extern __pdata char ao_cmd_lex_c;
147 extern __pdata enum ao_cmd_status ao_cmd_status;
150 ao_put_string(__code char *s);
156 ao_cmd_put8(uint8_t v);
159 ao_cmd_put16(uint16_t v);
162 ao_cmd_is_white(void);
168 ao_cmd_hexchar(char c);
171 ao_cmd_hexbyte(void);
177 ao_cmd_decimal(void);
179 /* Read a single hex nibble off stdin. */
184 ao_match_word(__code char *word);
192 ao_cmd_register(const __code struct ao_cmds *cmds);
199 * Provided by an external module to filter raw command lines
225 #include <ao_storage.h>
233 #include <ao_flight.h>
234 #include <ao_sample.h>
241 #define AO_RDF_INTERVAL_TICKS AO_SEC_TO_TICKS(5)
242 #define AO_RDF_LENGTH_MS 500
243 #define AO_RDF_CONTINUITY_MS 32
244 #define AO_RDF_CONTINUITY_PAUSE 96
245 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
247 /* This assumes that we're generating a 1kHz tone, which
248 * modulates the carrier at 2kbps, or 250kBps
250 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
252 #define AO_RADIO_RDF_LEN AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
253 #define AO_RADIO_CONT_TONE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
254 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
255 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
257 /* returns a value 0-3 to indicate igniter continuity */
259 ao_report_igniter(void);
262 ao_report_init(void);
267 * Given raw data, convert to SI units
270 /* pressure from the sensor to altitude in meters */
272 ao_pres_to_altitude(int16_t pres) __reentrant;
275 ao_altitude_to_pres(int16_t alt) __reentrant;
278 ao_temp_to_dC(int16_t temp) __reentrant;
283 * Convert between pressure in Pa and altitude in meters
289 ao_pa_to_altitude(int32_t pa);
292 ao_altitude_to_pa(alt_t alt);
298 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
299 #include <ao_serial.h>
308 ao_spi_slave_recv(void *buf, uint16_t len);
311 ao_spi_slave_send(void *buf, uint16_t len);
314 ao_spi_slave_init(void);
316 /* This must be defined by the product; it will get called when chip
317 * select goes low, at which point it should use ao_spi_read and
318 * ao_spi_write to deal with the request
324 #include <ao_telemetry.h>
329 #define AO_GPS_NUM_SAT_MASK (0xf << 0)
330 #define AO_GPS_NUM_SAT_SHIFT (0)
332 #define AO_GPS_VALID (1 << 4)
333 #define AO_GPS_RUNNING (1 << 5)
334 #define AO_GPS_DATE_VALID (1 << 6)
335 #define AO_GPS_COURSE_VALID (1 << 7)
337 extern __pdata uint16_t ao_gps_tick;
338 extern __xdata uint8_t ao_gps_mutex;
339 extern __xdata struct ao_telemetry_location ao_gps_data;
340 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
350 int32_t latitude; /* degrees * 10⁷ */
351 int32_t longitude; /* degrees * 10⁷ */
352 int16_t altitude; /* m */
353 uint16_t ground_speed; /* cm/s */
354 uint8_t course; /* degrees / 2 */
355 uint8_t hdop; /* * 5 */
356 int16_t climb_rate; /* cm/s */
357 uint16_t h_error; /* m */
358 uint16_t v_error; /* m */
361 struct ao_gps_sat_orig {
366 #define AO_MAX_GPS_TRACKING 12
368 struct ao_gps_tracking_orig {
370 struct ao_gps_sat_orig sats[AO_MAX_GPS_TRACKING];
377 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
380 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
393 ao_gps_report_init(void);
396 * ao_gps_report_mega.c
400 ao_gps_report_mega(void);
403 ao_gps_report_mega_init(void);
406 * ao_telemetry_orig.c
411 uint16_t tick; /* tick when the sample was read */
412 int16_t accel; /* accelerometer */
413 int16_t pres; /* pressure sensor */
414 int16_t temp; /* temperature sensor */
415 int16_t v_batt; /* battery voltage */
416 int16_t sense_d; /* drogue continuity sense */
417 int16_t sense_m; /* main continuity sense */
420 struct ao_telemetry_orig {
423 uint8_t flight_state;
425 int16_t ground_accel;
435 int16_t accel_plus_g;
436 int16_t accel_minus_g;
437 struct ao_adc_orig adc;
438 struct ao_gps_orig gps;
439 char callsign[AO_MAX_CALLSIGN];
440 struct ao_gps_tracking_orig gps_tracking;
443 struct ao_telemetry_tiny {
446 uint8_t flight_state;
447 int16_t height; /* AGL in meters */
448 int16_t speed; /* in m/s * 16 */
449 int16_t accel; /* in m/s² * 16 */
450 int16_t ground_pres; /* sensor units */
451 struct ao_adc adc; /* raw ADC readings */
452 char callsign[AO_MAX_CALLSIGN];
455 struct ao_telemetry_orig_recv {
456 struct ao_telemetry_orig telemetry_orig;
461 struct ao_telemetry_tiny_recv {
462 struct ao_telemetry_tiny telemetry_tiny;
467 #endif /* LEGACY_MONITOR */
469 /* Unfortunately, we've exposed the CC1111 rssi units as the 'usual' method
470 * for reporting RSSI. So, now we use these values everywhere
472 #define AO_RSSI_FROM_RADIO(radio) ((int16_t) ((int8_t) (radio) >> 1) - 74)
473 #define AO_RADIO_FROM_RSSI(rssi) (((int8_t) (rssi) + 74) << 1)
476 * ao_radio_recv tacks on rssi and status bytes
479 struct ao_telemetry_raw_recv {
480 uint8_t packet[AO_MAX_TELEMETRY + 2];
483 /* Set delay between telemetry reports (0 to disable) */
485 #ifdef AO_SEND_ALL_BARO
486 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(100)
487 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
488 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(100)
490 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(1000)
491 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
492 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(1000)
496 ao_telemetry_set_interval(uint16_t interval);
499 ao_rdf_set(uint8_t rdf);
502 ao_telemetry_init(void);
505 ao_telemetry_orig_init(void);
508 ao_telemetry_tiny_init(void);
514 extern __xdata uint8_t ao_radio_dma;
516 extern __xdata int8_t ao_radio_rssi;
518 #ifdef PKT_APPEND_STATUS_1_CRC_OK
519 #define AO_RADIO_STATUS_CRC_OK PKT_APPEND_STATUS_1_CRC_OK
522 #define AO_RADIO_STATUS_CRC_OK AO_FEC_DECODE_CRC_OK
525 #ifndef HAS_RADIO_RECV
526 #define HAS_RADIO_RECV HAS_RADIO
528 #ifndef HAS_RADIO_XMIT
529 #define HAS_RADIO_XMIT HAS_RADIO
533 ao_radio_general_isr(void) ao_arch_interrupt(16);
537 ao_radio_send(const __xdata void *d, uint8_t size) __reentrant;
542 ao_radio_recv(__xdata void *d, uint8_t size, uint8_t timeout) __reentrant;
545 ao_radio_recv_abort(void);
549 ao_radio_test(uint8_t on);
551 typedef int16_t (*ao_radio_fill_func)(uint8_t *buffer, int16_t len);
554 ao_radio_send_aprs(ao_radio_fill_func fill);
562 ao_radio_pa_on(void);
565 ao_radio_pa_off(void);
568 ao_radio_pa_init(void);
570 #define ao_radio_pa_on()
571 #define ao_radio_pa_off()
572 #define ao_radio_pa_init()
576 * Compute the packet length as follows:
578 * 2000 bps (for a 1kHz tone)
579 * so, for 'ms' milliseconds, we need
580 * 2 * ms bits, or ms / 4 bytes
587 ao_radio_continuity(uint8_t c);
590 ao_radio_rdf_abort(void);
601 extern const char const * const ao_state_names[];
603 #define AO_MONITOR_RING 8
606 struct ao_telemetry_raw_recv raw;
607 struct ao_telemetry_all_recv all;
609 struct ao_telemetry_orig_recv orig;
610 struct ao_telemetry_tiny_recv tiny;
614 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
616 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
618 extern __data uint8_t ao_monitoring;
619 extern __data uint8_t ao_monitor_head;
624 #define AO_MONITORING_OFF 0
625 #define AO_MONITORING_ORIG 1
628 ao_monitor_set(uint8_t monitoring);
631 ao_monitor_disable(void);
634 ao_monitor_enable(void);
637 ao_monitor_init(void) __reentrant;
645 #define AO_READ_AGAIN (-1)
648 int (*_pollchar)(void); /* Called with interrupts blocked */
649 void (*putchar)(char c) __reentrant;
654 extern __xdata struct ao_stdio ao_stdios[];
655 extern __pdata int8_t ao_cur_stdio;
656 extern __pdata int8_t ao_num_stdios;
661 extern __xdata uint8_t ao_stdin_ready;
667 ao_add_stdio(int (*pollchar)(void),
668 void (*putchar)(char) __reentrant,
669 void (*flush)(void)) __reentrant;
676 ao_igniter_drogue = 0,
681 ao_ignite(enum ao_igniter igniter);
683 enum ao_igniter_status {
684 ao_igniter_unknown, /* unknown status (ambiguous voltage) */
685 ao_igniter_ready, /* continuity detected */
686 ao_igniter_active, /* igniter firing */
687 ao_igniter_open, /* open circuit detected */
696 extern __xdata struct ao_ignition ao_ignition[2];
698 enum ao_igniter_status
699 ao_igniter_status(enum ao_igniter igniter);
701 extern __pdata uint8_t ao_igniter_present;
704 ao_ignite_set_pins(void);
707 ao_igniter_init(void);
719 * Set this to force the frequency to 434.550MHz
721 extern __xdata uint8_t ao_force_freq;
724 #define AO_CONFIG_MAJOR 1
725 #define AO_CONFIG_MINOR 14
727 #define AO_AES_LEN 16
729 extern __xdata uint8_t ao_config_aes_seq;
734 uint16_t main_deploy;
735 int16_t accel_plus_g; /* changed for minor version 2 */
736 uint8_t _legacy_radio_channel;
737 char callsign[AO_MAX_CALLSIGN + 1];
738 uint8_t apogee_delay; /* minor version 1 */
739 int16_t accel_minus_g; /* minor version 2 */
740 uint32_t radio_cal; /* minor version 3 */
741 uint32_t flight_log_max; /* minor version 4 */
742 uint8_t ignite_mode; /* minor version 5 */
743 uint8_t pad_orientation; /* minor version 6 */
744 uint32_t radio_setting; /* minor version 7 */
745 uint8_t radio_enable; /* minor version 8 */
746 uint8_t aes_key[AO_AES_LEN]; /* minor version 9 */
747 uint32_t frequency; /* minor version 10 */
748 uint16_t apogee_lockout; /* minor version 11 */
750 struct ao_pyro pyro[AO_PYRO_NUM]; /* minor version 12 */
752 uint16_t aprs_interval; /* minor version 13 */
754 uint8_t radio_power; /* minor version 14 */
757 uint8_t radio_amp; /* minor version 14 */
761 #define AO_IGNITE_MODE_DUAL 0
762 #define AO_IGNITE_MODE_APOGEE 1
763 #define AO_IGNITE_MODE_MAIN 2
765 #define AO_RADIO_ENABLE_CORE 1
766 #define AO_RADIO_DISABLE_TELEMETRY 2
767 #define AO_RADIO_DISABLE_RDF 4
769 #define AO_PAD_ORIENTATION_ANTENNA_UP 0
770 #define AO_PAD_ORIENTATION_ANTENNA_DOWN 1
772 extern __xdata struct ao_config ao_config;
774 #define AO_CONFIG_MAX_SIZE 128
777 _ao_config_edit_start(void);
780 _ao_config_edit_finish(void);
789 ao_config_set_radio(void);
792 ao_config_init(void);
799 ao_rssi_set(int rssi_value);
802 ao_rssi_init(uint8_t rssi_led);
807 * values which need to be defined for
808 * each instance of a product
811 extern const char ao_version[];
812 extern const char ao_manufacturer[];
813 extern const char ao_product[];
819 #define AO_FIFO_SIZE 32
824 char fifo[AO_FIFO_SIZE];
827 #define ao_fifo_insert(f,c) do { \
828 (f).fifo[(f).insert] = (c); \
829 (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
832 #define ao_fifo_remove(f,c) do {\
833 c = (f).fifo[(f).remove]; \
834 (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
837 #define ao_fifo_full(f) ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
838 #define ao_fifo_empty(f) ((f).insert == (f).remove)
840 #if PACKET_HAS_MASTER || PACKET_HAS_SLAVE
841 #include <ao_packet.h>
849 #include <ao_companion.h>
862 struct ao_launch_command {
870 #define AO_LAUNCH_QUERY 1
872 struct ao_launch_query {
878 uint8_t igniter_status;
881 #define AO_LAUNCH_ARM 2
882 #define AO_LAUNCH_FIRE 3
885 ao_launch_init(void);
891 #define AO_LOG_TELESCIENCE_START ((uint8_t) 's')
892 #define AO_LOG_TELESCIENCE_DATA ((uint8_t) 'd')
894 #define AO_LOG_TELESCIENCE_NUM_ADC 12
896 struct ao_log_telescience {
903 uint16_t adc[AO_LOG_TELESCIENCE_NUM_ADC];
906 #define AO_LOG_SINGLE_SIZE 32
908 union ao_log_single {
909 struct ao_log_telescience telescience;
910 union ao_telemetry_all telemetry;
911 uint8_t bytes[AO_LOG_SINGLE_SIZE];
914 extern __xdata union ao_log_single ao_log_single_write_data;
915 extern __xdata union ao_log_single ao_log_single_read_data;
918 ao_log_single_extra_query(void);
921 ao_log_single_list(void);
924 ao_log_single_main(void);
927 ao_log_single_write(void);
930 ao_log_single_read(uint32_t pos);
933 ao_log_single_start(void);
936 ao_log_single_stop(void);
939 ao_log_single_restart(void);
942 ao_log_single_set(void);
945 ao_log_single_delete(void);
948 ao_log_single_init(void);
957 #define AO_TELEPYRO_NUM_ADC 9
960 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
961 #define ao_xmemset(d,v,c) memset(d,v,c)
962 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
970 ao_terraui_init(void);
978 ao_battery_isr(void) ao_arch_interrupt(1);
981 ao_battery_get(void);
984 ao_battery_init(void);
985 #endif /* BATTERY_PIN */
992 ao_sqrt(uint32_t op);
998 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
1004 void ao_ms5607_init(void);
1006 #include <ao_arch_funcs.h>