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