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
add_fib.py@31:182518299918, 2017-01-04 (annotated)
- Committer:
- The Other Jimmy
- Date:
- Wed Jan 04 11:58:24 2017 -0600
- Revision:
- 31:182518299918
Update tools to follow mbed-os tools release 5.3.1
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
The Other Jimmy |
31:182518299918 | 1 | """ |
The Other Jimmy |
31:182518299918 | 2 | @copyright (c) 2012 ON Semiconductor. All rights reserved. |
The Other Jimmy |
31:182518299918 | 3 | ON Semiconductor is supplying this software for use with ON Semiconductor |
The Other Jimmy |
31:182518299918 | 4 | processor based microcontrollers only. |
The Other Jimmy |
31:182518299918 | 5 | THIS SOFTWARE IS PROVIDED "AS IS". NO WARRANTIES, WHETHER EXPRESS, IMPLIED |
The Other Jimmy |
31:182518299918 | 6 | OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF |
The Other Jimmy |
31:182518299918 | 7 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. |
The Other Jimmy |
31:182518299918 | 8 | ON SEMICONDUCTOR SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, |
The Other Jimmy |
31:182518299918 | 9 | INCIDENTAL, OR CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER. |
The Other Jimmy |
31:182518299918 | 10 | """ |
The Other Jimmy |
31:182518299918 | 11 | |
The Other Jimmy |
31:182518299918 | 12 | from __future__ import absolute_import |
The Other Jimmy |
31:182518299918 | 13 | from __future__ import print_function |
The Other Jimmy |
31:182518299918 | 14 | |
The Other Jimmy |
31:182518299918 | 15 | import itertools |
The Other Jimmy |
31:182518299918 | 16 | import binascii |
The Other Jimmy |
31:182518299918 | 17 | import intelhex |
The Other Jimmy |
31:182518299918 | 18 | from tools.config import Config |
The Other Jimmy |
31:182518299918 | 19 | |
The Other Jimmy |
31:182518299918 | 20 | FIB_BASE = 0x2000 |
The Other Jimmy |
31:182518299918 | 21 | FLASH_BASE = 0x3000 |
The Other Jimmy |
31:182518299918 | 22 | FW_REV = 0x01000100 |
The Other Jimmy |
31:182518299918 | 23 | TRIM_BASE = 0x2800 |
The Other Jimmy |
31:182518299918 | 24 | |
The Other Jimmy |
31:182518299918 | 25 | def ranges(i): |
The Other Jimmy |
31:182518299918 | 26 | for _, b in itertools.groupby(enumerate(i), lambda x_y: x_y[1] - x_y[0]): |
The Other Jimmy |
31:182518299918 | 27 | b = list(b) |
The Other Jimmy |
31:182518299918 | 28 | yield b[0][1], b[-1][1] |
The Other Jimmy |
31:182518299918 | 29 | |
The Other Jimmy |
31:182518299918 | 30 | |
The Other Jimmy |
31:182518299918 | 31 | def add_fib_at_start(arginput): |
The Other Jimmy |
31:182518299918 | 32 | input_file = arginput + ".bin" |
The Other Jimmy |
31:182518299918 | 33 | file_name_hex = arginput + "_fib.hex" |
The Other Jimmy |
31:182518299918 | 34 | file_name_bin = arginput + ".bin" |
The Other Jimmy |
31:182518299918 | 35 | |
The Other Jimmy |
31:182518299918 | 36 | # Read in hex file |
The Other Jimmy |
31:182518299918 | 37 | input_hex_file = intelhex.IntelHex() |
The Other Jimmy |
31:182518299918 | 38 | input_hex_file.padding = 0x00 |
The Other Jimmy |
31:182518299918 | 39 | input_hex_file.loadbin(input_file, offset=FLASH_BASE) |
The Other Jimmy |
31:182518299918 | 40 | |
The Other Jimmy |
31:182518299918 | 41 | output_hex_file = intelhex.IntelHex() |
The Other Jimmy |
31:182518299918 | 42 | output_hex_file.padding = 0x00 |
The Other Jimmy |
31:182518299918 | 43 | |
The Other Jimmy |
31:182518299918 | 44 | # Get the starting and ending address |
The Other Jimmy |
31:182518299918 | 45 | addresses = input_hex_file.addresses() |
The Other Jimmy |
31:182518299918 | 46 | addresses.sort() |
The Other Jimmy |
31:182518299918 | 47 | start_end_pairs = list(ranges(addresses)) |
The Other Jimmy |
31:182518299918 | 48 | regions = len(start_end_pairs) |
The Other Jimmy |
31:182518299918 | 49 | |
The Other Jimmy |
31:182518299918 | 50 | if regions == 1: |
The Other Jimmy |
31:182518299918 | 51 | start, end = start_end_pairs[0] |
The Other Jimmy |
31:182518299918 | 52 | else: |
The Other Jimmy |
31:182518299918 | 53 | start = min(min(start_end_pairs)) |
The Other Jimmy |
31:182518299918 | 54 | end = max(max(start_end_pairs)) |
The Other Jimmy |
31:182518299918 | 55 | |
The Other Jimmy |
31:182518299918 | 56 | assert start >= FLASH_BASE, ("Error - start 0x%x less than begining of user\ |
The Other Jimmy |
31:182518299918 | 57 | flash area" %start) |
The Other Jimmy |
31:182518299918 | 58 | # Compute checksum over the range (don't include data at location of crc) |
The Other Jimmy |
31:182518299918 | 59 | size = end - start + 1 |
The Other Jimmy |
31:182518299918 | 60 | data = input_hex_file.tobinarray(start=start, size=size) |
The Other Jimmy |
31:182518299918 | 61 | crc32 = binascii.crc32(data) & 0xFFFFFFFF |
The Other Jimmy |
31:182518299918 | 62 | |
The Other Jimmy |
31:182518299918 | 63 | fw_rev = FW_REV |
The Other Jimmy |
31:182518299918 | 64 | |
The Other Jimmy |
31:182518299918 | 65 | checksum = (start + size + crc32 + fw_rev) & 0xFFFFFFFF |
The Other Jimmy |
31:182518299918 | 66 | |
The Other Jimmy |
31:182518299918 | 67 | print("Writing FIB: base 0x%08X, size 0x%08X, crc32 0x%08X, fw rev 0x%08X,\ |
The Other Jimmy |
31:182518299918 | 68 | checksum 0x%08X" % (start, size, crc32, fw_rev, checksum)) |
The Other Jimmy |
31:182518299918 | 69 | |
The Other Jimmy |
31:182518299918 | 70 | #expected initial values used by daplink to validate that it is a valid bin |
The Other Jimmy |
31:182518299918 | 71 | #file added as dummy values in this file because the fib area preceeds the |
The Other Jimmy |
31:182518299918 | 72 | #application area the bootloader will ignore these dummy values |
The Other Jimmy |
31:182518299918 | 73 | # 00 is stack pointer (RAM address) |
The Other Jimmy |
31:182518299918 | 74 | # 04 is Reset vector (FLASH address) |
The Other Jimmy |
31:182518299918 | 75 | # 08 NMI_Handler (FLASH address) |
The Other Jimmy |
31:182518299918 | 76 | # 0C HardFault_Handler(FLASH address) |
The Other Jimmy |
31:182518299918 | 77 | # 10 dummy |
The Other Jimmy |
31:182518299918 | 78 | dummy_sp = 0x3FFFFC00 |
The Other Jimmy |
31:182518299918 | 79 | dummy_reset_vector = 0x00003625 |
The Other Jimmy |
31:182518299918 | 80 | dummy_nmi_handler = 0x00003761 |
The Other Jimmy |
31:182518299918 | 81 | dummy_hardfault_handler = 0x00003691 |
The Other Jimmy |
31:182518299918 | 82 | dummy_blank = 0x00000000 |
The Other Jimmy |
31:182518299918 | 83 | |
The Other Jimmy |
31:182518299918 | 84 | #expected fib structure |
The Other Jimmy |
31:182518299918 | 85 | #typedef struct fib{ |
The Other Jimmy |
31:182518299918 | 86 | #uint32_t base; /**< Base offset of firmware, indicating what flash the |
The Other Jimmy |
31:182518299918 | 87 | # firmware is in. (will never be 0x11111111) */ |
The Other Jimmy |
31:182518299918 | 88 | #uint32_t size; /**< Size of the firmware */ |
The Other Jimmy |
31:182518299918 | 89 | #uint32_t crc; /**< CRC32 for firmware correctness check */ |
The Other Jimmy |
31:182518299918 | 90 | #uint32_t rev; /**< Revision number */ |
The Other Jimmy |
31:182518299918 | 91 | #uint32_t checksum; /**< Check-sum of information block */ |
The Other Jimmy |
31:182518299918 | 92 | #}fib_t, *fib_pt; |
The Other Jimmy |
31:182518299918 | 93 | |
The Other Jimmy |
31:182518299918 | 94 | fib_start = FIB_BASE |
The Other Jimmy |
31:182518299918 | 95 | dummy_fib_size = 20 |
The Other Jimmy |
31:182518299918 | 96 | fib_size = 20 |
The Other Jimmy |
31:182518299918 | 97 | trim_size = 24 |
The Other Jimmy |
31:182518299918 | 98 | user_code_start = FLASH_BASE |
The Other Jimmy |
31:182518299918 | 99 | trim_area_start = TRIM_BASE |
The Other Jimmy |
31:182518299918 | 100 | |
The Other Jimmy |
31:182518299918 | 101 | # Write FIB to the file in little endian |
The Other Jimmy |
31:182518299918 | 102 | output_hex_file[fib_start + 0] = (dummy_sp >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 103 | output_hex_file[fib_start + 1] = (dummy_sp >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 104 | output_hex_file[fib_start + 2] = (dummy_sp >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 105 | output_hex_file[fib_start + 3] = (dummy_sp >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 106 | |
The Other Jimmy |
31:182518299918 | 107 | output_hex_file[fib_start + 4] = (dummy_reset_vector >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 108 | output_hex_file[fib_start + 5] = (dummy_reset_vector >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 109 | output_hex_file[fib_start + 6] = (dummy_reset_vector >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 110 | output_hex_file[fib_start + 7] = (dummy_reset_vector >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 111 | |
The Other Jimmy |
31:182518299918 | 112 | output_hex_file[fib_start + 8] = (dummy_nmi_handler >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 113 | output_hex_file[fib_start + 9] = (dummy_nmi_handler >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 114 | output_hex_file[fib_start + 10] = (dummy_nmi_handler >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 115 | output_hex_file[fib_start + 11] = (dummy_nmi_handler >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 116 | |
The Other Jimmy |
31:182518299918 | 117 | output_hex_file[fib_start + 12] = (dummy_hardfault_handler >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 118 | output_hex_file[fib_start + 13] = (dummy_hardfault_handler >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 119 | output_hex_file[fib_start + 14] = (dummy_hardfault_handler >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 120 | output_hex_file[fib_start + 15] = (dummy_hardfault_handler >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 121 | |
The Other Jimmy |
31:182518299918 | 122 | output_hex_file[fib_start + 16] = (dummy_blank >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 123 | output_hex_file[fib_start + 17] = (dummy_blank >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 124 | output_hex_file[fib_start + 18] = (dummy_blank >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 125 | output_hex_file[fib_start + 19] = (dummy_blank >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 126 | |
The Other Jimmy |
31:182518299918 | 127 | # Write FIB to the file in little endian |
The Other Jimmy |
31:182518299918 | 128 | output_hex_file[fib_start + 20] = (start >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 129 | output_hex_file[fib_start + 21] = (start >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 130 | output_hex_file[fib_start + 22] = (start >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 131 | output_hex_file[fib_start + 23] = (start >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 132 | |
The Other Jimmy |
31:182518299918 | 133 | output_hex_file[fib_start + 24] = (size >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 134 | output_hex_file[fib_start + 25] = (size >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 135 | output_hex_file[fib_start + 26] = (size >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 136 | output_hex_file[fib_start + 27] = (size >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 137 | |
The Other Jimmy |
31:182518299918 | 138 | output_hex_file[fib_start + 28] = (crc32 >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 139 | output_hex_file[fib_start + 29] = (crc32 >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 140 | output_hex_file[fib_start + 30] = (crc32 >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 141 | output_hex_file[fib_start + 31] = (crc32 >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 142 | |
The Other Jimmy |
31:182518299918 | 143 | output_hex_file[fib_start + 32] = (fw_rev >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 144 | output_hex_file[fib_start + 33] = (fw_rev >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 145 | output_hex_file[fib_start + 34] = (fw_rev >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 146 | output_hex_file[fib_start + 35] = (fw_rev >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 147 | |
The Other Jimmy |
31:182518299918 | 148 | output_hex_file[fib_start + 36] = (checksum >> 0) & 0xFF |
The Other Jimmy |
31:182518299918 | 149 | output_hex_file[fib_start + 37] = (checksum >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 150 | output_hex_file[fib_start + 38] = (checksum >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 151 | output_hex_file[fib_start + 39] = (checksum >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 152 | |
The Other Jimmy |
31:182518299918 | 153 | #pad the rest of the file |
The Other Jimmy |
31:182518299918 | 154 | for i in range(fib_start + dummy_fib_size + fib_size, trim_area_start): |
The Other Jimmy |
31:182518299918 | 155 | output_hex_file[i] = 0xFF |
The Other Jimmy |
31:182518299918 | 156 | |
The Other Jimmy |
31:182518299918 | 157 | # Read in configuration data from the config parameter in targets.json |
The Other Jimmy |
31:182518299918 | 158 | configData = Config('NCS36510') |
The Other Jimmy |
31:182518299918 | 159 | paramData = configData.get_target_config_data() |
The Other Jimmy |
31:182518299918 | 160 | for v in paramData.values(): |
The Other Jimmy |
31:182518299918 | 161 | if (v.name == "target.mac-addr-high"): |
The Other Jimmy |
31:182518299918 | 162 | mac_addr_high = int(v.value, 16) |
The Other Jimmy |
31:182518299918 | 163 | elif (v.name == "target.mac-addr-low"): |
The Other Jimmy |
31:182518299918 | 164 | mac_addr_low = int(v.value,16) |
The Other Jimmy |
31:182518299918 | 165 | elif (v.name == "target.32KHz-clk-trim"): |
The Other Jimmy |
31:182518299918 | 166 | clk_32k_trim = int(v.value,16) |
The Other Jimmy |
31:182518299918 | 167 | elif (v.name == "target.32MHz-clk-trim"): |
The Other Jimmy |
31:182518299918 | 168 | clk_32m_trim = int(v.value,16) |
The Other Jimmy |
31:182518299918 | 169 | elif (v.name == "target.rssi-trim"): |
The Other Jimmy |
31:182518299918 | 170 | rssi = int(v.value,16) |
The Other Jimmy |
31:182518299918 | 171 | elif (v.name == "target.txtune-trim"): |
The Other Jimmy |
31:182518299918 | 172 | txtune = int(v.value,16) |
The Other Jimmy |
31:182518299918 | 173 | else: |
The Other Jimmy |
31:182518299918 | 174 | print("Not a valid param") |
The Other Jimmy |
31:182518299918 | 175 | |
The Other Jimmy |
31:182518299918 | 176 | output_hex_file[trim_area_start + 0] = mac_addr_low & 0xFF |
The Other Jimmy |
31:182518299918 | 177 | output_hex_file[trim_area_start + 1] = (mac_addr_low >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 178 | output_hex_file[trim_area_start + 2] = (mac_addr_low >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 179 | output_hex_file[trim_area_start + 3] = (mac_addr_low >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 180 | |
The Other Jimmy |
31:182518299918 | 181 | output_hex_file[trim_area_start + 4] = mac_addr_high & 0xFF |
The Other Jimmy |
31:182518299918 | 182 | output_hex_file[trim_area_start + 5] = (mac_addr_high >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 183 | output_hex_file[trim_area_start + 6] = (mac_addr_high >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 184 | output_hex_file[trim_area_start + 7] = (mac_addr_high >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 185 | |
The Other Jimmy |
31:182518299918 | 186 | output_hex_file[trim_area_start + 8] = clk_32k_trim & 0xFF |
The Other Jimmy |
31:182518299918 | 187 | output_hex_file[trim_area_start + 9] = (clk_32k_trim >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 188 | output_hex_file[trim_area_start + 10] = (clk_32k_trim >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 189 | output_hex_file[trim_area_start + 11] = (clk_32k_trim >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 190 | |
The Other Jimmy |
31:182518299918 | 191 | output_hex_file[trim_area_start + 12] = clk_32m_trim & 0xFF |
The Other Jimmy |
31:182518299918 | 192 | output_hex_file[trim_area_start + 13] = (clk_32m_trim >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 193 | output_hex_file[trim_area_start + 14] = (clk_32m_trim >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 194 | output_hex_file[trim_area_start + 15] = (clk_32m_trim >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 195 | |
The Other Jimmy |
31:182518299918 | 196 | output_hex_file[trim_area_start + 16] = rssi & 0xFF |
The Other Jimmy |
31:182518299918 | 197 | output_hex_file[trim_area_start + 17] = (rssi >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 198 | output_hex_file[trim_area_start + 18] = (rssi >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 199 | output_hex_file[trim_area_start + 19] = (rssi >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 200 | |
The Other Jimmy |
31:182518299918 | 201 | output_hex_file[trim_area_start + 20] = txtune & 0xFF |
The Other Jimmy |
31:182518299918 | 202 | output_hex_file[trim_area_start + 21] = (txtune >> 8) & 0xFF |
The Other Jimmy |
31:182518299918 | 203 | output_hex_file[trim_area_start + 22] = (txtune >> 16) & 0xFF |
The Other Jimmy |
31:182518299918 | 204 | output_hex_file[trim_area_start + 23] = (txtune >> 24) & 0xFF |
The Other Jimmy |
31:182518299918 | 205 | |
The Other Jimmy |
31:182518299918 | 206 | # pad the rest of the area with 0xFF |
The Other Jimmy |
31:182518299918 | 207 | for i in range(trim_area_start + trim_size, user_code_start): |
The Other Jimmy |
31:182518299918 | 208 | output_hex_file[i] = 0xFF |
The Other Jimmy |
31:182518299918 | 209 | |
The Other Jimmy |
31:182518299918 | 210 | #merge two hex files |
The Other Jimmy |
31:182518299918 | 211 | output_hex_file.merge(input_hex_file, overlap='error') |
The Other Jimmy |
31:182518299918 | 212 | |
The Other Jimmy |
31:182518299918 | 213 | # Write out file(s) |
The Other Jimmy |
31:182518299918 | 214 | output_hex_file.tofile(file_name_hex, 'hex') |
The Other Jimmy |
31:182518299918 | 215 | output_hex_file.tofile(file_name_bin, 'bin') |