common/update.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2008 Semihalf
   4  *
   5  * Written by: Rafal Czubak <rcz@semihalf.com>
   6  *             Bartlomiej Sieka <tur@semihalf.com>
   7  */
   8
   9 #include <common.h>
  10 #include <cpu_func.h>
  11
  12 #if !(defined(CONFIG_FIT) && defined(CONFIG_OF_LIBFDT))
  13 #error "CONFIG_FIT and CONFIG_OF_LIBFDT are required for auto-update feature"
  14 #endif
  15
  16 #if defined(CONFIG_UPDATE_TFTP) && !defined(CONFIG_MTD_NOR_FLASH)
  17 #error "CONFIG_UPDATE_TFTP and !CONFIG_MTD_NOR_FLASH needed for legacy behaviour"
  18 #endif
  19
  20 #include <command.h>
  21 #include <env.h>
  22 #include <flash.h>
  23 #include <net.h>
  24 #include <net/tftp.h>
  25 #include <malloc.h>
  26 #include <dfu.h>
  27 #include <errno.h>
  28 #include <mtd/cfi_flash.h>
  29
  30 /* env variable holding the location of the update file */
  31 #define UPDATE_FILE_ENV         "updatefile"
  32
  33 /* set configuration defaults if needed */
  34 #ifndef CONFIG_UPDATE_LOAD_ADDR
  35 #define CONFIG_UPDATE_LOAD_ADDR 0x100000
  36 #endif
  37
  38 #ifndef CONFIG_UPDATE_TFTP_MSEC_MAX
  39 #define CONFIG_UPDATE_TFTP_MSEC_MAX     100
  40 #endif
  41
  42 #ifndef CONFIG_UPDATE_TFTP_CNT_MAX
  43 #define CONFIG_UPDATE_TFTP_CNT_MAX      0
  44 #endif
  45
  46 extern ulong tftp_timeout_ms;
  47 extern int tftp_timeout_count_max;
  48 extern ulong load_addr;
  49 #ifdef CONFIG_MTD_NOR_FLASH
  50 extern flash_info_t flash_info[];
  51 static uchar *saved_prot_info;
  52 #endif
  53 static int update_load(char *filename, ulong msec_max, int cnt_max, ulong addr)
  54 {
  55         int size, rv;
  56         ulong saved_timeout_msecs;
  57         int saved_timeout_count;
  58         char *saved_netretry, *saved_bootfile;
  59
  60         rv = 0;
  61         /* save used globals and env variable */
  62         saved_timeout_msecs = tftp_timeout_ms;
  63         saved_timeout_count = tftp_timeout_count_max;
  64         saved_netretry = strdup(env_get("netretry"));
  65         saved_bootfile = strdup(net_boot_file_name);
  66
  67         /* set timeouts for auto-update */
  68         tftp_timeout_ms = msec_max;
  69         tftp_timeout_count_max = cnt_max;
  70
  71         /* we don't want to retry the connection if errors occur */
  72         env_set("netretry", "no");
  73
  74         /* download the update file */
  75         load_addr = addr;
  76         copy_filename(net_boot_file_name, filename, sizeof(net_boot_file_name));
  77         size = net_loop(TFTPGET);
  78
  79         if (size < 0)
  80                 rv = 1;
  81         else if (size > 0)
  82                 flush_cache(addr, size);
  83
  84         /* restore changed globals and env variable */
  85         tftp_timeout_ms = saved_timeout_msecs;
  86         tftp_timeout_count_max = saved_timeout_count;
  87
  88         env_set("netretry", saved_netretry);
  89         if (saved_netretry != NULL)
  90                 free(saved_netretry);
  91
  92         if (saved_bootfile != NULL) {
  93                 copy_filename(net_boot_file_name, saved_bootfile,
  94                               sizeof(net_boot_file_name));
  95                 free(saved_bootfile);
  96         }
  97
  98         return rv;
  99 }
 100
 101 #ifdef CONFIG_MTD_NOR_FLASH
 102 static int update_flash_protect(int prot, ulong addr_first, ulong addr_last)
 103 {
 104         uchar *sp_info_ptr;
 105         ulong s;
 106         int i, bank, cnt;
 107         flash_info_t *info;
 108
 109         sp_info_ptr = NULL;
 110
 111         if (prot == 0) {
 112                 saved_prot_info =
 113                         calloc(CONFIG_SYS_MAX_FLASH_BANKS * CONFIG_SYS_MAX_FLASH_SECT, 1);
 114                 if (!saved_prot_info)
 115                         return 1;
 116         }
 117
 118         for (bank = 0; bank < CONFIG_SYS_MAX_FLASH_BANKS; ++bank) {
 119                 cnt = 0;
 120                 info = &flash_info[bank];
 121
 122                 /* Nothing to do if the bank doesn't exist */
 123                 if (info->sector_count == 0)
 124                         return 0;
 125
 126                 /* Point to current bank protection information */
 127                 sp_info_ptr = saved_prot_info + (bank * CONFIG_SYS_MAX_FLASH_SECT);
 128
 129                 /*
 130                  * Adjust addr_first or addr_last if we are on bank boundary.
 131                  * Address space between banks must be continuous for other
 132                  * flash functions (like flash_sect_erase or flash_write) to
 133                  * succeed. Banks must also be numbered in correct order,
 134                  * according to increasing addresses.
 135                  */
 136                 if (addr_last > info->start[0] + info->size - 1)
 137                         addr_last = info->start[0] + info->size - 1;
 138                 if (addr_first < info->start[0])
 139                         addr_first = info->start[0];
 140
 141                 for (i = 0; i < info->sector_count; i++) {
 142                         /* Save current information about protected sectors */
 143                         if (prot == 0) {
 144                                 s = info->start[i];
 145                                 if ((s >= addr_first) && (s <= addr_last))
 146                                         sp_info_ptr[i] = info->protect[i];
 147
 148                         }
 149
 150                         /* Protect/unprotect sectors */
 151                         if (sp_info_ptr[i] == 1) {
 152 #if defined(CONFIG_SYS_FLASH_PROTECTION)
 153                                 if (flash_real_protect(info, i, prot))
 154                                         return 1;
 155 #else
 156                                 info->protect[i] = prot;
 157 #endif
 158                                 cnt++;
 159                         }
 160                 }
 161
 162                 if (cnt) {
 163                         printf("%sProtected %d sectors\n",
 164                                                 prot ? "": "Un-", cnt);
 165                 }
 166         }
 167
 168         if((prot == 1) && saved_prot_info)
 169                 free(saved_prot_info);
 170
 171         return 0;
 172 }
 173 #endif
 174
 175 static int update_flash(ulong addr_source, ulong addr_first, ulong size)
 176 {
 177 #ifdef CONFIG_MTD_NOR_FLASH
 178         ulong addr_last = addr_first + size - 1;
 179
 180         /* round last address to the sector boundary */
 181         if (flash_sect_roundb(&addr_last) > 0)
 182                 return 1;
 183
 184         if (addr_first >= addr_last) {
 185                 printf("Error: end address exceeds addressing space\n");
 186                 return 1;
 187         }
 188
 189         /* remove protection on processed sectors */
 190         if (update_flash_protect(0, addr_first, addr_last) > 0) {
 191                 printf("Error: could not unprotect flash sectors\n");
 192                 return 1;
 193         }
 194
 195         printf("Erasing 0x%08lx - 0x%08lx", addr_first, addr_last);
 196         if (flash_sect_erase(addr_first, addr_last) > 0) {
 197                 printf("Error: could not erase flash\n");
 198                 return 1;
 199         }
 200
 201         printf("Copying to flash...");
 202         if (flash_write((char *)addr_source, addr_first, size) > 0) {
 203                 printf("Error: could not copy to flash\n");
 204                 return 1;
 205         }
 206         printf("done\n");
 207
 208         /* enable protection on processed sectors */
 209         if (update_flash_protect(1, addr_first, addr_last) > 0) {
 210                 printf("Error: could not protect flash sectors\n");
 211                 return 1;
 212         }
 213 #endif
 214         return 0;
 215 }
 216
 217 static int update_fit_getparams(const void *fit, int noffset, ulong *addr,
 218                                                 ulong *fladdr, ulong *size)
 219 {
 220         const void *data;
 221
 222         if (fit_image_get_data(fit, noffset, &data, (size_t *)size))
 223                 return 1;
 224
 225         if (fit_image_get_load(fit, noffset, (ulong *)fladdr))
 226                 return 1;
 227
 228         *addr = (ulong)data;
 229
 230         return 0;
 231 }
 232
 233 int update_tftp(ulong addr, char *interface, char *devstring)
 234 {
 235         char *filename, *env_addr, *fit_image_name;
 236         ulong update_addr, update_fladdr, update_size;
 237         int images_noffset, ndepth, noffset;
 238         bool update_tftp_dfu;
 239         int ret = 0;
 240         void *fit;
 241
 242         if (interface == NULL && devstring == NULL) {
 243                 update_tftp_dfu = false;
 244         } else if (interface && devstring) {
 245                 update_tftp_dfu = true;
 246         } else {
 247                 pr_err("Interface: %s and devstring: %s not supported!\n",
 248                       interface, devstring);
 249                 return -EINVAL;
 250         }
 251
 252         /* use already present image */
 253         if (addr)
 254                 goto got_update_file;
 255
 256         printf("Auto-update from TFTP: ");
 257
 258         /* get the file name of the update file */
 259         filename = env_get(UPDATE_FILE_ENV);
 260         if (filename == NULL) {
 261                 printf("failed, env. variable '%s' not found\n",
 262                                                         UPDATE_FILE_ENV);
 263                 return 1;
 264         }
 265
 266         printf("trying update file '%s'\n", filename);
 267
 268         /* get load address of downloaded update file */
 269         env_addr = env_get("loadaddr");
 270         if (env_addr)
 271                 addr = simple_strtoul(env_addr, NULL, 16);
 272         else
 273                 addr = CONFIG_UPDATE_LOAD_ADDR;
 274
 275
 276         if (update_load(filename, CONFIG_UPDATE_TFTP_MSEC_MAX,
 277                                         CONFIG_UPDATE_TFTP_CNT_MAX, addr)) {
 278                 printf("Can't load update file, aborting auto-update\n");
 279                 return 1;
 280         }
 281
 282 got_update_file:
 283         fit = (void *)addr;
 284
 285         if (!fit_check_format((void *)fit)) {
 286                 printf("Bad FIT format of the update file, aborting "
 287                                                         "auto-update\n");
 288                 return 1;
 289         }
 290
 291         /* process updates */
 292         images_noffset = fdt_path_offset(fit, FIT_IMAGES_PATH);
 293
 294         ndepth = 0;
 295         noffset = fdt_next_node(fit, images_noffset, &ndepth);
 296         while (noffset >= 0 && ndepth > 0) {
 297                 if (ndepth != 1)
 298                         goto next_node;
 299
 300                 fit_image_name = (char *)fit_get_name(fit, noffset, NULL);
 301                 printf("Processing update '%s' :", fit_image_name);
 302
 303                 if (!fit_image_verify(fit, noffset)) {
 304                         printf("Error: invalid update hash, aborting\n");
 305                         ret = 1;
 306                         goto next_node;
 307                 }
 308
 309                 printf("\n");
 310                 if (update_fit_getparams(fit, noffset, &update_addr,
 311                                         &update_fladdr, &update_size)) {
 312                         printf("Error: can't get update parameteres, "
 313                                                                 "aborting\n");
 314                         ret = 1;
 315                         goto next_node;
 316                 }
 317
 318                 if (!update_tftp_dfu) {
 319                         if (update_flash(update_addr, update_fladdr,
 320                                          update_size)) {
 321                                 printf("Error: can't flash update, aborting\n");
 322                                 ret = 1;
 323                                 goto next_node;
 324                         }
 325                 } else if (fit_image_check_type(fit, noffset,
 326                                                 IH_TYPE_FIRMWARE)) {
 327                         ret = dfu_tftp_write(fit_image_name, update_addr,
 328                                              update_size, interface, devstring);
 329                         if (ret)
 330                                 return ret;
 331                 }
 332 next_node:
 333                 noffset = fdt_next_node(fit, noffset, &ndepth);
 334         }
 335
 336         return ret;
 337 }