/* * Copyright (c) 2009, Google Inc. * All rights reserved. * * Copyright (c) 2009-2014, The Linux Foundation. All rights reserved. * Portions Copyright 2014 Broadcom Corporation. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions are met: * * Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in the * documentation and/or other materials provided with the distribution. * * Neither the name of The Linux Foundation nor * the names of its contributors may be used to endorse or promote * products derived from this software without specific prior written * permission. * * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE * IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND * NON-INFRINGEMENT ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * * NOTE: * Although it is very similar, this license text is not identical * to the "BSD-3-Clause", therefore, DO NOT MODIFY THIS LICENSE TEXT! */ #include #include #include #include #include #include #include #include #include static void default_log(const char *ignored, char *response) {} unsigned int write_spimg_on_dfu(struct sparse_storage *info, const char *part_name, void *data, char *response, unsigned int data_size) { static lbaint_t blk; static chunk_header_t chunk_header_S; static unsigned int chunk_data_sz = 0; static sparse_header_t sparse_header_S; chunk_header_t *chunk_header; lbaint_t blkcnt = 0; lbaint_t blks = 0; unsigned int offset; uint32_t *fill_buf = NULL; uint32_t fill_val; char *buf = NULL; uint32_t *source = NULL; sparse_header_t *sparse_header; int fill_buf_num_blks; int i; int j; unsigned char md5_output_orig[16] = {0}; unsigned char md5_output_cur[16] = {0}; fill_buf_num_blks = CONFIG_IMAGE_SPARSE_FILLBUF_SIZE / info->blksz; /* Only the first packet include sparse image header*/ if (is_sparse_image((void*)data)) { /* Read and skip over sparse image header */ sparse_header = (sparse_header_t *)data; data += sparse_header->file_hdr_sz; data_size -= sparse_header->file_hdr_sz; if (sparse_header->file_hdr_sz > sizeof(sparse_header_t)) { /* * Skip the remaining bytes in a header that is longer than * we expected. */ data += (sparse_header->file_hdr_sz - sizeof(sparse_header_t)); data_size -= (sparse_header->file_hdr_sz - sizeof(sparse_header_t)); } if (!info->mssg) info->mssg = default_log; debug("=== Sparse Image Header ===\n"); debug("magic: 0x%x\n", sparse_header->magic); debug("major_version: 0x%x\n", sparse_header->major_version); debug("minor_version: 0x%x\n", sparse_header->minor_version); debug("file_hdr_sz: %d\n", sparse_header->file_hdr_sz); debug("chunk_hdr_sz: %d\n", sparse_header->chunk_hdr_sz); debug("blk_sz: %d\n", sparse_header->blk_sz); debug("total_blks: %d\n", sparse_header->total_blks); debug("total_chunks: %d\n", sparse_header->total_chunks); /* Set static sparse header for next packet */ sparse_header_S.magic = sparse_header->magic; sparse_header_S.major_version = sparse_header->major_version; sparse_header_S.minor_version = sparse_header->minor_version; sparse_header_S.file_hdr_sz = sparse_header->file_hdr_sz; sparse_header_S.chunk_hdr_sz = sparse_header->chunk_hdr_sz; sparse_header_S.blk_sz = sparse_header->blk_sz; sparse_header_S.total_blks = sparse_header->total_blks; sparse_header_S.total_chunks = sparse_header->total_chunks; /* * Verify that the sparse block size is a multiple of our * storage backend block size */ div_u64_rem(sparse_header_S.blk_sz, info->blksz, &offset); if (offset) { printf("%s: Sparse image block size issue [%u]\n", __func__, sparse_header_S.blk_sz); info->mssg("sparse image block size issue", response); return -1; } /* Init the blk start location */ blk = info->start; chunk_data_sz = 0; } /* Start processing chunks */ /* Data size should be more then or equal to a chunk size */ while(data_size >= 12) { /* Get new chunk data after chunk data is write done */ if (chunk_data_sz == 0) { /* Read and skip over chunk header */ chunk_header = (chunk_header_t *)data; data += sizeof(chunk_header_t); data_size -= sizeof(chunk_header_t); if (chunk_header->chunk_type != CHUNK_TYPE_RAW) { debug("=== Chunk Header ===\n"); debug("chunk_type: 0x%x\n", chunk_header->chunk_type); debug("chunk_data_sz: 0x%x\n", chunk_header->chunk_sz); debug("total_size: 0x%x\n", chunk_header->total_sz); } /* Set static chunk header for next packet */ chunk_header_S.chunk_type = chunk_header->chunk_type; chunk_header_S.chunk_sz = chunk_header->chunk_sz; chunk_header_S.total_sz = chunk_header->total_sz; if (sparse_header_S.chunk_hdr_sz > sizeof(chunk_header_t)) { /* * Skip the remaining bytes in a header that is longer * than we expected. */ data += (sparse_header_S.chunk_hdr_sz - sizeof(chunk_header_t)); data_size -= (sparse_header_S.chunk_hdr_sz - sizeof(chunk_header_t)); } /* Check chun data is correct */ chunk_data_sz = sparse_header_S.blk_sz * chunk_header->chunk_sz; } switch (chunk_header_S.chunk_type) { case CHUNK_TYPE_RAW: if (chunk_header_S.total_sz != (sparse_header_S.chunk_hdr_sz + (sparse_header_S.blk_sz * chunk_header_S.chunk_sz))) { info->mssg("Bogus chunk size for chunk type Raw", response); return -1; } /* Check data size and calculate how many blocks should be wrote */ if (data_size < chunk_data_sz) { blkcnt = data_size / info->blksz; if (blkcnt <= 0) { return data_size; } chunk_data_sz = chunk_data_sz - (blkcnt * info->blksz); } else { blkcnt = chunk_data_sz / info->blksz; chunk_data_sz = 0; } if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } blks = info->write(info, blk, blkcnt, data); /* blks might be > blkcnt (eg. NAND bad-blocks) */ if (blks < blkcnt) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Write failed, block #", blk, blks); info->mssg("flash write failure", response); return -1; } /* Verify data */ md5_wd((unsigned char *)data, blkcnt * info->blksz, md5_output_orig, CHUNKSZ_MD5); info->read(info, blk, blkcnt, data); md5_wd((unsigned char *)data, blkcnt * info->blksz, md5_output_cur, CHUNKSZ_MD5); if ( memcmp( md5_output_cur, md5_output_orig, sizeof(md5_output_orig) ) != 0 ) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Verify failed, block #", blk, blks); info->mssg("Verify data failure", response); if ( buf != NULL ) free(buf); return -1; } blk += blks; data += blkcnt * info->blksz; data_size = data_size - (blkcnt * info->blksz); break; case CHUNK_TYPE_FILL: if (chunk_header_S.total_sz != (sparse_header_S.chunk_hdr_sz + sizeof(uint32_t))) { info->mssg("Bogus chunk size for chunk type FILL", response); return -1; } if (data_size < sizeof(uint32_t)) { return data_size; } else { blkcnt = chunk_data_sz / info->blksz; chunk_data_sz = 0; } fill_buf = (uint32_t *) memalign(ARCH_DMA_MINALIGN, ROUNDUP( info->blksz * fill_buf_num_blks, ARCH_DMA_MINALIGN)); if (!fill_buf) { info->mssg("Malloc failed for: CHUNK_TYPE_FILL", response); return -1; } fill_val = *(uint32_t *)data; data = (char *)data + sizeof(uint32_t); data_size -= sizeof(uint32_t); for (i = 0; i < (info->blksz * fill_buf_num_blks / sizeof(fill_val)); i++) fill_buf[i] = fill_val; if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } for (i = 0; i < blkcnt;) { j = blkcnt - i; if (j > fill_buf_num_blks) j = fill_buf_num_blks; blks = info->write(info, blk, j, fill_buf); /* blks might be > j (eg. NAND bad-blocks) */ if (blks < j) { printf("%s: %s " LBAFU " [%d]\n", __func__, "Write failed, block #", blk, j); info->mssg("flash write failure", response); free(fill_buf); return -1; } blk += blks; i += j; } free(fill_buf); /* Verify data */ buf = malloc( info->blksz ); source = malloc( info->blksz ); memset(source, fill_val, sizeof(fill_val)); if ( buf == NULL ) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Alloc buffer failed on Fill type, block #", blk, blks); info->mssg("Alloc buffer failure on Fill type", response); return -1; } for (i = 0; i < ( info->blksz / sizeof(fill_val) ); i++) source[i] = fill_val; for ( i = 0; i < blkcnt; i++) { info->read(info, blk + i, 1, buf); if ( memcmp( buf, source, info->blksz ) != 0 ) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Verify failed on Fill type, block #", blk, blks); info->mssg("Verify data failure on Fill type", response); if ( buf != NULL ) free(buf); if (source != NULL ) free(source); return -1; } } if ( buf != NULL ) free(buf); if (source != NULL ) free(source); break; case CHUNK_TYPE_DONT_CARE: blkcnt = chunk_data_sz / info->blksz; chunk_data_sz = 0; blk += info->reserve(info, blk, blkcnt); break; case CHUNK_TYPE_CRC32: if (chunk_header_S.total_sz != sparse_header_S.chunk_hdr_sz) { info->mssg("Bogus chunk size for chunk type Dont Care", response); return -1; } if (data_size < sparse_header_S.blk_sz * chunk_header_S.chunk_sz) return data_size; data = (char *)data + sparse_header_S.blk_sz * chunk_header_S.chunk_sz; data_size = data_size - sparse_header_S.blk_sz * chunk_header_S.chunk_sz; break; default: printf("%s: Unknown chunk type: %x\n", __func__, chunk_header_S.chunk_type); info->mssg("Unknown chunk type", response); return -1; } } /* Return the left data */ return data_size; } int write_sparse_image(struct sparse_storage *info, const char *part_name, void *data, char *response) { lbaint_t blk; lbaint_t blkcnt; lbaint_t blks; uint32_t bytes_written = 0; unsigned int chunk; unsigned int offset; unsigned int chunk_data_sz; uint32_t *fill_buf = NULL; uint32_t fill_val; sparse_header_t *sparse_header; chunk_header_t *chunk_header; uint32_t total_blocks = 0; int fill_buf_num_blks; int i; int j; fill_buf_num_blks = CONFIG_IMAGE_SPARSE_FILLBUF_SIZE / info->blksz; /* Read and skip over sparse image header */ sparse_header = (sparse_header_t *)data; data += sparse_header->file_hdr_sz; if (sparse_header->file_hdr_sz > sizeof(sparse_header_t)) { /* * Skip the remaining bytes in a header that is longer than * we expected. */ data += (sparse_header->file_hdr_sz - sizeof(sparse_header_t)); } if (!info->mssg) info->mssg = default_log; debug("=== Sparse Image Header ===\n"); debug("magic: 0x%x\n", sparse_header->magic); debug("major_version: 0x%x\n", sparse_header->major_version); debug("minor_version: 0x%x\n", sparse_header->minor_version); debug("file_hdr_sz: %d\n", sparse_header->file_hdr_sz); debug("chunk_hdr_sz: %d\n", sparse_header->chunk_hdr_sz); debug("blk_sz: %d\n", sparse_header->blk_sz); debug("total_blks: %d\n", sparse_header->total_blks); debug("total_chunks: %d\n", sparse_header->total_chunks); /* * Verify that the sparse block size is a multiple of our * storage backend block size */ div_u64_rem(sparse_header->blk_sz, info->blksz, &offset); if (offset) { printf("%s: Sparse image block size issue [%u]\n", __func__, sparse_header->blk_sz); info->mssg("sparse image block size issue", response); return -1; } puts("Flashing Sparse Image\n"); /* Start processing chunks */ blk = info->start; for (chunk = 0; chunk < sparse_header->total_chunks; chunk++) { /* Read and skip over chunk header */ chunk_header = (chunk_header_t *)data; data += sizeof(chunk_header_t); if (chunk_header->chunk_type != CHUNK_TYPE_RAW) { debug("=== Chunk Header ===\n"); debug("chunk_type: 0x%x\n", chunk_header->chunk_type); debug("chunk_data_sz: 0x%x\n", chunk_header->chunk_sz); debug("total_size: 0x%x\n", chunk_header->total_sz); } if (sparse_header->chunk_hdr_sz > sizeof(chunk_header_t)) { /* * Skip the remaining bytes in a header that is longer * than we expected. */ data += (sparse_header->chunk_hdr_sz - sizeof(chunk_header_t)); } chunk_data_sz = sparse_header->blk_sz * chunk_header->chunk_sz; blkcnt = chunk_data_sz / info->blksz; switch (chunk_header->chunk_type) { case CHUNK_TYPE_RAW: if (chunk_header->total_sz != (sparse_header->chunk_hdr_sz + chunk_data_sz)) { info->mssg("Bogus chunk size for chunk type Raw", response); return -1; } if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } blks = info->write(info, blk, blkcnt, data); /* blks might be > blkcnt (eg. NAND bad-blocks) */ if (blks < blkcnt) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Write failed, block #", blk, blks); info->mssg("flash write failure", response); return -1; } blk += blks; bytes_written += blkcnt * info->blksz; total_blocks += chunk_header->chunk_sz; data += chunk_data_sz; break; case CHUNK_TYPE_FILL: if (chunk_header->total_sz != (sparse_header->chunk_hdr_sz + sizeof(uint32_t))) { info->mssg("Bogus chunk size for chunk type FILL", response); return -1; } fill_buf = (uint32_t *) memalign(ARCH_DMA_MINALIGN, ROUNDUP( info->blksz * fill_buf_num_blks, ARCH_DMA_MINALIGN)); if (!fill_buf) { info->mssg("Malloc failed for: CHUNK_TYPE_FILL", response); return -1; } fill_val = *(uint32_t *)data; data = (char *)data + sizeof(uint32_t); for (i = 0; i < (info->blksz * fill_buf_num_blks / sizeof(fill_val)); i++) fill_buf[i] = fill_val; if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } for (i = 0; i < blkcnt;) { j = blkcnt - i; if (j > fill_buf_num_blks) j = fill_buf_num_blks; blks = info->write(info, blk, j, fill_buf); /* blks might be > j (eg. NAND bad-blocks) */ if (blks < j) { printf("%s: %s " LBAFU " [%d]\n", __func__, "Write failed, block #", blk, j); info->mssg("flash write failure", response); free(fill_buf); return -1; } blk += blks; i += j; } bytes_written += blkcnt * info->blksz; total_blocks += chunk_data_sz / sparse_header->blk_sz; free(fill_buf); break; case CHUNK_TYPE_DONT_CARE: blk += info->reserve(info, blk, blkcnt); total_blocks += chunk_header->chunk_sz; break; case CHUNK_TYPE_CRC32: if (chunk_header->total_sz != sparse_header->chunk_hdr_sz) { info->mssg("Bogus chunk size for chunk type Dont Care", response); return -1; } total_blocks += chunk_header->chunk_sz; data += chunk_data_sz; break; default: printf("%s: Unknown chunk type: %x\n", __func__, chunk_header->chunk_type); info->mssg("Unknown chunk type", response); return -1; } } debug("Wrote %d blocks, expected to write %d blocks\n", total_blocks, sparse_header->total_blks); printf("........ wrote %u bytes to '%s'\n", bytes_written, part_name); if (total_blocks != sparse_header->total_blks) { info->mssg("sparse image write failure", response); return -1; } return 0; } int read_sparse_image(struct sparse_storage *info, const char *part_name, void *data, char *response) { lbaint_t blk; lbaint_t blkcnt; lbaint_t blks; uint32_t bytes_written = 0; unsigned int chunk; unsigned int offset; unsigned int chunk_data_sz; uint32_t *fill_buf = NULL; uint32_t fill_val; sparse_header_t *sparse_header; chunk_header_t *chunk_header; uint32_t total_blocks = 0; int fill_buf_num_blks; int i; int j; fill_buf_num_blks = CONFIG_IMAGE_SPARSE_FILLBUF_SIZE / info->blksz; /* Read and skip over sparse image header */ sparse_header = (sparse_header_t *)data; data += sparse_header->file_hdr_sz; if (sparse_header->file_hdr_sz > sizeof(sparse_header_t)) { /* * Skip the remaining bytes in a header that is longer than * we expected. */ data += (sparse_header->file_hdr_sz - sizeof(sparse_header_t)); } if (!info->mssg) info->mssg = default_log; debug("=== Sparse Image Header ===\n"); debug("magic: 0x%x\n", sparse_header->magic); debug("major_version: 0x%x\n", sparse_header->major_version); debug("minor_version: 0x%x\n", sparse_header->minor_version); debug("file_hdr_sz: %d\n", sparse_header->file_hdr_sz); debug("chunk_hdr_sz: %d\n", sparse_header->chunk_hdr_sz); debug("blk_sz: %d\n", sparse_header->blk_sz); debug("total_blks: %d\n", sparse_header->total_blks); debug("total_chunks: %d\n", sparse_header->total_chunks); /* * Verify that the sparse block size is a multiple of our * storage backend block size */ div_u64_rem(sparse_header->blk_sz, info->blksz, &offset); if (offset) { printf("%s: Sparse image block size issue [%u]\n", __func__, sparse_header->blk_sz); info->mssg("sparse image block size issue", response); return -1; } puts("Flashing Sparse Image\n"); /* Start processing chunks */ blk = info->start; for (chunk = 0; chunk < sparse_header->total_chunks; chunk++) { /* Read and skip over chunk header */ chunk_header = (chunk_header_t *)data; data += sizeof(chunk_header_t); if (chunk_header->chunk_type != CHUNK_TYPE_RAW) { debug("=== Chunk Header ===\n"); debug("chunk_type: 0x%x\n", chunk_header->chunk_type); debug("chunk_data_sz: 0x%x\n", chunk_header->chunk_sz); debug("total_size: 0x%x\n", chunk_header->total_sz); } if (sparse_header->chunk_hdr_sz > sizeof(chunk_header_t)) { /* * Skip the remaining bytes in a header that is longer * than we expected. */ data += (sparse_header->chunk_hdr_sz - sizeof(chunk_header_t)); } chunk_data_sz = sparse_header->blk_sz * chunk_header->chunk_sz; blkcnt = chunk_data_sz / info->blksz; switch (chunk_header->chunk_type) { case CHUNK_TYPE_RAW: if (chunk_header->total_sz != (sparse_header->chunk_hdr_sz + chunk_data_sz)) { info->mssg("Bogus chunk size for chunk type Raw", response); return -1; } if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } blks = info->read(info, blk, blkcnt, data); /* blks might be > blkcnt (eg. NAND bad-blocks) */ if (blks < blkcnt) { printf("%s: %s" LBAFU " [" LBAFU "]\n", __func__, "Write failed, block #", blk, blks); info->mssg("flash write failure", response); return -1; } blk += blks; bytes_written += blkcnt * info->blksz; total_blocks += chunk_header->chunk_sz; data += chunk_data_sz; break; case CHUNK_TYPE_FILL: if (chunk_header->total_sz != (sparse_header->chunk_hdr_sz + sizeof(uint32_t))) { info->mssg("Bogus chunk size for chunk type FILL", response); return -1; } fill_buf = (uint32_t *) memalign(ARCH_DMA_MINALIGN, ROUNDUP( info->blksz * fill_buf_num_blks, ARCH_DMA_MINALIGN)); if (!fill_buf) { info->mssg("Malloc failed for: CHUNK_TYPE_FILL", response); return -1; } fill_val = *(uint32_t *)data; data = (char *)data + sizeof(uint32_t); for (i = 0; i < (info->blksz * fill_buf_num_blks / sizeof(fill_val)); i++) fill_buf[i] = fill_val; if (blk + blkcnt > info->start + info->size) { printf( "%s: Request would exceed partition size!\n", __func__); info->mssg("Request would exceed partition size!", response); return -1; } for (i = 0; i < blkcnt;) { j = blkcnt - i; if (j > fill_buf_num_blks) j = fill_buf_num_blks; blks = info->read(info, blk, j, fill_buf); /* blks might be > j (eg. NAND bad-blocks) */ if (blks < j) { printf("%s: %s " LBAFU " [%d]\n", __func__, "Write failed, block #", blk, j); info->mssg("flash write failure", response); free(fill_buf); return -1; } blk += blks; i += j; } bytes_written += blkcnt * info->blksz; total_blocks += chunk_data_sz / sparse_header->blk_sz; free(fill_buf); break; case CHUNK_TYPE_DONT_CARE: blk += info->reserve(info, blk, blkcnt); total_blocks += chunk_header->chunk_sz; break; case CHUNK_TYPE_CRC32: if (chunk_header->total_sz != sparse_header->chunk_hdr_sz) { info->mssg("Bogus chunk size for chunk type Dont Care", response); return -1; } total_blocks += chunk_header->chunk_sz; data += chunk_data_sz; break; default: printf("%s: Unknown chunk type: %x\n", __func__, chunk_header->chunk_type); info->mssg("Unknown chunk type", response); return -1; } } debug("Wrote %d blocks, expected to write %d blocks\n", total_blocks, sparse_header->total_blks); printf("........ wrote %u bytes to '%s'\n", bytes_written, part_name); if (total_blocks != sparse_header->total_blks) { info->mssg("sparse image write failure", response); return -1; } return 0; }