From: David Brownell <dbrownell@users.sourceforge.net>
Date: Mon, 11 Jan 2010 08:14:01 +0000 (-0800)
Subject: Doxygen file comments
X-Git-Tag: v0.4.0-rc2~104
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=8c730aaee22a505cf66666be3ff28734ac885418;p=openocd

Doxygen file comments

Add file comments to a few files.  Make the GDB server use
more conventional (pointer-free) hex digit conversion.

Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
---

diff --git a/src/flash/nor/core.c b/src/flash/nor/core.c
index 7e783d42..9083ed15 100644
--- a/src/flash/nor/core.c
+++ b/src/flash/nor/core.c
@@ -29,6 +29,13 @@
 #include <target/image.h>
 
 
+/**
+ * @file
+ * Upper level of NOR flash framework.
+ * The lower level interfaces are to drivers.  These upper level ones
+ * primarily support access from Tcl scripts or from GDB.
+ */
+
 struct flash_bank *flash_banks;
 
 int flash_driver_erase(struct flash_bank *bank, int first, int last)
diff --git a/src/flash/nor/core.h b/src/flash/nor/core.h
index c1e26cd2..36e163df 100644
--- a/src/flash/nor/core.h
+++ b/src/flash/nor/core.h
@@ -24,6 +24,11 @@
 
 #include <flash/common.h>
 
+/**
+ * @file
+ * Upper level NOR flash interfaces.
+ */
+
 struct image;
 
 #define FLASH_MAX_ERROR_STR	(128)
diff --git a/src/flash/nor/tcl.c b/src/flash/nor/tcl.c
index 65523fbe..b7e80df2 100644
--- a/src/flash/nor/tcl.c
+++ b/src/flash/nor/tcl.c
@@ -26,6 +26,11 @@
 #include <helper/time_support.h>
 #include <target/image.h>
 
+/**
+ * @file
+ * Implements Tcl commands used to access NOR flash facilities.
+ */
+
 COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
 		struct flash_bank **bank)
 {
diff --git a/src/server/gdb_server.c b/src/server/gdb_server.c
index 08daa68a..f4a99cae 100644
--- a/src/server/gdb_server.c
+++ b/src/server/gdb_server.c
@@ -37,6 +37,15 @@
 #include <jtag/jtag.h>
 
 
+/**
+ * @file
+ * GDB server implementation.
+ *
+ * This implements the GDB Remote Serial Protocol, over TCP connections,
+ * giving GDB access to the JTAG or other hardware debugging facilities
+ * found in most modern embedded processors.
+ */
+
 /* private connection data for GDB */
 struct gdb_connection
 {
@@ -68,7 +77,7 @@ static enum breakpoint_type gdb_breakpoint_override_type;
 extern int gdb_error(struct connection *connection, int retval);
 static unsigned short gdb_port = 3333;
 static unsigned short gdb_port_next = 0;
-static const char *DIGITS = "0123456789abcdef";
+static const char DIGITS[16] = "0123456789abcdef";
 
 static void gdb_log_callback(void *priv, const char *file, unsigned line,
 		const char *function, const char *string);