lib/image-sparse.c

   1 /*
   2  * Copyright (c) 2009, Google Inc.
   3  * All rights reserved.
   4  *
   5  * Copyright (c) 2009-2014, The Linux Foundation. All rights reserved.
   6  * Portions Copyright 2014 Broadcom Corporation.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions are met:
  10  *     * Redistributions of source code must retain the above copyright
  11  *       notice, this list of conditions and the following disclaimer.
  12  *     * Redistributions in binary form must reproduce the above copyright
  13  *       notice, this list of conditions and the following disclaimer in the
  14  *       documentation and/or other materials provided with the distribution.
  15  *     * Neither the name of The Linux Foundation nor
  16  *       the names of its contributors may be used to endorse or promote
  17  *       products derived from this software without specific prior written
  18  *       permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  23  * NON-INFRINGEMENT ARE DISCLAIMED.  IN NO EVENT SHALL THE COPYRIGHT OWNER OR
  24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
  27  * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
  28  * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
  29  * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
  30  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  31  *
  32  * NOTE:
  33  *   Although it is very similar, this license text is not identical
  34  *   to the "BSD-3-Clause", therefore, DO NOT MODIFY THIS LICENSE TEXT!
  35  */
  36
  37 #include <config.h>
  38 #include <common.h>
  39 #include <blk.h>
  40 #include <image-sparse.h>
  41 #include <div64.h>
  42 #include <log.h>
  43 #include <malloc.h>
  44 #include <part.h>
  45 #include <sparse_format.h>
  46 #include <asm/cache.h>
  47
  48 #include <linux/math64.h>
  49 #include <linux/err.h>
  50
  51 static void default_log(const char *ignored, char *response) {}
  52
  53 static lbaint_t write_sparse_chunk_raw(struct sparse_storage *info,
  54                                        lbaint_t blk, lbaint_t blkcnt,
  55                                        void *data,
  56                                        char *response)
  57 {
  58         lbaint_t n = blkcnt, write_blks, blks = 0;
  59         lbaint_t aligned_buf_blks = FASTBOOT_MAX_BLK_WRITE;
  60         uint32_t *aligned_buf = NULL;
  61
  62         if (CONFIG_IS_ENABLED(SYS_DCACHE_OFF)) {
  63                 write_blks = info->write(info, blk, n, data);
  64                 if (write_blks < n)
  65                         goto write_fail;
  66
  67                 return write_blks;
  68         }
  69
  70         aligned_buf = memalign(ARCH_DMA_MINALIGN, info->blksz * aligned_buf_blks);
  71         if (!aligned_buf) {
  72                 info->mssg("Malloc failed for: CHUNK_TYPE_RAW", response);
  73                 return -ENOMEM;
  74         }
  75
  76         while (blkcnt > 0) {
  77                 n = min(aligned_buf_blks, blkcnt);
  78                 memcpy(aligned_buf, data, n * info->blksz);
  79
  80                 /* write_blks might be > n due to NAND bad-blocks */
  81                 write_blks = info->write(info, blk + blks, n, aligned_buf);
  82                 if (write_blks < n) {
  83                         free(aligned_buf);
  84                         goto write_fail;
  85                 }
  86
  87                 blks += write_blks;
  88                 data += n * info->blksz;
  89                 blkcnt -= n;
  90         }
  91
  92         free(aligned_buf);
  93         return blks;
  94
  95 write_fail:
  96         if (IS_ERR_VALUE(write_blks)) {
  97                 printf("%s: Write failed, block #" LBAFU " [" LBAFU "] (%lld)\n",
  98                        __func__, blk + blks, n, (long long)write_blks);
  99                 info->mssg("flash write failure", response);
 100                 return write_blks;
 101         }
 102
 103         /* write_blks < n */
 104         printf("%s: Write failed, block #" LBAFU " [" LBAFU "]\n",
 105                __func__, blk + blks, n);
 106         info->mssg("flash write failure(incomplete)", response);
 107         return -1;
 108 }
 109
 110 int write_sparse_image(struct sparse_storage *info,
 111                        const char *part_name, void *data, char *response)
 112 {
 113         lbaint_t blk;
 114         lbaint_t blkcnt;
 115         lbaint_t blks;
 116         uint64_t bytes_written = 0;
 117         unsigned int chunk;
 118         unsigned int offset;
 119         uint64_t chunk_data_sz;
 120         uint32_t *fill_buf = NULL;
 121         uint32_t fill_val;
 122         sparse_header_t *sparse_header;
 123         chunk_header_t *chunk_header;
 124         uint32_t total_blocks = 0;
 125         int fill_buf_num_blks;
 126         int i;
 127         int j;
 128
 129         fill_buf_num_blks = CONFIG_IMAGE_SPARSE_FILLBUF_SIZE / info->blksz;
 130
 131         /* Read and skip over sparse image header */
 132         sparse_header = (sparse_header_t *)data;
 133
 134         data += sparse_header->file_hdr_sz;
 135         if (sparse_header->file_hdr_sz > sizeof(sparse_header_t)) {
 136                 /*
 137                  * Skip the remaining bytes in a header that is longer than
 138                  * we expected.
 139                  */
 140                 data += (sparse_header->file_hdr_sz - sizeof(sparse_header_t));
 141         }
 142
 143         if (!info->mssg)
 144                 info->mssg = default_log;
 145
 146         debug("=== Sparse Image Header ===\n");
 147         debug("magic: 0x%x\n", sparse_header->magic);
 148         debug("major_version: 0x%x\n", sparse_header->major_version);
 149         debug("minor_version: 0x%x\n", sparse_header->minor_version);
 150         debug("file_hdr_sz: %d\n", sparse_header->file_hdr_sz);
 151         debug("chunk_hdr_sz: %d\n", sparse_header->chunk_hdr_sz);
 152         debug("blk_sz: %d\n", sparse_header->blk_sz);
 153         debug("total_blks: %d\n", sparse_header->total_blks);
 154         debug("total_chunks: %d\n", sparse_header->total_chunks);
 155
 156         /*
 157          * Verify that the sparse block size is a multiple of our
 158          * storage backend block size
 159          */
 160         div_u64_rem(sparse_header->blk_sz, info->blksz, &offset);
 161         if (offset) {
 162                 printf("%s: Sparse image block size issue [%u]\n",
 163                        __func__, sparse_header->blk_sz);
 164                 info->mssg("sparse image block size issue", response);
 165                 return -1;
 166         }
 167
 168         puts("Flashing Sparse Image\n");
 169
 170         /* Start processing chunks */
 171         blk = info->start;
 172         for (chunk = 0; chunk < sparse_header->total_chunks; chunk++) {
 173                 /* Read and skip over chunk header */
 174                 chunk_header = (chunk_header_t *)data;
 175                 data += sizeof(chunk_header_t);
 176
 177                 if (chunk_header->chunk_type != CHUNK_TYPE_RAW) {
 178                         debug("=== Chunk Header ===\n");
 179                         debug("chunk_type: 0x%x\n", chunk_header->chunk_type);
 180                         debug("chunk_data_sz: 0x%x\n", chunk_header->chunk_sz);
 181                         debug("total_size: 0x%x\n", chunk_header->total_sz);
 182                 }
 183
 184                 if (sparse_header->chunk_hdr_sz > sizeof(chunk_header_t)) {
 185                         /*
 186                          * Skip the remaining bytes in a header that is longer
 187                          * than we expected.
 188                          */
 189                         data += (sparse_header->chunk_hdr_sz -
 190                                  sizeof(chunk_header_t));
 191                 }
 192
 193                 chunk_data_sz = ((u64)sparse_header->blk_sz) * chunk_header->chunk_sz;
 194                 blkcnt = DIV_ROUND_UP_ULL(chunk_data_sz, info->blksz);
 195                 switch (chunk_header->chunk_type) {
 196                 case CHUNK_TYPE_RAW:
 197                         if (chunk_header->total_sz !=
 198                             (sparse_header->chunk_hdr_sz + chunk_data_sz)) {
 199                                 info->mssg("Bogus chunk size for chunk type Raw",
 200                                            response);
 201                                 return -1;
 202                         }
 203
 204                         if (blk + blkcnt > info->start + info->size) {
 205                                 printf(
 206                                     "%s: Request would exceed partition size!\n",
 207                                     __func__);
 208                                 info->mssg("Request would exceed partition size!",
 209                                            response);
 210                                 return -1;
 211                         }
 212
 213                         blks = write_sparse_chunk_raw(info, blk, blkcnt,
 214                                                       data, response);
 215                         if (blks < 0)
 216                                 return -1;
 217
 218                         blk += blks;
 219                         bytes_written += ((u64)blkcnt) * info->blksz;
 220                         total_blocks += chunk_header->chunk_sz;
 221                         data += chunk_data_sz;
 222                         break;
 223
 224                 case CHUNK_TYPE_FILL:
 225                         if (chunk_header->total_sz !=
 226                             (sparse_header->chunk_hdr_sz + sizeof(uint32_t))) {
 227                                 info->mssg("Bogus chunk size for chunk type FILL", response);
 228                                 return -1;
 229                         }
 230
 231                         fill_buf = (uint32_t *)
 232                                    memalign(ARCH_DMA_MINALIGN,
 233                                             ROUNDUP(
 234                                                 info->blksz * fill_buf_num_blks,
 235                                                 ARCH_DMA_MINALIGN));
 236                         if (!fill_buf) {
 237                                 info->mssg("Malloc failed for: CHUNK_TYPE_FILL",
 238                                            response);
 239                                 return -1;
 240                         }
 241
 242                         fill_val = *(uint32_t *)data;
 243                         data = (char *)data + sizeof(uint32_t);
 244
 245                         for (i = 0;
 246                              i < (info->blksz * fill_buf_num_blks /
 247                                   sizeof(fill_val));
 248                              i++)
 249                                 fill_buf[i] = fill_val;
 250
 251                         if (blk + blkcnt > info->start + info->size) {
 252                                 printf(
 253                                     "%s: Request would exceed partition size!\n",
 254                                     __func__);
 255                                 info->mssg("Request would exceed partition size!",
 256                                            response);
 257                                 return -1;
 258                         }
 259
 260                         for (i = 0; i < blkcnt;) {
 261                                 j = blkcnt - i;
 262                                 if (j > fill_buf_num_blks)
 263                                         j = fill_buf_num_blks;
 264                                 blks = info->write(info, blk, j, fill_buf);
 265                                 /* blks might be > j (eg. NAND bad-blocks) */
 266                                 if (blks < j) {
 267                                         printf("%s: %s " LBAFU " [%d]\n",
 268                                                __func__,
 269                                                "Write failed, block #",
 270                                                blk, j);
 271                                         info->mssg("flash write failure",
 272                                                    response);
 273                                         free(fill_buf);
 274                                         return -1;
 275                                 }
 276                                 blk += blks;
 277                                 i += j;
 278                         }
 279                         bytes_written += ((u64)blkcnt) * info->blksz;
 280                         total_blocks += DIV_ROUND_UP_ULL(chunk_data_sz,
 281                                                          sparse_header->blk_sz);
 282                         free(fill_buf);
 283                         break;
 284
 285                 case CHUNK_TYPE_DONT_CARE:
 286                         blk += info->reserve(info, blk, blkcnt);
 287                         total_blocks += chunk_header->chunk_sz;
 288                         break;
 289
 290                 case CHUNK_TYPE_CRC32:
 291                         if (chunk_header->total_sz !=
 292                             sparse_header->chunk_hdr_sz) {
 293                                 info->mssg("Bogus chunk size for chunk type Dont Care",
 294                                            response);
 295                                 return -1;
 296                         }
 297                         total_blocks += chunk_header->chunk_sz;
 298                         data += chunk_data_sz;
 299                         break;
 300
 301                 default:
 302                         printf("%s: Unknown chunk type: %x\n", __func__,
 303                                chunk_header->chunk_type);
 304                         info->mssg("Unknown chunk type", response);
 305                         return -1;
 306                 }
 307         }
 308
 309         debug("Wrote %d blocks, expected to write %d blocks\n",
 310               total_blocks, sparse_header->total_blks);
 311         printf("........ wrote %llu bytes to '%s'\n", bytes_written, part_name);
 312
 313         if (total_blocks != sparse_header->total_blks) {
 314                 info->mssg("sparse image write failure", response);
 315                 return -1;
 316         }
 317
 318         return 0;
 319 }