Package com.dalsemi.onewire.container
Class MemoryBankScratchCRCPW
java.lang.Object
com.dalsemi.onewire.container.MemoryBankScratchCRCPW
- All Implemented Interfaces:
MemoryBank
,PagedMemoryBank
Memory bank class for the Scratchpad section of NVRAM iButtons and 1-Wire
devices with password protected memory pages.
-
Field Summary
Modifier and TypeFieldDescriptionprotected String
Memory bank descriptionsprotected byte
Copy Scratchpad Commandprotected boolean
Flag to indicate that speed needs to be setboolean
Enable Provided Power for some Password checking.protected boolean
Flag if reading a page in memory bank provides optional extra information (counter, tamper protection, SHA-1...)protected String
Extra information description when reading page in memory bankprotected int
Length of extra information when reading a page in memory bankprotected byte[]
block of 0xFF's used for faster read pre-fill of 1-Wire blocksprotected boolean
Memory bank usage flagsprotected OneWireContainer
Reference to the OneWireContainer this bank resides on.protected PasswordContainer
The Password container to access the 8 byte passwordsprotected int
Max data length in page packet in memory bankprotected boolean
Flag if memory bank is non volatile (will not erase when power removed)protected int
Number of pages in memory bankprotected boolean
Flag if memory bank has page auto-CRC generationprotected int
page length in memory bankprotected boolean
Flag if memory bank needs power delivery to writeprotected boolean
Flag if memory bank needs program Pulse to writestatic final byte
Read Scratchpad Commandprotected boolean
Flag if memory bank is read onlyprotected boolean
Flag if memory bank is read/writeprotected int
Size of memory bank in bytesprotected int
Starting physical address in memory bank.static final byte
Write Scratchpad Commandprotected boolean
Flag if memory bank is write once (EPROM)protected boolean
Flag if read back verification is enabled in 'write()'. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
Check the device speed if has not been done before or if an error was detected.void
copyScratchpad
(int startAddr, int len) Copy the scratchpad page to memory.void
copyScratchpad
(int startAddr, int len, boolean WriteProtect) Copy the scratchpad page to memory.void
Set the flag to indicate the next 'checkSpeed()' will force a speed set and verify 'doSpeed()'.Query to see get a string description of the current memory bank.Query to get a string description of what is contained in the Extra Informationed return when reading pages in the current memory bank.int
Query to get the length in bytes of extra information that is read when read a page in the current memory bank.int
Query to get Maximum data page length in bytes for a packet read or written in the current memory bank.int
Query to get the number of pages in current memory bank.int
Query to get page length in bytes in current memory bank.int
getSize()
Query to get the memory bank size in bytes.int
Query to get the starting physical address of this bank.boolean
Checks to see if this memory bank's pages deliver extra information outside of the normal data space, when read.boolean
Query to see if current memory bank pages can be read with the contents being verified by a device generated CRC.boolean
Query to see if the current memory bank is general purpose user memory.boolean
Query to see if current memory bank non-volatile.boolean
Query to see if current memory bank is read only.boolean
Query to see if current memory bank is read/write.boolean
Query to see if current memory bank is write write once such as with EPROM technology.boolean
Query to see if current memory bank pages need the adapter to have a 'PowerDelivery' feature in order to write to the memory.boolean
Query to see if current memory bank pages need the adapter to have a 'ProgramPulse' in order to write to the memory.void
read
(int startAddr, boolean readContinue, byte[] readBuf, int offset, int len) Read memory in the current bank with no CRC checking (device or data).void
readPage
(int page, boolean readContinue, byte[] readBuf, int offset) Read page in the current bank with no CRC checking (device or data).void
readPage
(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) Read page with extra information in the current bank with no CRC checking (device or data).void
readPageCRC
(int page, boolean readContinue, byte[] readBuf, int offset) Read a complete memory page with CRC verification provided by the device.void
readPageCRC
(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) Read a complete memory page with CRC verification provided by the device with extra information.int
readPagePacket
(int page, boolean readContinue, byte[] readBuf, int offset) Read a Universal Data Packet.int
readPagePacket
(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) Read a Universal Data Packet and extra information.void
readScratchpad
(byte[] readBuf, int offset, int len, byte[] extraInfo) Read the scratchpad page of memory from a NVRAM device This method reads and returns the entire scratchpad after the byte offset regardless of the actual ending offsetvoid
setWriteVerification
(boolean doReadVerf) Set the write verification for the 'write()' method.void
write
(int startAddr, byte[] writeBuf, int offset, int len) Write memory in the current bank.void
writePagePacket
(int page, byte[] writeBuf, int offset, int len) Write a Universal Data Packet.void
writeScratchpad
(int startAddr, byte[] writeBuf, int offset, int len) Write to the scratchpad page of memory a NVRAM device.
-
Field Details
-
ibPass
The Password container to access the 8 byte passwords -
enablePower
public boolean enablePowerEnable Provided Power for some Password checking. -
WRITE_SCRATCHPAD_COMMAND
public static final byte WRITE_SCRATCHPAD_COMMANDWrite Scratchpad Command- See Also:
-
READ_SCRATCHPAD_COMMAND
public static final byte READ_SCRATCHPAD_COMMANDRead Scratchpad Command- See Also:
-
ib
Reference to the OneWireContainer this bank resides on. -
ffBlock
protected byte[] ffBlockblock of 0xFF's used for faster read pre-fill of 1-Wire blocks -
COPY_SCRATCHPAD_COMMAND
protected byte COPY_SCRATCHPAD_COMMANDCopy Scratchpad Command -
doSetSpeed
protected boolean doSetSpeedFlag to indicate that speed needs to be set -
size
protected int sizeSize of memory bank in bytes -
bankDescription
Memory bank descriptions -
generalPurposeMemory
protected boolean generalPurposeMemoryMemory bank usage flags -
readWrite
protected boolean readWriteFlag if memory bank is read/write -
writeOnce
protected boolean writeOnceFlag if memory bank is write once (EPROM) -
readOnly
protected boolean readOnlyFlag if memory bank is read only -
nonVolatile
protected boolean nonVolatileFlag if memory bank is non volatile (will not erase when power removed) -
programPulse
protected boolean programPulseFlag if memory bank needs program Pulse to write -
powerDelivery
protected boolean powerDeliveryFlag if memory bank needs power delivery to write -
startPhysicalAddress
protected int startPhysicalAddressStarting physical address in memory bank. Needed for different types of memory in the same logical memory bank. This can be used to separate them into two virtual memory banks. Example: DS2406 status page has mixed EPROM and Volatile RAM. -
writeVerification
protected boolean writeVerificationFlag if read back verification is enabled in 'write()'. -
numberPages
protected int numberPagesNumber of pages in memory bank -
pageLength
protected int pageLengthpage length in memory bank -
maxPacketDataLength
protected int maxPacketDataLengthMax data length in page packet in memory bank -
pageAutoCRC
protected boolean pageAutoCRCFlag if memory bank has page auto-CRC generation -
extraInfo
protected boolean extraInfoFlag if reading a page in memory bank provides optional extra information (counter, tamper protection, SHA-1...) -
extraInfoLength
protected int extraInfoLengthLength of extra information when reading a page in memory bank -
extraInfoDescription
Extra information description when reading page in memory bank
-
-
Constructor Details
-
MemoryBankScratchCRCPW
Memory bank contstuctor. Requires reference to the OneWireContainer this memory bank resides on.
-
-
Method Details
-
readPageCRC
public void readPageCRC(int page, boolean readContinue, byte[] readBuf, int offset) throws OneWireIOException, OneWireException Read a complete memory page with CRC verification provided by the device. Not supported by all devices. See the method 'hasPageAutoCRC()'.- Specified by:
readPageCRC
in interfacePagedMemoryBank
- Parameters:
page
- page number to readreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPagePacket() continuous where the last one stopped and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to put data read. Must have at least 'getMaxPacketDataLength()' elements.offset
- offset into readBuf to place data- Throws:
OneWireIOException
OneWireException
- See Also:
-
readPageCRC
public void readPageCRC(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) throws OneWireIOException, OneWireException Read a complete memory page with CRC verification provided by the device with extra information. Not supported by all devices. See the method 'hasPageAutoCRC()'. See the method 'hasExtraInfo()' for a description of the optional extra information.- Specified by:
readPageCRC
in interfacePagedMemoryBank
- Parameters:
page
- page number to readreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPagePacket() continuous where the last one stopped and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to put data read. Must have at least 'getMaxPacketDataLength()' elements.offset
- offset into readBuf to place dataextraInfo
- byte array to put extra info read into- Throws:
OneWireIOException
OneWireException
- See Also:
-
readScratchpad
public void readScratchpad(byte[] readBuf, int offset, int len, byte[] extraInfo) throws OneWireIOException, OneWireException Read the scratchpad page of memory from a NVRAM device This method reads and returns the entire scratchpad after the byte offset regardless of the actual ending offset- Parameters:
readBuf
- byte array to place read data into length of array is always pageLength.offset
- offset into readBuf to pug datalen
- length in bytes to readextraInfo
- byte array to put extra info read into (TA1, TA2, e/s byte) length of array is always extraInfoLength. Can be 'null' if extra info is not needed.- Throws:
OneWireIOException
OneWireException
-
copyScratchpad
Copy the scratchpad page to memory.- Parameters:
startAddr
- starting addresslen
- length in bytes that was written already- Throws:
OneWireIOException
OneWireException
-
writeScratchpad
public void writeScratchpad(int startAddr, byte[] writeBuf, int offset, int len) throws OneWireIOException, OneWireException Write to the scratchpad page of memory a NVRAM device.- Parameters:
startAddr
- starting addresswriteBuf
- byte array containing data to writeoffset
- offset into readBuf to place datalen
- length in bytes to write- Throws:
OneWireIOException
OneWireException
-
getBankDescription
Query to see get a string description of the current memory bank.- Specified by:
getBankDescription
in interfaceMemoryBank
- Returns:
- String containing the memory bank description
-
isGeneralPurposeMemory
public boolean isGeneralPurposeMemory()Query to see if the current memory bank is general purpose user memory. If it is NOT then it is Memory-Mapped and writing values to this memory will affect the behavior of the 1-Wire device.- Specified by:
isGeneralPurposeMemory
in interfaceMemoryBank
- Returns:
- 'true' if current memory bank is general purpose
-
isReadWrite
public boolean isReadWrite()Query to see if current memory bank is read/write.- Specified by:
isReadWrite
in interfaceMemoryBank
- Returns:
- 'true' if current memory bank is read/write
-
isWriteOnce
public boolean isWriteOnce()Query to see if current memory bank is write write once such as with EPROM technology.- Specified by:
isWriteOnce
in interfaceMemoryBank
- Returns:
- 'true' if current memory bank can only be written once
-
isReadOnly
public boolean isReadOnly()Query to see if current memory bank is read only.- Specified by:
isReadOnly
in interfaceMemoryBank
- Returns:
- 'true' if current memory bank can only be read
-
isNonVolatile
public boolean isNonVolatile()Query to see if current memory bank non-volatile. Memory is non-volatile if it retains its contents even when removed from the 1-Wire network.- Specified by:
isNonVolatile
in interfaceMemoryBank
- Returns:
- 'true' if current memory bank non volatile.
-
needsProgramPulse
public boolean needsProgramPulse()Query to see if current memory bank pages need the adapter to have a 'ProgramPulse' in order to write to the memory.- Specified by:
needsProgramPulse
in interfaceMemoryBank
- Returns:
- 'true' if writing to the current memory bank pages requires a 'ProgramPulse'.
- See Also:
-
needsPowerDelivery
public boolean needsPowerDelivery()Query to see if current memory bank pages need the adapter to have a 'PowerDelivery' feature in order to write to the memory.- Specified by:
needsPowerDelivery
in interfaceMemoryBank
- Returns:
- 'true' if writing to the current memory bank pages requires 'PowerDelivery'.
- See Also:
-
getStartPhysicalAddress
public int getStartPhysicalAddress()Query to get the starting physical address of this bank. Physical banks are sometimes sub-divided into logical banks due to changes in attributes.- Specified by:
getStartPhysicalAddress
in interfaceMemoryBank
- Returns:
- physical starting address of this logical bank.
-
getSize
public int getSize()Query to get the memory bank size in bytes.- Specified by:
getSize
in interfaceMemoryBank
- Returns:
- memory bank size in bytes.
-
getNumberPages
public int getNumberPages()Query to get the number of pages in current memory bank.- Specified by:
getNumberPages
in interfacePagedMemoryBank
- Returns:
- number of pages in current memory bank
-
getPageLength
public int getPageLength()Query to get page length in bytes in current memory bank.- Specified by:
getPageLength
in interfacePagedMemoryBank
- Returns:
- page length in bytes in current memory bank
-
getMaxPacketDataLength
public int getMaxPacketDataLength()Query to get Maximum data page length in bytes for a packet read or written in the current memory bank. See the 'ReadPagePacket()' and 'WritePagePacket()' methods. This method is only useful if the current memory bank is general purpose memory.- Specified by:
getMaxPacketDataLength
in interfacePagedMemoryBank
- Returns:
- max packet page length in bytes in current memory bank
- See Also:
-
hasPageAutoCRC
public boolean hasPageAutoCRC()Query to see if current memory bank pages can be read with the contents being verified by a device generated CRC. This is used to see if the 'ReadPageCRC()' can be used.- Specified by:
hasPageAutoCRC
in interfacePagedMemoryBank
- Returns:
- 'true' if current memory bank can be read with self generated CRC.
- See Also:
-
hasExtraInfo
public boolean hasExtraInfo()Checks to see if this memory bank's pages deliver extra information outside of the normal data space, when read. Examples of this may be a redirection byte, counter, tamper protection bytes, or SHA-1 result. If this method returns true then the methods with an 'extraInfo' parameter can be used:readPage
,readPageCRC
, andreadPagePacket
.- Specified by:
hasExtraInfo
in interfacePagedMemoryBank
- Returns:
true
if reading the this memory bank's pages provides extra information- Since:
- 1-Wire API 0.01
- See Also:
-
getExtraInfoLength
public int getExtraInfoLength()Query to get the length in bytes of extra information that is read when read a page in the current memory bank. See 'hasExtraInfo()'.- Specified by:
getExtraInfoLength
in interfacePagedMemoryBank
- Returns:
- number of bytes in Extra Information read when reading pages in the current memory bank.
- See Also:
-
getExtraInfoDescription
Query to get a string description of what is contained in the Extra Informationed return when reading pages in the current memory bank. See 'hasExtraInfo()'.- Specified by:
getExtraInfoDescription
in interfacePagedMemoryBank
- Returns:
- string describing extra information.
- See Also:
-
setWriteVerification
public void setWriteVerification(boolean doReadVerf) Set the write verification for the 'write()' method.- Specified by:
setWriteVerification
in interfaceMemoryBank
- Parameters:
doReadVerf
- true (default) verify write in 'write' false, don't verify write (used on Write-Once bit manipulation)- See Also:
-
read
public void read(int startAddr, boolean readContinue, byte[] readBuf, int offset, int len) throws OneWireIOException, OneWireException Read memory in the current bank with no CRC checking (device or data). The resulting data from this API may or may not be what is on the 1-Wire device. It is recommends that the data contain some kind of checking (CRC) like in the readPagePacket() method or have the 1-Wire device provide the CRC as in readPageCRC(). readPageCRC() however is not supported on all memory types, see 'hasPageAutoCRC()'. If neither is an option then this method could be called more then once to at least verify that the same thing is read consistently.- Specified by:
read
in interfaceMemoryBank
- Parameters:
startAddr
- starting addressreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new read() continuous where the last one led off and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to place read data intooffset
- offset into readBuf to place datalen
- length in bytes to read- Throws:
OneWireIOException
OneWireException
-
write
public void write(int startAddr, byte[] writeBuf, int offset, int len) throws OneWireIOException, OneWireException Write memory in the current bank. It is recommended that when writing data that some structure in the data is created to provide error free reading back with read(). Or the method 'writePagePacket()' could be used which automatically wraps the data in a length and CRC. When using on Write-Once devices care must be taken to write into into empty space. If write() is used to write over an unlocked page on a Write-Once device it will fail. If write verification is turned off with the method 'setWriteVerification(false)' then the result will be an 'AND' of the existing data and the new data.- Specified by:
write
in interfaceMemoryBank
- Parameters:
startAddr
- starting addresswriteBuf
- byte array containing data to writeoffset
- offset into writeBuf to get datalen
- length in bytes to write- Throws:
OneWireIOException
OneWireException
-
readPage
public void readPage(int page, boolean readContinue, byte[] readBuf, int offset) throws OneWireIOException, OneWireException Read page in the current bank with no CRC checking (device or data). The resulting data from this API may or may not be what is on the 1-Wire device. It is recommends that the data contain some kind of checking (CRC) like in the readPagePacket() method or have the 1-Wire device provide the CRC as in readPageCRC(). readPageCRC() however is not supported on all memory types, see 'hasPageAutoCRC()'. If neither is an option then this method could be called more then once to at least verify that the same thing is read consistently.- Specified by:
readPage
in interfacePagedMemoryBank
- Parameters:
page
- page number to read packet fromreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPage() continuous where the last one led off and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to place read data intooffset
- offset into readBuf to place data- Throws:
OneWireIOException
OneWireException
-
readPage
public void readPage(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) throws OneWireIOException, OneWireException Read page with extra information in the current bank with no CRC checking (device or data). The resulting data from this API may or may not be what is on the 1-Wire device. It is recommends that the data contain some kind of checking (CRC) like in the readPagePacket() method or have the 1-Wire device provide the CRC as in readPageCRC(). readPageCRC() however is not supported on all memory types, see 'hasPageAutoCRC()'. If neither is an option then this method could be called more then once to at least verify that the same thing is read consistently. See the method 'hasExtraInfo()' for a description of the optional extra information some devices have.- Specified by:
readPage
in interfacePagedMemoryBank
- Parameters:
page
- page number to read packet fromreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPage() continuous where the last one led off and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to place read data intooffset
- offset into readBuf to place dataextraInfo
- byte array to put extra info read into- Throws:
OneWireIOException
OneWireException
- See Also:
-
readPagePacket
public int readPagePacket(int page, boolean readContinue, byte[] readBuf, int offset) throws OneWireIOException, OneWireException Read a Universal Data Packet. The Universal Data Packet always starts on page boundaries but can end anywhere in the page. The structure specifies the length of data bytes not including the length byte and the CRC16 bytes. There is one length byte. The CRC16 is first initialized to the page number. This provides a check to verify the page that was intended is being read. The CRC16 is then calculated over the length and data bytes. The CRC16 is then inverted and stored low byte first followed by the high byte. This is structure is used by this method to verify the data but is not returned, only the data payload is returned.- Specified by:
readPagePacket
in interfacePagedMemoryBank
- Parameters:
page
- page number to read packet fromreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPagePacket() continuous where the last one stopped and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to put data read. Must have at least 'getMaxPacketDataLength()' elements.offset
- offset into readBuf to place data- Returns:
- number of data bytes read from the device and written to readBuf at the offset.
- Throws:
OneWireIOException
OneWireException
- See Also:
-
readPagePacket
public int readPagePacket(int page, boolean readContinue, byte[] readBuf, int offset, byte[] extraInfo) throws OneWireIOException, OneWireException Read a Universal Data Packet and extra information. See the method 'readPagePacket()' for a description of the packet structure. See the method 'hasExtraInfo()' for a description of the optional extra information some devices have.- Specified by:
readPagePacket
in interfacePagedMemoryBank
- Parameters:
page
- page number to read packet fromreadContinue
- if 'true' then device read is continued without re-selecting. This can only be used if the new readPagePacket() continuous where the last one stopped and it is inside a 'beginExclusive/endExclusive' block.readBuf
- byte array to put data read. Must have at least 'getMaxPacketDataLength()' elements.offset
- offset into readBuf to place dataextraInfo
- byte array to put extra info read into- Returns:
- number of data bytes read from the device and written to readBuf at the offset.
- Throws:
OneWireIOException
OneWireException
- See Also:
-
writePagePacket
public void writePagePacket(int page, byte[] writeBuf, int offset, int len) throws OneWireIOException, OneWireException Write a Universal Data Packet. See the method 'readPagePacket()' for a description of the packet structure.- Specified by:
writePagePacket
in interfacePagedMemoryBank
- Parameters:
page
- page number to write packet towriteBuf
- data byte array to writeoffset
- offset into writeBuf where data to write islen
- number of bytes to write- Throws:
OneWireIOException
OneWireException
- See Also:
-
copyScratchpad
public void copyScratchpad(int startAddr, int len, boolean WriteProtect) throws OneWireIOException, OneWireException Copy the scratchpad page to memory.- Parameters:
startAddr
- starting addresslen
- length in bytes that was written already- Throws:
OneWireIOException
OneWireException
-
checkSpeed
Check the device speed if has not been done before or if an error was detected.- Throws:
OneWireIOException
OneWireException
-
forceVerify
public void forceVerify()Set the flag to indicate the next 'checkSpeed()' will force a speed set and verify 'doSpeed()'.
-