Merge branch 'ft-dfu-code-loading'

8 files changed, 220 insertions, 5 deletions

diff --git a/projects/cli-test/Makefile b/projects/cli-test/Makefile
index 7737e13..39619fc 100644
--- a/projects/cli-test/Makefile
+++ b/projects/cli-test/Makefile
@@ -1,6 +1,6 @@
 TEST = cli-test
 
-OBJS = crc32.o mgmt-cli.o test_sdram.o
+OBJS = crc32.o mgmt-cli.o test_sdram.o mgmt-dfu.o
 
 CFLAGS += -I$(LIBCLI_DIR)
 LIBS += $(LIBCLI_DIR)/libcli.a
diff --git a/projects/cli-test/cli-test.c b/projects/cli-test/cli-test.c
index 41d7365..84c268b 100644
--- a/projects/cli-test/cli-test.c
+++ b/projects/cli-test/cli-test.c
@@ -39,6 +39,7 @@
 #include "stm-keystore.h"
 #include "stm-sdram.h"
 #include "mgmt-cli.h"
+#include "mgmt-dfu.h"
 #include "test_sdram.h"
 
 #include <string.h>
@@ -396,7 +397,7 @@ void configure_cli_test(struct cli_def *cli)
     cli_command_node(test, sdram, "Run SDRAM tests");
 }
 
-void configure_cli_misc(struct cli_def *cli)
+static void configure_cli_misc(struct cli_def *cli)
 {
     /* filetransfer */
     cli_command_root_node(filetransfer, "Test file transfering");
@@ -404,11 +405,32 @@ void configure_cli_misc(struct cli_def *cli)
     cli_command_root_node(reboot, "Reboot the STM32");
 }
 
+typedef  void (*pFunction)(void);
+
+/* This is it's own function to make it more convenient to set a breakpoint at it in gdb */
+void do_early_dfu_jump(void)
+{
+    pFunction loaded_app = (pFunction) *dfu_code_ptr;
+    /* Set the stack pointer to the correct one for the firmware */
+    __set_MSP(*dfu_msp_ptr);
+    /* Set the Vector Table Offset Register */
+    SCB->VTOR = (uint32_t) dfu_firmware;
+    loaded_app();
+    while (1);
+}
+
+
 int
 main()
 {
     static struct cli_def cli;
 
+    /* Check if we've just rebooted in order to jump to the firmware. */
+    if (*dfu_control == HARDWARE_EARLY_DFU_JUMP) {
+	*dfu_control = 0;
+	do_early_dfu_jump();
+    }
+
     stm_init();
 
     led_on(LED_RED);
@@ -420,6 +442,7 @@ main()
     configure_cli_fpga(&cli);
     configure_cli_test(&cli);
     configure_cli_misc(&cli);
+    configure_cli_dfu(&cli);
 
     led_off(LED_RED);
     led_on(LED_GREEN);
diff --git a/projects/cli-test/filetransfer b/projects/cli-test/filetransfer
index 2b74570..025a6ac 100755
--- a/projects/cli-test/filetransfer
+++ b/projects/cli-test/filetransfer
@@ -40,6 +40,7 @@ import argparse
 from binascii import crc32
 
 CHUNK_SIZE = 256
+DFU_CHUNK_SIZE = 256
 FPGA_CHUNK_SIZE = 4096
 
 
@@ -57,6 +58,11 @@ def parse_args():
                         action='store_true', default=False,
                         help='Perform FPGA bitstream upload',
                         )
+    parser.add_argument('--dfu',
+                        dest='dfu',
+                        action='store_true', default=False,
+                        help='Perform DFU application upload',
+                        )
 
     parser.add_argument('--device',
                         dest='device',
@@ -117,6 +123,9 @@ def send_file(filename, args, dst):
         src.read(0x64)
         chunk_size = FPGA_CHUNK_SIZE
         response = _execute(dst, 'fpga bitstream upload')
+    elif args.dfu:
+        chunk_size = DFU_CHUNK_SIZE
+        response = _execute(dst, 'dfu upload')
     else:
         chunk_size = CHUNK_SIZE
         response = _execute(dst, 'filetransfer')
diff --git a/projects/cli-test/mgmt-cli.c b/projects/cli-test/mgmt-cli.c
index faaafda..46faae8 100644
--- a/projects/cli-test/mgmt-cli.c
+++ b/projects/cli-test/mgmt-cli.c
@@ -31,7 +31,6 @@
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
-#include "stm32f4xx_hal.h"
 #include "stm-init.h"
 #include "stm-uart.h"
 #include "mgmt-cli.h"
diff --git a/projects/cli-test/mgmt-cli.h b/projects/cli-test/mgmt-cli.h
index e6780a3..dd6a58b 100644
--- a/projects/cli-test/mgmt-cli.h
+++ b/projects/cli-test/mgmt-cli.h
@@ -35,7 +35,7 @@
 #ifndef __STM32_MGMT_CLI_H
 #define __STM32_MGMT_CLI_H
 
-#include "stm32f4xx_hal.h"
+#include "stm-init.h"
 #include <libcli.h>
 
 
@@ -64,7 +64,7 @@
 
 /* ROOT NODE is a label without a parent, but with a command associated with it */
 #define cli_command_root_node(name, help)				\
-    _cli_cmd_struct(name, name, NULL, (char *) help);			\
+    _cli_cmd_struct(name, name, cmd_##name, (char *) help);		\
     cli_register_command2(cli, &cmd_##name##_s, NULL)
 
 
diff --git a/projects/cli-test/mgmt-dfu.c b/projects/cli-test/mgmt-dfu.c
new file mode 100644
index 0000000..27fd722
--- /dev/null
+++ b/projects/cli-test/mgmt-dfu.c
@@ -0,0 +1,120 @@
+/*
+ * mgmt-dfu.c
+ * ---------
+ * CLI code for looking at, jumping to or erasing the loaded firmware.
+ *
+ * Copyright (c) 2016, NORDUnet A/S All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of the NORDUnet nor the names of its contributors may
+ *   be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#include "stm-init.h"
+#include "mgmt-cli.h"
+#include "stm-uart.h"
+#include "stm-flash.h"
+#include "mgmt-dfu.h"
+
+#include <string.h>
+
+extern uint32_t update_crc(uint32_t crc, uint8_t *buf, int len);
+
+/* Linker symbols are strange in C. Make regular pointers for sanity. */
+__IO uint32_t *dfu_control = &CRYPTECH_DFU_CONTROL;
+__IO uint32_t *dfu_firmware = &CRYPTECH_FIRMWARE_START;
+__IO uint32_t *dfu_firmware_end = &CRYPTECH_FIRMWARE_END;
+/* The first word in the firmware is an address to the stack (msp) */
+__IO uint32_t *dfu_msp_ptr = &CRYPTECH_FIRMWARE_START;
+/* The second word in the firmware is a pointer to the code
+ * (points at the Reset_Handler from the linker script).
+ */
+__IO uint32_t *dfu_code_ptr = &CRYPTECH_FIRMWARE_START + 1;
+
+
+
+int cmd_dfu_dump(struct cli_def *cli, const char *command, char *argv[], int argc)
+{
+    cli_print(cli, "First 256 bytes from DFU application address %p:\r\n", dfu_firmware);
+
+    uart_send_hexdump(STM_UART_MGMT, (uint8_t *) dfu_firmware, 0, 0xff);
+    uart_send_string2(STM_UART_MGMT, (char *) "\r\n\r\n");
+
+    return CLI_OK;
+}
+
+int cmd_dfu_erase(struct cli_def *cli, const char *command, char *argv[], int argc)
+{
+    int status;
+
+    cli_print(cli, "Erasing flash sectors %i to %i (address %p to %p) - expect the CLI to crash now",
+	      stm_flash_sector_num((uint32_t) dfu_firmware),
+	      stm_flash_sector_num((uint32_t) dfu_firmware_end),
+	      dfu_firmware,
+	      dfu_firmware_end);
+
+    if ((status = stm_flash_erase_sectors((uint32_t) dfu_firmware, (uint32_t) dfu_firmware_end)) != 0) {
+	cli_print(cli, "Failed erasing flash sectors (%i)", status);
+    }
+
+    return CLI_OK;
+}
+
+int cmd_dfu_jump(struct cli_def *cli, const char *command, char *argv[], int argc)
+{
+    uint32_t i;
+    /* Load first byte from the DFU_FIRMWARE_PTR to verify it contains an IVT before
+     * jumping there.
+     */
+    cli_print(cli, "Checking for application at %p", dfu_firmware);
+
+    i = *dfu_msp_ptr & 0xFF000000;
+    /* 'new_msp' is supposed to be a pointer to the new applications stack, it should
+     * point either at RAM (0x20000000) or at the CCM memory (0x10000000).
+     */
+    if (i == 0x20000000 || i == 0x10000000) {
+	/* Set dfu_control to the magic value that will cause the us to jump to the
+	 * firmware from the CLI main() function after rebooting.
+	 */
+	*dfu_control = HARDWARE_EARLY_DFU_JUMP;
+	cli_print(cli, "Making the leap");
+	HAL_NVIC_SystemReset();
+	while (1) { ; }
+    } else {
+	cli_print(cli, "No loaded application found at %p (read 0x%x)",
+		  dfu_firmware, (unsigned int) *dfu_msp_ptr);
+    }
+
+    return CLI_OK;
+}
+
+void configure_cli_dfu(struct cli_def *cli)
+{
+    cli_command_root(dfu);
+
+    cli_command_node(dfu, dump, "Show the first 256 bytes of the loaded firmware");
+    cli_command_node(dfu, jump, "Jump to the loaded firmware");
+    cli_command_node(dfu, erase, "Erase the firmware memory (will crash the CLI)");
+}
diff --git a/projects/cli-test/mgmt-dfu.h b/projects/cli-test/mgmt-dfu.h
new file mode 100644
index 0000000..ac6589c
--- /dev/null
+++ b/projects/cli-test/mgmt-dfu.h
@@ -0,0 +1,59 @@
+/*
+ * mgmt-dfu.h
+ * ---------
+ * Management CLI Device Firmware Upgrade code.
+ *
+ * Copyright (c) 2016, NORDUnet A/S All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are
+ * met:
+ * - Redistributions of source code must retain the above copyright notice,
+ *   this list of conditions and the following disclaimer.
+ *
+ * - Redistributions in binary form must reproduce the above copyright
+ *   notice, this list of conditions and the following disclaimer in the
+ *   documentation and/or other materials provided with the distribution.
+ *
+ * - Neither the name of the NORDUnet nor the names of its contributors may
+ *   be used to endorse or promote products derived from this software
+ *   without specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
+ * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
+ * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+ * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+ * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+
+#ifndef __STM32_CLI_MGMT_DFU_H
+#define __STM32_CLI_MGMT_DFU_H
+
+#include "stm-init.h"
+#include <libcli.h>
+
+/* symbols defined in the linker script (STM32F429BI.ld) */
+extern uint32_t CRYPTECH_FIRMWARE_START;
+extern uint32_t CRYPTECH_FIRMWARE_END;
+extern uint32_t CRYPTECH_DFU_CONTROL;
+
+#define DFU_FIRMWARE_ADDR         ((uint32_t) &CRYPTECH_FIRMWARE_START)
+#define DFU_FIRMWARE_END_ADDR     ((uint32_t) &CRYPTECH_FIRMWARE_END)
+#define DFU_UPLOAD_CHUNK_SIZE     256
+#define HARDWARE_EARLY_DFU_JUMP   0xBADABADA
+
+extern __IO uint32_t *dfu_control;
+extern __IO uint32_t *dfu_firmware;
+extern __IO uint32_t *dfu_msp_ptr;
+extern __IO uint32_t *dfu_code_ptr;
+
+
+extern void configure_cli_dfu(struct cli_def *cli);
+
+#endif /* __STM32_CLI_MGMT_DFU_H */
diff --git a/projects/cli-test/test_sdram.h b/projects/cli-test/test_sdram.h
index b848d18..3076aa1 100644
--- a/projects/cli-test/test_sdram.h
+++ b/projects/cli-test/test_sdram.h
@@ -31,6 +31,9 @@
  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
+#ifndef __STM32_CLI_TEST_SDRAM_H
+#define __STM32_CLI_TEST_SDRAM_H
+
 extern uint32_t lfsr1;
 extern uint32_t lfsr2;
 
@@ -40,3 +43,5 @@ extern int test_sdrams_interleaved(uint32_t *base_addr1, uint32_t *base_addr2);
 
 extern uint32_t lfsr_next_32(uint32_t lfsr);
 extern uint32_t lfsr_next_24(uint32_t lfsr);
+
+#endif /* __STM32_CLI_TEST_SDRAM_H */