tool/mbed/mbed-sdk/workspace_tools/patch.py

   1 """
   2 mbed SDK
   3 Copyright (c) 2011-2013 ARM Limited
   4
   5 Licensed under the Apache License, Version 2.0 (the "License");
   6 you may not use this file except in compliance with the License.
   7 You may obtain a copy of the License at
   8
   9     http://www.apache.org/licenses/LICENSE-2.0
  10
  11 Unless required by applicable law or agreed to in writing, software
  12 distributed under the License is distributed on an "AS IS" BASIS,
  13 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 See the License for the specific language governing permissions and
  15 limitations under the License.
  16
  17
  18 http://www.nxp.com/documents/user_manual/UM10360.pdf
  19
  20 32.3.1.1 Criterion for Valid User Code
  21 The reserved Cortex-M3 exception vector location 7 (offset 0x1C in the vector table)
  22 should contain the 2's complement of the check-sum of table entries 0 through 6. This
  23 causes the checksum of the first 8 table entries to be 0. The boot loader code checksums
  24 the first 8 locations in sector 0 of the flash. If the result is 0, then execution control is
  25 transferred to the user code.
  26 """
  27 from struct import unpack, pack
  28
  29
  30 def patch(bin_path):
  31     with open(bin_path, 'r+b') as bin:
  32         # Read entries 0 through 6 (Little Endian 32bits words)
  33         vector = [unpack('<I', bin.read(4))[0] for _ in range(7)]
  34
  35         # location 7 (offset 0x1C in the vector table) should contain the 2's
  36         # complement of the check-sum of table entries 0 through 6
  37         bin.seek(0x1C)
  38         bin.write(pack('<I', (~sum(vector) + 1) & 0xFFFFFFFF))
  39
  40
  41 def is_patched(bin_path):
  42     with open(bin_path, 'rb') as bin:
  43         # The checksum of the first 8 table entries should be 0
  44         return (sum([unpack('<I', bin.read(4))[0] for _ in range(8)]) & 0xFFFFFFFF) == 0
  45
  46
  47 if __name__ == '__main__':
  48     bin_path = "C:/Users/emimon01/releases/emilmont/build/test/LPC1768/ARM/MBED_A1/basic.bin"
  49     patch(bin_path)
  50     assert is_patched(bin_path), "The file is not patched"