gdb_hooks.h

Go to the documentation of this file.

/*
 gdb_hooks.h - Hooks for GDB Stub library
 Copyright (c) 2018 Ivan Grokhotkov.  All right reserved.

 This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
 License as published by the Free Software Foundation; either
 version 2.1 of the License, or (at your option) any later version.

 This library is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 Lesser General Public License for more details.

 You should have received a copy of the GNU Lesser General Public
 License along with this library; if not, write to the Free Software
 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
*/

#pragma once

#include <esp_systemapi.h>

#ifdef __cplusplus
extern "C" {
#endif

void gdb_init(void);

void gdb_enable(bool state);

#ifdef ENABLE_GDB
#ifdef ARCH_HOST
#define gdb_do_break() __asm__("int $0x03")
#elif defined(ARCH_ESP8266)
#define gdb_do_break() __asm__("break 0,0")
#elif defined(ARCH_ESP32)
#define gdb_do_break() cpu_hal_break()
#elif defined(ARCH_RP2040)
#define gdb_do_break() __asm__("bkpt #0")
#endif
#else
#define gdb_do_break()                                                                                                 \
    do {                                                                                                               \
    } while(0)
#endif

typedef enum {
    eGDB_NotPresent,
    eGDB_Detached,
    eGDB_Attached,
} GdbState;

GdbState gdb_present(void);

void gdb_on_attach(bool attached);

void gdb_detach();

/*
 * @brief Called by framework on unexpected system reset
 */
void debug_crash_callback(const struct rst_info* rst_info, uint32_t stack, uint32_t stack_end);

void debug_print_stack(uint32_t start, uint32_t end);

#ifdef __cplusplus
} // extern "C"
#endif