gdbstub.h

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Intel Corporation
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_DEBUG_GDBSTUB_H_
#define ZEPHYR_INCLUDE_DEBUG_GDBSTUB_H_
 
/* Map from CPU exceptions to GDB  */
#define GDB_EXCEPTION_INVALID_INSTRUCTION   4UL
#define GDB_EXCEPTION_BREAKPOINT            5UL
#define GDB_EXCEPTION_MEMORY_FAULT          7UL
#define GDB_EXCEPTION_DIVIDE_ERROR          8UL
#define GDB_EXCEPTION_INVALID_MEMORY        11UL
#define GDB_EXCEPTION_OVERFLOW              16UL
 
/* Access permissions for memory regions */
#define GDB_MEM_REGION_NO_ACCESS            0UL
#define GDB_MEM_REGION_READ                 BIT(0)
#define GDB_MEM_REGION_WRITE                BIT(1)
 
#define GDB_MEM_REGION_RO \
        (GDB_MEM_REGION_READ)
 
#define GDB_MEM_REGION_RW \
        (GDB_MEM_REGION_READ | GDB_MEM_REGION_WRITE)
 
struct gdb_mem_region {
        uintptr_t start;
 
        uintptr_t end;
 
        uint16_t  attributes;
 
        uint8_t   alignment;
};
 
enum gdb_loop_state {
        GDB_LOOP_RECEIVING,
        GDB_LOOP_CONTINUE,
        GDB_LOOP_ERROR,
};
 
extern const struct gdb_mem_region gdb_mem_region_array[];
 
extern const size_t gdb_mem_num_regions;
 
size_t gdb_bin2hex(const uint8_t *buf, size_t buflen,
                   char *hex, size_t hexlen);
 
 
bool gdb_mem_can_read(const uintptr_t addr, const size_t len, uint8_t *align);
 
bool gdb_mem_can_write(const uintptr_t addr, const size_t len, uint8_t *align);
 
#endif