make dump_otadata: Displays app ota_seq and crc on console

diff --git a/components/app_update/Makefile.projbuild b/components/app_update/Makefile.projbuild
index 29d223dc5e7f1e8d3b57a5d11fce16e53ce95beb..4015a601fa0099c945ec56649cbae03764024188 100644 (file)
--- a/components/app_update/Makefile.projbuild
+++ b/components/app_update/Makefile.projbuild
@@ -1,15 +1,48 @@
-#
 # Generate partition binary
 #
-.PHONY: erase_ota blank_ota_data
+.PHONY: dump_otadata erase_ota blank_ota_data
 
 GEN_EMPTY_PART := $(PYTHON) $(COMPONENT_PATH)/gen_empty_partition.py
 BLANK_OTA_DATA_FILE = $(BUILD_DIR_BASE)/ota_data_initial.bin
 
+PARTITION_TABLE_LEN := 0xC00
+OTADATA_LEN := 0x2000
+
+PARTITION_TABLE_ONCHIP_BIN_PATH := $(call dequote,$(abspath $(BUILD_DIR_BASE)))
+PARTITION_TABLE_ONCHIP_BIN_NAME := "onchip_partition.bin"
+OTADATA_ONCHIP_BIN_NAME := "onchip_otadata.bin"
+
+PARTITION_TABLE_ONCHIP_BIN := $(PARTITION_TABLE_ONCHIP_BIN_PATH)/$(call dequote,$(PARTITION_TABLE_ONCHIP_BIN_NAME)) 
+OTADATA_ONCHIP_BIN := $(PARTITION_TABLE_ONCHIP_BIN_PATH)/$(call dequote,$(OTADATA_ONCHIP_BIN_NAME))
+
+PARTITION_TABLE_GET_BIN_CMD = $(ESPTOOLPY_SERIAL) read_flash $(PARTITION_TABLE_OFFSET) $(PARTITION_TABLE_LEN) $(PARTITION_TABLE_ONCHIP_BIN)
+OTADATA_GET_BIN_CMD = $(ESPTOOLPY_SERIAL) read_flash $(OTADATA_OFFSET) $(OTADATA_LEN) $(OTADATA_ONCHIP_BIN)
+
+GEN_OTADATA = $(IDF_PATH)/components/app_update/dump_otadata.py
+ERASE_OTADATA_CMD = $(ESPTOOLPY_SERIAL) erase_region $(OTADATA_OFFSET) $(OTADATA_LEN)
+
 # If there is no otadata partition, both OTA_DATA_OFFSET and BLANK_OTA_DATA_FILE 
 # expand to empty values.
 ESPTOOL_ALL_FLASH_ARGS += $(OTA_DATA_OFFSET) $(BLANK_OTA_DATA_FILE)
 
+$(PARTITION_TABLE_ONCHIP_BIN):
+       $(PARTITION_TABLE_GET_BIN_CMD)
+
+onchip_otadata_get_info: $(PARTITION_TABLE_ONCHIP_BIN) 
+       $(eval OTADATA_OFFSET:=$(shell $(GET_PART_INFO) --type data --subtype ota --offset $(PARTITION_TABLE_ONCHIP_BIN)))
+       @echo $(if $(OTADATA_OFFSET), $(shell export OTADATA_OFFSET), $(shell rm -f $(PARTITION_TABLE_ONCHIP_BIN));$(error "ERROR: ESP32 does not have otadata partition."))
+
+$(OTADATA_ONCHIP_BIN):
+       $(OTADATA_GET_BIN_CMD)
+
+dump_otadata: onchip_otadata_get_info $(OTADATA_ONCHIP_BIN) $(PARTITION_TABLE_ONCHIP_BIN) 
+       @echo "otadata retrieved. Contents:"
+       @echo $(SEPARATOR)
+       $(GEN_OTADATA) $(OTADATA_ONCHIP_BIN)
+       @echo $(SEPARATOR)
+       rm -f $(PARTITION_TABLE_ONCHIP_BIN)
+       rm -f $(OTADATA_ONCHIP_BIN)
+
 $(BLANK_OTA_DATA_FILE): partition_table_get_info
        $(GEN_EMPTY_PART) --size $(OTA_DATA_SIZE) $(BLANK_OTA_DATA_FILE)
        $(eval BLANK_OTA_DATA_FILE = $(shell if [ $(OTA_DATA_SIZE) != 0 ]; then echo $(BLANK_OTA_DATA_FILE); else echo " "; fi) )

diff --git a/components/app_update/dump_otadata.py b/components/app_update/dump_otadata.py
new file mode 100755 (executable)
index 0000000..040bd2b
--- /dev/null
+++ b/components/app_update/dump_otadata.py
@@ -0,0 +1,88 @@
+#!/usr/bin/env python
+#
+# gen_otadata prints info about the otadata partition.
+#
+# Copyright 2018 Espressif Systems (Shanghai) PTE LTD
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http:#www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+from __future__ import print_function, division
+import argparse
+import os
+import re
+import struct
+import sys
+import hashlib
+import binascii
+
+__version__ = '1.0'
+
+quiet = False
+
+def status(msg):
+    """ Print status message to stderr """
+    if not quiet:
+        critical(msg)
+
+def critical(msg):
+    """ Print critical message to stderr """
+    if not quiet:
+        sys.stderr.write(msg)
+        sys.stderr.write('\n')
+
+def little_endian(buff, offset):
+    data = buff[offset:offset+4]
+    data.reverse()
+    data = ''.join(data)
+    return data
+               
+def main():
+    global quiet
+    parser = argparse.ArgumentParser(description='Prints otadata partition in human readable form.')
+
+    parser.add_argument('--quiet', '-q', help="Don't print status messages to stderr", action='store_true')
+
+    search_type = parser.add_mutually_exclusive_group()
+
+    parser.add_argument('input', help='Path to binary file containing otadata partition to parse.',
+                        type=argparse.FileType('rb'))
+
+    args = parser.parse_args()
+
+    quiet = args.quiet
+
+    input = args.input.read()
+    
+    hex_input_0 = binascii.hexlify(input)
+    hex_input_0 = map(''.join, zip(*[iter(hex_input_0)]*2))
+    hex_input_1 = binascii.hexlify(input[4096:])
+    hex_input_1 = map(''.join, zip(*[iter(hex_input_1)]*2))
+    
+    print("\t%11s\t%8s    |\t%8s\t%8s" %("OTA_SEQ", "CRC", "OTA_SEQ", "CRC"))
+    print("Firmware:  0x%s  \t 0x%s |\t0x%s \t 0x%s" % (little_endian(hex_input_0, 0), little_endian(hex_input_0, 28), \
+                                                        little_endian(hex_input_1, 0), little_endian(hex_input_1, 28)))
+class InputError(RuntimeError):
+    def __init__(self, e):
+        super(InputError, self).__init__(e)
+
+class ValidationError(InputError):
+    def __init__(self, partition, message):
+        super(ValidationError, self).__init__(
+            "Partition %s invalid: %s" % (partition.name, message))
+
+if __name__ == '__main__':
+    try:
+        r = main()
+        sys.exit(r)
+    except InputError as e:
+        print(e, file=sys.stderr)
+        sys.exit(2)

diff --git a/tools/ci/executable-list.txt b/tools/ci/executable-list.txt
index 18361a7c90973924c972ae7c638770b3b5f7feba..2b278c429410214f977b04341f1124f3b895d52d 100644 (file)
--- a/tools/ci/executable-list.txt
+++ b/tools/ci/executable-list.txt
@@ -6,6 +6,7 @@ components/idf_test/unit_test/TestCaseScript/IDFUnitTest/__init__.py
 components/partition_table/gen_esp32part.py
 components/partition_table/parttool.py
 components/app_update/gen_empty_partition.py
+components/app_update/dump_otadata.py
 components/partition_table/test_gen_esp32part_host/gen_esp32part_tests.py
 components/ulp/esp32ulp_mapgen.py
 components/nvs_flash/nvs_partition_generator/nvs_partition_gen.py