rusefi
/
dfu_java
mirror of https://github.com/rusefi/dfu_java.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

DFU file support 

reducing Android language requirement
This commit is contained in:
rusefi 2020-07-03 00:18:00 -04:00
parent 6d2386a73e
commit f888811a1f
9 changed files with 265 additions and 50 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
src/main/java/com/rusefi/dfu/BinaryImage.java Normal file
View File

@ -0,0 +1,7 @@
package com.rusefi.dfu;
public interface BinaryImage {
byte[] getImage();
int getImageSize();
}

22
src/main/java/com/rusefi/dfu/DfuConnection.java
View File

@ -1,33 +1,11 @@
package com.rusefi.dfu;
import com.rusefi.dfu.commands.DfuCommandGetStatus;
import com.rusefi.dfu.usb4java.USBDfuConnection;
import java.nio.ByteBuffer;
public interface DfuConnection {
int SECOND = 1000;
int DFU_TIMEOUT = 10 * DfuConnection.SECOND;
static void waitStatus(USBDfuConnection device) {
DfuCommandGetStatus.State state = DfuCommandGetStatus.read(device);
System.out.println(" state " + state);
while (state == DfuCommandGetStatus.State.DFU_DOWNLOAD_BUSY || state == DfuCommandGetStatus.State.DFU_ERROR) {
sleep(106);
state = DfuCommandGetStatus.read(device);
System.out.println(" state " + state);
}
}
static void sleep(int millis) {
System.out.println("Sleep " + millis);
try {
Thread.sleep(millis);
} catch (InterruptedException e) {
throw new IllegalStateException(e);
}
}
FlashRange getFlashRange();
int getTransferSize();

25
src/main/java/com/rusefi/dfu/DfuConnectionUtil.java Normal file
View File

@ -0,0 +1,25 @@
package com.rusefi.dfu;
import com.rusefi.dfu.commands.DfuCommandGetStatus;
import com.rusefi.dfu.usb4java.USBDfuConnection;
public class DfuConnectionUtil {
public static void waitStatus(USBDfuConnection device) {
DfuCommandGetStatus.State state = DfuCommandGetStatus.read(device);
System.out.println(" state " + state);
while (state == DfuCommandGetStatus.State.DFU_DOWNLOAD_BUSY || state == DfuCommandGetStatus.State.DFU_ERROR) {
sleep(106);
state = DfuCommandGetStatus.read(device);
System.out.println(" state " + state);
}
}
public static void sleep(int millis) {
System.out.println("Sleep " + millis);
try {
Thread.sleep(millis);
} catch (InterruptedException e) {
throw new IllegalStateException(e);
}
}
}

211
src/main/java/com/rusefi/dfu/DfuImage.java Normal file
View File

@ -0,0 +1,211 @@
package com.rusefi.dfu;
import java.io.File;
import java.io.FileInputStream;
import java.io.IOException;
/**
* Inspired by https://github.com/UmbrelaSmart/android-stm32-dfu-programmer
*/
public class DfuImage implements BinaryImage {
// private final static int ELEMENT1_OFFSET = 293; // constant offset in file array where image data starts
private final static int TARGET_NAME_START = 22;
private final static int TARGET_NAME_MAX_END = 276;
private final static int TARGET_SIZE = 277;
private final static int TARGET_NUM_ELEMENTS = 281;
private byte[] content;
private int PID;
private int VID;
private int elementStartAddress;
private int elementLength;
private String TargetName;
private int TargetSize;
private int NumElements;
public void read(String fileName) {
File file = new File(fileName);
this.content = new byte[(int) file.length()];
FileInputStream fileInputStream;
try {
fileInputStream = new FileInputStream(fileName);
fileInputStream.read(this.content);
fileInputStream.close();
} catch (IOException e) {
throw new IllegalStateException(e);
}
verifyFile();
}
@Override
public byte[] getImage() {
return content;
}
@Override
public int getImageSize() {
return content.length;
}
private static int calculateCRC(byte[] FileData) {
int crc = -1;
for (int i = 0; i < FileData.length - 4; i++) {
crc = CRC_TABLE[(crc ^ FileData[i]) & 0xff] ^ (crc >>> 8);
}
return crc;
}
private void verifyFile() {
// todo for now i expect the file to be not corrupted
int length = this.content.length;
int crcIndex = length - 4;
int crc = 0;
crc |= this.content[crcIndex++] & 0xFF;
crc |= (this.content[crcIndex++] & 0xFF) << 8;
crc |= (this.content[crcIndex++] & 0xFF) << 16;
crc |= (this.content[crcIndex] & 0xFF) << 24;
// do crc check
if (crc != calculateCRC(this.content)) {
throw new IllegalArgumentException("CRC Failed");
}
// Check the prefix
String prefix = new String(this.content, 0, 5);
if (prefix.compareTo("DfuSe") != 0) {
throw new IllegalArgumentException("File signature error");
}
// check dfuSe Version
if (this.content[5] != 1) {
throw new IllegalArgumentException("DFU file version must be 1");
}
// Check the suffix
String suffix = new String(this.content, length - 8, 3);
if (suffix.compareTo("UFD") != 0) {
throw new IllegalArgumentException("File suffix error");
}
if ((this.content[length - 5] != 16) || (this.content[length - 10] != 0x1A) || (this.content[length - 9] != 0x01)) {
throw new IllegalArgumentException("File number error");
}
// Now check the target prefix, we assume there is only one target in the file
String target = new String(this.content, 11, 6);
if (target.compareTo("Target") != 0) {
throw new IllegalArgumentException("Target signature error");
}
if (0 != this.content[TARGET_NAME_START]) {
String tempName = new String(this.content, TARGET_NAME_START, TARGET_NAME_MAX_END);
int foundNullAt = tempName.indexOf(0);
this.TargetName = tempName.substring(0, foundNullAt);
} else {
throw new IllegalArgumentException("No Target Name Exist in File");
}
System.out.println("Firmware Target Name: " + this.TargetName);
this.TargetSize = this.content[TARGET_SIZE] & 0xFF;
this.TargetSize |= (this.content[TARGET_SIZE + 1] & 0xFF) << 8;
this.TargetSize |= (this.content[TARGET_SIZE + 2] & 0xFF) << 16;
this.TargetSize |= (this.content[TARGET_SIZE + 3] & 0xFF) << 24;
System.out.println("Firmware Target Size: " + this.TargetSize);
this.NumElements = this.content[TARGET_NUM_ELEMENTS] & 0xFF;
this.NumElements |= (this.content[TARGET_NUM_ELEMENTS + 1] & 0xFF) << 8;
this.NumElements |= (this.content[TARGET_NUM_ELEMENTS + 2] & 0xFF) << 16;
this.NumElements |= (this.content[TARGET_NUM_ELEMENTS + 3] & 0xFF) << 24;
System.out.println("Firmware Num of Elements: " + this.NumElements);
if (this.NumElements > 1) {
/* If you get this error, that means that the C-compiler IDE is treating the Reset Vector ISR
and the data ( your code) as two separate elements.
This problem has been observed with The Atollic TrueStudio V5.5.2
The version of Atollic that works with this is v5.3.0
The version of DfuSe FileManager is v3.0.3
Refer to ST document UM0391 for more details on DfuSe format
*/
throw new IllegalArgumentException("Do not support multiple Elements inside Image");
}
// Get Element Flash start address and size
elementStartAddress = this.content[285] & 0xFF;
elementStartAddress |= (this.content[286] & 0xFF) << 8;
elementStartAddress |= (this.content[287] & 0xFF) << 16;
elementStartAddress |= (this.content[288] & 0xFF) << 24;
this.elementLength = this.content[289] & 0xFF;
this.elementLength |= (this.content[290] & 0xFF) << 8;
this.elementLength |= (this.content[291] & 0xFF) << 16;
this.elementLength |= (this.content[292] & 0xFF) << 24;
if (this.elementLength < 512) {
throw new IllegalArgumentException("Element Size is too small");
}
System.out.println(String.format("%x %x", elementStartAddress, elementLength));
// Get VID, PID and version number
this.VID = (this.content[length - 11] & 0xFF) << 8;
this.VID |= (this.content[length - 12] & 0xFF);
this.PID = (this.content[length - 13] & 0xFF) << 8;
this.PID |= (this.content[length - 14] & 0xFF);
int bootVersion = (this.content[length - 15] & 0xFF) << 8;
bootVersion |= (this.content[length - 16] & 0xFF);
System.out.println(String.format("VID=%x PID=%x", VID, PID));
}
private final static int[] CRC_TABLE = {
0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f,
0xe963a535, 0x9e6495a3, 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988,
0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, 0x1db71064, 0x6ab020f2,
0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7,
0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9,
0xfa0f3d63, 0x8d080df5, 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172,
0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, 0x35b5a8fa, 0x42b2986c,
0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59,
0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423,
0xcfba9599, 0xb8bda50f, 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924,
0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, 0x76dc4190, 0x01db7106,
0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433,
0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d,
0x91646c97, 0xe6635c01, 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e,
0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, 0x65b0d9c6, 0x12b7e950,
0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65,
0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7,
0xa4d1c46d, 0xd3d6f4fb, 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0,
0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, 0x5005713c, 0x270241aa,
0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f,
0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81,
0xb7bd5c3b, 0xc0ba6cad, 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a,
0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, 0xe3630b12, 0x94643b84,
0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1,
0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb,
0x196c3671, 0x6e6b06e7, 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc,
0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, 0xd6d6a3e8, 0xa1d1937e,
0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b,
0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55,
0x316e8eef, 0x4669be79, 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236,
0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, 0xc5ba3bbe, 0xb2bd0b28,
0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d,
0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f,
0x72076785, 0x05005713, 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38,
0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, 0x86d3d2d4, 0xf1d4e242,
0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777,
0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69,
0x616bffd3, 0x166ccf45, 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2,
0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, 0xaed16a4a, 0xd9d65adc,
0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9,
0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693,
0x54de5729, 0x23d967bf, 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94,
0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d
};
}

10
src/main/java/com/rusefi/dfu/DfuLogic.java
View File

@ -15,8 +15,8 @@ public class DfuLogic {
public static final byte USB_DT_DFU = 0x21;
public static final String FLASH_TAG = "Flash";
static void uploadImage(USBDfuConnection device, HexImage image) {
List<Integer> erasePages = image.getRange().pagesForSize(image.getTotalBytes());
static void uploadImage(USBDfuConnection device, HexImage image, FlashRange range) {
List<Integer> erasePages = range.pagesForSize(image.getImageSize());
// todo: smarted start address logic
int eraseAddress = 0x08000000;
for (Integer erasePage : erasePages) {
@ -25,16 +25,16 @@ public class DfuLogic {
}
System.out.println(String.format("Erased up to %x", eraseAddress));
for (int offset = 0; offset < image.getMaxOffset() - image.getRange().getBaseAddress(); offset += device.getTransferSize()) {
for (int offset = 0; offset < image.getImage().length; offset += device.getTransferSize()) {
DfuSeCommandSetAddress.execute(device, device.getFlashRange().getBaseAddress() + offset);
DfuConnection.waitStatus(device);
DfuConnectionUtil.waitStatus(device);
ByteBuffer buffer = ByteBuffer.allocateDirect(device.getTransferSize());
buffer.put(image.getImage(), offset, device.getTransferSize());
device.sendData(DfuCommmand.DNLOAD, DfuSeCommand.W_DNLOAD, buffer);
// AN3156 USB DFU protocol used in the STM32 bootloader
// "The Write memory operation is effectively executed only when a DFU_GETSTATUS request is issued by the host. "
DfuConnection.waitStatus(device);
DfuConnectionUtil.waitStatus(device);
}
}
}

21
src/main/java/com/rusefi/dfu/HexImage.java
View File

@ -8,15 +8,13 @@ import java.io.IOException;
import java.io.InputStream;
import java.util.concurrent.atomic.AtomicInteger;
public class HexImage extends AtomicInteger {
public class HexImage implements BinaryImage {
private final byte[] image;
private final FlashRange range;
private final int totalBytes;
private final int maxOffset;
public HexImage(byte[] image, FlashRange range, int totalBytes, int maxOffset) {
public HexImage(byte[] image, int totalBytes, int maxOffset) {
this.image = image;
this.range = range;
this.totalBytes = totalBytes;
this.maxOffset = maxOffset;
}
@ -54,30 +52,23 @@ public class HexImage extends AtomicInteger {
});
ihp.parse();
return new HexImage(image, range, totalBytesReceived.get(), maxOffset.get());
return new HexImage(image, totalBytesReceived.get(), maxOffset.get());
}
@Override
public byte[] getImage() {
return image;
}
public int getTotalBytes() {
@Override
public int getImageSize() {
return totalBytes;
}
public int getMaxOffset() {
return maxOffset;
}
public FlashRange getRange() {
return range;
}
@Override
public String toString() {
return "HexImage{" +
"image=" + image.length +
", range=" + range +
", totalBytes=" + totalBytes +
", maxOffset=" + maxOffset +
'}';

7
src/main/java/com/rusefi/dfu/commands/DfuSeCommandErasePage.java
View File

@ -1,9 +1,6 @@
package com.rusefi.dfu.commands;
import com.rusefi.dfu.DfuCommmand;
import com.rusefi.dfu.DfuConnection;
import com.rusefi.dfu.DfuSeCommand;
import com.rusefi.dfu.LogUtil;
import com.rusefi.dfu.*;
import com.rusefi.dfu.usb4java.USBDfuConnection;
import org.apache.commons.logging.Log;
@ -16,6 +13,6 @@ public class DfuSeCommandErasePage {
log.info(String.format("SetAddress %x", address));
ByteBuffer buffer = DfuSeCommandSetAddress.createSpecialCommandBuffer(DfuSeCommand.SE_ERASE_PAGE, address);
session.sendData(DfuCommmand.DNLOAD, DfuSeCommand.W_SPECIAL, buffer);
DfuConnection.waitStatus(session);
DfuConnectionUtil.waitStatus(session);
}
}

8
src/test/java/com/rusefi/dfu/DfuReaderSandbox.java Normal file
View File

@ -0,0 +1,8 @@
package com.rusefi.dfu;
public class DfuReaderSandbox {
public static void main(String[] args) {
DfuImage dfuImage = new DfuImage();
dfuImage.read("rusefi.dfu");
}
}

4
src/test/java/com/rusefi/dfu/Sandbox.java
View File

@ -22,10 +22,8 @@ public class Sandbox {
HexImage image = HexImage.loadHexToBuffer(new FileInputStream("rusefi.hex"), device.getFlashRange());
DfuLogic.uploadImage(device, image);
DfuLogic.uploadImage(device, image, device.getFlashRange());
log.info("STM32 DFU " + device);
}
}