summaryrefslogtreecommitdiff
path: root/src/flash
diff options
context:
space:
mode:
authorDavid Brownell <dbrownell@users.sourceforge.net>2010-01-11 00:14:01 -0800
committerDavid Brownell <dbrownell@users.sourceforge.net>2010-01-11 00:16:57 -0800
commit8c730aaee22a505cf66666be3ff28734ac885418 (patch)
treee3f5fba860026687418f4e31a4879d286bd0a210 /src/flash
parent88907cc7f941ce85f0dc35ed3dbc4d2dbc87cef7 (diff)
downloadopenocd+libswd-8c730aaee22a505cf66666be3ff28734ac885418.tar.gz
openocd+libswd-8c730aaee22a505cf66666be3ff28734ac885418.tar.bz2
openocd+libswd-8c730aaee22a505cf66666be3ff28734ac885418.tar.xz
openocd+libswd-8c730aaee22a505cf66666be3ff28734ac885418.zip
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>
Diffstat (limited to 'src/flash')
-rw-r--r--src/flash/nor/core.c7
-rw-r--r--src/flash/nor/core.h5
-rw-r--r--src/flash/nor/tcl.c5
3 files changed, 17 insertions, 0 deletions
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)
{