diff options
Diffstat (limited to 'avr/env.c')
-rw-r--r-- | avr/env.c | 833 |
1 files changed, 833 insertions, 0 deletions
diff --git a/avr/env.c b/avr/env.c new file mode 100644 index 0000000..7cf33ac --- /dev/null +++ b/avr/env.c @@ -0,0 +1,833 @@ +#include "common.h" +#include <string.h> +#include <stdlib.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 ENV_GET_VAL (1<<0) + + +/* + * Default Environment + */ + +#define DELIM "\0" + +const FLASH char default_env[] = { + "bootdelay=" "3" DELIM + "bootcmd=" "reset; loadf; go $(startaddr)" DELIM + "baudrate=" "115200" DELIM + "startaddr=" "0" 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 { +#define EF_N_EEP (1<<7) /* Variable name is in EEPROM */ +#define EF_V_EEP (1<<6) /* Variable value is in EEPROM */ +#define EF_DIRTY (1<<0) /* Variable is new or value changed */ + uint8_t flags; + union { + uint16_t eep; + char *ram; + } name; + union { + uint16_t eep; + char *ram; + } val; +} 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; + + if (env_valid == 2) + off = CONFIG_ENV_OFFSET + CONFIG_ENV_SIZE; + + return (char) eeprom_read_byte((const uint8_t *)off + index + + offsetof(env_t, data)); +} + + +static +uint16_t varname_get(char *buf, env_item_t *ep) +{ + int i = 0; + char c; + + if (ep->flags & EF_N_EEP) { + + while ((c = env_get_char(ep->name.eep + i)) != '=' && + c != '\0' && i < CONFIG_SYS_ENV_NAMELEN) { + + buf[i] = c; + i++; + } + if (i > 0 && c != '=') { + debug("** ee_name: '%s' not '=' terminated!\n", buf); + } + } else { + strncpy(buf, ep->name.ram, CONFIG_SYS_ENV_NAMELEN); + i = strnlen(buf, CONFIG_SYS_ENV_NAMELEN); + } + buf[i] = '\0'; + return i; +} + + +static +uint16_t varval_get(char *buf, uint16_t index, int len) +{ + int i = 0; + char c; + + while ((c = env_get_char (index + i)) != '\0' && i < len) { + buf[i] = c; + i++; + }; + + buf[i] = '\0'; + + /* TODO: len check */ + + return i; +} + +static +int comp_env_key_item(const void *key, const void *item) +{ + char buf[CONFIG_SYS_ENV_NAMELEN+1]; + env_item_t *ep = (env_item_t *) item; + + varname_get(buf, ep); + + return strcmp((char *) key, buf); +} + +static +int comp_env_items(const void *m1, const void *m2) +{ + char b1[CONFIG_SYS_ENV_NAMELEN+1]; + char b2[CONFIG_SYS_ENV_NAMELEN+1]; + + env_item_t *ep1 = (env_item_t *) m1; + env_item_t *ep2 = (env_item_t *) m2; + + varname_get(b1, ep1); + varname_get(b2, ep2); + + return strcmp(b1, b2); +} + + +static +int envlist_import(void) +{ + char name[CONFIG_SYS_ENV_NAMELEN+1]; + uint16_t idx = 0; + int nlen; + env_item_t e; + + e.flags = EF_N_EEP | EF_V_EEP; + e.name.eep = idx; + while ((nlen = varname_get(name, &e)) != 0 && idx < ENV_SIZE) { + + if (entrycount <= CONFIG_ENVVAR_MAX) { + e.val.eep = idx + nlen + 1; + + env_list[entrycount++] = e; + + idx += nlen + 1; + while (env_get_char(idx++) != 0 && idx < ENV_SIZE) + ; + e.name.eep = idx; + } else { + debug("** Too many environment variables!\n"); + break; + } + } + qsort(env_list, entrycount, sizeof(env_item_t), comp_env_items); + + return 0; +} + + +static +int set_default_env(void) +{ + char buf[56]; + uint16_t eep = CONFIG_ENV_OFFSET + offsetof(env_t, data); + unsigned int len = ENV_SIZE; + unsigned int i, src = 0; + char c = 0xff, c0 = c; + + if (env_valid == 1) { + eep = CONFIG_ENV_OFFSET + offsetof(env_t, data) + CONFIG_ENV_SIZE; + } + + while (len) { + memcpy_P(buf, default_env+src, sizeof(buf)); + for (i=0; i < (len < sizeof(buf) ? len : sizeof(buf)) && + !(c == 0 && c0 == 0); + i++) { + c0 = c; c = buf[i]; + } + eeprom_update_block(buf, (char *) eep, i); + if (c == 0 && c0 == 0) + len = 0; + if (len > sizeof(buf)) + len -= sizeof(buf); + src += sizeof(buf); + eep += sizeof(buf); + } + + 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")); + set_default_env(); + } + entrycount = 0; + envlist_import(); + return 0; +} + + +static +env_item_t *envlist_search(const char *name) +{ + return bsearch(name, env_list, entrycount, + sizeof(env_item_t), comp_env_key_item); +} + + +static +env_item_t *envlist_enter(env_item_t *e) +{ + char *key = e->name.ram; + const size_t size = sizeof(env_item_t); + env_item_t *ep; + + ep = bsearch(key, env_list, entrycount, + size, comp_env_key_item); + + if (ep == NULL) { + if (entrycount < CONFIG_ENVVAR_MAX) { + + env_list[entrycount++] = *e; + qsort(env_list, entrycount, size, comp_env_items); + ep = bsearch(key, env_list, entrycount, + size, comp_env_key_item); + } + } else { + if ((ep->flags & EF_V_EEP) == 0) { + free(ep->val.ram); + } + ep->val.ram = e->val.ram; + } + + if (ep != NULL) { + ep->flags |= EF_DIRTY; + ep->flags &= ~EF_V_EEP; + + if ((ep->flags & EF_N_EEP) == 0) { + int nlen = strnlen(key, CONFIG_SYS_ENV_NAMELEN); + char *name = xmalloc(nlen + 1); + if (name == NULL) { + printf_P(PSTR("## Can't malloc %d bytes\n"), + nlen + 1); + return NULL; + } + strcpy(name, key); + name[nlen] = '\0'; + ep->name.ram = name; + } + } + + return ep; +} + + +static +int env_item_delete(env_item_t *ep) +{ + if (entrycount == 0) + return -1; + if ((ep->flags & EF_V_EEP) == 0) + free(ep->val.ram); + if ((ep->flags & EF_N_EEP) == 0) + free(ep->name.ram); + + 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 char *name) +{ + env_item_t *ep = bsearch(name, env_list, entrycount, + sizeof(env_item_t), comp_env_key_item); + + if (ep != NULL) + return env_item_delete(ep); + + return 1; +} + + +static +env_item_t *envlist_get(const char *name, uint_fast8_t flag) +{ + env_item_t *ep; + + ep = envlist_search(name); + + if (ep != NULL && (flag & ENV_GET_VAL)) { + if (ep->flags & EF_V_EEP) { + char *vp; + uint_fast8_t len; + /* TODO: function that gets len of val, + to get rid of xrealloc */ + vp = xmalloc(CONFIG_SYS_CBSIZE); + len = varval_get(vp, ep->val.eep, CONFIG_SYS_CBSIZE); + ep->val.ram = xrealloc(vp, len + 1); + ep->flags &= ~EF_V_EEP; + } + } + + return ep; +} + + +char *getenv(const char *name) +{ + env_item_t *ep; + char *ret = NULL; + + ep = envlist_get(name, ENV_GET_VAL); + if (ep != NULL) + ret = ep->val.ram; + return ret; +} + +static +int env_item_save(env_item_t *ep, uint16_t offset, int space_left) +{ + char buf[CONFIG_SYS_ENV_NAMELEN+1]; + int len; + env_item_t e = *ep; + + len = varname_get(buf, ep); + if (len == 0) + return 0; + buf[len++] = '='; + space_left -= len; + + if (space_left <= 0) + return 0; + + eeprom_update_block(buf, (uint8_t *) offset, len); + offset += len; + + if (e.val.ram != NULL) { + char c; + do { + if (e.flags & EF_V_EEP) + c = env_get_char(e.val.eep++); + else + c = *e.val.ram++; + + eeprom_update_byte((uint8_t *) offset, c); + offset++; + space_left--; + len++; + } while ((c != '\0') && space_left ); + } + return len; +} + + +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) { + while (entrycount != 0) { + env_item_delete(&env_list[entrycount-1]); + } + eeprom_update_byte((uint8_t *) off_red + offsetof(env_t, flags), + OBSOLETE_FLAG); + env_valid = (env_valid == 2) ? 1 : 2; + + envlist_import(); + } + + return rc; +} + + +static +int env_item_print(env_item_t *ep) +{ + char buf[CONFIG_SYS_ENV_NAMELEN+1]; + int len; + env_item_t e = *ep; + + varname_get(buf, ep); + len = printf_P(PSTR("%s="), buf); + + if (e.val.ram != NULL) { + while (1) { + char c; + if (e.flags & EF_V_EEP) + c = env_get_char(e.val.eep++); + else + c = *e.val.ram++; + + if (c != '\0') { + putchar(c); + len++; + } else + break; + } + } + putchar('\n'); + 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(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; +} + +static +int env_print_ramsize(void) +{ + int size = 0; + uint8_t name_cnt = 0; + uint8_t val_cnt = 0; + + for (int i = 0 ; i < entrycount; i++) { + if ((env_list[i].flags & EF_N_EEP) == 0 && + (env_list[i].name.ram != NULL)) { + name_cnt++; + size += strlen(env_list[i].name.ram) + 3; + } + if ((env_list[i].flags & EF_V_EEP) == 0 && + (env_list[i].val.ram != NULL)) { + val_cnt++; + size += strlen(env_list[i].val.ram) + 3; + } + } + printf_P(PSTR("%d bytes RAM used for %u names and %u values\n"), + size, name_cnt, val_cnt); + return size; +} + + +int do_env_print(cmd_tbl_t *cmdtp, int flag, int argc, char * const argv[]) +{ + int i; + int rcode = 0; + + (void) cmdtp; (void) flag; + + if (argc == 1) { + /* print all env vars */ + rcode = env_print(NULL); + if (rcode < 0) + return 1; + printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"), + rcode, ENV_SIZE); + env_print_ramsize(); + return 0; + } + + /* print selected env vars */ + for (i = 1; i < argc; ++i) { + int rc = env_print(argv[i]); + if (rc < 0) { + printf_P(PSTR("## Error: \"%s\" not defined\n"), argv[i]); + ++rcode; + } + } + + return rcode; +} + + +/** + * 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 +int _do_env_set(int flag, int argc, char * const argv[]) +{ + int i, len; + char *name, *value, *s; + env_item_t e, *ep; + + (void) flag; + debug("Initial value for argc=%d\n", argc); + + name = argv[1]; + value = argv[2]; + + if (strchr(name, '=')) { + printf_P(PSTR("## Error: illegal character '='" + "in variable name \"%s\"\n"), name); + return 1; + } + if (strlen(name) > CONFIG_SYS_ENV_NAMELEN) { + printf_P(PSTR("## Error: Variable name \"%s\" too long. " + "(max %d characters)\n"), name, CONFIG_SYS_ENV_NAMELEN); + return 1; + } +/* + env_id++; +*/ + /* Delete only ? */ + if (argc < 3 || argv[2] == NULL) { + int rc = envlist_delete(name); + return rc != 0; + } + + /* + * Insert / replace new value + */ + for (i = 2, len = 0; 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 1; + } + for (i = 2, s = value; i < argc; ++i) { + char *v = argv[i]; + + while ((*s++ = *v++) != '\0') + ; + *(s - 1) = ' '; + } + if (s != value) + *--s = '\0'; + + e.flags = EF_DIRTY; + e.name.ram = name; + e.val.ram = value; + ep = envlist_enter(&e); + if (!ep) { + printf_P(PSTR("## Error inserting \"%s\" variable.\n"), + name); + return 1; + } + + return 0; +} + +/** + * 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 char *varname, const char *varvalue) +{ + const char * const argv[3] = { NULL, varname, varvalue }; + int argc = 3; + + if (varvalue == NULL || varvalue[0] == '\0') + --argc; + + return _do_env_set(0, argc, (char * const *)argv); +} + +#if 0 +/** + * Set an environment variable to an integer value + * + * @param varname Environment variable to set + * @param value Value to set it to + * @return 0 if ok, 1 on error + */ +int setenv_ulong(const char *varname, unsigned long value) +{ + /* TODO: this should be unsigned */ + char *str = simple_itoa(value); + + return setenv(varname, str); +} +#endif + + +/** + * Set an environment variable to an value in hex + * + * @param varname Environment variable to set + * @param value Value to set it to + * @return 0 if ok, 1 on error + */ +int setenv_hex(const char *varname, unsigned long value) +{ + char str[sizeof(unsigned long) *2 + 1]; + + sprintf_P(str, PSTR("%lx"), value); + return setenv(varname, str); +} + +/** + * Get an environment variable as a hex value + * + * @param varname Environment variable to get + * @param default_val Return this, if variable does not exist + * @return hex value of variable or default_val + */ +unsigned long getenv_hex(const char *varname, unsigned long default_val) +{ + const char *s; + unsigned long value; + char *endp; + + s = getenv(varname); + if (s) + value = strtoul(s, &endp, 16); + if (!s || endp == s) + return default_val; + + return value; +} + +int 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); +} + + +int 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() ? 1 : 0; +} + +#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 |