drivers/dfu/dfu.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * dfu.c -- DFU back-end routines
   4  *
   5  * Copyright (C) 2012 Samsung Electronics
   6  * author: Lukasz Majewski <l.majewski@samsung.com>
   7  */
   8
   9 #include <common.h>
  10 #include <env.h>
  11 #include <errno.h>
  12 #include <malloc.h>
  13 #include <mmc.h>
  14 #include <fat.h>
  15 #include <dfu.h>
  16 #include <hash.h>
  17 #include <linux/list.h>
  18 #include <linux/compiler.h>
  19
  20 static LIST_HEAD(dfu_list);
  21 static int dfu_alt_num;
  22 static int alt_num_cnt;
  23 static struct hash_algo *dfu_hash_algo;
  24
  25 /*
  26  * The purpose of the dfu_usb_get_reset() function is to
  27  * provide information if after USB_DETACH request
  28  * being sent the dfu-util performed reset of USB
  29  * bus.
  30  *
  31  * Described behaviour is the only way to distinct if
  32  * user has typed -e (detach) or -R (reset) when invoking
  33  * dfu-util command.
  34  *
  35  */
  36 __weak bool dfu_usb_get_reset(void)
  37 {
  38 #ifdef CONFIG_SPL_DFU_NO_RESET
  39         return false;
  40 #else
  41         return true;
  42 #endif
  43 }
  44
  45 static int dfu_find_alt_num(const char *s)
  46 {
  47         int i = 0;
  48
  49         for (; *s; s++)
  50                 if (*s == ';')
  51                         i++;
  52
  53         return ++i;
  54 }
  55
  56 int dfu_init_env_entities(char *interface, char *devstr)
  57 {
  58         const char *str_env;
  59         char *env_bkp;
  60         int ret = 0;
  61
  62 #ifdef CONFIG_SET_DFU_ALT_INFO
  63         set_dfu_alt_info(interface, devstr);
  64 #endif
  65         str_env = env_get("dfu_alt_info");
  66         if (!str_env) {
  67                 pr_err("\"dfu_alt_info\" env variable not defined!\n");
  68                 return -EINVAL;
  69         }
  70
  71         env_bkp = strdup(str_env);
  72         ret = dfu_config_entities(env_bkp, interface, devstr);
  73         if (ret) {
  74                 pr_err("DFU entities configuration failed!\n");
  75                 pr_err("(partition table does not match dfu_alt_info?)\n");
  76                 goto done;
  77         }
  78
  79 done:
  80         free(env_bkp);
  81         return ret;
  82 }
  83
  84 static unsigned char *dfu_buf;
  85 static unsigned long dfu_buf_size;
  86
  87 unsigned char *dfu_free_buf(void)
  88 {
  89         free(dfu_buf);
  90         dfu_buf = NULL;
  91         return dfu_buf;
  92 }
  93
  94 unsigned long dfu_get_buf_size(void)
  95 {
  96         return dfu_buf_size;
  97 }
  98
  99 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
 100 {
 101         char *s;
 102
 103         if (dfu_buf != NULL)
 104                 return dfu_buf;
 105
 106         s = env_get("dfu_bufsiz");
 107         if (s)
 108                 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
 109
 110         if (!s || !dfu_buf_size)
 111                 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
 112
 113         if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
 114                 dfu_buf_size = dfu->max_buf_size;
 115
 116         dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
 117         if (dfu_buf == NULL)
 118                 printf("%s: Could not memalign 0x%lx bytes\n",
 119                        __func__, dfu_buf_size);
 120
 121         return dfu_buf;
 122 }
 123
 124 static char *dfu_get_hash_algo(void)
 125 {
 126         char *s;
 127
 128         s = env_get("dfu_hash_algo");
 129         if (!s)
 130                 return NULL;
 131
 132         if (!strcmp(s, "crc32")) {
 133                 debug("%s: DFU hash method: %s\n", __func__, s);
 134                 return s;
 135         }
 136
 137         pr_err("DFU hash method: %s not supported!\n", s);
 138         return NULL;
 139 }
 140
 141 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
 142 {
 143         long w_size;
 144         int ret;
 145
 146         /* flush size? */
 147         w_size = dfu->i_buf - dfu->i_buf_start;
 148         if (w_size == 0)
 149                 return 0;
 150
 151         if (dfu_hash_algo)
 152                 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
 153                                            dfu->i_buf_start, w_size, 0);
 154
 155         ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
 156         if (ret)
 157                 debug("%s: Write error!\n", __func__);
 158
 159         /* point back */
 160         dfu->i_buf = dfu->i_buf_start;
 161
 162         /* update offset */
 163         dfu->offset += w_size;
 164
 165         puts("#");
 166
 167         return ret;
 168 }
 169
 170 void dfu_transaction_cleanup(struct dfu_entity *dfu)
 171 {
 172         /* clear everything */
 173         dfu->crc = 0;
 174         dfu->offset = 0;
 175         dfu->i_blk_seq_num = 0;
 176         dfu->i_buf_start = dfu_get_buf(dfu);
 177         dfu->i_buf_end = dfu->i_buf_start;
 178         dfu->i_buf = dfu->i_buf_start;
 179         dfu->r_left = 0;
 180         dfu->b_left = 0;
 181         dfu->bad_skip = 0;
 182
 183         dfu->inited = 0;
 184 }
 185
 186 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
 187 {
 188         int ret = 0;
 189
 190         if (dfu->inited)
 191                 return 0;
 192
 193         dfu_transaction_cleanup(dfu);
 194
 195         if (dfu->i_buf_start == NULL)
 196                 return -ENOMEM;
 197
 198         dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
 199
 200         if (read) {
 201                 ret = dfu->get_medium_size(dfu, &dfu->r_left);
 202                 if (ret < 0)
 203                         return ret;
 204                 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
 205         }
 206
 207         dfu->inited = 1;
 208
 209         return 0;
 210 }
 211
 212 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 213 {
 214         int ret = 0;
 215
 216         ret = dfu_write_buffer_drain(dfu);
 217         if (ret)
 218                 return ret;
 219
 220         if (dfu->flush_medium)
 221                 ret = dfu->flush_medium(dfu);
 222
 223         if (dfu_hash_algo)
 224                 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
 225                        dfu->crc);
 226
 227         dfu_transaction_cleanup(dfu);
 228
 229         return ret;
 230 }
 231
 232 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 233 {
 234         int ret;
 235
 236         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
 237               __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
 238               (unsigned long)(dfu->i_buf - dfu->i_buf_start));
 239
 240         ret = dfu_transaction_initiate(dfu, false);
 241         if (ret < 0)
 242                 return ret;
 243
 244         if (dfu->i_blk_seq_num != blk_seq_num) {
 245                 printf("%s: Wrong sequence number! [%d] [%d]\n",
 246                        __func__, dfu->i_blk_seq_num, blk_seq_num);
 247                 dfu_transaction_cleanup(dfu);
 248                 return -1;
 249         }
 250
 251         /* DFU 1.1 standard says:
 252          * The wBlockNum field is a block sequence number. It increments each
 253          * time a block is transferred, wrapping to zero from 65,535. It is used
 254          * to provide useful context to the DFU loader in the device."
 255          *
 256          * This means that it's a 16 bit counter that roll-overs at
 257          * 0xffff -> 0x0000. By having a typical 4K transfer block
 258          * we roll-over at exactly 256MB. Not very fun to debug.
 259          *
 260          * Handling rollover, and having an inited variable,
 261          * makes things work.
 262          */
 263
 264         /* handle rollover */
 265         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
 266
 267         /* flush buffer if overflow */
 268         if ((dfu->i_buf + size) > dfu->i_buf_end) {
 269                 ret = dfu_write_buffer_drain(dfu);
 270                 if (ret) {
 271                         dfu_transaction_cleanup(dfu);
 272                         return ret;
 273                 }
 274         }
 275
 276         /* we should be in buffer now (if not then size too large) */
 277         if ((dfu->i_buf + size) > dfu->i_buf_end) {
 278                 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
 279                       size, dfu->i_buf_end);
 280                 dfu_transaction_cleanup(dfu);
 281                 return -1;
 282         }
 283
 284         memcpy(dfu->i_buf, buf, size);
 285         dfu->i_buf += size;
 286
 287         /* if end or if buffer full flush */
 288         if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
 289                 ret = dfu_write_buffer_drain(dfu);
 290                 if (ret) {
 291                         dfu_transaction_cleanup(dfu);
 292                         return ret;
 293                 }
 294         }
 295
 296         return 0;
 297 }
 298
 299 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
 300 {
 301         long chunk;
 302         int ret, readn;
 303
 304         readn = 0;
 305         while (size > 0) {
 306                 /* get chunk that can be read */
 307                 chunk = min((long)size, dfu->b_left);
 308                 /* consume */
 309                 if (chunk > 0) {
 310                         memcpy(buf, dfu->i_buf, chunk);
 311                         if (dfu_hash_algo)
 312                                 dfu_hash_algo->hash_update(dfu_hash_algo,
 313                                                            &dfu->crc, buf,
 314                                                            chunk, 0);
 315
 316                         dfu->i_buf += chunk;
 317                         dfu->b_left -= chunk;
 318                         size -= chunk;
 319                         buf += chunk;
 320                         readn += chunk;
 321                 }
 322
 323                 /* all done */
 324                 if (size > 0) {
 325                         /* no more to read */
 326                         if (dfu->r_left == 0)
 327                                 break;
 328
 329                         dfu->i_buf = dfu->i_buf_start;
 330                         dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
 331
 332                         /* got to read, but buffer is empty */
 333                         if (dfu->b_left > dfu->r_left)
 334                                 dfu->b_left = dfu->r_left;
 335                         ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
 336                                         &dfu->b_left);
 337                         if (ret != 0) {
 338                                 debug("%s: Read error!\n", __func__);
 339                                 return ret;
 340                         }
 341                         dfu->offset += dfu->b_left;
 342                         dfu->r_left -= dfu->b_left;
 343
 344                         puts("#");
 345                 }
 346         }
 347
 348         return readn;
 349 }
 350
 351 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 352 {
 353         int ret = 0;
 354
 355         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
 356                __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
 357
 358         ret = dfu_transaction_initiate(dfu, true);
 359         if (ret < 0)
 360                 return ret;
 361
 362         if (dfu->i_blk_seq_num != blk_seq_num) {
 363                 printf("%s: Wrong sequence number! [%d] [%d]\n",
 364                        __func__, dfu->i_blk_seq_num, blk_seq_num);
 365                 return -1;
 366         }
 367         /* handle rollover */
 368         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
 369
 370         ret = dfu_read_buffer_fill(dfu, buf, size);
 371         if (ret < 0) {
 372                 printf("%s: Failed to fill buffer\n", __func__);
 373                 return -1;
 374         }
 375
 376         if (ret < size) {
 377                 if (dfu_hash_algo)
 378                         debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
 379                               dfu_hash_algo->name, dfu->crc);
 380                 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
 381
 382                 dfu_transaction_cleanup(dfu);
 383         }
 384
 385         return ret;
 386 }
 387
 388 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
 389                            char *interface, char *devstr)
 390 {
 391         char *st;
 392
 393         debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
 394         st = strsep(&s, " ");
 395         strcpy(dfu->name, st);
 396
 397         dfu->alt = alt;
 398         dfu->max_buf_size = 0;
 399         dfu->free_entity = NULL;
 400
 401         /* Specific for mmc device */
 402         if (strcmp(interface, "mmc") == 0) {
 403                 if (dfu_fill_entity_mmc(dfu, devstr, s))
 404                         return -1;
 405         } else if (strcmp(interface, "nand") == 0) {
 406                 if (dfu_fill_entity_nand(dfu, devstr, s))
 407                         return -1;
 408         } else if (strcmp(interface, "ram") == 0) {
 409                 if (dfu_fill_entity_ram(dfu, devstr, s))
 410                         return -1;
 411         } else if (strcmp(interface, "sf") == 0) {
 412                 if (dfu_fill_entity_sf(dfu, devstr, s))
 413                         return -1;
 414         } else {
 415                 printf("%s: Device %s not (yet) supported!\n",
 416                        __func__,  interface);
 417                 return -1;
 418         }
 419         dfu_get_buf(dfu);
 420
 421         return 0;
 422 }
 423
 424 void dfu_free_entities(void)
 425 {
 426         struct dfu_entity *dfu, *p, *t = NULL;
 427
 428         dfu_free_buf();
 429         list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
 430                 list_del(&dfu->list);
 431                 if (dfu->free_entity)
 432                         dfu->free_entity(dfu);
 433                 t = dfu;
 434         }
 435         if (t)
 436                 free(t);
 437         INIT_LIST_HEAD(&dfu_list);
 438
 439         alt_num_cnt = 0;
 440 }
 441
 442 int dfu_config_entities(char *env, char *interface, char *devstr)
 443 {
 444         struct dfu_entity *dfu;
 445         int i, ret;
 446         char *s;
 447
 448         dfu_alt_num = dfu_find_alt_num(env);
 449         debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
 450
 451         dfu_hash_algo = NULL;
 452         s = dfu_get_hash_algo();
 453         if (s) {
 454                 ret = hash_lookup_algo(s, &dfu_hash_algo);
 455                 if (ret)
 456                         pr_err("Hash algorithm %s not supported\n", s);
 457         }
 458
 459         dfu = calloc(sizeof(*dfu), dfu_alt_num);
 460         if (!dfu)
 461                 return -1;
 462         for (i = 0; i < dfu_alt_num; i++) {
 463
 464                 s = strsep(&env, ";");
 465                 ret = dfu_fill_entity(&dfu[i], s, alt_num_cnt, interface,
 466                                       devstr);
 467                 if (ret) {
 468                         /* We will free "dfu" in dfu_free_entities() */
 469                         return -1;
 470                 }
 471
 472                 list_add_tail(&dfu[i].list, &dfu_list);
 473                 alt_num_cnt++;
 474         }
 475
 476         return 0;
 477 }
 478
 479 const char *dfu_get_dev_type(enum dfu_device_type t)
 480 {
 481         const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
 482                                      "SF"};
 483         return dev_t[t];
 484 }
 485
 486 const char *dfu_get_layout(enum dfu_layout l)
 487 {
 488         const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
 489                                           "EXT3", "EXT4", "RAM_ADDR" };
 490         return dfu_layout[l];
 491 }
 492
 493 void dfu_show_entities(void)
 494 {
 495         struct dfu_entity *dfu;
 496
 497         puts("DFU alt settings list:\n");
 498
 499         list_for_each_entry(dfu, &dfu_list, list) {
 500                 printf("dev: %s alt: %d name: %s layout: %s\n",
 501                        dfu_get_dev_type(dfu->dev_type), dfu->alt,
 502                        dfu->name, dfu_get_layout(dfu->layout));
 503         }
 504 }
 505
 506 int dfu_get_alt_number(void)
 507 {
 508         return dfu_alt_num;
 509 }
 510
 511 struct dfu_entity *dfu_get_entity(int alt)
 512 {
 513         struct dfu_entity *dfu;
 514
 515         list_for_each_entry(dfu, &dfu_list, list) {
 516                 if (dfu->alt == alt)
 517                         return dfu;
 518         }
 519
 520         return NULL;
 521 }
 522
 523 int dfu_get_alt(char *name)
 524 {
 525         struct dfu_entity *dfu;
 526         char *str;
 527
 528         list_for_each_entry(dfu, &dfu_list, list) {
 529                 if (dfu->name[0] != '/') {
 530                         if (!strncmp(dfu->name, name, strlen(dfu->name)))
 531                                 return dfu->alt;
 532                 } else {
 533                         /*
 534                          * One must also consider absolute path
 535                          * (/boot/bin/uImage) available at dfu->name when
 536                          * compared "plain" file name (uImage)
 537                          *
 538                          * It is the case for e.g. thor gadget where lthor SW
 539                          * sends only the file name, so only the very last part
 540                          * of path must be checked for equality
 541                          */
 542
 543                         str = strstr(dfu->name, name);
 544                         if (!str)
 545                                 continue;
 546
 547                         /*
 548                          * Check if matching substring is the last element of
 549                          * dfu->name (uImage)
 550                          */
 551                         if (strlen(dfu->name) ==
 552                             ((str - dfu->name) + strlen(name)))
 553                                 return dfu->alt;
 554                 }
 555         }
 556
 557         return -ENODEV;
 558 }
 559
 560 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
 561 {
 562         unsigned long dfu_buf_size, write, left = size;
 563         int i, ret = 0;
 564         void *dp = buf;
 565
 566         /*
 567          * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
 568          * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
 569          * into account.
 570          */
 571         dfu_get_buf(dfu);
 572         dfu_buf_size = dfu_get_buf_size();
 573         debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
 574
 575         for (i = 0; left > 0; i++) {
 576                 write = min(dfu_buf_size, left);
 577
 578                 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
 579                       dp, left, write);
 580                 ret = dfu_write(dfu, dp, write, i);
 581                 if (ret) {
 582                         pr_err("DFU write failed\n");
 583                         return ret;
 584                 }
 585
 586                 dp += write;
 587                 left -= write;
 588         }
 589
 590         ret = dfu_flush(dfu, NULL, 0, i);
 591         if (ret)
 592                 pr_err("DFU flush failed!");
 593
 594         return ret;
 595 }