common/spl/spl_ymodem.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2004
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * (C) Copyright 2011
   7  * Texas Instruments, <www.ti.com>
   8  *
   9  * Matt Porter <mporter@ti.com>
  10  */
  11 #include <common.h>
  12 #include <gzip.h>
  13 #include <spl.h>
  14 #include <xyzModem.h>
  15 #include <asm/u-boot.h>
  16 #include <linux/libfdt.h>
  17
  18 #define BUF_SIZE 1024
  19
  20 /*
  21  * Information required to load image using ymodem.
  22  *
  23  * @image_read: Now of bytes read from the image.
  24  * @buf: pointer to the previous read block.
  25  */
  26 struct ymodem_fit_info {
  27         int image_read;
  28         char *buf;
  29 };
  30
  31 static int getcymodem(void) {
  32         if (tstc())
  33                 return (getc());
  34         return -1;
  35 }
  36
  37 static ulong ymodem_read_fit(struct spl_load_info *load, ulong offset,
  38                              ulong size, void *addr)
  39 {
  40         int res, err;
  41         struct ymodem_fit_info *info = load->priv;
  42         char *buf = info->buf;
  43
  44         while (info->image_read < offset) {
  45                 res = xyzModem_stream_read(buf, BUF_SIZE, &err);
  46                 if (res <= 0)
  47                         return res;
  48                 info->image_read += res;
  49         }
  50
  51         if (info->image_read > offset) {
  52                 res = info->image_read - offset;
  53                 memcpy(addr, &buf[BUF_SIZE - res], res);
  54                 addr = addr + res;
  55         }
  56
  57         while (info->image_read < offset + size) {
  58                 res = xyzModem_stream_read(buf, BUF_SIZE, &err);
  59                 if (res <= 0)
  60                         return res;
  61
  62                 memcpy(addr, buf, res);
  63                 info->image_read += res;
  64                 addr += res;
  65         }
  66
  67         return size;
  68 }
  69
  70 static int spl_ymodem_load_image(struct spl_image_info *spl_image,
  71                                  struct spl_boot_device *bootdev)
  72 {
  73         ulong size = 0;
  74         int err;
  75         int res;
  76         int ret;
  77         connection_info_t info;
  78         char buf[BUF_SIZE];
  79         struct image_header *ih = NULL;
  80         ulong addr = 0;
  81
  82         info.mode = xyzModem_ymodem;
  83         ret = xyzModem_stream_open(&info, &err);
  84         if (ret) {
  85                 printf("spl: ymodem err - %s\n", xyzModem_error(err));
  86                 return ret;
  87         }
  88
  89         res = xyzModem_stream_read(buf, BUF_SIZE, &err);
  90         if (res <= 0)
  91                 goto end_stream;
  92
  93         if (IS_ENABLED(CONFIG_SPL_LOAD_FIT_FULL) &&
  94             image_get_magic((struct image_header *)buf) == FDT_MAGIC) {
  95                 addr = CONFIG_SYS_LOAD_ADDR;
  96                 ih = (struct image_header *)addr;
  97
  98                 memcpy((void *)addr, buf, res);
  99                 size += res;
 100                 addr += res;
 101
 102                 while ((res = xyzModem_stream_read(buf, BUF_SIZE, &err)) > 0) {
 103                         memcpy((void *)addr, buf, res);
 104                         size += res;
 105                         addr += res;
 106                 }
 107
 108                 ret = spl_parse_image_header(spl_image, ih);
 109                 if (ret)
 110                         return ret;
 111         } else if (IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
 112             image_get_magic((struct image_header *)buf) == FDT_MAGIC) {
 113                 struct spl_load_info load;
 114                 struct ymodem_fit_info info;
 115
 116                 debug("Found FIT\n");
 117                 load.dev = NULL;
 118                 load.priv = (void *)&info;
 119                 load.filename = NULL;
 120                 load.bl_len = 1;
 121                 info.buf = buf;
 122                 info.image_read = BUF_SIZE;
 123                 load.read = ymodem_read_fit;
 124                 ret = spl_load_simple_fit(spl_image, &load, 0, (void *)buf);
 125                 size = info.image_read;
 126
 127                 while ((res = xyzModem_stream_read(buf, BUF_SIZE, &err)) > 0)
 128                         size += res;
 129         } else {
 130                 ih = (struct image_header *)buf;
 131                 ret = spl_parse_image_header(spl_image, ih);
 132                 if (ret)
 133                         goto end_stream;
 134 #ifdef CONFIG_SPL_GZIP
 135                 if (ih->ih_comp == IH_COMP_GZIP)
 136                         addr = CONFIG_SYS_LOAD_ADDR;
 137                 else
 138 #endif
 139                         addr = spl_image->load_addr;
 140                 memcpy((void *)addr, buf, res);
 141                 ih = (struct image_header *)addr;
 142                 size += res;
 143                 addr += res;
 144
 145                 while ((res = xyzModem_stream_read(buf, BUF_SIZE, &err)) > 0) {
 146                         memcpy((void *)addr, buf, res);
 147                         size += res;
 148                         addr += res;
 149                 }
 150         }
 151
 152 end_stream:
 153         xyzModem_stream_close(&err);
 154         xyzModem_stream_terminate(false, &getcymodem);
 155
 156         printf("Loaded %lu bytes\n", size);
 157
 158 #ifdef CONFIG_SPL_GZIP
 159         if (!(IS_ENABLED(CONFIG_SPL_LOAD_FIT) &&
 160               image_get_magic((struct image_header *)buf) == FDT_MAGIC) &&
 161             (ih->ih_comp == IH_COMP_GZIP)) {
 162                 if (gunzip((void *)(spl_image->load_addr + sizeof(*ih)),
 163                            CONFIG_SYS_BOOTM_LEN,
 164                            (void *)(CONFIG_SYS_LOAD_ADDR + sizeof(*ih)),
 165                            &size)) {
 166                         puts("Uncompressing error\n");
 167                         return -EIO;
 168                 }
 169         }
 170 #endif
 171
 172         return ret;
 173 }
 174 SPL_LOAD_IMAGE_METHOD("UART", 0, BOOT_DEVICE_UART, spl_ymodem_load_image);