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; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.
32 /* Convert a __data pointer into an __xdata pointer */
34 #define DATA_TO_XDATA(a) (a)
36 #ifndef PDATA_TO_XDATA
37 #define PDATA_TO_XDATA(a) (a)
40 #define CODE_TO_XDATA(a) (a)
47 typedef AO_PORT_TYPE ao_port_t;
52 #include <ao_notask.h>
59 #define AO_PANIC_NO_TASK 1 /* AO_NUM_TASKS is not large enough */
60 #define AO_PANIC_DMA 2 /* Attempt to start DMA while active */
61 #define AO_PANIC_MUTEX 3 /* Mis-using mutex API */
62 #define AO_PANIC_EE 4 /* Mis-using eeprom API */
63 #define AO_PANIC_LOG 5 /* Failing to read/write log data */
64 #define AO_PANIC_CMD 6 /* Too many command sets registered */
65 #define AO_PANIC_STDIO 7 /* Too many stdio handlers registered */
66 #define AO_PANIC_REBOOT 8 /* Reboot failed */
67 #define AO_PANIC_FLASH 9 /* Invalid flash part (or wrong blocksize) */
68 #define AO_PANIC_USB 10 /* Trying to send USB packet while busy */
69 #define AO_PANIC_BT 11 /* Communications with bluetooth device failed */
70 #define AO_PANIC_STACK 12 /* Stack overflow */
71 #define AO_PANIC_SPI 13 /* SPI communication failure */
72 #define AO_PANIC_CRASH 14 /* Processor crashed */
73 #define AO_PANIC_BUFIO 15 /* Mis-using bufio API */
74 #define AO_PANIC_EXTI 16 /* Mis-using exti API */
75 #define AO_PANIC_FAST_TIMER 17 /* Mis-using fast timer API */
76 #define AO_PANIC_ADC 18 /* Mis-using ADC interface */
77 #define AO_PANIC_IRQ 19 /* interrupts not blocked */
78 #define AO_PANIC_SELF_TEST_CC1120 0x40 | 1 /* Self test failure */
79 #define AO_PANIC_SELF_TEST_HMC5883 0x40 | 2 /* Self test failure */
80 #define AO_PANIC_SELF_TEST_MPU6000 0x40 | 3 /* Self test failure */
81 #define AO_PANIC_SELF_TEST_MPU9250 0x40 | 3 /* Self test failure */
82 #define AO_PANIC_SELF_TEST_MS5607 0x40 | 4 /* Self test failure */
84 /* Stop the operating system, beeping and blinking the reason */
86 ao_panic(uint8_t reason);
93 #define AO_TICK_TYPE uint16_t
94 #define AO_TICK_SIGNED int16_t
97 extern volatile __data AO_TICK_TYPE ao_tick_count;
99 /* Our timer runs at 100Hz */
103 #define AO_MS_TO_TICKS(ms) ((ms) / (1000 / AO_HERTZ))
104 #define AO_SEC_TO_TICKS(s) ((s) * AO_HERTZ)
106 /* Returns the current time in ticks */
110 /* Suspend the current task until ticks time has passed */
112 ao_delay(uint16_t ticks);
114 /* Set the ADC interval */
116 ao_timer_set_adc_interval(uint8_t interval);
118 /* Timer interrupt */
120 ao_timer_isr(void) ao_arch_interrupt(9);
122 /* Initialize the timer */
126 /* Initialize the hardware clock. Must be called first */
130 #if AO_POWER_MANAGEMENT
131 /* Go to low power clock */
133 ao_clock_suspend(void);
135 /* Restart full-speed clock */
137 ao_clock_resume(void);
146 ao_mutex_try(__xdata uint8_t *ao_mutex, uint8_t task_id) __reentrant;
149 ao_mutex_get(__xdata uint8_t *ao_mutex) __reentrant;
152 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
161 ao_cmd_lex_error = 1,
162 ao_cmd_syntax_error = 2,
165 extern __pdata uint16_t ao_cmd_lex_i;
166 extern __pdata uint32_t ao_cmd_lex_u32;
167 extern __pdata char ao_cmd_lex_c;
168 extern __pdata enum ao_cmd_status ao_cmd_status;
171 ao_put_string(__code char *s);
174 ao_cmd_readline(void);
180 ao_cmd_put8(uint8_t v);
183 ao_cmd_put16(uint16_t v);
186 ao_cmd_is_white(void);
192 ao_cmd_hexchar(char c);
195 ao_cmd_hexbyte(void);
201 ao_cmd_decimal(void) __reentrant;
203 /* Read a single hex nibble off stdin. */
208 ao_match_word(__code char *word);
216 ao_cmd_register(const __code struct ao_cmds *cmds);
223 * Provided by an external module to filter raw command lines
249 #include <ao_storage.h>
257 #include <ao_flight.h>
258 #include <ao_sample.h>
265 #define AO_RDF_INTERVAL_TICKS AO_SEC_TO_TICKS(5)
266 #define AO_RDF_LENGTH_MS 500
267 #define AO_RDF_CONTINUITY_MS 32
268 #define AO_RDF_CONTINUITY_PAUSE 96
269 #define AO_RDF_CONTINUITY_TOTAL ((AO_RDF_CONTINUITY_PAUSE + AO_RDF_CONTINUITY_MS) * 3 + AO_RDF_CONTINUITY_PAUSE)
271 /* This assumes that we're generating a 1kHz tone, which
272 * modulates the carrier at 2kbps, or 250kBps
274 #define AO_MS_TO_RDF_LEN(ms) ((ms) / 4)
276 #define AO_RADIO_RDF_LEN AO_MS_TO_RDF_LEN(AO_RDF_LENGTH_MS)
277 #define AO_RADIO_CONT_TONE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_MS)
278 #define AO_RADIO_CONT_PAUSE_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_PAUSE)
279 #define AO_RADIO_CONT_TOTAL_LEN AO_MS_TO_RDF_LEN(AO_RDF_CONTINUITY_TOTAL)
281 /* returns a value 0-3 to indicate igniter continuity */
283 ao_report_igniter(void);
286 ao_report_init(void);
291 * Given raw data, convert to SI units
295 /* pressure from the sensor to altitude in meters */
297 ao_pres_to_altitude(pres_t pres) __reentrant;
300 ao_altitude_to_pres(alt_t alt) __reentrant;
303 ao_temp_to_dC(int16_t temp) __reentrant;
309 * Convert between pressure in Pa and altitude in meters
316 ao_pa_to_altitude(pres_t pa);
319 ao_altitude_to_pa(alt_t alt);
326 #if HAS_SERIAL_0 || HAS_SERIAL_1 || HAS_SERIAL_2 || HAS_SERIAL_3
327 #include <ao_serial.h>
333 * Convert ADC readings to decivolts
337 ao_battery_decivolt(int16_t adc);
340 ao_ignite_decivolt(int16_t adc);
347 ao_spi_slave_recv(void *buf, uint16_t len);
350 ao_spi_slave_send(void *buf, uint16_t len);
353 ao_spi_slave_init(void);
355 /* This must be defined by the product; it will get called when chip
356 * select goes low, at which point it should use ao_spi_read and
357 * ao_spi_write to deal with the request
363 #include <ao_telemetry.h>
368 #define AO_GPS_NUM_SAT_MASK (0xf << 0)
369 #define AO_GPS_NUM_SAT_SHIFT (0)
371 #define AO_GPS_VALID (1 << 4)
372 #define AO_GPS_RUNNING (1 << 5)
373 #define AO_GPS_DATE_VALID (1 << 6)
374 #define AO_GPS_COURSE_VALID (1 << 7)
376 #define AO_GPS_NEW_DATA 1
377 #define AO_GPS_NEW_TRACKING 2
379 extern __xdata uint8_t ao_gps_new;
380 extern __pdata uint16_t ao_gps_tick;
381 extern __xdata uint8_t ao_gps_mutex;
382 extern __xdata struct ao_telemetry_location ao_gps_data;
383 extern __xdata struct ao_telemetry_satellite ao_gps_tracking_data;
393 int32_t latitude; /* degrees * 10⁷ */
394 int32_t longitude; /* degrees * 10⁷ */
395 int16_t altitude; /* m */
396 uint16_t ground_speed; /* cm/s */
397 uint8_t course; /* degrees / 2 */
398 uint8_t hdop; /* * 5 */
399 int16_t climb_rate; /* cm/s */
400 uint16_t h_error; /* m */
401 uint16_t v_error; /* m */
404 struct ao_gps_sat_orig {
409 #define AO_MAX_GPS_TRACKING 12
411 struct ao_gps_tracking_orig {
413 struct ao_gps_sat_orig sats[AO_MAX_GPS_TRACKING];
417 ao_gps_set_rate(uint8_t rate);
423 ao_gps_print(__xdata struct ao_gps_orig *gps_data);
426 ao_gps_tracking_print(__xdata struct ao_gps_tracking_orig *gps_tracking_data);
429 ao_gps_show(void) __reentrant;
442 ao_gps_report_init(void);
445 * ao_gps_report_mega.c
449 ao_gps_report_mega(void);
452 ao_gps_report_mega_init(void);
455 * ao_telemetry_orig.c
460 uint16_t tick; /* tick when the sample was read */
461 int16_t accel; /* accelerometer */
462 int16_t pres; /* pressure sensor */
463 int16_t temp; /* temperature sensor */
464 int16_t v_batt; /* battery voltage */
465 int16_t sense_d; /* drogue continuity sense */
466 int16_t sense_m; /* main continuity sense */
469 struct ao_telemetry_orig {
472 uint8_t flight_state;
474 int16_t ground_accel;
484 int16_t accel_plus_g;
485 int16_t accel_minus_g;
486 struct ao_adc_orig adc;
487 struct ao_gps_orig gps;
488 char callsign[AO_MAX_CALLSIGN];
489 struct ao_gps_tracking_orig gps_tracking;
492 struct ao_telemetry_tiny {
495 uint8_t flight_state;
496 int16_t height; /* AGL in meters */
497 int16_t speed; /* in m/s * 16 */
498 int16_t accel; /* in m/s² * 16 */
499 int16_t ground_pres; /* sensor units */
500 struct ao_adc adc; /* raw ADC readings */
501 char callsign[AO_MAX_CALLSIGN];
504 struct ao_telemetry_orig_recv {
505 struct ao_telemetry_orig telemetry_orig;
510 struct ao_telemetry_tiny_recv {
511 struct ao_telemetry_tiny telemetry_tiny;
516 #endif /* LEGACY_MONITOR */
518 /* Unfortunately, we've exposed the CC1111 rssi units as the 'usual' method
519 * for reporting RSSI. So, now we use these values everywhere
521 #define AO_RSSI_FROM_RADIO(radio) ((int16_t) ((int8_t) (radio) >> 1) - 74)
522 #define AO_RADIO_FROM_RSSI(rssi) (((int8_t) (rssi) + 74) << 1)
525 * ao_radio_recv tacks on rssi and status bytes
528 struct ao_telemetry_raw_recv {
529 uint8_t packet[AO_MAX_TELEMETRY + 2];
532 /* Set delay between telemetry reports (0 to disable) */
534 #define AO_TELEMETRY_INTERVAL_PAD AO_MS_TO_TICKS(1000)
535 #define AO_TELEMETRY_INTERVAL_FLIGHT AO_MS_TO_TICKS(100)
536 #define AO_TELEMETRY_INTERVAL_RECOVER AO_MS_TO_TICKS(1000)
539 ao_telemetry_reset_interval(void);
542 ao_telemetry_set_interval(uint16_t interval);
545 ao_rdf_set(uint8_t rdf);
548 ao_telemetry_init(void);
551 ao_telemetry_orig_init(void);
554 ao_telemetry_tiny_init(void);
560 extern __xdata uint8_t ao_radio_dma;
562 extern __xdata int8_t ao_radio_rssi;
564 #ifdef PKT_APPEND_STATUS_1_CRC_OK
565 #define AO_RADIO_STATUS_CRC_OK PKT_APPEND_STATUS_1_CRC_OK
568 #define AO_RADIO_STATUS_CRC_OK AO_FEC_DECODE_CRC_OK
571 #ifndef HAS_RADIO_RECV
572 #define HAS_RADIO_RECV HAS_RADIO
574 #ifndef HAS_RADIO_XMIT
575 #define HAS_RADIO_XMIT HAS_RADIO
578 #define AO_RADIO_RATE_38400 0
579 #define AO_RADIO_RATE_9600 1
580 #define AO_RADIO_RATE_2400 2
581 #define AO_RADIO_RATE_MAX AO_RADIO_RATE_2400
583 #if defined(HAS_RADIO) && !defined(HAS_RADIO_RATE)
584 #define HAS_RADIO_RATE HAS_RADIO
588 ao_radio_general_isr(void) ao_arch_interrupt(16);
592 ao_radio_send(const __xdata void *d, uint8_t size) __reentrant;
597 ao_radio_recv(__xdata void *d, uint8_t size, uint8_t timeout) __reentrant;
600 ao_radio_recv_abort(void);
604 ao_radio_test(uint8_t on);
606 typedef int16_t (*ao_radio_fill_func)(uint8_t *buffer, int16_t len);
609 ao_radio_send_aprs(ao_radio_fill_func fill);
617 ao_radio_pa_on(void);
620 ao_radio_pa_off(void);
623 ao_radio_pa_init(void);
625 #define ao_radio_pa_on()
626 #define ao_radio_pa_off()
627 #define ao_radio_pa_init()
631 * Compute the packet length as follows:
633 * 2000 bps (for a 1kHz tone)
634 * so, for 'ms' milliseconds, we need
635 * 2 * ms bits, or ms / 4 bytes
642 ao_radio_continuity(uint8_t c);
645 ao_radio_rdf_abort(void);
648 ao_radio_test_on(void);
651 ao_radio_test_off(void);
662 extern const char const * const ao_state_names[];
664 #define AO_MONITOR_RING 8
667 struct ao_telemetry_raw_recv raw;
668 struct ao_telemetry_all_recv all;
670 struct ao_telemetry_orig_recv orig;
671 struct ao_telemetry_tiny_recv tiny;
675 extern __xdata union ao_monitor ao_monitor_ring[AO_MONITOR_RING];
677 #define ao_monitor_ring_next(n) (((n) + 1) & (AO_MONITOR_RING - 1))
678 #define ao_monitor_ring_prev(n) (((n) - 1) & (AO_MONITOR_RING - 1))
680 extern __xdata uint8_t ao_monitoring_mutex;
681 extern __data uint8_t ao_monitoring;
682 extern __data uint8_t ao_monitor_head;
687 #define AO_MONITORING_OFF 0
688 #define AO_MONITORING_ORIG 1
691 ao_monitor_set(uint8_t monitoring);
694 ao_monitor_disable(void);
697 ao_monitor_enable(void);
700 ao_monitor_init(void) __reentrant;
708 #define AO_READ_AGAIN (-1)
711 int (*_pollchar)(void); /* Called with interrupts blocked */
712 void (*putchar)(char c) __reentrant;
717 extern __xdata struct ao_stdio ao_stdios[];
718 extern __pdata int8_t ao_cur_stdio;
719 extern __pdata int8_t ao_num_stdios;
724 extern __xdata uint8_t ao_stdin_ready;
730 ao_add_stdio(int (*pollchar)(void),
731 void (*putchar)(char) __reentrant,
732 void (*flush)(void)) __reentrant;
739 ao_igniter_drogue = 0,
744 ao_ignite(enum ao_igniter igniter);
746 enum ao_igniter_status {
747 ao_igniter_unknown, /* unknown status (ambiguous voltage) */
748 ao_igniter_ready, /* continuity detected */
749 ao_igniter_active, /* igniter firing */
750 ao_igniter_open, /* open circuit detected */
759 extern __code char * __code ao_igniter_status_names[];
761 extern __xdata struct ao_ignition ao_ignition[2];
763 enum ao_igniter_status
764 ao_igniter_status(enum ao_igniter igniter);
766 extern __pdata uint8_t ao_igniter_present;
769 ao_ignite_set_pins(void);
772 ao_igniter_init(void);
777 #include <ao_config.h>
785 * Set this to force the frequency to 434.550MHz
787 extern __xdata uint8_t ao_force_freq;
796 ao_rssi_set(int16_t rssi_value);
799 ao_rssi_init(AO_LED_TYPE rssi_led);
805 * values which need to be defined for
806 * each instance of a product
809 extern const char ao_version[];
810 extern const char ao_manufacturer[];
811 extern const char ao_product[];
817 #define AO_FIFO_SIZE 32
822 char fifo[AO_FIFO_SIZE];
825 #define ao_fifo_insert(f,c) do { \
826 (f).fifo[(f).insert] = (c); \
827 (f).insert = ((f).insert + 1) & (AO_FIFO_SIZE-1); \
830 #define ao_fifo_remove(f,c) do {\
831 c = (f).fifo[(f).remove]; \
832 (f).remove = ((f).remove + 1) & (AO_FIFO_SIZE-1); \
835 #define ao_fifo_full(f) ((((f).insert + 1) & (AO_FIFO_SIZE-1)) == (f).remove)
836 #define ao_fifo_mostly(f) ((((f).insert - (f).remove) & (AO_FIFO_SIZE-1)) >= (AO_FIFO_SIZE * 3 / 4))
837 #define ao_fifo_barely(f) ((((f).insert - (f).remove) & (AO_FIFO_SIZE-1)) >= (AO_FIFO_SIZE * 1 / 4))
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>
864 #define AO_LOG_TELESCIENCE_START ((uint8_t) 's')
865 #define AO_LOG_TELESCIENCE_DATA ((uint8_t) 'd')
867 #define AO_LOG_TELESCIENCE_NUM_ADC 12
869 struct ao_log_telescience {
876 uint16_t adc[AO_LOG_TELESCIENCE_NUM_ADC];
879 #define AO_LOG_SINGLE_SIZE 32
881 union ao_log_single {
882 struct ao_log_telescience telescience;
883 union ao_telemetry_all telemetry;
884 uint8_t bytes[AO_LOG_SINGLE_SIZE];
887 extern __xdata union ao_log_single ao_log_single_write_data;
888 extern __xdata union ao_log_single ao_log_single_read_data;
891 ao_log_single_extra_query(void);
894 ao_log_single_list(void);
897 ao_log_single_main(void);
900 ao_log_single_write(void);
903 ao_log_single_read(uint32_t pos);
906 ao_log_single_start(void);
909 ao_log_single_stop(void);
912 ao_log_single_restart(void);
915 ao_log_single_set(void);
918 ao_log_single_delete(void);
921 ao_log_single_init(void);
930 #define AO_TELEPYRO_NUM_ADC 9
933 #define ao_xmemcpy(d,s,c) memcpy(d,s,c)
934 #define ao_xmemset(d,v,c) memset(d,v,c)
935 #define ao_xmemcmp(d,s,c) memcmp(d,s,c)
943 ao_terraui_init(void);
951 ao_battery_isr(void) ao_arch_interrupt(1);
954 ao_battery_get(void);
957 ao_battery_init(void);
958 #endif /* BATTERY_PIN */
965 ao_sqrt(uint32_t op);
971 int32_t ao_freq_to_set(int32_t freq, int32_t cal) __reentrant;
977 void ao_ms5607_init(void);
979 #include <ao_arch_funcs.h>