/* * This file is part of the Black Magic Debug project. * * Copyright (C) 2014 Mike Walters * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ /* This file implements nRF51 target specific functions for detecting * the device, providing the XML memory map and Flash memory programming. */ #include "general.h" #include "adiv5.h" #include "target.h" #include "command.h" #include "gdb_packet.h" #include "cortexm.h" static int nrf51_flash_erase(struct target_flash *f, uint32_t addr, size_t len); static int nrf51_flash_write(struct target_flash *f, uint32_t dest, const void *src, size_t len); static bool nrf51_cmd_erase_all(target *t); static bool nrf51_cmd_read_hwid(target *t); static bool nrf51_cmd_read_fwid(target *t); static bool nrf51_cmd_read_deviceid(target *t); static bool nrf51_cmd_read_deviceaddr(target *t); static bool nrf51_cmd_read_help(); static bool nrf51_cmd_read(target *t, int argc, const char *argv[]); const struct command_s nrf51_cmd_list[] = { {"erase_mass", (cmd_handler)nrf51_cmd_erase_all, "Erase entire flash memory"}, {"read", (cmd_handler)nrf51_cmd_read, "Read device parameters"}, {NULL, NULL, NULL} }; const struct command_s nrf51_read_cmd_list[] = { {"help", (cmd_handler)nrf51_cmd_read_help, "Display help for read commands"}, {"hwid", (cmd_handler)nrf51_cmd_read_hwid, "Read hardware identification number"}, {"fwid", (cmd_handler)nrf51_cmd_read_fwid, "Read pre-loaded firmware ID"}, {"deviceid", (cmd_handler)nrf51_cmd_read_deviceid, "Read unique device ID"}, {"deviceaddr", (cmd_handler)nrf51_cmd_read_deviceaddr, "Read device address"}, {NULL, NULL, NULL} }; /* Non-Volatile Memory Controller (NVMC) Registers */ #define NRF51_NVMC 0x4001E000 #define NRF51_NVMC_READY (NRF51_NVMC + 0x400) #define NRF51_NVMC_CONFIG (NRF51_NVMC + 0x504) #define NRF51_NVMC_ERASEPAGE (NRF51_NVMC + 0x508) #define NRF51_NVMC_ERASEALL (NRF51_NVMC + 0x50C) #define NRF51_NVMC_ERASEUICR (NRF51_NVMC + 0x514) #define NRF51_NVMC_CONFIG_REN 0x0 // Read only access #define NRF51_NVMC_CONFIG_WEN 0x1 // Write enable #define NRF51_NVMC_CONFIG_EEN 0x2 // Erase enable /* Factory Information Configuration Registers (FICR) */ #define NRF51_FICR 0x10000000 #define NRF51_FICR_CODEPAGESIZE (NRF51_FICR + 0x010) #define NRF51_FICR_CODESIZE (NRF51_FICR + 0x014) #define NRF51_FICR_CONFIGID (NRF51_FICR + 0x05C) #define NRF51_FICR_DEVICEID_LOW (NRF51_FICR + 0x060) #define NRF51_FICR_DEVICEID_HIGH (NRF51_FICR + 0x064) #define NRF51_FICR_DEVICEADDRTYPE (NRF51_FICR + 0x0A0) #define NRF51_FICR_DEVICEADDR_LOW (NRF51_FICR + 0x0A4) #define NRF51_FICR_DEVICEADDR_HIGH (NRF51_FICR + 0x0A8) /* User Information Configuration Registers (UICR) */ #define NRF51_UICR 0x10001000 #define NRF51_PAGE_SIZE 1024 #define SRAM_BASE 0x20000000 #define STUB_BUFFER_BASE (SRAM_BASE + 0x28) static const uint16_t nrf51_flash_write_stub[] = { #include "../flashstub/nrf51.stub" }; static void nrf51_add_flash(target *t, uint32_t addr, size_t length, size_t erasesize) { struct target_flash *f = calloc(1, sizeof(*f)); f->start = addr; f->length = length; f->blocksize = erasesize; f->erase = nrf51_flash_erase; f->write = nrf51_flash_write; f->align = 4; f->erased = 0xff; target_add_flash(t, f); } bool nrf51_probe(target *t) { t->idcode = target_mem_read32(t, NRF51_FICR_CONFIGID) & 0xFFFF; switch (t->idcode) { case 0x001D: case 0x002A: case 0x0044: case 0x003C: case 0x0020: case 0x002F: case 0x0040: case 0x0047: case 0x004D: case 0x0026: case 0x004C: t->driver = "Nordic nRF51"; target_add_ram(t, 0x20000000, 0x4000); nrf51_add_flash(t, 0x00000000, 0x40000, NRF51_PAGE_SIZE); nrf51_add_flash(t, NRF51_UICR, 0x100, 0x100); target_add_commands(t, nrf51_cmd_list, "nRF51"); return true; } return false; } static int nrf51_flash_erase(struct target_flash *f, uint32_t addr, size_t len) { target *t = f->t; /* Enable erase */ target_mem_write32(t, NRF51_NVMC_CONFIG, NRF51_NVMC_CONFIG_EEN); /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return -1; while (len) { if (addr == NRF51_UICR) { // Special Case /* Write to the ERASE_UICR register to erase */ target_mem_write32(t, NRF51_NVMC_ERASEUICR, 0x1); } else { // Standard Flash Page /* Write address of first word in page to erase it */ target_mem_write32(t, NRF51_NVMC_ERASEPAGE, addr); } /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return -1; addr += f->blocksize; len -= f->blocksize; } /* Return to read-only */ target_mem_write32(t, NRF51_NVMC_CONFIG, NRF51_NVMC_CONFIG_REN); /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return -1; return 0; } static int nrf51_flash_write(struct target_flash *f, uint32_t dest, const void *src, size_t len) { target *t = f->t; uint32_t data[2 + len/4]; /* FIXME rewrite stub to use register args */ /* Construct data buffer used by stub */ data[0] = dest; data[1] = len; /* length must always be a multiple of 4 */ memcpy((uint8_t *)&data[2], src, len); /* Enable write */ target_mem_write32(t, NRF51_NVMC_CONFIG, NRF51_NVMC_CONFIG_WEN); /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return -1; /* Write stub and data to target ram and call stub */ target_mem_write(t, SRAM_BASE, nrf51_flash_write_stub, sizeof(nrf51_flash_write_stub)); target_mem_write(t, STUB_BUFFER_BASE, data, len + 8); cortexm_run_stub(t, SRAM_BASE, 0, 0, 0, 0); /* Return to read-only */ target_mem_write32(t, NRF51_NVMC_CONFIG, NRF51_NVMC_CONFIG_REN); return 0; } static bool nrf51_cmd_erase_all(target *t) { gdb_out("erase..\n"); /* Enable erase */ target_mem_write32(t, NRF51_NVMC_CONFIG, NRF51_NVMC_CONFIG_EEN); /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return false; /* Erase all */ target_mem_write32(t, NRF51_NVMC_ERASEALL, 1); /* Poll for NVMC_READY */ while (target_mem_read32(t, NRF51_NVMC_READY) == 0) if(target_check_error(t)) return false; return true; } static bool nrf51_cmd_read_hwid(target *t) { uint32_t hwid = target_mem_read32(t, NRF51_FICR_CONFIGID) & 0xFFFF; gdb_outf("Hardware ID: 0x%04X\n", hwid); return true; } static bool nrf51_cmd_read_fwid(target *t) { uint32_t fwid = (target_mem_read32(t, NRF51_FICR_CONFIGID) >> 16) & 0xFFFF; gdb_outf("Firmware ID: 0x%04X\n", fwid); return true; } static bool nrf51_cmd_read_deviceid(target *t) { uint32_t deviceid_low = target_mem_read32(t, NRF51_FICR_DEVICEID_LOW); uint32_t deviceid_high = target_mem_read32(t, NRF51_FICR_DEVICEID_HIGH); gdb_outf("Device ID: 0x%08X%08X\n", deviceid_high, deviceid_low); return true; } static bool nrf51_cmd_read_deviceaddr(target *t) { uint32_t addr_type = target_mem_read32(t, NRF51_FICR_DEVICEADDRTYPE); uint32_t addr_low = target_mem_read32(t, NRF51_FICR_DEVICEADDR_LOW); uint32_t addr_high = target_mem_read32(t, NRF51_FICR_DEVICEADDR_HIGH) & 0xFFFF; if ((addr_type & 1) == 0) { gdb_outf("Publicly Listed Address: 0x%04X%08X\n", addr_high, addr_low); } else { gdb_outf("Randomly Assigned Address: 0x%04X%08X\n", addr_high, addr_low); } return true; } static bool nrf51_cmd_read_help() { const struct command_s *c; gdb_out("Read commands:\n"); for(c = nrf51_read_cmd_list; c->cmd; c++) gdb_outf("\t%s -- %s\n", c->cmd, c->help); return true; } static bool nrf51_cmd_read(target *t, int argc, const char *argv[]) { const struct command_s *c; for(c = nrf51_read_cmd_list; c->cmd; c++) { /* Accept a partial match as GDB does. * So 'mon ver' will match 'monitor version' */ if(!strncmp(argv[1], c->cmd, strlen(argv[1]))) return !c->handler(t, argc - 1, &argv[1]); } return nrf51_cmd_read_help(t); }