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 <linux/list.h> 17 #include <linux/compiler.h> 18 19 static LIST_HEAD(dfu_list); 20 static int dfu_alt_num; 21 22 static int dfu_find_alt_num(const char *s) 23 { 24 int i = 0; 25 26 for (; *s; s++) 27 if (*s == ';') 28 i++; 29 30 return ++i; 31 } 32 33 static unsigned char *dfu_buf; 34 static unsigned long dfu_buf_size = CONFIG_SYS_DFU_DATA_BUF_SIZE; 35 36 static unsigned char *dfu_free_buf(void) 37 { 38 free(dfu_buf); 39 dfu_buf = NULL; 40 return dfu_buf; 41 } 42 43 static unsigned char *dfu_get_buf(void) 44 { 45 char *s; 46 47 if (dfu_buf != NULL) 48 return dfu_buf; 49 50 s = getenv("dfu_bufsiz"); 51 dfu_buf_size = s ? (unsigned long)simple_strtol(s, NULL, 16) : 52 CONFIG_SYS_DFU_DATA_BUF_SIZE; 53 54 dfu_buf = memalign(CONFIG_SYS_CACHELINE_SIZE, dfu_buf_size); 55 if (dfu_buf == NULL) 56 printf("%s: Could not memalign 0x%lx bytes\n", 57 __func__, dfu_buf_size); 58 59 return dfu_buf; 60 } 61 62 static int dfu_write_buffer_drain(struct dfu_entity *dfu) 63 { 64 long w_size; 65 int ret; 66 67 /* flush size? */ 68 w_size = dfu->i_buf - dfu->i_buf_start; 69 if (w_size == 0) 70 return 0; 71 72 /* update CRC32 */ 73 dfu->crc = crc32(dfu->crc, dfu->i_buf_start, w_size); 74 75 ret = dfu->write_medium(dfu, dfu->offset, dfu->i_buf_start, &w_size); 76 if (ret) 77 debug("%s: Write error!\n", __func__); 78 79 /* point back */ 80 dfu->i_buf = dfu->i_buf_start; 81 82 /* update offset */ 83 dfu->offset += w_size; 84 85 puts("#"); 86 87 return ret; 88 } 89 90 int dfu_write(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num) 91 { 92 int ret = 0; 93 int tret; 94 95 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x offset: 0x%llx bufoffset: 0x%x\n", 96 __func__, dfu->name, buf, size, blk_seq_num, dfu->offset, 97 dfu->i_buf - dfu->i_buf_start); 98 99 if (!dfu->inited) { 100 /* initial state */ 101 dfu->crc = 0; 102 dfu->offset = 0; 103 dfu->bad_skip = 0; 104 dfu->i_blk_seq_num = 0; 105 dfu->i_buf_start = dfu_get_buf(); 106 if (dfu->i_buf_start == NULL) 107 return -ENOMEM; 108 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size; 109 dfu->i_buf = dfu->i_buf_start; 110 111 dfu->inited = 1; 112 } 113 114 if (dfu->i_blk_seq_num != blk_seq_num) { 115 printf("%s: Wrong sequence number! [%d] [%d]\n", 116 __func__, dfu->i_blk_seq_num, blk_seq_num); 117 return -1; 118 } 119 120 /* DFU 1.1 standard says: 121 * The wBlockNum field is a block sequence number. It increments each 122 * time a block is transferred, wrapping to zero from 65,535. It is used 123 * to provide useful context to the DFU loader in the device." 124 * 125 * This means that it's a 16 bit counter that roll-overs at 126 * 0xffff -> 0x0000. By having a typical 4K transfer block 127 * we roll-over at exactly 256MB. Not very fun to debug. 128 * 129 * Handling rollover, and having an inited variable, 130 * makes things work. 131 */ 132 133 /* handle rollover */ 134 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff; 135 136 /* flush buffer if overflow */ 137 if ((dfu->i_buf + size) > dfu->i_buf_end) { 138 tret = dfu_write_buffer_drain(dfu); 139 if (ret == 0) 140 ret = tret; 141 } 142 143 /* we should be in buffer now (if not then size too large) */ 144 if ((dfu->i_buf + size) > dfu->i_buf_end) { 145 printf("%s: Wrong size! [%d] [%d] - %d\n", 146 __func__, dfu->i_blk_seq_num, blk_seq_num, size); 147 return -1; 148 } 149 150 memcpy(dfu->i_buf, buf, size); 151 dfu->i_buf += size; 152 153 /* if end or if buffer full flush */ 154 if (size == 0 || (dfu->i_buf + size) > dfu->i_buf_end) { 155 tret = dfu_write_buffer_drain(dfu); 156 if (ret == 0) 157 ret = tret; 158 } 159 160 /* end? */ 161 if (size == 0) { 162 /* Now try and flush to the medium if needed. */ 163 if (dfu->flush_medium) 164 ret = dfu->flush_medium(dfu); 165 printf("\nDFU complete CRC32: 0x%08x\n", dfu->crc); 166 167 /* clear everything */ 168 dfu_free_buf(); 169 dfu->crc = 0; 170 dfu->offset = 0; 171 dfu->i_blk_seq_num = 0; 172 dfu->i_buf_start = dfu_buf; 173 dfu->i_buf_end = dfu_buf; 174 dfu->i_buf = dfu->i_buf_start; 175 176 dfu->inited = 0; 177 178 } 179 180 return ret = 0 ? size : ret; 181 } 182 183 static int dfu_read_buffer_fill(struct dfu_entity *dfu, void *buf, int size) 184 { 185 long chunk; 186 int ret, readn; 187 188 readn = 0; 189 while (size > 0) { 190 /* get chunk that can be read */ 191 chunk = min(size, dfu->b_left); 192 /* consume */ 193 if (chunk > 0) { 194 memcpy(buf, dfu->i_buf, chunk); 195 dfu->crc = crc32(dfu->crc, buf, chunk); 196 dfu->i_buf += chunk; 197 dfu->b_left -= chunk; 198 size -= chunk; 199 buf += chunk; 200 readn += chunk; 201 } 202 203 /* all done */ 204 if (size > 0) { 205 /* no more to read */ 206 if (dfu->r_left == 0) 207 break; 208 209 dfu->i_buf = dfu->i_buf_start; 210 dfu->b_left = dfu->i_buf_end - dfu->i_buf_start; 211 212 /* got to read, but buffer is empty */ 213 if (dfu->b_left > dfu->r_left) 214 dfu->b_left = dfu->r_left; 215 ret = dfu->read_medium(dfu, dfu->offset, dfu->i_buf, 216 &dfu->b_left); 217 if (ret != 0) { 218 debug("%s: Read error!\n", __func__); 219 return ret; 220 } 221 dfu->offset += dfu->b_left; 222 dfu->r_left -= dfu->b_left; 223 224 puts("#"); 225 } 226 } 227 228 return readn; 229 } 230 231 int dfu_read(struct dfu_entity *dfu, void *buf, int size, int blk_seq_num) 232 { 233 int ret = 0; 234 235 debug("%s: name: %s buf: 0x%p size: 0x%x p_num: 0x%x i_buf: 0x%p\n", 236 __func__, dfu->name, buf, size, blk_seq_num, dfu->i_buf); 237 238 if (!dfu->inited) { 239 dfu->i_buf_start = dfu_get_buf(); 240 if (dfu->i_buf_start == NULL) 241 return -ENOMEM; 242 243 ret = dfu->read_medium(dfu, 0, dfu->i_buf_start, &dfu->r_left); 244 if (ret != 0) { 245 debug("%s: failed to get r_left\n", __func__); 246 return ret; 247 } 248 249 debug("%s: %s %ld [B]\n", __func__, dfu->name, dfu->r_left); 250 251 dfu->i_blk_seq_num = 0; 252 dfu->crc = 0; 253 dfu->offset = 0; 254 dfu->i_buf_end = dfu_get_buf() + dfu_buf_size; 255 dfu->i_buf = dfu->i_buf_start; 256 dfu->b_left = 0; 257 258 dfu->bad_skip = 0; 259 260 dfu->inited = 1; 261 } 262 263 if (dfu->i_blk_seq_num != blk_seq_num) { 264 printf("%s: Wrong sequence number! [%d] [%d]\n", 265 __func__, dfu->i_blk_seq_num, blk_seq_num); 266 return -1; 267 } 268 /* handle rollover */ 269 dfu->i_blk_seq_num = (dfu->i_blk_seq_num + 1) & 0xffff; 270 271 ret = dfu_read_buffer_fill(dfu, buf, size); 272 if (ret < 0) { 273 printf("%s: Failed to fill buffer\n", __func__); 274 return -1; 275 } 276 277 if (ret < size) { 278 debug("%s: %s CRC32: 0x%x\n", __func__, dfu->name, dfu->crc); 279 puts("\nUPLOAD ... done\nCtrl+C to exit ...\n"); 280 281 dfu_free_buf(); 282 dfu->i_blk_seq_num = 0; 283 dfu->crc = 0; 284 dfu->offset = 0; 285 dfu->i_buf_start = dfu_buf; 286 dfu->i_buf_end = dfu_buf; 287 dfu->i_buf = dfu->i_buf_start; 288 dfu->b_left = 0; 289 290 dfu->bad_skip = 0; 291 292 dfu->inited = 0; 293 } 294 295 return ret; 296 } 297 298 static int dfu_fill_entity(struct dfu_entity *dfu, char *s, int alt, 299 char *interface, int num) 300 { 301 char *st; 302 303 debug("%s: %s interface: %s num: %d\n", __func__, s, interface, num); 304 st = strsep(&s, " "); 305 strcpy(dfu->name, st); 306 307 dfu->dev_num = num; 308 dfu->alt = alt; 309 310 /* Specific for mmc device */ 311 if (strcmp(interface, "mmc") == 0) { 312 if (dfu_fill_entity_mmc(dfu, s)) 313 return -1; 314 } else if (strcmp(interface, "nand") == 0) { 315 if (dfu_fill_entity_nand(dfu, s)) 316 return -1; 317 } else { 318 printf("%s: Device %s not (yet) supported!\n", 319 __func__, interface); 320 return -1; 321 } 322 323 return 0; 324 } 325 326 void dfu_free_entities(void) 327 { 328 struct dfu_entity *dfu, *p, *t = NULL; 329 330 list_for_each_entry_safe_reverse(dfu, p, &dfu_list, list) { 331 list_del(&dfu->list); 332 t = dfu; 333 } 334 if (t) 335 free(t); 336 INIT_LIST_HEAD(&dfu_list); 337 } 338 339 int dfu_config_entities(char *env, char *interface, int num) 340 { 341 struct dfu_entity *dfu; 342 int i, ret; 343 char *s; 344 345 dfu_alt_num = dfu_find_alt_num(env); 346 debug("%s: dfu_alt_num=%d\n", __func__, dfu_alt_num); 347 348 dfu = calloc(sizeof(*dfu), dfu_alt_num); 349 if (!dfu) 350 return -1; 351 for (i = 0; i < dfu_alt_num; i++) { 352 353 s = strsep(&env, ";"); 354 ret = dfu_fill_entity(&dfu[i], s, i, interface, num); 355 if (ret) 356 return -1; 357 358 list_add_tail(&dfu[i].list, &dfu_list); 359 } 360 361 return 0; 362 } 363 364 const char *dfu_get_dev_type(enum dfu_device_type t) 365 { 366 const char *dev_t[] = {NULL, "eMMC", "OneNAND", "NAND" }; 367 return dev_t[t]; 368 } 369 370 const char *dfu_get_layout(enum dfu_layout l) 371 { 372 const char *dfu_layout[] = {NULL, "RAW_ADDR", "FAT", "EXT2", 373 "EXT3", "EXT4" }; 374 return dfu_layout[l]; 375 } 376 377 void dfu_show_entities(void) 378 { 379 struct dfu_entity *dfu; 380 381 puts("DFU alt settings list:\n"); 382 383 list_for_each_entry(dfu, &dfu_list, list) { 384 printf("dev: %s alt: %d name: %s layout: %s\n", 385 dfu_get_dev_type(dfu->dev_type), dfu->alt, 386 dfu->name, dfu_get_layout(dfu->layout)); 387 } 388 } 389 390 int dfu_get_alt_number(void) 391 { 392 return dfu_alt_num; 393 } 394 395 struct dfu_entity *dfu_get_entity(int alt) 396 { 397 struct dfu_entity *dfu; 398 399 list_for_each_entry(dfu, &dfu_list, list) { 400 if (dfu->alt == alt) 401 return dfu; 402 } 403 404 return NULL; 405 } 406