[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 "getopt-min.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_str(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, bool mode)
{
	int len;
	char *ev = ep->envvar;

	if (mode) {
		len = printf_P(PSTR("setenv %s "), ev) - 7;
		len += printf_P(PSTR("'%s'\n"), ev + len) - 2;
	} else {
	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, bool mode)
{
	int len = -1;

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

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

	} else {		/* print whole list */
		len = 0;
		for (int i = 0 ; i < entrycount; i++) {
			len += env_item_print(&env_list[i], mode);
		}
	}
	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_str(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[])
{
	(void) cmdtp; (void) flag;

	bool mode = 0;
	command_ret_t rc = CMD_RET_SUCCESS;

	/* reset getopt() */
	optind = 0;

	int opt;
	while ((opt = getopt(argc, argv, PSTR("s"))) != -1) {
		switch (opt) {
		case 's':
			mode = 1;
			break;
		default: /* '?' */
			return CMD_RET_USAGE;
		}
	}

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

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

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