[z180-stamp.git] / avr / env.c

/*
 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
 *
 * SPDX-License-Identifier:	GPL-2.0
 */

#include "common.h"
#include <string.h>
#include <stdlib.h>
#include <stdbool.h>
#include <avr/eeprom.h>

#include "config.h"
#include "debug.h"
#include "xmalloc.h"
#include "crc.h"
#include "command.h"
#include "env.h"


#define ENV_SIZE	(CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
#define ACTIVE_FLAG	1
#define OBSOLETE_FLAG	0

#define ENVLIST_DELETE	(1<<0)


/*
 * Default Environment
 */

#define DELIM 		"\0"

const FLASH char default_env[] = {
	ENV_BAUDRATE	  "=" "115200" DELIM
	ENV_BOOTDELAY	  "=" "3" DELIM
	ENV_BOOTCMD		  "=" "pin ${pins}; loadcpm3; go ${startaddress}" DELIM
	ENV_CPM3_SYSFILE  "=" CONFIG_CPM3_SYSFILE DELIM
	ENV_PINALIAS	  "=" "0:PG5,1:PG4,2:PB4,3:PB5,4:PB6,5:PB7,"
						  "6:PG3,7:PG2,8:PG1,9:PG0,10:PE7" DELIM
	ENV_STARTADDRESS  "=" "0" DELIM
	"pins"			  "=" "2,8 low 9 high 3 2" DELIM
	DELIM
};


/* EEPROM storage */
typedef struct environment_s {
	uint16_t	crc;		/* CRC16 over data bytes	*/
	uint8_t		flags;		/* active/obsolete flags	*/
	char		data[ENV_SIZE]; /* Environment data		*/
} env_t;


/* */
typedef struct env_item_s {
	char * envvar;
} env_item_t;


static uint8_t env_valid;
static env_item_t env_list[CONFIG_ENVVAR_MAX];
static int entrycount;


static
char env_get_char(uint16_t index)
{
	unsigned int off = CONFIG_ENV_OFFSET;
	char ret;

	switch (env_valid) {
	case 2:
		off += CONFIG_ENV_SIZE;
	case 1:
		ret = (char) eeprom_read_byte((const uint8_t *)off + index +
				offsetof(env_t, data));
		break;

	default:
		ret = default_env[index];
	}

	return ret;
}


static const FLASH char *comp_key;

static
int comp_env_items(const void *m1, const void *m2)
{
	env_item_t *ep1 = (env_item_t *) m1;
	env_item_t *ep2 = (env_item_t *) m2;

	if (ep1 == NULL)
		return - strcmp_P(ep2->envvar, comp_key);
	else
		return strcmp(ep1->envvar, ep2->envvar);
}


env_item_t *envlist_search(const MEMX char *name)
{
#ifdef __MEMX
	if (__builtin_avr_flash_segment(name) != -1) {
		comp_key = name;
		return bsearch(0, env_list, entrycount,
				sizeof(env_item_t), comp_env_items);
	} else {

		env_item_t e;
		e.envvar = (char *) name;

		return bsearch(&e, env_list, entrycount,
				sizeof(env_item_t), comp_env_items);
	}
#else
	env_item_t e;
	e.envvar = (char *) name;

	return bsearch(&e, env_list, entrycount,
				sizeof(env_item_t), comp_env_items);
#endif /* __MEMX */
}


static
env_item_t *envlist_enter(env_item_t *e)
{
	const size_t size = sizeof(env_item_t);
	env_item_t *ep;

	ep = bsearch(e, env_list, entrycount,
			size, comp_env_items);

	if (ep == NULL) {
		if (entrycount < CONFIG_ENVVAR_MAX) {

			env_list[entrycount++] = *e;
			qsort(env_list, entrycount, size, comp_env_items);
			ep = bsearch(e, env_list, entrycount,
						size, comp_env_items);
		}
	} else {
		free(ep->envvar);
		ep->envvar = e->envvar;
	}

	return ep;
}


static
int env_item_delete(env_item_t *ep)
{
	if (entrycount == 0)
		return -1;

	free(ep->envvar);

	entrycount--;
	size_t size = sizeof(env_item_t);
	memmove(ep, ep + 1, (env_list - ep)*size + entrycount*size);

	return 0;
}

static
int envlist_delete(const MEMX char *name)
{
	env_item_t *ep = envlist_search(name);

	if (ep != NULL)
		return env_item_delete(ep);

	return 1;
}


static
int envlist_import(uint8_t flags)
{
	uint16_t index;

	int len;
	env_item_t e;
	char *np, c;
	uint_fast8_t ef;

	if ((flags & ENVLIST_DELETE) != 0)
		while (entrycount != 0)
			env_item_delete(&env_list[entrycount-1]);

	for (index = 0; env_get_char(index) != '\0'; ) {
		for (len = 0; env_get_char(index + len) != '\0'; ++len) {
			if ((index + len) >= ENV_SIZE)
				return -1;
		}

		np = (char *) xmalloc(len+1);
		if (np == NULL) {
			printf_P(PSTR("## Can't malloc %d bytes\n"), len+1);
			return 1;
		}
		e.envvar = np;
		ef = 0;
		while ((c = env_get_char(index++)) != '\0') {
			if (!ef && (c == '=')) {
				*np = '\0';
				ef = 1;
			} else
				*np = c;
			np++;
		}
		*np = '\0';
		envlist_enter(&e);
	}


	return 0;
}


static
uint16_t env_crc(uint16_t data_offset)
{
	uint16_t crc;
	uint16_t i;
	char c, c0;

	crc = 0xffff;
	c = 0xff;
	for (i = 0; !(c == 0 && c0 == 0) && i < ENV_SIZE; i++)
	{
		c0 = c;
		c = eeprom_read_byte((const uint8_t *) data_offset + i);
		crc = crc16(crc, c);
	}
	return crc ;
}


/**
 * return valid env
 */
static
int env_check_valid(void)
{
	const uint16_t offset[2] = {CONFIG_ENV_OFFSET,
				    CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE};
	uint_fast8_t flags[2], crc_ok[2];
	int rc;

	/* read FLAGS */
	flags[0] = eeprom_read_byte ((uint8_t *) offset[0] +
				offsetof(env_t, flags));
	flags[1] = eeprom_read_byte ((uint8_t *) offset[1] +
				offsetof(env_t, flags));

	/* check CRC */
	crc_ok[0] = (
		eeprom_read_word((uint16_t *) offset[0] +
				offsetof(env_t, crc))
		== env_crc(offset[0] + offsetof(env_t, data))
	);
	crc_ok[1] = (
		eeprom_read_word((uint16_t *) offset[1] +
				offsetof(env_t, crc))
		== env_crc(offset[1] + offsetof(env_t, data))
	);

	if (!crc_ok[0] && !crc_ok[1]) {
		rc = 0;

	} else if (crc_ok[0] && !crc_ok[1]) {
		rc = 1;
	} else if (!crc_ok[0] && crc_ok[1]) {
		rc = 2;
	} else {
		/* both ok - check serial */
#if 1
		if      (flags[1] == ACTIVE_FLAG && flags[0] != ACTIVE_FLAG)
			rc = 2;
		else if (flags[1] == OBSOLETE_FLAG && flags[0] == 0xFF)
			rc = 2;
		else
			rc = 1;
#else
		if (flags[0] == ACTIVE_FLAG && flags[1] == OBSOLETE_FLAG)
			rc = 1;
		else if (flags[0] == OBSOLETE_FLAG && flags[1] == ACTIVE_FLAG)
			rc = 2;
		else if (flags[0] == 0xFF && flags[1] == 0)
			rc = 2;
		else if (flags[1] == 0xFF && flags[0] == 0)
			rc = 1;
		else /* flags are equal - almost impossible */
			rc = 1;
#endif
	}

	return rc;
}


int env_init(void)
{
	env_valid = env_check_valid();
	if (env_valid == 0) {
		printf_P(PSTR("*** Warning - bad CRC, "
				"using default environment\n\n"));
	}

	envlist_import(ENVLIST_DELETE);
	return 0;
}


char *getenv_char(const MEMX char *name)
{
	env_item_t *ep;
	char *ret = NULL;

	ep = envlist_search(name);
	if (ep != NULL)
		ret = ep->envvar + strlen(ep->envvar) +1;
	return ret;
}

static
int env_item_save(env_item_t *ep, uint16_t offset, int space_left)
{
	int nlen, vlen;
	char *var = ep->envvar;

	nlen = strlen(var);
	if (nlen == 0)
		return 0;
	vlen = strlen(var + nlen + 1);
	if (vlen == 0)
		return 0;
	if (nlen + vlen + 2 > space_left)
		return 0;

	eeprom_update_block(var, (uint8_t *) offset, nlen);
	offset += nlen;
	eeprom_update_byte((uint8_t *) offset++, '=');
	eeprom_update_block(var + nlen +1, (uint8_t *) offset, vlen+1);

	return nlen + vlen + 2;
}


static
int saveenv(void)
{
	unsigned int off     = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	unsigned int off_red = CONFIG_ENV_OFFSET;
	unsigned int pos;
	int len, left;
	uint16_t crc;
	int rc = 0;

	if (env_valid == 2) {
		off	= CONFIG_ENV_OFFSET;
		off_red	= CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	}

	eeprom_update_byte((uint8_t *) off + offsetof(env_t, flags), 0xff);

	pos = off + offsetof(env_t, data);
	left = ENV_SIZE - 1;
	for (int i = 0 ; i < entrycount; i++) {
		len = env_item_save(&env_list[i], pos, left);
		if (len == 0) {
			return 1;
		}
		pos += len;
		left -= len;
	}
	/* terminate list */
	eeprom_update_byte((uint8_t *) pos, 0);
	crc = env_crc(off + offsetof(env_t, data));
	eeprom_update_word((uint16_t *) off + offsetof(env_t, crc), crc);
	eeprom_update_byte((uint8_t *) off + offsetof(env_t, flags),
					ACTIVE_FLAG);

	if (rc == 0) {
		eeprom_update_byte((uint8_t *) off_red + offsetof(env_t, flags),
					OBSOLETE_FLAG);
		env_valid = (env_valid == 2) ? 1 : 2;
	}

	return rc;
}


static
int env_item_print(env_item_t *ep)
{
	int len;
	char *ev = ep->envvar;

	len = printf_P(PSTR("%s="), ev);
	len += printf_P(PSTR("%s\n"), ev + len);

	return len;
}


/*
 * Command interface: print one or all environment variables
 *
 * Returns -1 in case of error, or length of printed string
 */
static
int env_print(const MEMX char *name)
{
	int len = -1;

	if (name) {		/* print a single name */

		env_item_t *ep = envlist_search(name);
		if (ep != NULL)
			len = env_item_print(ep);

	} else {		/* print whole list */
		len = 0;
		for (int i = 0 ; i < entrycount; i++) {
			len += env_item_print(&env_list[i]);
		}
	}
	return len;
}


/**
 * Set or delete environment variable
 *
 * Set a new environment variable,
 * or replace or delete an existing one.
 *
 * @param flag		(not used)
 * @param argc
 * @param argv[1]	Environment variable to set or delete
 *			if no more args
 * @param argv[2] ...	Value to set it to
 *
 * @return 0 if ok, 1 on error
 */
static
command_ret_t _do_env_set(int flag, int argc, char * const argv[])
{
	int i, len;
	char *name, *value, *valp, *p;
	env_item_t e, *ep;

	(void) flag;

	name = argv[1];
	value = argv[2];

	if (strchr(name, '=')) {
		printf_P(PSTR("## Error: illegal character '='"
		       "in variable name \"%s\"\n"), name);
		return CMD_RET_FAILURE;
	}
	len = strlen(name);
	if (len > CONFIG_SYS_ENV_NAMELEN) {
		printf_P(PSTR("## Error: Variable name \"%s\" too long. "
		       "(max %d characters)\n"), name, CONFIG_SYS_ENV_NAMELEN);
		return CMD_RET_FAILURE;
	}
/*
	env_id++;
*/
	/* Delete only ? */
	if (argc < 3 || argv[2] == NULL) {
		int rc = envlist_delete(name);
		return rc ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
	}

	/*
	 * Insert / replace new value
	 */
	for (i = 2, len += 1; i < argc; ++i)
		len += strlen(argv[i]) + 1;

	value = xmalloc(len);
	if (value == NULL) {
		printf_P(PSTR("## Can't malloc %d bytes\n"), len);
		return CMD_RET_FAILURE;
	}
	strcpy(value, name);
	valp = value + strlen(name) + 1;
	for (i = 2, p = valp; i < argc; ++i) {
		char *v = argv[i];

		while ((*p++ = *v++) != '\0')
			;
		*(p - 1) = ' ';
	}
	if (p != valp)
		*--p = '\0';

	e.envvar = value;
	ep = envlist_enter(&e);
	if (!ep) {
		printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
			name);
		return CMD_RET_FAILURE;
	}

	return CMD_RET_SUCCESS;
}

/**
 * Set an environment variable
 *
 * @param varname	Environment variable to set
 * @param varvalue	Value to set it to
 * @return 0 if ok, 1 on error
 */
static
int setenv(const MEMX char *varname, const char *varvalue)
{
	int rc;

#ifdef __MEMX
	char *tmpname = NULL;
	if (__builtin_avr_flash_segment(varname) != -1) {
		tmpname = malloc(strlen_P(varname)+1);
		if (tmpname == NULL) {
			printf_P(PSTR("setenv: Out of Memory!\n"));
			return 1;
		}
		strcpy_P(tmpname, varname);
	} else
		tmpname = (char *) varname;
#endif

	const char * const argv[3] = { NULL, tmpname, varvalue };
	int argc = 3;

	if (varvalue == NULL || varvalue[0] == '\0')
		--argc;

	rc = (int) _do_env_set(0, argc, (char * const *)argv);

#ifdef __MEMX
	free(tmpname);
#endif
	return rc;
}

/**
 * Set an environment variable to an integer value
 *
 * @param name	Environment variable to set
 * @param value	Value to set it to
 * @param radix	Base
 * @return 0 if ok, 1 on error
 */
static
int setenv_intval(const MEMX char *name, unsigned long value, int radix)
{
	char buf[11];

	ultoa(value, buf, radix);

	return setenv(name, buf);
}

/**
 * Set an environment variable to a decimal integer value
 *
 * @param name	Environment variable to set
 * @param value	Value to set it to
 * @return 0 if ok, 1 on error
 */
int setenv_ulong(const MEMX char *name, unsigned long value)
{
	return setenv_intval(name, value, 10);
}


/**
 * Set an environment variable to a value in hex
 *
 * @param name	Environment variable to set
 * @param value	Value to set it to
 * @return 0 if ok, 1 on error
 */
int setenv_hex(const MEMX char *name, unsigned long value)
{
	return setenv_intval(name, value, 16);
}


/**
 * Decode the integer value of an environment variable and return it.
 *
 * @param name		Name of environemnt variable
 * @param base		Number base to use (normally 10, or 16 for hex)
 * @param default_val	Default value to return if the variable is not
 *			found
 * @return the decoded value, or default_val if not found
 */
unsigned long getenv_ulong(const MEMX char *name, int base, unsigned long default_val)
{
	unsigned long value;
	char *vp, *endp;

	env_item_t *ep = envlist_search(name);

	if (ep != NULL ) {
		vp = ep->envvar + strlen(ep->envvar) +1;
		value = strtoul(vp, &endp, base);
		if (endp != vp)
			return value;
	}

	return default_val;
}


/*
 * Read an environment variable as a boolean
 */
bool getenv_yesno(const MEMX char *name)
{
	char *s = getenv_char(name);

	if (s == NULL)
		return false;

	return strchr_P(PSTR("1yYtT"), *s) != NULL;

/*
	return *s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T' ?
		1 : 0;
*/
}

command_ret_t do_env_print(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	command_ret_t rc = CMD_RET_SUCCESS;

	(void) cmdtp; (void) flag;

	if (argc == 1) {
		/* print all env vars */
		int size = env_print(NULL);
		if (size < 0)
			return CMD_RET_FAILURE;
		printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
			size, ENV_SIZE);
		return CMD_RET_SUCCESS;
	}

	/* print selected env vars */
	for (int i = 1; i < argc; ++i) {
		int rc = env_print(argv[i]);
		if (rc < 0) {
			printf_P(PSTR("## Error: \"%s\" not defined\n"), argv[i]);
			rc = CMD_RET_FAILURE;
		}
	}

	return rc;
}


command_ret_t do_env_set(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	(void) cmdtp;

	if (argc < 2)
		return CMD_RET_USAGE;

	return _do_env_set(flag, argc, argv);
}


command_ret_t do_env_default(cmd_tbl_t *cmdtp, int flag,
			  int argc, char * const argv[])
{
	(void) cmdtp; (void) flag; (void) argc;	(void) argv;

	uint8_t tmp = env_valid;
	env_valid = 0;

	/* Reset the whole environment */
	printf_P(PSTR("## Resetting to default environment\n"));
	envlist_import(ENVLIST_DELETE);

	env_valid = tmp;

	return CMD_RET_SUCCESS;
}


command_ret_t do_env_save(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[])
{
	(void) cmdtp; (void) flag; (void) argc;	(void) argv;

	printf_P(PSTR("Saving Environment ...\n"));
	return saveenv() ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
}


#if defined(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
35edb766 L	1	/*
	2	* (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
	3	*
b51d2360	4	* SPDX-License-Identifier: GPL-2.0
35edb766 L	5	*/
35edb766 L	6
d684c216 L	7	#include "common.h"
	8	#include <string.h>
	9	#include <stdlib.h>
be84a704	10	#include <stdbool.h>
d684c216 L	11	#include <avr/eeprom.h>
	12
	13	#include "config.h"
	14	#include "debug.h"
	15	#include "xmalloc.h"
	16	#include "crc.h"
	17	#include "command.h"
d684c216 L	18	#include "env.h"
	19
	20
323398b1 L	21	#define ENV_SIZE (CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
	22	#define ACTIVE_FLAG 1
	23	#define OBSOLETE_FLAG 0
d684c216	24
7e24905c L	25	#define ENVLIST_DELETE (1<<0)
7e24905c L	26
d684c216	27
534e1dfc L	28	/*
	29	* Default Environment
	30	*/
1da3acc4 L	31
	32	#define DELIM "\0"
	33
534e1dfc	34	const FLASH char default_env[] = {
c0abd68b L	35	ENV_BAUDRATE "=" "115200" DELIM
c0abd68b L	36	ENV_BOOTDELAY "=" "3" DELIM
b51d2360	37	ENV_BOOTCMD "=" "pin ${pins}; loadcpm3; go ${startaddress}" DELIM
057817cb	38	ENV_CPM3_SYSFILE "=" CONFIG_CPM3_SYSFILE DELIM
c0abd68b L	39	ENV_PINALIAS "=" "0:PG5,1:PG4,2:PB4,3:PB5,4:PB6,5:PB7,"
	40	"6:PG3,7:PG2,8:PG1,9:PG0,10:PE7" DELIM
	41	ENV_STARTADDRESS "=" "0" DELIM
b51d2360	42	"pins" "=" "2,8 low 9 high 3 2" DELIM
534e1dfc L	43	DELIM
	44	};
	45
c0abd68b	46
1da3acc4	47	/* EEPROM storage */
d684c216 L	48	typedef struct environment_s {
d684c216 L	49	uint16_t crc; /* CRC16 over data bytes */
323398b1	50	uint8_t flags; /* active/obsolete flags */
d684c216 L	51	char data[ENV_SIZE]; /* Environment data */
	52	} env_t;
	53
	54
1da3acc4	55	/* */
d684c216	56	typedef struct env_item_s {
55027f3b	57	char * envvar;
d684c216 L	58	} env_item_t;
d684c216 L	59
1da3acc4	60
323398b1	61	static uint8_t env_valid;
d684c216 L	62	static env_item_t env_list[CONFIG_ENVVAR_MAX];
	63	static int entrycount;
	64
	65
1da3acc4 L	66	static
1da3acc4 L	67	char env_get_char(uint16_t index)
d684c216 L	68	{
d684c216 L	69	unsigned int off = CONFIG_ENV_OFFSET;
55027f3b	70	char ret;
d684c216	71
55027f3b L	72	switch (env_valid) {
	73	case 2:
	74	off += CONFIG_ENV_SIZE;
	75	case 1:
	76	ret = (char) eeprom_read_byte((const uint8_t *)off + index +
d684c216	77	offsetof(env_t, data));
55027f3b	78	break;
d684c216	79
55027f3b L	80	default:
55027f3b L	81	ret = default_env[index];
d684c216	82	}
d684c216	83
55027f3b	84	return ret;
d684c216 L	85	}
d684c216 L	86
d684c216	87
04cffff0 L	88	static const FLASH char *comp_key;
04cffff0 L	89
d684c216 L	90	static
	91	int comp_env_items(const void m1, const void m2)
	92	{
d684c216 L	93	env_item_t ep1 = (env_item_t ) m1;
d684c216 L	94	env_item_t ep2 = (env_item_t ) m2;
7e24905c	95
04cffff0 L	96	if (ep1 == NULL)
	97	return - strcmp_P(ep2->envvar, comp_key);
	98	else
	99	return strcmp(ep1->envvar, ep2->envvar);
d684c216 L	100	}
d684c216 L	101
1da3acc4	102
7e24905c L	103	env_item_t envlist_search(const MEMX char name)
7e24905c L	104	{
7e24905c	105	#ifdef __MEMX
7e24905c	106	if (__builtin_avr_flash_segment(name) != -1) {
04cffff0 L	107	comp_key = name;
	108	return bsearch(0, env_list, entrycount,
	109	sizeof(env_item_t), comp_env_items);
	110	} else {
	111
	112	env_item_t e;
	113	e.envvar = (char *) name;
	114
	115	return bsearch(&e, env_list, entrycount,
	116	sizeof(env_item_t), comp_env_items);
7e24905c	117	}
04cffff0 L	118	#else
	119	env_item_t e;
	120	e.envvar = (char *) name;
7e24905c	121
55027f3b L	122	return bsearch(&e, env_list, entrycount,
55027f3b L	123	sizeof(env_item_t), comp_env_items);
04cffff0	124	#endif /* __MEMX */
7e24905c L	125	}
	126
	127
	128	static
	129	env_item_t envlist_enter(env_item_t e)
	130	{
7e24905c L	131	const size_t size = sizeof(env_item_t);
	132	env_item_t *ep;
	133
55027f3b L	134	ep = bsearch(e, env_list, entrycount,
55027f3b L	135	size, comp_env_items);
7e24905c L	136
	137	if (ep == NULL) {
	138	if (entrycount < CONFIG_ENVVAR_MAX) {
	139
	140	env_list[entrycount++] = *e;
	141	qsort(env_list, entrycount, size, comp_env_items);
55027f3b L	142	ep = bsearch(e, env_list, entrycount,
55027f3b L	143	size, comp_env_items);
7e24905c L	144	}
7e24905c L	145	} else {
55027f3b L	146	free(ep->envvar);
55027f3b L	147	ep->envvar = e->envvar;
7e24905c L	148	}
	149
	150	return ep;
	151	}
	152
	153
	154	static
	155	int env_item_delete(env_item_t *ep)
	156	{
	157	if (entrycount == 0)
	158	return -1;
55027f3b L	159
55027f3b L	160	free(ep->envvar);
7e24905c L	161
	162	entrycount--;
	163	size_t size = sizeof(env_item_t);
	164	memmove(ep, ep + 1, (env_list - ep)size + entrycountsize);
	165
	166	return 0;
	167	}
	168
	169	static
04cffff0	170	int envlist_delete(const MEMX char *name)
7e24905c	171	{
04cffff0	172	env_item_t *ep = envlist_search(name);
7e24905c L	173
	174	if (ep != NULL)
	175	return env_item_delete(ep);
	176
	177	return 1;
	178	}
	179
	180
7e24905c L	181
	182	static
	183	int envlist_import(uint8_t flags)
d684c216	184	{
55027f3b L	185	uint16_t index;
	186
	187	int len;
1da3acc4	188	env_item_t e;
55027f3b L	189	char *np, c;
55027f3b L	190	uint_fast8_t ef;
7e24905c L	191
	192	if ((flags & ENVLIST_DELETE) != 0)
	193	while (entrycount != 0)
	194	env_item_delete(&env_list[entrycount-1]);
	195
55027f3b L	196	for (index = 0; env_get_char(index) != '\0'; ) {
	197	for (len = 0; env_get_char(index + len) != '\0'; ++len) {
	198	if ((index + len) >= ENV_SIZE)
	199	return -1;
1da3acc4	200	}
d684c216	201
55027f3b L	202	np = (char *) xmalloc(len+1);
	203	if (np == NULL) {
	204	printf_P(PSTR("## Can't malloc %d bytes\n"), len+1);
	205	return 1;
d684c216	206	}
55027f3b L	207	e.envvar = np;
	208	ef = 0;
	209	while ((c = env_get_char(index++)) != '\0') {
	210	if (!ef && (c == '=')) {
	211	*np = '\0';
	212	ef = 1;
	213	} else
	214	*np = c;
	215	np++;
	216	}
	217	*np = '\0';
	218	envlist_enter(&e);
d684c216	219	}
d684c216	220
55027f3b	221
1da3acc4 L	222	return 0;
1da3acc4 L	223	}
d684c216 L	224
d684c216 L	225
1da3acc4 L	226	static
1da3acc4 L	227	uint16_t env_crc(uint16_t data_offset)
323398b1	228	{
7e24905c	229	uint16_t crc;
1da3acc4 L	230	uint16_t i;
1da3acc4 L	231	char c, c0;
323398b1	232
1da3acc4 L	233	crc = 0xffff;
	234	c = 0xff;
	235	for (i = 0; !(c == 0 && c0 == 0) && i < ENV_SIZE; i++)
	236	{
7e24905c	237	c0 = c;
1da3acc4 L	238	c = eeprom_read_byte((const uint8_t *) data_offset + i);
1da3acc4 L	239	crc = crc16(crc, c);
323398b1	240	}
1da3acc4 L	241	return crc ;
1da3acc4 L	242	}
323398b1 L	243
323398b1 L	244
1da3acc4 L	245	/**
1da3acc4 L	246	* return valid env
323398b1	247	*/
1da3acc4 L	248	static
	249	int env_check_valid(void)
	250	{
	251	const uint16_t offset[2] = {CONFIG_ENV_OFFSET,
	252	CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE};
	253	uint_fast8_t flags[2], crc_ok[2];
	254	int rc;
	255
	256	/* read FLAGS */
	257	flags[0] = eeprom_read_byte ((uint8_t *) offset[0] +
	258	offsetof(env_t, flags));
	259	flags[1] = eeprom_read_byte ((uint8_t *) offset[1] +
	260	offsetof(env_t, flags));
	261
	262	/* check CRC */
	263	crc_ok[0] = (
	264	eeprom_read_word((uint16_t *) offset[0] +
	265	offsetof(env_t, crc))
	266	== env_crc(offset[0] + offsetof(env_t, data))
	267	);
	268	crc_ok[1] = (
	269	eeprom_read_word((uint16_t *) offset[1] +
	270	offsetof(env_t, crc))
	271	== env_crc(offset[1] + offsetof(env_t, data))
	272	);
323398b1	273
1da3acc4 L	274	if (!crc_ok[0] && !crc_ok[1]) {
1da3acc4 L	275	rc = 0;
323398b1	276
1da3acc4 L	277	} else if (crc_ok[0] && !crc_ok[1]) {
	278	rc = 1;
	279	} else if (!crc_ok[0] && crc_ok[1]) {
	280	rc = 2;
	281	} else {
	282	/* both ok - check serial */
	283	#if 1
	284	if (flags[1] == ACTIVE_FLAG && flags[0] != ACTIVE_FLAG)
	285	rc = 2;
	286	else if (flags[1] == OBSOLETE_FLAG && flags[0] == 0xFF)
	287	rc = 2;
	288	else
	289	rc = 1;
	290	#else
	291	if (flags[0] == ACTIVE_FLAG && flags[1] == OBSOLETE_FLAG)
	292	rc = 1;
	293	else if (flags[0] == OBSOLETE_FLAG && flags[1] == ACTIVE_FLAG)
	294	rc = 2;
	295	else if (flags[0] == 0xFF && flags[1] == 0)
	296	rc = 2;
	297	else if (flags[1] == 0xFF && flags[0] == 0)
	298	rc = 1;
	299	else /* flags are equal - almost impossible */
	300	rc = 1;
	301	#endif
323398b1	302	}
7e24905c	303
1da3acc4 L	304	return rc;
1da3acc4 L	305	}
323398b1 L	306
323398b1 L	307
1da3acc4	308	int env_init(void)
323398b1	309	{
1da3acc4 L	310	env_valid = env_check_valid();
1da3acc4 L	311	if (env_valid == 0) {
55027f3b	312	printf_P(PSTR("*** Warning - bad CRC, "
1da3acc4	313	"using default environment\n\n"));
d684c216	314	}
55027f3b	315
7e24905c L	316	envlist_import(ENVLIST_DELETE);
7e24905c L	317	return 0;
323398b1	318	}
d684c216	319
1da3acc4	320
1b77fa4e	321	char getenv_char(const MEMX char name)
d684c216 L	322	{
	323	env_item_t *ep;
	324	char *ret = NULL;
	325
55027f3b	326	ep = envlist_search(name);
d684c216	327	if (ep != NULL)
55027f3b	328	ret = ep->envvar + strlen(ep->envvar) +1;
d684c216 L	329	return ret;
	330	}
	331
1da3acc4 L	332	static
1da3acc4 L	333	int env_item_save(env_item_t *ep, uint16_t offset, int space_left)
323398b1	334	{
55027f3b L	335	int nlen, vlen;
55027f3b L	336	char *var = ep->envvar;
323398b1	337
55027f3b L	338	nlen = strlen(var);
55027f3b L	339	if (nlen == 0)
1da3acc4	340	return 0;
55027f3b L	341	vlen = strlen(var + nlen + 1);
	342	if (vlen == 0)
	343	return 0;
	344	if (nlen + vlen + 2 > space_left)
1da3acc4	345	return 0;
7e24905c	346
55027f3b L	347	eeprom_update_block(var, (uint8_t *) offset, nlen);
	348	offset += nlen;
	349	eeprom_update_byte((uint8_t *) offset++, '=');
	350	eeprom_update_block(var + nlen +1, (uint8_t *) offset, vlen+1);
	351
	352	return nlen + vlen + 2;
7e24905c	353	}
1da3acc4	354
323398b1	355
1da3acc4	356	static
d684c216 L	357	int saveenv(void)
d684c216 L	358	{
323398b1 L	359	unsigned int off = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	360	unsigned int off_red = CONFIG_ENV_OFFSET;
	361	unsigned int pos;
	362	int len, left;
	363	uint16_t crc;
	364	int rc = 0;
d684c216	365
323398b1 L	366	if (env_valid == 2) {
	367	off = CONFIG_ENV_OFFSET;
	368	off_red = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE;
	369	}
	370
7e24905c	371	eeprom_update_byte((uint8_t *) off + offsetof(env_t, flags), 0xff);
d684c216	372
323398b1 L	373	pos = off + offsetof(env_t, data);
	374	left = ENV_SIZE - 1;
	375	for (int i = 0 ; i < entrycount; i++) {
	376	len = env_item_save(&env_list[i], pos, left);
	377	if (len == 0) {
	378	return 1;
	379	}
	380	pos += len;
	381	left -= len;
	382	}
	383	/* terminate list */
	384	eeprom_update_byte((uint8_t *) pos, 0);
	385	crc = env_crc(off + offsetof(env_t, data));
	386	eeprom_update_word((uint16_t *) off + offsetof(env_t, crc), crc);
7e24905c	387	eeprom_update_byte((uint8_t *) off + offsetof(env_t, flags),
323398b1 L	388	ACTIVE_FLAG);
	389
	390	if (rc == 0) {
7e24905c	391	eeprom_update_byte((uint8_t *) off_red + offsetof(env_t, flags),
323398b1 L	392	OBSOLETE_FLAG);
323398b1 L	393	env_valid = (env_valid == 2) ? 1 : 2;
323398b1	394	}
7e24905c	395
d684c216 L	396	return rc;
	397	}
	398
d684c216	399
1da3acc4 L	400	static
1da3acc4 L	401	int env_item_print(env_item_t *ep)
d684c216	402	{
1da3acc4	403	int len;
55027f3b L	404	char *ev = ep->envvar;
	405
	406	len = printf_P(PSTR("%s="), ev);
	407	len += printf_P(PSTR("%s\n"), ev + len);
1da3acc4 L	408
1da3acc4 L	409	return len;
7e24905c	410	}
323398b1 L	411
323398b1 L	412
d684c216 L	413	/*
	414	* Command interface: print one or all environment variables
	415	*
	416	* Returns -1 in case of error, or length of printed string
	417	*/
7e24905c	418	static
fc30b18e	419	int env_print(const MEMX char *name)
d684c216 L	420	{
	421	int len = -1;
	422
	423	if (name) { /* print a single name */
7e24905c	424
d684c216 L	425	env_item_t *ep = envlist_search(name);
	426	if (ep != NULL)
	427	len = env_item_print(ep);
	428
	429	} else { /* print whole list */
	430	len = 0;
	431	for (int i = 0 ; i < entrycount; i++) {
	432	len += env_item_print(&env_list[i]);
	433	}
	434	}
	435	return len;
	436	}
	437
1da3acc4	438
72f58822 L	439	/**
	440	* Set or delete environment variable
	441	*
d684c216 L	442	* Set a new environment variable,
d684c216 L	443	* or replace or delete an existing one.
72f58822 L	444	*
	445	* @param flag (not used)
	446	* @param argc
	447	* @param argv[1] Environment variable to set or delete
	448	* if no more args
	449	* @param argv[2] ... Value to set it to
	450	*
	451	* @return 0 if ok, 1 on error
d684c216	452	*/
1da3acc4	453	static
d0581f88	454	command_ret_t _do_env_set(int flag, int argc, char * const argv[])
d684c216	455	{
72f58822	456	int i, len;
55027f3b	457	char name, value, valp, p;
d684c216 L	458	env_item_t e, *ep;
	459
	460	(void) flag;
d684c216 L	461
	462	name = argv[1];
	463	value = argv[2];
	464
	465	if (strchr(name, '=')) {
	466	printf_P(PSTR("## Error: illegal character '='"
	467	"in variable name \"%s\"\n"), name);
d0581f88	468	return CMD_RET_FAILURE;
d684c216	469	}
55027f3b L	470	len = strlen(name);
55027f3b L	471	if (len > CONFIG_SYS_ENV_NAMELEN) {
d684c216 L	472	printf_P(PSTR("## Error: Variable name \"%s\" too long. "
d684c216 L	473	"(max %d characters)\n"), name, CONFIG_SYS_ENV_NAMELEN);
d0581f88	474	return CMD_RET_FAILURE;
d684c216 L	475	}
	476	/*
	477	env_id++;
	478	*/
	479	/* Delete only ? */
	480	if (argc < 3 \|\| argv[2] == NULL) {
	481	int rc = envlist_delete(name);
d0581f88	482	return rc ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
d684c216 L	483	}
	484
	485	/*
	486	* Insert / replace new value
	487	*/
55027f3b	488	for (i = 2, len += 1; i < argc; ++i)
d684c216 L	489	len += strlen(argv[i]) + 1;
	490
	491	value = xmalloc(len);
	492	if (value == NULL) {
	493	printf_P(PSTR("## Can't malloc %d bytes\n"), len);
d0581f88	494	return CMD_RET_FAILURE;
d684c216	495	}
55027f3b L	496	strcpy(value, name);
	497	valp = value + strlen(name) + 1;
	498	for (i = 2, p = valp; i < argc; ++i) {
d684c216 L	499	char *v = argv[i];
d684c216 L	500
55027f3b	501	while ((p++ = v++) != '\0')
d684c216	502	;
55027f3b	503	*(p - 1) = ' ';
d684c216	504	}
55027f3b L	505	if (p != valp)
55027f3b L	506	*--p = '\0';
d684c216	507
55027f3b	508	e.envvar = value;
d684c216 L	509	ep = envlist_enter(&e);
	510	if (!ep) {
	511	printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
	512	name);
d0581f88	513	return CMD_RET_FAILURE;
d684c216 L	514	}
d684c216 L	515
d0581f88	516	return CMD_RET_SUCCESS;
d684c216 L	517	}
d684c216 L	518
72f58822 L	519	/**
	520	* Set an environment variable
	521	*
	522	* @param varname Environment variable to set
	523	* @param varvalue Value to set it to
	524	* @return 0 if ok, 1 on error
	525	*/
1da3acc4	526	static
c0abd68b	527	int setenv(const MEMX char varname, const char varvalue)
d684c216	528	{
c0abd68b L	529	int rc;
	530
	531	#ifdef __MEMX
	532	char *tmpname = NULL;
	533	if (__builtin_avr_flash_segment(varname) != -1) {
	534	tmpname = malloc(strlen_P(varname)+1);
	535	if (tmpname == NULL) {
	536	printf_P(PSTR("setenv: Out of Memory!\n"));
	537	return 1;
	538	}
	539	strcpy_P(tmpname, varname);
	540	} else
	541	tmpname = (char *) varname;
	542	#endif
	543
	544	const char * const argv[3] = { NULL, tmpname, varvalue };
d684c216 L	545	int argc = 3;
	546
	547	if (varvalue == NULL \|\| varvalue[0] == '\0')
	548	--argc;
7e24905c	549
c0abd68b L	550	rc = (int) _do_env_set(0, argc, (char * const *)argv);
	551
	552	#ifdef __MEMX
	553	free(tmpname);
	554	#endif
	555	return rc;
d684c216 L	556	}
d684c216 L	557
d684c216 L	558	/**
	559	* Set an environment variable to an integer value
	560	*
f76ca346 L	561	* @param name Environment variable to set
	562	* @param value Value to set it to
	563	* @param radix Base
d684c216 L	564	* @return 0 if ok, 1 on error
d684c216 L	565	*/
f76ca346 L	566	static
f76ca346 L	567	int setenv_intval(const MEMX char *name, unsigned long value, int radix)
d684c216	568	{
f76ca346	569	char buf[11];
d684c216	570
f76ca346	571	ultoa(value, buf, radix);
d684c216	572
f76ca346 L	573	return setenv(name, buf);
f76ca346 L	574	}
d684c216 L	575
d684c216 L	576	/**
f76ca346	577	* Set an environment variable to a decimal integer value
d684c216	578	*
f76ca346 L	579	* @param name Environment variable to set
f76ca346 L	580	* @param value Value to set it to
d684c216 L	581	* @return 0 if ok, 1 on error
d684c216 L	582	*/
f76ca346	583	int setenv_ulong(const MEMX char *name, unsigned long value)
d684c216	584	{
f76ca346 L	585	return setenv_intval(name, value, 10);
	586	}
	587
d684c216	588
f76ca346 L	589	/**
	590	* Set an environment variable to a value in hex
	591	*
	592	* @param name Environment variable to set
	593	* @param value Value to set it to
	594	* @return 0 if ok, 1 on error
	595	*/
	596	int setenv_hex(const MEMX char *name, unsigned long value)
	597	{
	598	return setenv_intval(name, value, 16);
d684c216 L	599	}
d684c216 L	600
35e9ec0c	601
72f58822	602	/**
35e9ec0c	603	* Decode the integer value of an environment variable and return it.
72f58822	604	*
35e9ec0c L	605	* @param name Name of environemnt variable
	606	* @param base Number base to use (normally 10, or 16 for hex)
	607	* @param default_val Default value to return if the variable is not
	608	* found
	609	* @return the decoded value, or default_val if not found
72f58822	610	*/
fc30b18e	611	unsigned long getenv_ulong(const MEMX char *name, int base, unsigned long default_val)
d684c216	612	{
d684c216	613	unsigned long value;
35e9ec0c L	614	char vp, endp;
	615
	616	env_item_t *ep = envlist_search(name);
d684c216	617
35e9ec0c	618	if (ep != NULL ) {
55027f3b L	619	vp = ep->envvar + strlen(ep->envvar) +1;
	620	value = strtoul(vp, &endp, base);
	621	if (endp != vp)
	622	return value;
35e9ec0c	623	}
d684c216	624
35e9ec0c	625	return default_val;
d684c216 L	626	}
d684c216 L	627
35e9ec0c	628
be84a704 L	629	/*
	630	* Read an environment variable as a boolean
	631	*/
	632	bool getenv_yesno(const MEMX char *name)
	633	{
	634	char *s = getenv_char(name);
	635
	636	if (s == NULL)
	637	return false;
	638
	639	return strchr_P(PSTR("1yYtT"), *s) != NULL;
	640
	641	/*
	642	return s == '1' \|\| s == 'y' \|\| s == 'Y' \|\| s == 't' \|\| *s == 'T' ?
	643	1 : 0;
	644	*/
	645	}
	646
f76ca346 L	647	command_ret_t do_env_print(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
	648	{
	649	command_ret_t rc = CMD_RET_SUCCESS;
	650
	651	(void) cmdtp; (void) flag;
	652
	653	if (argc == 1) {
	654	/* print all env vars */
	655	int size = env_print(NULL);
	656	if (size < 0)
	657	return CMD_RET_FAILURE;
	658	printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
	659	size, ENV_SIZE);
	660	return CMD_RET_SUCCESS;
	661	}
	662
	663	/* print selected env vars */
	664	for (int i = 1; i < argc; ++i) {
	665	int rc = env_print(argv[i]);
	666	if (rc < 0) {
	667	printf_P(PSTR("## Error: \"%s\" not defined\n"), argv[i]);
	668	rc = CMD_RET_FAILURE;
	669	}
	670	}
	671
	672	return rc;
	673	}
	674
	675
d0581f88	676	command_ret_t do_env_set(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
d684c216 L	677	{
	678	(void) cmdtp;
	679
	680	if (argc < 2)
	681	return CMD_RET_USAGE;
	682
	683	return _do_env_set(flag, argc, argv);
	684	}
	685
	686
7e24905c L	687	command_ret_t do_env_default(cmd_tbl_t *cmdtp, int flag,
	688	int argc, char * const argv[])
	689	{
	690	(void) cmdtp; (void) flag; (void) argc; (void) argv;
	691
55027f3b L	692	uint8_t tmp = env_valid;
	693	env_valid = 0;
	694
7e24905c	695	/* Reset the whole environment */
55027f3b	696	printf_P(PSTR("## Resetting to default environment\n"));
7e24905c L	697	envlist_import(ENVLIST_DELETE);
7e24905c L	698
55027f3b L	699	env_valid = tmp;
55027f3b L	700
7e24905c L	701	return CMD_RET_SUCCESS;
	702	}
	703
55027f3b	704
d0581f88	705	command_ret_t do_env_save(cmd_tbl_t cmdtp, int flag, int argc, char const argv[])
323398b1 L	706	{
	707	(void) cmdtp; (void) flag; (void) argc; (void) argv;
	708
	709	printf_P(PSTR("Saving Environment ...\n"));
d0581f88	710	return saveenv() ? CMD_RET_FAILURE : CMD_RET_SUCCESS;
323398b1 L	711	}
323398b1 L	712
55027f3b	713
7e24905c	714	#if defined(CONFIG_AUTO_COMPLETE)
d684c216 L	715	int env_complete(char var, int maxv, char cmdv[], int bufsz, char *buf)
	716	{
	717	ENTRY *match;
	718	int found, idx;
	719
	720	idx = 0;
	721	found = 0;
	722	cmdv[0] = NULL;
	723
	724	while ((idx = hmatch_r(var, idx, &match, &env_htab))) {
	725	int vallen = strlen(match->key) + 1;
	726
	727	if (found >= maxv - 2 \|\| bufsz < vallen)
	728	break;
	729
	730	cmdv[found++] = buf;
	731	memcpy(buf, match->key, vallen);
	732	buf += vallen;
	733	bufsz -= vallen;
	734	}
	735
	736	qsort(cmdv, found, sizeof(cmdv[0]), strcmp_compar);
	737
	738	if (idx)
	739	cmdv[found++] = "...";
	740
	741	cmdv[found] = NULL;
	742	return found;
	743	}
	744	#endif