esp_cpu_set_watchpoint() function

Set and enable a hardware watchpoint on the current CPU Set and enable a hardware watchpoint on the current CPU, specifying the memory range and trigger operation. Watchpoints will break/panic the CPU when the CPU accesses (according to the trigger type) on a certain memory range.

Syntax

Show:

Summary

Declaration

Definition

from esp_cpu.h:497

esp_err_t esp_cpu_set_watchpoint(int wp_num, const void *wp_addr, size_t size, esp_cpu_watchpoint_trigger_t trigger);

Implemented in cpu.c:127

Arguments

Argument

Declared as

Description

wp_num

int

Hardware watchpoint number [0..SOC_CPU_WATCHPOINTS_NUM - 1]

wp_addr

const void *

Watchpoint's base address, must be naturally aligned to the size of the region

size

size_t

Size of the region to watch. Must be one of 2^n and in the range of [1 ... SOC_CPU_WATCHPOINT_MAX_REGION_SIZE]

trigger

esp_cpu_watchpoint_trigger_t

Trigger type

Return value

ESP_ERR_INVALID_ARG on invalid arg, ESP_OK otherwise

Notes

Overwrites previously set watchpoint with same watchpoint number. On RISC-V chips, this API uses method0(Exact matching) and method1(NAPOT matching) according to the riscv-debug-spec-0.13 specification for address matching. If the watch region size is 1byte, it uses exact matching (method 0). If the watch region size is larger than 1byte, it uses NAPOT matching (method 1). This mode requires the watching region start address to be aligned to the watching region size.