doryan/BloomPatched
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Made a start with documentation for the GDB server implementation

Browse Source
This commit is contained in:
Nav
2022-04-03 02:13:06 +01:00
parent 62375c306c
commit ac534eef95
2 changed files with 131 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/DebugServer/README.md
View File

@@ -32,6 +32,8 @@ running (it hasn't received an event which triggers a shutdown), the `ServerInte
again, and control will be handed back to the server implementation. The AVR GDB server implementation employs this
method to ensure that events are processed ASAP. See the relevant documentation for more.
---
Any blocking I/O employed by a server implementation can support event interrupts using an
[`EventNotifier`](../Helpers/EventNotifier.hpp) and [`EpollInstance`](../Helpers/EpollInstance.hpp).
@@ -54,13 +56,15 @@ the interruption of blocking I/O operations when an event is triggered. Specific
[`GdbRspDebugServer::waitForConnection()`](./Gdb/GdbRspDebugServer.hpp) or
[`Gdb::Connection::read()`](./Gdb/Connection.hpp).
---
### Server implementations
Currently, there is only one server implementation. Others may be added upon request.
| Server Name | Brief Description | Documentation |
|----------------|-------------------|---------------|
| AVR GDB Server | An AVR-specific implementation of the GDB Remote Serial Protocol over TCP/IP. | To follow |
| Server Name | Brief Description | Documentation |
|----------------|-------------------------------------------------------------------------------|---------------------------------------------------|
| AVR GDB Server | An AVR-specific implementation of the GDB Remote Serial Protocol over TCP/IP. | [/src/DebugServer/Gdb/README.md](./Gdb/README.md) |
#### Adding new server implementations