no.nordicsemi.android.dfu.internal

Class ArchiveInputStream

java.lang.Object

java.io.InputStream

java.io.FilterInputStream

java.util.zip.InflaterInputStream

java.util.zip.ZipInputStream

no.nordicsemi.android.dfu.internal.ArchiveInputStream

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class ArchiveInputStream
extends java.util.zip.ZipInputStream

Reads the firmware files from the a ZIP file. The ZIP file must be either created using the nrf utility tool, available together with Master Control Panel v3.8.0+, or follow the backward compatibility syntax: must contain only files with names: application.hex/bin, softdevice.hex/dat or bootloader.hex/bin, optionally also application.dat and/or system.dat with init packets.

The ArchiveInputStream will read only files with types specified by types parameter of the constructor.

Field Summary

Fields inherited from class java.util.zip.ZipInputStream

CENATT, CENATX, CENCOM, CENCRC, CENDSK, CENEXT, CENFLG, CENHDR, CENHOW, CENLEN, CENNAM, CENOFF, CENSIG, CENSIZ, CENTIM, CENVEM, CENVER, ENDCOM, ENDHDR, ENDOFF, ENDSIG, ENDSIZ, ENDSUB, ENDTOT, EXTCRC, EXTHDR, EXTLEN, EXTSIG, EXTSIZ, LOCCRC, LOCEXT, LOCFLG, LOCHDR, LOCHOW, LOCLEN, LOCNAM, LOCSIG, LOCSIZ, LOCTIM, LOCVER

Fields inherited from class java.util.zip.InflaterInputStream

buf, closed, inf, len

Fields inherited from class java.io.FilterInputStream

in

Constructor Summary

Constructors

Constructor and Description
ArchiveInputStream(java.io.InputStream stream, int mbrSize, int types) The ArchiveInputStream read HEX or BIN files from the Zip stream.

Method Summary

Modifier and Type	Method and Description
int	applicationImageSize() Returns the total size of the Application firmware.
int	available() Returns the number of bytes that has not been read yet.
int	bootloaderImageSize() Returns the total size of the Bootloader firmware.
void	close()
byte[]	getApplicationInit() Returns the content of the init file for the Application or null if no application file in the ZIP, or the DAT file is not provided.
int	getBytesRead() Returns number of bytes read until now.
int	getContentType() Returns the content type based on the content of the ZIP file.
long	getCrc32() Returns the CRC32 of the part of the firmware that was already read.
byte[]	getSystemInit() Returns the content of the init file for SoftDevice and/or Bootloader.
boolean	isSecureDfuRequired() This method returns true if the content of the ZIP file may be sent only using Secure DFU.
void	mark(int readlimit) Marks the current position in the stream.
boolean	markSupported()
int	read(byte[] buffer)
void	reset()
int	setContentType(int type) Truncates the current content type.
int	softDeviceImageSize() Returns the total size of the SoftDevice firmware.

Methods inherited from class java.util.zip.ZipInputStream

closeEntry, createZipEntry, getNextEntry, read, skip

Methods inherited from class java.util.zip.InflaterInputStream

fill, read

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ArchiveInputStream

public ArchiveInputStream(java.io.InputStream stream,
                          int mbrSize,
                          int types)
                   throws java.io.IOException

The ArchiveInputStream read HEX or BIN files from the Zip stream. It may skip some of them, depending on the value of the types parameter. This is useful if the DFU service wants to send the Soft Device and Bootloader only, and then the Application in the following connection, despite the ZIP file contains all 3 HEX/BIN files. When types is equal to DfuBaseService.TYPE_AUTO all present files are read.

Use bit combination of the following types:

• DfuBaseService.TYPE_SOFT_DEVICE
• DfuBaseService.TYPE_BOOTLOADER
• DfuBaseService.TYPE_APPLICATION
• DfuBaseService.TYPE_AUTO

Parameters:

stream - the Zip Input Stream

mbrSize - The size of the MRB segment (Master Boot Record) on the device. The parser will cut data from addresses below that number from all HEX files.

types - File types that are to be read from the ZIP. Use DfuBaseService.TYPE_APPLICATION etc.

Throws:

java.io.IOException

Method Detail

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class java.util.zip.ZipInputStream

Throws:

java.io.IOException

read

public int read(@NonNull
                byte[] buffer)
         throws java.io.IOException

Overrides:

read in class java.io.FilterInputStream

Throws:

java.io.IOException

markSupported

public boolean markSupported()

Overrides:

markSupported in class java.util.zip.InflaterInputStream

mark

public void mark(int readlimit)

Marks the current position in the stream. The parameter is ignored.

Overrides:

mark in class java.util.zip.InflaterInputStream

Parameters:

readlimit - this parameter is ignored, can be anything

reset

public void reset()
           throws java.io.IOException

Overrides:

reset in class java.util.zip.InflaterInputStream

Throws:

java.io.IOException

getBytesRead

public int getBytesRead()

Returns number of bytes read until now.

getCrc32

public long getCrc32()

Returns the CRC32 of the part of the firmware that was already read.

Returns:

the CRC

getContentType

public int getContentType()

Returns the content type based on the content of the ZIP file. The content type may be truncated using setContentType(int).

Returns:

a bit field of TYPE_SOFT_DEVICE, TYPE_BOOTLOADER and TYPE_APPLICATION

setContentType

public int setContentType(int type)

Truncates the current content type. May be used to hide some files, e.g. to send Soft Device and Bootloader without Application or only the Application.

Parameters:

type - the new type

Returns:

the final type after truncating

available

public int available()

Returns the number of bytes that has not been read yet. This value includes only firmwares matching the content type set by the construcotor or the setContentType(int) method.

Overrides:

available in class java.util.zip.ZipInputStream

softDeviceImageSize

public int softDeviceImageSize()

Returns the total size of the SoftDevice firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.

Returns:

the size of the SoftDevice firmware (BIN part)

bootloaderImageSize

public int bootloaderImageSize()

Returns the total size of the Bootloader firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.

Returns:

the size of the Bootloader firmware (BIN part)

applicationImageSize

public int applicationImageSize()

Returns the total size of the Application firmware. In case the firmware was given as a HEX, this method returns the size of the BIN content of the file.

Returns:

the size of the Application firmware (BIN part)

getSystemInit

public byte[] getSystemInit()

Returns the content of the init file for SoftDevice and/or Bootloader. When both SoftDevice and Bootloader are present in the ZIP file (as two files using the compatibility mode or as one file using the new Distribution packet) the system init contains validation data for those two files combined (e.g. the CRC value). This method may return null if there is no SoftDevice nor Bootloader in the ZIP or the DAT file is not present there.

Returns:

the content of the init packet for SoftDevice and/or Bootloader

getApplicationInit

public byte[] getApplicationInit()

Returns the content of the init file for the Application or null if no application file in the ZIP, or the DAT file is not provided.

Returns:

the content of the init packet for Application

isSecureDfuRequired

public boolean isSecureDfuRequired()

This method returns true if the content of the ZIP file may be sent only using Secure DFU. The reason may be that the ZIP contains a single bin file with SD and/or BL together with App, which has to be sent in a single connection. Sizes of each component are not given explicitly in the Manifest (even if they are, they are ignored). They are hidden in the Init Packet instead.

Returns:

true if the content of this ZIP may only be sent using Secure DFU.