X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=blobdiff_plain;f=src%2Fflash%2Fflash.h;fp=src%2Fflash%2Fflash.h;h=fb88c35398a51321fc904051952798151d46cb44;hp=23a7b81839c0707f0f4f1edeeefb8712d59d1400;hb=870b8c04557f0b7441cc502debaf537984d77e2a;hpb=8f446fcf676e9cd13cf53d9946f0cae5d29a10ec diff --git a/src/flash/flash.h b/src/flash/flash.h index 23a7b81839..fb88c35398 100644 --- a/src/flash/flash.h +++ b/src/flash/flash.h @@ -309,6 +309,14 @@ int default_flash_blank_check(struct flash_bank *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. @@ -317,7 +325,9 @@ int default_flash_mem_blank_check(struct flash_bank *bank); 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 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.