Improved firmware update process, i2c now checks if it needs to reboot and uploaded data is checked with CRC (not in hardware yet)

Inc/stm32f4xx_hal_conf.h

@@ -39,7 +39,7 @@
   /* #define HAL_ADC_MODULE_ENABLED   */
 /* #define HAL_CRYP_MODULE_ENABLED   */
 /* #define HAL_CAN_MODULE_ENABLED   */
-/* #define HAL_CRC_MODULE_ENABLED   */
+#define HAL_CRC_MODULE_ENABLED
 /* #define HAL_CAN_LEGACY_MODULE_ENABLED   */
 /* #define HAL_CRYP_MODULE_ENABLED   */
 /* #define HAL_DAC_MODULE_ENABLED   */

Makefile

@@ -1,5 +1,5 @@
 ##########################################################################################################################
-# File automatically-generated by tool: [projectgenerator] version: [3.11.0-B13] date: [Wed Jan 06 03:17:31 CET 2021] 
+# File automatically-generated by tool: [projectgenerator] version: [3.11.0-B13] date: [Wed Jan 06 03:22:56 CET 2021] 
 ##########################################################################################################################
 
 # ------------------------------------------------
@@ -86,7 +86,8 @@ Middlewares/ST/STM32_USB_Device_Library/Class/MSC/Src/usbd_msc_bot.c \
 Middlewares/ST/STM32_USB_Device_Library/Class/MSC/Src/usbd_msc_data.c \
 Middlewares/ST/STM32_USB_Device_Library/Class/MSC/Src/usbd_msc_scsi.c \
 Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_i2c.c \
-Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_i2c_ex.c
+Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_i2c_ex.c \
+Drivers/STM32F4xx_HAL_Driver/Src/stm32f4xx_hal_crc.c
 
 # ASM sources
 ASM_SOURCES =  \

Src/firmware.c

@@ -8,6 +8,7 @@
 
 extern I2C_HandleTypeDef hi2c1;
 extern UART_HandleTypeDef huart2;
+extern CRC_HandleTypeDef hcrc;
 
 typedef enum {
 	TARGET_NONE = 0,
@@ -15,6 +16,36 @@ typedef enum {
 	TARGET_I2C
 } UpdateTarget;
 
+static const uint32_t crc_table[0x100] = {
+  0x00000000, 0x04C11DB7, 0x09823B6E, 0x0D4326D9, 0x130476DC, 0x17C56B6B, 0x1A864DB2, 0x1E475005, 0x2608EDB8, 0x22C9F00F, 0x2F8AD6D6, 0x2B4BCB61, 0x350C9B64, 0x31CD86D3, 0x3C8EA00A, 0x384FBDBD, 
+  0x4C11DB70, 0x48D0C6C7, 0x4593E01E, 0x4152FDA9, 0x5F15ADAC, 0x5BD4B01B, 0x569796C2, 0x52568B75, 0x6A1936C8, 0x6ED82B7F, 0x639B0DA6, 0x675A1011, 0x791D4014, 0x7DDC5DA3, 0x709F7B7A, 0x745E66CD, 
+  0x9823B6E0, 0x9CE2AB57, 0x91A18D8E, 0x95609039, 0x8B27C03C, 0x8FE6DD8B, 0x82A5FB52, 0x8664E6E5, 0xBE2B5B58, 0xBAEA46EF, 0xB7A96036, 0xB3687D81, 0xAD2F2D84, 0xA9EE3033, 0xA4AD16EA, 0xA06C0B5D, 
+  0xD4326D90, 0xD0F37027, 0xDDB056FE, 0xD9714B49, 0xC7361B4C, 0xC3F706FB, 0xCEB42022, 0xCA753D95, 0xF23A8028, 0xF6FB9D9F, 0xFBB8BB46, 0xFF79A6F1, 0xE13EF6F4, 0xE5FFEB43, 0xE8BCCD9A, 0xEC7DD02D, 
+  0x34867077, 0x30476DC0, 0x3D044B19, 0x39C556AE, 0x278206AB, 0x23431B1C, 0x2E003DC5, 0x2AC12072, 0x128E9DCF, 0x164F8078, 0x1B0CA6A1, 0x1FCDBB16, 0x018AEB13, 0x054BF6A4, 0x0808D07D, 0x0CC9CDCA, 
+  0x7897AB07, 0x7C56B6B0, 0x71159069, 0x75D48DDE, 0x6B93DDDB, 0x6F52C06C, 0x6211E6B5, 0x66D0FB02, 0x5E9F46BF, 0x5A5E5B08, 0x571D7DD1, 0x53DC6066, 0x4D9B3063, 0x495A2DD4, 0x44190B0D, 0x40D816BA, 
+  0xACA5C697, 0xA864DB20, 0xA527FDF9, 0xA1E6E04E, 0xBFA1B04B, 0xBB60ADFC, 0xB6238B25, 0xB2E29692, 0x8AAD2B2F, 0x8E6C3698, 0x832F1041, 0x87EE0DF6, 0x99A95DF3, 0x9D684044, 0x902B669D, 0x94EA7B2A, 
+  0xE0B41DE7, 0xE4750050, 0xE9362689, 0xEDF73B3E, 0xF3B06B3B, 0xF771768C, 0xFA325055, 0xFEF34DE2, 0xC6BCF05F, 0xC27DEDE8, 0xCF3ECB31, 0xCBFFD686, 0xD5B88683, 0xD1799B34, 0xDC3ABDED, 0xD8FBA05A, 
+  0x690CE0EE, 0x6DCDFD59, 0x608EDB80, 0x644FC637, 0x7A089632, 0x7EC98B85, 0x738AAD5C, 0x774BB0EB, 0x4F040D56, 0x4BC510E1, 0x46863638, 0x42472B8F, 0x5C007B8A, 0x58C1663D, 0x558240E4, 0x51435D53, 
+  0x251D3B9E, 0x21DC2629, 0x2C9F00F0, 0x285E1D47, 0x36194D42, 0x32D850F5, 0x3F9B762C, 0x3B5A6B9B, 0x0315D626, 0x07D4CB91, 0x0A97ED48, 0x0E56F0FF, 0x1011A0FA, 0x14D0BD4D, 0x19939B94, 0x1D528623, 
+  0xF12F560E, 0xF5EE4BB9, 0xF8AD6D60, 0xFC6C70D7, 0xE22B20D2, 0xE6EA3D65, 0xEBA91BBC, 0xEF68060B, 0xD727BBB6, 0xD3E6A601, 0xDEA580D8, 0xDA649D6F, 0xC423CD6A, 0xC0E2D0DD, 0xCDA1F604, 0xC960EBB3, 
+  0xBD3E8D7E, 0xB9FF90C9, 0xB4BCB610, 0xB07DABA7, 0xAE3AFBA2, 0xAAFBE615, 0xA7B8C0CC, 0xA379DD7B, 0x9B3660C6, 0x9FF77D71, 0x92B45BA8, 0x9675461F, 0x8832161A, 0x8CF30BAD, 0x81B02D74, 0x857130C3, 
+  0x5D8A9099, 0x594B8D2E, 0x5408ABF7, 0x50C9B640, 0x4E8EE645, 0x4A4FFBF2, 0x470CDD2B, 0x43CDC09C, 0x7B827D21, 0x7F436096, 0x7200464F, 0x76C15BF8, 0x68860BFD, 0x6C47164A, 0x61043093, 0x65C52D24, 
+  0x119B4BE9, 0x155A565E, 0x18197087, 0x1CD86D30, 0x029F3D35, 0x065E2082, 0x0B1D065B, 0x0FDC1BEC, 0x3793A651, 0x3352BBE6, 0x3E119D3F, 0x3AD08088, 0x2497D08D, 0x2056CD3A, 0x2D15EBE3, 0x29D4F654, 
+  0xC5A92679, 0xC1683BCE, 0xCC2B1D17, 0xC8EA00A0, 0xD6AD50A5, 0xD26C4D12, 0xDF2F6BCB, 0xDBEE767C, 0xE3A1CBC1, 0xE760D676, 0xEA23F0AF, 0xEEE2ED18, 0xF0A5BD1D, 0xF464A0AA, 0xF9278673, 0xFDE69BC4, 
+  0x89B8FD09, 0x8D79E0BE, 0x803AC667, 0x84FBDBD0, 0x9ABC8BD5, 0x9E7D9662, 0x933EB0BB, 0x97FFAD0C, 0xAFB010B1, 0xAB710D06, 0xA6322BDF, 0xA2F33668, 0xBCB4666D, 0xB8757BDA, 0xB5365D03, 0xB1F740B4, 
+};
+
+uint32_t crc32(uint8_t* data, uint16_t length) {
+    uint32_t crc = 0xFFFFFFFF;
+    for(uint16_t i = 0; i < length; i++)
+    {
+        uint8_t top = (uint8_t)(crc >> 24);
+        top ^= data[i];
+        crc = (crc << 8) ^ crc_table[top];
+    }
+    return crc;
+}
+
 extern uint8_t ack[1];
 extern uint8_t nack[1];
 void firmware_update() {
@@ -30,7 +61,13 @@ void firmware_update() {
 
 	uint8_t* data = malloc(length);
 	HAL_UART_Receive(&huart2, data, length, 1000);
-	HAL_UART_Transmit(&huart2, ack, sizeof(ack), HAL_MAX_DELAY);
+
+	// Calculate the CRC of the data and send it back
+	// @todo Figure how we can actually use the hardware crc
+	/* uint32_t crc = HAL_CRC_Calculate(&hcrc, (uint32_t*)data, length); */
+	uint32_t crc = crc32(data, length);
+	uint8_t c[] = {crc, crc >> 8, crc >> 16, crc >> 24};
+	HAL_UART_Transmit(&huart2, c, sizeof(c), HAL_MAX_DELAY);
 
 	switch (target) {
 		case TARGET_ROM:
@@ -42,26 +79,32 @@ void firmware_update() {
 			HAL_UART_Receive(&huart2, &address, 1, 1000);
 			HAL_UART_Transmit(&huart2, &address, sizeof(ack), HAL_MAX_DELAY);
 
-			if (HAL_I2C_IsDeviceReady(&hi2c1, 0x29 << 1, 10, 1000) != HAL_OK) {
+			// Check if we can read the version string
-				HAL_UART_Transmit(&huart2, nack, sizeof(nack), HAL_MAX_DELAY);
+			uint8_t version_command[] = {0x01};
-				return;
+			HAL_I2C_Master_Transmit(&hi2c1, address << 1, version_command, sizeof(version_command), 1000);
+			uint8_t version_string[16] = {0};
+			HAL_I2C_Master_Receive(&hi2c1, address << 1, version_string, sizeof(version_string), 1000);
+
+			// Check the version string
+			if (version_string[0] == 'T' && version_string[1] == 'W' && version_string[2] == 'I') {
+				HAL_UART_Transmit(&huart2, ack, sizeof(ack), HAL_MAX_DELAY);
+			} else {
+				uint8_t reboot_command[] = {0xFF};
+				HAL_I2C_Master_Transmit(&hi2c1, address << 1, reboot_command, sizeof(reboot_command), 1000);
+
+				uint8_t rebooting[] = {0x02};
+				HAL_UART_Transmit(&huart2, rebooting, sizeof(rebooting), HAL_MAX_DELAY);
 			}
-			HAL_UART_Transmit(&huart2, ack, sizeof(ack), HAL_MAX_DELAY);
 
-			// @todo This assumes that the target it not already in bootloader mode, otherwise this will mess things up
+			while (HAL_I2C_IsDeviceReady(&hi2c1, address << 1, 10, 1000) != HAL_OK);
-			uint8_t reboot_command[] = {0xFF};
-			HAL_I2C_Master_Transmit(&hi2c1, address << 1, reboot_command, sizeof(reboot_command), 1000);
-
-			while (HAL_I2C_IsDeviceReady(&hi2c1, 0x29 << 1, 10, 1000) != HAL_OK);
 
 			HAL_UART_Transmit(&huart2, ack, sizeof(ack), HAL_MAX_DELAY);
 
 			uint8_t abort_command[] = {0x00};
 			HAL_I2C_Master_Transmit(&hi2c1, address << 1, abort_command, sizeof(abort_command), 1000);
 
-			uint8_t version_command[] = {0x01};
+			// Re-read the version string in case we rebooted
 			HAL_I2C_Master_Transmit(&hi2c1, address << 1, version_command, sizeof(version_command), 1000);
-			uint8_t version_string[16] = {0};
 			HAL_I2C_Master_Receive(&hi2c1, address << 1, version_string, sizeof(version_string), 1000);
 			HAL_UART_Transmit(&huart2, version_string, sizeof(version_string), HAL_MAX_DELAY);
 
@@ -82,7 +125,7 @@ void firmware_update() {
 
 				HAL_I2C_Master_Transmit(&hi2c1, address << 1, upload_command, sizeof(upload_command), 1000);
 
-				while (HAL_I2C_IsDeviceReady(&hi2c1, 0x29 << 1, 10, 1000) != HAL_OK);
+				while (HAL_I2C_IsDeviceReady(&hi2c1, address << 1, 10, 1000) != HAL_OK);
 
 				uint8_t progress[] = {(length-remaining) & 0xFF, (length-remaining) >> 8};
 				HAL_UART_Transmit(&huart2, progress, sizeof(progress), HAL_MAX_DELAY);

Src/main.c

@@ -49,6 +49,8 @@
 /* USER CODE END PM */
 
 /* Private variables ---------------------------------------------------------*/
+CRC_HandleTypeDef hcrc;
+
 I2C_HandleTypeDef hi2c1;
 
 SD_HandleTypeDef hsd;
@@ -66,6 +68,7 @@ static void MX_GPIO_Init(void);
 static void MX_USART2_UART_Init(void);
 static void MX_I2C1_Init(void);
 static void MX_SDIO_SD_Init(void);
+static void MX_CRC_Init(void);
 /* USER CODE BEGIN PFP */
 
 /* USER CODE END PFP */
@@ -219,6 +222,7 @@ int main(void)
 	MX_SDIO_SD_Init();
 	MX_FATFS_Init();
 	MX_USB_DEVICE_Init();
+	MX_CRC_Init();
 	/* USER CODE BEGIN 2 */
 	setvbuf(stdout, NULL, _IONBF, 0);
 
@@ -240,14 +244,8 @@ int main(void)
 
 		/* USER CODE BEGIN 3 */
 		// @todo Speed up the main loop
-		uint8_t temp = HAL_GPIO_ReadPin(GPIOA, GPIO_PIN_4); 
-		if (!temp && zrst) {
-			printf("Restarting Z80\n\r");
-			control_reset();
-		}
-		zrst = temp;
 
-		temp = HAL_GPIO_ReadPin(GPIOA, GPIO_PIN_5); 
+		uint8_t temp = HAL_GPIO_ReadPin(GPIOA, GPIO_PIN_5); 
 		if (!temp && dfu) {
 			printf("Soft restart to bootloader\n\r");
 			request_restart_to_bootloader();
@@ -261,9 +259,16 @@ int main(void)
 		}
 		rst = temp;
 
-		restart_check();
+		temp = HAL_GPIO_ReadPin(GPIOA, GPIO_PIN_4); 
+		if (!temp && zrst) {
+			printf("Restarting Z80\n\r");
+			control_reset();
+		} else if (!temp) {
+			control_execute_state();
+		}
+		zrst = temp;
 
-		control_execute_state();
+		restart_check();
 	}
 	/* USER CODE END 3 */
 }
@@ -311,6 +316,32 @@ void SystemClock_Config(void)
 	}
 }
 
+/**
+ * @brief CRC Initialization Function
+ * @param None
+ * @retval None
+ */
+static void MX_CRC_Init(void)
+{
+
+	/* USER CODE BEGIN CRC_Init 0 */
+
+	/* USER CODE END CRC_Init 0 */
+
+	/* USER CODE BEGIN CRC_Init 1 */
+
+	/* USER CODE END CRC_Init 1 */
+	hcrc.Instance = CRC;
+	if (HAL_CRC_Init(&hcrc) != HAL_OK)
+	{
+		Error_Handler();
+	}
+	/* USER CODE BEGIN CRC_Init 2 */
+
+	/* USER CODE END CRC_Init 2 */
+
+}
+
 /**
  * @brief I2C1 Initialization Function
  * @param None

Src/stm32f4xx_hal_msp.c

@@ -77,6 +77,50 @@ void HAL_MspInit(void)
   /* USER CODE END MspInit 1 */
 }
 
+/**
+* @brief CRC MSP Initialization
+* This function configures the hardware resources used in this example
+* @param hcrc: CRC handle pointer
+* @retval None
+*/
+void HAL_CRC_MspInit(CRC_HandleTypeDef* hcrc)
+{
+  if(hcrc->Instance==CRC)
+  {
+  /* USER CODE BEGIN CRC_MspInit 0 */
+
+  /* USER CODE END CRC_MspInit 0 */
+    /* Peripheral clock enable */
+    __HAL_RCC_CRC_CLK_ENABLE();
+  /* USER CODE BEGIN CRC_MspInit 1 */
+
+  /* USER CODE END CRC_MspInit 1 */
+  }
+
+}
+
+/**
+* @brief CRC MSP De-Initialization
+* This function freeze the hardware resources used in this example
+* @param hcrc: CRC handle pointer
+* @retval None
+*/
+void HAL_CRC_MspDeInit(CRC_HandleTypeDef* hcrc)
+{
+  if(hcrc->Instance==CRC)
+  {
+  /* USER CODE BEGIN CRC_MspDeInit 0 */
+
+  /* USER CODE END CRC_MspDeInit 0 */
+    /* Peripheral clock disable */
+    __HAL_RCC_CRC_CLK_DISABLE();
+  /* USER CODE BEGIN CRC_MspDeInit 1 */
+
+  /* USER CODE END CRC_MspDeInit 1 */
+  }
+
+}
+
 /**
 * @brief I2C MSP Initialization
 * This function configures the hardware resources used in this example

z80-stm32-v2.ioc

@@ -81,17 +81,18 @@ VP_USB_DEVICE_VS_USB_DEVICE_MSC_FS.Signal=USB_DEVICE_VS_USB_DEVICE_MSC_FS
 PA6.GPIOParameters=GPIO_PuPd
 FATFS0.BSP.STBoard=false
 ProjectManager.ProjectFileName=z80-stm32-v2.ioc
-Mcu.PinsNb=71
+Mcu.PinsNb=72
+Mcu.Pin71=VP_USB_DEVICE_VS_USB_DEVICE_MSC_FS
 FATFS0.BSP.mode=Input
 PD3.Signal=GPIO_Input
-Mcu.Pin70=VP_USB_DEVICE_VS_USB_DEVICE_MSC_FS
+Mcu.Pin70=VP_SYS_VS_Systick
 PC6.Signal=GPIO_Input
 PC2.Signal=GPIO_Output
 PD13.GPIOParameters=GPIO_PuPd
 PD7.Signal=GPIO_Input
 PD1.Signal=GPIO_Input
-Mcu.Pin68=VP_FATFS_VS_SDIO
+Mcu.Pin68=VP_CRC_VS_CRC
-Mcu.Pin69=VP_SYS_VS_Systick
+Mcu.Pin69=VP_FATFS_VS_SDIO
 PC0.Signal=GPIO_Input
 PB14.Locked=true
 RCC.APB1CLKDivider=RCC_HCLK_DIV4
@@ -116,6 +117,7 @@ Mcu.Pin51=PD0
 Mcu.Pin52=PD1
 I2C1.I2C_Mode=I2C_Standard
 Mcu.Pin50=PC12
+VP_CRC_VS_CRC.Signal=CRC_VS_CRC
 PD11.GPIO_Speed=GPIO_SPEED_FREQ_LOW
 Mcu.Pin55=PD4
 Mcu.Pin56=PD5
@@ -237,15 +239,15 @@ PB15.Signal=GPIO_Output
 PE5.GPIOParameters=GPIO_PuPd
 ProjectManager.StackSize=0x400
 PD13.Signal=GPIO_Input
-Mcu.IP4=SDIO
+Mcu.IP4=RCC
 RCC.FCLKCortexFreq_Value=168000000
-Mcu.IP5=SYS
+Mcu.IP5=SDIO
-Mcu.IP2=NVIC
 I2C1.IPParameters=ClockSpeed,I2C_Mode
+Mcu.IP2=I2C1
 PD13.Locked=true
-Mcu.IP3=RCC
+Mcu.IP3=NVIC
-Mcu.IP0=FATFS
+Mcu.IP0=CRC
-Mcu.IP1=I2C1
+Mcu.IP1=FATFS
 PA12.Signal=USB_OTG_FS_DP
 PE4.GPIOParameters=GPIO_Speed,PinState
 Mcu.UserConstants=
@@ -255,7 +257,7 @@ I2C1.ClockSpeed=100000
 PC1.GPIOParameters=GPIO_Speed,PinState
 Mcu.ThirdPartyNb=0
 RCC.HCLKFreq_Value=168000000
-Mcu.IPNb=9
+Mcu.IPNb=10
 RCC.I2SClocksFreq_Value=96000000
 ProjectManager.PreviousToolchain=
 RCC.VcooutputI2S=96000000
@@ -363,10 +365,11 @@ ProjectManager.AskForMigrate=false
 Mcu.Name=STM32F407V(E-G)Tx
 PE0.Signal=GPIO_Input
 PA2.Signal=USART2_TX
-Mcu.IP8=USB_OTG_FS
+Mcu.IP8=USB_DEVICE
+Mcu.IP9=USB_OTG_FS
 PD14.Signal=GPIO_Input
-Mcu.IP6=USART2
+Mcu.IP6=SYS
-Mcu.IP7=USB_DEVICE
+Mcu.IP7=USART2
 ProjectManager.CoupleFile=false
 RCC.48MHZClocksFreq_Value=48000000
 PB3.Signal=GPIO_Input
@@ -388,6 +391,7 @@ PB8.Signal=GPIO_Input
 PC9.Signal=SDIO_D1
 PD9.Locked=true
 RCC.APB1Freq_Value=42000000
+VP_CRC_VS_CRC.Mode=CRC_Activate
 PB11.Locked=true
 ProjectManager.DeviceId=STM32F407VETx
 PB12.Signal=GPIO_Output