[J-u-boot.git] / common / env_common.c

/*
 * (C) Copyright 2000-2010
 * Wolfgang Denk, DENX Software Engineering, [email protected].
 *
 * (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
 * Andreas Heppel <[email protected]>
 *
 * See file CREDITS for list of people who contributed to this
 * project.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License as
 * published by the Free Software Foundation; either version 2 of
 * the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.	 See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 * MA 02111-1307 USA
 */

#include <common.h>
#include <command.h>
#include <environment.h>
#include <linux/stddef.h>
#include <search.h>
#include <errno.h>
#include <malloc.h>

DECLARE_GLOBAL_DATA_PTR;

extern env_t *env_ptr;

extern void env_relocate_spec (void);
extern uchar env_get_char_spec(int);

static uchar env_get_char_init (int index);

/************************************************************************
 * Default settings to be used when no valid environment is found
 */
#define XMK_STR(x)	#x
#define MK_STR(x)	XMK_STR(x)

uchar default_environment[] = {
#ifdef	CONFIG_BOOTARGS
	"bootargs="	CONFIG_BOOTARGS			"\0"
#endif
#ifdef	CONFIG_BOOTCOMMAND
	"bootcmd="	CONFIG_BOOTCOMMAND		"\0"
#endif
#ifdef	CONFIG_RAMBOOTCOMMAND
	"ramboot="	CONFIG_RAMBOOTCOMMAND		"\0"
#endif
#ifdef	CONFIG_NFSBOOTCOMMAND
	"nfsboot="	CONFIG_NFSBOOTCOMMAND		"\0"
#endif
#if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
	"bootdelay="	MK_STR(CONFIG_BOOTDELAY)	"\0"
#endif
#if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
	"baudrate="	MK_STR(CONFIG_BAUDRATE)		"\0"
#endif
#ifdef	CONFIG_LOADS_ECHO
	"loads_echo="	MK_STR(CONFIG_LOADS_ECHO)	"\0"
#endif
#ifdef	CONFIG_ETHADDR
	"ethaddr="	MK_STR(CONFIG_ETHADDR)		"\0"
#endif
#ifdef	CONFIG_ETH1ADDR
	"eth1addr="	MK_STR(CONFIG_ETH1ADDR)		"\0"
#endif
#ifdef	CONFIG_ETH2ADDR
	"eth2addr="	MK_STR(CONFIG_ETH2ADDR)		"\0"
#endif
#ifdef	CONFIG_ETH3ADDR
	"eth3addr="	MK_STR(CONFIG_ETH3ADDR)		"\0"
#endif
#ifdef	CONFIG_ETH4ADDR
	"eth4addr="	MK_STR(CONFIG_ETH4ADDR)		"\0"
#endif
#ifdef	CONFIG_ETH5ADDR
	"eth5addr="	MK_STR(CONFIG_ETH5ADDR)		"\0"
#endif
#ifdef	CONFIG_IPADDR
	"ipaddr="	MK_STR(CONFIG_IPADDR)		"\0"
#endif
#ifdef	CONFIG_SERVERIP
	"serverip="	MK_STR(CONFIG_SERVERIP)		"\0"
#endif
#ifdef	CONFIG_SYS_AUTOLOAD
	"autoload="	CONFIG_SYS_AUTOLOAD			"\0"
#endif
#ifdef	CONFIG_PREBOOT
	"preboot="	CONFIG_PREBOOT			"\0"
#endif
#ifdef	CONFIG_ROOTPATH
	"rootpath="	MK_STR(CONFIG_ROOTPATH)		"\0"
#endif
#ifdef	CONFIG_GATEWAYIP
	"gatewayip="	MK_STR(CONFIG_GATEWAYIP)	"\0"
#endif
#ifdef	CONFIG_NETMASK
	"netmask="	MK_STR(CONFIG_NETMASK)		"\0"
#endif
#ifdef	CONFIG_HOSTNAME
	"hostname="	MK_STR(CONFIG_HOSTNAME)		"\0"
#endif
#ifdef	CONFIG_BOOTFILE
	"bootfile="	MK_STR(CONFIG_BOOTFILE)		"\0"
#endif
#ifdef	CONFIG_LOADADDR
	"loadaddr="	MK_STR(CONFIG_LOADADDR)		"\0"
#endif
#ifdef  CONFIG_CLOCKS_IN_MHZ
	"clocks_in_mhz=1\0"
#endif
#if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
	"pcidelay="	MK_STR(CONFIG_PCI_BOOTDELAY)	"\0"
#endif
#ifdef  CONFIG_EXTRA_ENV_SETTINGS
	CONFIG_EXTRA_ENV_SETTINGS
#endif
	"\0"
};

struct hsearch_data env_htab;

static uchar env_get_char_init (int index)
{
	uchar c;

	/* if crc was bad, use the default environment */
	if (gd->env_valid)
		c = env_get_char_spec(index);
	else
		c = default_environment[index];

	return (c);
}

uchar env_get_char_memory (int index)
{
	return *env_get_addr(index);
}

uchar env_get_char (int index)
{
	uchar c;

	/* if relocated to RAM */
	if (gd->flags & GD_FLG_RELOC)
		c = env_get_char_memory(index);
	else
		c = env_get_char_init(index);

	return (c);
}

uchar *env_get_addr (int index)
{
	if (gd->env_valid)
		return (uchar *)(gd->env_addr + index);
	else
		return &default_environment[index];
}

void set_default_env(const char *s)
{
	if (sizeof(default_environment) > ENV_SIZE) {
		puts("*** Error - default environment is too large\n\n");
		return;
	}

	if (s) {
		if (*s == '!') {
			printf("*** Warning - %s, "
				"using default environment\n\n",
				s+1);
		} else {
			puts(s);
		}
	} else {
		puts("Using default environment\n\n");
	}

	if (himport_r(&env_htab, (char *)default_environment,
		    sizeof(default_environment), '\0', 0) == 0) {
		error("Environment import failed: errno = %d\n", errno);
	}
	gd->flags |= GD_FLG_ENV_READY;
}

/*
 * Check if CRC is valid and (if yes) import the environment.
 * Note that "buf" may or may not be aligned.
 */
int env_import(const char *buf, int check)
{
	env_t *ep = (env_t *)buf;

	if (check) {
		uint32_t crc;

		memcpy(&crc, &ep->crc, sizeof(crc));

		if (crc32(0, ep->data, ENV_SIZE) != crc) {
			set_default_env("!bad CRC");
			return 0;
		}
	}

	if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0)) {
		gd->flags |= GD_FLG_ENV_READY;
		return 1;
	}

	error("Cannot import environment: errno = %d\n", errno);

	set_default_env("!import failed");

	return 0;
}

void env_relocate (void)
{
#if defined(CONFIG_NEEDS_MANUAL_RELOC)
	extern void env_reloc(void);

	env_reloc();
#endif
	if (gd->env_valid == 0) {
#if defined(CONFIG_ENV_IS_NOWHERE)	/* Environment not changable */
		set_default_env(NULL);
#else
		show_boot_progress (-60);
		set_default_env("!bad CRC");
#endif
	} else {
		env_relocate_spec ();
	}
}

#ifdef CONFIG_AUTO_COMPLETE
int env_complete(char *var, int maxv, char *cmdv[], int bufsz, char *buf)
{
	ENTRY *match;
	int found, idx;

	idx = 0;
	found = 0;
	cmdv[0] = NULL;

	while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
		int vallen = strlen(match->key) + 1;

		if (found >= maxv - 2 || bufsz < vallen)
			break;

		cmdv[found++] = buf;
		memcpy(buf, match->key, vallen);
		buf += vallen;
		bufsz -= vallen;
	}

	qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);

	if (idx)
		cmdv[found++] = "...";
	cmdv[found] = NULL;
	return found;
}
#endif
Commit	Line	Data
05706fdd	1	/*
ea882baf	2	* (C) Copyright 2000-2010
05706fdd WD	3	* Wolfgang Denk, DENX Software Engineering, [email protected].
	4	*
	5	* (C) Copyright 2001 Sysgo Real-Time Solutions, GmbH <www.elinos.com>
	6	* Andreas Heppel <[email protected]>
ea882baf	7	*
05706fdd WD	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	#include <common.h>
	28	#include <command.h>
	29	#include <environment.h>
05706fdd	30	#include <linux/stddef.h>
ea882baf WD	31	#include <search.h>
ea882baf WD	32	#include <errno.h>
05706fdd WD	33	#include <malloc.h>
05706fdd WD	34
d87080b7 WD	35	DECLARE_GLOBAL_DATA_PTR;
d87080b7 WD	36
05706fdd WD	37	extern env_t *env_ptr;
	38
	39	extern void env_relocate_spec (void);
	40	extern uchar env_get_char_spec(int);
	41
	42	static uchar env_get_char_init (int index);
05706fdd WD	43
	44	/************************************************************************
	45	* Default settings to be used when no valid environment is found
	46	*/
	47	#define XMK_STR(x) #x
	48	#define MK_STR(x) XMK_STR(x)
	49
	50	uchar default_environment[] = {
	51	#ifdef CONFIG_BOOTARGS
	52	"bootargs=" CONFIG_BOOTARGS "\0"
	53	#endif
	54	#ifdef CONFIG_BOOTCOMMAND
	55	"bootcmd=" CONFIG_BOOTCOMMAND "\0"
	56	#endif
	57	#ifdef CONFIG_RAMBOOTCOMMAND
	58	"ramboot=" CONFIG_RAMBOOTCOMMAND "\0"
	59	#endif
	60	#ifdef CONFIG_NFSBOOTCOMMAND
	61	"nfsboot=" CONFIG_NFSBOOTCOMMAND "\0"
	62	#endif
	63	#if defined(CONFIG_BOOTDELAY) && (CONFIG_BOOTDELAY >= 0)
	64	"bootdelay=" MK_STR(CONFIG_BOOTDELAY) "\0"
	65	#endif
	66	#if defined(CONFIG_BAUDRATE) && (CONFIG_BAUDRATE >= 0)
	67	"baudrate=" MK_STR(CONFIG_BAUDRATE) "\0"
	68	#endif
	69	#ifdef CONFIG_LOADS_ECHO
	70	"loads_echo=" MK_STR(CONFIG_LOADS_ECHO) "\0"
	71	#endif
	72	#ifdef CONFIG_ETHADDR
	73	"ethaddr=" MK_STR(CONFIG_ETHADDR) "\0"
	74	#endif
	75	#ifdef CONFIG_ETH1ADDR
	76	"eth1addr=" MK_STR(CONFIG_ETH1ADDR) "\0"
	77	#endif
	78	#ifdef CONFIG_ETH2ADDR
	79	"eth2addr=" MK_STR(CONFIG_ETH2ADDR) "\0"
	80	#endif
69459791 WD	81	#ifdef CONFIG_ETH3ADDR
	82	"eth3addr=" MK_STR(CONFIG_ETH3ADDR) "\0"
	83	#endif
c68a05fe	84	#ifdef CONFIG_ETH4ADDR
	85	"eth4addr=" MK_STR(CONFIG_ETH4ADDR) "\0"
	86	#endif
	87	#ifdef CONFIG_ETH5ADDR
	88	"eth5addr=" MK_STR(CONFIG_ETH5ADDR) "\0"
	89	#endif
05706fdd WD	90	#ifdef CONFIG_IPADDR
	91	"ipaddr=" MK_STR(CONFIG_IPADDR) "\0"
	92	#endif
	93	#ifdef CONFIG_SERVERIP
	94	"serverip=" MK_STR(CONFIG_SERVERIP) "\0"
	95	#endif
6d0f6bcf JCPV	96	#ifdef CONFIG_SYS_AUTOLOAD
6d0f6bcf JCPV	97	"autoload=" CONFIG_SYS_AUTOLOAD "\0"
05706fdd WD	98	#endif
	99	#ifdef CONFIG_PREBOOT
	100	"preboot=" CONFIG_PREBOOT "\0"
	101	#endif
	102	#ifdef CONFIG_ROOTPATH
	103	"rootpath=" MK_STR(CONFIG_ROOTPATH) "\0"
	104	#endif
	105	#ifdef CONFIG_GATEWAYIP
	106	"gatewayip=" MK_STR(CONFIG_GATEWAYIP) "\0"
	107	#endif
	108	#ifdef CONFIG_NETMASK
	109	"netmask=" MK_STR(CONFIG_NETMASK) "\0"
	110	#endif
	111	#ifdef CONFIG_HOSTNAME
	112	"hostname=" MK_STR(CONFIG_HOSTNAME) "\0"
	113	#endif
	114	#ifdef CONFIG_BOOTFILE
	115	"bootfile=" MK_STR(CONFIG_BOOTFILE) "\0"
	116	#endif
	117	#ifdef CONFIG_LOADADDR
	118	"loadaddr=" MK_STR(CONFIG_LOADADDR) "\0"
	119	#endif
	120	#ifdef CONFIG_CLOCKS_IN_MHZ
	121	"clocks_in_mhz=1\0"
	122	#endif
ad10dd9a SR	123	#if defined(CONFIG_PCI_BOOTDELAY) && (CONFIG_PCI_BOOTDELAY > 0)
	124	"pcidelay=" MK_STR(CONFIG_PCI_BOOTDELAY) "\0"
	125	#endif
05706fdd WD	126	#ifdef CONFIG_EXTRA_ENV_SETTINGS
	127	CONFIG_EXTRA_ENV_SETTINGS
	128	#endif
	129	"\0"
	130	};
	131
2eb1573f MF	132	struct hsearch_data env_htab;
2eb1573f MF	133
05706fdd WD	134	static uchar env_get_char_init (int index)
05706fdd WD	135	{
05706fdd WD	136	uchar c;
	137
	138	/* if crc was bad, use the default environment */
	139	if (gd->env_valid)
05706fdd	140	c = env_get_char_spec(index);
ea882baf	141	else
05706fdd	142	c = default_environment[index];
05706fdd WD	143
	144	return (c);
	145	}
	146
	147	uchar env_get_char_memory (int index)
	148	{
ea882baf	149	return *env_get_addr(index);
05706fdd WD	150	}
05706fdd WD	151
b502611b JT	152	uchar env_get_char (int index)
	153	{
	154	uchar c;
	155
	156	/* if relocated to RAM */
	157	if (gd->flags & GD_FLG_RELOC)
	158	c = env_get_char_memory(index);
	159	else
	160	c = env_get_char_init(index);
	161
	162	return (c);
	163	}
	164
05706fdd WD	165	uchar *env_get_addr (int index)
05706fdd WD	166	{
ea882baf WD	167	if (gd->env_valid)
	168	return (uchar *)(gd->env_addr + index);
	169	else
	170	return &default_environment[index];
05706fdd WD	171	}
05706fdd WD	172
ea882baf	173	void set_default_env(const char *s)
5bb12dbd HW	174	{
5bb12dbd HW	175	if (sizeof(default_environment) > ENV_SIZE) {
ea882baf	176	puts("*** Error - default environment is too large\n\n");
5bb12dbd HW	177	return;
	178	}
	179
ea882baf WD	180	if (s) {
	181	if (*s == '!') {
	182	printf("*** Warning - %s, "
	183	"using default environment\n\n",
	184	s+1);
	185	} else {
	186	puts(s);
	187	}
	188	} else {
	189	puts("Using default environment\n\n");
	190	}
	191
2eb1573f	192	if (himport_r(&env_htab, (char *)default_environment,
ea882baf WD	193	sizeof(default_environment), '\0', 0) == 0) {
	194	error("Environment import failed: errno = %d\n", errno);
	195	}
	196	gd->flags \|= GD_FLG_ENV_READY;
5bb12dbd HW	197	}
5bb12dbd HW	198
ea882baf WD	199	/*
	200	* Check if CRC is valid and (if yes) import the environment.
	201	* Note that "buf" may or may not be aligned.
	202	*/
	203	int env_import(const char *buf, int check)
05706fdd	204	{
ea882baf	205	env_t ep = (env_t )buf;
05706fdd	206
ea882baf WD	207	if (check) {
	208	uint32_t crc;
	209
	210	memcpy(&crc, &ep->crc, sizeof(crc));
	211
	212	if (crc32(0, ep->data, ENV_SIZE) != crc) {
	213	set_default_env("!bad CRC");
	214	return 0;
	215	}
	216	}
	217
2eb1573f	218	if (himport_r(&env_htab, (char *)ep->data, ENV_SIZE, '\0', 0)) {
ea882baf WD	219	gd->flags \|= GD_FLG_ENV_READY;
	220	return 1;
	221	}
05706fdd	222
ea882baf WD	223	error("Cannot import environment: errno = %d\n", errno);
	224
	225	set_default_env("!import failed");
	226
	227	return 0;
	228	}
	229
	230	void env_relocate (void)
	231	{
2e5167cc	232	#if defined(CONFIG_NEEDS_MANUAL_RELOC)
60f7da1f HS	233	extern void env_reloc(void);
	234
	235	env_reloc();
	236	#endif
05706fdd	237	if (gd->env_valid == 0) {
0fe247b9	238	#if defined(CONFIG_ENV_IS_NOWHERE) /* Environment not changable */
ea882baf	239	set_default_env(NULL);
05706fdd	240	#else
fad63407	241	show_boot_progress (-60);
ea882baf	242	set_default_env("!bad CRC");
d259079d	243	#endif
ea882baf	244	} else {
05706fdd WD	245	env_relocate_spec ();
05706fdd WD	246	}
05706fdd	247	}
04a85b3b	248
560d424b	249	#ifdef CONFIG_AUTO_COMPLETE
04a85b3b WD	250	int env_complete(char var, int maxv, char cmdv[], int bufsz, char *buf)
04a85b3b WD	251	{
560d424b MF	252	ENTRY *match;
560d424b MF	253	int found, idx;
04a85b3b	254
560d424b	255	idx = 0;
04a85b3b WD	256	found = 0;
	257	cmdv[0] = NULL;
	258
560d424b MF	259	while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
560d424b MF	260	int vallen = strlen(match->key) + 1;
04a85b3b	261
560d424b	262	if (found >= maxv - 2 \|\| bufsz < vallen)
04a85b3b	263	break;
560d424b	264
04a85b3b	265	cmdv[found++] = buf;
560d424b MF	266	memcpy(buf, match->key, vallen);
	267	buf += vallen;
	268	bufsz -= vallen;
04a85b3b WD	269	}
04a85b3b WD	270
560d424b MF	271	qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
	272
	273	if (idx)
	274	cmdv[found++] = "...";
04a85b3b WD	275	cmdv[found] = NULL;
	276	return found;
	277	}
	278	#endif