2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
4 * SPDX-License-Identifier: GPL-2.0
8 #include <avr/eeprom.h>
15 #define ENV_SIZE (CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
17 #define OBSOLETE_FLAG 0
19 #define ENVLIST_DELETE (1<<0)
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
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 */
50 typedef struct env_item_s
{
55 static uint8_t env_valid
;
56 static env_item_t env_list
[CONFIG_ENVVAR_MAX
];
57 static int entrycount
;
61 char env_get_char(uint16_t index
)
63 unsigned int off
= CONFIG_ENV_OFFSET
;
68 off
+= CONFIG_ENV_SIZE
;
70 ret
= (char) eeprom_read_byte((const uint8_t *)off
+ index
+
71 offsetof(env_t
, data
));
75 ret
= default_env
[index
];
82 static const FLASH
char *comp_key
;
85 int comp_env_items(const void *m1
, const void *m2
)
87 env_item_t
*ep1
= (env_item_t
*) m1
;
88 env_item_t
*ep2
= (env_item_t
*) m2
;
91 return - strcmp_P(ep2
->envvar
, comp_key
);
93 return strcmp(ep1
->envvar
, ep2
->envvar
);
97 env_item_t
*envlist_search(const MEMX
char *name
)
100 if (__builtin_avr_flash_segment(name
) != -1) {
102 return bsearch(0, env_list
, entrycount
,
103 sizeof(env_item_t
), comp_env_items
);
107 e
.envvar
= (char *) name
;
109 return bsearch(&e
, env_list
, entrycount
,
110 sizeof(env_item_t
), comp_env_items
);
114 e
.envvar
= (char *) name
;
116 return bsearch(&e
, env_list
, entrycount
,
117 sizeof(env_item_t
), comp_env_items
);
123 env_item_t
*envlist_enter(env_item_t
*e
)
125 const size_t size
= sizeof(env_item_t
);
128 ep
= bsearch(e
, env_list
, entrycount
,
129 size
, comp_env_items
);
132 if (entrycount
< CONFIG_ENVVAR_MAX
) {
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
);
141 ep
->envvar
= e
->envvar
;
149 int env_item_delete(env_item_t
*ep
)
157 size_t size
= sizeof(env_item_t
);
158 memmove(ep
, ep
+ 1, (env_list
- ep
)*size
+ entrycount
*size
);
164 int envlist_delete(const MEMX
char *name
)
166 env_item_t
*ep
= envlist_search(name
);
169 return env_item_delete(ep
);
177 int envlist_import(uint8_t flags
)
186 if ((flags
& ENVLIST_DELETE
) != 0)
187 while (entrycount
!= 0)
188 env_item_delete(&env_list
[entrycount
-1]);
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
)
196 np
= (char *) malloc(len
+1);
198 printf_P(PSTR("## Can't malloc %d bytes\n"), len
+1);
203 while ((c
= env_get_char(index
++)) != '\0') {
204 if (!ef
&& (c
== '=')) {
221 uint16_t env_crc(uint16_t data_offset
)
229 for (i
= 0; !(c
== 0 && c0
== 0) && i
< ENV_SIZE
; i
++)
232 c
= eeprom_read_byte((const uint8_t *) data_offset
+ i
);
243 int env_check_valid(void)
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];
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
));
258 eeprom_read_word((uint16_t *) offset
[0] +
259 offsetof(env_t
, crc
))
260 == env_crc(offset
[0] + offsetof(env_t
, data
))
263 eeprom_read_word((uint16_t *) offset
[1] +
264 offsetof(env_t
, crc
))
265 == env_crc(offset
[1] + offsetof(env_t
, data
))
268 if (!crc_ok
[0] && !crc_ok
[1]) {
271 } else if (crc_ok
[0] && !crc_ok
[1]) {
273 } else if (!crc_ok
[0] && crc_ok
[1]) {
276 /* both ok - check serial */
278 if (flags
[1] == ACTIVE_FLAG
&& flags
[0] != ACTIVE_FLAG
)
280 else if (flags
[1] == OBSOLETE_FLAG
&& flags
[0] == 0xFF)
285 if (flags
[0] == ACTIVE_FLAG
&& flags
[1] == OBSOLETE_FLAG
)
287 else if (flags
[0] == OBSOLETE_FLAG
&& flags
[1] == ACTIVE_FLAG
)
289 else if (flags
[0] == 0xFF && flags
[1] == 0)
291 else if (flags
[1] == 0xFF && flags
[0] == 0)
293 else /* flags are equal - almost impossible */
304 env_valid
= env_check_valid();
305 if (env_valid
== 0) {
306 printf_P(PSTR("*** Warning - bad CRC, "
307 "using default environment\n\n"));
310 envlist_import(ENVLIST_DELETE
);
315 char *getenv_str(const MEMX
char *name
)
320 ep
= envlist_search(name
);
322 ret
= ep
->envvar
+ strlen(ep
->envvar
) +1;
327 int env_item_save(env_item_t
*ep
, uint16_t offset
, int space_left
)
330 char *var
= ep
->envvar
;
335 vlen
= strlen(var
+ nlen
+ 1);
338 if (nlen
+ vlen
+ 2 > space_left
)
341 eeprom_update_block(var
, (uint8_t *) offset
, nlen
);
343 eeprom_update_byte((uint8_t *) offset
++, '=');
344 eeprom_update_block(var
+ nlen
+1, (uint8_t *) offset
, vlen
+1);
346 return nlen
+ vlen
+ 2;
353 unsigned int off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
354 unsigned int off_red
= CONFIG_ENV_OFFSET
;
360 if (env_valid
== 2) {
361 off
= CONFIG_ENV_OFFSET
;
362 off_red
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
365 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
), 0xff);
367 pos
= off
+ offsetof(env_t
, data
);
369 for (int i
= 0 ; i
< entrycount
; i
++) {
370 len
= env_item_save(&env_list
[i
], pos
, left
);
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
),
385 eeprom_update_byte((uint8_t *) off_red
+ offsetof(env_t
, flags
),
387 env_valid
= (env_valid
== 2) ? 1 : 2;
395 int env_item_print(env_item_t
*ep
)
398 char *ev
= ep
->envvar
;
400 len
= printf_P(PSTR("%s="), ev
);
401 len
+= printf_P(PSTR("%s\n"), ev
+ len
);
408 * Command interface: print one or all environment variables
410 * Returns -1 in case of error, or length of printed string
413 int env_print(const MEMX
char *name
)
417 if (name
) { /* print a single name */
419 env_item_t
*ep
= envlist_search(name
);
421 len
= env_item_print(ep
);
423 } else { /* print whole list */
425 for (int i
= 0 ; i
< entrycount
; i
++) {
426 len
+= env_item_print(&env_list
[i
]);
434 * Set or delete environment variable
436 * Set a new environment variable,
437 * or replace or delete an existing one.
439 * @param flag (not used)
441 * @param argv[1] Environment variable to set or delete
443 * @param argv[2] ... Value to set it to
445 * @return 0 if ok, 1 on error
448 command_ret_t
_do_env_set(uint_fast8_t flag
, int argc
, char * const argv
[])
451 char *name
, *value
, *valp
, *p
;
459 if (strchr(name
, '=')) {
460 printf_P(PSTR("## Error: illegal character '='"
461 "in variable name \"%s\"\n"), name
);
462 return CMD_RET_FAILURE
;
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
;
474 if (argc
< 3 || argv
[2] == NULL
) {
475 int rc
= envlist_delete(name
);
476 return rc
? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
480 * Insert / replace new value
482 for (i
= 2, len
+= 1; i
< argc
; ++i
)
483 len
+= strlen(argv
[i
]) + 1;
487 printf_P(PSTR("## Can't malloc %d bytes\n"), len
);
488 return CMD_RET_FAILURE
;
491 valp
= value
+ strlen(name
) + 1;
492 for (i
= 2, p
= valp
; i
< argc
; ++i
) {
495 while ((*p
++ = *v
++) != '\0')
503 ep
= envlist_enter(&e
);
505 printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
507 return CMD_RET_FAILURE
;
510 return CMD_RET_SUCCESS
;
514 * Set an environment variable
516 * @param varname Environment variable to set
517 * @param varvalue Value to set it to
518 * @return 0 if ok, 1 on error
521 int setenv(const MEMX
char *varname
, const char *varvalue
)
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"));
533 strcpy_P(tmpname
, varname
);
535 tmpname
= (char *) varname
;
538 const char * const argv
[3] = { NULL
, tmpname
, varvalue
};
541 if (varvalue
== NULL
|| varvalue
[0] == '\0')
544 rc
= (int) _do_env_set(0, argc
, (char * const *)argv
);
553 * Set an environment variable to an integer value
555 * @param name Environment variable to set
556 * @param value Value to set it to
558 * @return 0 if ok, 1 on error
561 int setenv_intval(const MEMX
char *name
, unsigned long value
, int radix
)
565 ultoa(value
, buf
, radix
);
567 return setenv(name
, buf
);
571 * Set an environment variable to a decimal integer value
573 * @param name Environment variable to set
574 * @param value Value to set it to
575 * @return 0 if ok, 1 on error
577 int setenv_ulong(const MEMX
char *name
, unsigned long value
)
579 return setenv_intval(name
, value
, 10);
584 * Set an environment variable to a value in hex
586 * @param name Environment variable to set
587 * @param value Value to set it to
588 * @return 0 if ok, 1 on error
590 int setenv_hex(const MEMX
char *name
, unsigned long value
)
592 return setenv_intval(name
, value
, 16);
597 * Decode the integer value of an environment variable and return it.
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
603 * @return the decoded value, or default_val if not found
605 unsigned long getenv_ulong(const MEMX
char *name
, int base
, unsigned long default_val
)
610 env_item_t
*ep
= envlist_search(name
);
613 vp
= ep
->envvar
+ strlen(ep
->envvar
) +1;
614 value
= strtoul(vp
, &endp
, base
);
624 * Read an environment variable as a boolean
626 bool getenv_yesno(const MEMX
char *name
)
628 char *s
= getenv_str(name
);
633 return strchr_P(PSTR("1yYtT"), *s
) != NULL
;
636 return *s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T' ?
641 command_ret_t
do_env_print(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[])
643 command_ret_t rc
= CMD_RET_SUCCESS
;
645 (void) cmdtp
; (void) flag
;
648 /* print all env vars */
649 int size
= env_print(NULL
);
651 return CMD_RET_FAILURE
;
652 printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
654 return CMD_RET_SUCCESS
;
657 /* print selected env vars */
658 for (int i
= 1; i
< argc
; ++i
) {
659 int rc
= env_print(argv
[i
]);
661 printf_P(PSTR("## Error: \"%s\" not defined\n"), argv
[i
]);
662 rc
= CMD_RET_FAILURE
;
670 command_ret_t
do_env_set(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[])
675 return CMD_RET_USAGE
;
677 return _do_env_set(flag
, argc
, argv
);
681 command_ret_t
do_env_default(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
,
682 int argc
, char * const argv
[])
684 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
686 uint8_t tmp
= env_valid
;
689 /* Reset the whole environment */
690 printf_P(PSTR("## Resetting to default environment\n"));
691 envlist_import(ENVLIST_DELETE
);
695 return CMD_RET_SUCCESS
;
699 command_ret_t
do_env_save(cmd_tbl_t
*cmdtp
, uint_fast8_t flag
, int argc
, char * const argv
[])
701 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
703 printf_P(PSTR("Saving Environment ...\n"));
704 return saveenv() ? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
708 #if defined(CONFIG_AUTO_COMPLETE)
709 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
718 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
719 int vallen
= strlen(match
->key
) + 1;
721 if (found
>= maxv
- 2 || bufsz
< vallen
)
725 memcpy(buf
, match
->key
, vallen
);
730 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
733 cmdv
[found
++] = "...";