X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fflash.h;h=8cd50f68253cade7cd92c5afa336ebb2d9a963d6;hp=9cd592321c3b3a946f8e34b06f9c97e81882730b;hb=d9dc604a4d790f557a7ba502babdabffa27eaa17;hpb=632fd663a821047df9a9b965ec1c35d6b034ebba diff --git a/src/flash/flash.h b/src/flash/flash.h index 9cd592321c..8cd50f6825 100644 --- a/src/flash/flash.h +++ b/src/flash/flash.h @@ -26,10 +26,9 @@ #ifndef FLASH_H #define FLASH_H -#include "target.h" -#include "log.h" +#include -struct image_s; +struct image; #define FLASH_MAX_ERROR_STR (128) @@ -57,10 +56,10 @@ struct flash_sector int is_protected; }; -struct flash_bank_s; +struct flash_bank; #define __FLASH_BANK_COMMAND(name) \ - COMMAND_HELPER(name, struct flash_bank_s *bank) + COMMAND_HELPER(name, struct flash_bank *bank) /** * @brief Provides the implementation-independent structure that defines @@ -91,35 +90,33 @@ 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_s *cmd_ctx); + const struct command_registration *commands; /** * 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. + * 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. @@ -136,7 +133,7 @@ struct flash_driver * @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). @@ -150,7 +147,7 @@ struct flash_driver * @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 @@ -163,7 +160,7 @@ struct flash_driver * @param count The number of bytes to write. * @returns ERROR_OK if successful; otherwise, an error code. */ - int (*write)(struct flash_bank_s *bank, + int (*write)(struct flash_bank *bank, uint8_t *buffer, uint32_t offset, uint32_t count); /** @@ -173,7 +170,7 @@ struct flash_driver * @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. @@ -184,7 +181,7 @@ struct flash_driver * @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. @@ -196,7 +193,7 @@ struct flash_driver * @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 @@ -208,7 +205,7 @@ struct flash_driver * @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 @@ -223,7 +220,7 @@ struct flash_driver * @param bank - the bank to probe * @returns ERROR_OK if successful; otherwise, an error code. */ - int (*auto_probe)(struct flash_bank_s *bank); + int (*auto_probe)(struct flash_bank *bank); }; #define FLASH_BANK_COMMAND_HANDLER(name) static __FLASH_BANK_COMMAND(name) @@ -238,9 +235,11 @@ struct flash_driver * 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. */ + char *name; + + struct target *target; /**< Target to which this bank belongs. */ struct flash_driver *driver; /**< Driver for this bank. */ void *driver_priv; /**< Private driver storage pointer */ @@ -261,19 +260,19 @@ typedef struct flash_bank_s /// Array of sectors, allocated and initilized by the flash driver 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 -int flash_register_commands(struct command_context_s *cmd_ctx); +int flash_register_commands(struct command_context *cmd_ctx); /// Initializes the 'flash' subsystem drivers -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. */ -int flash_erase_address_range(struct target_s *target, +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 @@ -285,8 +284,8 @@ int flash_erase_address_range(struct target_s *target, * erase the corresponding banks or sectors before programming. * @returns ERROR_OK if successful; otherwise, an error code. */ -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. @@ -300,52 +299,53 @@ int flash_get_bank_count(void); * this routine will call default_flash_mem_blank_check() to confirm. * @returns ERROR_OK if successful; otherwise, an error code. */ -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. */ -int default_flash_mem_blank_check(struct flash_bank_s *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. - * @returns A flash_bank_t for flash bank @a num, or NULL + * @returns A struct flash_bank for flash bank @a num, or NULL */ -flash_bank_t *get_flash_bank_by_num(int num); +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_s *cmd_ctx, - const char *str, flash_bank_t **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. - * @returns A flash_bank_t for flash bank @a num, or NULL. + * @returns A struct flash_bank for flash bank @a num, or NULL. */ -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. */ -flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t 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) +struct flash_bank *get_flash_bank_by_addr(struct target *target, uint32_t addr); #endif /* FLASH_H */