X-Git-Url: https://review.openocd.org/gitweb?a=blobdiff_plain;f=src%2Fflash%2Fflash.h;h=ac1600e4587f535942aa2f633ffae8b1f77129fe;hb=1765b103044179baa2d5036bb61710369ae59e70;hp=56aeb3bfa0f12173a942360270fafdd07f497a84;hpb=1840226d555b9863a2315bcc6218671fdfa2af32;p=openocd.git diff --git a/src/flash/flash.h b/src/flash/flash.h index 56aeb3bfa0..ac1600e458 100644 --- a/src/flash/flash.h +++ b/src/flash/flash.h @@ -2,7 +2,7 @@ * Copyright (C) 2005 by Dominic Rath * * Dominic.Rath@gmx.de * * * - * Copyright (C) 2007,2008 Øyvind Harboe * + * Copyright (C) 2007,2008 Øyvind Harboe * * oyvind.harboe@zylin.com * * * * Copyright (C) 2008 by Spencer Oliver * @@ -29,7 +29,7 @@ #include "target.h" #include "log.h" -struct image_s; +struct image; #define FLASH_MAX_ERROR_STR (128) @@ -38,26 +38,29 @@ 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; /// Number of bytes in this flash sector. uint32_t size; /** - * Indication of erasure status: 0=not erased, 1=erased, - * other=unknown. Set by @c flash_driver_s::erase_check. + * Indication of erasure status: 0 = not erased, 1 = erased, + * other = unknown. Set by @c flash_driver_s::erase_check. */ int is_erased; /** - * Indication of protection status: 0=unprotected/unlocked, - * 1=protected/locked, other=unknown. Set by + * Indication of protection status: 0 = unprotected/unlocked, + * 1 = protected/locked, other = unknown. Set by * @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,57 +82,51 @@ struct flash_bank_s; * corresponding static flash_driver_callback() * routine in flash.c. */ -typedef struct flash_driver_s +struct flash_driver { - /** + /** * Gives a human-readable name of this flash driver, * This field is used to select and initialize the driver. */ char *name; - /** + /** * Registers driver-specific commands. When called (during the * "flash bank" command), the driver may 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); + 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 + * 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. */ - 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 * called, the flash driver should erase the specified sectors * using whatever means are at its disposal. @@ -139,9 +136,9 @@ 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). * When called, the driver should disable 'flash write' bits (or * enable 'erase protection' bits) for the given @a bank and @a @@ -153,9 +150,9 @@ 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 * "bank->base + offset", while the physical address is * dependent upon current target MMU mappings. @@ -166,18 +163,19 @@ 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. * This is invoked by the "probe" script command. * * @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. * When called, the driver routine must perform the required * checks and then set the @c flash_sector_s::is_erased field @@ -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 @@ -209,8 +207,8 @@ typedef struct flash_driver_s * @param char - where to put the text for the human to read * @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,10 +223,12 @@ 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 * a major interface. * @@ -238,11 +238,13 @@ 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. */ + char *name; + + 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,24 +261,25 @@ 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 + * will contain the * @param target The target with the flash to be programmed. * @param image The image that will be programmed to flash. * @param written On return, contains the number of bytes written. @@ -284,48 +287,69 @@ 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 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 + */ +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. 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. */ -extern flash_bank_t *get_flash_bank_by_num(int num); +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. */ -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)