winIDEA SDK
IConnectUMI Struct Reference

Description

This interface defines methods for controlling UMI devices.

#include <i_ConnectUMI.h>

Inherits IUnknown.

Public Types

enum  EOperationFlags {
  wOpWrite = 0x00000000 , wOpRead = 0x00000100 ,
  wOpFlush = 0x00000200 , wOpErase = 0x00000300 ,
  wOpVerify = 0x00000400 , wOpBlankCheck = 0x00000500 ,
  wOpSecure = 0x00000600 , wOpUnsecure = 0x00000700 ,
  wOpSecureCheck = 0x00000800 , wOpReadHASH = 0x00000900 ,
  wOpReadPgmState = 0x00000A00 , wOpGetLastError = 0x00000B00 ,
  wOpFill = 0x00000C00 , wOpGetID = 0x00000D00 ,
  wOpMask = 0x00000F00 , wScopeDevice = 0x00001000 ,
  wCheckIfOpAvailable = 0x00002000 , wProgDevice = 0x00000000 ,
  wProgCache = 0x00004000 , wProgMask = 0x00004000 ,
  wOverrideSafety = 0x00008000 , wFileFormatAuto = 0x00000000 ,
  wFileFormatBin = 0x00010000 , wFileFormatS = 0x00020000 ,
  wFileFormatHex = 0x00030000 , wFileFormatMask = 0x000F0000
}
 Operations flags. More...
 

Public Member Functions

virtual HRESULT Operation (DWORD dwFlags, DWORD dwDevice, ADDRESS aAddress, ADDRESS aSize, BYTE *pbyData, LPCSTR pszFileName) PURE
 Writes data to the device or intermediate cache. More...
 

Member Enumeration Documentation

◆ EOperationFlags

Operations flags.

Enumerator
wOpWrite 

write the data/file

wOpRead 

read the data

wOpFlush 

program the device from the intermediate cache

wOpErase 

erase the specified region

wOpVerify 

device contents are compared to cache

wOpBlankCheck 

device contents are compared to the empty value

wOpSecure 

secure the device/sector

wOpUnsecure 

unsecure secure the device/sector

wOpSecureCheck 

check if security is set on device/sector

wOpReadHASH 

read the murmur hash of the data

wOpReadPgmState 

reads current device programed state

wOpGetLastError 

reads last error message

wOpFill 

fill device with empty value

wOpGetID 

get device ID

wOpMask 

mask to extract the operation mode from dwFlags

wScopeDevice 

the operation scope is entire device, otherwise aAddress and aSize are used

wCheckIfOpAvailable 

check only of operation is available

wProgDevice 

program the data into device immediately

wProgCache 

program the data into intermediate cache

wProgMask 

mask to extract the program mode from dwFlags

wOverrideSafety 

perform operation even if it is disabled in configuration (e.g. Erase)

wFileFormatAuto 

auto detect file format

wFileFormatBin 

binary format

wFileFormatS 

Motorola S.

wFileFormatHex 

Intel Hex.

wFileFormatMask 

mask to extract the format from dwFlags

Member Function Documentation

◆ Operation()

virtual HRESULT IConnectUMI::Operation ( DWORD  dwFlags,
DWORD  dwDevice,
ADDRESS  aAddress,
ADDRESS  aSize,
BYTE *  pbyData,
LPCSTR  pszFileName 
)
virtual

Writes data to the device or intermediate cache.

Parameters
dwFlagsEOperationFlags
dwDeviceindex of the UMI device
aAddressaddress to write/read/hash/erase/secure or offset to add to the address in the file
aSizesize of the data to write/read/hash/erase/secure, ignored if file is programmed
pbyDatapointer to the buffer to be written, read, receive HASH or file to load
pszFileNamepath to the file to program