Compare commits
8 commits
Author | SHA1 | Date | |
---|---|---|---|
Michael Hope | ad8559e8c8 | ||
Michael Hope | 99ce67f926 | ||
Michael Hope | b1f84a16e5 | ||
Michael Hope | b46afaa04d | ||
Michael Hope | 7209f340ed | ||
Michael Hope | ff5027bb80 | ||
Michael Hope | 0e1f0b92cd | ||
Michael Hope | 8378288fb3 |
40
.drone.yml
Normal file
40
.drone.yml
Normal file
|
@ -0,0 +1,40 @@
|
|||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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.
|
||||
|
||||
kind: pipeline
|
||||
name: default
|
||||
|
||||
platform:
|
||||
os: linux
|
||||
arch: arm64
|
||||
|
||||
steps:
|
||||
- name: fetch
|
||||
image: alpine/git
|
||||
failure: ignore
|
||||
commands:
|
||||
- git fetch --tags
|
||||
|
||||
- name: build
|
||||
image: python
|
||||
commands:
|
||||
- pip3 install -r requirements.txt
|
||||
- python3 setup.py bdist
|
||||
|
||||
- name: test
|
||||
image: python
|
||||
commands:
|
||||
- pip3 install -r requirements.txt
|
||||
- pip3 install pytest flake8
|
||||
- flake8 hf2i2c
|
7
.gitignore
vendored
Normal file
7
.gitignore
vendored
Normal file
|
@ -0,0 +1,7 @@
|
|||
build/
|
||||
dist/
|
||||
.vscode/
|
||||
.eggs/
|
||||
\#*
|
||||
*~
|
||||
*.egg-info/
|
|
@ -1,8 +1,17 @@
|
|||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# Copyright (c) 2021 Google LLC.
|
||||
# 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
|
||||
#
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# 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.
|
||||
|
||||
cmake_minimum_required(VERSION 3.13.1)
|
||||
|
||||
list(APPEND BOARD_ROOT ${CMAKE_CURRENT_SOURCE_DIR})
|
||||
|
|
16
CONTRIBUTING.md
Normal file
16
CONTRIBUTING.md
Normal file
|
@ -0,0 +1,16 @@
|
|||
# How to Contribute
|
||||
|
||||
We'd love to accept your patches and contributions to this project. There are
|
||||
just a few small guidelines you need to follow.
|
||||
|
||||
## Contributor License Agreement
|
||||
|
||||
Contributions to this project must be accompanied by a Contributor License
|
||||
Agreement. You (or your employer) retain the copyright to your contribution;
|
||||
this simply gives us permission to use and redistribute your contributions as
|
||||
part of the project. Head over to <https://cla.developers.google.com/> to see
|
||||
your current agreements on file or to sign a new one.
|
||||
|
||||
You generally only need to submit a CLA once, so if you've already submitted one
|
||||
(even if it was for a different project), you probably don't need to do it
|
||||
again.
|
202
LICENSE
Normal file
202
LICENSE
Normal file
|
@ -0,0 +1,202 @@
|
|||
|
||||
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.
|
9
README.md
Normal file
9
README.md
Normal file
|
@ -0,0 +1,9 @@
|
|||
# ZX0 bootloader
|
||||
|
||||
This is an I2C based bootloader for the SAMD21. It implements the [Microsoft HF2][hf2] protocol over I2C and uses the same double-tap-for-bootloader and magic as the Adafruit UF2 bootloader.
|
||||
|
||||
The bootloader is written in C++ and uses Zephyr for the drivers. It should be easy to adapt to the SAMD51 and other devices supported by Zephyr but each will need a custom I2C client driver.
|
||||
|
||||
-- Michael Hope <mlhx@google.com> <michaelh@juju.nz>
|
||||
|
||||
[hf2]: https://github.com/microsoft/uf2/blob/master/hf2.md
|
|
@ -1,4 +1,16 @@
|
|||
# SPDX-License-Identifier: Apache-2.0
|
||||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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.
|
||||
|
||||
if(CONFIG_PINMUX_SAM0)
|
||||
zephyr_library()
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Arduino Zero Board configuration
|
||||
# ZX0 Board configuration
|
||||
|
||||
# Copyright (c) 2017 Google LLC.
|
||||
# Copyright (c) 2021 Google LLC.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
config BOARD_ZX0
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# Arduino Zero board configuration
|
||||
# ZX0 board configuration
|
||||
|
||||
# Copyright (c) 2017 Google LLC.
|
||||
# Copyright (c) 2021 Google LLC.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
config BOARD
|
||||
|
|
|
@ -1,4 +1,15 @@
|
|||
# Copyright (c) 2017 Google LLC.
|
||||
# SPDX-License-Identifier: Apache-2.0
|
||||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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.
|
||||
|
||||
include(${ZEPHYR_BASE}/boards/common/openocd.board.cmake)
|
||||
|
|
|
@ -1,7 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2018 Google LLC.
|
||||
* Copyright 2021 Google LLC
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
* 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.
|
||||
*/
|
||||
|
||||
#include <drivers/pinmux.h>
|
||||
|
|
|
@ -1,8 +1,6 @@
|
|||
# source [find interface/cmsis-dap.cfg]
|
||||
source [find interface/jlink.cfg]
|
||||
transport select swd
|
||||
|
||||
# chip name
|
||||
set CHIPNAME at91samd21e18
|
||||
set ENDIAN little
|
||||
set CPUTAPID 0x0bc11477
|
||||
|
|
|
@ -1,5 +1,5 @@
|
|||
/*
|
||||
* Copyright (c) 2017 Google LLC.
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
|
@ -19,7 +19,6 @@
|
|||
zephyr,code-partition = &boot_partition;
|
||||
};
|
||||
|
||||
/* These aliases are provided for compatibility with samples */
|
||||
aliases {
|
||||
led0 = &led0;
|
||||
led1 = &led1;
|
||||
|
@ -79,15 +78,5 @@
|
|||
reg = <0x2000 DT_SIZE_K(256-8-16)>;
|
||||
read-only;
|
||||
};
|
||||
|
||||
/*
|
||||
* The final 16 KiB is reserved for the application.
|
||||
* Storage partition will be used by FCB/LittleFS/NVS
|
||||
* if enabled.
|
||||
*/
|
||||
storage_partition: partition@3c000 {
|
||||
label = "storage";
|
||||
reg = <0x0003c000 DT_SIZE_K(16)>;
|
||||
};
|
||||
};
|
||||
};
|
||||
|
|
|
@ -1,21 +0,0 @@
|
|||
identifier: zx0
|
||||
name: ZX0
|
||||
type: mcu
|
||||
arch: arm
|
||||
ram: 32
|
||||
flash: 256
|
||||
toolchain:
|
||||
- zephyr
|
||||
- gnuarmemb
|
||||
- xtools
|
||||
supported:
|
||||
- adc
|
||||
- counter
|
||||
- dma
|
||||
- gpio
|
||||
- hwinfo
|
||||
- pinmux
|
||||
- spi
|
||||
- uart
|
||||
- usb_device
|
||||
- watchdog
|
|
@ -9,7 +9,3 @@ CONFIG_UART_CONSOLE=y
|
|||
CONFIG_UART_INTERRUPT_DRIVEN=y
|
||||
CONFIG_SERIAL=y
|
||||
CONFIG_PINMUX=y
|
||||
CONFIG_SOC_ATMEL_SAMD_XOSC32K=y
|
||||
CONFIG_SOC_ATMEL_SAMD_XOSC32K_AS_MAIN=y
|
||||
CONFIG_BOOTLOADER_BOSSA=y
|
||||
CONFIG_BOOTLOADER_BOSSA_ADAFRUIT_UF2=y
|
||||
|
|
14
hf2i2c/__init__.py
Normal file
14
hf2i2c/__init__.py
Normal file
|
@ -0,0 +1,14 @@
|
|||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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.
|
||||
|
201
hf2i2c/app.py
Normal file
201
hf2i2c/app.py
Normal file
|
@ -0,0 +1,201 @@
|
|||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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.
|
||||
|
||||
"""Host side programmer for the ZX0 bootloader.
|
||||
|
||||
The bootloader implements the HF2 protocol. See https://github.com/microsoft/uf2/blob/master/hf2.md for the definition including the protocol level values.
|
||||
"""
|
||||
|
||||
import enum
|
||||
from dataclasses import dataclass
|
||||
import random
|
||||
import struct
|
||||
from typing import List, Optional, Sequence
|
||||
|
||||
import click
|
||||
import smbus
|
||||
import intelhex
|
||||
from crccheck.crc import Crc16Xmodem
|
||||
|
||||
FILL = 0xFF
|
||||
|
||||
|
||||
class Command(enum.IntEnum):
|
||||
BININFO = 0x0001
|
||||
INFO = 0x0002
|
||||
RESET_INTO_APP = 0x0003
|
||||
RESET_INTO_BOOTLOADER = 0x0004
|
||||
START_FLASH = 0x0005
|
||||
WRITE_FLASH_PAGE = 0x0006
|
||||
CHKSUM_PAGES = 0x0007
|
||||
READ_WORDS = 0x0008
|
||||
WRITE_WORDS = 0x0009
|
||||
DMESG = 0x0010
|
||||
|
||||
|
||||
class Flag(enum.IntFlag):
|
||||
SERIAL_OUT = 0x80
|
||||
SERIAL_ERR = 0xC0
|
||||
CMDPKT_LAST = 0x40
|
||||
CMDPKT_BODY = 0x00
|
||||
FLAG_MASK = 0xC0
|
||||
SIZE_MASK = 63
|
||||
|
||||
|
||||
class Status(enum.IntEnum):
|
||||
OK = 0
|
||||
INVALID_CMD = 1
|
||||
ERROR = 2
|
||||
|
||||
|
||||
@dataclass
|
||||
class BinInfo:
|
||||
mode: int
|
||||
flash_page_size: int
|
||||
flash_num_pages: int
|
||||
max_message_size: int
|
||||
family_id: int
|
||||
|
||||
|
||||
class Error(Exception):
|
||||
pass
|
||||
|
||||
|
||||
class HF2:
|
||||
"""Implements the HF2 flashing protocol over I2C."""
|
||||
|
||||
# Maximum number of bytes per packet. Must fit within the 32 bytes of a Linux write.
|
||||
MAX_PACKET = 31
|
||||
|
||||
def __init__(self, bus: smbus.SMBus, address: int, command: int):
|
||||
self._bus = bus
|
||||
self._address = address
|
||||
self._command = command
|
||||
|
||||
self._tag = random.randint(0, 30000)
|
||||
|
||||
def send(self, command: Command, args: Optional[bytes] = None) -> None:
|
||||
self._tag = (self._tag + 1) & 0xFFFF
|
||||
msg = struct.pack('<IHBB', command, self._tag, 0, 0)
|
||||
if args:
|
||||
msg += args
|
||||
|
||||
for i in range(0, len(msg), self.MAX_PACKET):
|
||||
remain = len(msg) - i
|
||||
take = min(remain, self.MAX_PACKET)
|
||||
header = take
|
||||
final = (i + self.MAX_PACKET >= len(msg))
|
||||
if final:
|
||||
header |= Flag.CMDPKT_LAST
|
||||
packet = [header] + list(msg[i:i + take])
|
||||
self._bus.write_i2c_block_data(self._address, self._command,
|
||||
packet)
|
||||
|
||||
def exec(self, command: Command, args: Optional[bytes] = None) -> bytes:
|
||||
self.send(command, args)
|
||||
got = bytes(self._bus.read_block_data(self._address, self._command))
|
||||
header, tag, status, status_info = struct.unpack_from('<BHBB', got, 0)
|
||||
|
||||
if (header & Flag.FLAG_MASK) != Flag.CMDPKT_LAST:
|
||||
raise Error(
|
||||
'Target returned a header {header:x}, want the last packet')
|
||||
if tag != self._tag:
|
||||
raise Error(
|
||||
f'Target returned the wrong tag. Want {self._tag}, got {tag}')
|
||||
if status != Status.OK:
|
||||
raise Error(f'Target returned status {status}: {status_info}')
|
||||
|
||||
return got[5:]
|
||||
|
||||
def get_bininfo(self) -> BinInfo:
|
||||
data = self.exec(Command.BININFO)
|
||||
return BinInfo(*struct.unpack_from('<IIIII', data, 0))
|
||||
|
||||
def write_flash_page(self, address: int, data: bytes) -> None:
|
||||
args = struct.pack('<I', address) + data
|
||||
self.exec(Command.WRITE_FLASH_PAGE, args)
|
||||
|
||||
def chksum_pages(self, address: int, num_pages: int = 1) -> Sequence[int]:
|
||||
args = struct.pack('<II', address, num_pages)
|
||||
got = self.exec(Command.CHKSUM_PAGES, args)
|
||||
return [
|
||||
struct.unpack_from('<H', got, x)[0] for x in range(0, len(got), 2)
|
||||
]
|
||||
|
||||
def read_words(self, address: int, num_words: int = 1) -> Sequence[int]:
|
||||
args = struct.pack('<II', address, num_words)
|
||||
got = self.exec(Command.READ_WORDS, args)
|
||||
return [
|
||||
struct.unpack_from('<I', got, x)[0] for x in range(0, len(got), 4)
|
||||
]
|
||||
|
||||
def reset_into_app(self) -> None:
|
||||
self.send(Command.RESET_INTO_APP)
|
||||
|
||||
|
||||
def _show_address(v) -> str:
|
||||
if v is None:
|
||||
return ''
|
||||
return '%x' % v
|
||||
|
||||
|
||||
@click.command()
|
||||
@click.option('--bus', default=3, help='I2C bus')
|
||||
@click.option('--address', default=0x22, help='Device address')
|
||||
@click.option('--command', default=0xFE, help='HF2 command')
|
||||
@click.option('--program',
|
||||
type=click.File(),
|
||||
help='Hex file to program to the device')
|
||||
@click.option('--start',
|
||||
is_flag=True,
|
||||
help='Start the application running after any other operations')
|
||||
def main(bus: int, address: int, command: int, program: str, start: bool):
|
||||
b = smbus.SMBus(bus)
|
||||
h = HF2(b, address, command)
|
||||
|
||||
info = h.get_bininfo()
|
||||
click.echo(f'Found a device with {info.flash_num_pages} pages of '
|
||||
f'{info.flash_page_size} bytes')
|
||||
|
||||
if program:
|
||||
hex = intelhex.IntelHex()
|
||||
hex.fromfile(program, format='hex')
|
||||
|
||||
page = info.flash_page_size
|
||||
addresses: List[int] = []
|
||||
for start, end in hex.segments():
|
||||
addresses.extend(range(start, end, page))
|
||||
|
||||
with click.progressbar(addresses,
|
||||
label='Program',
|
||||
item_show_func=_show_address) as bar:
|
||||
for address in bar:
|
||||
data = [
|
||||
hex[x] for x in range(address, min(address + page, end))
|
||||
]
|
||||
data += [FILL] * (page - len(data))
|
||||
assert len(data) == page
|
||||
h.write_flash_page(address, bytes(data))
|
||||
got, want = h.chksum_pages(address)[0], Crc16Xmodem.calc(data)
|
||||
if got != want and address >= 16384:
|
||||
raise Error(f'Program error at address {address:x}. '
|
||||
f'Want CRC {want:x}, got {got:x}')
|
||||
|
||||
if start:
|
||||
click.echo('Starting app')
|
||||
h.reset_into_app()
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
4
requirements.txt
Normal file
4
requirements.txt
Normal file
|
@ -0,0 +1,4 @@
|
|||
click>=8.0
|
||||
smbus>=1.1
|
||||
intelhex>=2.3.0
|
||||
crccheck>=1.0
|
31
setup.py
Normal file
31
setup.py
Normal file
|
@ -0,0 +1,31 @@
|
|||
# Copyright 2021 Google LLC
|
||||
#
|
||||
# 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
|
||||
#
|
||||
# https://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 setuptools import find_packages, setup
|
||||
|
||||
setup(
|
||||
name='hf2i2c',
|
||||
version_format='{tag}.dev{commitcount}+{gitsha}',
|
||||
setup_requires=['setuptools-git-version'],
|
||||
url='https://juju.nz/src/michaelh/zx0-bootloader',
|
||||
author='Michael Hope',
|
||||
author_email='michaelh@juju.nz',
|
||||
description='hf2i2c programmer',
|
||||
zip_safe=True,
|
||||
packages=find_packages(),
|
||||
entry_points='''
|
||||
[console_scripts]
|
||||
hf2i2c=hf2i2c.app:main
|
||||
''',
|
||||
)
|
19
src/hal.cpp
19
src/hal.cpp
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#include "hal.h"
|
||||
|
||||
#include <drivers/gpio.h>
|
||||
|
|
19
src/hal.h
19
src/hal.h
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <device.h>
|
||||
|
|
19
src/hf2.cpp
19
src/hf2.cpp
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#include "hf2.h"
|
||||
|
||||
#include <drivers/flash.h>
|
||||
|
|
15
src/hf2.h
15
src/hf2.h
|
@ -1,8 +1,19 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
* Copyright 2021 Google LLC
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
* 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.
|
||||
*/
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <device.h>
|
||||
|
|
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#include "i2c_sam0.h"
|
||||
|
||||
static constexpr uint8_t kCommand = 0xFE;
|
||||
|
|
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#pragma once
|
||||
|
||||
#include <soc.h>
|
||||
|
|
19
src/main.cpp
19
src/main.cpp
|
@ -1,8 +1,17 @@
|
|||
/*
|
||||
* Copyright (c) 2021 Google LLC.
|
||||
*
|
||||
* SPDX-License-Identifier: Apache-2.0
|
||||
*/
|
||||
// Copyright 2021 Google LLC
|
||||
//
|
||||
// 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.
|
||||
|
||||
#include "hal.h"
|
||||
#include "hf2.h"
|
||||
#include "i2c_sam0.h"
|
||||
|
|
Loading…
Reference in a new issue