drivers/dfu/dfu.c

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