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

   1 // SPDX-License-Identifier: GPL-2.0-or-later
   2
   3 /***************************************************************************
   4  *   Copyright (C) 2013 by Andrey Yurovsky                                 *
   5  *   Andrey Yurovsky <yurovsky@gmail.com>                                  *
   6  ***************************************************************************/
   7
   8 #ifdef HAVE_CONFIG_H
   9 #include "config.h"
  10 #endif
  11
  12 #include "imp.h"
  13 #include "helper/binarybuffer.h"
  14
  15 #include <jtag/jtag.h>
  16 #include <target/cortex_m.h>
  17
  18 #define SAMD_NUM_PROT_BLOCKS    16
  19 #define SAMD_PAGE_SIZE_MAX      1024
  20
  21 #define SAMD_FLASH                      ((uint32_t)0x00000000)  /* physical Flash memory */
  22 #define SAMD_USER_ROW           ((uint32_t)0x00804000)  /* User Row of Flash */
  23 #define SAMD_PAC1                       0x41000000      /* Peripheral Access Control 1 */
  24 #define SAMD_DSU                        0x41002000      /* Device Service Unit */
  25 #define SAMD_NVMCTRL            0x41004000      /* Non-volatile memory controller */
  26
  27 #define SAMD_DSU_STATUSA        1               /* DSU status register */
  28 #define SAMD_DSU_DID            0x18            /* Device ID register */
  29 #define SAMD_DSU_CTRL_EXT       0x100           /* CTRL register, external access */
  30
  31 #define SAMD_NVMCTRL_CTRLA              0x00    /* NVM control A register */
  32 #define SAMD_NVMCTRL_CTRLB              0x04    /* NVM control B register */
  33 #define SAMD_NVMCTRL_PARAM              0x08    /* NVM parameters register */
  34 #define SAMD_NVMCTRL_INTFLAG    0x18    /* NVM Interrupt Flag Status & Clear */
  35 #define SAMD_NVMCTRL_STATUS             0x18    /* NVM status register */
  36 #define SAMD_NVMCTRL_ADDR               0x1C    /* NVM address register */
  37 #define SAMD_NVMCTRL_LOCK               0x20    /* NVM Lock section register */
  38
  39 #define SAMD_CMDEX_KEY          0xA5UL
  40 #define SAMD_NVM_CMD(n)         ((SAMD_CMDEX_KEY << 8) | (n & 0x7F))
  41
  42 /* NVMCTRL commands.  See Table 20-4 in 42129F–SAM–10/2013 */
  43 #define SAMD_NVM_CMD_ER         0x02            /* Erase Row */
  44 #define SAMD_NVM_CMD_WP         0x04            /* Write Page */
  45 #define SAMD_NVM_CMD_EAR        0x05            /* Erase Auxiliary Row */
  46 #define SAMD_NVM_CMD_WAP        0x06            /* Write Auxiliary Page */
  47 #define SAMD_NVM_CMD_LR         0x40            /* Lock Region */
  48 #define SAMD_NVM_CMD_UR         0x41            /* Unlock Region */
  49 #define SAMD_NVM_CMD_SPRM       0x42            /* Set Power Reduction Mode */
  50 #define SAMD_NVM_CMD_CPRM       0x43            /* Clear Power Reduction Mode */
  51 #define SAMD_NVM_CMD_PBC        0x44            /* Page Buffer Clear */
  52 #define SAMD_NVM_CMD_SSB        0x45            /* Set Security Bit */
  53 #define SAMD_NVM_CMD_INVALL     0x46            /* Invalidate all caches */
  54
  55 /* NVMCTRL bits */
  56 #define SAMD_NVM_CTRLB_MANW 0x80
  57
  58 /* Known identifiers */
  59 #define SAMD_PROCESSOR_M0       0x01
  60 #define SAMD_FAMILY_D           0x00
  61 #define SAMD_FAMILY_L           0x01
  62 #define SAMD_FAMILY_C           0x02
  63 #define SAMD_SERIES_20          0x00
  64 #define SAMD_SERIES_21          0x01
  65 #define SAMD_SERIES_22          0x02
  66 #define SAMD_SERIES_10          0x02
  67 #define SAMD_SERIES_11          0x03
  68 #define SAMD_SERIES_09          0x04
  69
  70 /* Device ID macros */
  71 #define SAMD_GET_PROCESSOR(id) (id >> 28)
  72 #define SAMD_GET_FAMILY(id) (((id >> 23) & 0x1F))
  73 #define SAMD_GET_SERIES(id) (((id >> 16) & 0x3F))
  74 #define SAMD_GET_DEVSEL(id) (id & 0xFF)
  75
  76 /* Bits to mask out lockbits in user row */
  77 #define NVMUSERROW_LOCKBIT_MASK ((uint64_t)0x0000FFFFFFFFFFFF)
  78
  79 struct samd_part {
  80         uint8_t id;
  81         const char *name;
  82         uint32_t flash_kb;
  83         uint32_t ram_kb;
  84 };
  85
  86 /* Known SAMD09 parts. DID reset values missing in RM, see
  87  * https://github.com/avrxml/asf/blob/master/sam0/utils/cmsis/samd09/include/ */
  88 static const struct samd_part samd09_parts[] = {
  89         { 0x0, "SAMD09D14A", 16, 4 },
  90         { 0x7, "SAMD09C13A", 8, 4 },
  91 };
  92
  93 /* Known SAMD10 parts */
  94 static const struct samd_part samd10_parts[] = {
  95         { 0x0, "SAMD10D14AMU", 16, 4 },
  96         { 0x1, "SAMD10D13AMU", 8, 4 },
  97         { 0x2, "SAMD10D12AMU", 4, 4 },
  98         { 0x3, "SAMD10D14ASU", 16, 4 },
  99         { 0x4, "SAMD10D13ASU", 8, 4 },
 100         { 0x5, "SAMD10D12ASU", 4, 4 },
 101         { 0x6, "SAMD10C14A", 16, 4 },
 102         { 0x7, "SAMD10C13A", 8, 4 },
 103         { 0x8, "SAMD10C12A", 4, 4 },
 104 };
 105
 106 /* Known SAMD11 parts */
 107 static const struct samd_part samd11_parts[] = {
 108         { 0x0, "SAMD11D14AM", 16, 4 },
 109         { 0x1, "SAMD11D13AMU", 8, 4 },
 110         { 0x2, "SAMD11D12AMU", 4, 4 },
 111         { 0x3, "SAMD11D14ASS", 16, 4 },
 112         { 0x4, "SAMD11D13ASU", 8, 4 },
 113         { 0x5, "SAMD11D12ASU", 4, 4 },
 114         { 0x6, "SAMD11C14A", 16, 4 },
 115         { 0x7, "SAMD11C13A", 8, 4 },
 116         { 0x8, "SAMD11C12A", 4, 4 },
 117         { 0x9, "SAMD11D14AU", 16, 4 },
 118 };
 119
 120 /* Known SAMD20 parts. See Table 12-8 in 42129F–SAM–10/2013 */
 121 static const struct samd_part samd20_parts[] = {
 122         { 0x0, "SAMD20J18A", 256, 32 },
 123         { 0x1, "SAMD20J17A", 128, 16 },
 124         { 0x2, "SAMD20J16A", 64, 8 },
 125         { 0x3, "SAMD20J15A", 32, 4 },
 126         { 0x4, "SAMD20J14A", 16, 2 },
 127         { 0x5, "SAMD20G18A", 256, 32 },
 128         { 0x6, "SAMD20G17A", 128, 16 },
 129         { 0x7, "SAMD20G16A", 64, 8 },
 130         { 0x8, "SAMD20G15A", 32, 4 },
 131         { 0x9, "SAMD20G14A", 16, 2 },
 132         { 0xA, "SAMD20E18A", 256, 32 },
 133         { 0xB, "SAMD20E17A", 128, 16 },
 134         { 0xC, "SAMD20E16A", 64, 8 },
 135         { 0xD, "SAMD20E15A", 32, 4 },
 136         { 0xE, "SAMD20E14A", 16, 2 },
 137 };
 138
 139 /* Known SAMD21 parts. */
 140 static const struct samd_part samd21_parts[] = {
 141         { 0x0, "SAMD21J18A", 256, 32 },
 142         { 0x1, "SAMD21J17A", 128, 16 },
 143         { 0x2, "SAMD21J16A", 64, 8 },
 144         { 0x3, "SAMD21J15A", 32, 4 },
 145         { 0x4, "SAMD21J14A", 16, 2 },
 146         { 0x5, "SAMD21G18A", 256, 32 },
 147         { 0x6, "SAMD21G17A", 128, 16 },
 148         { 0x7, "SAMD21G16A", 64, 8 },
 149         { 0x8, "SAMD21G15A", 32, 4 },
 150         { 0x9, "SAMD21G14A", 16, 2 },
 151         { 0xA, "SAMD21E18A", 256, 32 },
 152         { 0xB, "SAMD21E17A", 128, 16 },
 153         { 0xC, "SAMD21E16A", 64, 8 },
 154         { 0xD, "SAMD21E15A", 32, 4 },
 155         { 0xE, "SAMD21E14A", 16, 2 },
 156
 157     /* SAMR21 parts have integrated SAMD21 with a radio */
 158         { 0x18, "SAMR21G19A", 256, 32 }, /* with 512k of serial flash */
 159         { 0x19, "SAMR21G18A", 256, 32 },
 160         { 0x1A, "SAMR21G17A", 128, 32 },
 161         { 0x1B, "SAMR21G16A",  64, 16 },
 162         { 0x1C, "SAMR21E18A", 256, 32 },
 163         { 0x1D, "SAMR21E17A", 128, 32 },
 164         { 0x1E, "SAMR21E16A",  64, 16 },
 165
 166     /* SAMD21 B Variants (Table 3-7 from rev I of datasheet) */
 167         { 0x20, "SAMD21J16B", 64, 8 },
 168         { 0x21, "SAMD21J15B", 32, 4 },
 169         { 0x23, "SAMD21G16B", 64, 8 },
 170         { 0x24, "SAMD21G15B", 32, 4 },
 171         { 0x26, "SAMD21E16B", 64, 8 },
 172         { 0x27, "SAMD21E15B", 32, 4 },
 173
 174         /* SAMD21 D and L Variants (from Errata)
 175            http://ww1.microchip.com/downloads/en/DeviceDoc/
 176            SAM-D21-Family-Silicon-Errata-and-DataSheet-Clarification-DS80000760D.pdf */
 177         { 0x55, "SAMD21E16BU", 64, 8 },
 178         { 0x56, "SAMD21E15BU", 32, 4 },
 179         { 0x57, "SAMD21G16L", 64, 8 },
 180         { 0x3E, "SAMD21E16L", 64, 8 },
 181         { 0x3F, "SAMD21E15L", 32, 4 },
 182         { 0x62, "SAMD21E16CU", 64, 8 },
 183         { 0x63, "SAMD21E15CU", 32, 4 },
 184         { 0x92, "SAMD21J17D", 128, 16 },
 185         { 0x93, "SAMD21G17D", 128, 16 },
 186         { 0x94, "SAMD21E17D", 128, 16 },
 187         { 0x95, "SAMD21E17DU", 128, 16 },
 188         { 0x96, "SAMD21G17L", 128, 16 },
 189         { 0x97, "SAMD21E17L", 128, 16 },
 190
 191         /* Known SAMDA1 parts.
 192            SAMD-A1 series uses the same series identifier like the SAMD21
 193            taken from http://ww1.microchip.com/downloads/en/DeviceDoc/40001895A.pdf (pages 14-17) */
 194         { 0x29, "SAMDA1J16A", 64, 8 },
 195         { 0x2A, "SAMDA1J15A", 32, 4 },
 196         { 0x2B, "SAMDA1J14A", 16, 4 },
 197         { 0x2C, "SAMDA1G16A", 64, 8 },
 198         { 0x2D, "SAMDA1G15A", 32, 4 },
 199         { 0x2E, "SAMDA1G14A", 16, 4 },
 200         { 0x2F, "SAMDA1E16A", 64, 8 },
 201         { 0x30, "SAMDA1E15A", 32, 4 },
 202         { 0x31, "SAMDA1E14A", 16, 4 },
 203         { 0x64, "SAMDA1J16B", 64, 8 },
 204         { 0x65, "SAMDA1J15B", 32, 4 },
 205         { 0x66, "SAMDA1J14B", 16, 4 },
 206         { 0x67, "SAMDA1G16B", 64, 8 },
 207         { 0x68, "SAMDA1G15B", 32, 4 },
 208         { 0x69, "SAMDA1G14B", 16, 4 },
 209         { 0x6A, "SAMDA1E16B", 64, 8 },
 210         { 0x6B, "SAMDA1E15B", 32, 4 },
 211         { 0x6C, "SAMDA1E14B", 16, 4 },
 212 };
 213
 214 /* Known SAML21 parts. */
 215 static const struct samd_part saml21_parts[] = {
 216         { 0x00, "SAML21J18A", 256, 32 },
 217         { 0x01, "SAML21J17A", 128, 16 },
 218         { 0x02, "SAML21J16A", 64, 8 },
 219         { 0x05, "SAML21G18A", 256, 32 },
 220         { 0x06, "SAML21G17A", 128, 16 },
 221         { 0x07, "SAML21G16A", 64, 8 },
 222         { 0x0A, "SAML21E18A", 256, 32 },
 223         { 0x0B, "SAML21E17A", 128, 16 },
 224         { 0x0C, "SAML21E16A", 64, 8 },
 225         { 0x0D, "SAML21E15A", 32, 4 },
 226         { 0x0F, "SAML21J18B", 256, 32 },
 227         { 0x10, "SAML21J17B", 128, 16 },
 228         { 0x11, "SAML21J16B", 64, 8 },
 229         { 0x14, "SAML21G18B", 256, 32 },
 230         { 0x15, "SAML21G17B", 128, 16 },
 231         { 0x16, "SAML21G16B", 64, 8 },
 232         { 0x19, "SAML21E18B", 256, 32 },
 233         { 0x1A, "SAML21E17B", 128, 16 },
 234         { 0x1B, "SAML21E16B", 64, 8 },
 235         { 0x1C, "SAML21E15B", 32, 4 },
 236
 237     /* SAMR30 parts have integrated SAML21 with a radio */
 238         { 0x1E, "SAMR30G18A", 256, 32 },
 239         { 0x1F, "SAMR30E18A", 256, 32 },
 240
 241     /* SAMR34/R35 parts have integrated SAML21 with a lora radio */
 242         { 0x28, "SAMR34J18", 256, 32 },
 243         { 0x2B, "SAMR35J18", 256, 32 },
 244 };
 245
 246 /* Known SAML22 parts. */
 247 static const struct samd_part saml22_parts[] = {
 248         { 0x00, "SAML22N18A", 256, 32 },
 249         { 0x01, "SAML22N17A", 128, 16 },
 250         { 0x02, "SAML22N16A", 64, 8 },
 251         { 0x05, "SAML22J18A", 256, 32 },
 252         { 0x06, "SAML22J17A", 128, 16 },
 253         { 0x07, "SAML22J16A", 64, 8 },
 254         { 0x0A, "SAML22G18A", 256, 32 },
 255         { 0x0B, "SAML22G17A", 128, 16 },
 256         { 0x0C, "SAML22G16A", 64, 8 },
 257 };
 258
 259 /* Known SAMC20 parts. */
 260 static const struct samd_part samc20_parts[] = {
 261         { 0x00, "SAMC20J18A", 256, 32 },
 262         { 0x01, "SAMC20J17A", 128, 16 },
 263         { 0x02, "SAMC20J16A", 64, 8 },
 264         { 0x03, "SAMC20J15A", 32, 4 },
 265         { 0x05, "SAMC20G18A", 256, 32 },
 266         { 0x06, "SAMC20G17A", 128, 16 },
 267         { 0x07, "SAMC20G16A", 64, 8 },
 268         { 0x08, "SAMC20G15A", 32, 4 },
 269         { 0x0A, "SAMC20E18A", 256, 32 },
 270         { 0x0B, "SAMC20E17A", 128, 16 },
 271         { 0x0C, "SAMC20E16A", 64, 8 },
 272         { 0x0D, "SAMC20E15A", 32, 4 },
 273         { 0x20, "SAMC20N18A", 256, 32 },
 274         { 0x21, "SAMC20N17A", 128, 16 },
 275 };
 276
 277 /* Known SAMC21 parts. */
 278 static const struct samd_part samc21_parts[] = {
 279         { 0x00, "SAMC21J18A", 256, 32 },
 280         { 0x01, "SAMC21J17A", 128, 16 },
 281         { 0x02, "SAMC21J16A", 64, 8 },
 282         { 0x03, "SAMC21J15A", 32, 4 },
 283         { 0x05, "SAMC21G18A", 256, 32 },
 284         { 0x06, "SAMC21G17A", 128, 16 },
 285         { 0x07, "SAMC21G16A", 64, 8 },
 286         { 0x08, "SAMC21G15A", 32, 4 },
 287         { 0x0A, "SAMC21E18A", 256, 32 },
 288         { 0x0B, "SAMC21E17A", 128, 16 },
 289         { 0x0C, "SAMC21E16A", 64, 8 },
 290         { 0x0D, "SAMC21E15A", 32, 4 },
 291         { 0x20, "SAMC21N18A", 256, 32 },
 292         { 0x21, "SAMC21N17A", 128, 16 },
 293 };
 294
 295 /* Each family of parts contains a parts table in the DEVSEL field of DID.  The
 296  * processor ID, family ID, and series ID are used to determine which exact
 297  * family this is and then we can use the corresponding table. */
 298 struct samd_family {
 299         uint8_t processor;
 300         uint8_t family;
 301         uint8_t series;
 302         const struct samd_part *parts;
 303         size_t num_parts;
 304         uint64_t nvm_userrow_res_mask; /* protect bits which are reserved, 0 -> protect */
 305 };
 306
 307 /* Known SAMD families */
 308 static const struct samd_family samd_families[] = {
 309         { SAMD_PROCESSOR_M0, SAMD_FAMILY_D, SAMD_SERIES_20,
 310                 samd20_parts, ARRAY_SIZE(samd20_parts),
 311                 (uint64_t)0xFFFF01FFFE01FF77 },
 312         { SAMD_PROCESSOR_M0, SAMD_FAMILY_D, SAMD_SERIES_21,
 313                 samd21_parts, ARRAY_SIZE(samd21_parts),
 314                 (uint64_t)0xFFFF01FFFE01FF77 },
 315         { SAMD_PROCESSOR_M0, SAMD_FAMILY_D, SAMD_SERIES_09,
 316                 samd09_parts, ARRAY_SIZE(samd09_parts),
 317                 (uint64_t)0xFFFF01FFFE01FF77 },
 318         { SAMD_PROCESSOR_M0, SAMD_FAMILY_D, SAMD_SERIES_10,
 319                 samd10_parts, ARRAY_SIZE(samd10_parts),
 320                 (uint64_t)0xFFFF01FFFE01FF77 },
 321         { SAMD_PROCESSOR_M0, SAMD_FAMILY_D, SAMD_SERIES_11,
 322                 samd11_parts, ARRAY_SIZE(samd11_parts),
 323                 (uint64_t)0xFFFF01FFFE01FF77 },
 324         { SAMD_PROCESSOR_M0, SAMD_FAMILY_L, SAMD_SERIES_21,
 325                 saml21_parts, ARRAY_SIZE(saml21_parts),
 326                 (uint64_t)0xFFFF03FFFC01FF77 },
 327         { SAMD_PROCESSOR_M0, SAMD_FAMILY_L, SAMD_SERIES_22,
 328                 saml22_parts, ARRAY_SIZE(saml22_parts),
 329                 (uint64_t)0xFFFF03FFFC01FF77 },
 330         { SAMD_PROCESSOR_M0, SAMD_FAMILY_C, SAMD_SERIES_20,
 331                 samc20_parts, ARRAY_SIZE(samc20_parts),
 332                 (uint64_t)0xFFFF03FFFC01FF77 },
 333         { SAMD_PROCESSOR_M0, SAMD_FAMILY_C, SAMD_SERIES_21,
 334                 samc21_parts, ARRAY_SIZE(samc21_parts),
 335                 (uint64_t)0xFFFF03FFFC01FF77 },
 336 };
 337
 338 struct samd_info {
 339         uint32_t page_size;
 340         int num_pages;
 341         int sector_size;
 342         int prot_block_size;
 343
 344         bool probed;
 345         struct target *target;
 346 };
 347
 348
 349 /**
 350  * Gives the family structure to specific device id.
 351  * @param id The id of the device.
 352  * @return On failure NULL, otherwise a pointer to the structure.
 353  */
 354 static const struct samd_family *samd_find_family(uint32_t id)
 355 {
 356         uint8_t processor = SAMD_GET_PROCESSOR(id);
 357         uint8_t family = SAMD_GET_FAMILY(id);
 358         uint8_t series = SAMD_GET_SERIES(id);
 359
 360         for (unsigned i = 0; i < ARRAY_SIZE(samd_families); i++) {
 361                 if (samd_families[i].processor == processor &&
 362                         samd_families[i].series == series &&
 363                         samd_families[i].family == family)
 364                         return &samd_families[i];
 365         }
 366
 367         return NULL;
 368 }
 369
 370 /**
 371  * Gives the part structure to specific device id.
 372  * @param id The id of the device.
 373  * @return On failure NULL, otherwise a pointer to the structure.
 374  */
 375 static const struct samd_part *samd_find_part(uint32_t id)
 376 {
 377         uint8_t devsel = SAMD_GET_DEVSEL(id);
 378         const struct samd_family *family = samd_find_family(id);
 379         if (!family)
 380                 return NULL;
 381
 382         for (unsigned i = 0; i < family->num_parts; i++) {
 383                 if (family->parts[i].id == devsel)
 384                         return &family->parts[i];
 385         }
 386
 387         return NULL;
 388 }
 389
 390 static int samd_protect_check(struct flash_bank *bank)
 391 {
 392         int res;
 393         uint16_t lock;
 394
 395         res = target_read_u16(bank->target,
 396                         SAMD_NVMCTRL + SAMD_NVMCTRL_LOCK, &lock);
 397         if (res != ERROR_OK)
 398                 return res;
 399
 400         /* Lock bits are active-low */
 401         for (unsigned int prot_block = 0; prot_block < bank->num_prot_blocks; prot_block++)
 402                 bank->prot_blocks[prot_block].is_protected = !(lock & (1u<<prot_block));
 403
 404         return ERROR_OK;
 405 }
 406
 407 static int samd_get_flash_page_info(struct target *target,
 408                 uint32_t *sizep, int *nump)
 409 {
 410         int res;
 411         uint32_t param;
 412
 413         res = target_read_u32(target, SAMD_NVMCTRL + SAMD_NVMCTRL_PARAM, &param);
 414         if (res == ERROR_OK) {
 415                 /* The PSZ field (bits 18:16) indicate the page size bytes as 2^(3+n)
 416                  * so 0 is 8KB and 7 is 1024KB. */
 417                 if (sizep)
 418                         *sizep = (8 << ((param >> 16) & 0x7));
 419                 /* The NVMP field (bits 15:0) indicates the total number of pages */
 420                 if (nump)
 421                         *nump = param & 0xFFFF;
 422         } else {
 423                 LOG_ERROR("Couldn't read NVM Parameters register");
 424         }
 425
 426         return res;
 427 }
 428
 429 static int samd_probe(struct flash_bank *bank)
 430 {
 431         uint32_t id;
 432         int res;
 433         struct samd_info *chip = (struct samd_info *)bank->driver_priv;
 434         const struct samd_part *part;
 435
 436         if (chip->probed)
 437                 return ERROR_OK;
 438
 439         res = target_read_u32(bank->target, SAMD_DSU + SAMD_DSU_DID, &id);
 440         if (res != ERROR_OK) {
 441                 LOG_ERROR("Couldn't read Device ID register");
 442                 return res;
 443         }
 444
 445         part = samd_find_part(id);
 446         if (!part) {
 447                 LOG_ERROR("Couldn't find part corresponding to DID %08" PRIx32, id);
 448                 return ERROR_FAIL;
 449         }
 450
 451         bank->size = part->flash_kb * 1024;
 452
 453         res = samd_get_flash_page_info(bank->target, &chip->page_size,
 454                         &chip->num_pages);
 455         if (res != ERROR_OK) {
 456                 LOG_ERROR("Couldn't determine Flash page size");
 457                 return res;
 458         }
 459
 460         /* Sanity check: the total flash size in the DSU should match the page size
 461          * multiplied by the number of pages. */
 462         if (bank->size != chip->num_pages * chip->page_size) {
 463                 LOG_WARNING("SAMD: bank size doesn't match NVM parameters. "
 464                                 "Identified %" PRIu32 "KB Flash but NVMCTRL reports %u %" PRIu32 "B pages",
 465                                 part->flash_kb, chip->num_pages, chip->page_size);
 466         }
 467
 468         /* Erase granularity = 1 row = 4 pages */
 469         chip->sector_size = chip->page_size * 4;
 470
 471         /* Allocate the sector table */
 472         bank->num_sectors = chip->num_pages / 4;
 473         bank->sectors = alloc_block_array(0, chip->sector_size, bank->num_sectors);
 474         if (!bank->sectors)
 475                 return ERROR_FAIL;
 476
 477         /* 16 protection blocks per device */
 478         chip->prot_block_size = bank->size / SAMD_NUM_PROT_BLOCKS;
 479
 480         /* Allocate the table of protection blocks */
 481         bank->num_prot_blocks = SAMD_NUM_PROT_BLOCKS;
 482         bank->prot_blocks = alloc_block_array(0, chip->prot_block_size, bank->num_prot_blocks);
 483         if (!bank->prot_blocks)
 484                 return ERROR_FAIL;
 485
 486         samd_protect_check(bank);
 487
 488         /* Done */
 489         chip->probed = true;
 490
 491         LOG_INFO("SAMD MCU: %s (%" PRIu32 "KB Flash, %" PRIu32 "KB RAM)", part->name,
 492                         part->flash_kb, part->ram_kb);
 493
 494         return ERROR_OK;
 495 }
 496
 497 static int samd_check_error(struct target *target)
 498 {
 499         int ret, ret2;
 500         uint16_t status;
 501
 502         ret = target_read_u16(target,
 503                         SAMD_NVMCTRL + SAMD_NVMCTRL_STATUS, &status);
 504         if (ret != ERROR_OK) {
 505                 LOG_ERROR("Can't read NVM status");
 506                 return ret;
 507         }
 508
 509         if ((status & 0x001C) == 0)
 510                 return ERROR_OK;
 511
 512         if (status & (1 << 4)) { /* NVME */
 513                 LOG_ERROR("SAMD: NVM Error");
 514                 ret = ERROR_FLASH_OPERATION_FAILED;
 515         }
 516
 517         if (status & (1 << 3)) { /* LOCKE */
 518                 LOG_ERROR("SAMD: NVM lock error");
 519                 ret = ERROR_FLASH_PROTECTED;
 520         }
 521
 522         if (status & (1 << 2)) { /* PROGE */
 523                 LOG_ERROR("SAMD: NVM programming error");
 524                 ret = ERROR_FLASH_OPER_UNSUPPORTED;
 525         }
 526
 527         /* Clear the error conditions by writing a one to them */
 528         ret2 = target_write_u16(target,
 529                         SAMD_NVMCTRL + SAMD_NVMCTRL_STATUS, status);
 530         if (ret2 != ERROR_OK)
 531                 LOG_ERROR("Can't clear NVM error conditions");
 532
 533         return ret;
 534 }
 535
 536 static int samd_issue_nvmctrl_command(struct target *target, uint16_t cmd)
 537 {
 538         int res;
 539
 540         if (target->state != TARGET_HALTED) {
 541                 LOG_ERROR("Target not halted");
 542                 return ERROR_TARGET_NOT_HALTED;
 543         }
 544
 545         /* Issue the NVM command */
 546         res = target_write_u32(target,
 547                         SAMD_NVMCTRL + SAMD_NVMCTRL_CTRLA, SAMD_NVM_CMD(cmd));
 548         if (res != ERROR_OK)
 549                 return res;
 550
 551         /* Check to see if the NVM command resulted in an error condition. */
 552         return samd_check_error(target);
 553 }
 554
 555 /**
 556  * Erases a flash-row at the given address.
 557  * @param target Pointer to the target structure.
 558  * @param address The address of the row.
 559  * @return On success ERROR_OK, on failure an errorcode.
 560  */
 561 static int samd_erase_row(struct target *target, uint32_t address)
 562 {
 563         int res;
 564
 565         /* Set an address contained in the row to be erased */
 566         res = target_write_u32(target,
 567                         SAMD_NVMCTRL + SAMD_NVMCTRL_ADDR, address >> 1);
 568
 569         /* Issue the Erase Row command to erase that row. */
 570         if (res == ERROR_OK)
 571                 res = samd_issue_nvmctrl_command(target,
 572                                 address == SAMD_USER_ROW ? SAMD_NVM_CMD_EAR : SAMD_NVM_CMD_ER);
 573
 574         if (res != ERROR_OK)  {
 575                 LOG_ERROR("Failed to erase row containing %08" PRIx32, address);
 576                 return ERROR_FAIL;
 577         }
 578
 579         return ERROR_OK;
 580 }
 581
 582 /**
 583  * Returns the bitmask of reserved bits in register.
 584  * @param target Pointer to the target structure.
 585  * @param mask Bitmask, 0 -> value stays untouched.
 586  * @return On success ERROR_OK, on failure an errorcode.
 587  */
 588 static int samd_get_reservedmask(struct target *target, uint64_t *mask)
 589 {
 590         int res;
 591         /* Get the devicetype */
 592         uint32_t id;
 593         res = target_read_u32(target, SAMD_DSU + SAMD_DSU_DID, &id);
 594         if (res != ERROR_OK) {
 595                 LOG_ERROR("Couldn't read Device ID register");
 596                 return res;
 597         }
 598         const struct samd_family *family;
 599         family = samd_find_family(id);
 600         if (!family) {
 601                 LOG_ERROR("Couldn't determine device family");
 602                 return ERROR_FAIL;
 603         }
 604         *mask = family->nvm_userrow_res_mask;
 605         return ERROR_OK;
 606 }
 607
 608 static int read_userrow(struct target *target, uint64_t *userrow)
 609 {
 610         int res;
 611         uint8_t buffer[8];
 612
 613         res = target_read_memory(target, SAMD_USER_ROW, 4, 2, buffer);
 614         if (res != ERROR_OK)
 615                 return res;
 616
 617         *userrow = target_buffer_get_u64(target, buffer);
 618         return ERROR_OK;
 619 }
 620
 621 /**
 622  * Modify the contents of the User Row in Flash. The User Row itself
 623  * has a size of one page and contains a combination of "fuses" and
 624  * calibration data. Bits which have a value of zero in the mask will
 625  * not be changed. Up to now devices only use the first 64 bits.
 626  * @param target Pointer to the target structure.
 627  * @param value_input The value to write.
 628  * @param value_mask Bitmask, 0 -> value stays untouched.
 629  * @return On success ERROR_OK, on failure an errorcode.
 630  */
 631 static int samd_modify_user_row_masked(struct target *target,
 632                 uint64_t value_input, uint64_t value_mask)
 633 {
 634         int res;
 635         uint32_t nvm_ctrlb;
 636         bool manual_wp = true;
 637
 638         /* Retrieve the MCU's page size, in bytes. This is also the size of the
 639          * entire User Row. */
 640         uint32_t page_size;
 641         res = samd_get_flash_page_info(target, &page_size, NULL);
 642         if (res != ERROR_OK) {
 643                 LOG_ERROR("Couldn't determine Flash page size");
 644                 return res;
 645         }
 646
 647         /* Make sure the size is sane. */
 648         assert(page_size <= SAMD_PAGE_SIZE_MAX &&
 649                 page_size >= sizeof(value_input));
 650
 651         uint8_t buf[SAMD_PAGE_SIZE_MAX];
 652         /* Read the user row (comprising one page) by words. */
 653         res = target_read_memory(target, SAMD_USER_ROW, 4, page_size / 4, buf);
 654         if (res != ERROR_OK)
 655                 return res;
 656
 657         uint64_t value_device;
 658         res = read_userrow(target, &value_device);
 659         if (res != ERROR_OK)
 660                 return res;
 661         uint64_t value_new = (value_input & value_mask) | (value_device & ~value_mask);
 662
 663         /* We will need to erase before writing if the new value needs a '1' in any
 664          * position for which the current value had a '0'.  Otherwise we can avoid
 665          * erasing. */
 666         if ((~value_device) & value_new) {
 667                 res = samd_erase_row(target, SAMD_USER_ROW);
 668                 if (res != ERROR_OK) {
 669                         LOG_ERROR("Couldn't erase user row");
 670                         return res;
 671                 }
 672         }
 673
 674         /* Modify */
 675         target_buffer_set_u64(target, buf, value_new);
 676
 677         /* Write the page buffer back out to the target. */
 678         res = target_write_memory(target, SAMD_USER_ROW, 4, page_size / 4, buf);
 679         if (res != ERROR_OK)
 680                 return res;
 681
 682         /* Check if we need to do manual page write commands */
 683         res = target_read_u32(target, SAMD_NVMCTRL + SAMD_NVMCTRL_CTRLB, &nvm_ctrlb);
 684         if (res == ERROR_OK)
 685                 manual_wp = (nvm_ctrlb & SAMD_NVM_CTRLB_MANW) != 0;
 686         else {
 687                 LOG_ERROR("Read of NVM register CTRKB failed.");
 688                 return ERROR_FAIL;
 689         }
 690         if (manual_wp) {
 691                 /* Trigger flash write */
 692                 res = samd_issue_nvmctrl_command(target, SAMD_NVM_CMD_WAP);
 693         } else {
 694                 res = samd_check_error(target);
 695         }
 696
 697         return res;
 698 }
 699
 700 /**
 701  * Modifies the user row register to the given value.
 702  * @param target Pointer to the target structure.
 703  * @param value The value to write.
 704  * @param startb The bit-offset by which the given value is shifted.
 705  * @param endb The bit-offset of the last bit in value to write.
 706  * @return On success ERROR_OK, on failure an errorcode.
 707  */
 708 static int samd_modify_user_row(struct target *target, uint64_t value,
 709                 uint8_t startb, uint8_t endb)
 710 {
 711         uint64_t mask = 0;
 712         int i;
 713         for (i = startb ; i <= endb ; i++)
 714                 mask |= ((uint64_t)1) << i;
 715
 716         return samd_modify_user_row_masked(target, value << startb, mask);
 717 }
 718
 719 static int samd_protect(struct flash_bank *bank, int set,
 720                 unsigned int first, unsigned int last)
 721 {
 722         int res = ERROR_OK;
 723
 724         /* We can issue lock/unlock region commands with the target running but
 725          * the settings won't persist unless we're able to modify the LOCK regions
 726          * and that requires the target to be halted. */
 727         if (bank->target->state != TARGET_HALTED) {
 728                 LOG_ERROR("Target not halted");
 729                 return ERROR_TARGET_NOT_HALTED;
 730         }
 731
 732         for (unsigned int prot_block = first; prot_block <= last; prot_block++) {
 733                 if (set != bank->prot_blocks[prot_block].is_protected) {
 734                         /* Load an address that is within this protection block (we use offset 0) */
 735                         res = target_write_u32(bank->target,
 736                                                         SAMD_NVMCTRL + SAMD_NVMCTRL_ADDR,
 737                                                         bank->prot_blocks[prot_block].offset >> 1);
 738                         if (res != ERROR_OK)
 739                                 goto exit;
 740
 741                         /* Tell the controller to lock that block */
 742                         res = samd_issue_nvmctrl_command(bank->target,
 743                                         set ? SAMD_NVM_CMD_LR : SAMD_NVM_CMD_UR);
 744                         if (res != ERROR_OK)
 745                                 goto exit;
 746                 }
 747         }
 748
 749         /* We've now applied our changes, however they will be undone by the next
 750          * reset unless we also apply them to the LOCK bits in the User Page.  The
 751          * LOCK bits start at bit 48, corresponding to Sector 0 and end with bit 63,
 752          * corresponding to Sector 15.  A '1' means unlocked and a '0' means
 753          * locked.  See Table 9-3 in the SAMD20 datasheet for more details. */
 754
 755         res = samd_modify_user_row(bank->target,
 756                         set ? (uint64_t)0 : (uint64_t)UINT64_MAX,
 757                         48 + first, 48 + last);
 758         if (res != ERROR_OK)
 759                 LOG_WARNING("SAMD: protect settings were not made persistent!");
 760
 761         res = ERROR_OK;
 762
 763 exit:
 764         samd_protect_check(bank);
 765
 766         return res;
 767 }
 768
 769 static int samd_erase(struct flash_bank *bank, unsigned int first,
 770                 unsigned int last)
 771 {
 772         int res;
 773         struct samd_info *chip = (struct samd_info *)bank->driver_priv;
 774
 775         if (bank->target->state != TARGET_HALTED) {
 776                 LOG_ERROR("Target not halted");
 777
 778                 return ERROR_TARGET_NOT_HALTED;
 779         }
 780
 781         if (!chip->probed) {
 782                 if (samd_probe(bank) != ERROR_OK)
 783                         return ERROR_FLASH_BANK_NOT_PROBED;
 784         }
 785
 786         /* For each sector to be erased */
 787         for (unsigned int s = first; s <= last; s++) {
 788                 res = samd_erase_row(bank->target, bank->sectors[s].offset);
 789                 if (res != ERROR_OK) {
 790                         LOG_ERROR("SAMD: failed to erase sector %d at 0x%08" PRIx32, s, bank->sectors[s].offset);
 791                         return res;
 792                 }
 793         }
 794
 795         return ERROR_OK;
 796 }
 797
 798
 799 static int samd_write(struct flash_bank *bank, const uint8_t *buffer,
 800                 uint32_t offset, uint32_t count)
 801 {
 802         int res;
 803         uint32_t nvm_ctrlb;
 804         uint32_t address;
 805         uint32_t pg_offset;
 806         uint32_t nb;
 807         uint32_t nw;
 808         struct samd_info *chip = (struct samd_info *)bank->driver_priv;
 809         uint8_t *pb = NULL;
 810         bool manual_wp;
 811
 812         if (bank->target->state != TARGET_HALTED) {
 813                 LOG_ERROR("Target not halted");
 814                 return ERROR_TARGET_NOT_HALTED;
 815         }
 816
 817         if (!chip->probed) {
 818                 if (samd_probe(bank) != ERROR_OK)
 819                         return ERROR_FLASH_BANK_NOT_PROBED;
 820         }
 821
 822         /* Check if we need to do manual page write commands */
 823         res = target_read_u32(bank->target, SAMD_NVMCTRL + SAMD_NVMCTRL_CTRLB, &nvm_ctrlb);
 824
 825         if (res != ERROR_OK)
 826                 return res;
 827
 828         if (nvm_ctrlb & SAMD_NVM_CTRLB_MANW)
 829                 manual_wp = true;
 830         else
 831                 manual_wp = false;
 832
 833         res = samd_issue_nvmctrl_command(bank->target, SAMD_NVM_CMD_PBC);
 834         if (res != ERROR_OK) {
 835                 LOG_ERROR("%s: %d", __func__, __LINE__);
 836                 return res;
 837         }
 838
 839         while (count) {
 840                 nb = chip->page_size - offset % chip->page_size;
 841                 if (count < nb)
 842                         nb = count;
 843
 844                 address = bank->base + offset;
 845                 pg_offset = offset % chip->page_size;
 846
 847                 if (offset % 4 || (offset + nb) % 4) {
 848                         /* Either start or end of write is not word aligned */
 849                         if (!pb) {
 850                                 pb = malloc(chip->page_size);
 851                                 if (!pb)
 852                                         return ERROR_FAIL;
 853                         }
 854
 855                         /* Set temporary page buffer to 0xff and overwrite the relevant part */
 856                         memset(pb, 0xff, chip->page_size);
 857                         memcpy(pb + pg_offset, buffer, nb);
 858
 859                         /* Align start address to a word boundary */
 860                         address -= offset % 4;
 861                         pg_offset -= offset % 4;
 862                         assert(pg_offset % 4 == 0);
 863
 864                         /* Extend length to whole words */
 865                         nw = (nb + offset % 4 + 3) / 4;
 866                         assert(pg_offset + 4 * nw <= chip->page_size);
 867
 868                         /* Now we have original data extended by 0xff bytes
 869                          * to the nearest word boundary on both start and end */
 870                         res = target_write_memory(bank->target, address, 4, nw, pb + pg_offset);
 871                 } else {
 872                         assert(nb % 4 == 0);
 873                         nw = nb / 4;
 874                         assert(pg_offset + 4 * nw <= chip->page_size);
 875
 876                         /* Word aligned data, use direct write from buffer */
 877                         res = target_write_memory(bank->target, address, 4, nw, buffer);
 878                 }
 879                 if (res != ERROR_OK) {
 880                         LOG_ERROR("%s: %d", __func__, __LINE__);
 881                         goto free_pb;
 882                 }
 883
 884                 /* Devices with errata 13134 have automatic page write enabled by default
 885                  * For other devices issue a write page CMD to the NVM
 886                  * If the page has not been written up to the last word
 887                  * then issue CMD_WP always */
 888                 if (manual_wp || pg_offset + 4 * nw < chip->page_size) {
 889                         res = samd_issue_nvmctrl_command(bank->target, SAMD_NVM_CMD_WP);
 890                 } else {
 891                         /* Access through AHB is stalled while flash is being programmed */
 892                         usleep(200);
 893
 894                         res = samd_check_error(bank->target);
 895                 }
 896
 897                 if (res != ERROR_OK) {
 898                         LOG_ERROR("%s: write failed at address 0x%08" PRIx32, __func__, address);
 899                         goto free_pb;
 900                 }
 901
 902                 /* We're done with the page contents */
 903                 count -= nb;
 904                 offset += nb;
 905                 buffer += nb;
 906         }
 907
 908 free_pb:
 909         free(pb);
 910         return res;
 911 }
 912
 913 FLASH_BANK_COMMAND_HANDLER(samd_flash_bank_command)
 914 {
 915         if (bank->base != SAMD_FLASH) {
 916                 LOG_ERROR("Address " TARGET_ADDR_FMT
 917                                 " invalid bank address (try 0x%08" PRIx32
 918                                 "[at91samd series] )",
 919                                 bank->base, SAMD_FLASH);
 920                 return ERROR_FAIL;
 921         }
 922
 923         struct samd_info *chip;
 924         chip = calloc(1, sizeof(*chip));
 925         if (!chip) {
 926                 LOG_ERROR("No memory for flash bank chip info");
 927                 return ERROR_FAIL;
 928         }
 929
 930         chip->target = bank->target;
 931         chip->probed = false;
 932
 933         bank->driver_priv = chip;
 934
 935         return ERROR_OK;
 936 }
 937
 938 COMMAND_HANDLER(samd_handle_chip_erase_command)
 939 {
 940         struct target *target = get_current_target(CMD_CTX);
 941         int res = ERROR_FAIL;
 942
 943         if (target) {
 944                 /* Enable access to the DSU by disabling the write protect bit */
 945                 target_write_u32(target, SAMD_PAC1, (1<<1));
 946                 /* intentionally without error checking - not accessible on secured chip */
 947
 948                 /* Tell the DSU to perform a full chip erase.  It takes about 240ms to
 949                  * perform the erase. */
 950                 res = target_write_u8(target, SAMD_DSU + SAMD_DSU_CTRL_EXT, (1<<4));
 951                 if (res == ERROR_OK)
 952                         command_print(CMD, "chip erase started");
 953                 else
 954                         command_print(CMD, "write to DSU CTRL failed");
 955         }
 956
 957         return res;
 958 }
 959
 960 COMMAND_HANDLER(samd_handle_set_security_command)
 961 {
 962         int res = ERROR_OK;
 963         struct target *target = get_current_target(CMD_CTX);
 964
 965         if (CMD_ARGC < 1 || (CMD_ARGC >= 1 && (strcmp(CMD_ARGV[0], "enable")))) {
 966                 command_print(CMD, "supply the \"enable\" argument to proceed.");
 967                 return ERROR_COMMAND_SYNTAX_ERROR;
 968         }
 969
 970         if (target) {
 971                 if (target->state != TARGET_HALTED) {
 972                         LOG_ERROR("Target not halted");
 973                         return ERROR_TARGET_NOT_HALTED;
 974                 }
 975
 976                 res = samd_issue_nvmctrl_command(target, SAMD_NVM_CMD_SSB);
 977
 978                 /* Check (and clear) error conditions */
 979                 if (res == ERROR_OK)
 980                         command_print(CMD, "chip secured on next power-cycle");
 981                 else
 982                         command_print(CMD, "failed to secure chip");
 983         }
 984
 985         return res;
 986 }
 987
 988 COMMAND_HANDLER(samd_handle_eeprom_command)
 989 {
 990         int res = ERROR_OK;
 991         struct target *target = get_current_target(CMD_CTX);
 992
 993         if (target) {
 994                 if (target->state != TARGET_HALTED) {
 995                         LOG_ERROR("Target not halted");
 996                         return ERROR_TARGET_NOT_HALTED;
 997                 }
 998
 999                 if (CMD_ARGC >= 1) {
1000                         int val = atoi(CMD_ARGV[0]);
1001                         uint32_t code;
1002
1003                         if (val == 0)
1004                                 code = 7;
1005                         else {
1006                                 /* Try to match size in bytes with corresponding size code */
1007                                 for (code = 0; code <= 6; code++) {
1008                                         if (val == (2 << (13 - code)))
1009                                                 break;
1010                                 }
1011
1012                                 if (code > 6) {
1013                                         command_print(CMD, "Invalid EEPROM size.  Please see "
1014                                                         "datasheet for a list valid sizes.");
1015                                         return ERROR_COMMAND_SYNTAX_ERROR;
1016                                 }
1017                         }
1018
1019                         res = samd_modify_user_row(target, code, 4, 6);
1020                 } else {
1021                         uint16_t val;
1022                         res = target_read_u16(target, SAMD_USER_ROW, &val);
1023                         if (res == ERROR_OK) {
1024                                 uint32_t size = ((val >> 4) & 0x7); /* grab size code */
1025
1026                                 if (size == 0x7)
1027                                         command_print(CMD, "EEPROM is disabled");
1028                                 else {
1029                                         /* Otherwise, 6 is 256B, 0 is 16KB */
1030                                         command_print(CMD, "EEPROM size is %u bytes",
1031                                                         (2 << (13 - size)));
1032                                 }
1033                         }
1034                 }
1035         }
1036
1037         return res;
1038 }
1039
1040 COMMAND_HANDLER(samd_handle_nvmuserrow_command)
1041 {
1042         int res = ERROR_OK;
1043         struct target *target = get_current_target(CMD_CTX);
1044
1045         if (target) {
1046                 if (CMD_ARGC > 2) {
1047                         command_print(CMD, "Too much Arguments given.");
1048                         return ERROR_COMMAND_SYNTAX_ERROR;
1049                 }
1050
1051                 if (CMD_ARGC > 0) {
1052                         if (target->state != TARGET_HALTED) {
1053                                 LOG_ERROR("Target not halted.");
1054                                 return ERROR_TARGET_NOT_HALTED;
1055                         }
1056
1057                         uint64_t mask;
1058                         res = samd_get_reservedmask(target, &mask);
1059                         if (res != ERROR_OK) {
1060                                 LOG_ERROR("Couldn't determine the mask for reserved bits.");
1061                                 return ERROR_FAIL;
1062                         }
1063                         mask &= NVMUSERROW_LOCKBIT_MASK;
1064
1065                         uint64_t value;
1066                         COMMAND_PARSE_NUMBER(u64, CMD_ARGV[0], value);
1067
1068                         if (CMD_ARGC == 2) {
1069                                 uint64_t mask_temp;
1070                                 COMMAND_PARSE_NUMBER(u64, CMD_ARGV[1], mask_temp);
1071
1072                                 mask &= mask_temp;
1073                         }
1074                         res = samd_modify_user_row_masked(target, value, mask);
1075                         if (res != ERROR_OK)
1076                                 return res;
1077                 }
1078
1079                 /* read register */
1080                 uint64_t value;
1081                 res = read_userrow(target, &value);
1082                 if (res == ERROR_OK)
1083                         command_print(CMD, "NVMUSERROW: 0x%016"PRIX64, value);
1084                 else
1085                         LOG_ERROR("NVMUSERROW could not be read.");
1086         }
1087         return res;
1088 }
1089
1090 COMMAND_HANDLER(samd_handle_bootloader_command)
1091 {
1092         int res = ERROR_OK;
1093         struct target *target = get_current_target(CMD_CTX);
1094
1095         if (target) {
1096                 if (target->state != TARGET_HALTED) {
1097                         LOG_ERROR("Target not halted");
1098                         return ERROR_TARGET_NOT_HALTED;
1099                 }
1100
1101                 /* Retrieve the MCU's page size, in bytes. */
1102                 uint32_t page_size;
1103                 res = samd_get_flash_page_info(target, &page_size, NULL);
1104                 if (res != ERROR_OK) {
1105                         LOG_ERROR("Couldn't determine Flash page size");
1106                         return res;
1107                 }
1108
1109                 if (CMD_ARGC >= 1) {
1110                         int val = atoi(CMD_ARGV[0]);
1111                         uint32_t code;
1112
1113                         if (val == 0)
1114                                 code = 7;
1115                         else {
1116                                 /* Try to match size in bytes with corresponding size code */
1117                                 for (code = 0; code <= 6; code++) {
1118                                         if ((unsigned int)val == (2UL << (8UL - code)) * page_size)
1119                                                 break;
1120                                 }
1121
1122                                 if (code > 6) {
1123                                         command_print(CMD, "Invalid bootloader size.  Please "
1124                                                         "see datasheet for a list valid sizes.");
1125                                         return ERROR_COMMAND_SYNTAX_ERROR;
1126                                 }
1127
1128                         }
1129
1130                         res = samd_modify_user_row(target, code, 0, 2);
1131                 } else {
1132                         uint16_t val;
1133                         res = target_read_u16(target, SAMD_USER_ROW, &val);
1134                         if (res == ERROR_OK) {
1135                                 uint32_t size = (val & 0x7); /* grab size code */
1136                                 uint32_t nb;
1137
1138                                 if (size == 0x7)
1139                                         nb = 0;
1140                                 else
1141                                         nb = (2 << (8 - size)) * page_size;
1142
1143                                 /* There are 4 pages per row */
1144                                 command_print(CMD, "Bootloader size is %" PRIu32 " bytes (%" PRIu32 " rows)",
1145                                            nb, (uint32_t)(nb / (page_size * 4)));
1146                         }
1147                 }
1148         }
1149
1150         return res;
1151 }
1152
1153
1154
1155 COMMAND_HANDLER(samd_handle_reset_deassert)
1156 {
1157         struct target *target = get_current_target(CMD_CTX);
1158         int retval = ERROR_OK;
1159         enum reset_types jtag_reset_config = jtag_get_reset_config();
1160
1161         /* If the target has been unresponsive before, try to re-establish
1162          * communication now - CPU is held in reset by DSU, DAP is working */
1163         if (!target_was_examined(target))
1164                 target_examine_one(target);
1165         target_poll(target);
1166
1167         /* In case of sysresetreq, debug retains state set in cortex_m_assert_reset()
1168          * so we just release reset held by DSU
1169          *
1170          * n_RESET (srst) clears the DP, so reenable debug and set vector catch here
1171          *
1172          * After vectreset DSU release is not needed however makes no harm
1173          */
1174         if (target->reset_halt && (jtag_reset_config & RESET_HAS_SRST)) {
1175                 retval = target_write_u32(target, DCB_DHCSR, DBGKEY | C_HALT | C_DEBUGEN);
1176                 if (retval == ERROR_OK)
1177                         retval = target_write_u32(target, DCB_DEMCR,
1178                                 TRCENA | VC_HARDERR | VC_BUSERR | VC_CORERESET);
1179                 /* do not return on error here, releasing DSU reset is more important */
1180         }
1181
1182         /* clear CPU Reset Phase Extension bit */
1183         int retval2 = target_write_u8(target, SAMD_DSU + SAMD_DSU_STATUSA, (1<<1));
1184         if (retval2 != ERROR_OK)
1185                 return retval2;
1186
1187         return retval;
1188 }
1189
1190 static const struct command_registration at91samd_exec_command_handlers[] = {
1191         {
1192                 .name = "dsu_reset_deassert",
1193                 .handler = samd_handle_reset_deassert,
1194                 .mode = COMMAND_EXEC,
1195                 .help = "Deassert internal reset held by DSU.",
1196                 .usage = "",
1197         },
1198         {
1199                 .name = "chip-erase",
1200                 .handler = samd_handle_chip_erase_command,
1201                 .mode = COMMAND_EXEC,
1202                 .help = "Erase the entire Flash by using the Chip-"
1203                         "Erase feature in the Device Service Unit (DSU).",
1204                 .usage = "",
1205         },
1206         {
1207                 .name = "set-security",
1208                 .handler = samd_handle_set_security_command,
1209                 .mode = COMMAND_EXEC,
1210                 .help = "Secure the chip's Flash by setting the Security Bit. "
1211                         "This makes it impossible to read the Flash contents. "
1212                         "The only way to undo this is to issue the chip-erase "
1213                         "command.",
1214                 .usage = "'enable'",
1215         },
1216         {
1217                 .name = "eeprom",
1218                 .usage = "[size_in_bytes]",
1219                 .handler = samd_handle_eeprom_command,
1220                 .mode = COMMAND_EXEC,
1221                 .help = "Show or set the EEPROM size setting, stored in the User Row. "
1222                         "Please see Table 20-3 of the SAMD20 datasheet for allowed values. "
1223                         "Changes are stored immediately but take affect after the MCU is "
1224                         "reset.",
1225         },
1226         {
1227                 .name = "bootloader",
1228                 .usage = "[size_in_bytes]",
1229                 .handler = samd_handle_bootloader_command,
1230                 .mode = COMMAND_EXEC,
1231                 .help = "Show or set the bootloader size, stored in the User Row. "
1232                         "Please see Table 20-2 of the SAMD20 datasheet for allowed values. "
1233                         "Changes are stored immediately but take affect after the MCU is "
1234                         "reset.",
1235         },
1236         {
1237                 .name = "nvmuserrow",
1238                 .usage = "[value] [mask]",
1239                 .handler = samd_handle_nvmuserrow_command,
1240                 .mode = COMMAND_EXEC,
1241                 .help = "Show or set the nvmuserrow register. It is 64 bit wide "
1242                         "and located at address 0x804000. Use the optional mask argument "
1243                         "to prevent changes at positions where the bitvalue is zero. "
1244                         "For security reasons the lock- and reserved-bits are masked out "
1245                         "in background and therefore cannot be changed.",
1246         },
1247         COMMAND_REGISTRATION_DONE
1248 };
1249
1250 static const struct command_registration at91samd_command_handlers[] = {
1251         {
1252                 .name = "at91samd",
1253                 .mode = COMMAND_ANY,
1254                 .help = "at91samd flash command group",
1255                 .usage = "",
1256                 .chain = at91samd_exec_command_handlers,
1257         },
1258         COMMAND_REGISTRATION_DONE
1259 };
1260
1261 const struct flash_driver at91samd_flash = {
1262         .name = "at91samd",
1263         .commands = at91samd_command_handlers,
1264         .flash_bank_command = samd_flash_bank_command,
1265         .erase = samd_erase,
1266         .protect = samd_protect,
1267         .write = samd_write,
1268         .read = default_flash_read,
1269         .probe = samd_probe,
1270         .auto_probe = samd_probe,
1271         .erase_check = default_flash_blank_check,
1272         .protect_check = samd_protect_check,
1273         .free_driver_priv = default_flash_free_driver_priv,
1274 };