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

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