X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fflash.h;h=4651fc3664175cf4fb067f990d39990920e014b2;hp=a7f08f63d7d98499d15cfe274f4e98ab0e7b87ae;hb=98723c4ecdbe06f90c66f3abec27b792c3b38e34;hpb=8b994145b849c40b0a195c3fb332b9770b2f9097

diff --git a/src/flash/flash.h b/src/flash/flash.h
index a7f08f63d7..4651fc3664 100644
--- a/src/flash/flash.h
+++ b/src/flash/flash.h
@@ -29,7 +29,7 @@
 #include "target.h"
 #include "log.h"
 
-struct image_s;
+struct image;
 
 #define FLASH_MAX_ERROR_STR	(128)
 
@@ -38,7 +38,7 @@ struct image_s;
  * within a flash bank.  A single bank typically consists of multiple
  * sectors, each of which can be erased and protected independently.
  */
-typedef struct flash_sector_s
+struct flash_sector
 {
 	/// Bus offset from start of the flash chip (in bytes).
 	uint32_t offset;
@@ -55,9 +55,12 @@ typedef struct flash_sector_s
 	 * @c flash_driver_s::protect_check.
 	 */
 	int is_protected;
-} flash_sector_t;
+};
 
-struct flash_bank_s;
+struct flash_bank;
+
+#define __FLASH_BANK_COMMAND(name) \
+		COMMAND_HELPER(name, struct flash_bank *bank)
 
 /**
  * @brief Provides the implementation-independent structure that defines
@@ -79,7 +82,7 @@ struct flash_bank_s;
  * corresponding static <code>flash_driver_<i>callback</i>()</code>
  * routine in flash.c.
  */
-typedef struct flash_driver_s
+struct flash_driver
 {
 	/**
 	 * Gives a human-readable name of this flash driver,
@@ -94,19 +97,13 @@ typedef struct flash_driver_s
 	 *
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*register_commands)(struct command_context_s *cmd_ctx);
+	int (*register_commands)(struct command_context *cmd_ctx);
 
 	/**
 	 * Finish the "flash bank" command for @a bank.  The
 	 * @a bank parameter will have been filled in by the core flash
 	 * layer when this routine is called, and the driver can store
-	 * additional information in its flash_bank_t::driver_priv field.
-	 *
-	 * @param cmd_ctx - the command context
-	 * @param cmd     - the command, in this case 'flash'
-	 * @param args    - parameters, see below
-	 * @param argc    - number of parameters on command line
-	 * @param bank    - new filled in flash bank.
+	 * additional information in its struct flash_bank::driver_priv field.
 	 *
 	 * The args are: @par
 	 * @code
@@ -127,7 +124,7 @@ typedef struct flash_driver_s
 	 *
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*flash_bank_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
+	__FLASH_BANK_COMMAND((*flash_bank_command));
 
 	/**
 	 * Bank/sector erase routine (target-specific).  When
@@ -139,7 +136,7 @@ typedef struct flash_driver_s
 	 * @param last The number of the last sector to erase, typically N-1.
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*erase)(struct flash_bank_s *bank, int first, int last);
+	int (*erase)(struct flash_bank *bank, int first, int last);
 
 	/**
 	 * Bank/sector protection routine (target-specific).
@@ -153,7 +150,7 @@ typedef struct flash_driver_s
 	 * @param last The last sector to (un)project, typically N-1.
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*protect)(struct flash_bank_s *bank, int set, int first, int last);
+	int (*protect)(struct flash_bank *bank, int set, int first, int last);
 
 	/**
 	 * Program data into the flash.  Note CPU address will be
@@ -166,7 +163,8 @@ typedef struct flash_driver_s
 	 * @param count The number of bytes to write.
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*write)(struct flash_bank_s *bank, uint8_t *buffer, uint32_t offset, uint32_t count);
+	int (*write)(struct flash_bank *bank,
+			uint8_t *buffer, uint32_t offset, uint32_t count);
 
 	/**
 	 * Probe to determine what kind of flash is present.
@@ -175,7 +173,7 @@ typedef struct flash_driver_s
 	 * @param bank The bank to probe
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*probe)(struct flash_bank_s *bank);
+	int (*probe)(struct flash_bank *bank);
 
 	/**
 	 * Check the erasure status of a flash bank.
@@ -186,7 +184,7 @@ typedef struct flash_driver_s
 	 * @param bank The bank to check
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*erase_check)(struct flash_bank_s *bank);
+	int (*erase_check)(struct flash_bank *bank);
 
 	/**
 	 * Determine if the specific bank is "protected" or not.
@@ -198,7 +196,7 @@ typedef struct flash_driver_s
 	 * @param bank - the bank to check
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*protect_check)(struct flash_bank_s *bank);
+	int (*protect_check)(struct flash_bank *bank);
 
 	/**
 	 * Display human-readable information about the flash
@@ -210,7 +208,7 @@ typedef struct flash_driver_s
 	 * @param buf_size - the size of the human buffer.
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*info)(struct flash_bank_s *bank, char *buf, int buf_size);
+	int (*info)(struct flash_bank *bank, char *buf, int buf_size);
 
 	/**
 	 * A more gentle flavor of filash_driver_s::probe, performing
@@ -225,8 +223,10 @@ typedef struct flash_driver_s
 	 * @param bank - the bank to probe
 	 * @returns ERROR_OK if successful; otherwise, an error code.
 	 */
-	int (*auto_probe)(struct flash_bank_s *bank);
-} flash_driver_t;
+	int (*auto_probe)(struct flash_bank *bank);
+};
+
+#define FLASH_BANK_COMMAND_HANDLER(name) static __FLASH_BANK_COMMAND(name)
 
 /**
  * Provides details of a flash bank, available either on-chip or through
@@ -238,11 +238,11 @@ typedef struct flash_driver_s
  * may use the @c driver_priv member to store additional data on a
  * per-bank basis, if required.
  */
-typedef struct flash_bank_s
+struct flash_bank
 {
-	struct target_s *target; /**< Target to which this bank belongs. */
+	struct target *target; /**< Target to which this bank belongs. */
 
-	flash_driver_t *driver; /**< Driver for this bank. */
+	struct flash_driver *driver; /**< Driver for this bank. */
 	void *driver_priv; /**< Private driver storage pointer */
 
 	int bank_number; /**< The 'bank' (or chip number) of this instance. */
@@ -259,21 +259,22 @@ typedef struct flash_bank_s
 	 */
 	int num_sectors;
 	/// Array of sectors, allocated and initilized by the flash driver
-	flash_sector_t *sectors;
+	struct flash_sector *sectors;
 
-	struct flash_bank_s *next; /**< The next flash bank on this chip */
-} flash_bank_t;
+	struct flash_bank *next; /**< The next flash bank on this chip */
+};
 
 /// Registers the 'flash' subsystem commands
-extern int flash_register_commands(struct command_context_s *cmd_ctx);
+int flash_register_commands(struct command_context *cmd_ctx);
 /// Initializes the 'flash' subsystem drivers
-extern int flash_init_drivers(struct command_context_s *cmd_ctx);
+int flash_init_drivers(struct command_context *cmd_ctx);
 
 /**
  * Erases @a length bytes in the @a target flash, starting at @a addr.
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
-extern int flash_erase_address_range(struct target_s *target, uint32_t addr, uint32_t length);
+int flash_erase_address_range(struct target *target,
+		uint32_t addr, uint32_t length);
 /**
  * Writes @a image into the @a target flash.  The @a written parameter
  * will contain the
@@ -284,48 +285,59 @@ extern int flash_erase_address_range(struct target_s *target, uint32_t addr, uin
  * erase the corresponding banks or sectors before programming.
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
-extern int flash_write(struct target_s *target, struct image_s *image, uint32_t *written, int erase);
+int flash_write(struct target *target,
+		struct image *image, uint32_t *written, int erase);
 /**
  * Forces targets to re-examine their erase/protection state.
  * This routine must be called when the system may modify the status.
  */
-extern void flash_set_dirty(void);
+void flash_set_dirty(void);
 /// @returns The number of flash banks currently defined.
-extern int flash_get_bank_count(void);
+int flash_get_bank_count(void);
 /**
  * Provides default erased-bank check handling. Checks to see if
  * the flash driver knows they are erased; if things look uncertain,
  * this routine will call default_flash_mem_blank_check() to confirm.
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
-extern int default_flash_blank_check(struct flash_bank_s *bank);
+int default_flash_blank_check(struct flash_bank *bank);
 /**
  * Provides a default blank flash memory check.  Ensures the contents
  * of the given bank have truly been erased.
  * @param bank The flash bank.
  * @returns ERROR_OK if successful; otherwise, an error code.
  */
-extern int default_flash_mem_blank_check(struct flash_bank_s *bank);
+int default_flash_mem_blank_check(struct flash_bank *bank);
 
 /**
  * Returns a flash bank by the specified flash_bank_s bank_number, @a num.
  * @param num The flash bank number.
- * @returns A flash_bank_t for flash bank @a num, or NULL
+ * @returns A struct flash_bank for flash bank @a num, or NULL
+ */
+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.
+ * @param bank On output, contians a pointer to the bank or NULL.
+ * @returns ERROR_OK on success, or an error indicating the problem.
  */
-extern flash_bank_t *get_flash_bank_by_num(int num);
+int flash_command_get_bank_by_num(struct command_context *cmd_ctx,
+		const char *str, struct flash_bank **bank);
 /**
  * Returns the flash bank like get_flash_bank_by_num(), without probing.
  * @param num The flash bank number.
- * @returns A flash_bank_t for flash bank @a num, or NULL.
+ * @returns A struct flash_bank for flash bank @a num, or NULL.
  */
-extern flash_bank_t *get_flash_bank_by_num_noprobe(int num);
+struct flash_bank *get_flash_bank_by_num_noprobe(int num);
 /**
  * Returns the flash bank located at a specified address.
  * @param target The target, presumed to contain one or more banks.
  * @param addr An address that is within the range of the bank.
- * @returns The flash_bank_t located at @a addr, or NULL.
+ * @returns The struct flash_bank located at @a addr, or NULL.
  */
-extern flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t addr);
+struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr);
 
 #define ERROR_FLASH_BANK_INVALID			(-900)
 #define ERROR_FLASH_SECTOR_INVALID			(-901)