[gem5-dev] Change in gem5/gem5[develop]: base: Tag API methods in remote_gdb.hh
Hoa Nguyen has submitted this change. (
https://gem5-review.googlesource.com/c/public/gem5/+/33256 )
Change subject: base: Tag API methods in remote_gdb.hh
..
base: Tag API methods in remote_gdb.hh
Change-Id: I7d4d6ce8a2b18a365561ad88434fea7d6823d310
Signed-off-by: Hoa Nguyen
Reviewed-on: https://gem5-review.googlesource.com/c/public/gem5/+/33256
Reviewed-by: Bobby R. Bruce
Reviewed-by: Jason Lowe-Power
Maintainer: Bobby R. Bruce
Tested-by: kokoro
---
M src/base/remote_gdb.hh
1 file changed, 21 insertions(+), 1 deletion(-)
Approvals:
Jason Lowe-Power: Looks good to me, but someone else must approve
Bobby R. Bruce: Looks good to me, approved; Looks good to me, approved
kokoro: Regressions pass
diff --git a/src/base/remote_gdb.hh b/src/base/remote_gdb.hh
index fc25990..3ab0feb 100644
--- a/src/base/remote_gdb.hh
+++ b/src/base/remote_gdb.hh
@@ -75,23 +75,31 @@
* Return the pointer to the raw bytes buffer containing the
* register values. Each byte of this buffer is literally
* encoded as two hex digits in the g or G RSP packet.
+ *
+ * @ingroup api_remote_gdb
*/
virtual char *data() const = 0;
/**
* Return the size of the raw buffer, in bytes
* (i.e., half of the number of digits in the g/G packet).
+ *
+ * @ingroup api_remote_gdb
*/
virtual size_t size() const = 0;
/**
* Fill the raw buffer from the registers in the ThreadContext.
+ *
+ * @ingroup api_remote_gdb
*/
virtual void getRegs(ThreadContext*) = 0;
/**
* Set the ThreadContext's registers from the values
* in the raw buffer.
+ *
+ * @ingroup api_remote_gdb
*/
virtual void setRegs(ThreadContext*) const = 0;
@@ -100,9 +108,14 @@
* Having each concrete superclass redefine this member
* is useful in situations where the class of the regCache
* can change on the fly.
+ *
+ * @ingroup api_remote_gdb
*/
virtual const std::string name() const = 0;
+/**
+ * @ingroup api_remote_gdb
+ */
BaseGdbRegCache(BaseRemoteGDB *g) : gdb(g)
{}
virtual ~BaseGdbRegCache()
@@ -117,7 +130,12 @@
friend class HardBreakpoint;
public:
-/*
+/**
+ * @ingroup api_remote_gdb
+ * @{
+ */
+
+/**
* Interface to other parts of the simulator.
*/
BaseRemoteGDB(System *system, ThreadContext *context, int _port);
@@ -139,6 +157,8 @@
bool trap(int type);
bool breakpoint() { return trap(SIGTRAP); }
+/** @} */ // end of api_remote_gdb
+
private:
/*
* Connection to the external GDB.
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/33256
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I7d4d6ce8a2b18a365561ad88434fea7d6823d310
Gerrit-Change-Number: 33256
Gerrit-PatchSet: 3
Gerrit-Owner: Hoa Nguyen
Gerrit-Reviewer: Bobby R. Bruce
Gerrit-Reviewer: Gabe Black
Gerrit-Reviewer: Hoa Nguyen
Gerrit-Reviewer: Jason Lowe-Power
Gerrit-Reviewer: kokoro
Gerrit-MessageType: merged
___
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
[gem5-dev] Change in gem5/gem5[develop]: base: Tag API methods in remote_gdb.hh
Hoa Nguyen has uploaded this change for review. (
https://gem5-review.googlesource.com/c/public/gem5/+/33256 )
Change subject: base: Tag API methods in remote_gdb.hh
..
base: Tag API methods in remote_gdb.hh
Change-Id: I7d4d6ce8a2b18a365561ad88434fea7d6823d310
Signed-off-by: Hoa Nguyen
---
M src/base/remote_gdb.hh
1 file changed, 40 insertions(+), 1 deletion(-)
diff --git a/src/base/remote_gdb.hh b/src/base/remote_gdb.hh
index fc25990..2809d4f 100644
--- a/src/base/remote_gdb.hh
+++ b/src/base/remote_gdb.hh
@@ -75,23 +75,31 @@
* Return the pointer to the raw bytes buffer containing the
* register values. Each byte of this buffer is literally
* encoded as two hex digits in the g or G RSP packet.
+ *
+ * @ingroup api_remote_gdb
*/
virtual char *data() const = 0;
/**
* Return the size of the raw buffer, in bytes
* (i.e., half of the number of digits in the g/G packet).
+ *
+ * @ingroup api_remote_gdb
*/
virtual size_t size() const = 0;
/**
* Fill the raw buffer from the registers in the ThreadContext.
+ *
+ * @ingroup api_remote_gdb
*/
virtual void getRegs(ThreadContext*) = 0;
/**
* Set the ThreadContext's registers from the values
* in the raw buffer.
+ *
+ * @ingroup api_remote_gdb
*/
virtual void setRegs(ThreadContext*) const = 0;
@@ -100,9 +108,14 @@
* Having each concrete superclass redefine this member
* is useful in situations where the class of the regCache
* can change on the fly.
+ *
+ * @ingroup api_remote_gdb
*/
virtual const std::string name() const = 0;
+/**
+ * @ingroup api_remote_gdb
+ */
BaseGdbRegCache(BaseRemoteGDB *g) : gdb(g)
{}
virtual ~BaseGdbRegCache()
@@ -117,27 +130,53 @@
friend class HardBreakpoint;
public:
-/*
+/**
* Interface to other parts of the simulator.
+ *
+ * @ingroup api_remote_gdb
*/
BaseRemoteGDB(System *system, ThreadContext *context, int _port);
virtual ~BaseRemoteGDB();
+/**
+ * @ingroup api_remote_gdb
+ */
std::string name();
+/**
+ * @ingroup api_remote_gdb
+ * @{
+ */
void listen();
void connect();
+/** @} */ // end of api_remote_gdb
+/**
+ * @ingroup api_remote_gdb
+ */
int port() const;
+/**
+ * @ingroup api_remote_gdb
+ * @{
+ */
void attach(int fd);
void detach();
bool isAttached() { return attached; }
+/** @} */ // end of api_remote_gdb
+/**
+ * @ingroup api_remote_gdb
+ */
void replaceThreadContext(ThreadContext *_tc) { tc = _tc; }
+/**
+ * @ingroup api_remote_gdb
+ * @{
+ */
bool trap(int type);
bool breakpoint() { return trap(SIGTRAP); }
+/** @} */ // end of api_remote_gdb
private:
/*
--
To view, visit https://gem5-review.googlesource.com/c/public/gem5/+/33256
To unsubscribe, or for help writing mail filters, visit
https://gem5-review.googlesource.com/settings
Gerrit-Project: public/gem5
Gerrit-Branch: develop
Gerrit-Change-Id: I7d4d6ce8a2b18a365561ad88434fea7d6823d310
Gerrit-Change-Number: 33256
Gerrit-PatchSet: 1
Gerrit-Owner: Hoa Nguyen
Gerrit-MessageType: newchange
___
gem5-dev mailing list -- gem5-dev@gem5.org
To unsubscribe send an email to gem5-dev-le...@gem5.org
%(web_page_url)slistinfo%(cgiext)s/%(_internal_name)s
