- "flash write_binary" is now "flash write_bank" to clarify the focus of the

 command and reduce confusion with "flash write_image".
- retired deprecated "flash erase" & "flash write".
- added flash_driver_protect/write/erase() that are wafer thin frontend
 functions to low level driver functions. They implement checks
 that were inconsistently handled by the drivers, e.g. check for
 target halted was done in a spotty fashion.
- use return ERROR_COMMAND_SYNTAX_ERROR to print out
 syntax of command instead of having lots of inlined replicas of
 the command line syntax(some of which were wrong).
- use logging instead of dubious translation of error values to
 human understandable explanations of why things failed.
 The lower levels log the precise reason and the higher
 levels can ammend context as the error propagates up
 the call stack.
- simplified flash API slightly with logging instead of
 allocating and returning information that the caller then
 has to translate into print statements.



git-svn-id: svn://svn.berlios.de/openocd/trunk@337 b42882b7-edfa-0310-969c-e2dbd0fdcd60

1 files changed, 97 insertions, 86 deletions

diff --git a/src/flash/flash.h b/src/flash/flash.h
index 1ef74c8..e8262ef 100644
--- a/src/flash/flash.h
+++ b/src/flash/flash.h
@@ -1,86 +1,97 @@
-/***************************************************************************
- *   Copyright (C) 2005 by Dominic Rath                                    *
- *   Dominic.Rath@gmx.de                                                   *
- *                                                                         *
- *   This program is free software; you can redistribute it and/or modify  *
- *   it under the terms of the GNU General Public License as published by  *
- *   the Free Software Foundation; either version 2 of the License, or     *
- *   (at your option) any later version.                                   *
- *                                                                         *
- *   This program is distributed in the hope that it will be useful,       *
- *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
- *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
- *   GNU General Public License for more details.                          *
- *                                                                         *
- *   You should have received a copy of the GNU General Public License     *
- *   along with this program; if not, write to the                         *
- *   Free Software Foundation, Inc.,                                       *
- *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
- ***************************************************************************/
-#ifndef FLASH_H
-#define FLASH_H
-
-#include "target.h"
-#include "image.h"
-
-#define FLASH_MAX_ERROR_STR	(128)
-
-typedef struct flash_sector_s
-{
-	u32 offset;
-	u32 size;
-	int is_erased;
-	int is_protected;
-} flash_sector_t;
-
-struct flash_bank_s;
-
-typedef struct flash_driver_s
-{
-	char *name;
-	int (*register_commands)(struct command_context_s *cmd_ctx);
-	int (*flash_bank_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);
-	int (*erase)(struct flash_bank_s *bank, int first, int last);
-	int (*protect)(struct flash_bank_s *bank, int set, int first, int last);
-	int (*write)(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);
-	int (*probe)(struct flash_bank_s *bank);
-	int (*erase_check)(struct flash_bank_s *bank);
-	int (*protect_check)(struct flash_bank_s *bank);
-	int (*info)(struct flash_bank_s *bank, char *buf, int buf_size);
-	int (*auto_probe)(struct flash_bank_s *bank);
-} flash_driver_t;
-
-typedef struct flash_bank_s
-{
-	target_t *target;
-	flash_driver_t *driver;
-	void *driver_priv;
-	u32 base;
-	u32 size;
-	int chip_width;
-	int bus_width;
-	int num_sectors;
-	flash_sector_t *sectors;
-	struct flash_bank_s *next;
-} flash_bank_t;
-
-extern int flash_register_commands(struct command_context_s *cmd_ctx);
-extern int flash_init_drivers(struct command_context_s *cmd_ctx);
-
-extern int flash_erase_address_range(target_t *target, u32 addr, u32 length);
-extern int flash_write(target_t *target, image_t *image, u32 *written, char **error, int *failed, int erase);
-extern void flash_set_dirty(void);
-
-extern flash_bank_t *get_flash_bank_by_num(int num);
-extern flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr);
-
-#define		ERROR_FLASH_BANK_INVALID		(-900)
-#define		ERROR_FLASH_SECTOR_INVALID		(-901)
-#define		ERROR_FLASH_OPERATION_FAILED	(-902)
-#define		ERROR_FLASH_DST_OUT_OF_BANK		(-903)
-#define		ERROR_FLASH_DST_BREAKS_ALIGNMENT (-904)
-#define		ERROR_FLASH_BUSY				(-905)
-#define		ERROR_FLASH_SECTOR_NOT_ERASED	(-906)
-#define		ERROR_FLASH_BANK_NOT_PROBED		(-907)
-
-#endif /* FLASH_H */
+/***************************************************************************

+ *   Copyright (C) 2005 by Dominic Rath                                    *

+ *   Dominic.Rath@gmx.de                                                   *

+ *                                                                         *

+ *   This program is free software; you can redistribute it and/or modify  *

+ *   it under the terms of the GNU General Public License as published by  *

+ *   the Free Software Foundation; either version 2 of the License, or     *

+ *   (at your option) any later version.                                   *

+ *                                                                         *

+ *   This program is distributed in the hope that it will be useful,       *

+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *

+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *

+ *   GNU General Public License for more details.                          *

+ *                                                                         *

+ *   You should have received a copy of the GNU General Public License     *

+ *   along with this program; if not, write to the                         *

+ *   Free Software Foundation, Inc.,                                       *

+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *

+ ***************************************************************************/

+#ifndef FLASH_H

+#define FLASH_H

+

+#include "target.h"

+#include "image.h"

+

+#define FLASH_MAX_ERROR_STR	(128)

+

+typedef struct flash_sector_s

+{

+	u32 offset;

+	u32 size;

+	int is_erased;

+	int is_protected;

+} flash_sector_t;

+

+struct flash_bank_s;

+

+typedef struct flash_driver_s

+{

+	char *name;

+	int (*register_commands)(struct command_context_s *cmd_ctx);

+	int (*flash_bank_command)(struct command_context_s *cmd_ctx, char *cmd, char **args, int argc, struct flash_bank_s *bank);

+	/* low level flash erase. Only invoke from flash_driver_erase()

+	 * 

+	 * Will only be invoked when target is halted. 

+	 */

+	int (*erase)(struct flash_bank_s *bank, int first, int last);

+	/* invoked only from flash_driver_protect().

+	 *  

+	 * Only invoked if target is halted

+	 */

+	int (*protect)(struct flash_bank_s *bank, int set, int first, int last);

+	/* low level flash write. Will only be invoked if the target is halted.

+	 * use the flash_driver_write() wrapper to invoke.

+	 */

+	int (*write)(struct flash_bank_s *bank, u8 *buffer, u32 offset, u32 count);

+	int (*probe)(struct flash_bank_s *bank);

+	int (*erase_check)(struct flash_bank_s *bank);

+	int (*protect_check)(struct flash_bank_s *bank);

+	int (*info)(struct flash_bank_s *bank, char *buf, int buf_size);

+	int (*auto_probe)(struct flash_bank_s *bank);

+} flash_driver_t;

+

+typedef struct flash_bank_s

+{

+	target_t *target;

+	flash_driver_t *driver;

+	void *driver_priv;

+	u32 base;

+	u32 size;

+	int chip_width;

+	int bus_width;

+	int num_sectors;

+	flash_sector_t *sectors;

+	struct flash_bank_s *next;

+} flash_bank_t;

+

+extern int flash_register_commands(struct command_context_s *cmd_ctx);

+extern int flash_init_drivers(struct command_context_s *cmd_ctx);

+

+extern int flash_erase_address_range(target_t *target, u32 addr, u32 length);

+extern int flash_write(target_t *target, image_t *image, u32 *written, int erase);

+extern void flash_set_dirty(void);

+

+extern flash_bank_t *get_flash_bank_by_num(int num);

+extern flash_bank_t *get_flash_bank_by_addr(target_t *target, u32 addr);

+

+#define		ERROR_FLASH_BANK_INVALID		(-900)

+#define		ERROR_FLASH_SECTOR_INVALID		(-901)

+#define		ERROR_FLASH_OPERATION_FAILED	(-902)

+#define		ERROR_FLASH_DST_OUT_OF_BANK		(-903)

+#define		ERROR_FLASH_DST_BREAKS_ALIGNMENT (-904)

+#define		ERROR_FLASH_BUSY				(-905)

+#define		ERROR_FLASH_SECTOR_NOT_ERASED	(-906)

+#define		ERROR_FLASH_BANK_NOT_PROBED		(-907)

+

+#endif /* FLASH_H */