Class CortexM

Cortex M class

Hierarchy (view full)

Implements

Constructors

constructor

Methods

concatTypedArray connect disconnect execute getState halt isHalted readAP readAPCommand readBlock readBytes readCoreRegister readCoreRegisterCommand readCoreRegisters readDP readDPCommand readMem16 readMem16Command readMem32 readMem32Command readMem32Sequence readMem8 readMem8Command reconnect reset resume setTargetResetState softReset transferSequence waitDelay writeAP writeAPCommand writeBlock writeBytes writeCoreRegister writeCoreRegisterCommand writeDP writeDPCommand writeMem16 writeMem16Command writeMem32 writeMem32Command writeMem32Sequence writeMem8 writeMem8Command

Constructors

constructor

Methods

Protected concatTypedArray

connect

disconnect

execute

  • execute(address, code, stackPointer, programCounter, linkRegister?, ...registers): Promise<void>

  • Exucute code at a specified memory address

    Parameters

    • address: number

      The address to put the code

    • code: Uint32Array

      The code to use

    • stackPointer: number

      The stack pointer to use

    • programCounter: number

      The program counter to use

    • linkRegister: number = ...

      The link register to use (defaults to address + 1)

    • Rest ...registers: number[]

      Values to add to the general purpose registers, R0, R1, R2, etc.

    Returns Promise<void>

getState

halt

  • halt(wait?, timeout?): Promise<void>

  • Halt the target

    Parameters

    • wait: boolean = true

      Wait until halted before returning

    • timeout: number = 0

      Milliseconds to wait before aborting wait

    Returns Promise<void>

    Promise

isHalted

readAP

  • readAP(register): Promise<number>

  • Read from an access port register

    Parameters

    Returns Promise<number>

    Promise of register value

Protected readAPCommand

readBlock

  • readBlock(register, count): Promise<Uint32Array>

  • Read a block of 32-bit words from a memory access port register

    Parameters

    • register: number

      ID of register to read from

    • count: number

      The count of values to read

    Returns Promise<Uint32Array>

    Promise of register data

readBytes

  • readBytes(register, count): Promise<Uint8Array>

  • Read a block of bytes from a memory access port register

    Parameters

    • register: number

      ID of register to read from

    • count: number

      The count of values to read

    Returns Promise<Uint8Array>

    Promise of register data

readCoreRegister

Protected readCoreRegisterCommand

readCoreRegisters

readDP

  • readDP(register): Promise<number>

  • Read from a debug port register

    Parameters

    Returns Promise<number>

    Promise of register value

Protected readDPCommand

readMem16

  • readMem16(register): Promise<number>

  • Read a 16-bit word from a memory access port register

    Parameters

    • register: number

      ID of register to read

    Returns Promise<number>

    Promise of register data

Protected readMem16Command

readMem32

  • readMem32(register): Promise<number>

  • Read a 32-bit word from a memory access port register

    Parameters

    • register: number

      ID of register to read

    Returns Promise<number>

    Promise of register data

Protected readMem32Command

Protected readMem32Sequence

  • readMem32Sequence(register, count): Promise<Uint32Array>

  • Read a sequence of 32-bit words from a memory access port register, without crossing TAR auto-increment boundaries

    Parameters

    • register: number

      ID of register to read from

    • count: number

      The count of values to read

    Returns Promise<Uint32Array>

    Promise of register data

readMem8

  • readMem8(register): Promise<number>

  • Read an 8-bit word from a memory access port register

    Parameters

    • register: number

      ID of register to read

    Returns Promise<number>

    Promise of register data

Protected readMem8Command

reconnect

reset

resume

  • resume(wait?, timeout?): Promise<void>

  • Resume a target

    Parameters

    • wait: boolean = true

      Wait until resumed before returning

    • timeout: number = 0

      Milliseconds to wait before aborting wait

    Returns Promise<void>

    Promise

setTargetResetState

  • setTargetResetState(hardwareReset?): Promise<void>

  • set the target to reset state

    Parameters

    • hardwareReset: boolean = true

      use hardware reset pin or software reset

    Returns Promise<void>

    Promise

softReset

Protected transferSequence

Protected waitDelay

  • waitDelay(fn, timeout?, delay?): Promise<void>

  • Continually run a function until it returns true

    Parameters

    • fn: (() => Promise<boolean>)

      The function to run

        • (): Promise<boolean>

        • Returns Promise<boolean>

    • timeout: number = 0

      Optional timeout to wait before giving up and throwing

    • delay: number = DEFAULT_WAIT_DELAY

      The milliseconds to wait between each run

    Returns Promise<void>

    Promise

writeAP

  • writeAP(register, value): Promise<void>

  • Write to an access port register

    Parameters

    • register: APRegister

      AP register to write

    • value: number

      Value to write

    Returns Promise<void>

    Promise

Protected writeAPCommand

writeBlock

  • writeBlock(register, values): Promise<void>

  • Write a block of 32-bit words to a memory access port register

    Parameters

    • register: number

      ID of register to write to

    • values: Uint32Array

      The values to write

    Returns Promise<void>

    Promise

writeBytes

  • writeBytes(register, values): Promise<void>

  • Write a block of bytes to a memory access port register

    Parameters

    • register: number

      ID of register to write to

    • values: Uint8Array

      The values to write

    Returns Promise<void>

    Promise

writeCoreRegister

Protected writeCoreRegisterCommand

writeDP

  • writeDP(register, value): Promise<void>

  • Write to a debug port register

    Parameters

    • register: DPRegister

      DP register to write

    • value: number

      Value to write

    Returns Promise<void>

    Promise

Protected writeDPCommand

writeMem16

  • writeMem16(register, value): Promise<void>

  • Write a 16-bit word to a memory access port register

    Parameters

    • register: number

      ID of register to write to

    • value: number

      The value to write

    Returns Promise<void>

    Promise

Protected writeMem16Command

writeMem32

  • writeMem32(register, value): Promise<void>

  • Write a 32-bit word to a memory access port register

    Parameters

    • register: number

      ID of register to write to

    • value: number

      The value to write

    Returns Promise<void>

    Promise

Protected writeMem32Command

Protected writeMem32Sequence

  • writeMem32Sequence(register, values): Promise<void>

  • Write a sequence of 32-bit words to a memory access port register, without crossing TAR auto-increment boundaries

    Parameters

    • register: number

      ID of register to write to

    • values: Uint32Array

      The values to write

    Returns Promise<void>

    Promise

writeMem8

  • writeMem8(register, value): Promise<void>

  • Write an 8-bit word to a memory access port register

    Parameters

    • register: number

      ID of register to write to

    • value: number

      The value to write

    Returns Promise<void>

    Promise

Protected writeMem8Command

Settings

Member Visibility

Theme

On This Page

constructorconcatTypedArrayconnectdisconnectexecutegetStatehaltisHaltedreadAPreadAPCommandreadBlockreadBytesreadCoreRegisterreadCoreRegisterCommandreadCoreRegistersreadDPreadDPCommandreadMem16readMem16CommandreadMem32readMem32CommandreadMem32SequencereadMem8readMem8CommandreconnectresetresumesetTargetResetStatesoftResettransferSequencewaitDelaywriteAPwriteAPCommandwriteBlockwriteByteswriteCoreRegisterwriteCoreRegisterCommandwriteDPwriteDPCommandwriteMem16writeMem16CommandwriteMem32writeMem32CommandwriteMem32SequencewriteMem8writeMem8Command