tmc9660::TMC9660< CommType >::Script Struct Reference

Subsystem for TMCL script execution control. More...

#include <tmc9660.hpp>

Collaboration diagram for tmc9660::TMC9660< CommType >::Script:

Public Member Functions
bool	upload (const std::vector< uint32_t > &script_data) noexcept
	Upload a TMCL script to the TMC9660's internal memory.
bool	start (uint16_t address=0) noexcept
	Start or restart execution of the stored script.
bool	stop () noexcept
	Stop execution of the running script.
bool	step () noexcept
	Execute a single TMCL instruction of the loaded script.
bool	reset () noexcept
	Reset the TMCL program counter.
bool	getStatus (uint32_t &status) noexcept
	Query the execution state of the running script.
bool	readMemory (uint16_t address, uint32_t &value) noexcept
	Read a 32-bit instruction from script memory.
bool	addBreakpoint (uint16_t address) noexcept
	Add a breakpoint at the given address.
bool	removeBreakpoint (uint16_t address) noexcept
	Remove a previously set breakpoint.
bool	clearBreakpoints () noexcept
	Remove all breakpoints from the script.
bool	getMaxBreakpointCount (uint32_t &count) noexcept
	Query the maximum number of supported breakpoints.

Private Member Functions
	Script (TMC9660 &parent) noexcept

Private Attributes
TMC9660 &	driver

Friends
class	TMC9660

Detailed Description

template<typename CommType>
struct tmc9660::TMC9660< CommType >::Script

Subsystem for TMCL script execution control.

Constructor & Destructor Documentation

Script()

template<typename CommType >

tmc9660::TMC9660< CommType >::Script::Script ( TMC9660 & parent )

inlineexplicitprivatenoexcept

Member Function Documentation

addBreakpoint()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::addBreakpoint ( uint16_t address )

noexcept

Add a breakpoint at the given address.

Parameters

address

Instruction address where execution should break.

Returns

true if the breakpoint was set.

clearBreakpoints()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::clearBreakpoints ( )

noexcept

Remove all breakpoints from the script.

Returns

true if the command succeeded.

getMaxBreakpointCount()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::getMaxBreakpointCount ( uint32_t & count )

noexcept

Query the maximum number of supported breakpoints.

Parameters

[out]

count

Maximum breakpoint count reported by the device.

Returns

true on success.

getStatus()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::getStatus ( uint32_t & status )

noexcept

Query the execution state of the running script.

Parameters

[out]

status

Raw status value returned by GetStatusScript.

Returns

true if the status value was retrieved successfully.

readMemory()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::readMemory ( uint16_t address, uint32_t & value )

noexcept

Read a 32-bit instruction from script memory.

Parameters

	address	Instruction address to read.
[out]	value	Returned 32-bit TMCL instruction word.

Returns

true on success.

removeBreakpoint()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::removeBreakpoint ( uint16_t address )

noexcept

Remove a previously set breakpoint.

Parameters

address

Address of the breakpoint to remove.

Returns

true if removed successfully.

reset()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::reset ( )

noexcept

Reset the TMCL program counter.

Sends the ApplReset command which stops execution and resets the script to the beginning.

start()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::start ( uint16_t address = 0 )

noexcept

Start or restart execution of the stored script.

Parameters

address

The address from which to start execution (usually 0 for beginning of script).

Returns

true if the command to start the script was sent.

step()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::step ( )

noexcept

Execute a single TMCL instruction of the loaded script.

Uses the ApplStep opcode which advances the interpreter by one instruction. Useful for debugging scripts in real time.

stop()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::stop ( )

noexcept

Stop execution of the running script.

Returns

true if the stop command was sent successfully.

upload()

template<typename CommType >

bool tmc9660::TMC9660< CommType >::Script::upload ( const std::vector< uint32_t > & script_data )

noexcept

Upload a TMCL script to the TMC9660's internal memory.

This enters download mode, writes a series of instructions to the device memory, and exits download mode. The script will typically run on device startup or when triggered.

Parameters

script_data

Vector of 32-bit instructions representing the TMCL script.

Returns

true if the script was uploaded successfully.

Friends And Related Symbol Documentation

TMC9660

template<typename CommType >

friend class TMC9660

friend

Member Data Documentation

driver

template<typename CommType >

TMC9660& tmc9660::TMC9660< CommType >::Script::driver

private

---

The documentation for this struct was generated from the following file:

• tmc9660.hpp