altos: mark gps date written only after it gets into eeprom
[fw/altos] / src / ao.h
index c4cb5bf7176d526b2ea4a4bbe887684778070a59..8db22799f24df6fca7ec59fb30cc54416572d504 100644 (file)
--- a/src/ao.h
+++ b/src/ao.h
@@ -21,7 +21,9 @@
 #include <stdint.h>
 #include <stdio.h>
 #include <string.h>
+#include <stddef.h>
 #include "cc1111.h"
+#include "ao_pins.h"
 
 #define TRUE 1
 #define FALSE 0
@@ -39,8 +41,9 @@
 /* An AltOS task */
 struct ao_task {
        __xdata void *wchan;            /* current wait channel (NULL if running) */
+       uint16_t alarm;                 /* abort ao_sleep time */
        uint8_t stack_count;            /* amount of saved stack */
-       uint8_t task_id;                /* index in the task array */
+       uint8_t task_id;                /* unique id */
        __code char *name;              /* task name */
        uint8_t stack[AO_STACK_SIZE];   /* saved stack */
 };
@@ -54,14 +57,26 @@ extern __xdata struct ao_task *__data ao_cur_task;
  ao_task.c
  */
 
-/* Suspend the current task until wchan is awoken */
-void
+/* Suspend the current task until wchan is awoken.
+ * returns:
+ *  0 on normal wake
+ *  1 on alarm
+ */
+uint8_t
 ao_sleep(__xdata void *wchan);
 
 /* Wake all tasks sleeping on wchan */
 void
 ao_wakeup(__xdata void *wchan);
 
+/* Wake up a specific task */
+void
+ao_wake_task(__xdata struct ao_task *task);
+
+/* set an alarm to go off in 'delay' ticks */
+void
+ao_alarm(uint16_t delay);
+
 /* Yield the processor to another task */
 void
 ao_yield(void) _naked;
@@ -70,6 +85,10 @@ ao_yield(void) _naked;
 void
 ao_add_task(__xdata struct ao_task * task, void (*start)(void), __code char *name) __reentrant;
 
+/* Terminate the current task */
+void
+ao_exit(void);
+
 /* Dump task info to console */
 void
 ao_task_info(void);
@@ -88,6 +107,10 @@ ao_start_scheduler(void);
 #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 */
+#define AO_PANIC_STDIO         7       /* Too many stdio handlers registered */
+#define AO_PANIC_REBOOT                8       /* Reboot failed */
+#define AO_PANIC_FLASH         9       /* Invalid flash part (or wrong blocksize) */
+#define AO_PANIC_USB           10      /* Trying to send USB packet while busy */
 
 /* Stop the operating system, beeping and blinking the reason */
 void
@@ -98,8 +121,9 @@ ao_panic(uint8_t reason);
  */
 
 /* Our timer runs at 100Hz */
-#define AO_MS_TO_TICKS(ms)     ((ms) / 10)
-#define AO_SEC_TO_TICKS(s)     ((s) * 100)
+#define AO_HERTZ               100
+#define AO_MS_TO_TICKS(ms)     ((ms) / (1000 / AO_HERTZ))
+#define AO_SEC_TO_TICKS(s)     ((s) * AO_HERTZ)
 
 /* Returns the current time in ticks */
 uint16_t
@@ -121,16 +145,12 @@ ao_timer_isr(void) interrupt 9;
 void
 ao_timer_init(void);
 
-/*
- * ao_adc.c
- */
-
-#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))
+/* Initialize the hardware clock. Must be called first */
+void
+ao_clock_init(void);
 
 /*
- * One set of samples read from the A/D converter
+ * One set of samples read from the A/D converter or telemetry
  */
 struct ao_adc {
        uint16_t        tick;           /* tick when the sample was read */
@@ -142,6 +162,20 @@ struct ao_adc {
        int16_t         sense_m;        /* main continuity sense */
 };
 
+#ifndef HAS_ADC
+#error Please define HAS_ADC
+#endif
+
+#if HAS_ADC
+/*
+ * ao_adc.c
+ */
+
+#define AO_ADC_RING    32
+#define ao_adc_ring_next(n)    (((n) + 1) & (AO_ADC_RING - 1))
+#define ao_adc_ring_prev(n)    (((n) - 1) & (AO_ADC_RING - 1))
+
+
 /*
  * A/D data is stored in a ring, with the next sample to be written
  * at ao_adc_head
@@ -162,15 +196,16 @@ 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
 ao_adc_init(void);
 
+#endif /* HAS_ADC */
+
 /*
  * ao_beep.c
  */
@@ -229,8 +264,6 @@ ao_beep_init(void);
  */
 
 #define AO_LED_NONE    0
-#define AO_LED_GREEN   1
-#define AO_LED_RED     2
 
 /* Turn on the specified LEDs */
 void
@@ -256,6 +289,18 @@ ao_led_for(uint8_t colors, uint16_t ticks) __reentrant;
 void
 ao_led_init(uint8_t enable);
 
+/*
+ * ao_romconfig.c
+ */
+
+#define AO_ROMCONFIG_VERSION   2
+
+extern __code __at (0x00a0) uint16_t ao_romconfig_version;
+extern __code __at (0x00a2) uint16_t ao_romconfig_check;
+extern __code __at (0x00a4) uint16_t ao_serial_number;
+extern __code __at (0x00a6) uint32_t ao_radio_cal;
+extern __code __at (0x00aa) uint8_t ao_usb_descriptors [];
+
 /*
  * ao_usb.c
  */
@@ -268,6 +313,12 @@ ao_usb_putchar(char c);
 char
 ao_usb_getchar(void);
 
+/* Poll for a charcter on the USB input queue.
+ * returns AO_READ_AGAIN if none are available
+ */
+char
+ao_usb_pollchar(void);
+
 /* Flush the USB output queue */
 void
 ao_usb_flush(void);
@@ -299,6 +350,7 @@ enum ao_cmd_status {
 };
 
 extern __xdata uint16_t ao_cmd_lex_i;
+extern __xdata uint32_t ao_cmd_lex_u32;
 extern __xdata char    ao_cmd_lex_c;
 extern __xdata enum ao_cmd_status ao_cmd_status;
 
@@ -320,6 +372,9 @@ ao_cmd_hex(void);
 void
 ao_cmd_decimal(void);
 
+uint8_t
+ao_match_word(__code char *word);
+
 struct ao_cmds {
        char            cmd;
        void            (*func)(void);
@@ -336,9 +391,14 @@ ao_cmd_init(void);
  * ao_dma.c
  */
 
-/* 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
+/* Allocate a DMA channel. the 'done' parameter will be set
+ * when the dma is finished or aborted and will be used to
+ * wakeup any waiters
  */
+
+#define AO_DMA_DONE    1
+#define AO_DMA_ABORTED 2
+
 uint8_t
 ao_dma_alloc(__xdata uint8_t * done);
 
@@ -419,14 +479,6 @@ 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.
@@ -461,6 +513,8 @@ struct ao_gps_pos {
 #define AO_LOG_GPS_LAT         'N'
 #define AO_LOG_GPS_LON         'W'
 #define AO_LOG_GPS_ALT         'H'
+#define AO_LOG_GPS_SAT         'V'
+#define AO_LOG_GPS_DATE                'Y'
 
 #define AO_LOG_POS_NONE                (~0UL)
 
@@ -495,12 +549,23 @@ struct ao_log_record {
                        uint8_t         second;
                        uint8_t         flags;
                } gps_time;
-               struct ao_gps_pos gps_latitude;
-               struct ao_gps_pos gps_longitude;
+               int32_t         gps_latitude;
+               int32_t         gps_longitude;
                struct {
                        int16_t         altitude;
                        uint16_t        unused;
                } gps_altitude;
+               struct {
+                       uint16_t        svid;
+                       uint8_t         unused;
+                       uint8_t         c_n;
+               } gps_sat;
+               struct {
+                       uint8_t         year;
+                       uint8_t         month;
+                       uint8_t         day;
+                       uint8_t         extra;
+               } gps_date;
                struct {
                        uint16_t        d0;
                        uint16_t        d1;
@@ -509,18 +574,18 @@ struct ao_log_record {
 };
 
 /* Write a record to the eeprom log */
-void
-ao_log_data(struct ao_log_record *log);
+uint8_t
+ao_log_data(__xdata struct ao_log_record *log) __reentrant;
 
 /* Flush the log */
 void
 ao_log_flush(void);
 
-/* Log dumping API:
- * ao_log_dump_first() - get first log record
- * ao_log_dump_next()  - get next log record
+/* We record flight numbers in the first record of
+ * the log. Tasks may wait for this to be initialized
+ * by sleeping on this variable.
  */
-extern __xdata struct ao_log_record ao_log_dump;
+extern __xdata uint16_t ao_flight_number;
 
 /* Retrieve first log record for the current flight */
 uint8_t
@@ -553,10 +618,10 @@ ao_log_init(void);
 enum ao_flight_state {
        ao_flight_startup = 0,
        ao_flight_idle = 1,
-       ao_flight_launchpad = 2,
+       ao_flight_pad = 2,
        ao_flight_boost = 3,
-       ao_flight_coast = 4,
-       ao_flight_apogee = 5,
+       ao_flight_fast = 4,
+       ao_flight_coast = 5,
        ao_flight_drogue = 6,
        ao_flight_main = 7,
        ao_flight_landed = 8,
@@ -573,6 +638,7 @@ 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;
+extern __xdata uint8_t                 ao_flight_force_idle;
 
 /* Flight thread */
 void
@@ -650,13 +716,16 @@ ao_dbg_init(void);
  * ao_serial.c
  */
 
-#if !AO_NO_SERIAL_ISR
+#ifndef HAS_SERIAL_1
+#error Please define HAS_SERIAL_1
+#endif
+
+#if HAS_SERIAL_1
 void
 ao_serial_rx1_isr(void) interrupt 3;
 
 void
 ao_serial_tx1_isr(void) interrupt 14;
-#endif
 
 char
 ao_serial_getchar(void) __critical;
@@ -664,8 +733,16 @@ ao_serial_getchar(void) __critical;
 void
 ao_serial_putchar(char c) __critical;
 
+#define AO_SERIAL_SPEED_4800   0
+#define AO_SERIAL_SPEED_9600   1
+#define AO_SERIAL_SPEED_57600  2
+
+void
+ao_serial_set_speed(uint8_t speed);
+
 void
 ao_serial_init(void);
+#endif
 
 /*
  * ao_gps.c
@@ -675,26 +752,43 @@ ao_serial_init(void);
 #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_RUNNING         (1 << 5)
+#define AO_GPS_DATE_VALID      (1 << 6)
 
-#define AO_GPS_LATITUDE_MASK   (1 << 6)
-#define AO_GPS_LATITUDE_NORTH  (0 << 6)
-#define AO_GPS_LATITUDE_SOUTH  (1 << 6)
+extern __xdata uint16_t ao_gps_tick;
 
 struct ao_gps_data {
+       uint8_t                 year;
+       uint8_t                 month;
+       uint8_t                 day;
        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;
+       int32_t                 latitude;       /* degrees * 10⁷ */
+       int32_t                 longitude;      /* degrees * 10⁷ */
+       int16_t                 altitude;       /* m */
+       uint16_t                ground_speed;   /* cm/s */
+       uint8_t                 course;         /* degrees / 2 */
+       uint8_t                 hdop;           /* * 5 */
+       int16_t                 climb_rate;     /* cm/s */
+       uint16_t                h_error;        /* m */
+       uint16_t                v_error;        /* m */
+};
+
+struct ao_gps_sat_data {
+       uint8_t         svid;
+       uint8_t         c_n_1;
+};
+
+struct ao_gps_tracking_data {
+       uint8_t                 channels;
+       struct ao_gps_sat_data  sats[12];
 };
 
 extern __xdata uint8_t ao_gps_mutex;
 extern __xdata struct ao_gps_data ao_gps_data;
+extern __xdata struct ao_gps_tracking_data ao_gps_tracking_data;
 
 void
 ao_gps(void);
@@ -702,6 +796,9 @@ ao_gps(void);
 void
 ao_gps_print(__xdata struct ao_gps_data *gps_data);
 
+void
+ao_gps_tracking_print(__xdata struct ao_gps_tracking_data *gps_tracking_data);
+
 void
 ao_gps_init(void);
 
@@ -720,18 +817,23 @@ ao_gps_report_init(void);
  */
 
 #define AO_MAX_CALLSIGN                8
+#define AO_TELEMETRY_VERSION   3
 
 struct ao_telemetry {
        uint8_t                 addr;
+       uint16_t                flight;
        uint8_t                 flight_state;
        int16_t                 flight_accel;
        int16_t                 ground_accel;
        int32_t                 flight_vel;
        int16_t                 flight_pres;
        int16_t                 ground_pres;
+       int16_t                 accel_plus_g;
+       int16_t                 accel_minus_g;
        struct ao_adc           adc;
        struct ao_gps_data      gps;
        char                    callsign[AO_MAX_CALLSIGN];
+       struct ao_gps_tracking_data     gps_tracking;
 };
 
 /* Set delay between telemetry reports (0 to disable) */
@@ -743,6 +845,9 @@ struct ao_telemetry {
 void
 ao_telemetry_set_interval(uint16_t interval);
 
+void
+ao_rdf_set(uint8_t rdf);
+
 void
 ao_telemetry_init(void);
 
@@ -750,6 +855,28 @@ ao_telemetry_init(void);
  * ao_radio.c
  */
 
+extern __xdata uint8_t ao_radio_dma;
+extern __xdata uint8_t ao_radio_dma_done;
+extern __xdata uint8_t ao_radio_done;
+extern __xdata uint8_t ao_radio_mutex;
+
+void
+ao_radio_general_isr(void) interrupt 16;
+
+void
+ao_radio_get(void);
+
+#define ao_radio_put() ao_mutex_put(&ao_radio_mutex)
+
+void
+ao_radio_set_telemetry(void);
+
+void
+ao_radio_set_packet(void);
+
+void
+ao_radio_set_rdf(void);
+
 void
 ao_radio_send(__xdata struct ao_telemetry *telemetry) __reentrant;
 
@@ -759,9 +886,21 @@ struct ao_radio_recv {
        uint8_t                 status;
 };
 
-void
+uint8_t
 ao_radio_recv(__xdata struct ao_radio_recv *recv) __reentrant;
 
+void
+ao_radio_rdf(int ms);
+
+void
+ao_radio_abort(void);
+
+void
+ao_radio_rdf_abort(void);
+
+void
+ao_radio_idle(void);
+
 void
 ao_radio_init(void);
 
@@ -784,9 +923,24 @@ ao_monitor_init(uint8_t led, uint8_t monitoring) __reentrant;
  * ao_stdio.c
  */
 
+#define AO_READ_AGAIN  ((char) -1)
+
+struct ao_stdio {
+       char    (*pollchar)(void);
+       void    (*putchar)(char c) __reentrant;
+       void    (*flush)(void);
+};
+
 void
 flush(void);
 
+extern __xdata uint8_t ao_stdin_ready;
+
+void
+ao_add_stdio(char (*pollchar)(void),
+            void (*putchar)(char) __reentrant,
+            void (*flush)(void));
+
 /*
  * ao_ignite.c
  */
@@ -817,15 +971,18 @@ ao_igniter_init(void);
  */
 
 #define AO_CONFIG_MAJOR        1
-#define AO_CONFIG_MINOR        0
+#define AO_CONFIG_MINOR        3
 
 struct ao_config {
        uint8_t         major;
        uint8_t         minor;
        uint16_t        main_deploy;
-       int16_t         accel_zero_g;
+       int16_t         accel_plus_g;           /* changed for minor version 2 */
        uint8_t         radio_channel;
        char            callsign[AO_MAX_CALLSIGN + 1];
+       uint8_t         apogee_delay;           /* minor version 1 */
+       int16_t         accel_minus_g;          /* minor version 2 */
+       uint32_t        radio_cal;              /* minor version 3 */
 };
 
 extern __xdata struct ao_config ao_config;
@@ -853,8 +1010,7 @@ ao_rssi_init(uint8_t rssi_led);
  * each instance of a product
  */
 
-extern const uint8_t ao_usb_descriptors [];
-extern const uint16_t ao_serial_number;
+extern __code __at(0x00aa) uint8_t ao_usb_descriptors [];
 extern const char ao_version[];
 extern const char ao_manufacturer[];
 extern const char ao_product[];
@@ -890,37 +1046,60 @@ struct ao_fifo {
  * Packet-based command interface
  */
 
-#define AO_PACKET_MAX  32
-#define AO_PACKET_WIN  256
-
-#define AO_PACKET_FIN  (1 << 0)
-#define AO_PACKET_SYN  (1 << 1)
-#define AO_PACKET_RST  (1 << 2)
-#define AO_PACKET_ACK  (1 << 3)
+#define AO_PACKET_MAX          64
+#define AO_PACKET_SYN          (uint8_t) 0xff
 
 struct ao_packet {
        uint8_t         addr;
-       uint8_t         flags;
-       uint16_t        seq;
-       uint16_t        ack;
-       uint16_t        window;
        uint8_t         len;
+       uint8_t         seq;
+       uint8_t         ack;
        uint8_t         d[AO_PACKET_MAX];
+       uint8_t         callsign[AO_MAX_CALLSIGN];
 };
 
-uint8_t
-ao_packet_connect(uint8_t dest);
+struct ao_packet_recv {
+       struct ao_packet        packet;
+       int8_t                  rssi;
+       uint8_t                 status;
+};
+
+extern __xdata struct ao_packet_recv ao_rx_packet;
+extern __xdata struct ao_packet ao_tx_packet;
+extern __xdata struct ao_task  ao_packet_task;
+extern __xdata uint8_t ao_packet_enable;
+extern __xdata uint8_t ao_packet_master_sleeping;
+extern __pdata uint8_t ao_packet_rx_len, ao_packet_rx_used, ao_packet_tx_used;
+
+void
+ao_packet_send(void);
 
 uint8_t
-ao_packet_accept(void);
+ao_packet_recv(void);
+
+void
+ao_packet_flush(void);
+
+void
+ao_packet_putchar(char c) __reentrant;
+
+char
+ao_packet_pollchar(void) __critical;
 
-int
-ao_packet_send(uint8_t *data, int len);
+/* ao_packet_master.c */
 
-int
-ao_packet_recv(uint8_t *data, int len);
+void
+ao_packet_master_init(void);
+
+/* ao_packet_slave.c */
+
+void
+ao_packet_slave_start(void);
+
+void
+ao_packet_slave_stop(void);
 
 void
-ao_packet_init(void);
+ao_packet_slave_init(void);
 
 #endif /* _AO_H_ */