diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index c13445ff14..92f77bf39d 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -43,7 +43,7 @@ jobs: name: ${{ matrix.model }} path: | source/Hexfile/${{ matrix.model }}_*.hex - source/Hexfile/${{ matrix.model }}_*.bin + source/Hexfile/${{ matrix.model }}_*.dfu source/Hexfile/LICENSE source/Hexfile/LICENSE_RELEASE.md if-no-files-found: error @@ -88,7 +88,7 @@ jobs: name: ${{ matrix.model }}_multi-lang path: | source/Hexfile/${{ matrix.model }}_*.hex - source/Hexfile/${{ matrix.model }}_*.bin + source/Hexfile/${{ matrix.model }}_*.dfu source/Hexfile/LICENSE source/Hexfile/LICENSE_RELEASE.md if-no-files-found: error diff --git a/Dockerfile b/Dockerfile index 4575064b3b..e52516f7ad 100644 --- a/Dockerfile +++ b/Dockerfile @@ -4,9 +4,9 @@ LABEL maintainer="Ben V. Brown " WORKDIR /build # Add extra mirrors for options RUN echo "deb mirror://mirrors.ubuntu.com/mirrors.txt focal main restricted universe multiverse" > /etc/apt/sources.list && \ - echo "deb mirror://mirrors.ubuntu.com/mirrors.txt focal-updates main restricted universe multiverse" >> /etc/apt/sources.list && \ - echo "deb mirror://mirrors.ubuntu.com/mirrors.txt focal-security main restricted universe multiverse" >> /etc/apt/sources.list && \ - DEBIAN_FRONTEND=noninteractive apt-get update + echo "deb mirror://mirrors.ubuntu.com/mirrors.txt focal-updates main restricted universe multiverse" >> /etc/apt/sources.list && \ + echo "deb mirror://mirrors.ubuntu.com/mirrors.txt focal-security main restricted universe multiverse" >> /etc/apt/sources.list && \ + DEBIAN_FRONTEND=noninteractive apt-get update # Install dependencies to build the firmware RUN apt-get install -y \ make \ @@ -15,6 +15,7 @@ RUN apt-get install -y \ python3 \ python3-pip \ clang-format \ + dfu-util \ wget --no-install-recommends && \ apt-get clean RUN python3 -m pip install bdflib diff --git a/setup.sh b/setup.sh index b11b89cca9..6db08bedba 100644 --- a/setup.sh +++ b/setup.sh @@ -1,7 +1,7 @@ #!/bin/bash set -e # Setup shell file to setup the environment on an ubuntu machine -sudo apt-get update && sudo apt-get install -y make bzip2 git python3 python3-pip wget +sudo apt-get update && sudo apt-get install -y make bzip2 git python3 python3-pip wget dfu-util python3 -m pip install bdflib black flake8 sudo mkdir -p /build cd /build diff --git a/source/Makefile b/source/Makefile index 39eb601c0b..98ee60bc17 100644 --- a/source/Makefile +++ b/source/Makefile @@ -31,6 +31,7 @@ HOST_CC := gcc endif HOST_OUTPUT_DIR=Objects/host +DEVICE_DFU_ADDRESS=0x08000000 # Enumerate all of the include directories APP_INC_DIR = ./Core/Inc @@ -100,6 +101,7 @@ CPUFLAGS= -mcpu=cortex-m3 \ -mfloat-abi=soft flash_size=64k bootldr_size=0x4000 +DEVICE_DFU_ADDRESS=0x08004000 endif ifeq ($(model),$(filter $(model),$(ALL_MHP30_MODELS))) @@ -128,6 +130,7 @@ CPUFLAGS= -mcpu=cortex-m3 \ -mfloat-abi=soft flash_size=128k bootldr_size=32k +DEVICE_DFU_ADDRESS=0x08008000 endif ifeq ($(model),$(ALL_PINE_MODELS)) $(info Building for Pine64 ) @@ -336,7 +339,7 @@ OUT_OBJS_S=$(addprefix $(OUTPUT_DIR)/,$(OBJS_S)) default : firmware-EN -firmware-%: $(HEXFILE_DIR)/$(model)_%.hex $(HEXFILE_DIR)/$(model)_%.bin +firmware-%: $(HEXFILE_DIR)/$(model)_%.hex $(HEXFILE_DIR)/$(model)_%.bin $(HEXFILE_DIR)/$(model)_%.dfu @true ALL_FIRMWARE_TARGETS=$(addprefix firmware-,$(ALL_LANGUAGES)) @@ -354,6 +357,9 @@ all: $(ALL_FIRMWARE_TARGETS) $(SIZE) --format=berkeley $< $(OBJCOPY) $< -O binary $@ +%.dfu : %.bin Makefile + python3 dfuse-pack.py -b $(DEVICE_DFU_ADDRESS)@0:$< -D 0x28E9:0x0189 $@ + $(HEXFILE_DIR)/$(model)_%.elf : \ $(OUT_OBJS_S) $(OUT_OBJS) $(OUT_OBJS_CPP) \ $(OUTPUT_DIR)/Core/Gen/Translation.%.o \ diff --git a/source/dfuse-pack.py b/source/dfuse-pack.py new file mode 100755 index 0000000000..64c3ac3af3 --- /dev/null +++ b/source/dfuse-pack.py @@ -0,0 +1,349 @@ +#!/usr/bin/python + +# Written by Antonio Galea - 2010/11/18 +# Distributed under Gnu LGPL 3.0 +# see http://www.gnu.org/licenses/lgpl-3.0.txt + +import sys, struct, zlib, os +import binascii +from optparse import OptionParser + +try: + from intelhex import IntelHex +except ImportError: + IntelHex = None + +DEFAULT_DEVICE = "0x0483:0xdf11" +DEFAULT_NAME = b"ST..." + +# Prefix and Suffix sizes are derived from ST's DfuSe File Format Specification (UM0391), DFU revision 1.1a +PREFIX_SIZE = 11 +SUFFIX_SIZE = 16 + + +def named(tuple, names): + return dict(list(zip(names.split(), tuple))) + + +def consume(fmt, data, names): + n = struct.calcsize(fmt) + return named(struct.unpack(fmt, data[:n]), names), data[n:] + + +def cstring(bytestring): + return bytestring.partition(b"\0")[0] + + +def compute_crc(data): + return 0xFFFFFFFF & -zlib.crc32(data) - 1 + + +def parse(file, dump_images=False): + print('File: "%s"' % file) + data = open(file, "rb").read() + crc = compute_crc(data[:-4]) + prefix, data = consume("<5sBIB", data, "signature version size targets") + print( + "%(signature)s v%(version)d, image size: %(size)d, targets: %(targets)d" + % prefix + ) + for t in range(prefix["targets"]): + tprefix, data = consume( + "<6sBI255s2I", data, "signature altsetting named name size elements" + ) + tprefix["num"] = t + if tprefix["named"]: + tprefix["name"] = cstring(tprefix["name"]) + else: + tprefix["name"] = "" + print( + '%(signature)s %(num)d, alt setting: %(altsetting)s, name: "%(name)s", size: %(size)d, elements: %(elements)d' + % tprefix + ) + tsize = tprefix["size"] + target, data = data[:tsize], data[tsize:] + for e in range(tprefix["elements"]): + eprefix, target = consume("<2I", target, "address size") + eprefix["num"] = e + print(" %(num)d, address: 0x%(address)08x, size: %(size)d" % eprefix) + esize = eprefix["size"] + image, target = target[:esize], target[esize:] + if dump_images: + out = "%s.target%d.image%d.bin" % (file, t, e) + open(out, "wb").write(image) + print(' DUMPED IMAGE TO "%s"' % out) + if len(target): + print("target %d: PARSE ERROR" % t) + suffix = named( + struct.unpack("<4H3sBI", data[:SUFFIX_SIZE]), + "device product vendor dfu ufd len crc", + ) + print( + "usb: %(vendor)04x:%(product)04x, device: 0x%(device)04x, dfu: 0x%(dfu)04x, %(ufd)s, %(len)d, 0x%(crc)08x" + % suffix + ) + if crc != suffix["crc"]: + print("CRC ERROR: computed crc32 is 0x%08x" % crc) + data = data[SUFFIX_SIZE:] + if data: + print("PARSE ERROR") + + +def checkbin(binfile): + data = open(binfile, "rb").read() + if len(data) < SUFFIX_SIZE: + return + crc = compute_crc(data[:-4]) + suffix = named( + struct.unpack("<4H3sBI", data[-SUFFIX_SIZE:]), + "device product vendor dfu ufd len crc", + ) + if crc == suffix["crc"] and suffix["ufd"] == b"UFD": + print( + "usb: %(vendor)04x:%(product)04x, device: 0x%(device)04x, dfu: 0x%(dfu)04x, %(ufd)s, %(len)d, 0x%(crc)08x" + % suffix + ) + print("It looks like the file %s has a DFU suffix!" % binfile) + print("Please remove any DFU suffix and retry.") + sys.exit(1) + + +def build(file, targets, name=DEFAULT_NAME, device=DEFAULT_DEVICE): + data = b"" + for t, target in enumerate(targets): + tdata = b"" + for image in target: + tdata += ( + struct.pack("<2I", image["address"], len(image["data"])) + image["data"] + ) + ealt = image["alt"] + tdata = ( + struct.pack( + "<6sBI255s2I", b"Target", ealt, 1, name, len(tdata), len(target) + ) + + tdata + ) + data += tdata + data = ( + struct.pack( + "<5sBIB", b"DfuSe", 1, PREFIX_SIZE + len(data) + SUFFIX_SIZE, len(targets) + ) + + data + ) + v, d = [int(x, 0) & 0xFFFF for x in device.split(":", 1)] + data += struct.pack("<4H3sB", 0, d, v, 0x011A, b"UFD", SUFFIX_SIZE) + crc = compute_crc(data) + data += struct.pack("