Interface Memory

Fill a block of memory with a specified value.

Example

// Fill a block of 10 words, starting at 0x2400, with all 1s (assumes words are 32-bit on the target)
session.memory.fill(0x2400n, 10, 0xFFFFFFFF);

// Filling the same block with all 1s, but using 64-bit values
session.memory.fill(0x2400n, 5, -1n, 64);
Copy

Get a list of the supported formats to be used for Memory.saveData.

Example

let formats = session.memory.getSupportedFormats();
// print all the formats
for (const format : formats) {
  console.log(format);
}
Copy

Load a block of memory from a binary file, like the ones created with Memory.saveBinary.

Remarks

Unlike loadBinaryProgram, this is not considered a program load. That is, this cannot program flash memory, and the target will not be halted automatically. However, it can load to memory pages other than the program page.

Example

session.memory.saveBinary(0x2400n, 256, "C:/loadBinaryExample.bin");
// Load the binary file at a different address
session.memory.loadBinary(0x3200n, "C:/loadBinaryExample.bin");
Copy

Load a binary program file to the target.

Remarks

This can be used to program flash memory.

The target will be halted prior to the load.

Unlike Memory.loadProgram, this will not clear previously loaded debug symbols.

Example

// Load a binary program
session.memory.loadBinaryProgram("C:/workspace/example.bin", 0x2400n);
Copy

Load a block of memory from a file created using Memory.saveData.

Remarks

This command cannot be used to program flash. If you want to save and load data from and to flash, consider using Memory.saveBinary and Memory.loadBinaryProgram.

Example

session.memory.saveData(0x2400n, 5, "C:/loadDataExample.dat", "32-Bit Hex - TI Style");
// Load the saved memory at a different location
session.memory.loadData(0x3200n, 5, "C:/loadDataExample.dat");
Copy

Load a program file to the target, and load debug symbols (if any) for debugging. Accepts programs in ELF, COFF, and multiple hex formats.

Remarks

Loading a program will clear any previously loaded debug symbols.

This returns once the program has been loaded to the target, the debugger is finished loading debug symbols, and the target is halted. By default, the debugger will run to the start of main. This behavior can be configured in the debugger settings.

Will throw if the program load fails.

Example

// Load a program
session.memory.loadProgram("C:/my_project/Debug/example.out");
Copy

Read a block of values from the target's memory. The memory contents are interpreted as unsigned integers of the specified bit size.

Remarks

Will throw if any part of the memory read encounters an error.

Example

// Read 10 words starting at 0x2400
let values = session.memory.read(0x2400n, 10);

// Read 2 64-bit values
let [value1, value2] = session.memory.read(0x2400n, 2, 64);
Copy

Like Memory.read but reads and returns a single value instead of an array.

Example

// Read one word at 0x24000
let value = session.memory.readOne(0x2400n);

// Read one 64-bit value
let value = session.memory.readOne(0x2400n, 64);
Copy

Save a block of target memory to a binary file that can be loaded with Memory.loadBinary or Memory.loadBinaryProgram (see the descriptions of these commands for the differences in their behavior).

Example

// Save 256 words of memory to a binary file
session.memory.saveBinary(0x2400n, 256, "C:/saveBinaryExample.bin");
Copy

Save a block of target memory to a file in a human-readable format.

Example

// Save 5 words of memory in 32-bit hex format without a 0x prefix
session.memory.saveData(0x2400n, 5, "C:/saveDataExample.dat", "32-Bit Hex - TI Style");

// Save 24 words of memory in ascii character format
session.memory.saveData(0x2400n, 24, "C:/saveDataExample.dat", "Character");
Copy

Verifies a binary program file against what is in the target's memory. An error is thrown if the verification fails.

Example

// Verify a binary program
try {
  session.memory.verifyBinaryProgram("C:/workspace/example.bin", 0x2400n);
  console.log("Program verification passed");
} catch {
  console.log("Program verification failed");
}
Copy

Verifies a program file against what is in the target's memory. Accepts programs in ELF, COFF, and multiple hex formats. An error is thrown if the verification fails.

Example

// Verify a program
try {
  session.memory.verifyProgram("C:/my_project/Debug/example.out");
  console.log("Program verification passed");
} catch {
  console.log("Program verification failed");
}
Copy

Write a block of values to the target's memory.

Negative values can be provided and will be written as a signed integer of the specified size. Values provided will be truncated to fit in an integer of the specified size and appropriate signedness.

Remarks

Will throw if any part of the memory write encounters an error.

Example

// Write 6 words starting at 0x2400
// values can be specified as numbers, bigints, or strings
session.memory.write(0x2400n, [0, 1n, -500, 0x4, "5", "-0x3"]);

// Write one 64 bit value at 0x2400
session.memory.write(0x2400n, 0x8765432187654312n, 64);
// equivalently
session.memory.write(0x2400n, [0x8765432187654312n], 64);
Copy