the other jimmy / mbed-sdk-tools

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Fork of mbed-sdk-tools by mbed official

add_fib.py@29:1210849dba19, 2016-08-29 (annotated)

Committer:
screamer
Date:
Mon Aug 29 11:18:36 2016 +0100
Revision:
29:1210849dba19
Port the latest tools patches from https://github.com/ARMmbed/mbed-os

Who changed what in which revision?

UserRevisionLine numberNew contents of line
screamer 29:1210849dba19 1 """
screamer 29:1210849dba19 2 @copyright (c) 2012 ON Semiconductor. All rights reserved.
screamer 29:1210849dba19 3 ON Semiconductor is supplying this software for use with ON Semiconductor
screamer 29:1210849dba19 4 processor based microcontrollers only.
screamer 29:1210849dba19 5 THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED
screamer 29:1210849dba19 6 OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
screamer 29:1210849dba19 7 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE.
screamer 29:1210849dba19 8 ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL,
screamer 29:1210849dba19 9 INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
screamer 29:1210849dba19 10 """
screamer 29:1210849dba19 11
screamer 29:1210849dba19 12 from __future__ import absolute_import
screamer 29:1210849dba19 13 from __future__ import print_function
screamer 29:1210849dba19 14
screamer 29:1210849dba19 15 import itertools
screamer 29:1210849dba19 16 import binascii
screamer 29:1210849dba19 17 import intelhex
screamer 29:1210849dba19 18
screamer 29:1210849dba19 19 FIB_BASE = 0x2000
screamer 29:1210849dba19 20 FLASH_BASE = 0x3000
screamer 29:1210849dba19 21 FW_REV = 0x01000100
screamer 29:1210849dba19 22 def ranges(i):
screamer 29:1210849dba19 23 for _, b in itertools.groupby(enumerate(i), lambda x_y: x_y[1] - x_y[0]):
screamer 29:1210849dba19 24 b = list(b)
screamer 29:1210849dba19 25 yield b[0][1], b[-1][1]
screamer 29:1210849dba19 26
screamer 29:1210849dba19 27
screamer 29:1210849dba19 28 def add_fib_at_start(arginput):
screamer 29:1210849dba19 29 input_file = arginput + ".bin"
screamer 29:1210849dba19 30 file_name_hex = arginput + "_fib.hex"
screamer 29:1210849dba19 31 file_name_bin = arginput + ".bin"
screamer 29:1210849dba19 32
screamer 29:1210849dba19 33 # Read in hex file
screamer 29:1210849dba19 34 input_hex_file = intelhex.IntelHex()
screamer 29:1210849dba19 35 input_hex_file.padding = 0x00
screamer 29:1210849dba19 36 input_hex_file.loadbin(input_file, offset=FLASH_BASE)
screamer 29:1210849dba19 37
screamer 29:1210849dba19 38 output_hex_file = intelhex.IntelHex()
screamer 29:1210849dba19 39 output_hex_file.padding = 0x00
screamer 29:1210849dba19 40
screamer 29:1210849dba19 41 # Get the starting and ending address
screamer 29:1210849dba19 42 addresses = input_hex_file.addresses()
screamer 29:1210849dba19 43 addresses.sort()
screamer 29:1210849dba19 44 start_end_pairs = list(ranges(addresses))
screamer 29:1210849dba19 45 regions = len(start_end_pairs)
screamer 29:1210849dba19 46
screamer 29:1210849dba19 47 if regions == 1:
screamer 29:1210849dba19 48 start, end = start_end_pairs[0]
screamer 29:1210849dba19 49 else:
screamer 29:1210849dba19 50 start = min(min(start_end_pairs))
screamer 29:1210849dba19 51 end = max(max(start_end_pairs))
screamer 29:1210849dba19 52
screamer 29:1210849dba19 53 assert start >= FLASH_BASE, ("Error - start 0x%x less than begining of user\
screamer 29:1210849dba19 54 flash area" %start)
screamer 29:1210849dba19 55 # Compute checksum over the range (don't include data at location of crc)
screamer 29:1210849dba19 56 size = end - start + 1
screamer 29:1210849dba19 57 data = input_hex_file.tobinarray(start=start, size=size)
screamer 29:1210849dba19 58 crc32 = binascii.crc32(data) & 0xFFFFFFFF
screamer 29:1210849dba19 59
screamer 29:1210849dba19 60 fw_rev = FW_REV
screamer 29:1210849dba19 61
screamer 29:1210849dba19 62 checksum = (start + size + crc32 + fw_rev) & 0xFFFFFFFF
screamer 29:1210849dba19 63
screamer 29:1210849dba19 64 print("Writing FIB: base 0x%08X, size 0x%08X, crc32 0x%08X, fw rev 0x%08X,\
screamer 29:1210849dba19 65 checksum 0x%08X" % (start, size, crc32, fw_rev, checksum))
screamer 29:1210849dba19 66
screamer 29:1210849dba19 67 #expected initial values used by daplink to validate that it is a valid bin
screamer 29:1210849dba19 68 #file added as dummy values in this file because the fib area preceeds the
screamer 29:1210849dba19 69 #application area the bootloader will ignore these dummy values
screamer 29:1210849dba19 70 # 00 is stack pointer (RAM address)
screamer 29:1210849dba19 71 # 04 is Reset vector (FLASH address)
screamer 29:1210849dba19 72 # 08 NMI_Handler (FLASH address)
screamer 29:1210849dba19 73 # 0C HardFault_Handler(FLASH address)
screamer 29:1210849dba19 74 # 10 dummy
screamer 29:1210849dba19 75 dummy_sp = 0x3FFFFC00
screamer 29:1210849dba19 76 dummy_reset_vector = 0x00003625
screamer 29:1210849dba19 77 dummy_nmi_handler = 0x00003761
screamer 29:1210849dba19 78 dummy_hardfault_handler = 0x00003691
screamer 29:1210849dba19 79 dummy_blank = 0x00000000
screamer 29:1210849dba19 80
screamer 29:1210849dba19 81 #expected fib structure
screamer 29:1210849dba19 82 #typedef struct fib{
screamer 29:1210849dba19 83 #uint32_t base; /**< Base offset of firmware, indicating what flash the
screamer 29:1210849dba19 84 # firmware is in. (will never be 0x11111111) */
screamer 29:1210849dba19 85 #uint32_t size; /**< Size of the firmware */
screamer 29:1210849dba19 86 #uint32_t crc; /**< CRC32 for firmware correctness check */
screamer 29:1210849dba19 87 #uint32_t rev; /**< Revision number */
screamer 29:1210849dba19 88 #uint32_t checksum; /**< Check-sum of information block */
screamer 29:1210849dba19 89 #}fib_t, *fib_pt;
screamer 29:1210849dba19 90
screamer 29:1210849dba19 91 fib_start = FIB_BASE
screamer 29:1210849dba19 92 dummy_fib_size = 20
screamer 29:1210849dba19 93 fib_size = 20
screamer 29:1210849dba19 94 user_code_start = FLASH_BASE
screamer 29:1210849dba19 95
screamer 29:1210849dba19 96 # Write FIB to the file in little endian
screamer 29:1210849dba19 97 output_hex_file[fib_start + 0] = (dummy_sp >> 0) & 0xFF
screamer 29:1210849dba19 98 output_hex_file[fib_start + 1] = (dummy_sp >> 8) & 0xFF
screamer 29:1210849dba19 99 output_hex_file[fib_start + 2] = (dummy_sp >> 16) & 0xFF
screamer 29:1210849dba19 100 output_hex_file[fib_start + 3] = (dummy_sp >> 24) & 0xFF
screamer 29:1210849dba19 101
screamer 29:1210849dba19 102 output_hex_file[fib_start + 4] = (dummy_reset_vector >> 0) & 0xFF
screamer 29:1210849dba19 103 output_hex_file[fib_start + 5] = (dummy_reset_vector >> 8) & 0xFF
screamer 29:1210849dba19 104 output_hex_file[fib_start + 6] = (dummy_reset_vector >> 16) & 0xFF
screamer 29:1210849dba19 105 output_hex_file[fib_start + 7] = (dummy_reset_vector >> 24) & 0xFF
screamer 29:1210849dba19 106
screamer 29:1210849dba19 107 output_hex_file[fib_start + 8] = (dummy_nmi_handler >> 0) & 0xFF
screamer 29:1210849dba19 108 output_hex_file[fib_start + 9] = (dummy_nmi_handler >> 8) & 0xFF
screamer 29:1210849dba19 109 output_hex_file[fib_start + 10] = (dummy_nmi_handler >> 16) & 0xFF
screamer 29:1210849dba19 110 output_hex_file[fib_start + 11] = (dummy_nmi_handler >> 24) & 0xFF
screamer 29:1210849dba19 111
screamer 29:1210849dba19 112 output_hex_file[fib_start + 12] = (dummy_hardfault_handler >> 0) & 0xFF
screamer 29:1210849dba19 113 output_hex_file[fib_start + 13] = (dummy_hardfault_handler >> 8) & 0xFF
screamer 29:1210849dba19 114 output_hex_file[fib_start + 14] = (dummy_hardfault_handler >> 16) & 0xFF
screamer 29:1210849dba19 115 output_hex_file[fib_start + 15] = (dummy_hardfault_handler >> 24) & 0xFF
screamer 29:1210849dba19 116
screamer 29:1210849dba19 117 output_hex_file[fib_start + 16] = (dummy_blank >> 0) & 0xFF
screamer 29:1210849dba19 118 output_hex_file[fib_start + 17] = (dummy_blank >> 8) & 0xFF
screamer 29:1210849dba19 119 output_hex_file[fib_start + 18] = (dummy_blank >> 16) & 0xFF
screamer 29:1210849dba19 120 output_hex_file[fib_start + 19] = (dummy_blank >> 24) & 0xFF
screamer 29:1210849dba19 121
screamer 29:1210849dba19 122 # Write FIB to the file in little endian
screamer 29:1210849dba19 123 output_hex_file[fib_start + 20] = (start >> 0) & 0xFF
screamer 29:1210849dba19 124 output_hex_file[fib_start + 21] = (start >> 8) & 0xFF
screamer 29:1210849dba19 125 output_hex_file[fib_start + 22] = (start >> 16) & 0xFF
screamer 29:1210849dba19 126 output_hex_file[fib_start + 23] = (start >> 24) & 0xFF
screamer 29:1210849dba19 127
screamer 29:1210849dba19 128 output_hex_file[fib_start + 24] = (size >> 0) & 0xFF
screamer 29:1210849dba19 129 output_hex_file[fib_start + 25] = (size >> 8) & 0xFF
screamer 29:1210849dba19 130 output_hex_file[fib_start + 26] = (size >> 16) & 0xFF
screamer 29:1210849dba19 131 output_hex_file[fib_start + 27] = (size >> 24) & 0xFF
screamer 29:1210849dba19 132
screamer 29:1210849dba19 133 output_hex_file[fib_start + 28] = (crc32 >> 0) & 0xFF
screamer 29:1210849dba19 134 output_hex_file[fib_start + 29] = (crc32 >> 8) & 0xFF
screamer 29:1210849dba19 135 output_hex_file[fib_start + 30] = (crc32 >> 16) & 0xFF
screamer 29:1210849dba19 136 output_hex_file[fib_start + 31] = (crc32 >> 24) & 0xFF
screamer 29:1210849dba19 137
screamer 29:1210849dba19 138 output_hex_file[fib_start + 32] = (fw_rev >> 0) & 0xFF
screamer 29:1210849dba19 139 output_hex_file[fib_start + 33] = (fw_rev >> 8) & 0xFF
screamer 29:1210849dba19 140 output_hex_file[fib_start + 34] = (fw_rev >> 16) & 0xFF
screamer 29:1210849dba19 141 output_hex_file[fib_start + 35] = (fw_rev >> 24) & 0xFF
screamer 29:1210849dba19 142
screamer 29:1210849dba19 143 output_hex_file[fib_start + 36] = (checksum >> 0) & 0xFF
screamer 29:1210849dba19 144 output_hex_file[fib_start + 37] = (checksum >> 8) & 0xFF
screamer 29:1210849dba19 145 output_hex_file[fib_start + 38] = (checksum >> 16) & 0xFF
screamer 29:1210849dba19 146 output_hex_file[fib_start + 39] = (checksum >> 24) & 0xFF
screamer 29:1210849dba19 147
screamer 29:1210849dba19 148 #pad the rest of the file
screamer 29:1210849dba19 149 for i in range(fib_start + dummy_fib_size + fib_size, user_code_start):
screamer 29:1210849dba19 150 output_hex_file[i] = 0xFF
screamer 29:1210849dba19 151
screamer 29:1210849dba19 152 #merge two hex files
screamer 29:1210849dba19 153 output_hex_file.merge(input_hex_file, overlap='error')
screamer 29:1210849dba19 154
screamer 29:1210849dba19 155 # Write out file(s)
screamer 29:1210849dba19 156 output_hex_file.tofile(file_name_hex, 'hex')
screamer 29:1210849dba19 157 output_hex_file.tofile(file_name_bin, 'bin')
screamer 29:1210849dba19 158