ADI | DAPjs API Documentation

Arm Debug Interface class

Hierarchy

ADI
- CortexM

Implements

DAP

Index

Constructors

constructor

Methods

Constructors

constructor

new ADI(transport: Transport, mode?: DAPProtocol, clockFrequency?: undefined | number): ADI

ADI constructor

Parameters
- transport: Transport
  
  Debug transport to use
- Optional mode: DAPProtocol
  
  Debug mode to use (default 0)
- Optional clockFrequency: undefined | number
  
  Communication clock frequency to use (default 10000000)
Returns ADI

new ADI(proxy: Proxy): ADI

ADI constructor

Parameters
- proxy: Proxy
  
  Proxy to use
Returns ADI

Methods

connect

connect(): Promise<void>

Implementation of DAP.connect

Connect to target device

Returns Promise<void>

Promise

disconnect

disconnect(): Promise<void>

Implementation of DAP.disconnect

Disconnect from target device

Returns Promise<void>

Promise

readAP

readAP(register: APRegister): Promise<number>

Read from an access port register

Parameters
- register: APRegister
  
  AP register to read
Returns Promise<number>

Promise of register value

readBlock

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

Implementation of DAP.readBlock

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

readDP

readDP(register: DPRegister): Promise<number>

Read from a debug port register

Parameters
- register: DPRegister
  
  DP register to read
Returns Promise<number>

Promise of register value

readMem16

readMem16(register: number): Promise<number>

Implementation of DAP.readMem16

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

readMem32

readMem32(register: number): Promise<number>

Implementation of DAP.readMem32

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

reconnect

reconnect(): Promise<void>

Implementation of DAP.reconnect

Reconnect to target device

Returns Promise<void>

Promise

reset

reset(): Promise<boolean>

Implementation of DAP.reset

Reset target device

Returns Promise<boolean>

Promise

writeAP

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

Write to an access port register

Parameters
- register: APRegister
  
  AP register to write
- value: number
  
  Value to write
Returns Promise<void>

Promise

writeBlock

writeBlock(register: number, values: Uint32Array): Promise<void>

Implementation of DAP.writeBlock

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

writeDP

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

Write to a debug port register

Parameters
- register: DPRegister
  
  DP register to write
- value: number
  
  Value to write
Returns Promise<void>

Promise

writeMem16

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

Implementation of DAP.writeMem16

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

writeMem32

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

Implementation of DAP.writeMem32

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