flash/nor/rp2040: refactoring: change rp2040 to rp2xxx

While on it use calloc() instead of malloc()/memset()
Drop useless implementation of rp2040_flash_free_driver_priv()
- exactly same as default_flash_free_driver_priv()
Code style fixes forced by checkpatch

Signed-off-by: Tomas Vanek <vanekt@fbl.cz>
Change-Id: I5c56c4a7d586c0dcab164a45e8f6200ea9a3bd1d
Reviewed-on: https://review.openocd.org/c/openocd/+/8455
Tested-by: jenkins

diff --git a/src/flash/nor/Makefile.am b/src/flash/nor/Makefile.am
index 147807fbaa29f1189b3282f7361d2f9c31cb18af..7a81b282b608e6d3938c991f20a89069186d1d72 100644 (file)
--- a/src/flash/nor/Makefile.am
+++ b/src/flash/nor/Makefile.am
@@ -59,7 +59,7 @@ NOR_DRIVERS = \
        %D%/psoc6.c \
        %D%/qn908x.c \
        %D%/renesas_rpchf.c \
-       %D%/rp2040.c \
+       %D%/rp2xxx.c \
        %D%/rsl10.c \
        %D%/sfdp.c \
        %D%/sh_qspi.c \

diff --git a/src/flash/nor/driver.h b/src/flash/nor/driver.h
index 794566f121c3de0606b68226e5329917e319b013..3b57ef9ff0e16039bf7f13b0feee522a009a91ac 100644 (file)
--- a/src/flash/nor/driver.h
+++ b/src/flash/nor/driver.h
@@ -289,7 +289,7 @@ extern const struct flash_driver psoc5lp_nvl_flash;
 extern const struct flash_driver psoc6_flash;
 extern const struct flash_driver qn908x_flash;
 extern const struct flash_driver renesas_rpchf_flash;
-extern const struct flash_driver rp2040_flash;
+extern const struct flash_driver rp2xxx_flash;
 extern const struct flash_driver rsl10_flash;
 extern const struct flash_driver sh_qspi_flash;
 extern const struct flash_driver sim3x_flash;

diff --git a/src/flash/nor/drivers.c b/src/flash/nor/drivers.c
index 67d86243b7b303337d8f52a30cbf554155cf4537..3770bfbd3c9873e851d2da9d075140f7d799f815 100644 (file)
--- a/src/flash/nor/drivers.c
+++ b/src/flash/nor/drivers.c
@@ -66,7 +66,7 @@ static const struct flash_driver * const flash_drivers[] = {
        &psoc6_flash,
        &qn908x_flash,
        &renesas_rpchf_flash,
-       &rp2040_flash,
+       &rp2xxx_flash,
        &sh_qspi_flash,
        &sim3x_flash,
        &stellaris_flash,

diff --git a/src/flash/nor/rp2040.c b/src/flash/nor/rp2xxx.c
similarity index 94%
rename from src/flash/nor/rp2040.c
rename to src/flash/nor/rp2xxx.c
index 514cea8b69e6c4a1374a0f1f5b60f2ea5b02a10f..e58fc8a29b02bac4c978ba0f40c68d5dc1b421ae 100644 (file)
--- a/src/flash/nor/rp2040.c
+++ b/src/flash/nor/rp2xxx.c
@@ -185,14 +185,14 @@ typedef struct rp2xxx_rom_call_batch_record {
        uint32_t args[4];
 } rp2xxx_rom_call_batch_record_t;
 
-struct rp2040_flash_bank {
+struct rp2xxx_flash_bank {
        bool probed;                                            /* flag indicating successful flash probe */
        uint32_t id;                                            /* cached SYSINFO CHIP_ID */
        struct working_area *stack;                     /* stack used by Boot ROM calls */
        /* static code scratchpad used for RAM algorithms -- allocated in advance
           so that higher-level calls can just grab all remaining workarea: */
        struct working_area *ram_algo_space;
-       /* function jump table populated by rp2040_flash_probe() */
+       /* function jump table populated by rp2xxx_flash_probe() */
        uint16_t jump_flash_exit_xip;
        uint16_t jump_connect_internal_flash;
        uint16_t jump_flash_range_erase;
@@ -381,7 +381,7 @@ static int rp2xxx_lookup_rom_symbol(struct target *target, uint16_t tag, uint16_
        return ERROR_FAIL;
 }
 
-static int rp2xxx_populate_rom_pointer_cache(struct target *target, struct rp2040_flash_bank *priv)
+static int rp2xxx_populate_rom_pointer_cache(struct target *target, struct rp2xxx_flash_bank *priv)
 {
        const uint16_t symtype_func = is_arm(target_to_arm(target))
                                                                         ? RT_FLAG_FUNC_ARM_SEC : RT_FLAG_FUNC_RISCV;
@@ -444,7 +444,7 @@ static int rp2xxx_populate_rom_pointer_cache(struct target *target, struct rp204
 
 // Call a list of PC + SP + r0-r3 function call tuples with a single OpenOCD
 // algorithm invocation, to amortise the algorithm overhead over multiple calls:
-static int rp2xxx_call_rom_func_batch(struct target *target, struct rp2040_flash_bank *priv,
+static int rp2xxx_call_rom_func_batch(struct target *target, struct rp2xxx_flash_bank *priv,
        rp2xxx_rom_call_batch_record_t *calls, unsigned int n_calls)
 {
        // Note +1 is for the null terminator
@@ -556,7 +556,7 @@ static int rp2xxx_call_rom_func_batch(struct target *target, struct rp2040_flash
 }
 
 // Call a single ROM function, using the default algorithm stack.
-static int rp2xxx_call_rom_func(struct target *target, struct rp2040_flash_bank *priv,
+static int rp2xxx_call_rom_func(struct target *target, struct rp2xxx_flash_bank *priv,
                uint16_t func_offset, uint32_t argdata[], unsigned int n_args)
 {
        assert(n_args <= 4); /* only allow register arguments -- capped at just 4 on Arm */
@@ -602,7 +602,7 @@ static int rp2350_init_accessctrl(struct target *target)
        return ERROR_OK;
 }
 
-static int rp2350_init_arm_core0(struct target *target, struct rp2040_flash_bank *priv)
+static int rp2350_init_arm_core0(struct target *target, struct rp2xxx_flash_bank *priv)
 {
        // Flash algorithms (and the RCP init stub called by this function) must
        // run in the Secure state, so flip the state now before attempting to
@@ -661,7 +661,7 @@ static int rp2350_init_arm_core0(struct target *target, struct rp2040_flash_bank
        return err;
 }
 
-static int setup_for_raw_flash_cmd(struct target *target, struct rp2040_flash_bank *priv)
+static int setup_for_raw_flash_cmd(struct target *target, struct rp2xxx_flash_bank *priv)
 {
        int err = ERROR_OK;
 
@@ -725,14 +725,14 @@ static int setup_for_raw_flash_cmd(struct target *target, struct rp2040_flash_ba
        };
        err = rp2xxx_call_rom_func_batch(target, priv, calls, 2);
        if (err != ERROR_OK) {
-               LOG_ERROR("RP2040 flash: failed to exit flash XIP mode");
+               LOG_ERROR("RP2xxx flash: failed to exit flash XIP mode");
                return err;
        }
 
        return ERROR_OK;
 }
 
-static int rp2xxx_invalidate_cache_restore_xip(struct target *target, struct rp2040_flash_bank *priv)
+static int rp2xxx_invalidate_cache_restore_xip(struct target *target, struct rp2xxx_flash_bank *priv)
 {
        // Flash content has changed. We can now do a bit of poking to make
        // the new flash contents visible to us via memory-mapped (XIP) interface
@@ -763,12 +763,12 @@ static int rp2xxx_invalidate_cache_restore_xip(struct target *target, struct rp2
 
        int retval = rp2xxx_call_rom_func_batch(target, priv, finishing_calls, num_finishing_calls);
        if (retval != ERROR_OK)
-               LOG_ERROR("RP2040 write: failed to flush flash cache/restore XIP");
+               LOG_ERROR("RP2xxx: failed to flush flash cache/restore XIP");
 
        return retval;
 }
 
-static void cleanup_after_raw_flash_cmd(struct target *target, struct rp2040_flash_bank *priv)
+static void cleanup_after_raw_flash_cmd(struct target *target, struct rp2xxx_flash_bank *priv)
 {
        /* OpenOCD is prone to trashing work-area allocations on target state
           transitions, which leaves us with stale work area pointers in our
@@ -785,11 +785,11 @@ static void cleanup_after_raw_flash_cmd(struct target *target, struct rp2040_fla
        }
 }
 
-static int rp2040_flash_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
+static int rp2xxx_flash_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
 {
        LOG_DEBUG("Writing %d bytes starting at 0x%" PRIx32, count, offset);
 
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
        struct target *target = bank->target;
 
        if (target->state != TARGET_HALTED) {
@@ -851,9 +851,9 @@ cleanup_and_return:
        return err;
 }
 
-static int rp2040_flash_erase(struct flash_bank *bank, unsigned int first, unsigned int last)
+static int rp2xxx_flash_erase(struct flash_bank *bank, unsigned int first, unsigned int last)
 {
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
        struct target *target = bank->target;
 
        if (target->state != TARGET_HALTED) {
@@ -863,7 +863,7 @@ static int rp2040_flash_erase(struct flash_bank *bank, unsigned int first, unsig
 
        uint32_t start_addr = bank->sectors[first].offset;
        uint32_t length = bank->sectors[last].offset + bank->sectors[last].size - start_addr;
-       LOG_DEBUG("RP2040 erase %d bytes starting at 0x%" PRIx32, length, start_addr);
+       LOG_DEBUG("erase %d bytes starting at 0x%" PRIx32, length, start_addr);
 
        int err = setup_for_raw_flash_cmd(target, priv);
        if (err != ERROR_OK)
@@ -1064,7 +1064,7 @@ static int rp2xxx_spi_tx_rx(struct flash_bank *bank,
                unsigned int dummy_len,
                uint8_t *rx, unsigned int rx_len)
 {
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
        struct target *target = bank->target;
 
        if (IS_RP2040(priv->id))
@@ -1078,7 +1078,7 @@ static int rp2xxx_spi_tx_rx(struct flash_bank *bank,
 static int rp2xxx_read_sfdp_block(struct flash_bank *bank, uint32_t addr,
                unsigned int words, uint32_t *buffer)
 {
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
 
        uint8_t cmd[4] = { SPIFLASH_READ_SFDP };
        uint8_t data[4 * words + priv->sfdp_dummy_detect];
@@ -1106,9 +1106,9 @@ static int rp2xxx_read_sfdp_block(struct flash_bank *bank, uint32_t addr,
        return retval;
 }
 
-static int rp2040_flash_probe(struct flash_bank *bank)
+static int rp2xxx_flash_probe(struct flash_bank *bank)
 {
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
        struct target *target = bank->target;
 
        int retval = target_read_u32(target, RP2XXX_SYSINFO_CHIP_ID, &priv->id);
@@ -1202,31 +1202,23 @@ static int rp2040_flash_probe(struct flash_bank *bank)
        return ERROR_OK;
 }
 
-static int rp2040_flash_auto_probe(struct flash_bank *bank)
+static int rp2xxx_flash_auto_probe(struct flash_bank *bank)
 {
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
 
        if (priv->probed)
                return ERROR_OK;
 
-       return rp2040_flash_probe(bank);
-}
-
-static void rp2040_flash_free_driver_priv(struct flash_bank *bank)
-{
-       free(bank->driver_priv);
-       bank->driver_priv = NULL;
+       return rp2xxx_flash_probe(bank);
 }
 
 /* -----------------------------------------------------------------------------
    Driver boilerplate */
 
-FLASH_BANK_COMMAND_HANDLER(rp2040_flash_bank_command)
+FLASH_BANK_COMMAND_HANDLER(rp2xxx_flash_bank_command)
 {
-       struct rp2040_flash_bank *priv;
-       priv = malloc(sizeof(struct rp2040_flash_bank));
-       memset(priv, 0, sizeof(struct rp2040_flash_bank));
-       priv->probed = false;
+       struct rp2xxx_flash_bank *priv;
+       priv = calloc(1, sizeof(struct rp2xxx_flash_bank));
        priv->size_override = bank->size != 0;
 
        /* Set up driver_priv */
@@ -1236,7 +1228,7 @@ FLASH_BANK_COMMAND_HANDLER(rp2040_flash_bank_command)
 }
 
 
-COMMAND_HANDLER(rp2040_rom_api_call_handler)
+COMMAND_HANDLER(rp2xxx_rom_api_call_handler)
 {
        if (CMD_ARGC < 1)
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -1245,7 +1237,7 @@ COMMAND_HANDLER(rp2040_rom_api_call_handler)
 
        struct flash_bank *bank;
        for (bank = flash_bank_list(); bank; bank = bank->next) {
-               if (bank->driver != &rp2040_flash)
+               if (bank->driver != &rp2xxx_flash)
                        continue;
 
                if (bank->target == target)
@@ -1258,7 +1250,7 @@ COMMAND_HANDLER(rp2040_rom_api_call_handler)
                return ERROR_FAIL;
        }
 
-       int retval = rp2040_flash_auto_probe(bank);
+       int retval = rp2xxx_flash_auto_probe(bank);
        if (retval != ERROR_OK) {
                command_print(CMD, "auto_probe failed");
                return retval;
@@ -1275,7 +1267,7 @@ COMMAND_HANDLER(rp2040_rom_api_call_handler)
                return ERROR_TARGET_NOT_HALTED;
        }
 
-       struct rp2040_flash_bank *priv = bank->driver_priv;
+       struct rp2xxx_flash_bank *priv = bank->driver_priv;
        retval = setup_for_raw_flash_cmd(target, priv);
        if (retval != ERROR_OK)
                goto cleanup_and_return;
@@ -1304,7 +1296,7 @@ cleanup_and_return:
        return retval;
 }
 
-COMMAND_HANDLER(rp2040_switch_target_handler)
+COMMAND_HANDLER(rp2xxx_switch_target_handler)
 {
        if (CMD_ARGC != 2)
                return ERROR_COMMAND_SYNTAX_ERROR;
@@ -1323,10 +1315,10 @@ COMMAND_HANDLER(rp2040_switch_target_handler)
 
        struct flash_bank *bank;
        for (bank = flash_bank_list(); bank; bank = bank->next) {
-               if (bank->driver == &rp2040_flash) {
+               if (bank->driver == &rp2xxx_flash) {
                        if (bank->target == old_target) {
                                bank->target = new_target;
-                               struct rp2040_flash_bank *priv = bank->driver_priv;
+                               struct rp2xxx_flash_bank *priv = bank->driver_priv;
                                priv->probed = false;
                                return ERROR_OK;
                        } else if (bank->target == new_target) {
@@ -1340,44 +1332,44 @@ COMMAND_HANDLER(rp2040_switch_target_handler)
        return ERROR_FAIL;
 }
 
-static const struct command_registration rp2040_exec_command_handlers[] = {
+static const struct command_registration rp2xxx_exec_command_handlers[] = {
        {
                .name = "rom_api_call",
                .mode = COMMAND_EXEC,
                .help = "arbitrary ROM API call",
                .usage = "fc [p0 [p1 [p2 [p3]]]]",
-               .handler = rp2040_rom_api_call_handler,
+               .handler = rp2xxx_rom_api_call_handler,
        },
        {
                .name = "_switch_target",
                .mode = COMMAND_EXEC,
                .help = "internal use",
                .usage = "old_target new_target",
-               .handler = rp2040_switch_target_handler,
+               .handler = rp2xxx_switch_target_handler,
        },
        COMMAND_REGISTRATION_DONE
 };
 
-static const struct command_registration rp2040_command_handler[] = {
+static const struct command_registration rp2xxx_command_handler[] = {
        {
                .name = "rp2xxx",
                .mode = COMMAND_ANY,
                .help = "rp2xxx flash controller commands",
                .usage = "",
-               .chain = rp2040_exec_command_handlers,
+               .chain = rp2xxx_exec_command_handlers,
        },
        COMMAND_REGISTRATION_DONE
 };
 
-const struct flash_driver rp2040_flash = {
-       .name = "rp2040_flash",
-       .commands = rp2040_command_handler,
-       .flash_bank_command = rp2040_flash_bank_command,
-       .erase =  rp2040_flash_erase,
-       .write = rp2040_flash_write,
+const struct flash_driver rp2xxx_flash = {
+       .name = "rp2xxx",
+       .commands = rp2xxx_command_handler,
+       .flash_bank_command = rp2xxx_flash_bank_command,
+       .erase =  rp2xxx_flash_erase,
+       .write = rp2xxx_flash_write,
        .read = default_flash_read,
-       .probe = rp2040_flash_probe,
-       .auto_probe = rp2040_flash_auto_probe,
+       .probe = rp2xxx_flash_probe,
+       .auto_probe = rp2xxx_flash_auto_probe,
        .erase_check = default_flash_blank_check,
-       .free_driver_priv = rp2040_flash_free_driver_priv
+       .free_driver_priv = default_flash_free_driver_priv
 };

diff --git a/tcl/target/rp2040.cfg b/tcl/target/rp2040.cfg
index 5e78c69310a03662909b2947dc83a8180cf2b4b0..5fae390b4131d51e9354c837c86b726a3a782c19 100644 (file)
--- a/tcl/target/rp2040.cfg
+++ b/tcl/target/rp2040.cfg
@@ -99,7 +99,7 @@ if { $_USE_CORE == 1 } {
 # The flash is probed during gdb connect if gdb memory_map is enabled (by default).
 $_FLASH_TARGET configure -work-area-phys 0x20010000 -work-area-size $_WORKAREASIZE -work-area-backup 1
 set _FLASHNAME $_CHIPNAME.flash
-flash bank $_FLASHNAME rp2040_flash 0x10000000 0 0 0 $_FLASH_TARGET
+flash bank $_FLASHNAME rp2xxx 0x10000000 0 0 0 $_FLASH_TARGET
 
 if { $_BOTH_CORES } {
        # Alias to ensure gdb connecting to core 1 gets the correct memory map

diff --git a/tcl/target/rp2350.cfg b/tcl/target/rp2350.cfg
index dc26cde1901d556baef4d2d5d04db2bde41abf18..b7617acd4c3fb47e0a3560adc1d45449901323bf 100644 (file)
--- a/tcl/target/rp2350.cfg
+++ b/tcl/target/rp2350.cfg
@@ -160,7 +160,7 @@ if { [info exists _FLASH_TARGET] } {
                echo "Info : $_CHIPNAME.flash will be handled by the active one of $_FLASH_TARGET and $_TARGETNAME_RV0 cores"
        }
        set _FLASHNAME $_CHIPNAME.flash
-       flash bank $_FLASHNAME rp2040_flash 0x10000000 $_FLASHSIZE 0 0 $_FLASH_TARGET
+       flash bank $_FLASHNAME rp2xxx 0x10000000 $_FLASHSIZE 0 0 $_FLASH_TARGET
 }
 
 if { [info exists _TARGETNAME_1] } {