altos: Require sequencing through 'main' state before landing
[fw/altos] / src / ao_ee.c
index f299b925c0274b70c46270de3c76da05aee23087..83863af562af58bb6f9ff337fda21af8aec0ff4c 100644 (file)
 #include "ao.h"
 #include "25lc1024.h"
 
+#define EE_BLOCK_SIZE  ((uint16_t) (256))
+#define EE_BLOCK_SHIFT 8
+#define EE_DEVICE_SIZE ((uint32_t) 128 * (uint32_t) 1024)
+
+/* Total bytes of available storage */
+__pdata uint32_t       ao_storage_total;
+
+/* Block size - device is erased in these units. At least 256 bytes */
+__pdata uint32_t       ao_storage_block;
+
+/* Byte offset of config block. Will be ao_storage_block bytes long */
+__pdata uint32_t       ao_storage_config;
+
+/* Storage unit size - device reads and writes must be within blocks of this size. Usually 256 bytes. */
+__pdata uint16_t       ao_storage_unit;
+
 /*
  * Using SPI on USART 0, with P1_2 as the chip select
  */
 #define EE_CS          P1_2
 #define EE_CS_INDEX    2
 
-__xdata uint8_t ao_ee_dma_in_done;
-__xdata uint8_t ao_ee_dma_out_done;
-__xdata uint8_t ao_ee_mutex;
-
-uint8_t        ao_ee_dma_out_id;
-uint8_t ao_ee_dma_in_id;
-
-static __xdata uint8_t ao_ee_const = 0xff;
+static __xdata uint8_t ao_ee_mutex;
 
 #define ao_ee_delay() do { \
        _asm nop _endasm; \
@@ -40,99 +49,20 @@ static __xdata uint8_t      ao_ee_const = 0xff;
        _asm nop _endasm; \
 } while(0)
 
-void ao_ee_cs_low(void)
+static void ao_ee_cs_low(void)
 {
        ao_ee_delay();
        EE_CS = 0;
        ao_ee_delay();
 }
 
-void ao_ee_cs_high(void)
+static void ao_ee_cs_high(void)
 {
        ao_ee_delay();
        EE_CS = 1;
        ao_ee_delay();
 }
 
-/* Send bytes over SPI.
- *
- * This sets up two DMA engines, one writing the data and another reading
- * bytes coming back.  We use the bytes coming back to tell when the transfer
- * is complete, as the transmit register is double buffered and hence signals
- * completion one byte before the transfer is actually complete
- */
-static void
-ao_ee_send(void __xdata *block, uint16_t len)
-{
-       ao_dma_set_transfer(ao_ee_dma_in_id,
-                           &U0DBUFXADDR,
-                           &ao_ee_const,
-                           len,
-                           DMA_CFG0_WORDSIZE_8 |
-                           DMA_CFG0_TMODE_SINGLE |
-                           DMA_CFG0_TRIGGER_URX0,
-                           DMA_CFG1_SRCINC_0 |
-                           DMA_CFG1_DESTINC_0 |
-                           DMA_CFG1_PRIORITY_NORMAL);
-
-       ao_dma_set_transfer(ao_ee_dma_out_id,
-                           block,
-                           &U0DBUFXADDR,
-                           len,
-                           DMA_CFG0_WORDSIZE_8 |
-                           DMA_CFG0_TMODE_SINGLE |
-                           DMA_CFG0_TRIGGER_UTX0,
-                           DMA_CFG1_SRCINC_1 |
-                           DMA_CFG1_DESTINC_0 |
-                           DMA_CFG1_PRIORITY_NORMAL);
-
-       ao_dma_start(ao_ee_dma_in_id);
-       ao_dma_start(ao_ee_dma_out_id);
-       ao_dma_trigger(ao_ee_dma_out_id);
-       __critical while (!ao_ee_dma_in_done)
-               ao_sleep(&ao_ee_dma_in_done);
-}
-
-/* Receive bytes over SPI.
- *
- * This sets up tow DMA engines, one reading the data and another
- * writing constant values to the SPI transmitter as that is what
- * clocks the data coming in.
- */
-static void
-ao_ee_recv(void __xdata *block, uint16_t len)
-{
-       ao_dma_set_transfer(ao_ee_dma_in_id,
-                           &U0DBUFXADDR,
-                           block,
-                           len,
-                           DMA_CFG0_WORDSIZE_8 |
-                           DMA_CFG0_TMODE_SINGLE |
-                           DMA_CFG0_TRIGGER_URX0,
-                           DMA_CFG1_SRCINC_0 |
-                           DMA_CFG1_DESTINC_1 |
-                           DMA_CFG1_PRIORITY_NORMAL);
-
-       ao_dma_set_transfer(ao_ee_dma_out_id,
-                           &ao_ee_const,
-                           &U0DBUFXADDR,
-                           len,
-                           DMA_CFG0_WORDSIZE_8 |
-                           DMA_CFG0_TMODE_SINGLE |
-                           DMA_CFG0_TRIGGER_UTX0,
-                           DMA_CFG1_SRCINC_0 |
-                           DMA_CFG1_DESTINC_0 |
-                           DMA_CFG1_PRIORITY_NORMAL);
-
-       ao_dma_start(ao_ee_dma_in_id);
-       ao_dma_start(ao_ee_dma_out_id);
-       ao_dma_trigger(ao_ee_dma_out_id);
-       __critical while (!ao_ee_dma_in_done)
-               ao_sleep(&ao_ee_dma_in_done);
-}
-
-#define EE_BLOCK       256
-
 struct ao_ee_instruction {
        uint8_t instruction;
        uint8_t address[3];
@@ -143,7 +73,7 @@ ao_ee_write_enable(void)
 {
        ao_ee_cs_low();
        ao_ee_instruction.instruction = EE_WREN;
-       ao_ee_send(&ao_ee_instruction, 1);
+       ao_spi_send(&ao_ee_instruction, 1);
        ao_ee_cs_high();
 }
 
@@ -152,8 +82,8 @@ ao_ee_rdsr(void)
 {
        ao_ee_cs_low();
        ao_ee_instruction.instruction = EE_RDSR;
-       ao_ee_send(&ao_ee_instruction, 1);
-       ao_ee_recv(&ao_ee_instruction, 1);
+       ao_spi_send(&ao_ee_instruction, 1);
+       ao_spi_recv(&ao_ee_instruction, 1);
        ao_ee_cs_high();
        return ao_ee_instruction.instruction;
 }
@@ -164,13 +94,13 @@ ao_ee_wrsr(uint8_t status)
        ao_ee_cs_low();
        ao_ee_instruction.instruction = EE_WRSR;
        ao_ee_instruction.address[0] = status;
-       ao_ee_send(&ao_ee_instruction, 2);
+       ao_spi_send(&ao_ee_instruction, 2);
        ao_ee_cs_high();
 }
 
 #define EE_BLOCK_NONE  0xffff
 
-static __xdata uint8_t ao_ee_data[EE_BLOCK];
+static __xdata uint8_t ao_ee_data[EE_BLOCK_SIZE];
 static __pdata uint16_t ao_ee_block = EE_BLOCK_NONE;
 static __pdata uint8_t ao_ee_block_dirty;
 
@@ -191,8 +121,8 @@ ao_ee_write_block(void)
        ao_ee_instruction.address[0] = ao_ee_block >> 8;
        ao_ee_instruction.address[1] = ao_ee_block;
        ao_ee_instruction.address[2] = 0;
-       ao_ee_send(&ao_ee_instruction, 4);
-       ao_ee_send(ao_ee_data, EE_BLOCK);
+       ao_spi_send(&ao_ee_instruction, 4);
+       ao_spi_send(ao_ee_data, EE_BLOCK_SIZE);
        ao_ee_cs_high();
        for (;;) {
                uint8_t status = ao_ee_rdsr();
@@ -210,8 +140,8 @@ ao_ee_read_block(void)
        ao_ee_instruction.address[0] = ao_ee_block >> 8;
        ao_ee_instruction.address[1] = ao_ee_block;
        ao_ee_instruction.address[2] = 0;
-       ao_ee_send(&ao_ee_instruction, 4);
-       ao_ee_recv(ao_ee_data, EE_BLOCK);
+       ao_spi_send(&ao_ee_instruction, 4);
+       ao_spi_recv(ao_ee_data, EE_BLOCK_SIZE);
        ao_ee_cs_high();
 }
 
@@ -235,225 +165,87 @@ ao_ee_fill(uint16_t block)
 }
 
 uint8_t
-ao_ee_write(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant
+ao_storage_device_write(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant
 {
-       uint16_t block;
-       uint16_t this_len;
-       uint8_t this_off;
-
-       if (pos >= AO_EE_DATA_SIZE || pos + len > AO_EE_DATA_SIZE)
-               return 0;
-       while (len) {
-
-               /* Compute portion of transfer within
-                * a single block
-                */
-               this_off = pos;
-               this_len = 256 - (uint16_t) this_off;
-               block = (uint16_t) (pos >> 8);
-               if (this_len > len)
-                       this_len = len;
-               if (this_len & 0xff00)
-                       ao_panic(AO_PANIC_EE);
-
-               /* Transfer the data */
-               ao_mutex_get(&ao_ee_mutex); {
-                       if (this_len != 256)
-                               ao_ee_fill(block);
-                       else {
-                               ao_ee_flush_internal();
-                               ao_ee_block = block;
-                       }
-                       memcpy(ao_ee_data + this_off, buf, this_len);
-                       ao_ee_block_dirty = 1;
-               } ao_mutex_put(&ao_ee_mutex);
-
-               /* See how much is left */
-               buf += this_len;
-               len -= this_len;
-       }
+       uint16_t block = (uint16_t) (pos >> EE_BLOCK_SHIFT);
+
+       /* Transfer the data */
+       ao_mutex_get(&ao_ee_mutex); {
+               if (len != EE_BLOCK_SIZE)
+                       ao_ee_fill(block);
+               else {
+                       ao_ee_flush_internal();
+                       ao_ee_block = block;
+               }
+               memcpy(ao_ee_data + (uint16_t) (pos & 0xff), buf, len);
+               ao_ee_block_dirty = 1;
+       } ao_mutex_put(&ao_ee_mutex);
        return 1;
 }
 
 uint8_t
-ao_ee_read(uint32_t pos, uint8_t *buf, uint16_t len) __reentrant
+ao_storage_device_read(uint32_t pos, __xdata void *buf, uint16_t len) __reentrant
 {
-       uint16_t block;
-       uint16_t this_len;
-       uint8_t this_off;
-
-       if (pos >= AO_EE_DATA_SIZE || pos + len > AO_EE_DATA_SIZE)
-               return 0;
-       while (len) {
-
-               /* Compute portion of transfer within
-                * a single block
-                */
-               this_off = pos;
-               this_len = 256 - (uint16_t) this_off;
-               block = (uint16_t) (pos >> 8);
-               if (this_len > len)
-                       this_len = len;
-               if (this_len & 0xff00)
-                       ao_panic(AO_PANIC_EE);
-
-               /* Transfer the data */
-               ao_mutex_get(&ao_ee_mutex); {
-                       ao_ee_fill(block);
-                       memcpy(buf, ao_ee_data + this_off, this_len);
-               } ao_mutex_put(&ao_ee_mutex);
+       uint16_t block = (uint16_t) (pos >> EE_BLOCK_SHIFT);
 
-               /* See how much is left */
-               buf += this_len;
-               len -= this_len;
-       }
+       /* Transfer the data */
+       ao_mutex_get(&ao_ee_mutex); {
+               ao_ee_fill(block);
+               memcpy(buf, ao_ee_data + (uint16_t) (pos & 0xff), len);
+       } ao_mutex_put(&ao_ee_mutex);
        return 1;
 }
 
 void
-ao_ee_flush(void) __reentrant
+ao_storage_flush(void) __reentrant
 {
        ao_mutex_get(&ao_ee_mutex); {
                ao_ee_flush_internal();
        } ao_mutex_put(&ao_ee_mutex);
 }
 
-/*
- * Read/write the config block, which is in
- * the last block of the ao_eeprom
- */
 uint8_t
-ao_ee_write_config(uint8_t *buf, uint16_t len) __reentrant
+ao_storage_erase(uint32_t pos) __reentrant
 {
-       if (len > AO_EE_BLOCK_SIZE)
-               return 0;
        ao_mutex_get(&ao_ee_mutex); {
-               ao_ee_fill(AO_EE_CONFIG_BLOCK);
-               memcpy(ao_ee_data, buf, len);
-               ao_ee_block_dirty = 1;
                ao_ee_flush_internal();
-       } ao_mutex_put(&ao_ee_mutex);
-       return 1;
-}
-
-uint8_t
-ao_ee_read_config(uint8_t *buf, uint16_t len) __reentrant
-{
-       if (len > AO_EE_BLOCK_SIZE)
-               return 0;
-       ao_mutex_get(&ao_ee_mutex); {
-               ao_ee_fill(AO_EE_CONFIG_BLOCK);
-               memcpy(buf, ao_ee_data, len);
+               ao_ee_block = (uint16_t) (pos >> EE_BLOCK_SHIFT);
+               memset(ao_ee_data, 0xff, EE_BLOCK_SIZE);
+               ao_ee_block_dirty = 1;
        } ao_mutex_put(&ao_ee_mutex);
        return 1;
 }
 
 static void
-ee_dump(void)
+ee_store(void) __reentrant
 {
-       __xdata uint8_t b;
-       __xdata uint16_t block;
-       __xdata uint8_t i;
-
-       ao_cmd_hex();
-       block = ao_cmd_lex_i;
-       if (ao_cmd_status != ao_cmd_success)
-               return;
-       i = 0;
-       do {
-               if ((i & 7) == 0) {
-                       if (i)
-                               putchar('\n');
-                       ao_cmd_put16((uint16_t) i);
-               }
-               putchar(' ');
-               ao_ee_read(((uint32_t) block << 8) | i, &b, 1);
-               ao_cmd_put8(b);
-               ++i;
-       } while (i != 0);
-       putchar('\n');
 }
 
-static void
-ee_store(void)
+void
+ao_storage_setup(void)
 {
-       __xdata uint16_t block;
-       __xdata uint8_t i;
-       __xdata uint16_t len;
-       __xdata uint8_t b;
-       __xdata uint32_t addr;
-
-       ao_cmd_hex();
-       block = ao_cmd_lex_i;
-       ao_cmd_hex();
-       i = ao_cmd_lex_i;
-       addr = ((uint32_t) block << 8) | i;
-       ao_cmd_hex();
-       len = ao_cmd_lex_i;
-       if (ao_cmd_status != ao_cmd_success)
-               return;
-       while (len--) {
-               ao_cmd_hex();
-               if (ao_cmd_status != ao_cmd_success)
-                       return;
-               b = ao_cmd_lex_i;
-               ao_ee_write(addr, &b, 1);
-               addr++;
+       if (ao_storage_total == 0) {
+               ao_storage_total = EE_DEVICE_SIZE;
+               ao_storage_block = EE_BLOCK_SIZE;
+               ao_storage_config = EE_DEVICE_SIZE - EE_BLOCK_SIZE;
+               ao_storage_unit = EE_BLOCK_SIZE;
        }
-       ao_ee_flush();
 }
 
-__code struct ao_cmds ao_ee_cmds[] = {
-       { 'e', ee_dump,         "e <block>                          Dump a block of EEPROM data" },
-       { 'w', ee_store,        "w <block> <start> <len> <data> ... Write data to EEPROM" },
-       { 0,   ee_store, NULL },
-};
+void
+ao_storage_device_info(void) __reentrant
+{
+}
 
 /*
  * To initialize the chip, set up the CS line and
  * the SPI interface
  */
 void
-ao_ee_init(void)
+ao_storage_device_init(void)
 {
        /* set up CS */
        EE_CS = 1;
        P1DIR |= (1 << EE_CS_INDEX);
        P1SEL &= ~(1 << EE_CS_INDEX);
-
-       /* Set up the USART pin assignment */
-       PERCFG = (PERCFG & ~PERCFG_U0CFG_ALT_MASK) | PERCFG_U0CFG_ALT_2;
-
-       /* Ensure that USART0 takes precidence over USART1 for pins that
-        * they share
-        */
-       P2SEL = (P2SEL & ~P2SEL_PRI3P1_MASK) | P2SEL_PRI3P1_USART0;
-
-       /* Make the SPI pins be controlled by the USART peripheral */
-       P1SEL |= ((1 << 5) | (1 << 4) | (1 << 3));
-
-       /* Set up OUT DMA */
-       ao_ee_dma_out_id = ao_dma_alloc(&ao_ee_dma_out_done);
-
-       /* Set up IN DMA */
-       ao_ee_dma_in_id = ao_dma_alloc(&ao_ee_dma_in_done);
-
-       /* Set up the USART.
-        *
-        * SPI master mode
-        */
-       U0CSR = (UxCSR_MODE_SPI | UxCSR_RE | UxCSR_MASTER);
-
-       /* Set the baud rate and signal parameters
-        *
-        * The cc1111 is limited to a 24/8 MHz SPI clock,
-        * while the 25LC1024 is limited to 20MHz. So,
-        * use the 3MHz clock (BAUD_E 17, BAUD_M 0)
-        */
-       U0BAUD = 0;
-       U0GCR = (UxGCR_CPOL_NEGATIVE |
-                UxGCR_CPHA_FIRST_EDGE |
-                UxGCR_ORDER_MSB |
-                (17 << UxGCR_BAUD_E_SHIFT));
-       ao_cmd_register(&ao_ee_cmds[0]);
 }