diff --git a/tools/updater/dist/precursorupdater-0.0.1-py3-none-any.whl b/tools/updater/dist/precursorupdater-0.0.1-py3-none-any.whl new file mode 100644 index 000000000..2167aee77 Binary files /dev/null and b/tools/updater/dist/precursorupdater-0.0.1-py3-none-any.whl differ diff --git a/tools/updater/dist/precursorupdater-0.0.1.tar.gz b/tools/updater/dist/precursorupdater-0.0.1.tar.gz new file mode 100644 index 000000000..84a197a37 Binary files /dev/null and b/tools/updater/dist/precursorupdater-0.0.1.tar.gz differ diff --git a/tools/updater/precursorupdater.egg-info/PKG-INFO b/tools/updater/precursorupdater.egg-info/PKG-INFO new file mode 100644 index 000000000..aee7dca91 --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/PKG-INFO @@ -0,0 +1,230 @@ +Metadata-Version: 2.1 +Name: precursorupdater +Version: 0.0.1 +Summary: Precursor USB Updater +Author: bunnie +License: + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + +Project-URL: Homepage, https://github.com/betrusted-io/betrusted-wiki/wiki/Updating-Your-Device +Project-URL: Bug Tracker, https://github.com/betrusted-io/xous-core/issues +Classifier: Programming Language :: Python :: 3 +Classifier: License :: OSI Approved :: Apache Software License +Classifier: Operating System :: OS Independent +Classifier: Development Status :: 3 - Alpha +Classifier: Environment :: Console +Classifier: Topic :: System :: Hardware +Classifier: Topic :: System :: Hardware :: Universal Serial Bus (USB) +Requires-Python: >=3.8 +Description-Content-Type: text/markdown +License-File: LICENSE + +# Precursor Updater + +This script automatically updates a Precursor device. Please run with `--help` to see +all the available options. By default, the script will attempt to load the latest stable release onto a Precursor device that is attached to the host via USB. + +When the script is finished running, you will need to reset the device by pressing on the +switch inside the hole in the lower right hand side of the case. See https://ci.betrusted.io/i/reset.jpg for an example of how to do this. + +See our [troubleshooting](https://github.com/betrusted-io/betrusted-wiki/wiki/Updating-Your-Device#troubleshooting) guide for more help, especially if you are running Windows. diff --git a/tools/updater/precursorupdater.egg-info/SOURCES.txt b/tools/updater/precursorupdater.egg-info/SOURCES.txt new file mode 100644 index 000000000..50a9b770d --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/SOURCES.txt @@ -0,0 +1,14 @@ +LICENSE +README.md +pyproject.toml +setup.py +precursorupdater/__init__.py +precursorupdater/precursorupdater.py +precursorupdater.egg-info/PKG-INFO +precursorupdater.egg-info/SOURCES.txt +precursorupdater.egg-info/dependency_links.txt +precursorupdater.egg-info/entry_points.txt +precursorupdater.egg-info/requires.txt +precursorupdater.egg-info/top_level.txt +precursorupdater/precursorusb/__init__.py +precursorupdater/precursorusb/precursorusb.py \ No newline at end of file diff --git a/tools/updater/precursorupdater.egg-info/dependency_links.txt b/tools/updater/precursorupdater.egg-info/dependency_links.txt new file mode 100644 index 000000000..8b1378917 --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/dependency_links.txt @@ -0,0 +1 @@ + diff --git a/tools/updater/precursorupdater.egg-info/entry_points.txt b/tools/updater/precursorupdater.egg-info/entry_points.txt new file mode 100644 index 000000000..9f3e65aa2 --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/entry_points.txt @@ -0,0 +1,2 @@ +[console_scripts] +my-script = precursorupdater.precursorupdater:main diff --git a/tools/updater/precursorupdater.egg-info/requires.txt b/tools/updater/precursorupdater.egg-info/requires.txt new file mode 100644 index 000000000..83611572d --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/requires.txt @@ -0,0 +1,3 @@ +requests>=2 +pyusb>=1 +progressbar2>=3 diff --git a/tools/updater/precursorupdater.egg-info/top_level.txt b/tools/updater/precursorupdater.egg-info/top_level.txt new file mode 100644 index 000000000..e0bc34273 --- /dev/null +++ b/tools/updater/precursorupdater.egg-info/top_level.txt @@ -0,0 +1 @@ +precursorupdater diff --git a/tools/updater/precursorupdater/precursorusb/__init__.py b/tools/updater/precursorupdater/precursorusb/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-38.pyc b/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-38.pyc new file mode 100644 index 000000000..3e4d7914c Binary files /dev/null and b/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-38.pyc differ diff --git a/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-39.pyc b/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-39.pyc new file mode 100644 index 000000000..f4eca2063 Binary files /dev/null and b/tools/updater/precursorupdater/precursorusb/__pycache__/__init__.cpython-39.pyc differ diff --git a/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-38.pyc b/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-38.pyc new file mode 100644 index 000000000..ed9ebd3e8 Binary files /dev/null and b/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-38.pyc differ diff --git a/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-39.pyc b/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-39.pyc new file mode 100644 index 000000000..7e3ad2d28 Binary files /dev/null and b/tools/updater/precursorupdater/precursorusb/__pycache__/precursorusb.cpython-39.pyc differ diff --git a/tools/updater/precursorupdater/precursorusb/precursorusb.py b/tools/updater/precursorupdater/precursorusb/precursorusb.py new file mode 100644 index 000000000..2058c84cf --- /dev/null +++ b/tools/updater/precursorupdater/precursorusb/precursorusb.py @@ -0,0 +1,407 @@ +import array +import hashlib +import csv + +from progressbar.bar import ProgressBar + +class PrecursorUsb: + def __init__(self, dev): + self.dev = dev + self.RDSR = 0x05 + self.RDSCUR = 0x2B + self.RDID = 0x9F + self.WREN = 0x06 + self.WRDI = 0x04 + self.SE4B = 0x21 + self.BE4B = 0xDC + self.PP4B = 0x12 + self.registers = {} + self.regions = {} + self.gitrev = '' + + def register(self, name): + return int(self.registers[name], 0) + + def peek(self, addr, display=False): + _dummy_s = '\x00'.encode('utf-8') + data = array.array('B', _dummy_s * 4) + + numread = self.dev.ctrl_transfer(bmRequestType=(0x80 | 0x43), bRequest=0, + wValue=(addr & 0xffff), wIndex=((addr >> 16) & 0xffff), + data_or_wLength=data, timeout=500) + + read_data = int.from_bytes(data.tobytes(), byteorder='little', signed=False) + if display == True: + print("0x{:08x}".format(read_data)) + return read_data + + def poke(self, addr, wdata, check=False, display=False): + if check == True: + _dummy_s = '\x00'.encode('utf-8') + data = array.array('B', _dummy_s * 4) + + numread = self.dev.ctrl_transfer(bmRequestType=(0x80 | 0x43), bRequest=0, + wValue=(addr & 0xffff), wIndex=((addr >> 16) & 0xffff), + data_or_wLength=data, timeout=500) + + read_data = int.from_bytes(data.tobytes(), byteorder='little', signed=False) + print("before poke: 0x{:08x}".format(read_data)) + + data = array.array('B', wdata.to_bytes(4, 'little')) + numwritten = self.dev.ctrl_transfer(bmRequestType=(0x00 | 0x43), bRequest=0, + wValue=(addr & 0xffff), wIndex=((addr >> 16) & 0xffff), + data_or_wLength=data, timeout=500) + + if check == True: + _dummy_s = '\x00'.encode('utf-8') + data = array.array('B', _dummy_s * 4) + + numread = self.dev.ctrl_transfer(bmRequestType=(0x80 | 0x43), bRequest=0, + wValue=(addr & 0xffff), wIndex=((addr >> 16) & 0xffff), + data_or_wLength=data, timeout=500) + + read_data = int.from_bytes(data.tobytes(), byteorder='little', signed=False) + print("after poke: 0x{:08x}".format(read_data)) + if display == True: + print("wrote 0x{:08x} to 0x{:08x}".format(wdata, addr)) + + def burst_read(self, addr, len): + _dummy_s = '\x00'.encode('utf-8') + maxlen = 4096 + + ret = bytearray() + packet_count = len // maxlen + if (len % maxlen) != 0: + packet_count += 1 + + for pkt_num in range(packet_count): + cur_addr = addr + pkt_num * maxlen + if pkt_num == packet_count - 1: + if len % maxlen != 0: + bufsize = len % maxlen + else: + bufsize = maxlen + else: + bufsize = maxlen + + data = array.array('B', _dummy_s * bufsize) + numread = self.dev.ctrl_transfer(bmRequestType=(0x80 | 0x43), bRequest=0, + wValue=(cur_addr & 0xffff), wIndex=((cur_addr >> 16) & 0xffff), + data_or_wLength=data, timeout=500) + + if numread != bufsize: + print("Burst read error: {} bytes requested, {} bytes read at 0x{:08x}".format(bufsize, numread, cur_addr)) + exit(1) + + ret = ret + data + + return ret + + def burst_write(self, addr, data): + if len(data) == 0: + return + + # the actual "addr" doesn't matter for a burst_write, because it's specified + # as an argument to the flash_pp4b command. We lock out access to the base of + # SPINOR because it's part of the gateware, so, we pick a "safe" address to + # write to instead. The page write responder will aggregate any write data + # to anywhere in the SPINOR address range. + writebuf_addr = 0x2098_0000 # the current start address of the kernel, for example + + maxlen = 4096 + packet_count = len(data) // maxlen + if (len(data) % maxlen) != 0: + packet_count += 1 + + for pkt_num in range(packet_count): + cur_addr = addr + pkt_num * maxlen + if pkt_num == packet_count - 1: + if len(data) % maxlen != 0: + bufsize = len(data) % maxlen + else: + bufsize = maxlen + else: + bufsize = maxlen + + wdata = array.array('B', data[(pkt_num * maxlen):(pkt_num * maxlen) + bufsize]) + numwritten = self.dev.ctrl_transfer(bmRequestType=(0x00 | 0x43), bRequest=0, + # note use of writebuf_addr instead of cur_addr -> see comment above about the quirk of write addressing + wValue=(writebuf_addr & 0xffff), wIndex=((writebuf_addr >> 16) & 0xffff), + data_or_wLength=wdata, timeout=500) + + if numwritten != bufsize: + print("Burst write error: {} bytes requested, {} bytes written at 0x{:08x}".format(bufsize, numwritten, cur_addr)) + exit(1) + + def ping_wdt(self): + self.poke(self.register('wdt_watchdog'), 1, display=False) + self.poke(self.register('wdt_watchdog'), 1, display=False) + + def spinor_command_value(self, exec=0, lock_reads=0, cmd_code=0, dummy_cycles=0, data_words=0, has_arg=0): + return ((exec & 1) << 1 | + (lock_reads & 1) << 24 | + (cmd_code & 0xff) << 2 | + (dummy_cycles & 0x1f) << 11 | + (data_words & 0xff) << 16 | + (has_arg & 1) << 10 + ) + + def flash_rdsr(self, lock_reads): + self.poke(self.register('spinor_cmd_arg'), 0) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=lock_reads, cmd_code=self.RDSR, dummy_cycles=4, data_words=1, has_arg=1) + ) + return self.peek(self.register('spinor_cmd_rbk_data'), display=False) + + def flash_rdscur(self): + self.poke(self.register('spinor_cmd_arg'), 0) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.RDSCUR, dummy_cycles=4, data_words=1, has_arg=1) + ) + return self.peek(self.register('spinor_cmd_rbk_data'), display=False) + + def flash_rdid(self, offset): + self.poke(self.register('spinor_cmd_arg'), 0) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, cmd_code=self.RDID, dummy_cycles=4, data_words=offset, has_arg=1) + ) + return self.peek(self.register('spinor_cmd_rbk_data'), display=False) + + def flash_wren(self): + self.poke(self.register('spinor_cmd_arg'), 0) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.WREN) + ) + + def flash_wrdi(self): + self.poke(self.register('spinor_cmd_arg'), 0) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.WRDI) + ) + + def flash_se4b(self, sector_address): + self.poke(self.register('spinor_cmd_arg'), sector_address) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.SE4B, has_arg=1) + ) + + def flash_be4b(self, block_address): + self.poke(self.register('spinor_cmd_arg'), block_address) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.BE4B, has_arg=1) + ) + + def flash_pp4b(self, address, data_bytes): + self.poke(self.register('spinor_cmd_arg'), address) + self.poke(self.register('spinor_command'), + self.spinor_command_value(exec=1, lock_reads=1, cmd_code=self.PP4B, has_arg=1, data_words=(data_bytes//2)) + ) + + def load_csrs(self, fname=None): + LOC_CSRCSV = 0x20277000 # this address shouldn't change because it's how we figure out our version number + # CSR extraction: + # dd if=soc_csr.bin of=csr_data_0.9.6.bin skip=2524 count=32 bs=1024 + if fname == None: + csr_data = self.burst_read(LOC_CSRCSV, 0x8000) + else: + with open(fname, "rb") as f: + csr_data = f.read(0x8000) + + hasher = hashlib.sha512() + hasher.update(csr_data[:0x7FC0]) + digest = hasher.digest() + if digest != csr_data[0x7fc0:]: + print("Could not find a valid csr.csv descriptor on the device, aborting!") + exit(1) + + csr_len = int.from_bytes(csr_data[:4], 'little') + csr_extracted = csr_data[4:4+csr_len] + decoded = csr_extracted.decode('utf-8') + # strip comments + stripped = [] + for line in decoded.split('\n'): + if line.startswith('#') == False: + stripped.append(line) + # create database + csr_db = csv.reader(stripped) + for row in csr_db: + if len(row) > 1: + if 'csr_register' in row[0]: + self.registers[row[1]] = row[2] + if 'memory_region' in row[0]: + self.regions[row[1]] = [row[2], row[3]] + if 'git_rev' in row[0]: + self.gitrev = row[1] + print("Using SoC {} registers".format(self.gitrev)) + + def erase_region(self, addr, length): + # ID code check + code = self.flash_rdid(1) + print("ID code bytes 1-2: 0x{:08x}".format(code)) + if code != 0x8080c2c2: + print("ID code mismatch") + exit(1) + code = self.flash_rdid(2) + print("ID code bytes 2-3: 0x{:08x}".format(code)) + if code != 0x3b3b8080: + print("ID code mismatch") + exit(1) + + # block erase + progress = ProgressBar(min_value=0, max_value=length, prefix='Erasing ').start() + erased = 0 + while erased < length: + self.ping_wdt() + if (length - erased >= 65536) and ((addr & 0xFFFF) == 0): + blocksize = 65536 + else: + blocksize = 4096 + + while True: + self.flash_wren() + status = self.flash_rdsr(1) + if status & 0x02 != 0: + break + + if blocksize == 4096: + self.flash_se4b(addr + erased) + else: + self.flash_be4b(addr + erased) + erased += blocksize + + while (self.flash_rdsr(1) & 0x01) != 0: + pass + + result = self.flash_rdscur() + if result & 0x60 != 0: + print("E_FAIL/P_FAIL set on erase, programming may fail, but trying anyways...") + + if self.flash_rdsr(1) & 0x02 != 0: + self.flash_wrdi() + while (self.flash_rdsr(1) & 0x02) != 0: + pass + if erased < length: + progress.update(erased) + progress.finish() + print("Erase finished") + + # addr is relative to the base of FLASH (not absolute) + def flash_program(self, addr, data, verify=True): + flash_region = int(self.regions['spiflash'][0], 0) + flash_len = int(self.regions['spiflash'][1], 0) + + if (addr + len(data) > flash_len): + print("Write data out of bounds! Aborting.") + exit(1) + + # ID code check + code = self.flash_rdid(1) + print("ID code bytes 1-2: 0x{:08x}".format(code)) + if code != 0x8080c2c2: + print("ID code mismatch") + exit(1) + code = self.flash_rdid(2) + print("ID code bytes 2-3: 0x{:08x}".format(code)) + if code != 0x3b3b8080: + print("ID code mismatch") + exit(1) + + # block erase + progress = ProgressBar(min_value=0, max_value=len(data), prefix='Erasing ').start() + erased = 0 + while erased < len(data): + self.ping_wdt() + if (len(data) - erased >= 65536) and ((addr & 0xFFFF) == 0): + blocksize = 65536 + else: + blocksize = 4096 + + while True: + self.flash_wren() + status = self.flash_rdsr(1) + if status & 0x02 != 0: + break + + if blocksize == 4096: + self.flash_se4b(addr + erased) + else: + self.flash_be4b(addr + erased) + erased += blocksize + + while (self.flash_rdsr(1) & 0x01) != 0: + pass + + result = self.flash_rdscur() + if result & 0x60 != 0: + print("E_FAIL/P_FAIL set on erase, programming may fail, but trying anyways...") + + if self.flash_rdsr(1) & 0x02 != 0: + self.flash_wrdi() + while (self.flash_rdsr(1) & 0x02) != 0: + pass + if erased < len(data): + progress.update(erased) + progress.finish() + print("Erase finished") + + # program + # pad out to the nearest word length + if len(data) % 4 != 0: + data += bytearray([0xff] * (4 - (len(data) % 4))) + written = 0 + progress = ProgressBar(min_value=0, max_value=len(data), prefix='Writing ').start() + while written < len(data): + self.ping_wdt() + if len(data) - written > 256: + chunklen = 256 + else: + chunklen = len(data) - written + + while True: + self.flash_wren() + status = self.flash_rdsr(1) + if status & 0x02 != 0: + break + + self.burst_write(self.register('spinor_wdata'), data[written:(written+chunklen)]) + self.flash_pp4b(addr + written, chunklen) + + written += chunklen + if written < len(data): + progress.update(written) + progress.finish() + print("Write finished") + + if self.flash_rdsr(1) & 0x02 != 0: + self.flash_wrdi() + while (self.flash_rdsr(1) & 0x02) != 0: + pass + + # dummy reads to clear the "read lock" bit + self.flash_rdsr(0) + + # verify + self.ping_wdt() + if verify: + print("Performing readback for verification...") + self.ping_wdt() + rbk_data = self.burst_read(addr + flash_region, len(data)) + if rbk_data != data: + errs = 0 + err_thresh = 64 + for i in range(0, len(rbk_data)): + if rbk_data[i] != data[i]: + if errs < err_thresh: + print("Error at 0x{:x}: {:x}->{:x}".format(i, data[i], rbk_data[i])) + errs += 1 + if errs == err_thresh: + print("Too many errors, stopping print...") + print("Errors were found in verification, programming failed") + print("Total byte errors: {}".format(errs)) + exit(1) + else: + print("Verification passed.") + else: + print("Skipped verification at user request") + + self.ping_wdt() diff --git a/tools/updater/setup.py b/tools/updater/setup.py new file mode 100644 index 000000000..606849326 --- /dev/null +++ b/tools/updater/setup.py @@ -0,0 +1,3 @@ +from setuptools import setup + +setup()