Decrease telemetry rate on the pad to 1/sec instead of 20/sec
[fw/altos] / ao.h
diff --git a/ao.h b/ao.h
index 20c2458cd87fc72766117784c25967120d3f409f..fb06df06aeef473fbce7374be20490d92067a1b3 100644 (file)
--- a/ao.h
+++ b/ao.h
@@ -29,7 +29,7 @@
 /* Stack runs from above the allocated __data space to 0xfe, which avoids
  * writing to 0xff as that triggers the stack overflow indicator
  */
-#define AO_STACK_START 0x62
+#define AO_STACK_START 0x80
 #define AO_STACK_END   0xfe
 #define AO_STACK_SIZE  (AO_STACK_END - AO_STACK_START + 1)
 
@@ -52,11 +52,11 @@ extern __xdata struct ao_task *__data ao_cur_task;
  */
 
 /* Suspend the current task until wchan is awoken */
-int
+void
 ao_sleep(__xdata void *wchan);
 
 /* Wake all tasks sleeping on wchan */
-int
+void
 ao_wakeup(__xdata void *wchan);
 
 /* Yield the processor to another task */
@@ -65,7 +65,7 @@ ao_yield(void) _naked;
 
 /* Add a task to the run queue */
 void
-ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name);
+ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
 
 /* Dump task info to console */
 void
@@ -84,6 +84,7 @@ ao_start_scheduler(void);
 #define AO_PANIC_MUTEX         3       /* Mis-using mutex API */
 #define AO_PANIC_EE            4       /* Mis-using eeprom API */
 #define AO_PANIC_LOG           5       /* Failing to read/write log data */
+#define AO_PANIC_CMD           6       /* Too many command sets registered */
 
 /* Stop the operating system, beeping and blinking the reason */
 void
@@ -105,6 +106,10 @@ ao_time(void);
 void
 ao_delay(uint16_t ticks);
 
+/* Set the ADC interval */
+void
+ao_timer_set_adc_interval(uint8_t interval) __critical;
+
 /* Timer interrupt */
 void
 ao_timer_isr(void) interrupt 9;
@@ -117,7 +122,9 @@ ao_timer_init(void);
  * ao_adc.c
  */
 
-#define AO_ADC_RING    128
+#define AO_ADC_RING    64
+#define ao_adc_ring_next(n)    (((n) + 1) & (AO_ADC_RING - 1))
+#define ao_adc_ring_prev(n)    (((n) - 1) & (AO_ADC_RING - 1))
 
 /*
  * One set of samples read from the A/D converter
@@ -142,7 +149,7 @@ extern volatile __data uint8_t              ao_adc_head;
 /* Trigger a conversion sequence (called from the timer interrupt) */
 void
 ao_adc_poll(void);
+
 /* Suspend the current task until another A/D sample is converted */
 void
 ao_adc_sleep(void);
@@ -152,8 +159,10 @@ void
 ao_adc_get(__xdata struct ao_adc *packet);
 
 /* The A/D interrupt handler */
+#if !AO_NO_ADC_ISR
 void
 ao_adc_isr(void) interrupt 1;
+#endif
 
 /* Initialize the A/D converter */
 void
@@ -206,7 +215,7 @@ ao_beep(uint8_t beep);
 
 /* Turn on the beeper for the specified time */
 void
-ao_beep_for(uint8_t beep, uint16_t ticks);
+ao_beep_for(uint8_t beep, uint16_t ticks) __reentrant;
 
 /* Initialize the beeper */
 void
@@ -232,13 +241,17 @@ ao_led_off(uint8_t colors);
 void
 ao_led_set(uint8_t colors);
 
+/* Toggle the specified LEDs */
+void
+ao_led_toggle(uint8_t colors);
+
 /* Turn on the specified LEDs for the indicated interval */
 void
-ao_led_for(uint8_t colors, uint16_t ticks);
+ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
 
 /* Initialize the LEDs */
 void
-ao_led_init(void);
+ao_led_init(uint8_t enable);
 
 /*
  * ao_usb.c
@@ -246,10 +259,10 @@ ao_led_init(void);
 
 /* Put one character to the USB output queue */
 void
-ao_usb_putchar(uint8_t c);
+ao_usb_putchar(char c);
 
 /* Get one character from the USB input queue */
-uint8_t
+char
 ao_usb_getchar(void);
 
 /* Flush the USB output queue */
@@ -260,6 +273,14 @@ ao_usb_flush(void);
 void
 ao_usb_isr(void) interrupt 6;
 
+/* Enable the USB controller */
+void
+ao_usb_enable(void);
+
+/* Disable the USB controller */
+void
+ao_usb_disable(void);
+
 /* Initialize the USB system */
 void
 ao_usb_init(void);
@@ -267,6 +288,44 @@ ao_usb_init(void);
 /*
  * ao_cmd.c
  */
+
+enum ao_cmd_status {
+       ao_cmd_success = 0,
+       ao_cmd_lex_error = 1,
+       ao_cmd_syntax_error = 2,
+};
+
+extern __xdata uint16_t ao_cmd_lex_i;
+extern __xdata char    ao_cmd_lex_c;
+extern __xdata enum ao_cmd_status ao_cmd_status;
+
+void
+ao_cmd_lex(void);
+
+void
+ao_cmd_put8(uint8_t v);
+
+void
+ao_cmd_put16(uint16_t v);
+
+void
+ao_cmd_white(void);
+
+void
+ao_cmd_hex(void);
+
+void
+ao_cmd_decimal(void);
+
+struct ao_cmds {
+       char            cmd;
+       void            (*func)(void);
+       const char      *help;
+};
+
+void
+ao_cmd_register(__code struct ao_cmds *cmds);
+
 void
 ao_cmd_init(void);
 
@@ -275,7 +334,7 @@ ao_cmd_init(void);
  */
 
 /* Allocate a DMA channel. the 'done' parameter will be set to 1
- * when the dma is finished and will be used to wakeup any waiters 
+ * when the dma is finished and will be used to wakeup any waiters
  */
 uint8_t
 ao_dma_alloc(__xdata uint8_t * done);
@@ -357,6 +416,14 @@ ao_ee_init(void);
  * ao_log.c
  */
 
+/* Structure containing GPS position, either lat or lon */
+
+struct ao_gps_pos {
+       uint8_t degrees;
+       uint8_t minutes;
+       uint16_t minutes_fraction;      /* in units of 1/10000 minutes */
+};
+
 /*
  * The data log is recorded in the eeprom as a sequence
  * of data packets.
@@ -365,7 +432,7 @@ ao_ee_init(void);
  * packet type, the packet checksum and the tick count. Then
  * they all contain 2 16 bit values which hold packet-specific
  * data.
- * 
+ *
  * For each flight, the first packet
  * is FLIGHT packet, indicating the serial number of the
  * device and a unique number marking the number of flights
@@ -387,16 +454,20 @@ ao_ee_init(void);
 #define AO_LOG_TEMP_VOLT       'T'
 #define AO_LOG_DEPLOY          'D'
 #define AO_LOG_STATE           'S'
+#define AO_LOG_GPS_TIME                'G'
+#define AO_LOG_GPS_LAT         'N'
+#define AO_LOG_GPS_LON         'W'
+#define AO_LOG_GPS_ALT         'H'
 
 #define AO_LOG_POS_NONE                (~0UL)
 
 struct ao_log_record {
-       uint8_t                 type;
+       char                    type;
        uint8_t                 csum;
        uint16_t                tick;
        union {
                struct {
-                       uint16_t        serial;
+                       int16_t         ground_accel;
                        uint16_t        flight;
                } flight;
                struct {
@@ -415,6 +486,18 @@ struct ao_log_record {
                        uint16_t        state;
                        uint16_t        reason;
                } state;
+               struct {
+                       uint8_t         hour;
+                       uint8_t         minute;
+                       uint8_t         second;
+                       uint8_t         flags;
+               } gps_time;
+               struct ao_gps_pos gps_latitude;
+               struct ao_gps_pos gps_longitude;
+               struct {
+                       int16_t         altitude;
+                       uint16_t        unused;
+               } gps_altitude;
                struct {
                        uint16_t        d0;
                        uint16_t        d1;
@@ -465,27 +548,27 @@ ao_log_init(void);
  */
 
 enum ao_flight_state {
-       ao_flight_startup,
-       ao_flight_idle,
-       ao_flight_launchpad,
-       ao_flight_boost,
-       ao_flight_coast,
-       ao_flight_apogee,
-       ao_flight_drogue,
-       ao_flight_main,
-       ao_flight_landed,
-       ao_flight_invalid
+       ao_flight_startup = 0,
+       ao_flight_idle = 1,
+       ao_flight_launchpad = 2,
+       ao_flight_boost = 3,
+       ao_flight_coast = 4,
+       ao_flight_apogee = 5,
+       ao_flight_drogue = 6,
+       ao_flight_main = 7,
+       ao_flight_landed = 8,
+       ao_flight_invalid = 9
 };
 
-extern __xdata struct ao_adc   ao_flight_data;
-extern __data enum flight_state        ao_flight_state;
-extern __data uint16_t                 ao_flight_tick;
-extern __data int16_t                  ao_flight_accel;
-extern __data int16_t                  ao_flight_pres;
-extern __data int16_t                  ao_ground_pres;
-extern __data int16_t                  ao_ground_accel;
-extern __data int16_t                  ao_min_pres;
-extern __data uint16_t                 ao_launch_time;
+extern __xdata struct ao_adc           ao_flight_data;
+extern __pdata enum ao_flight_state    ao_flight_state;
+extern __pdata uint16_t                        ao_flight_tick;
+extern __pdata int16_t                 ao_flight_accel;
+extern __pdata int16_t                 ao_flight_pres;
+extern __pdata int16_t                 ao_ground_pres;
+extern __pdata int16_t                 ao_ground_accel;
+extern __pdata int16_t                 ao_min_pres;
+extern __pdata uint16_t                        ao_launch_time;
 
 /* Flight thread */
 void
@@ -499,9 +582,6 @@ ao_flight_init(void);
  * ao_report.c
  */
 
-void
-ao_report_notify(void);
-
 void
 ao_report_init(void);
 
@@ -516,13 +596,10 @@ int16_t
 ao_pres_to_altitude(int16_t pres) __reentrant;
 
 int16_t
-ao_temp_to_dC(int16_t temp) __reentrant;
+ao_altitude_to_pres(int16_t alt) __reentrant;
 
 int16_t
-ao_accel_to_dm_per_s2(int16_t accel)
-{
-       return (998 - (accel >> 4)) * 3300 / 2047;
-}
+ao_temp_to_dC(int16_t temp) __reentrant;
 
 /*
  * ao_dbg.c
@@ -562,21 +639,26 @@ ao_dbg_debug_mode(void);
 void
 ao_dbg_reset(void);
 
+void
+ao_dbg_init(void);
+
 /*
  * ao_serial.c
  */
 
+#if !AO_NO_SERIAL_ISR
 void
 ao_serial_rx1_isr(void) interrupt 3;
 
 void
 ao_serial_tx1_isr(void) interrupt 14;
+#endif
 
-uint8_t
+char
 ao_serial_getchar(void) __critical;
 
 void
-ao_serial_putchar(uint8_t c) __critical;
+ao_serial_putchar(char c) __critical;
 
 void
 ao_serial_init(void);
@@ -585,12 +667,183 @@ ao_serial_init(void);
  * ao_gps.c
  */
 
+#define AO_GPS_NUM_SAT_MASK    (0xf << 0)
+#define AO_GPS_NUM_SAT_SHIFT   (0)
+
+#define AO_GPS_VALID           (1 << 4)
+#define AO_GPS_LONGITUDE_MASK  (1 << 5)
+#define AO_GPS_LONGITUDE_EAST  (0 << 5)
+#define AO_GPS_LONGITUDE_WEST  (1 << 5)
+
+#define AO_GPS_LATITUDE_MASK   (1 << 6)
+#define AO_GPS_LATITUDE_NORTH  (0 << 6)
+#define AO_GPS_LATITUDE_SOUTH  (1 << 6)
+
+struct ao_gps_data {
+       uint8_t                 hour;
+       uint8_t                 minute;
+       uint8_t                 second;
+       uint8_t                 flags;
+       struct ao_gps_pos       latitude;
+       struct ao_gps_pos       longitude;
+       int16_t                 altitude;
+};
+
+extern __xdata uint8_t ao_gps_mutex;
+extern __xdata struct ao_gps_data ao_gps_data;
+
 void
 ao_gps(void);
 
+void
+ao_gps_print(__xdata struct ao_gps_data *gps_data);
+
 void
 ao_gps_init(void);
 
+/*
+ * ao_gps_report.c
+ */
+
+void
+ao_gps_report(void);
 
-#endif /* _AO_H_ */
+void
+ao_gps_report_init(void);
+
+/*
+ * ao_telemetry.c
+ */
+
+#define AO_MAX_CALLSIGN                8
+
+struct ao_telemetry {
+       uint8_t                 addr;
+       uint8_t                 flight_state;
+       struct ao_adc           adc;
+       struct ao_gps_data      gps;
+       char                    callsign[AO_MAX_CALLSIGN];
+};
+
+/* Set delay between telemetry reports (0 to disable) */
+
+#define AO_TELEMETRY_INTERVAL_PAD      AO_MS_TO_TICKS(1000)
+#define AO_TELEMETRY_INTERVAL_FLIGHT   AO_MS_TO_TICKS(50)
+#define AO_TELEMETRY_INTERVAL_RECOVER  AO_MS_TO_TICKS(1000)
 
+void
+ao_telemetry_set_interval(uint16_t interval);
+
+void
+ao_rdf_set(uint8_t rdf);
+
+void
+ao_telemetry_init(void);
+
+/*
+ * ao_radio.c
+ */
+
+void
+ao_radio_send(__xdata struct ao_telemetry *telemetry) __reentrant;
+
+struct ao_radio_recv {
+       struct ao_telemetry     telemetry;
+       int8_t                  rssi;
+       uint8_t                 status;
+};
+
+void
+ao_radio_recv(__xdata struct ao_radio_recv *recv) __reentrant;
+
+void
+ao_radio_rdf(void);
+
+void
+ao_radio_rdf_abort(void);
+
+void
+ao_radio_init(void);
+
+/*
+ * ao_monitor.c
+ */
+
+extern const char const * const ao_state_names[];
+
+void
+ao_monitor(void);
+
+void
+ao_monitor_init(uint8_t led);
+
+/*
+ * ao_stdio.c
+ */
+
+void
+flush(void);
+
+/*
+ * ao_ignite.c
+ */
+
+enum ao_igniter {
+       ao_igniter_drogue = 0,
+       ao_igniter_main = 1
+};
+
+void
+ao_ignite(enum ao_igniter igniter);
+
+enum ao_igniter_status {
+       ao_igniter_unknown,     /* unknown status (ambiguous voltage) */
+       ao_igniter_ready,       /* continuity detected */
+       ao_igniter_active,      /* igniter firing */
+       ao_igniter_open,        /* open circuit detected */
+};
+
+enum ao_igniter_status
+ao_igniter_status(enum ao_igniter igniter);
+
+void
+ao_igniter_init(void);
+
+/*
+ * ao_config.c
+ */
+
+#define AO_CONFIG_MAJOR        1
+#define AO_CONFIG_MINOR        0
+
+struct ao_config {
+       uint8_t         major;
+       uint8_t         minor;
+       uint16_t        main_deploy;
+       int16_t         accel_zero_g;
+       uint8_t         radio_channel;
+       char            callsign[AO_MAX_CALLSIGN + 1];
+};
+
+extern __xdata struct ao_config ao_config;
+
+void
+ao_config_get(void);
+
+void
+ao_config_init(void);
+
+/*
+ * ao_product.c
+ *
+ * values which need to be defined for
+ * each instance of a product
+ */
+
+extern const uint8_t ao_usb_descriptors [];
+extern const uint16_t ao_serial_number;
+extern const char ao_version[];
+extern const char ao_manufacturer[];
+extern const char ao_product[];
+
+#endif /* _AO_H_ */