Clean up GDB include and library dir

Replace GDBstub.h with the version in the internal/ directory, and
adjust stub code accordingly.  This way, only one copy of a file called
"GDBstub.h" will exist.

Update the gdbcommands and replace the obsolete ESPRESSIF readme with
@kylefleming's version since we're mainly doing serial, not TCP,
connected debugging.

Bump the library rev. number since this is a pretty big functionality
change.

Minor documentation tweak.

Author: earlephilhower

doc/gdb.rst

@@ -257,9 +257,9 @@ Now, connect to the running ESP8266:
 
 Don't worry that GDB doesn't know what is at our present address, we broke
 into the code at a random spot and we could be in an interrupt, in the
-ROM, or elsewhere.  The important bit is that we're not connected and
+ROM, or elsewhere.  The important bit is that we're now connected and
 two things will now happen: we can debug, and the app's regular serial
-output will be displayed.
+output will be displayed on the GDB console..
 
 Continue the running app to see the serial output:
 

libraries/GDBStub/README-lib.md renamed to libraries/GDBStub/README.md

@@ -1,3 +1,20 @@
+# ESP8266 HW limits the number of breakpoints/watchpoints
 set remote hardware-breakpoint-limit 1
 set remote hardware-watchpoint-limit 1
-target remote :9980
+# Some GDBstub settings
+set remote interrupt-on-connect on
+set remote kill-packet off
+set remote symbol-lookup-packet off
+set remote verbose-resume-packet off
+# The memory map, so GDB knows where it can install SW breakpoints
+mem 0x20000000 0x3fefffff ro cache
+mem 0x3ff00000 0x3fffffff rw
+mem 0x40000000 0x400fffff ro cache
+mem 0x40100000 0x4013ffff rw cache
+mem 0x40140000 0x5fffffff ro cache
+mem 0x60000000 0x60001fff rw
+# Change the following to your sketch's ELF file
+file /path/to/sketch.ino.elf
+# Change the following to your serial port and baud
+set serial baud 115200
+target remote /dev/ttyUSB0

libraries/GDBStub/README.rst

@@ -1,6 +1,6 @@
 {
   "name": "GDBStub",
-  "version": "0.2",  
+  "version": "0.3",
   "keywords": "gdb, debug",
   "description": "GDB server stub helps debug crashes when JTAG isn't an option.",
   "repository":

libraries/GDBStub/gdbcmds

@@ -1,5 +1,5 @@
 name=GDBStub
-version=0.2
+version=0.3
 author=Jeroen Domburg
 maintainer=Ivan Grokhotkov <[email protected]>
 sentence=GDB server stub by Espressif

libraries/GDBStub/library.json

@@ -1,6 +1,40 @@
 #ifndef GDBSTUB_H
 #define GDBSTUB_H
 
-extern "C" void gdbstub_init();
+#include <stdbool.h>
+#include <stdint.h>
+#include <stddef.h>
 
-#endif //GDBSTUB_H
+#include "internal/gdbstub-cfg.h"
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+void gdbstub_init();
+
+//Indicates whether gdbstub will attach to these or not
+//Useful for other uart libs to avoid conflicts
+bool gdbstub_has_putc1_control();
+bool gdbstub_has_uart_isr_control();
+
+#if GDBSTUB_REDIRECT_CONSOLE_OUTPUT
+void gdbstub_set_putc1_callback(void (*callback)(char));
+#endif
+
+void gdbstub_write_char(char c);
+void gdbstub_write(const char* buf, size_t size);
+
+#if GDBSTUB_CTRLC_BREAK && !GDBSTUB_FREERTOS
+void gdbstub_set_uart_isr_callback(void (*callback)(void*, uint8_t), void* arg);
+
+//Override points for enabling tx and rx pins for uart0
+void gdbstub_hook_enable_tx_pin_uart0(uint8_t pin);
+void gdbstub_hook_enable_rx_pin_uart0(uint8_t pin);
+#endif
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif

libraries/GDBStub/library.properties

@@ -7,7 +7,7 @@
  * License: ESPRESSIF MIT License
  *******************************************************************************/
 
-#include "gdbstub.h"
+#include <GDBStub.h>
 #include <stddef.h>
 #include "ets_sys.h"
 #include "eagle_soc.h"