blob: 79201bd788be1ec83e41de807af570567e52dc23 [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
wdenkc6097192002-11-03 00:24:07 +00002/*
Wolfgang Denkea882ba2010-06-20 23:33:59 +02003 * (C) Copyright 2000-2010
wdenkc6097192002-11-03 00:24:07 +00004 * 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>
wdenkc6097192002-11-03 00:24:07 +00008 */
9
10/*
11 * 09-18-2001 Andreas Heppel, Sysgo RTS GmbH <aheppel@sysgo.de>
12 *
13 * It might not be possible in all cases to use 'memcpy()' to copy
14 * the environment to NVRAM, as the NVRAM might not be mapped into
15 * the memory space. (I.e. this is the case for the BAB750). In those
16 * cases it might be possible to access the NVRAM using a different
17 * method. For example, the RTC on the BAB750 is accessible in IO
18 * space using its address and data registers. To enable usage of
19 * NVRAM in those cases I invented the functions 'nvram_read()' and
20 * 'nvram_write()', which will be activated upon the configuration
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020021 * #define CONFIG_SYS_NVRAM_ACCESS_ROUTINE. Note, that those functions are
wdenkc6097192002-11-03 00:24:07 +000022 * strongly dependent on the used HW, and must be redefined for each
23 * board that wants to use them.
24 */
25
26#include <common.h>
wdenkc6097192002-11-03 00:24:07 +000027#include <command.h>
Simon Glass7b51b572019-08-01 09:46:52 -060028#include <env.h>
Simon Glassf3998fd2019-08-02 09:44:25 -060029#include <env_internal.h>
wdenkc6097192002-11-03 00:24:07 +000030#include <linux/stddef.h>
Wolfgang Denkea882ba2010-06-20 23:33:59 +020031#include <search.h>
32#include <errno.h>
wdenkc6097192002-11-03 00:24:07 +000033
Jean-Christophe PLAGNIOL-VILLARD957a0e62008-09-10 22:47:59 +020034DECLARE_GLOBAL_DATA_PTR;
35
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020036#ifdef CONFIG_SYS_NVRAM_ACCESS_ROUTINE
wdenkc6097192002-11-03 00:24:07 +000037extern void *nvram_read(void *dest, const long src, size_t count);
38extern void nvram_write(long dest, const void *src, size_t count);
wdenkc6097192002-11-03 00:24:07 +000039#else
Jean-Christophe PLAGNIOL-VILLARD0e8d1582008-09-10 22:48:06 +020040env_t *env_ptr = (env_t *)CONFIG_ENV_ADDR;
wdenkc6097192002-11-03 00:24:07 +000041#endif
42
Igor Grinbergbf95df42011-12-26 03:33:10 +000043#ifdef CONFIG_SYS_NVRAM_ACCESS_ROUTINE
Goldschmidt Simonb2cdef42018-02-09 20:23:17 +000044/** Call this function from overridden env_get_char_spec() if you need
45 * this functionality.
46 */
47int env_nvram_get_char(int index)
wdenkc6097192002-11-03 00:24:07 +000048{
wdenkc6097192002-11-03 00:24:07 +000049 uchar c;
50
Igor Grinberg91494ca2011-11-07 01:14:04 +000051 nvram_read(&c, CONFIG_ENV_ADDR + index, 1);
wdenkc6097192002-11-03 00:24:07 +000052
53 return c;
wdenkc6097192002-11-03 00:24:07 +000054}
Igor Grinbergbf95df42011-12-26 03:33:10 +000055#endif
wdenkc6097192002-11-03 00:24:07 +000056
Simon Glassc5951992017-08-03 12:22:17 -060057static int env_nvram_load(void)
wdenkc6097192002-11-03 00:24:07 +000058{
Tom Rinicd0f4fa2013-04-05 14:55:21 -040059 char buf[CONFIG_ENV_SIZE];
Wolfgang Denkea882ba2010-06-20 23:33:59 +020060
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020061#if defined(CONFIG_SYS_NVRAM_ACCESS_ROUTINE)
Wolfgang Denkea882ba2010-06-20 23:33:59 +020062 nvram_read(buf, CONFIG_ENV_ADDR, CONFIG_ENV_SIZE);
wdenkc6097192002-11-03 00:24:07 +000063#else
Tom Rinicd0f4fa2013-04-05 14:55:21 -040064 memcpy(buf, (void *)CONFIG_ENV_ADDR, CONFIG_ENV_SIZE);
wdenkc6097192002-11-03 00:24:07 +000065#endif
Simon Goldschmidt2166ebf2018-01-31 14:47:12 +010066 return env_import(buf, 1);
wdenkc6097192002-11-03 00:24:07 +000067}
68
Simon Glasse5bce242017-08-03 12:22:01 -060069static int env_nvram_save(void)
wdenkc6097192002-11-03 00:24:07 +000070{
Tom Rinicd0f4fa2013-04-05 14:55:21 -040071 env_t env_new;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020072 int rcode = 0;
73
Marek Vasut7ce15262014-03-05 19:59:50 +010074 rcode = env_export(&env_new);
75 if (rcode)
76 return rcode;
Wolfgang Denkea882ba2010-06-20 23:33:59 +020077
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020078#ifdef CONFIG_SYS_NVRAM_ACCESS_ROUTINE
Tom Rinicd0f4fa2013-04-05 14:55:21 -040079 nvram_write(CONFIG_ENV_ADDR, &env_new, CONFIG_ENV_SIZE);
80#else
81 if (memcpy((char *)CONFIG_ENV_ADDR, &env_new, CONFIG_ENV_SIZE) == NULL)
82 rcode = 1;
wdenkc6097192002-11-03 00:24:07 +000083#endif
84 return rcode;
85}
86
Wolfgang Denkea882ba2010-06-20 23:33:59 +020087/*
wdenkc6097192002-11-03 00:24:07 +000088 * Initialize Environment use
89 *
90 * We are still running from ROM, so data use is limited
91 */
Simon Glasse5bce242017-08-03 12:22:01 -060092static int env_nvram_init(void)
wdenkc6097192002-11-03 00:24:07 +000093{
Jean-Christophe PLAGNIOL-VILLARD6d0f6bc2008-10-16 15:01:15 +020094#if defined(CONFIG_SYS_NVRAM_ACCESS_ROUTINE)
wdenkc6097192002-11-03 00:24:07 +000095 ulong crc;
Tom Rinicd0f4fa2013-04-05 14:55:21 -040096 uchar data[ENV_SIZE];
Wolfgang Denkea882ba2010-06-20 23:33:59 +020097
98 nvram_read(&crc, CONFIG_ENV_ADDR, sizeof(ulong));
Igor Grinberg91494ca2011-11-07 01:14:04 +000099 nvram_read(data, CONFIG_ENV_ADDR + sizeof(ulong), ENV_SIZE);
wdenkc6097192002-11-03 00:24:07 +0000100
101 if (crc32(0, data, ENV_SIZE) == crc) {
Igor Grinberg91494ca2011-11-07 01:14:04 +0000102 gd->env_addr = (ulong)CONFIG_ENV_ADDR + sizeof(long);
wdenkc6097192002-11-03 00:24:07 +0000103#else
104 if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
Igor Grinberg91494ca2011-11-07 01:14:04 +0000105 gd->env_addr = (ulong)&env_ptr->data;
wdenkc6097192002-11-03 00:24:07 +0000106#endif
Simon Glass203e94f2017-08-03 12:21:56 -0600107 gd->env_valid = ENV_VALID;
wdenkc6097192002-11-03 00:24:07 +0000108 } else {
Igor Grinberg91494ca2011-11-07 01:14:04 +0000109 gd->env_addr = (ulong)&default_environment[0];
Simon Glass2d7cb5b2017-08-20 04:45:15 -0600110 gd->env_valid = ENV_INVALID;
wdenkc6097192002-11-03 00:24:07 +0000111 }
Igor Grinberg91494ca2011-11-07 01:14:04 +0000112
113 return 0;
wdenkc6097192002-11-03 00:24:07 +0000114}
Simon Glass4415f1d2017-08-03 12:21:58 -0600115
116U_BOOT_ENV_LOCATION(nvram) = {
117 .location = ENVL_NVRAM,
Simon Glassac358be2017-08-03 12:22:03 -0600118 ENV_NAME("NVRAM")
Simon Glasse5bce242017-08-03 12:22:01 -0600119 .load = env_nvram_load,
120 .save = env_save_ptr(env_nvram_save),
121 .init = env_nvram_init,
Simon Glass4415f1d2017-08-03 12:21:58 -0600122};