uboot/common/env_flash.c
<<
>>
Prefs
   1/*
   2 * (C) Copyright 2000-2010
   3 * Wolfgang Denk, DENX Software Engineering, wd@denx.de.
   4 *
   5 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
   6 * Andreas Heppel <aheppel@sysgo.de>
   7
   8 * SPDX-License-Identifier:     GPL-2.0+
   9 */
  10
  11/* #define DEBUG */
  12
  13#include <common.h>
  14#include <command.h>
  15#include <environment.h>
  16#include <linux/stddef.h>
  17#include <malloc.h>
  18#include <search.h>
  19#include <errno.h>
  20
  21DECLARE_GLOBAL_DATA_PTR;
  22
  23#if defined(CONFIG_CMD_SAVEENV) && defined(CONFIG_CMD_FLASH)
  24#define CMD_SAVEENV
  25#elif defined(CONFIG_ENV_ADDR_REDUND)
  26#error CONFIG_ENV_ADDR_REDUND must have CONFIG_CMD_SAVEENV & CONFIG_CMD_FLASH
  27#endif
  28
  29#if defined(CONFIG_ENV_SIZE_REDUND) &&  \
  30        (CONFIG_ENV_SIZE_REDUND < CONFIG_ENV_SIZE)
  31#error CONFIG_ENV_SIZE_REDUND should not be less then CONFIG_ENV_SIZE
  32#endif
  33
  34char *env_name_spec = "Flash";
  35
  36#ifdef ENV_IS_EMBEDDED
  37env_t *env_ptr = &environment;
  38
  39static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  40
  41#else /* ! ENV_IS_EMBEDDED */
  42
  43env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
  44static env_t *flash_addr = (env_t *)CONFIG_ENV_ADDR;
  45#endif /* ENV_IS_EMBEDDED */
  46
  47#if defined(CMD_SAVEENV) || defined(CONFIG_ENV_ADDR_REDUND)
  48/* CONFIG_ENV_ADDR is supposed to be on sector boundary */
  49static ulong end_addr = CONFIG_ENV_ADDR + CONFIG_ENV_SECT_SIZE - 1;
  50#endif
  51
  52#ifdef CONFIG_ENV_ADDR_REDUND
  53static env_t *flash_addr_new = (env_t *)CONFIG_ENV_ADDR_REDUND;
  54
  55/* CONFIG_ENV_ADDR_REDUND is supposed to be on sector boundary */
  56static ulong end_addr_new = CONFIG_ENV_ADDR_REDUND + CONFIG_ENV_SECT_SIZE - 1;
  57#endif /* CONFIG_ENV_ADDR_REDUND */
  58
  59
  60#ifdef CONFIG_ENV_ADDR_REDUND
  61int env_init(void)
  62{
  63        int crc1_ok = 0, crc2_ok = 0;
  64
  65        uchar flag1 = flash_addr->flags;
  66        uchar flag2 = flash_addr_new->flags;
  67
  68        ulong addr_default = (ulong)&default_environment[0];
  69        ulong addr1 = (ulong)&(flash_addr->data);
  70        ulong addr2 = (ulong)&(flash_addr_new->data);
  71
  72        crc1_ok = crc32(0, flash_addr->data, ENV_SIZE) == flash_addr->crc;
  73        crc2_ok =
  74                crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc;
  75
  76        if (crc1_ok && !crc2_ok) {
  77                gd->env_addr    = addr1;
  78                gd->env_valid   = 1;
  79        } else if (!crc1_ok && crc2_ok) {
  80                gd->env_addr    = addr2;
  81                gd->env_valid   = 1;
  82        } else if (!crc1_ok && !crc2_ok) {
  83                gd->env_addr    = addr_default;
  84                gd->env_valid   = 0;
  85        } else if (flag1 == ACTIVE_FLAG && flag2 == OBSOLETE_FLAG) {
  86                gd->env_addr    = addr1;
  87                gd->env_valid   = 1;
  88        } else if (flag1 == OBSOLETE_FLAG && flag2 == ACTIVE_FLAG) {
  89                gd->env_addr    = addr2;
  90                gd->env_valid   = 1;
  91        } else if (flag1 == flag2) {
  92                gd->env_addr    = addr1;
  93                gd->env_valid   = 2;
  94        } else if (flag1 == 0xFF) {
  95                gd->env_addr    = addr1;
  96                gd->env_valid   = 2;
  97        } else if (flag2 == 0xFF) {
  98                gd->env_addr    = addr2;
  99                gd->env_valid   = 2;
 100        }
 101
 102        return 0;
 103}
 104
 105#ifdef CMD_SAVEENV
 106int saveenv(void)
 107{
 108        env_t   env_new;
 109        ssize_t len;
 110        char    *res, *saved_data = NULL;
 111        char    flag = OBSOLETE_FLAG, new_flag = ACTIVE_FLAG;
 112        int     rc = 1;
 113#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 114        ulong   up_data = 0;
 115#endif
 116
 117        debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
 118
 119        if (flash_sect_protect(0, (ulong)flash_addr, end_addr))
 120                goto done;
 121
 122        debug("Protect off %08lX ... %08lX\n",
 123                (ulong)flash_addr_new, end_addr_new);
 124
 125        if (flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new))
 126                goto done;
 127
 128        res = (char *)&env_new.data;
 129        len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 130        if (len < 0) {
 131                error("Cannot export environment: errno = %d\n", errno);
 132                goto done;
 133        }
 134        env_new.crc     = crc32(0, env_new.data, ENV_SIZE);
 135        env_new.flags   = new_flag;
 136
 137#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 138        up_data = end_addr_new + 1 - ((long)flash_addr_new + CONFIG_ENV_SIZE);
 139        debug("Data to save 0x%lX\n", up_data);
 140        if (up_data) {
 141                saved_data = malloc(up_data);
 142                if (saved_data == NULL) {
 143                        printf("Unable to save the rest of sector (%ld)\n",
 144                                up_data);
 145                        goto done;
 146                }
 147                memcpy(saved_data,
 148                        (void *)((long)flash_addr_new + CONFIG_ENV_SIZE),
 149                        up_data);
 150                debug("Data (start 0x%lX, len 0x%lX) saved at 0x%p\n",
 151                        (long)flash_addr_new + CONFIG_ENV_SIZE,
 152                        up_data, saved_data);
 153        }
 154#endif
 155        puts("Erasing Flash...");
 156        debug(" %08lX ... %08lX ...", (ulong)flash_addr_new, end_addr_new);
 157
 158        if (flash_sect_erase((ulong)flash_addr_new, end_addr_new))
 159                goto done;
 160
 161        puts("Writing to Flash... ");
 162        debug(" %08lX ... %08lX ...",
 163                (ulong)&(flash_addr_new->data),
 164                sizeof(env_ptr->data) + (ulong)&(flash_addr_new->data));
 165        rc = flash_write((char *)&env_new, (ulong)flash_addr_new,
 166                         sizeof(env_new));
 167        if (rc)
 168                goto perror;
 169
 170        rc = flash_write(&flag, (ulong)&(flash_addr->flags),
 171                         sizeof(flash_addr->flags));
 172        if (rc)
 173                goto perror;
 174
 175#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 176        if (up_data) { /* restore the rest of sector */
 177                debug("Restoring the rest of data to 0x%lX len 0x%lX\n",
 178                        (long)flash_addr_new + CONFIG_ENV_SIZE, up_data);
 179                if (flash_write(saved_data,
 180                                (long)flash_addr_new + CONFIG_ENV_SIZE,
 181                                up_data))
 182                        goto perror;
 183        }
 184#endif
 185        puts("done\n");
 186
 187        {
 188                env_t *etmp = flash_addr;
 189                ulong ltmp = end_addr;
 190
 191                flash_addr = flash_addr_new;
 192                flash_addr_new = etmp;
 193
 194                end_addr = end_addr_new;
 195                end_addr_new = ltmp;
 196        }
 197
 198        rc = 0;
 199        goto done;
 200perror:
 201        flash_perror(rc);
 202done:
 203        if (saved_data)
 204                free(saved_data);
 205        /* try to re-protect */
 206        flash_sect_protect(1, (ulong)flash_addr, end_addr);
 207        flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 208
 209        return rc;
 210}
 211#endif /* CMD_SAVEENV */
 212
 213#else /* ! CONFIG_ENV_ADDR_REDUND */
 214
 215int env_init(void)
 216{
 217        if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
 218                gd->env_addr    = (ulong)&(env_ptr->data);
 219                gd->env_valid   = 1;
 220                return 0;
 221        }
 222
 223        gd->env_addr    = (ulong)&default_environment[0];
 224        gd->env_valid   = 0;
 225        return 0;
 226}
 227
 228#ifdef CMD_SAVEENV
 229int saveenv(void)
 230{
 231        env_t   env_new;
 232        ssize_t len;
 233        int     rc = 1;
 234        char    *res, *saved_data = NULL;
 235#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 236        ulong   up_data = 0;
 237
 238        up_data = end_addr + 1 - ((long)flash_addr + CONFIG_ENV_SIZE);
 239        debug("Data to save 0x%lx\n", up_data);
 240        if (up_data) {
 241                saved_data = malloc(up_data);
 242                if (saved_data == NULL) {
 243                        printf("Unable to save the rest of sector (%ld)\n",
 244                                up_data);
 245                        goto done;
 246                }
 247                memcpy(saved_data,
 248                        (void *)((long)flash_addr + CONFIG_ENV_SIZE), up_data);
 249                debug("Data (start 0x%lx, len 0x%lx) saved at 0x%lx\n",
 250                        (ulong)flash_addr + CONFIG_ENV_SIZE,
 251                        up_data,
 252                        (ulong)saved_data);
 253        }
 254#endif  /* CONFIG_ENV_SECT_SIZE */
 255
 256        debug("Protect off %08lX ... %08lX\n", (ulong)flash_addr, end_addr);
 257
 258        if (flash_sect_protect(0, (long)flash_addr, end_addr))
 259                goto done;
 260
 261        res = (char *)&env_new.data;
 262        len = hexport_r(&env_htab, '\0', 0, &res, ENV_SIZE, 0, NULL);
 263        if (len < 0) {
 264                error("Cannot export environment: errno = %d\n", errno);
 265                goto done;
 266        }
 267        env_new.crc = crc32(0, env_new.data, ENV_SIZE);
 268
 269        puts("Erasing Flash...");
 270        if (flash_sect_erase((long)flash_addr, end_addr))
 271                goto done;
 272
 273        puts("Writing to Flash... ");
 274        rc = flash_write((char *)&env_new, (long)flash_addr, CONFIG_ENV_SIZE);
 275        if (rc != 0)
 276                goto perror;
 277
 278#if CONFIG_ENV_SECT_SIZE > CONFIG_ENV_SIZE
 279        if (up_data) {  /* restore the rest of sector */
 280                debug("Restoring the rest of data to 0x%lx len 0x%lx\n",
 281                        (ulong)flash_addr + CONFIG_ENV_SIZE, up_data);
 282                if (flash_write(saved_data,
 283                                (long)flash_addr + CONFIG_ENV_SIZE,
 284                                up_data))
 285                        goto perror;
 286        }
 287#endif
 288        puts("done\n");
 289        rc = 0;
 290        goto done;
 291perror:
 292        flash_perror(rc);
 293done:
 294        if (saved_data)
 295                free(saved_data);
 296        /* try to re-protect */
 297        flash_sect_protect(1, (long)flash_addr, end_addr);
 298        return rc;
 299}
 300#endif /* CMD_SAVEENV */
 301
 302#endif /* CONFIG_ENV_ADDR_REDUND */
 303
 304void env_relocate_spec(void)
 305{
 306#ifdef CONFIG_ENV_ADDR_REDUND
 307        if (gd->env_addr != (ulong)&(flash_addr->data)) {
 308                env_t *etmp = flash_addr;
 309                ulong ltmp = end_addr;
 310
 311                flash_addr = flash_addr_new;
 312                flash_addr_new = etmp;
 313
 314                end_addr = end_addr_new;
 315                end_addr_new = ltmp;
 316        }
 317
 318        if (flash_addr_new->flags != OBSOLETE_FLAG &&
 319            crc32(0, flash_addr_new->data, ENV_SIZE) == flash_addr_new->crc) {
 320                char flag = OBSOLETE_FLAG;
 321
 322                gd->env_valid = 2;
 323                flash_sect_protect(0, (ulong)flash_addr_new, end_addr_new);
 324                flash_write(&flag,
 325                            (ulong)&(flash_addr_new->flags),
 326                            sizeof(flash_addr_new->flags));
 327                flash_sect_protect(1, (ulong)flash_addr_new, end_addr_new);
 328        }
 329
 330        if (flash_addr->flags != ACTIVE_FLAG &&
 331            (flash_addr->flags & ACTIVE_FLAG) == ACTIVE_FLAG) {
 332                char flag = ACTIVE_FLAG;
 333
 334                gd->env_valid = 2;
 335                flash_sect_protect(0, (ulong)flash_addr, end_addr);
 336                flash_write(&flag,
 337                            (ulong)&(flash_addr->flags),
 338                            sizeof(flash_addr->flags));
 339                flash_sect_protect(1, (ulong)flash_addr, end_addr);
 340        }
 341
 342        if (gd->env_valid == 2)
 343                puts("*** Warning - some problems detected "
 344                     "reading environment; recovered successfully\n\n");
 345#endif /* CONFIG_ENV_ADDR_REDUND */
 346
 347        env_import((char *)flash_addr, 1);
 348}
 349