* Code cleanup:
[kernel/u-boot.git] / common / env_nvram.c
1 /*
2  * (C) Copyright 2000-2002
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  * See file CREDITS for list of people who contributed to this
9  * project.
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License as
13  * published by the Free Software Foundation; either version 2 of
14  * the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
24  * MA 02111-1307 USA
25  */
26
27 /*
28  * 09-18-2001 Andreas Heppel, Sysgo RTS GmbH <aheppel@sysgo.de>
29  *
30  * It might not be possible in all cases to use 'memcpy()' to copy
31  * the environment to NVRAM, as the NVRAM might not be mapped into
32  * the memory space. (I.e. this is the case for the BAB750). In those
33  * cases it might be possible to access the NVRAM using a different
34  * method. For example, the RTC on the BAB750 is accessible in IO
35  * space using its address and data registers. To enable usage of
36  * NVRAM in those cases I invented the functions 'nvram_read()' and
37  * 'nvram_write()', which will be activated upon the configuration
38  * #define CFG_NVRAM_ACCESS_ROUTINE. Note, that those functions are
39  * strongly dependent on the used HW, and must be redefined for each
40  * board that wants to use them.
41  */
42
43 #include <common.h>
44
45 #ifdef CFG_ENV_IS_IN_NVRAM /* Environment is in NVRAM */
46
47 #include <command.h>
48 #include <environment.h>
49 #include <linux/stddef.h>
50 #include <malloc.h>
51
52 #ifdef CFG_NVRAM_ACCESS_ROUTINE
53 extern void *nvram_read(void *dest, const long src, size_t count);
54 extern void nvram_write(long dest, const void *src, size_t count);
55 env_t *env_ptr = NULL;
56 #else
57 env_t *env_ptr = (env_t *)CFG_ENV_ADDR;
58 #endif
59
60 char * env_name_spec = "NVRAM";
61
62 extern uchar default_environment[];
63 extern int default_environment_size;
64
65 extern uchar (*env_get_char)(int);
66 extern uchar env_get_char_memory (int index);
67
68 #ifdef CONFIG_AMIGAONEG3SE
69 uchar env_get_char_spec (int index)
70 {
71 #ifdef CFG_NVRAM_ACCESS_ROUTINE
72         uchar c;
73
74         nvram_read(&c, CFG_ENV_ADDR+index, 1);
75
76         return c;
77 #else
78         DECLARE_GLOBAL_DATA_PTR;
79         uchar retval;
80         enable_nvram();
81         retval = *((uchar *)(gd->env_addr + index));
82         disable_nvram();
83         return retval;
84 #endif
85 }
86 #else
87 uchar env_get_char_spec (int index)
88 {
89 #ifdef CFG_NVRAM_ACCESS_ROUTINE
90         uchar c;
91
92         nvram_read(&c, CFG_ENV_ADDR+index, 1);
93
94         return c;
95 #else
96         DECLARE_GLOBAL_DATA_PTR;
97
98         return *((uchar *)(gd->env_addr + index));
99 #endif
100 }
101 #endif
102
103 void env_relocate_spec (void)
104 {
105 #if defined(CFG_NVRAM_ACCESS_ROUTINE)
106         nvram_read(env_ptr, CFG_ENV_ADDR, CFG_ENV_SIZE);
107 #else
108         memcpy (env_ptr, (void*)CFG_ENV_ADDR, CFG_ENV_SIZE);
109 #endif
110 }
111
112 int saveenv (void)
113 {
114         int rcode = 0;
115 #ifdef CONFIG_AMIGAONEG3SE
116         enable_nvram();
117 #endif
118 #ifdef CFG_NVRAM_ACCESS_ROUTINE
119         nvram_write(CFG_ENV_ADDR, env_ptr, CFG_ENV_SIZE);
120 #else
121         if (memcpy ((char *)CFG_ENV_ADDR, env_ptr, CFG_ENV_SIZE) == NULL)
122                     rcode = 1 ;
123 #endif
124 #ifdef CONFIG_AMIGAONEG3SE
125         udelay(10000);
126         disable_nvram();
127 #endif
128         return rcode;
129 }
130
131
132 /************************************************************************
133  * Initialize Environment use
134  *
135  * We are still running from ROM, so data use is limited
136  */
137 int env_init (void)
138 {
139         DECLARE_GLOBAL_DATA_PTR;
140 #ifdef CONFIG_AMIGAONEG3SE
141         enable_nvram();
142 #endif
143 #if defined(CFG_NVRAM_ACCESS_ROUTINE)
144         ulong crc;
145         uchar data[ENV_SIZE];
146         nvram_read (&crc, CFG_ENV_ADDR, sizeof(ulong));
147         nvram_read (data, CFG_ENV_ADDR+sizeof(ulong), ENV_SIZE);
148
149         if (crc32(0, data, ENV_SIZE) == crc) {
150                 gd->env_addr  = (ulong)CFG_ENV_ADDR + sizeof(long);
151 #else
152         if (crc32(0, env_ptr->data, ENV_SIZE) == env_ptr->crc) {
153                 gd->env_addr  = (ulong)&(env_ptr->data);
154 #endif
155                 gd->env_valid = 1;
156         } else {
157                 gd->env_addr  = (ulong)&default_environment[0];
158                 gd->env_valid = 0;
159         }
160 #ifdef CONFIG_AMIGAONEG3SE
161         disable_nvram();
162 #endif
163         return (0);
164 }
165
166 #endif /* CFG_ENV_IS_IN_NVRAM */