C# BIN文件读取以及CRC校验(匹配STM32F103)

这一篇文章的主要目的还是为STM32F103的Firmware升级服务，在之前的文章中（STM32F103 BootLoader实现1（BootLoader跳转到Application））有提到，STM32F103在开发BootLoader的过程中，判断BootLoader是否要跳转到Application，最好能够对Application的Firmware进行CRC校验，这样就能确保Application的Firmware的正确性，毕竟Application的Firmware是开发出来的，可以让用户在线升级，那么升级如果失败，STM32的BootLoader如果不知道的话，就可能程序跑飞。如果增加了CRC校验，如果Firmware升级不成功，那么Firmware就一直停留在BootLoader，用户可以重新Download Firmware来“救活”下位机。

STM32F103中的CRC值计算有库函数，比较方便，如下面代码所示：

#define APP_RUN_BASEADDR   0x8008400    //32K for Bootloader, and another space for APP
#define APP_CRC_BASEADDR   0x8008000    //芯片Application Firmware的CRC值存储地址
#define APP_FLASH_RANGE    (470*1024)     // 从0x8008000到0x8008400的1K空间作为配置信息的存储空间，保存CRC校验值等

uint8_t flash_crc_check()
{
	uint8_t status=0x00;
	uint32_t cal_crc=0x00,store_crc=0x00;
	uint32_t index;      /* CRC input data buffer index */
	/* Change CRC peripheral state */
	hcrc.State = HAL_CRC_STATE_BUSY;
	/* Reset CRC Calculation Unit (hcrc->Instance->INIT is
	*  written in hcrc->Instance->DR) */
	hcrc.Instance->CR |= CRC_CR_RESET;
	/* Enter 32-bit input data to the CRC calculator */
	for (index = 0U; index < APP_FLASH_RANGE; )
	{
	  hcrc.Instance->DR = *(__IO uint32_t *)(APP_RUN_BASEADDR+index);

	  index = index+4;
	}
	cal_crc = hcrc.Instance->DR;
	store_crc = *(__IO uint32_t *)(APP_CRC_BASEADDR);
	if(cal_crc == store_crc)
	{
		status = 0x01;
    //计算Application出来的CRC值与存储在芯片里面的CRC值一致
	}

	/* Change CRC peripheral state */
	hcrc.State = HAL_CRC_STATE_READY;
	return status;
}

STM32的CRC值计算不需要我们过多的干预，只需要将数据放入寄存器即可。那么Application的CRC值具体是多少，如果用C#做的程序可以方便地算出，那么我们只需要把Application的FW编译出来的BIN文件导入到程序然后算出CRC值，之后更新到Application的Firmware就可以了，这样也方便了很多。

那么C#如何读取BIN文件并且算出与STM32F103一致的CRC值呢？

直接上代码：

private string file_path=String.Empty;

private void check_crc_value()
{
  file_path = "  "//文件的路径
  if (file_path != String.Empty)//需要确保文件路径不为空
  {
    UInt32 crc_value = 0xFFFFFFFF;
    try//需要确保文件数据格式等正确
    {
      FileStream bin_file = new FileStream(FilePath.Text, FileMode.Open);//打开BIN文件
      BinaryReader bin_reader = new BinaryReader(bin_file);//实例化BIN READER
      UInt32[] src_data = new UInt32[256];
      int data_length = 0;
      bin_reader.ReadBytes(1024); //BIN文件前面1K数据为配置数据不参与CRC计算，因此舍弃掉；
      for (long temp = 0; temp < (bin_file.Length - 1024) / 4; temp++)
      {
        byte[] data_temp = new byte[4];
        if (data_length < 256)
        {
          //每1K Bytes进行CRC计算，因此先对数据进行重新整合
          data_temp = bin_reader.ReadBytes(4);
          src_data[data_length] = (UInt32)(0x00000000 | data_temp[0] | (data_temp[1] << 8) | (data_temp[2] << 16) | (data_temp[3] << 24));
        }
        else
        {
          //1K Bytes 数据整合之后计算CRC值
          crc_value = gen_crc32(false, crc_value, src_data, 256);
          data_length = 0;
          data_temp = bin_reader.ReadBytes(4);
          src_data[data_length] = (UInt32)(0x00000000 | data_temp[0] | (data_temp[1] << 8) | (data_temp[2] << 16) | (data_temp[3] << 24));
        }
        data_length++;
      }
      //对数据进行补偿，即BIN.Length之后的数据补充为0XFF。整个文件大小为480*1024Bytes
      if ((bin_file.Length) < 480 * 1024)
      {
        int data_fill_length=0;
        if (data_length < 256)
        {
          data_fill_length = 256 - data_length;
          for (int temp = 0; temp < data_fill_length; temp++)
          {
            src_data[data_length] = 0xFFFFFFFF;
            data_length++;
          }
          crc_value = gen_crc32(false, crc_value, src_data, 256);
        }
        else
        {
          crc_value = gen_crc32(false, crc_value, src_data, 256);
        }
        if ((bin_file.Length + data_fill_length * 4) < 480 * 1024)
        {
          for (int temp = 0; temp < 256; temp++)
          {
            src_data[temp] = 0xFFFFFFFF;
          }
          for (long temp = 0; temp < (470 * 1024 - bin_file.Length - data_fill_length * 4) / 4/256+1; temp++)
          {
            crc_value = gen_crc32(false, crc_value, src_data, 256);
          }
        }
        MessageInfo.AppendText("File CRC calculated value: 0x" + crc_value.ToString("X8")+"\r\n");
      }
      else
      {
        MessageInfo.AppendText("File CRC calculated value: Error" +"\r\n");
      }
      
      bin_file.Flush();
      bin_file.Close();
    }
    catch
    {
      MessageInfo.AppendText("File Checksum calculate failed!(File Open Failed!)\r\n");
    }
  }
}

//产生CRC值，src_data为源数据，data_length为数据长度，crc_value 上一次的CRC值
private UInt32 gen_crc32(bool reset_flag, UInt32 crc_value,UInt32[] src_data, UInt32 data_length)
{
  const UInt32 st_crc32_const = 0x04C11db7;
  UInt32 xbit, bits, i;
  UInt32 crc_initial_value;
  if (reset_flag)
  {
    crc_initial_value = 0xFFFFFFFF;
  }
  else
  {
    crc_initial_value = crc_value;
  }
  for (i = 0; i < data_length; i++)
  {
    xbit = 0x80000000;
    for (bits = 0; bits < 32; bits++)
    {
      if ((crc_initial_value & 0x80000000) == 0x80000000)
      {
        crc_initial_value <<= 1;
        crc_initial_value ^= st_crc32_const;
      }
      else
      {
        crc_initial_value <<= 1;
      }
      if ((src_data[i] & xbit) == xbit)
      {
        crc_initial_value ^= st_crc32_const;
      }
      xbit >>= 1;
    } 
  }
  return crc_initial_value;
}

上述代码已经验证没有问题，与STM32F103可以匹配。这样，Application编译之后的BIN文件，导入到C#开发的程序，计算出CRC值，然后将CRC值填入到对应的Application的配置参数区域，这样，Application重新编译，然后Application的Firmware就完整了，并且可以实现Application的Firmware的CRC校验。