drivers/dfu/dfu_mmc.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 <[email protected]>
   7  */
   8
   9 #include <common.h>
  10 #include <malloc.h>
  11 #include <errno.h>
  12 #include <div64.h>
  13 #include <dfu.h>
  14 #include <ext4fs.h>
  15 #include <fat.h>
  16 #include <mmc.h>
  17
  18 static unsigned char *dfu_file_buf;
  19 static u64 dfu_file_buf_len;
  20 static long dfu_file_buf_filled;
  21
  22 static int mmc_block_op(enum dfu_op op, struct dfu_entity *dfu,
  23                         u64 offset, void *buf, long *len)
  24 {
  25         struct mmc *mmc;
  26         u32 blk_start, blk_count, n = 0;
  27         int ret, part_num_bkp = 0;
  28
  29         mmc = find_mmc_device(dfu->data.mmc.dev_num);
  30         if (!mmc) {
  31                 pr_err("Device MMC %d - not found!", dfu->data.mmc.dev_num);
  32                 return -ENODEV;
  33         }
  34
  35         /*
  36          * We must ensure that we work in lba_blk_size chunks, so ALIGN
  37          * this value.
  38          */
  39         *len = ALIGN(*len, dfu->data.mmc.lba_blk_size);
  40
  41         blk_start = dfu->data.mmc.lba_start +
  42                         (u32)lldiv(offset, dfu->data.mmc.lba_blk_size);
  43         blk_count = *len / dfu->data.mmc.lba_blk_size;
  44         if (blk_start + blk_count >
  45                         dfu->data.mmc.lba_start + dfu->data.mmc.lba_size) {
  46                 puts("Request would exceed designated area!\n");
  47                 return -EINVAL;
  48         }
  49
  50         if (dfu->data.mmc.hw_partition >= 0) {
  51                 part_num_bkp = mmc_get_blk_desc(mmc)->hwpart;
  52                 ret = blk_select_hwpart_devnum(IF_TYPE_MMC,
  53                                                dfu->data.mmc.dev_num,
  54                                                dfu->data.mmc.hw_partition);
  55                 if (ret)
  56                         return ret;
  57         }
  58
  59         debug("%s: %s dev: %d start: %d cnt: %d buf: 0x%p\n", __func__,
  60               op == DFU_OP_READ ? "MMC READ" : "MMC WRITE",
  61               dfu->data.mmc.dev_num, blk_start, blk_count, buf);
  62         switch (op) {
  63         case DFU_OP_READ:
  64                 n = blk_dread(mmc_get_blk_desc(mmc), blk_start, blk_count, buf);
  65                 break;
  66         case DFU_OP_WRITE:
  67                 n = blk_dwrite(mmc_get_blk_desc(mmc), blk_start, blk_count,
  68                                buf);
  69                 break;
  70         default:
  71                 pr_err("Operation not supported\n");
  72         }
  73
  74         if (n != blk_count) {
  75                 pr_err("MMC operation failed");
  76                 if (dfu->data.mmc.hw_partition >= 0)
  77                         blk_select_hwpart_devnum(IF_TYPE_MMC,
  78                                                  dfu->data.mmc.dev_num,
  79                                                  part_num_bkp);
  80                 return -EIO;
  81         }
  82
  83         if (dfu->data.mmc.hw_partition >= 0) {
  84                 ret = blk_select_hwpart_devnum(IF_TYPE_MMC,
  85                                                dfu->data.mmc.dev_num,
  86                                                part_num_bkp);
  87                 if (ret)
  88                         return ret;
  89         }
  90
  91         return 0;
  92 }
  93
  94 static int mmc_file_op(enum dfu_op op, struct dfu_entity *dfu,
  95                         u64 offset, void *buf, u64 *len)
  96 {
  97         char dev_part_str[8];
  98         int ret;
  99         int fstype;
 100         loff_t size = 0;
 101
 102         switch (dfu->layout) {
 103         case DFU_FS_FAT:
 104                 fstype = FS_TYPE_FAT;
 105                 break;
 106         case DFU_FS_EXT4:
 107                 fstype = FS_TYPE_EXT;
 108                 break;
 109         default:
 110                 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
 111                        dfu_get_layout(dfu->layout));
 112                 return -1;
 113         }
 114
 115         snprintf(dev_part_str, sizeof(dev_part_str), "%d:%d",
 116                  dfu->data.mmc.dev, dfu->data.mmc.part);
 117
 118         ret = fs_set_blk_dev("mmc", dev_part_str, fstype);
 119         if (ret) {
 120                 puts("dfu: fs_set_blk_dev error!\n");
 121                 return ret;
 122         }
 123
 124         switch (op) {
 125         case DFU_OP_READ:
 126                 ret = fs_read(dfu->name, (size_t)buf, offset, 0, &size);
 127                 if (ret) {
 128                         puts("dfu: fs_read error!\n");
 129                         return ret;
 130                 }
 131                 *len = size;
 132                 break;
 133         case DFU_OP_WRITE:
 134                 ret = fs_write(dfu->name, (size_t)buf, offset, *len, &size);
 135                 if (ret) {
 136                         puts("dfu: fs_write error!\n");
 137                         return ret;
 138                 }
 139                 break;
 140         case DFU_OP_SIZE:
 141                 ret = fs_size(dfu->name, &size);
 142                 if (ret) {
 143                         puts("dfu: fs_size error!\n");
 144                         return ret;
 145                 }
 146                 *len = size;
 147                 break;
 148         default:
 149                 return -1;
 150         }
 151
 152         return ret;
 153 }
 154
 155 static int mmc_file_buf_write(struct dfu_entity *dfu, u64 offset, void *buf, long *len)
 156 {
 157         if (dfu_file_buf_len + *len > CONFIG_SYS_DFU_MAX_FILE_SIZE) {
 158                 dfu_file_buf_len = 0;
 159                 return -EINVAL;
 160         }
 161
 162         /* Add to the current buffer. */
 163         memcpy(dfu_file_buf + dfu_file_buf_len, buf, *len);
 164         dfu_file_buf_len += *len;
 165
 166         return 0;
 167 }
 168
 169 static int mmc_file_buf_write_finish(struct dfu_entity *dfu)
 170 {
 171         int ret = mmc_file_op(DFU_OP_WRITE, dfu, 0, dfu_file_buf,
 172                         &dfu_file_buf_len);
 173
 174         /* Now that we're done */
 175         dfu_file_buf_len = 0;
 176         return ret;
 177 }
 178
 179 int dfu_write_medium_mmc(struct dfu_entity *dfu,
 180                 u64 offset, void *buf, long *len)
 181 {
 182         int ret = -1;
 183
 184         switch (dfu->layout) {
 185         case DFU_RAW_ADDR:
 186                 ret = mmc_block_op(DFU_OP_WRITE, dfu, offset, buf, len);
 187                 break;
 188         case DFU_FS_FAT:
 189         case DFU_FS_EXT4:
 190                 ret = mmc_file_buf_write(dfu, offset, buf, len);
 191                 break;
 192         default:
 193                 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
 194                        dfu_get_layout(dfu->layout));
 195         }
 196
 197         return ret;
 198 }
 199
 200 int dfu_flush_medium_mmc(struct dfu_entity *dfu)
 201 {
 202         int ret = 0;
 203
 204         if (dfu->layout != DFU_RAW_ADDR) {
 205                 /* Do stuff here. */
 206                 ret = mmc_file_buf_write_finish(dfu);
 207         }
 208
 209         return ret;
 210 }
 211
 212 int dfu_get_medium_size_mmc(struct dfu_entity *dfu, u64 *size)
 213 {
 214         int ret;
 215
 216         switch (dfu->layout) {
 217         case DFU_RAW_ADDR:
 218                 *size = dfu->data.mmc.lba_size * dfu->data.mmc.lba_blk_size;
 219                 return 0;
 220         case DFU_FS_FAT:
 221         case DFU_FS_EXT4:
 222                 dfu_file_buf_filled = -1;
 223                 ret = mmc_file_op(DFU_OP_SIZE, dfu, 0, NULL, size);
 224                 if (ret < 0)
 225                         return ret;
 226                 if (*size > CONFIG_SYS_DFU_MAX_FILE_SIZE)
 227                         return -1;
 228                 return 0;
 229         default:
 230                 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
 231                        dfu_get_layout(dfu->layout));
 232                 return -1;
 233         }
 234 }
 235
 236
 237 static int mmc_file_buf_read(struct dfu_entity *dfu, u64 offset, void *buf,
 238                              long *len)
 239 {
 240         int ret;
 241         u64 file_len;
 242
 243         if (dfu_file_buf_filled == -1) {
 244                 ret = mmc_file_op(DFU_OP_READ, dfu, 0, dfu_file_buf, &file_len);
 245                 if (ret < 0)
 246                         return ret;
 247                 dfu_file_buf_filled = file_len;
 248         }
 249         if (offset + *len > dfu_file_buf_filled)
 250                 return -EINVAL;
 251
 252         /* Add to the current buffer. */
 253         memcpy(buf, dfu_file_buf + offset, *len);
 254
 255         return 0;
 256 }
 257
 258 int dfu_read_medium_mmc(struct dfu_entity *dfu, u64 offset, void *buf,
 259                 long *len)
 260 {
 261         int ret = -1;
 262
 263         switch (dfu->layout) {
 264         case DFU_RAW_ADDR:
 265                 ret = mmc_block_op(DFU_OP_READ, dfu, offset, buf, len);
 266                 break;
 267         case DFU_FS_FAT:
 268         case DFU_FS_EXT4:
 269                 ret = mmc_file_buf_read(dfu, offset, buf, len);
 270                 break;
 271         default:
 272                 printf("%s: Layout (%s) not (yet) supported!\n", __func__,
 273                        dfu_get_layout(dfu->layout));
 274         }
 275
 276         return ret;
 277 }
 278
 279 void dfu_free_entity_mmc(struct dfu_entity *dfu)
 280 {
 281         if (dfu_file_buf) {
 282                 free(dfu_file_buf);
 283                 dfu_file_buf = NULL;
 284         }
 285 }
 286
 287 /*
 288  * @param s Parameter string containing space-separated arguments:
 289  *      1st:
 290  *              raw     (raw read/write)
 291  *              fat     (files)
 292  *              ext4    (^)
 293  *              part    (partition image)
 294  *      2nd and 3rd:
 295  *              lba_start and lba_size, for raw write
 296  *              mmc_dev and mmc_part, for filesystems and part
 297  *      4th (optional):
 298  *              mmcpart <num> (access to HW eMMC partitions)
 299  */
 300 int dfu_fill_entity_mmc(struct dfu_entity *dfu, char *devstr, char *s)
 301 {
 302         const char *entity_type;
 303         size_t second_arg;
 304         size_t third_arg;
 305
 306         struct mmc *mmc;
 307
 308         const char *argv[3];
 309         const char **parg = argv;
 310
 311         dfu->data.mmc.dev_num = simple_strtoul(devstr, NULL, 10);
 312
 313         for (; parg < argv + sizeof(argv) / sizeof(*argv); ++parg) {
 314                 *parg = strsep(&s, " ");
 315                 if (*parg == NULL) {
 316                         pr_err("Invalid number of arguments.\n");
 317                         return -ENODEV;
 318                 }
 319         }
 320
 321         entity_type = argv[0];
 322         /*
 323          * Base 0 means we'll accept (prefixed with 0x or 0) base 16, 8,
 324          * with default 10.
 325          */
 326         second_arg = simple_strtoul(argv[1], NULL, 0);
 327         third_arg = simple_strtoul(argv[2], NULL, 0);
 328
 329         mmc = find_mmc_device(dfu->data.mmc.dev_num);
 330         if (mmc == NULL) {
 331                 pr_err("Couldn't find MMC device no. %d.\n",
 332                       dfu->data.mmc.dev_num);
 333                 return -ENODEV;
 334         }
 335
 336         if (mmc_init(mmc)) {
 337                 pr_err("Couldn't init MMC device.\n");
 338                 return -ENODEV;
 339         }
 340
 341         dfu->data.mmc.hw_partition = -EINVAL;
 342         if (!strcmp(entity_type, "raw")) {
 343                 dfu->layout                     = DFU_RAW_ADDR;
 344                 dfu->data.mmc.lba_start         = second_arg;
 345                 dfu->data.mmc.lba_size          = third_arg;
 346                 dfu->data.mmc.lba_blk_size      = mmc->read_bl_len;
 347
 348                 /*
 349                  * Check for an extra entry at dfu_alt_info env variable
 350                  * specifying the mmc HW defined partition number
 351                  */
 352                 if (s)
 353                         if (!strcmp(strsep(&s, " "), "mmcpart"))
 354                                 dfu->data.mmc.hw_partition =
 355                                         simple_strtoul(s, NULL, 0);
 356
 357         } else if (!strcmp(entity_type, "part")) {
 358                 disk_partition_t partinfo;
 359                 struct blk_desc *blk_dev = mmc_get_blk_desc(mmc);
 360                 int mmcdev = second_arg;
 361                 int mmcpart = third_arg;
 362                 int offset = 0;
 363
 364                 if (part_get_info(blk_dev, mmcpart, &partinfo) != 0) {
 365                         pr_err("Couldn't find part #%d on mmc device #%d\n",
 366                               mmcpart, mmcdev);
 367                         return -ENODEV;
 368                 }
 369
 370                 /*
 371                  * Check for an extra entry at dfu_alt_info env variable
 372                  * specifying the mmc HW defined partition number
 373                  */
 374                 if (s)
 375                         if (!strcmp(strsep(&s, " "), "offset"))
 376                                 offset = simple_strtoul(s, NULL, 0);
 377
 378                 dfu->layout                     = DFU_RAW_ADDR;
 379                 dfu->data.mmc.lba_start         = partinfo.start + offset;
 380                 dfu->data.mmc.lba_size          = partinfo.size-offset;
 381                 dfu->data.mmc.lba_blk_size      = partinfo.blksz;
 382         } else if (!strcmp(entity_type, "fat")) {
 383                 dfu->layout = DFU_FS_FAT;
 384         } else if (!strcmp(entity_type, "ext4")) {
 385                 dfu->layout = DFU_FS_EXT4;
 386         } else {
 387                 pr_err("Memory layout (%s) not supported!\n", entity_type);
 388                 return -ENODEV;
 389         }
 390
 391         /* if it's NOT a raw write */
 392         if (strcmp(entity_type, "raw")) {
 393                 dfu->data.mmc.dev = second_arg;
 394                 dfu->data.mmc.part = third_arg;
 395         }
 396
 397         dfu->dev_type = DFU_DEV_MMC;
 398         dfu->get_medium_size = dfu_get_medium_size_mmc;
 399         dfu->read_medium = dfu_read_medium_mmc;
 400         dfu->write_medium = dfu_write_medium_mmc;
 401         dfu->flush_medium = dfu_flush_medium_mmc;
 402         dfu->inited = 0;
 403         dfu->free_entity = dfu_free_entity_mmc;
 404
 405         /* Check if file buffer is ready */
 406         if (!dfu_file_buf) {
 407                 dfu_file_buf = memalign(CONFIG_SYS_CACHELINE_SIZE,
 408                                         CONFIG_SYS_DFU_MAX_FILE_SIZE);
 409                 if (!dfu_file_buf) {
 410                         pr_err("Could not memalign 0x%x bytes",
 411                               CONFIG_SYS_DFU_MAX_FILE_SIZE);
 412                         return -ENOMEM;
 413                 }
 414         }
 415
 416         return 0;
 417 }