diff options
| author | Daniel Ramirez <javamonn@gmail.com> | 2013-12-23 13:03:25 -0600 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2013-12-23 15:06:12 -0500 |
| commit | c2b752881df62c870c395bb1f6c405bca33bec37 (patch) | |
| tree | 59bdac6a9aff4b946f473a69622a812c9c01d164 /c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h | |
| parent | i386: shared: Add doxygen (diff) | |
| download | rtems-c2b752881df62c870c395bb1f6c405bca33bec37.tar.bz2 | |
mips/shared: added new doxygen
Diffstat (limited to 'c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h')
| -rw-r--r-- | c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h | 33 |
1 files changed, 28 insertions, 5 deletions
diff --git a/c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h b/c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h index db5e711678..ba4f0eb757 100644 --- a/c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h +++ b/c/src/lib/libbsp/mips/shared/gdbstub/gdb_if.h @@ -1,3 +1,9 @@ +/** + * @file + * @ingroup mips_gdb + * @brief Definition of the interface between stub and gdb + */ + /* * gdb_if.h - definition of the interface between the stub and gdb * @@ -12,10 +18,17 @@ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. */ +/** + * @defgroup mips_gdb GDB Interface + * @ingroup mips_shared + * @brief GDB Interface + * @{ + */ + #ifndef _GDB_IF_H #define _GDB_IF_H -/* Max number of threads in qM response */ +/** @brief Max number of threads in qM response */ #define QM_MAX_THREADS (20) struct rtems_gdb_stub_thread_info { @@ -24,8 +37,9 @@ struct rtems_gdb_stub_thread_info { char more_display[256]; }; -/* - * Prototypes +/** + * @name Prototypes + * @{ */ int parse_zbreak(const char *in, int *type, unsigned char **addr, int *len); @@ -70,9 +84,14 @@ void rtems_gdb_process_query( int thread ); -/* - * MIPS registers, numbered in the order in which gdb expects to see them. +/** @} */ + +/** + * @name MIPS registers + * @brief Numbered in the order in which gdb expects to see them. + * @{ */ + #define ZERO 0 #define AT 1 #define V0 2 @@ -157,6 +176,8 @@ void rtems_gdb_process_query( #define NUM_REGS 72 +/** @} */ + void mips_gdb_stub_install(int enableThreads) ; #define MEMOPT_READABLE 1 @@ -168,4 +189,6 @@ void mips_gdb_stub_install(int enableThreads) ; int gdbstub_add_memsegment(unsigned,unsigned,int); +/** @} */ + #endif /* _GDB_IF_H */ |