com.ti.debug.engine.scripting

Class Flash

java.lang.Object

com.ti.debug.engine.scripting.Flash

public class Flash
extends java.lang.Object

This class encapsulates the flash programmer methods. An instance of this class is automatically created when a new session is opened.

Note: Do not use this class for Flash operations on MSP430 devices; MSP430 does not currently support Flash specific operations or options at this time. Download Options for MSP430 can be accessed using the DebugSession.options class.

// Create Environment and open a debug session
ScriptingEnvironment env = new ScriptingEnvironment();
DebugServer myServer = (DebugServer) env.getServer("DebugServer.1");
DebugSession mySession = myServer.openSession("*", "*");

...

// set which sectors to erase and then execute the erase operation
// note: SECTORA, SECTORB, etc. are just examples, look up the exact string for your device using the mySession.flash.options.printOptions() API
mySession.flash.options.setBoolean(SECTORA, true);
mySession.flash.options.setBoolean(SECTORB, false);
mySession.flash.options.setBoolean(SECTORC, true);
mySession.flash.options.setBoolean(SECTORD, true);
mySession.flash.options.setBoolean(SECTORE, false);
mySession.flash.erase();


Field Summary

Fields

Modifier and Type	Field and Description
Options	options

Constructor Summary

Constructors

Constructor and Description
Flash(ScriptingEnvironment environment, DebugSession session, java.lang.String variantName, Options opt)

Method Summary

Modifier and Type	Method and Description
void	calculateChecksum() Calculates the checksum on flash.
void	depletionRecovery() Performs the Depletion Recovery operation.
void	endFrequencyTest() Ends the frequency test and halts the target.
void	erase() Erases the selected sectors in flash.
int	getFlashChecksum() Returns the calculated checksum on flash.
int	getOTPChecksum() Returns the calculated OTP checksum on flash.
boolean	isFlashSupported() Determines if Flash programming is supported for the current device.
void	listSupportedOperations() Outputs the supported flash opCodes that the current target supports.
void	lock() Locks the flash based on the password that was programmed.
void	multiloadEnd() Needs to be called to finish the multi-load operation.
void	multiloadStart() Needs to be called before using the Multi-load feature to only erase the Flash on the first program load.
void	performOperation(java.lang.String opCode) Performs the Flash operation associated with the opCode.
void	programPassword() Programs the given password to flash.
void	startFrequencyTest() Start the frequency test to test the frequency on the target (using an oscilloscope).
void	unlock() Unlocks the flash if the user input password matches the one that was programmed Relevant properties for 28xx devices: FlashKey0, FlashKey1, etc.

Methods inherited from class java.lang.Object

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

Field Detail

options

public Options options

Constructor Detail

Flash

public Flash(ScriptingEnvironment environment,
             DebugSession session,
             java.lang.String variantName,
             Options opt)
      throws ScriptingException

Throws:

ScriptingException

Method Detail

calculateChecksum

public void calculateChecksum()
                       throws ScriptingException

Calculates the checksum on flash.
A ScriptingException is thrown if the calculateChecksum operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

depletionRecovery

public void depletionRecovery()
                       throws ScriptingException

Performs the Depletion Recovery operation.
A ScriptingException is thrown if the depletionRecovery operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

endFrequencyTest

public void endFrequencyTest()
                      throws ScriptingException

Ends the frequency test and halts the target. A ScriptingException is thrown if the endFrequencyTest operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

erase

public void erase()
           throws ScriptingException

Erases the selected sectors in flash.
Relevant properties for 28xx devices: FlashSectorA, FlashSectorB, etc.
Relevant properties for Stellaris devices: FlashEraseStartAddr, FlashEraseEndAddr, FlashEraseType
Relevant properties for TMSx70 devices: FlashEraseSelection, FlashBank0Sector0, FlashBank0Sector1, etc.
A ScriptingException is thrown if the erase operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

getFlashChecksum

public int getFlashChecksum()
                     throws ScriptingException

Returns the calculated checksum on flash.
A ScriptingException is thrown if the calculateChecksum operation is not supported or Flash is not supported for current device

Returns:

the calculated flash checksum

Throws:

ScriptingException

getOTPChecksum

public int getOTPChecksum()
                   throws ScriptingException

Returns the calculated OTP checksum on flash.
A ScriptingException is thrown if the calculateChecksum operation is not supported or Flash is not supported for current device

Returns:

the calculated OTP checksum

Throws:

ScriptingException

isFlashSupported

public boolean isFlashSupported()

Determines if Flash programming is supported for the current device. Can be use at the start of the script to make sure device is supported.

Returns:

(boolean) true if flash programming is supported, false otherwise.

listSupportedOperations

public void listSupportedOperations()
                             throws ScriptingException

Outputs the supported flash opCodes that the current target supports. A ScriptingException is thrown if Flash is not supported for current device

Throws:

ScriptingException

lock

public void lock()
          throws ScriptingException

Locks the flash based on the password that was programmed. A ScriptingException is thrown if the lock operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

multiloadEnd

public void multiloadEnd()
                  throws ScriptingException

Needs to be called to finish the multi-load operation. The Flash manager will return to default mode (erase Flash based on user settings)

Throws:

ScriptingException

multiloadStart

public void multiloadStart()
                    throws ScriptingException

Needs to be called before using the Multi-load feature to only erase the Flash on the first program load. Once the Flash Manger receives this call, users will be free to call debugSession.memory.load() as many times as needed to write to the Flash

Throws:

ScriptingException

performOperation

public void performOperation(java.lang.String opCode)
                      throws ScriptingException

Performs the Flash operation associated with the opCode. A list of all available opCodes for the current device can be displayed by calling listSupportedOperations() A ScriptingException is thrown if the opCode is invalid or Flash is not supported for current device.

Parameters:

opCode - String operation code for the flash operation

Throws:

ScriptingException

programPassword

public void programPassword()
                     throws ScriptingException

Programs the given password to flash.
Relevant properties for 28xx devices: FlashKey1, FlashKey2, etc.
A ScriptingException is thrown if the programPassword operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

startFrequencyTest

public void startFrequencyTest()
                        throws ScriptingException

Start the frequency test to test the frequency on the target (using an oscilloscope). A ScriptingException is thrown if the startFrequencyTest operation is not supported or Flash is not supported for current device

Throws:

ScriptingException

unlock

public void unlock()
            throws ScriptingException

Unlocks the flash if the user input password matches the one that was programmed
Relevant properties for 28xx devices: FlashKey0, FlashKey1, etc.
A ScriptingException is thrown if the unlock operation is not supported or Flash is not supported for current device

Throws:

ScriptingException