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