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