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 /*
  57  * treat dfu_alt_info with several interface information
  58  * to allow DFU on several device with one command,
  59  * the string format is
  60  * interface devstring'='alternate list (';' separated)
  61  * and each interface separated by '&'
  62  */
  63 int dfu_config_interfaces(char *env)
  64 {
  65         struct dfu_entity *dfu;
  66         char *s, *i, *d, *a, *part;
  67         int ret = -EINVAL;
  68         int n = 1;
  69
  70         s = env;
  71         for (; *s; s++) {
  72                 if (*s == ';')
  73                         n++;
  74                 if (*s == '&')
  75                         n++;
  76         }
  77         ret = dfu_alt_init(n, &dfu);
  78         if (ret)
  79                 return ret;
  80
  81         s = env;
  82         while (s) {
  83                 ret = -EINVAL;
  84                 i = strsep(&s, " ");
  85                 if (!i)
  86                         break;
  87                 d = strsep(&s, "=");
  88                 if (!d)
  89                         break;
  90                 a = strsep(&s, "&");
  91                 if (!a)
  92                         a = s;
  93                 do {
  94                         part = strsep(&a, ";");
  95                         ret = dfu_alt_add(dfu, i, d, part);
  96                         if (ret)
  97                                 return ret;
  98                 } while (a);
  99         }
 100
 101         return ret;
 102 }
 103
 104 int dfu_init_env_entities(char *interface, char *devstr)
 105 {
 106         const char *str_env;
 107         char *env_bkp;
 108         int ret = 0;
 109
 110 #ifdef CONFIG_SET_DFU_ALT_INFO
 111         set_dfu_alt_info(interface, devstr);
 112 #endif
 113         str_env = env_get("dfu_alt_info");
 114         if (!str_env) {
 115                 pr_err("\"dfu_alt_info\" env variable not defined!\n");
 116                 return -EINVAL;
 117         }
 118
 119         env_bkp = strdup(str_env);
 120         if (!interface && !devstr)
 121                 ret = dfu_config_interfaces(env_bkp);
 122         else
 123                 ret = dfu_config_entities(env_bkp, interface, devstr);
 124
 125         if (ret) {
 126                 pr_err("DFU entities configuration failed!\n");
 127                 pr_err("(partition table does not match dfu_alt_info?)\n");
 128                 goto done;
 129         }
 130
 131 done:
 132         free(env_bkp);
 133         return ret;
 134 }
 135
 136 static unsigned char *dfu_buf;
 137 static unsigned long dfu_buf_size;
 138 static enum dfu_device_type dfu_buf_device_type;
 139
 140 unsigned char *dfu_free_buf(void)
 141 {
 142         free(dfu_buf);
 143         dfu_buf = NULL;
 144         return dfu_buf;
 145 }
 146
 147 unsigned long dfu_get_buf_size(void)
 148 {
 149         return dfu_buf_size;
 150 }
 151
 152 unsigned char *dfu_get_buf(struct dfu_entity *dfu)
 153 {
 154         char *s;
 155
 156         /* manage several entity with several contraint */
 157         if (dfu_buf && dfu->dev_type != dfu_buf_device_type)
 158                 dfu_free_buf();
 159
 160         if (dfu_buf != NULL)
 161                 return dfu_buf;
 162
 163         s = env_get("dfu_bufsiz");
 164         if (s)
 165                 dfu_buf_size = (unsigned long)simple_strtol(s, NULL, 0);
 166
 167         if (!s || !dfu_buf_size)
 168                 dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE;
 169
 170         if (dfu->max_buf_size && dfu_buf_size > dfu->max_buf_size)
 171                 dfu_buf_size = dfu->max_buf_size;
 172
 173         dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size);
 174         if (dfu_buf == NULL)
 175                 printf("%s: Could not memalign 0x%lx bytes\n",
 176                        __func__, dfu_buf_size);
 177
 178         dfu_buf_device_type = dfu->dev_type;
 179         return dfu_buf;
 180 }
 181
 182 static char *dfu_get_hash_algo(void)
 183 {
 184         char *s;
 185
 186         s = env_get("dfu_hash_algo");
 187         if (!s)
 188                 return NULL;
 189
 190         if (!strcmp(s, "crc32")) {
 191                 debug("%s: DFU hash method: %s\n", __func__, s);
 192                 return s;
 193         }
 194
 195         pr_err("DFU hash method: %s not supported!\n", s);
 196         return NULL;
 197 }
 198
 199 static int dfu_write_buffer_drain(struct dfu_entity *dfu)
 200 {
 201         long w_size;
 202         int ret;
 203
 204         /* flush size? */
 205         w_size = dfu->i_buf - dfu->i_buf_start;
 206         if (w_size == 0)
 207                 return 0;
 208
 209         if (dfu_hash_algo)
 210                 dfu_hash_algo->hash_update(dfu_hash_algo, &dfu->crc,
 211                                            dfu->i_buf_start, w_size, 0);
 212
 213         ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size);
 214         if (ret)
 215                 debug("%s: Write error!\n", __func__);
 216
 217         /* point back */
 218         dfu->i_buf = dfu->i_buf_start;
 219
 220         /* update offset */
 221         dfu->offset += w_size;
 222
 223         puts("#");
 224
 225         return ret;
 226 }
 227
 228 void dfu_transaction_cleanup(struct dfu_entity *dfu)
 229 {
 230         /* clear everything */
 231         dfu->crc = 0;
 232         dfu->offset = 0;
 233         dfu->i_blk_seq_num = 0;
 234         dfu->i_buf_start = dfu_get_buf(dfu);
 235         dfu->i_buf_end = dfu->i_buf_start;
 236         dfu->i_buf = dfu->i_buf_start;
 237         dfu->r_left = 0;
 238         dfu->b_left = 0;
 239         dfu->bad_skip = 0;
 240
 241         dfu->inited = 0;
 242 }
 243
 244 int dfu_transaction_initiate(struct dfu_entity *dfu, bool read)
 245 {
 246         int ret = 0;
 247
 248         if (dfu->inited)
 249                 return 0;
 250
 251         dfu_transaction_cleanup(dfu);
 252
 253         if (dfu->i_buf_start == NULL)
 254                 return -ENOMEM;
 255
 256         dfu->i_buf_end = dfu->i_buf_start + dfu_get_buf_size();
 257
 258         if (read) {
 259                 ret = dfu->get_medium_size(dfu, &dfu->r_left);
 260                 if (ret < 0)
 261                         return ret;
 262                 debug("%s: %s %lld [B]\n", __func__, dfu->name, dfu->r_left);
 263         }
 264
 265         dfu->inited = 1;
 266
 267         return 0;
 268 }
 269
 270 int dfu_flush(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 271 {
 272         int ret = 0;
 273
 274         ret = dfu_write_buffer_drain(dfu);
 275         if (ret)
 276                 return ret;
 277
 278         if (dfu->flush_medium)
 279                 ret = dfu->flush_medium(dfu);
 280
 281         if (dfu_hash_algo)
 282                 printf("\nDFU complete %s: 0x%08x\n", dfu_hash_algo->name,
 283                        dfu->crc);
 284
 285         dfu_transaction_cleanup(dfu);
 286
 287         return ret;
 288 }
 289
 290 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 291 {
 292         int ret;
 293
 294         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%lx\n",
 295               __func__, dfu->name, buf, size, blk_seq_num, dfu->offset,
 296               (unsigned long)(dfu->i_buf - dfu->i_buf_start));
 297
 298         ret = dfu_transaction_initiate(dfu, false);
 299         if (ret < 0)
 300                 return ret;
 301
 302         if (dfu->i_blk_seq_num != blk_seq_num) {
 303                 printf("%s: Wrong sequence number! [%d] [%d]\n",
 304                        __func__, dfu->i_blk_seq_num, blk_seq_num);
 305                 dfu_transaction_cleanup(dfu);
 306                 return -1;
 307         }
 308
 309         /* DFU 1.1 standard says:
 310          * The wBlockNum field is a block sequence number. It increments each
 311          * time a block is transferred, wrapping to zero from 65,535. It is used
 312          * to provide useful context to the DFU loader in the device."
 313          *
 314          * This means that it's a 16 bit counter that roll-overs at
 315          * 0xffff -> 0x0000. By having a typical 4K transfer block
 316          * we roll-over at exactly 256MB. Not very fun to debug.
 317          *
 318          * Handling rollover, and having an inited variable,
 319          * makes things work.
 320          */
 321
 322         /* handle rollover */
 323         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
 324
 325         /* flush buffer if overflow */
 326         if ((dfu->i_buf + size) > dfu->i_buf_end) {
 327                 ret = dfu_write_buffer_drain(dfu);
 328                 if (ret) {
 329                         dfu_transaction_cleanup(dfu);
 330                         return ret;
 331                 }
 332         }
 333
 334         /* we should be in buffer now (if not then size too large) */
 335         if ((dfu->i_buf + size) > dfu->i_buf_end) {
 336                 pr_err("Buffer overflow! (0x%p + 0x%x > 0x%p)\n", dfu->i_buf,
 337                       size, dfu->i_buf_end);
 338                 dfu_transaction_cleanup(dfu);
 339                 return -1;
 340         }
 341
 342         memcpy(dfu->i_buf, buf, size);
 343         dfu->i_buf += size;
 344
 345         /* if end or if buffer full flush */
 346         if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) {
 347                 ret = dfu_write_buffer_drain(dfu);
 348                 if (ret) {
 349                         dfu_transaction_cleanup(dfu);
 350                         return ret;
 351                 }
 352         }
 353
 354         return 0;
 355 }
 356
 357 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size)
 358 {
 359         long chunk;
 360         int ret, readn;
 361
 362         readn = 0;
 363         while (size > 0) {
 364                 /* get chunk that can be read */
 365                 chunk = min((long)size, dfu->b_left);
 366                 /* consume */
 367                 if (chunk > 0) {
 368                         memcpy(buf, dfu->i_buf, chunk);
 369                         if (dfu_hash_algo)
 370                                 dfu_hash_algo->hash_update(dfu_hash_algo,
 371                                                            &dfu->crc, buf,
 372                                                            chunk, 0);
 373
 374                         dfu->i_buf += chunk;
 375                         dfu->b_left -= chunk;
 376                         size -= chunk;
 377                         buf += chunk;
 378                         readn += chunk;
 379                 }
 380
 381                 /* all done */
 382                 if (size > 0) {
 383                         /* no more to read */
 384                         if (dfu->r_left == 0)
 385                                 break;
 386
 387                         dfu->i_buf = dfu->i_buf_start;
 388                         dfu->b_left = dfu->i_buf_end - dfu->i_buf_start;
 389
 390                         /* got to read, but buffer is empty */
 391                         if (dfu->b_left > dfu->r_left)
 392                                 dfu->b_left = dfu->r_left;
 393                         ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf,
 394                                         &dfu->b_left);
 395                         if (ret != 0) {
 396                                 debug("%s: Read error!\n", __func__);
 397                                 return ret;
 398                         }
 399                         if (dfu->b_left == 0)
 400                                 break;
 401                         dfu->offset += dfu->b_left;
 402                         dfu->r_left -= dfu->b_left;
 403
 404                         puts("#");
 405                 }
 406         }
 407
 408         return readn;
 409 }
 410
 411 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num)
 412 {
 413         int ret = 0;
 414
 415         debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n",
 416                __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf);
 417
 418         ret = dfu_transaction_initiate(dfu, true);
 419         if (ret < 0)
 420                 return ret;
 421
 422         if (dfu->i_blk_seq_num != blk_seq_num) {
 423                 printf("%s: Wrong sequence number! [%d] [%d]\n",
 424                        __func__, dfu->i_blk_seq_num, blk_seq_num);
 425                 return -1;
 426         }
 427         /* handle rollover */
 428         dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff;
 429
 430         ret = dfu_read_buffer_fill(dfu, buf, size);
 431         if (ret < 0) {
 432                 printf("%s: Failed to fill buffer\n", __func__);
 433                 return -1;
 434         }
 435
 436         if (ret < size) {
 437                 if (dfu_hash_algo)
 438                         debug("%s: %s %s: 0x%x\n", __func__, dfu->name,
 439                               dfu_hash_algo->name, dfu->crc);
 440                 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n");
 441
 442                 dfu_transaction_cleanup(dfu);
 443         }
 444
 445         return ret;
 446 }
 447
 448 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt,
 449                            char *interface, char *devstr)
 450 {
 451         char *st;
 452
 453         debug("%s: %s interface: %s dev: %s\n", __func__, s, interface, devstr);
 454         st = strsep(&s, " ");
 455         strcpy(dfu->name, st);
 456
 457         dfu->alt = alt;
 458         dfu->max_buf_size = 0;
 459         dfu->free_entity = NULL;
 460
 461         /* Specific for mmc device */
 462         if (strcmp(interface, "mmc") == 0) {
 463                 if (dfu_fill_entity_mmc(dfu, devstr, s))
 464                         return -1;
 465         } else if (strcmp(interface, "mtd") == 0) {
 466                 if (dfu_fill_entity_mtd(dfu, devstr, s))
 467                         return -1;
 468         } else if (strcmp(interface, "nand") == 0) {
 469                 if (dfu_fill_entity_nand(dfu, devstr, s))
 470                         return -1;
 471         } else if (strcmp(interface, "ram") == 0) {
 472                 if (dfu_fill_entity_ram(dfu, devstr, s))
 473                         return -1;
 474         } else if (strcmp(interface, "sf") == 0) {
 475                 if (dfu_fill_entity_sf(dfu, devstr, s))
 476                         return -1;
 477         } else if (strcmp(interface, "virt") == 0) {
 478                 if (dfu_fill_entity_virt(dfu, devstr, s))
 479                         return -1;
 480         } else {
 481                 printf("%s: Device %s not (yet) supported!\n",
 482                        __func__,  interface);
 483                 return -1;
 484         }
 485         dfu_get_buf(dfu);
 486
 487         return 0;
 488 }
 489
 490 void dfu_free_entities(void)
 491 {
 492         struct dfu_entity *dfu, *p, *t = NULL;
 493
 494         dfu_free_buf();
 495         list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) {
 496                 list_del(&dfu->list);
 497                 if (dfu->free_entity)
 498                         dfu->free_entity(dfu);
 499                 t = dfu;
 500         }
 501         if (t)
 502                 free(t);
 503         INIT_LIST_HEAD(&dfu_list);
 504
 505         alt_num_cnt = 0;
 506 }
 507
 508 int dfu_alt_init(int num, struct dfu_entity **dfu)
 509 {
 510         char *s;
 511         int ret;
 512
 513         dfu_alt_num = num;
 514         debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num);
 515
 516         dfu_hash_algo = NULL;
 517         s = dfu_get_hash_algo();
 518         if (s) {
 519                 ret = hash_lookup_algo(s, &dfu_hash_algo);
 520                 if (ret)
 521                         pr_err("Hash algorithm %s not supported\n", s);
 522         }
 523
 524         *dfu = calloc(sizeof(struct dfu_entity), dfu_alt_num);
 525         if (!*dfu)
 526                 return -1;
 527
 528         return 0;
 529 }
 530
 531 int dfu_alt_add(struct dfu_entity *dfu, char *interface, char *devstr, char *s)
 532 {
 533         struct dfu_entity *p_dfu;
 534         int ret;
 535
 536         if (alt_num_cnt >= dfu_alt_num)
 537                 return -1;
 538
 539         p_dfu = &dfu[alt_num_cnt];
 540         ret = dfu_fill_entity(p_dfu, s, alt_num_cnt, interface, devstr);
 541         if (ret)
 542                 return -1;
 543
 544         list_add_tail(&p_dfu->list, &dfu_list);
 545         alt_num_cnt++;
 546
 547         return 0;
 548 }
 549
 550 int dfu_config_entities(char *env, char *interface, char *devstr)
 551 {
 552         struct dfu_entity *dfu;
 553         int i, ret;
 554         char *s;
 555
 556         ret = dfu_alt_init(dfu_find_alt_num(env), &dfu);
 557         if (ret)
 558                 return -1;
 559
 560         for (i = 0; i < dfu_alt_num; i++) {
 561                 s = strsep(&env, ";");
 562                 ret = dfu_alt_add(dfu, interface, devstr, s);
 563                 if (ret) {
 564                         /* We will free "dfu" in dfu_free_entities() */
 565                         return -1;
 566                 }
 567         }
 568
 569         return 0;
 570 }
 571
 572 const char *dfu_get_dev_type(enum dfu_device_type t)
 573 {
 574         const char *const dev_t[] = {NULL, "eMMC", "OneNAND", "NAND", "RAM",
 575                                      "SF", "MTD", "VIRT"};
 576         return dev_t[t];
 577 }
 578
 579 const char *dfu_get_layout(enum dfu_layout l)
 580 {
 581         const char *const dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2",
 582                                           "EXT3", "EXT4", "RAM_ADDR" };
 583         return dfu_layout[l];
 584 }
 585
 586 void dfu_show_entities(void)
 587 {
 588         struct dfu_entity *dfu;
 589
 590         puts("DFU alt settings list:\n");
 591
 592         list_for_each_entry(dfu, &dfu_list, list) {
 593                 printf("dev: %s alt: %d name: %s layout: %s\n",
 594                        dfu_get_dev_type(dfu->dev_type), dfu->alt,
 595                        dfu->name, dfu_get_layout(dfu->layout));
 596         }
 597 }
 598
 599 int dfu_get_alt_number(void)
 600 {
 601         return dfu_alt_num;
 602 }
 603
 604 struct dfu_entity *dfu_get_entity(int alt)
 605 {
 606         struct dfu_entity *dfu;
 607
 608         list_for_each_entry(dfu, &dfu_list, list) {
 609                 if (dfu->alt == alt)
 610                         return dfu;
 611         }
 612
 613         return NULL;
 614 }
 615
 616 int dfu_get_alt(char *name)
 617 {
 618         struct dfu_entity *dfu;
 619         char *str;
 620
 621         list_for_each_entry(dfu, &dfu_list, list) {
 622                 if (dfu->name[0] != '/') {
 623                         if (!strncmp(dfu->name, name, strlen(dfu->name)))
 624                                 return dfu->alt;
 625                 } else {
 626                         /*
 627                          * One must also consider absolute path
 628                          * (/boot/bin/uImage) available at dfu->name when
 629                          * compared "plain" file name (uImage)
 630                          *
 631                          * It is the case for e.g. thor gadget where lthor SW
 632                          * sends only the file name, so only the very last part
 633                          * of path must be checked for equality
 634                          */
 635
 636                         str = strstr(dfu->name, name);
 637                         if (!str)
 638                                 continue;
 639
 640                         /*
 641                          * Check if matching substring is the last element of
 642                          * dfu->name (uImage)
 643                          */
 644                         if (strlen(dfu->name) ==
 645                             ((str - dfu->name) + strlen(name)))
 646                                 return dfu->alt;
 647                 }
 648         }
 649
 650         return -ENODEV;
 651 }
 652
 653 int dfu_write_from_mem_addr(struct dfu_entity *dfu, void *buf, int size)
 654 {
 655         unsigned long dfu_buf_size, write, left = size;
 656         int i, ret = 0;
 657         void *dp = buf;
 658
 659         /*
 660          * Here we must call dfu_get_buf(dfu) first to be sure that dfu_buf_size
 661          * has been properly initialized - e.g. if "dfu_bufsiz" has been taken
 662          * into account.
 663          */
 664         dfu_get_buf(dfu);
 665         dfu_buf_size = dfu_get_buf_size();
 666         debug("%s: dfu buf size: %lu\n", __func__, dfu_buf_size);
 667
 668         for (i = 0; left > 0; i++) {
 669                 write = min(dfu_buf_size, left);
 670
 671                 debug("%s: dp: 0x%p left: %lu write: %lu\n", __func__,
 672                       dp, left, write);
 673                 ret = dfu_write(dfu, dp, write, i);
 674                 if (ret) {
 675                         pr_err("DFU write failed\n");
 676                         return ret;
 677                 }
 678
 679                 dp += write;
 680                 left -= write;
 681         }
 682
 683         ret = dfu_flush(dfu, NULL, 0, i);
 684         if (ret)
 685                 pr_err("DFU flush failed!");
 686
 687         return ret;
 688 }