2 * Copyright (c) 2009, Google Inc.
5 * Copyright (c) 2009-2014, The Linux Foundation. All rights reserved.
6 * Portions Copyright 2014 Broadcom Corporation.
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
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.
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!
39 #include <image-sparse.h>
43 #include <sparse_format.h>
45 #include <linux/math64.h>
47 #ifndef CONFIG_FASTBOOT_FLASH_FILLBUF_SIZE
48 #define CONFIG_FASTBOOT_FLASH_FILLBUF_SIZE (1024 * 512)
51 static void default_log(const char *ignored) {}
53 int write_sparse_image(struct sparse_storage *info,
54 const char *part_name, void *data)
59 uint32_t bytes_written = 0;
62 unsigned int chunk_data_sz;
63 uint32_t *fill_buf = NULL;
65 sparse_header_t *sparse_header;
66 chunk_header_t *chunk_header;
67 uint32_t total_blocks = 0;
68 int fill_buf_num_blks;
72 fill_buf_num_blks = CONFIG_FASTBOOT_FLASH_FILLBUF_SIZE / info->blksz;
74 /* Read and skip over sparse image header */
75 sparse_header = (sparse_header_t *)data;
77 data += sparse_header->file_hdr_sz;
78 if (sparse_header->file_hdr_sz > sizeof(sparse_header_t)) {
80 * Skip the remaining bytes in a header that is longer than
83 data += (sparse_header->file_hdr_sz - sizeof(sparse_header_t));
87 info->mssg = default_log;
89 debug("=== Sparse Image Header ===\n");
90 debug("magic: 0x%x\n", sparse_header->magic);
91 debug("major_version: 0x%x\n", sparse_header->major_version);
92 debug("minor_version: 0x%x\n", sparse_header->minor_version);
93 debug("file_hdr_sz: %d\n", sparse_header->file_hdr_sz);
94 debug("chunk_hdr_sz: %d\n", sparse_header->chunk_hdr_sz);
95 debug("blk_sz: %d\n", sparse_header->blk_sz);
96 debug("total_blks: %d\n", sparse_header->total_blks);
97 debug("total_chunks: %d\n", sparse_header->total_chunks);
100 * Verify that the sparse block size is a multiple of our
101 * storage backend block size
103 div_u64_rem(sparse_header->blk_sz, info->blksz, &offset);
105 printf("%s: Sparse image block size issue [%u]\n",
106 __func__, sparse_header->blk_sz);
107 info->mssg("sparse image block size issue");
111 puts("Flashing Sparse Image\n");
113 /* Start processing chunks */
115 for (chunk = 0; chunk < sparse_header->total_chunks; chunk++) {
116 /* Read and skip over chunk header */
117 chunk_header = (chunk_header_t *)data;
118 data += sizeof(chunk_header_t);
120 if (chunk_header->chunk_type != CHUNK_TYPE_RAW) {
121 debug("=== Chunk Header ===\n");
122 debug("chunk_type: 0x%x\n", chunk_header->chunk_type);
123 debug("chunk_data_sz: 0x%x\n", chunk_header->chunk_sz);
124 debug("total_size: 0x%x\n", chunk_header->total_sz);
127 if (sparse_header->chunk_hdr_sz > sizeof(chunk_header_t)) {
129 * Skip the remaining bytes in a header that is longer
132 data += (sparse_header->chunk_hdr_sz -
133 sizeof(chunk_header_t));
136 chunk_data_sz = sparse_header->blk_sz * chunk_header->chunk_sz;
137 blkcnt = chunk_data_sz / info->blksz;
138 switch (chunk_header->chunk_type) {
140 if (chunk_header->total_sz !=
141 (sparse_header->chunk_hdr_sz + chunk_data_sz)) {
142 info->mssg("Bogus chunk size for chunk type Raw");
146 if (blk + blkcnt > info->start + info->size) {
148 "%s: Request would exceed partition size!\n",
150 info->mssg("Request would exceed partition size!");
154 blks = info->write(info, blk, blkcnt, data);
155 /* blks might be > blkcnt (eg. NAND bad-blocks) */
157 printf("%s: %s" LBAFU " [" LBAFU "]\n",
158 __func__, "Write failed, block #",
160 info->mssg("flash write failure");
164 bytes_written += blkcnt * info->blksz;
165 total_blocks += chunk_header->chunk_sz;
166 data += chunk_data_sz;
169 case CHUNK_TYPE_FILL:
170 if (chunk_header->total_sz !=
171 (sparse_header->chunk_hdr_sz + sizeof(uint32_t))) {
172 info->mssg("Bogus chunk size for chunk type FILL");
176 fill_buf = (uint32_t *)
177 memalign(ARCH_DMA_MINALIGN,
179 info->blksz * fill_buf_num_blks,
182 info->mssg("Malloc failed for: CHUNK_TYPE_FILL");
186 fill_val = *(uint32_t *)data;
187 data = (char *)data + sizeof(uint32_t);
190 i < (info->blksz * fill_buf_num_blks /
193 fill_buf[i] = fill_val;
195 if (blk + blkcnt > info->start + info->size) {
197 "%s: Request would exceed partition size!\n",
199 info->mssg("Request would exceed partition size!");
203 for (i = 0; i < blkcnt;) {
205 if (j > fill_buf_num_blks)
206 j = fill_buf_num_blks;
207 blks = info->write(info, blk, j, fill_buf);
208 /* blks might be > j (eg. NAND bad-blocks) */
210 printf("%s: %s " LBAFU " [%d]\n",
212 "Write failed, block #",
214 info->mssg("flash write failure");
221 bytes_written += blkcnt * info->blksz;
222 total_blocks += chunk_data_sz / sparse_header->blk_sz;
226 case CHUNK_TYPE_DONT_CARE:
227 blk += info->reserve(info, blk, blkcnt);
228 total_blocks += chunk_header->chunk_sz;
231 case CHUNK_TYPE_CRC32:
232 if (chunk_header->total_sz !=
233 sparse_header->chunk_hdr_sz) {
234 info->mssg("Bogus chunk size for chunk type Dont Care");
237 total_blocks += chunk_header->chunk_sz;
238 data += chunk_data_sz;
242 printf("%s: Unknown chunk type: %x\n", __func__,
243 chunk_header->chunk_type);
244 info->mssg("Unknown chunk type");
249 debug("Wrote %d blocks, expected to write %d blocks\n",
250 total_blocks, sparse_header->total_blks);
251 printf("........ wrote %u bytes to '%s'\n", bytes_written, part_name);
253 if (total_blocks != sparse_header->total_blks) {
254 info->mssg("sparse image write failure");