avr/env.c

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