X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fflash.h;h=7afb13274c2c09a5fc80a136e57569cf45839ba0;hp=56aeb3bfa0f12173a942360270fafdd07f497a84;hb=57c5c5f46304a785092874a7dc0f6abc84794cc3;hpb=1840226d555b9863a2315bcc6218671fdfa2af32 diff --git a/src/flash/flash.h b/src/flash/flash.h index 56aeb3bfa0..7afb13274c 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 * @@ -45,13 +45,13 @@ typedef struct flash_sector_s /// 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; @@ -59,6 +59,9 @@ typedef struct flash_sector_s struct flash_bank_s; +#define __FLASH_BANK_COMMAND(name) \ + COMMAND_HELPER(name, struct flash_bank_s *bank) + /** * @brief Provides the implementation-independent structure that defines * all of the callbacks required by OpenOCD flash drivers. @@ -81,13 +84,13 @@ struct flash_bank_s; */ typedef struct flash_driver_s { - /** + /** * 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. @@ -96,23 +99,17 @@ typedef struct flash_driver_s */ int (*register_commands)(struct command_context_s *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. * * The args are: @par * @code * args[0] = bank * args[1] = drivername {name above} - * args[2] = baseaddress + * args[2] = baseaddress * args[3] = lengthbytes * args[4] = chip_width_in bytes * args[5] = bus_width_bytes @@ -127,9 +124,9 @@ 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 * called, the flash driver should erase the specified sectors * using whatever means are at its disposal. @@ -141,7 +138,7 @@ typedef struct flash_driver_s */ int (*erase)(struct flash_bank_s *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 @@ -155,7 +152,7 @@ typedef struct flash_driver_s */ int (*protect)(struct flash_bank_s *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,9 +163,10 @@ 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_s *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. * @@ -176,8 +174,8 @@ typedef struct flash_driver_s * @returns ERROR_OK if successful; otherwise, an error code. */ int (*probe)(struct flash_bank_s *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 @@ -209,7 +207,7 @@ 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); /** @@ -228,7 +226,9 @@ typedef struct flash_driver_s int (*auto_probe)(struct flash_bank_s *bank); } flash_driver_t; -/** +#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. * @@ -265,18 +265,19 @@ typedef struct flash_bank_s } flash_bank_t; /// Registers the 'flash' subsystem commands -extern int flash_register_commands(struct command_context_s *cmd_ctx); +int flash_register_commands(struct command_context_s *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_s *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_s *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 +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_s *target, + struct image_s *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_s *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_s *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 */ -extern flash_bank_t *get_flash_bank_by_num(int num); +flash_bank_t *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. + */ +int flash_command_get_bank_by_num(struct command_context_s *cmd_ctx, + const char *str, flash_bank_t **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. */ -extern flash_bank_t *get_flash_bank_by_num_noprobe(int num); +flash_bank_t *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. */ -extern flash_bank_t *get_flash_bank_by_addr(struct target_s *target, uint32_t addr); +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)