altos: Check for full log and complain

[fw/altos] / src / ao.h

diff --git a/src/ao.h b/src/ao.h
index 69f4665bca14d84dfcf8acb5863322fe02586512..37a39a790b643b7061a1614fa3e6f128d90b4a5d 100644 (file)
--- a/src/ao.h
+++ b/src/ao.h
@@ -430,42 +430,67 @@ void
 ao_mutex_put(__xdata uint8_t *ao_mutex) __reentrant;
 
 /*
- * ao_ee.c
+ * Storage interface, provided by one of the eeprom or flash
+ * drivers
  */
 
-/*
- * We reserve the last block on the device for
- * configuration space. Writes and reads in this
- * area return errors.
- */
+/* Total bytes of available storage */
+extern __xdata uint32_t        ao_storage_total;
+
+/* Block size - device is erased in these units. At least 256 bytes */
+extern __xdata uint32_t        ao_storage_block;
+
+/* Byte offset of config block. Will be ao_storage_block bytes long */
+extern __xdata uint32_t        ao_storage_config;
 
-#define AO_EE_BLOCK_SIZE       ((uint16_t) (256))
-#define AO_EE_DEVICE_SIZE      ((uint32_t) 128 * (uint32_t) 1024)
-#define AO_EE_DATA_SIZE                (AO_EE_DEVICE_SIZE - (uint32_t) AO_EE_BLOCK_SIZE)
-#define AO_EE_CONFIG_BLOCK     ((uint16_t) (AO_EE_DATA_SIZE / AO_EE_BLOCK_SIZE))
+/* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
+extern __xdata uint16_t ao_storage_unit;
 
+#define AO_STORAGE_ERASE_LOG   (ao_storage_config + AO_CONFIG_MAX_SIZE)
+
+/* Initialize above values. Can only be called once the OS is running */
 void
-ao_ee_flush(void) __reentrant;
+ao_storage_setup(void);
 
-/* Write to the eeprom */
+/* Write data. Returns 0 on failure, 1 on success */
 uint8_t
-ao_ee_write(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
+ao_storage_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 
-/* Read from the eeprom */
+/* Read data. Returns 0 on failure, 1 on success */
 uint8_t
-ao_ee_read(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant;
+ao_storage_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 
-/* Write the config block (at the end of the eeprom) */
+/* Erase a block of storage. This always clears ao_storage_block bytes */
 uint8_t
-ao_ee_write_config(uint8_t *buf, uint16_t len) __reentrant;
+ao_storage_erase(uint32_t pos) __reentrant;
+
+/* Flush any pending writes to stable storage */
+void
+ao_storage_flush(void) __reentrant;
 
-/* Read the config block (at the end of the eeprom) */
+/* Initialize the storage code */
+void
+ao_storage_init(void);
+
+/*
+ * Low-level functions wrapped by ao_storage.c
+ */
+
+/* Read data within a storage unit */
 uint8_t
-ao_ee_read_config(uint8_t *buf, uint16_t len) __reentrant;
+ao_storage_device_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
 
-/* Initialize the EEPROM code */
+/* Write data within a storage unit */
+uint8_t
+ao_storage_device_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant;
+
+/* Initialize low-level device bits */
 void
-ao_ee_init(void);
+ao_storage_device_init(void);
+
+/* Print out information about flash chips */
+void
+ao_storage_device_info(void) __reentrant;
 
 /*
  * ao_log.c
@@ -579,14 +604,6 @@ ao_log_flush(void);
  */
 extern __xdata uint16_t ao_flight_number;
 
-/* Retrieve first log record for the current flight */
-uint8_t
-ao_log_dump_first(void);
-
-/* return next log record for the current flight */
-uint8_t
-ao_log_dump_next(void);
-
 /* Logging thread main routine */
 void
 ao_log(void);
@@ -603,6 +620,18 @@ ao_log_stop(void);
 void
 ao_log_init(void);
 
+/* Write out the current flight number to the erase log */
+void
+ao_log_write_erase(uint8_t pos);
+
+/* Returns true if there are any logs stored in eeprom */
+uint8_t
+ao_log_present(void);
+
+/* Returns true if there is no more storage space available */
+uint8_t
+ao_log_full(void);
+
 /*
  * ao_flight.c
  */
@@ -981,7 +1010,7 @@ ao_igniter_init(void);
  */
 
 #define AO_CONFIG_MAJOR        1
-#define AO_CONFIG_MINOR        3
+#define AO_CONFIG_MINOR        4
 
 struct ao_config {
        uint8_t         major;
@@ -993,13 +1022,19 @@ struct ao_config {
        uint8_t         apogee_delay;           /* minor version 1 */
        int16_t         accel_minus_g;          /* minor version 2 */
        uint32_t        radio_cal;              /* minor version 3 */
+       uint32_t        flight_log_max;         /* minor version 4 */
 };
 
 extern __xdata struct ao_config ao_config;
 
+#define AO_CONFIG_MAX_SIZE     128
+
 void
 ao_config_get(void);
 
+void
+ao_config_put(void);
+
 void
 ao_config_init(void);