git.gag.com Git - fw/openocd/blob - src/flash/nor/rp2040.c

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 #ifdef HAVE_CONFIG_H
   4 #include "config.h"
   5 #endif
   6
   7 #include "imp.h"
   8 #include <helper/binarybuffer.h>
   9 #include <target/algorithm.h>
  10 #include <target/armv7m.h>
  11 #include "spi.h"
  12
  13 /* NOTE THAT THIS CODE REQUIRES FLASH ROUTINES in BOOTROM WITH FUNCTION TABLE PTR AT 0x00000010
  14    Your gdbinit should load the bootrom.elf if appropriate */
  15
  16 /* this is 'M' 'u', 1 (version) */
  17 #define BOOTROM_MAGIC 0x01754d
  18 #define BOOTROM_MAGIC_ADDR 0x00000010
  19
  20 /* Call a ROM function via the debug trampoline
  21    Up to four arguments passed in r0...r3 as per ABI
  22    Function address is passed in r7
  23    the trampoline is needed because OpenOCD "algorithm" code insists on sw breakpoints. */
  24
  25 #define MAKE_TAG(a, b) (((b)<<8) | a)
  26 #define FUNC_DEBUG_TRAMPOLINE       MAKE_TAG('D', 'T')
  27 #define FUNC_DEBUG_TRAMPOLINE_END   MAKE_TAG('D', 'E')
  28 #define FUNC_FLASH_EXIT_XIP         MAKE_TAG('E', 'X')
  29 #define FUNC_CONNECT_INTERNAL_FLASH MAKE_TAG('I', 'F')
  30 #define FUNC_FLASH_RANGE_ERASE      MAKE_TAG('R', 'E')
  31 #define FUNC_FLASH_RANGE_PROGRAM    MAKE_TAG('R', 'P')
  32 #define FUNC_FLASH_FLUSH_CACHE      MAKE_TAG('F', 'C')
  33 #define FUNC_FLASH_ENTER_CMD_XIP    MAKE_TAG('C', 'X')
  34
  35 struct rp2040_flash_bank {
  36         /* flag indicating successful flash probe */
  37         bool probed;
  38         /* stack used by Boot ROM calls */
  39         struct working_area *stack;
  40         /* function jump table populated by rp2040_flash_probe() */
  41         uint16_t jump_debug_trampoline;
  42         uint16_t jump_debug_trampoline_end;
  43         uint16_t jump_flash_exit_xip;
  44         uint16_t jump_connect_internal_flash;
  45         uint16_t jump_flash_range_erase;
  46         uint16_t jump_flash_range_program;
  47         uint16_t jump_flush_cache;
  48         uint16_t jump_enter_cmd_xip;
  49         /* detected model of SPI flash */
  50         const struct flash_device *dev;
  51 };
  52
  53 static uint32_t rp2040_lookup_symbol(struct target *target, uint32_t tag, uint16_t *symbol)
  54 {
  55         uint32_t magic;
  56         int err = target_read_u32(target, BOOTROM_MAGIC_ADDR, &magic);
  57         if (err != ERROR_OK)
  58                 return err;
  59
  60         magic &= 0xffffff; /* ignore bootrom version */
  61         if (magic != BOOTROM_MAGIC) {
  62                 if (!((magic ^ BOOTROM_MAGIC)&0xffff))
  63                         LOG_ERROR("Incorrect RP2040 BOOT ROM version");
  64                 else
  65                         LOG_ERROR("RP2040 BOOT ROM not found");
  66                 return ERROR_FAIL;
  67         }
  68
  69         /* dereference the table pointer */
  70         uint16_t table_entry;
  71         err = target_read_u16(target, BOOTROM_MAGIC_ADDR + 4, &table_entry);
  72         if (err != ERROR_OK)
  73                 return err;
  74
  75         uint16_t entry_tag;
  76         do {
  77                 err = target_read_u16(target, table_entry, &entry_tag);
  78                 if (err != ERROR_OK)
  79                         return err;
  80                 if (entry_tag == tag) {
  81                         /* 16 bit symbol is next */
  82                         return target_read_u16(target, table_entry + 2, symbol);
  83                 }
  84                 table_entry += 4;
  85         } while (entry_tag);
  86         return ERROR_FAIL;
  87 }
  88
  89 static int rp2040_call_rom_func(struct target *target, struct rp2040_flash_bank *priv,
  90                 uint16_t func_offset, uint32_t argdata[], unsigned int n_args)
  91 {
  92         char *regnames[4] = { "r0", "r1", "r2", "r3" };
  93
  94         assert(n_args <= ARRAY_SIZE(regnames)); /* only allow register arguments */
  95
  96         if (!priv->stack) {
  97                 LOG_ERROR("no stack for flash programming code");
  98                 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
  99         }
 100         target_addr_t stacktop = priv->stack->address + priv->stack->size;
 101
 102         LOG_DEBUG("Calling ROM func @0x%" PRIx16 " with %d arguments", func_offset, n_args);
 103         LOG_DEBUG("Calling on core \"%s\"", target->cmd_name);
 104
 105         struct reg_param args[ARRAY_SIZE(regnames) + 2];
 106         struct armv7m_algorithm alg_info;
 107
 108         for (unsigned int i = 0; i < n_args; ++i) {
 109                 init_reg_param(&args[i], regnames[i], 32, PARAM_OUT);
 110                 buf_set_u32(args[i].value, 0, 32, argdata[i]);
 111         }
 112         /* Pass function pointer in r7 */
 113         init_reg_param(&args[n_args], "r7", 32, PARAM_OUT);
 114         buf_set_u32(args[n_args].value, 0, 32, func_offset);
 115         init_reg_param(&args[n_args + 1], "sp", 32, PARAM_OUT);
 116         buf_set_u32(args[n_args + 1].value, 0, 32, stacktop);
 117
 118
 119         for (unsigned int i = 0; i < n_args + 2; ++i)
 120                 LOG_DEBUG("Set %s = 0x%" PRIx32, args[i].reg_name, buf_get_u32(args[i].value, 0, 32));
 121
 122         /* Actually call the function */
 123         alg_info.common_magic = ARMV7M_COMMON_MAGIC;
 124         alg_info.core_mode = ARM_MODE_THREAD;
 125         int err = target_run_algorithm(
 126                 target,
 127                 0, NULL,          /* No memory arguments */
 128                 n_args + 1, args, /* User arguments + r7 */
 129                 priv->jump_debug_trampoline, priv->jump_debug_trampoline_end,
 130                 3000, /* 3s timeout */
 131                 &alg_info
 132         );
 133         for (unsigned int i = 0; i < n_args + 2; ++i)
 134                 destroy_reg_param(&args[i]);
 135         if (err != ERROR_OK)
 136                 LOG_ERROR("Failed to invoke ROM function @0x%" PRIx16 "\n", func_offset);
 137         return err;
 138
 139 }
 140
 141 /* Finalize flash write/erase/read ID
 142  * - flush cache
 143  * - enters memory-mapped (XIP) mode to make flash data visible
 144  * - deallocates target ROM func stack if previously allocated
 145  */
 146 static int rp2040_finalize_stack_free(struct flash_bank *bank)
 147 {
 148         struct rp2040_flash_bank *priv = bank->driver_priv;
 149         struct target *target = bank->target;
 150
 151         /* Always flush before returning to execute-in-place, to invalidate stale
 152          * cache contents. The flush call also restores regular hardware-controlled
 153          * chip select following a rp2040_flash_exit_xip().
 154          */
 155         LOG_DEBUG("Flushing flash cache after write behind");
 156         int err = rp2040_call_rom_func(target, priv, priv->jump_flush_cache, NULL, 0);
 157         if (err != ERROR_OK) {
 158                 LOG_ERROR("Failed to flush flash cache");
 159                 /* Intentionally continue after error and try to setup xip anyway */
 160         }
 161
 162         LOG_DEBUG("Configuring SSI for execute-in-place");
 163         err = rp2040_call_rom_func(target, priv, priv->jump_enter_cmd_xip, NULL, 0);
 164         if (err != ERROR_OK)
 165                 LOG_ERROR("Failed to set SSI to XIP mode");
 166
 167         target_free_working_area(target, priv->stack);
 168         priv->stack = NULL;
 169         return err;
 170 }
 171
 172 /* Prepare flash write/erase/read ID
 173  * - allocates a stack for target ROM func
 174  * - switches the SPI interface from memory-mapped mode to direct command mode
 175  * Always pair with a call of rp2040_finalize_stack_free()
 176  * after flash operation finishes or fails.
 177  */
 178 static int rp2040_stack_grab_and_prep(struct flash_bank *bank)
 179 {
 180         struct rp2040_flash_bank *priv = bank->driver_priv;
 181         struct target *target = bank->target;
 182
 183         /* target_alloc_working_area always allocates multiples of 4 bytes, so no worry about alignment */
 184         const int STACK_SIZE = 256;
 185         int err = target_alloc_working_area(target, STACK_SIZE, &priv->stack);
 186         if (err != ERROR_OK) {
 187                 LOG_ERROR("Could not allocate stack for flash programming code");
 188                 return ERROR_TARGET_RESOURCE_NOT_AVAILABLE;
 189         }
 190
 191         LOG_DEBUG("Connecting internal flash");
 192         err = rp2040_call_rom_func(target, priv, priv->jump_connect_internal_flash, NULL, 0);
 193         if (err != ERROR_OK) {
 194                 LOG_ERROR("Failed to connect internal flash");
 195                 return err;
 196         }
 197
 198         LOG_DEBUG("Kicking flash out of XIP mode");
 199         err = rp2040_call_rom_func(target, priv, priv->jump_flash_exit_xip, NULL, 0);
 200         if (err != ERROR_OK) {
 201                 LOG_ERROR("Failed to exit flash XIP mode");
 202                 return err;
 203         }
 204
 205         return ERROR_OK;
 206 }
 207
 208 static int rp2040_flash_write(struct flash_bank *bank, const uint8_t *buffer, uint32_t offset, uint32_t count)
 209 {
 210         LOG_DEBUG("Writing %d bytes starting at 0x%" PRIx32, count, offset);
 211
 212         struct rp2040_flash_bank *priv = bank->driver_priv;
 213         struct target *target = bank->target;
 214         struct working_area *bounce = NULL;
 215
 216         int err = rp2040_stack_grab_and_prep(bank);
 217         if (err != ERROR_OK)
 218                 goto cleanup;
 219
 220         unsigned int avail_pages = target_get_working_area_avail(target) / priv->dev->pagesize;
 221         /* We try to allocate working area rounded down to device page size,
 222          * al least 1 page, at most the write data size
 223          */
 224         unsigned int chunk_size = MIN(MAX(avail_pages, 1) * priv->dev->pagesize, count);
 225         err = target_alloc_working_area(target, chunk_size, &bounce);
 226         if (err != ERROR_OK) {
 227                 LOG_ERROR("Could not allocate bounce buffer for flash programming. Can't continue");
 228                 goto cleanup;
 229         }
 230
 231         LOG_DEBUG("Allocated flash bounce buffer @" TARGET_ADDR_FMT, bounce->address);
 232
 233         while (count > 0) {
 234                 uint32_t write_size = count > chunk_size ? chunk_size : count;
 235                 LOG_DEBUG("Writing %d bytes to offset 0x%" PRIx32, write_size, offset);
 236                 err = target_write_buffer(target, bounce->address, write_size, buffer);
 237                 if (err != ERROR_OK) {
 238                         LOG_ERROR("Could not load data into target bounce buffer");
 239                         break;
 240                 }
 241                 uint32_t args[3] = {
 242                         offset, /* addr */
 243                         bounce->address, /* data */
 244                         write_size /* count */
 245                 };
 246                 err = rp2040_call_rom_func(target, priv, priv->jump_flash_range_program, args, ARRAY_SIZE(args));
 247                 if (err != ERROR_OK) {
 248                         LOG_ERROR("Failed to invoke flash programming code on target");
 249                         break;
 250                 }
 251
 252                 buffer += write_size;
 253                 offset += write_size;
 254                 count -= write_size;
 255         }
 256
 257 cleanup:
 258         target_free_working_area(target, bounce);
 259
 260         rp2040_finalize_stack_free(bank);
 261
 262         return err;
 263 }
 264
 265 static int rp2040_flash_erase(struct flash_bank *bank, unsigned int first, unsigned int last)
 266 {
 267         struct rp2040_flash_bank *priv = bank->driver_priv;
 268         uint32_t start_addr = bank->sectors[first].offset;
 269         uint32_t length = bank->sectors[last].offset + bank->sectors[last].size - start_addr;
 270         LOG_DEBUG("RP2040 erase %d bytes starting at 0x%" PRIx32, length, start_addr);
 271
 272         int err = rp2040_stack_grab_and_prep(bank);
 273         if (err != ERROR_OK)
 274                 goto cleanup;
 275
 276         LOG_DEBUG("Remote call flash_range_erase");
 277
 278         uint32_t args[4] = {
 279                 bank->sectors[first].offset, /* addr */
 280                 bank->sectors[last].offset + bank->sectors[last].size - bank->sectors[first].offset, /* count */
 281                 priv->dev->sectorsize, /* block_size */
 282                 priv->dev->erase_cmd /* block_cmd */
 283         };
 284
 285         /*
 286         The RP2040 Boot ROM provides a _flash_range_erase() API call documented in Section 2.8.3.1.3:
 287         https://datasheets.raspberrypi.org/rp2040/rp2040-datasheet.pdf
 288         and the particular source code for said Boot ROM function can be found here:
 289         https://github.com/raspberrypi/pico-bootrom/blob/master/bootrom/program_flash_generic.c
 290
 291         In theory, the function algorithm provides for erasing both a smaller "sector" (4096 bytes) and
 292         an optional larger "block" (size and command provided in args).
 293         */
 294
 295         err = rp2040_call_rom_func(bank->target, priv, priv->jump_flash_range_erase, args, ARRAY_SIZE(args));
 296
 297 cleanup:
 298         rp2040_finalize_stack_free(bank);
 299
 300         return err;
 301 }
 302
 303 /* -----------------------------------------------------------------------------
 304    Driver probing etc */
 305
 306 static int rp2040_ssel_active(struct target *target, bool active)
 307 {
 308         const target_addr_t qspi_ctrl_addr = 0x4001800c;
 309         const uint32_t qspi_ctrl_outover_low  = 2UL << 8;
 310         const uint32_t qspi_ctrl_outover_high = 3UL << 8;
 311         uint32_t state = (active) ? qspi_ctrl_outover_low : qspi_ctrl_outover_high;
 312         uint32_t val;
 313
 314         int err = target_read_u32(target, qspi_ctrl_addr, &val);
 315         if (err != ERROR_OK)
 316                 return err;
 317
 318         val = (val & ~qspi_ctrl_outover_high) | state;
 319
 320         err = target_write_u32(target, qspi_ctrl_addr, val);
 321         if (err != ERROR_OK)
 322                 return err;
 323
 324         return ERROR_OK;
 325 }
 326
 327 static int rp2040_spi_read_flash_id(struct target *target, uint32_t *devid)
 328 {
 329         uint32_t device_id = 0;
 330         const target_addr_t ssi_dr0 = 0x18000060;
 331
 332         int err = rp2040_ssel_active(target, true);
 333
 334         /* write RDID request into SPI peripheral's FIFO */
 335         for (int count = 0; (count < 4) && (err == ERROR_OK); count++)
 336                 err = target_write_u32(target, ssi_dr0, SPIFLASH_READ_ID);
 337
 338         /* by this time, there is a receive FIFO entry for every write */
 339         for (int count = 0; (count < 4) && (err == ERROR_OK); count++) {
 340                 uint32_t status;
 341                 err = target_read_u32(target, ssi_dr0, &status);
 342
 343                 device_id >>= 8;
 344                 device_id |= (status & 0xFF) << 24;
 345         }
 346
 347         if (err == ERROR_OK)
 348                 *devid = device_id >> 8;
 349
 350         int err2 = rp2040_ssel_active(target, false);
 351         if (err2 != ERROR_OK)
 352                 LOG_ERROR("SSEL inactive failed");
 353
 354         return err;
 355 }
 356
 357 static int rp2040_flash_probe(struct flash_bank *bank)
 358 {
 359         struct rp2040_flash_bank *priv = bank->driver_priv;
 360         struct target *target = bank->target;
 361
 362         int err = rp2040_lookup_symbol(target, FUNC_DEBUG_TRAMPOLINE, &priv->jump_debug_trampoline);
 363         if (err != ERROR_OK) {
 364                 LOG_ERROR("Debug trampoline not found in RP2040 ROM.");
 365                 return err;
 366         }
 367         priv->jump_debug_trampoline &= ~1u; /* mask off thumb bit */
 368
 369         err = rp2040_lookup_symbol(target, FUNC_DEBUG_TRAMPOLINE_END, &priv->jump_debug_trampoline_end);
 370         if (err != ERROR_OK) {
 371                 LOG_ERROR("Debug trampoline end not found in RP2040 ROM.");
 372                 return err;
 373         }
 374         priv->jump_debug_trampoline_end &= ~1u; /* mask off thumb bit */
 375
 376         err = rp2040_lookup_symbol(target, FUNC_FLASH_EXIT_XIP, &priv->jump_flash_exit_xip);
 377         if (err != ERROR_OK) {
 378                 LOG_ERROR("Function FUNC_FLASH_EXIT_XIP not found in RP2040 ROM.");
 379                 return err;
 380         }
 381
 382         err = rp2040_lookup_symbol(target, FUNC_CONNECT_INTERNAL_FLASH, &priv->jump_connect_internal_flash);
 383         if (err != ERROR_OK) {
 384                 LOG_ERROR("Function FUNC_CONNECT_INTERNAL_FLASH not found in RP2040 ROM.");
 385                 return err;
 386         }
 387
 388         err = rp2040_lookup_symbol(target, FUNC_FLASH_RANGE_ERASE, &priv->jump_flash_range_erase);
 389         if (err != ERROR_OK) {
 390                 LOG_ERROR("Function FUNC_FLASH_RANGE_ERASE not found in RP2040 ROM.");
 391                 return err;
 392         }
 393
 394         err = rp2040_lookup_symbol(target, FUNC_FLASH_RANGE_PROGRAM, &priv->jump_flash_range_program);
 395         if (err != ERROR_OK) {
 396                 LOG_ERROR("Function FUNC_FLASH_RANGE_PROGRAM not found in RP2040 ROM.");
 397                 return err;
 398         }
 399
 400         err = rp2040_lookup_symbol(target, FUNC_FLASH_FLUSH_CACHE, &priv->jump_flush_cache);
 401         if (err != ERROR_OK) {
 402                 LOG_ERROR("Function FUNC_FLASH_FLUSH_CACHE not found in RP2040 ROM.");
 403                 return err;
 404         }
 405
 406         err = rp2040_lookup_symbol(target, FUNC_FLASH_ENTER_CMD_XIP, &priv->jump_enter_cmd_xip);
 407         if (err != ERROR_OK) {
 408                 LOG_ERROR("Function FUNC_FLASH_ENTER_CMD_XIP not found in RP2040 ROM.");
 409                 return err;
 410         }
 411
 412         err = rp2040_stack_grab_and_prep(bank);
 413
 414         uint32_t device_id = 0;
 415         if (err == ERROR_OK)
 416                 err = rp2040_spi_read_flash_id(target, &device_id);
 417
 418         rp2040_finalize_stack_free(bank);
 419
 420         if (err != ERROR_OK)
 421                 return err;
 422
 423         /* search for a SPI flash Device ID match */
 424         priv->dev = NULL;
 425         for (const struct flash_device *p = flash_devices; p->name ; p++)
 426                 if (p->device_id == device_id) {
 427                         priv->dev = p;
 428                         break;
 429                 }
 430
 431         if (!priv->dev) {
 432                 LOG_ERROR("Unknown flash device (ID 0x%08" PRIx32 ")", device_id);
 433                 return ERROR_FAIL;
 434         }
 435
 436         LOG_INFO("Found flash device \'%s\' (ID 0x%08" PRIx32 ")",
 437                 priv->dev->name, priv->dev->device_id);
 438
 439         /* the Boot ROM flash_range_program() routine requires page alignment */
 440         bank->write_start_alignment = priv->dev->pagesize;
 441         bank->write_end_alignment = priv->dev->pagesize;
 442
 443         bank->size = priv->dev->size_in_bytes;
 444
 445         bank->num_sectors = bank->size / priv->dev->sectorsize;
 446         LOG_INFO("RP2040 B0 Flash Probe: %d bytes @" TARGET_ADDR_FMT ", in %d sectors\n",
 447                 bank->size, bank->base, bank->num_sectors);
 448         bank->sectors = alloc_block_array(0, priv->dev->sectorsize, bank->num_sectors);
 449         if (!bank->sectors)
 450                 return ERROR_FAIL;
 451
 452         if (err == ERROR_OK)
 453                 priv->probed = true;
 454
 455         return err;
 456 }
 457
 458 static int rp2040_flash_auto_probe(struct flash_bank *bank)
 459 {
 460         struct rp2040_flash_bank *priv = bank->driver_priv;
 461
 462         if (priv->probed)
 463                 return ERROR_OK;
 464
 465         return rp2040_flash_probe(bank);
 466 }
 467
 468 static void rp2040_flash_free_driver_priv(struct flash_bank *bank)
 469 {
 470         free(bank->driver_priv);
 471         bank->driver_priv = NULL;
 472 }
 473
 474 /* -----------------------------------------------------------------------------
 475    Driver boilerplate */
 476
 477 FLASH_BANK_COMMAND_HANDLER(rp2040_flash_bank_command)
 478 {
 479         struct rp2040_flash_bank *priv;
 480         priv = malloc(sizeof(struct rp2040_flash_bank));
 481         priv->probed = false;
 482
 483         /* Set up driver_priv */
 484         bank->driver_priv = priv;
 485
 486         return ERROR_OK;
 487 }
 488
 489 struct flash_driver rp2040_flash = {
 490         .name = "rp2040_flash",
 491         .flash_bank_command = rp2040_flash_bank_command,
 492         .erase =  rp2040_flash_erase,
 493         .write = rp2040_flash_write,
 494         .read = default_flash_read,
 495         .probe = rp2040_flash_probe,
 496         .auto_probe = rp2040_flash_auto_probe,
 497         .erase_check = default_flash_blank_check,
 498         .free_driver_priv = rp2040_flash_free_driver_priv
 499 };