change #include "flash.h" to <flash/flash.h>

[openocd.git] / src / flash / flash.h

diff --git a/src/flash/flash.h b/src/flash/flash.h
index 4651fc3664175cf4fb067f990d39990920e014b2..5e31c48bcecb5775a35b5e193360db463f8b0fb2 100644 (file)
--- a/src/flash/flash.h
+++ b/src/flash/flash.h
@@ -26,8 +26,8 @@
 #ifndef FLASH_H
 #define FLASH_H
 
-#include "target.h"
-#include "log.h"
+#include <target/target.h>
+#include <helper/log.h>
 
 struct image;
 
@@ -91,13 +91,11 @@ struct flash_driver
        char *name;
 
        /**
-        * Registers driver-specific commands.  When called (during the
-        * "flash bank" command), the driver may register addition
+        * An array of driver-specific commands to register.  When called
+        * during the "flash bank" command, the driver can register addition
         * commands to support new flash chip functions.
-        *
-        * @returns ERROR_OK if successful; otherwise, an error code.
         */
-       int (*register_commands)(struct command_context *cmd_ctx);
+       const struct command_registration *commands;
 
        /**
         * Finish the "flash bank" command for @a bank.  The
@@ -105,21 +103,21 @@ struct flash_driver
         * layer when this routine is called, and the driver can store
         * additional information in its struct flash_bank::driver_priv field.
         *
-        * The args are: @par
+        * The CMD_ARGV are: @par
         * @code
-        * args[0] = bank
-        * args[1] = drivername {name above}
-        * args[2] = baseaddress
-        * args[3] = lengthbytes
-        * args[4] = chip_width_in bytes
-        * args[5] = bus_width_bytes
-        * args[6] = driver-specific parameters
+        * CMD_ARGV[0] = bank
+        * CMD_ARGV[1] = drivername {name above}
+        * CMD_ARGV[2] = baseaddress
+        * CMD_ARGV[3] = lengthbytes
+        * CMD_ARGV[4] = chip_width_in bytes
+        * CMD_ARGV[5] = bus_width_bytes
+        * CMD_ARGV[6] = driver-specific parameters
         * @endcode
         *
-        * For example, args[4] = 16 bit flash, args[5] = 32bit bus.
+        * For example, CMD_ARGV[4] = 16 bit flash, CMD_ARGV[5] = 32bit bus.
         *
-        * If extra arguments are provided (@a argc > 6), they will
-        * start in @a args[6].  These can be used to implement
+        * If extra arguments are provided (@a CMD_ARGC > 6), they will
+        * start in @a CMD_ARGV[6].  These can be used to implement
         * driver-specific extensions.
         *
         * @returns ERROR_OK if successful; otherwise, an error code.
@@ -240,6 +238,8 @@ struct flash_driver
  */
 struct flash_bank
 {
+       char *name;
+
        struct target *target; /**< Target to which this bank belongs. */
 
        struct flash_driver *driver; /**< Driver for this bank. */
@@ -309,6 +309,14 @@ int default_flash_blank_check(struct flash_bank *bank);
  */
 int default_flash_mem_blank_check(struct flash_bank *bank);
 
+/**
+ * Returns the flash bank specified by @a name, which matches the
+ * driver name and a suffix (option) specify the driver-specific
+ * bank number. The suffix consists of the '.' and the driver-specific
+ * bank number: when two str9x banks are defined, then 'str9x.1' refers
+ * to the second.
+ */
+struct flash_bank *get_flash_bank_by_name(const char *name);
 /**
  * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
  * @param num The flash bank number.
@@ -317,14 +325,16 @@ int default_flash_mem_blank_check(struct flash_bank *bank);
 struct flash_bank *get_flash_bank_by_num(int num);
 /**
  * Retreives @a bank from a command argument, reporting errors parsing
- * the bank identifier or retreiving the specified bank.
- * @param cmd_ctx The command context for reporting errors.
- * @param str The string containing the bank identifier.
+ * the bank identifier or retreiving the specified bank.  The bank
+ * may be identified by its bank number or by @c name.instance, where
+ * @a instance is driver-specific.
+ * @param name_index The index to the string in args containing the
+ * bank identifier.
  * @param bank On output, contians a pointer to the bank or NULL.
  * @returns ERROR_OK on success, or an error indicating the problem.
  */
-int flash_command_get_bank_by_num(struct command_context *cmd_ctx,
-               const char *str, struct flash_bank **bank);
+COMMAND_HELPER(flash_command_get_bank, unsigned name_index,
+               struct flash_bank **bank);
 /**
  * Returns the flash bank like get_flash_bank_by_num(), without probing.
  * @param num The flash bank number.