tools/dfu-sign.c

   1 /*
   2  *      Sign firmware for our DFU boot-loader
   3  *
   4  *      (c) 2020 Martin Mareš <mj@ucw.cz>
   5  */
   6
   7 #include <ucw/lib.h>
   8 #include <ucw/opt.h>
   9 #include <ucw/unaligned.h>
  10 #include <fcntl.h>
  11 #include <string.h>
  12 #include <unistd.h>
  13 #include <zlib.h>
  14
  15 static char *in_name;
  16 static char *out_name;
  17
  18 static const struct opt_section options = {
  19         OPT_ITEMS {
  20                 OPT_HELP("A simple tool for signing firmware for UCW STM32 DFU bootloader."),
  21                 OPT_HELP("Usage: dfu-sign [options] <input> <output>"),
  22                 OPT_STRING(OPT_POSITIONAL(1), NULL, in_name, OPT_REQUIRED, ""),
  23                 OPT_STRING(OPT_POSITIONAL(2), NULL, out_name, OPT_REQUIRED, ""),
  24                 OPT_HELP(""),
  25                 OPT_HELP("Options:"),
  26                 OPT_HELP_OPTION,
  27                 OPT_END
  28         }
  29 };
  30
  31 struct fw_header {
  32         // The header lives in unused space between interrupt vectors
  33         byte vectors[0x1c];
  34         u32 length;             // Firmware length in bytes, divisible by 4
  35                                 // (excluding CRC appended at the end)
  36         u16 flash_in_progress;  // Temporarily non-zero during flashing
  37         u16 rfu1;
  38         u32 rfu2;
  39         u32 rfu3;
  40 };
  41
  42 struct dfu_trailer {
  43         u16 fw_version;
  44         u16 product_id;
  45         u16 vendor_id;
  46         u16 dfu_version;
  47         byte dfu_sig[3];
  48         byte trailer_len;
  49         u32 crc;                // CRC of the whole file except this field
  50 };
  51
  52 static byte *firmware;
  53 static uint firmware_len;       // Without CRC and trailer
  54 static struct fw_header *header;
  55 static struct dfu_trailer *trailer;
  56
  57 /*** CRC used in DFU ***/
  58
  59 static const u32 crc32_table[256] = {
  60     0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
  61     0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
  62     0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
  63     0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
  64     0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
  65     0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
  66     0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
  67     0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
  68     0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
  69     0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
  70     0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
  71     0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
  72     0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
  73     0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
  74     0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
  75     0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
  76     0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
  77     0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
  78     0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
  79     0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
  80     0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
  81     0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
  82     0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
  83     0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
  84     0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
  85     0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
  86     0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
  87     0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
  88     0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
  89     0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
  90     0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
  91     0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
  92     0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
  93     0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
  94     0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
  95     0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
  96     0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
  97     0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
  98     0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
  99     0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
 100     0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
 101     0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
 102     0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d};
 103
 104 static u32 dfu_update_crc(u32 crc, byte x)
 105 {
 106         return crc32_table[(crc ^ x) & 0xff] ^ (crc >> 8);
 107 }
 108
 109 static u32 dfu_crc(byte *buf, uint len)
 110 {
 111         u32 crc = 0xffffffff;
 112         for (uint i = 0; i < len; i++)
 113                 crc = dfu_update_crc(crc, buf[i]);
 114         return crc;
 115 }
 116
 117 /*** CRC implemented in STM32F1 hardware ***/
 118
 119 static const u32 stm_crc_table[256] = {
 120         0x00000000, 0x04c11db7, 0x09823b6e, 0x0d4326d9, 0x130476dc, 0x17c56b6b, 0x1a864db2, 0x1e475005,
 121         0x2608edb8, 0x22c9f00f, 0x2f8ad6d6, 0x2b4bcb61, 0x350c9b64, 0x31cd86d3, 0x3c8ea00a, 0x384fbdbd,
 122         0x4c11db70, 0x48d0c6c7, 0x4593e01e, 0x4152fda9, 0x5f15adac, 0x5bd4b01b, 0x569796c2, 0x52568b75,
 123         0x6a1936c8, 0x6ed82b7f, 0x639b0da6, 0x675a1011, 0x791d4014, 0x7ddc5da3, 0x709f7b7a, 0x745e66cd,
 124         0x9823b6e0, 0x9ce2ab57, 0x91a18d8e, 0x95609039, 0x8b27c03c, 0x8fe6dd8b, 0x82a5fb52, 0x8664e6e5,
 125         0xbe2b5b58, 0xbaea46ef, 0xb7a96036, 0xb3687d81, 0xad2f2d84, 0xa9ee3033, 0xa4ad16ea, 0xa06c0b5d,
 126         0xd4326d90, 0xd0f37027, 0xddb056fe, 0xd9714b49, 0xc7361b4c, 0xc3f706fb, 0xceb42022, 0xca753d95,
 127         0xf23a8028, 0xf6fb9d9f, 0xfbb8bb46, 0xff79a6f1, 0xe13ef6f4, 0xe5ffeb43, 0xe8bccd9a, 0xec7dd02d,
 128         0x34867077, 0x30476dc0, 0x3d044b19, 0x39c556ae, 0x278206ab, 0x23431b1c, 0x2e003dc5, 0x2ac12072,
 129         0x128e9dcf, 0x164f8078, 0x1b0ca6a1, 0x1fcdbb16, 0x018aeb13, 0x054bf6a4, 0x0808d07d, 0x0cc9cdca,
 130         0x7897ab07, 0x7c56b6b0, 0x71159069, 0x75d48dde, 0x6b93dddb, 0x6f52c06c, 0x6211e6b5, 0x66d0fb02,
 131         0x5e9f46bf, 0x5a5e5b08, 0x571d7dd1, 0x53dc6066, 0x4d9b3063, 0x495a2dd4, 0x44190b0d, 0x40d816ba,
 132         0xaca5c697, 0xa864db20, 0xa527fdf9, 0xa1e6e04e, 0xbfa1b04b, 0xbb60adfc, 0xb6238b25, 0xb2e29692,
 133         0x8aad2b2f, 0x8e6c3698, 0x832f1041, 0x87ee0df6, 0x99a95df3, 0x9d684044, 0x902b669d, 0x94ea7b2a,
 134         0xe0b41de7, 0xe4750050, 0xe9362689, 0xedf73b3e, 0xf3b06b3b, 0xf771768c, 0xfa325055, 0xfef34de2,
 135         0xc6bcf05f, 0xc27dede8, 0xcf3ecb31, 0xcbffd686, 0xd5b88683, 0xd1799b34, 0xdc3abded, 0xd8fba05a,
 136         0x690ce0ee, 0x6dcdfd59, 0x608edb80, 0x644fc637, 0x7a089632, 0x7ec98b85, 0x738aad5c, 0x774bb0eb,
 137         0x4f040d56, 0x4bc510e1, 0x46863638, 0x42472b8f, 0x5c007b8a, 0x58c1663d, 0x558240e4, 0x51435d53,
 138         0x251d3b9e, 0x21dc2629, 0x2c9f00f0, 0x285e1d47, 0x36194d42, 0x32d850f5, 0x3f9b762c, 0x3b5a6b9b,
 139         0x0315d626, 0x07d4cb91, 0x0a97ed48, 0x0e56f0ff, 0x1011a0fa, 0x14d0bd4d, 0x19939b94, 0x1d528623,
 140         0xf12f560e, 0xf5ee4bb9, 0xf8ad6d60, 0xfc6c70d7, 0xe22b20d2, 0xe6ea3d65, 0xeba91bbc, 0xef68060b,
 141         0xd727bbb6, 0xd3e6a601, 0xdea580d8, 0xda649d6f, 0xc423cd6a, 0xc0e2d0dd, 0xcda1f604, 0xc960ebb3,
 142         0xbd3e8d7e, 0xb9ff90c9, 0xb4bcb610, 0xb07daba7, 0xae3afba2, 0xaafbe615, 0xa7b8c0cc, 0xa379dd7b,
 143         0x9b3660c6, 0x9ff77d71, 0x92b45ba8, 0x9675461f, 0x8832161a, 0x8cf30bad, 0x81b02d74, 0x857130c3,
 144         0x5d8a9099, 0x594b8d2e, 0x5408abf7, 0x50c9b640, 0x4e8ee645, 0x4a4ffbf2, 0x470cdd2b, 0x43cdc09c,
 145         0x7b827d21, 0x7f436096, 0x7200464f, 0x76c15bf8, 0x68860bfd, 0x6c47164a, 0x61043093, 0x65c52d24,
 146         0x119b4be9, 0x155a565e, 0x18197087, 0x1cd86d30, 0x029f3d35, 0x065e2082, 0x0b1d065b, 0x0fdc1bec,
 147         0x3793a651, 0x3352bbe6, 0x3e119d3f, 0x3ad08088, 0x2497d08d, 0x2056cd3a, 0x2d15ebe3, 0x29d4f654,
 148         0xc5a92679, 0xc1683bce, 0xcc2b1d17, 0xc8ea00a0, 0xd6ad50a5, 0xd26c4d12, 0xdf2f6bcb, 0xdbee767c,
 149         0xe3a1cbc1, 0xe760d676, 0xea23f0af, 0xeee2ed18, 0xf0a5bd1d, 0xf464a0aa, 0xf9278673, 0xfde69bc4,
 150         0x89b8fd09, 0x8d79e0be, 0x803ac667, 0x84fbdbd0, 0x9abc8bd5, 0x9e7d9662, 0x933eb0bb, 0x97ffad0c,
 151         0xafb010b1, 0xab710d06, 0xa6322bdf, 0xa2f33668, 0xbcb4666d, 0xb8757bda, 0xb5365d03, 0xb1f740b4,
 152 };
 153
 154 static u32 stm_update_crc(u32 crc, byte x)
 155 {
 156         return (crc << 8) ^ stm_crc_table[0xff & ((crc >> 24) ^ x)];
 157 }
 158
 159 static u32 stm32_crc(byte *buf, uint len)
 160 {
 161         u32 crc = 0xffffffff;
 162         for (uint i = 0; i < len; i += 4) {
 163                 crc = stm_update_crc(crc, buf[i+3]);
 164                 crc = stm_update_crc(crc, buf[i+2]);
 165                 crc = stm_update_crc(crc, buf[i+1]);
 166                 crc = stm_update_crc(crc, buf[i+0]);
 167         }
 168         return crc;
 169 }
 170
 171 static void read_fw(void)
 172 {
 173         int fd = open(in_name, O_RDONLY);
 174         if (fd < 0)
 175                 die("Cannot open %s: %m", in_name);
 176
 177         firmware_len = lseek(fd, 0, SEEK_END);
 178         lseek(fd, 0, SEEK_SET);
 179         while (firmware_len % 4)
 180                 firmware_len++;
 181
 182         firmware = xmalloc_zero(firmware_len + 4 + sizeof(struct dfu_trailer));
 183         header = (struct fw_header *)firmware;
 184         trailer = (struct dfu_trailer *)(firmware + firmware_len + 4);
 185
 186         if (read(fd, firmware, firmware_len) != (int) firmware_len)
 187                 die("Error reading %s: %m", in_name);
 188
 189         close(fd);
 190 }
 191
 192 static void build_header_and_crc(void)
 193 {
 194         put_u32_le(&header->length, firmware_len);
 195         header->rfu1 = 0;
 196         header->rfu2 = 0;
 197         header->rfu3 = 0;
 198
 199         put_u32_le(firmware + firmware_len, stm32_crc(firmware, firmware_len));
 200 }
 201
 202 static void build_trailer(void)
 203 {
 204         struct dfu_trailer *t = trailer;
 205
 206         t->trailer_len = sizeof(struct dfu_trailer);
 207         memcpy(t->dfu_sig, "ufd", 3);
 208         put_u16_le(&t->dfu_version, 0x0100);
 209         put_u16_le(&t->vendor_id, 0xffff);              // fixme
 210         put_u16_le(&t->product_id, 0xffff);
 211         put_u16_le(&t->fw_version, 0xffff);
 212         put_u32_le(&t->crc, dfu_crc(firmware, firmware_len + 4 + t->trailer_len - 4));
 213 }
 214
 215 static void write_out(void)
 216 {
 217         int fd = open(out_name, O_WRONLY | O_CREAT | O_TRUNC, 0666);
 218         if (fd < 0)
 219                 die("Cannot create %s: %m", out_name);
 220
 221         int len = firmware_len + 4 + sizeof(struct dfu_trailer);
 222         if (write(fd, firmware, len) != len)
 223                 die("Error writing %s: %m", out_name);
 224
 225         close(fd);
 226 }
 227
 228 int main(int argc UNUSED, char **argv)
 229 {
 230         opt_parse(&options, argv+1);
 231         read_fw();
 232         build_header_and_crc();
 233         build_trailer();
 234         write_out();
 235
 236         return 0;
 237 }