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