env/sf.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2000-2010
   4  * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   5  *
   6  * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   7  * Andreas Heppel <aheppel@sysgo.de>
   8  *
   9  * (C) Copyright 2008 Atmel Corporation
  10  */
  11 #include <common.h>
  12 #include <dm.h>
  13 #include <env.h>
  14 #include <env_internal.h>
  15 #include <flash.h>
  16 #include <malloc.h>
  17 #include <spi.h>
  18 #include <spi_flash.h>
  19 #include <search.h>
  20 #include <errno.h>
  21 #include <uuid.h>
  22 #include <asm/cache.h>
  23 #include <asm/global_data.h>
  24 #include <dm/device-internal.h>
  25 #include <u-boot/crc.h>
  26
  27 #ifndef CONFIG_SPL_BUILD
  28 #define INITENV
  29 #endif
  30
  31 #ifdef CONFIG_ENV_OFFSET_REDUND
  32 static ulong env_offset         = CONFIG_ENV_OFFSET;
  33 static ulong env_new_offset     = CONFIG_ENV_OFFSET_REDUND;
  34 #endif /* CONFIG_ENV_OFFSET_REDUND */
  35
  36 DECLARE_GLOBAL_DATA_PTR;
  37
  38 static struct spi_flash *env_flash;
  39
  40 static int setup_flash_device(void)
  41 {
  42 #if CONFIG_IS_ENABLED(DM_SPI_FLASH)
  43         struct udevice *new;
  44         int     ret;
  45
  46         /* speed and mode will be read from DT */
  47         ret = spi_flash_probe_bus_cs(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  48                                      CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE,
  49                                      &new);
  50         if (ret) {
  51                 env_set_default("spi_flash_probe_bus_cs() failed", 0);
  52                 return ret;
  53         }
  54
  55         env_flash = dev_get_uclass_priv(new);
  56 #else
  57         if (env_flash)
  58                 spi_flash_free(env_flash);
  59
  60         env_flash = spi_flash_probe(CONFIG_ENV_SPI_BUS, CONFIG_ENV_SPI_CS,
  61                                     CONFIG_ENV_SPI_MAX_HZ, CONFIG_ENV_SPI_MODE);
  62         if (!env_flash) {
  63                 env_set_default("spi_flash_probe() failed", 0);
  64                 return -EIO;
  65         }
  66 #endif
  67         return 0;
  68 }
  69
  70 #if defined(CONFIG_ENV_OFFSET_REDUND)
  71 static int env_sf_save(void)
  72 {
  73         env_t   env_new;
  74         char    *saved_buffer = NULL, flag = ENV_REDUND_OBSOLETE;
  75         u32     saved_size = 0, saved_offset = 0, sector;
  76         u32     sect_size = CONFIG_ENV_SECT_SIZE;
  77         int     ret;
  78
  79         ret = setup_flash_device();
  80         if (ret)
  81                 return ret;
  82
  83         if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
  84                 sect_size = env_flash->mtd.erasesize;
  85
  86         ret = env_export(&env_new);
  87         if (ret)
  88                 return -EIO;
  89         env_new.flags   = ENV_REDUND_ACTIVE;
  90
  91         if (gd->env_valid == ENV_VALID) {
  92                 env_new_offset = CONFIG_ENV_OFFSET_REDUND;
  93                 env_offset = CONFIG_ENV_OFFSET;
  94         } else {
  95                 env_new_offset = CONFIG_ENV_OFFSET;
  96                 env_offset = CONFIG_ENV_OFFSET_REDUND;
  97         }
  98
  99         /* Is the sector larger than the env (i.e. embedded) */
 100         if (sect_size > CONFIG_ENV_SIZE) {
 101                 saved_size = sect_size - CONFIG_ENV_SIZE;
 102                 saved_offset = env_new_offset + CONFIG_ENV_SIZE;
 103                 saved_buffer = memalign(ARCH_DMA_MINALIGN, saved_size);
 104                 if (!saved_buffer) {
 105                         ret = -ENOMEM;
 106                         goto done;
 107                 }
 108                 ret = spi_flash_read(env_flash, saved_offset,
 109                                         saved_size, saved_buffer);
 110                 if (ret)
 111                         goto done;
 112         }
 113
 114         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 115
 116         puts("Erasing SPI flash...");
 117         ret = spi_flash_erase(env_flash, env_new_offset,
 118                                 sector * sect_size);
 119         if (ret)
 120                 goto done;
 121
 122         puts("Writing to SPI flash...");
 123
 124         ret = spi_flash_write(env_flash, env_new_offset,
 125                 CONFIG_ENV_SIZE, &env_new);
 126         if (ret)
 127                 goto done;
 128
 129         if (sect_size > CONFIG_ENV_SIZE) {
 130                 ret = spi_flash_write(env_flash, saved_offset,
 131                                         saved_size, saved_buffer);
 132                 if (ret)
 133                         goto done;
 134         }
 135
 136         ret = spi_flash_write(env_flash, env_offset + offsetof(env_t, flags),
 137                                 sizeof(env_new.flags), &flag);
 138         if (ret)
 139                 goto done;
 140
 141         puts("done\n");
 142
 143         gd->env_valid = gd->env_valid == ENV_REDUND ? ENV_VALID : ENV_REDUND;
 144
 145         printf("Valid environment: %d\n", (int)gd->env_valid);
 146
 147 done:
 148         if (saved_buffer)
 149                 free(saved_buffer);
 150
 151         return ret;
 152 }
 153
 154 static int env_sf_load(void)
 155 {
 156         int ret;
 157         int read1_fail, read2_fail;
 158         env_t *tmp_env1, *tmp_env2;
 159
 160         tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 161                         CONFIG_ENV_SIZE);
 162         tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 163                         CONFIG_ENV_SIZE);
 164         if (!tmp_env1 || !tmp_env2) {
 165                 env_set_default("malloc() failed", 0);
 166                 ret = -EIO;
 167                 goto out;
 168         }
 169
 170         ret = setup_flash_device();
 171         if (ret)
 172                 goto out;
 173
 174         read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 175                                     CONFIG_ENV_SIZE, tmp_env1);
 176         read2_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET_REDUND,
 177                                     CONFIG_ENV_SIZE, tmp_env2);
 178
 179         ret = env_import_redund((char *)tmp_env1, read1_fail, (char *)tmp_env2,
 180                                 read2_fail, H_EXTERNAL);
 181
 182         spi_flash_free(env_flash);
 183         env_flash = NULL;
 184 out:
 185         free(tmp_env1);
 186         free(tmp_env2);
 187
 188         return ret;
 189 }
 190 #else
 191 static int env_sf_save(void)
 192 {
 193         u32     saved_size = 0, saved_offset = 0, sector;
 194         u32     sect_size = CONFIG_ENV_SECT_SIZE;
 195         char    *saved_buffer = NULL;
 196         int     ret = 1;
 197         env_t   env_new;
 198
 199         ret = setup_flash_device();
 200         if (ret)
 201                 return ret;
 202
 203         if (IS_ENABLED(CONFIG_ENV_SECT_SIZE_AUTO))
 204                 sect_size = env_flash->mtd.erasesize;
 205
 206         /* Is the sector larger than the env (i.e. embedded) */
 207         if (sect_size > CONFIG_ENV_SIZE) {
 208                 saved_size = sect_size - CONFIG_ENV_SIZE;
 209                 saved_offset = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
 210                 saved_buffer = malloc(saved_size);
 211                 if (!saved_buffer)
 212                         goto done;
 213
 214                 ret = spi_flash_read(env_flash, saved_offset,
 215                         saved_size, saved_buffer);
 216                 if (ret)
 217                         goto done;
 218         }
 219
 220         ret = env_export(&env_new);
 221         if (ret)
 222                 goto done;
 223
 224         sector = DIV_ROUND_UP(CONFIG_ENV_SIZE, sect_size);
 225
 226         puts("Erasing SPI flash...");
 227         ret = spi_flash_erase(env_flash, CONFIG_ENV_OFFSET,
 228                 sector * sect_size);
 229         if (ret)
 230                 goto done;
 231
 232         puts("Writing to SPI flash...");
 233         ret = spi_flash_write(env_flash, CONFIG_ENV_OFFSET,
 234                 CONFIG_ENV_SIZE, &env_new);
 235         if (ret)
 236                 goto done;
 237
 238         if (sect_size > CONFIG_ENV_SIZE) {
 239                 ret = spi_flash_write(env_flash, saved_offset,
 240                         saved_size, saved_buffer);
 241                 if (ret)
 242                         goto done;
 243         }
 244
 245         ret = 0;
 246         puts("done\n");
 247
 248 done:
 249         if (saved_buffer)
 250                 free(saved_buffer);
 251
 252         return ret;
 253 }
 254
 255 static int env_sf_load(void)
 256 {
 257         int ret;
 258         char *buf = NULL;
 259
 260         buf = (char *)memalign(ARCH_DMA_MINALIGN, CONFIG_ENV_SIZE);
 261         if (!buf) {
 262                 env_set_default("malloc() failed", 0);
 263                 return -EIO;
 264         }
 265
 266         ret = setup_flash_device();
 267         if (ret)
 268                 goto out;
 269
 270         ret = spi_flash_read(env_flash,
 271                 CONFIG_ENV_OFFSET, CONFIG_ENV_SIZE, buf);
 272         if (ret) {
 273                 env_set_default("spi_flash_read() failed", 0);
 274                 goto err_read;
 275         }
 276
 277         ret = env_import(buf, 1, H_EXTERNAL);
 278         if (!ret)
 279                 gd->env_valid = ENV_VALID;
 280
 281 err_read:
 282         spi_flash_free(env_flash);
 283         env_flash = NULL;
 284 out:
 285         free(buf);
 286
 287         return ret;
 288 }
 289 #endif
 290
 291 #if CONFIG_ENV_ADDR != 0x0
 292 __weak void *env_sf_get_env_addr(void)
 293 {
 294         return (void *)CONFIG_ENV_ADDR;
 295 }
 296 #endif
 297
 298 #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
 299 /*
 300  * check if Environment on CONFIG_ENV_ADDR is valid.
 301  */
 302 static int env_sf_init_addr(void)
 303 {
 304         env_t *env_ptr = (env_t *)env_sf_get_env_addr();
 305
 306         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 307                 gd->env_addr    = (ulong)&(env_ptr->data);
 308                 gd->env_valid   = 1;
 309         } else {
 310                 gd->env_addr = (ulong)&default_environment[0];
 311                 gd->env_valid = 1;
 312         }
 313
 314         return 0;
 315 }
 316 #endif
 317
 318 #if defined(CONFIG_ENV_SPI_EARLY)
 319 /*
 320  * early load environment from SPI flash (before relocation)
 321  * and check if it is valid.
 322  */
 323 static int env_sf_init_early(void)
 324 {
 325         int ret;
 326         int read1_fail;
 327         int read2_fail;
 328         int crc1_ok;
 329         env_t *tmp_env2 = NULL;
 330         env_t *tmp_env1;
 331
 332         /*
 333          * if malloc is not ready yet, we cannot use
 334          * this part yet.
 335          */
 336         if (!gd->malloc_limit)
 337                 return -ENOENT;
 338
 339         tmp_env1 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 340                         CONFIG_ENV_SIZE);
 341         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
 342                 tmp_env2 = (env_t *)memalign(ARCH_DMA_MINALIGN,
 343                                              CONFIG_ENV_SIZE);
 344
 345         if (!tmp_env1 || !tmp_env2)
 346                 goto out;
 347
 348         ret = setup_flash_device();
 349         if (ret)
 350                 goto out;
 351
 352         read1_fail = spi_flash_read(env_flash, CONFIG_ENV_OFFSET,
 353                                     CONFIG_ENV_SIZE, tmp_env1);
 354
 355         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT)) {
 356                 read2_fail = spi_flash_read(env_flash,
 357                                             CONFIG_ENV_OFFSET_REDUND,
 358                                             CONFIG_ENV_SIZE, tmp_env2);
 359                 ret = env_check_redund((char *)tmp_env1, read1_fail,
 360                                        (char *)tmp_env2, read2_fail);
 361
 362                 if (ret == -EIO || ret == -ENOMSG)
 363                         goto err_read;
 364
 365                 if (gd->env_valid == ENV_VALID)
 366                         gd->env_addr = (unsigned long)&tmp_env1->data;
 367                 else
 368                         gd->env_addr = (unsigned long)&tmp_env2->data;
 369         } else {
 370                 if (read1_fail)
 371                         goto err_read;
 372
 373                 crc1_ok = crc32(0, tmp_env1->data, ENV_SIZE) ==
 374                                 tmp_env1->crc;
 375                 if (!crc1_ok)
 376                         goto err_read;
 377
 378                 /* if valid -> this is our env */
 379                 gd->env_valid = ENV_VALID;
 380                 gd->env_addr = (unsigned long)&tmp_env1->data;
 381         }
 382
 383         return 0;
 384 err_read:
 385         spi_flash_free(env_flash);
 386         env_flash = NULL;
 387         free(tmp_env1);
 388         if (IS_ENABLED(CONFIG_SYS_REDUNDAND_ENVIRONMENT))
 389                 free(tmp_env2);
 390 out:
 391         /* env is not valid. always return 0 */
 392         gd->env_valid = ENV_INVALID;
 393         return 0;
 394 }
 395 #endif
 396
 397 static int env_sf_init(void)
 398 {
 399 #if defined(INITENV) && (CONFIG_ENV_ADDR != 0x0)
 400         return env_sf_init_addr();
 401 #elif defined(CONFIG_ENV_SPI_EARLY)
 402         return env_sf_init_early();
 403 #endif
 404         /*
 405          * return here -ENOENT, so env_init()
 406          * can set the init bit and later if no
 407          * other Environment storage is defined
 408          * can set the default environment
 409          */
 410         return -ENOENT;
 411 }
 412
 413 U_BOOT_ENV_LOCATION(sf) = {
 414         .location       = ENVL_SPI_FLASH,
 415         ENV_NAME("SPIFlash")
 416         .load           = env_sf_load,
 417         .save           = CONFIG_IS_ENABLED(SAVEENV) ? ENV_SAVE_PTR(env_sf_save) : NULL,
 418         .init           = env_sf_init,
 419 };