Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CortexM

Cortex M class

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Methods

Protected concatTypedArray

  • concatTypedArray(arrays: Uint32Array[]): Uint32Array

connect

  • connect(): Promise<void>

disconnect

  • disconnect(): Promise<void>

execute

  • execute(address: number, code: Uint32Array, stackPointer: number, programCounter: number, linkRegister?: number, ...registers: number[]): 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?: boolean, timeout?: number): 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

  • isHalted(): Promise<boolean>

readAP

Protected readAPCommand

readBlock

  • readBlock(register: number, count: number): 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

readCoreRegister

Protected readCoreRegisterCommand

readCoreRegisters

  • readCoreRegisters(registers: CoreRegister[]): Promise<number[]>

readDP

Protected readDPCommand

readMem16

  • readMem16(register: number): 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: number): 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: number, count: number): 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: number): 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

  • reconnect(): Promise<void>

reset

  • reset(): Promise<boolean>

resume

  • resume(wait?: boolean, timeout?: number): 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?: boolean): Promise<void>

  • set the target to reset state

    Parameters

    • hardwareReset: boolean = true

      use hardware reset pin or software reset

    Returns Promise<void>

    Promise

softReset

  • softReset(): Promise<void>

Protected transferSequence

  • transferSequence(operations: DAPOperation[][]): Promise<Uint32Array>

Protected waitDelay

  • waitDelay(fn: () => Promise<boolean>, timeout?: number, timer?: number): 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

    • timer: number = DEFAULT_WAIT_DELAY

      The milliseconds to wait between each run

    Returns Promise<void>

    Promise

writeAP

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

Protected writeAPCommand

  • writeAPCommand(register: number, value: number): DAPOperation[]

writeBlock

  • writeBlock(register: number, values: Uint32Array): 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

writeCoreRegister

  • writeCoreRegister(register: CoreRegister, value: number): Promise<void>

Protected writeCoreRegisterCommand

  • writeCoreRegisterCommand(register: number, value: number): DAPOperation[]

writeDP

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

Protected writeDPCommand

  • writeDPCommand(register: number, value: number): DAPOperation[]

writeMem16

  • writeMem16(register: number, value: number): 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

  • writeMem16Command(register: number, value: number): DAPOperation[]

writeMem32

  • writeMem32(register: number, value: number): 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

  • writeMem32Command(register: number, value: number): DAPOperation[]

Protected writeMem32Sequence

  • writeMem32Sequence(register: number, values: Uint32Array): 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: number, value: number): 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

  • writeMem8Command(register: number, value: number): DAPOperation[]