fastboot: sparse: make write_sparse_image useable for non-fastboot

write_sparse_image could be useful for non-fastboot users.
For ex a platform, without usb-device/fastboot support, could
get sparse images over tftp and write using the mmc command.
Or non-android systems could also leverage the sparse format.

Towards that, this patch removes anything fastboot specific from
the write_sparse_image implementation. Which includes making the
function return integer as error code and calls for fastboot logging
via an optional callback function 'mssg'.

Signed-off-by: Jassi Brar <jaswinder.singh@linaro.org>

diff --git a/common/fb_mmc.c b/common/fb_mmc.c
index 234ce83b802a8da4f28aaa40522ee47d63d125cf..46f0073dbc239d8c9e3294e914a354ffadbfe719 100644 (file)
--- a/common/fb_mmc.c
+++ b/common/fb_mmc.c
@@ -329,6 +329,7 @@ void fb_mmc_flash_write(const char *cmd, void *download_buffer,
        if (is_sparse_image(download_buffer)) {
                struct fb_mmc_sparse sparse_priv;
                struct sparse_storage sparse;
+               int err;
 
                sparse_priv.dev_desc = dev_desc;
 
@@ -337,12 +338,15 @@ void fb_mmc_flash_write(const char *cmd, void *download_buffer,
                sparse.size = info.size;
                sparse.write = fb_mmc_sparse_write;
                sparse.reserve = fb_mmc_sparse_reserve;
+               sparse.mssg = fastboot_fail;
 
                printf("Flashing sparse image at offset " LBAFU "\n",
                       sparse.start);
 
                sparse.priv = &sparse_priv;
-               write_sparse_image(&sparse, cmd, download_buffer);
+               err = write_sparse_image(&sparse, cmd, download_buffer);
+               if (!err)
+                       fastboot_okay("");
        } else {
                write_raw_image(dev_desc, &info, cmd, download_buffer,
                                download_bytes);

diff --git a/common/fb_nand.c b/common/fb_nand.c
index d7d9eb08f696ced224880753a5ada465e9cd4590..c07655e49ed8ec10d6143b165855f70b55494d55 100644 (file)
--- a/common/fb_nand.c
+++ b/common/fb_nand.c
@@ -174,12 +174,15 @@ void fb_nand_flash_write(const char *cmd, void *download_buffer,
                sparse.size = part->size / sparse.blksz;
                sparse.write = fb_nand_sparse_write;
                sparse.reserve = fb_nand_sparse_reserve;
+               sparse.mssg = fastboot_fail;
 
                printf("Flashing sparse image at offset " LBAFU "\n",
                       sparse.start);
 
                sparse.priv = &sparse_priv;
-               write_sparse_image(&sparse, cmd, download_buffer);
+               ret = write_sparse_image(&sparse, cmd, download_buffer);
+               if (!ret)
+                       fastboot_okay("");
        } else {
                printf("Flashing raw image at offset 0x%llx\n",
                       part->offset);

diff --git a/common/image-sparse.c b/common/image-sparse.c
index 8ebd647e337d76653f96e3f053adba1d67bbcc9e..9223b9a1b86ce222068e27fe2cc8a90abd83c7ce 100644 (file)
--- a/common/image-sparse.c
+++ b/common/image-sparse.c
@@ -41,7 +41,6 @@
 #include <malloc.h>
 #include <part.h>
 #include <sparse_format.h>
-#include <fastboot.h>
 
 #include <linux/math64.h>
 
@@ -49,9 +48,10 @@
 #define CONFIG_FASTBOOT_FLASH_FILLBUF_SIZE (1024 * 512)
 #endif
 
-void write_sparse_image(
-               struct sparse_storage *info, const char *part_name,
-               void *data)
+static void default_log(const char *ignored) {}
+
+int write_sparse_image(struct sparse_storage *info,
+                      const char *part_name, void *data)
 {
        lbaint_t blk;
        lbaint_t blkcnt;
@@ -83,6 +83,9 @@ void write_sparse_image(
                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);
@@ -101,8 +104,8 @@ void write_sparse_image(
        if (offset) {
                printf("%s: Sparse image block size issue [%u]\n",
                       __func__, sparse_header->blk_sz);
-               fastboot_fail("sparse image block size issue");
-               return;
+               info->mssg("sparse image block size issue");
+               return -1;
        }
 
        puts("Flashing Sparse Image\n");
@@ -136,18 +139,16 @@ void write_sparse_image(
                case CHUNK_TYPE_RAW:
                        if (chunk_header->total_sz !=
                            (sparse_header->chunk_hdr_sz + chunk_data_sz)) {
-                               fastboot_fail(
-                                       "Bogus chunk size for chunk type Raw");
-                               return;
+                               info->mssg("Bogus chunk size for chunk type Raw");
+                               return -1;
                        }
 
                        if (blk + blkcnt > info->start + info->size) {
                                printf(
                                    "%s: Request would exceed partition size!\n",
                                    __func__);
-                               fastboot_fail(
-                                   "Request would exceed partition size!");
-                               return;
+                               info->mssg("Request would exceed partition size!");
+                               return -1;
                        }
 
                        blks = info->write(info, blk, blkcnt, data);
@@ -156,9 +157,8 @@ void write_sparse_image(
                                printf("%s: %s" LBAFU " [" LBAFU "]\n",
                                       __func__, "Write failed, block #",
                                       blk, blks);
-                               fastboot_fail(
-                                             "flash write failure");
-                               return;
+                               info->mssg("flash write failure");
+                               return -1;
                        }
                        blk += blks;
                        bytes_written += blkcnt * info->blksz;
@@ -169,9 +169,8 @@ void write_sparse_image(
                case CHUNK_TYPE_FILL:
                        if (chunk_header->total_sz !=
                            (sparse_header->chunk_hdr_sz + sizeof(uint32_t))) {
-                               fastboot_fail(
-                                       "Bogus chunk size for chunk type FILL");
-                               return;
+                               info->mssg("Bogus chunk size for chunk type FILL");
+                               return -1;
                        }
 
                        fill_buf = (uint32_t *)
@@ -180,9 +179,8 @@ void write_sparse_image(
                                                info->blksz * fill_buf_num_blks,
                                                ARCH_DMA_MINALIGN));
                        if (!fill_buf) {
-                               fastboot_fail(
-                                       "Malloc failed for: CHUNK_TYPE_FILL");
-                               return;
+                               info->mssg("Malloc failed for: CHUNK_TYPE_FILL");
+                               return -1;
                        }
 
                        fill_val = *(uint32_t *)data;
@@ -198,9 +196,8 @@ void write_sparse_image(
                                printf(
                                    "%s: Request would exceed partition size!\n",
                                    __func__);
-                               fastboot_fail(
-                                   "Request would exceed partition size!");
-                               return;
+                               info->mssg("Request would exceed partition size!");
+                               return -1;
                        }
 
                        for (i = 0; i < blkcnt;) {
@@ -214,10 +211,9 @@ void write_sparse_image(
                                               __func__,
                                               "Write failed, block #",
                                               blk, j);
-                                       fastboot_fail(
-                                                     "flash write failure");
+                                       info->mssg("flash write failure");
                                        free(fill_buf);
-                                       return;
+                                       return -1;
                                }
                                blk += blks;
                                i += j;
@@ -235,9 +231,8 @@ void write_sparse_image(
                case CHUNK_TYPE_CRC32:
                        if (chunk_header->total_sz !=
                            sparse_header->chunk_hdr_sz) {
-                               fastboot_fail(
-                                       "Bogus chunk size for chunk type Dont Care");
-                               return;
+                               info->mssg("Bogus chunk size for chunk type Dont Care");
+                               return -1;
                        }
                        total_blocks += chunk_header->chunk_sz;
                        data += chunk_data_sz;
@@ -246,8 +241,8 @@ void write_sparse_image(
                default:
                        printf("%s: Unknown chunk type: %x\n", __func__,
                               chunk_header->chunk_type);
-                       fastboot_fail("Unknown chunk type");
-                       return;
+                       info->mssg("Unknown chunk type");
+                       return -1;
                }
        }
 
@@ -255,10 +250,10 @@ void write_sparse_image(
              total_blocks, sparse_header->total_blks);
        printf("........ wrote %u bytes to '%s'\n", bytes_written, part_name);
 
-       if (total_blocks != sparse_header->total_blks)
-               fastboot_fail("sparse image write failure");
-       else
-               fastboot_okay("");
+       if (total_blocks != sparse_header->total_blks) {
+               info->mssg("sparse image write failure");
+               return -1;
+       }
 
-       return;
+       return 0;
 }

diff --git a/include/image-sparse.h b/include/image-sparse.h
index 72f4036d813d949fdacea72794eac2659fa17eaa..f39dc16617f32d987882fae7d134ff93f04cd07a 100644 (file)
--- a/include/image-sparse.h
+++ b/include/image-sparse.h
@@ -22,6 +22,8 @@ struct sparse_storage {
        lbaint_t        (*reserve)(struct sparse_storage *info,
                                 lbaint_t blk,
                                 lbaint_t blkcnt);
+
+       void            (*mssg)(const char *str);
 };
 
 static inline int is_sparse_image(void *buf)
@@ -35,5 +37,5 @@ static inline int is_sparse_image(void *buf)
        return 0;
 }
 
-void write_sparse_image(struct sparse_storage *info, const char *part_name,
-                       void *data);
+int write_sparse_image(struct sparse_storage *info, const char *part_name,
+                      void *data);