|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Object
|
+--com.dalsemi.onewire.container.MemoryBankNV
|
+--com.dalsemi.onewire.container.MemoryBankNVCRC
|
+--com.dalsemi.onewire.container.MemoryBankNVCRCPW
Memory bank class for the NVRAM with built-in CRC generation and Password protected memory read/write iButtons and 1-Wire Devices. An example of such a devices is the DS1922 Thermochron with 8k or password protected log memory.
| Field Summary | |
boolean |
enablePower
Enable Provided Power for some Password checking. |
static byte |
READ_MEMORY_COMMAND
Read Memory Command |
static byte |
READ_MEMORY_CRC_PW_COMMAND
Read Memory (with CRC and Password) Command |
static byte |
READ_PAGE_WITH_CRC
Write Scratchpad Command |
| Constructor Summary | |
MemoryBankNVCRCPW(PasswordContainer ibutton,
MemoryBankScratchCRCPW scratch)
Memory bank contstuctor. |
|
| Method Summary | |
String |
getBankDescription()
Query to see get a string description of the current memory bank. |
String |
getExtraInfoDescription()
Query to get a string description of what is contained in the Extra Informationed return when reading pages in the current memory bank. |
int |
getExtraInfoLength()
Query to get the length in bytes of extra information that is read when read a page in the current memory bank. |
int |
getMaxPacketDataLength()
Query to get Maximum data page length in bytes for a packet read or written in the current memory bank. |
int |
getNumberPages()
Query to get the number of pages in current memory bank. |
int |
getPageLength()
Query to get page length in bytes in current memory bank. |
int |
getSize()
Query to get the memory bank size in bytes. |
int |
getStartPhysicalAddress()
Query to get the starting physical address of this bank. |
boolean |
hasExtraInfo()
Checks to see if this memory bank's pages deliver extra information outside of the normal data space, when read. |
boolean |
hasPageAutoCRC()
Query to see if current memory bank pages can be read with the contents being verified by a device generated CRC. |
boolean |
haveExtraInfo()
Deprecated. As of 1-Wire API 0.01, replaced by MemoryBankNV.hasExtraInfo() |
boolean |
isGeneralPurposeMemory()
Query to see if the current memory bank is general purpose user memory. |
boolean |
isNonVolatile()
Query to see if current memory bank non-volatile. |
boolean |
isReadOnly()
Query to see if current memory bank is read only. |
boolean |
isReadWrite()
Query to see if current memory bank is read/write. |
boolean |
isWriteOnce()
Query to see if current memory bank is write write once such as with EPROM technology. |
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. |
boolean |
needsProgramPulse()
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 |
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. |
| Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
public static final byte READ_MEMORY_CRC_PW_COMMAND
public boolean enablePower
public static final byte READ_PAGE_WITH_CRC
public static final byte READ_MEMORY_COMMAND
| Constructor Detail |
public MemoryBankNVCRCPW(PasswordContainer ibutton,
MemoryBankScratchCRCPW scratch)
| Method Detail |
public void readPageCRC(int page,
boolean readContinue,
byte[] readBuf,
int offset,
byte[] extraInfo)
throws OneWireIOException,
OneWireException
readPageCRC in class com.dalsemi.onewire.container.MemoryBankNVCRCpage - page number to readreadContinue - if 'true' then device read is continued without
re-selecting. This can only be used if the new
readPagePacket() continious 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 intoOneWireIOException - OneWireException -
public void read(int startAddr,
boolean readContinue,
byte[] readBuf,
int offset,
int len)
throws OneWireIOException,
OneWireException
read in class com.dalsemi.onewire.container.MemoryBankNVstartAddr - starting physical addressreadContinue - if 'true' then device read is continued without
re-selecting. This can only be used if the new
read() continious 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 readOneWireIOException - OneWireException -
public void write(int startAddr,
byte[] writeBuf,
int offset,
int len)
throws OneWireIOException,
OneWireException
write in class com.dalsemi.onewire.container.MemoryBankNVstartAddr - starting addresswriteBuf - byte array containing data to writeoffset - offset into writeBuf to get datalen - length in bytes to writeOneWireIOException - OneWireException -
public void readPage(int page,
boolean readContinue,
byte[] readBuf,
int offset)
throws OneWireIOException,
OneWireException
readPage in class com.dalsemi.onewire.container.MemoryBankNVpage - 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() continious 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 dataOneWireIOException - OneWireException -
public void readPage(int page,
boolean readContinue,
byte[] readBuf,
int offset,
byte[] extraInfo)
throws OneWireIOException,
OneWireException
readPage in class com.dalsemi.onewire.container.MemoryBankNVpage - 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() continious 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 intoOneWireIOException - OneWireException -
public int readPagePacket(int page,
boolean readContinue,
byte[] readBuf,
int offset,
byte[] extraInfo)
throws OneWireIOException,
OneWireException
readPagePacket in class com.dalsemi.onewire.container.MemoryBankNVpage - 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() continious 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 intoOneWireIOException - OneWireException -
public void readPageCRC(int page,
boolean readContinue,
byte[] readBuf,
int offset)
throws OneWireIOException,
OneWireException
readPageCRC in class com.dalsemi.onewire.container.MemoryBankNVpage - page number to readreadContinue - if 'true' then device read is continued without
re-selecting. This can only be used if the new
readPagePacket() continious 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 dataOneWireIOException - OneWireException - public String getBankDescription()
getBankDescription in interface MemoryBankpublic boolean isGeneralPurposeMemory()
isGeneralPurposeMemory in interface MemoryBankpublic boolean isReadWrite()
isReadWrite in interface MemoryBankpublic boolean isWriteOnce()
isWriteOnce in interface MemoryBankpublic boolean isReadOnly()
isReadOnly in interface MemoryBankpublic boolean isNonVolatile()
isNonVolatile in interface MemoryBankpublic boolean needsProgramPulse()
needsProgramPulse in interface MemoryBankpublic boolean needsPowerDelivery()
needsPowerDelivery in interface MemoryBankpublic int getStartPhysicalAddress()
getStartPhysicalAddress in interface MemoryBankpublic int getSize()
getSize in interface MemoryBankpublic void setWriteVerification(boolean doReadVerf)
setWriteVerification in interface MemoryBankdoReadVerf - true (default) verify write in 'write'
false, don't verify write (used on
Write-Once bit manipulation)public int getNumberPages()
getNumberPages in interface PagedMemoryBankpublic int getPageLength()
getPageLength in interface PagedMemoryBankpublic int getMaxPacketDataLength()
getMaxPacketDataLength in interface PagedMemoryBankpublic boolean hasPageAutoCRC()
hasPageAutoCRC in interface PagedMemoryBankpublic boolean haveExtraInfo()
MemoryBankNV.hasExtraInfo()
haveExtraInfo in interface PagedMemoryBankpublic boolean hasExtraInfo()
readPage,
readPageCRC, and
readPagePacket.hasExtraInfo in interface PagedMemoryBank true if reading the this memory bank's
pages provides extra informationreadPage(extra),
readPageCRC(extra),
readPagePacket(extra)public int getExtraInfoLength()
getExtraInfoLength in interface PagedMemoryBankpublic String getExtraInfoDescription()
getExtraInfoDescription in interface PagedMemoryBank
public int readPagePacket(int page,
boolean readContinue,
byte[] readBuf,
int offset)
throws OneWireIOException,
OneWireException
readPagePacket in interface PagedMemoryBankpage - 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() continious 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 dataOneWireIOException - OneWireException -
public void writePagePacket(int page,
byte[] writeBuf,
int offset,
int len)
throws OneWireIOException,
OneWireException
writePagePacket in interface PagedMemoryBankpage - page number to write packet towriteBuf - data byte array to writeoffset - offset into writeBuf where data to write islen - number of bytes to writeOneWireIOException - OneWireException -
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||