2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
4 * SPDX-License-Identifier: GPL-2.0+
10 #include <avr/eeprom.h>
20 #define ENV_SIZE (CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
22 #define OBSOLETE_FLAG 0
24 #define ENVLIST_DELETE (1<<0)
33 const FLASH
char default_env
[] = {
34 ENV_BAUDRATE
"=" "115200" DELIM
35 ENV_BOOTDELAY
"=" "3" DELIM
36 ENV_BOOTCMD
"=" "reset; loadf; go ${startaddr}" DELIM
37 ENV_CPM3_SYSFILE
"=" CONFIG_CPM3_SYSFILE DELIM
38 ENV_PINALIAS
"=" "0:PG5,1:PG4,2:PB4,3:PB5,4:PB6,5:PB7,"
39 "6:PG3,7:PG2,8:PG1,9:PG0,10:PE7" DELIM
40 ENV_STARTADDRESS
"=" "0" DELIM
46 typedef struct environment_s
{
47 uint16_t crc
; /* CRC16 over data bytes */
48 uint8_t flags
; /* active/obsolete flags */
49 char data
[ENV_SIZE
]; /* Environment data */
54 typedef struct env_item_s
{
59 static uint8_t env_valid
;
60 static env_item_t env_list
[CONFIG_ENVVAR_MAX
];
61 static int entrycount
;
65 char env_get_char(uint16_t index
)
67 unsigned int off
= CONFIG_ENV_OFFSET
;
72 off
+= CONFIG_ENV_SIZE
;
74 ret
= (char) eeprom_read_byte((const uint8_t *)off
+ index
+
75 offsetof(env_t
, data
));
79 ret
= default_env
[index
];
86 static const FLASH
char *comp_key
;
89 int comp_env_items(const void *m1
, const void *m2
)
91 env_item_t
*ep1
= (env_item_t
*) m1
;
92 env_item_t
*ep2
= (env_item_t
*) m2
;
95 return - strcmp_P(ep2
->envvar
, comp_key
);
97 return strcmp(ep1
->envvar
, ep2
->envvar
);
101 env_item_t
*envlist_search(const MEMX
char *name
)
104 if (__builtin_avr_flash_segment(name
) != -1) {
106 return bsearch(0, env_list
, entrycount
,
107 sizeof(env_item_t
), comp_env_items
);
111 e
.envvar
= (char *) name
;
113 return bsearch(&e
, env_list
, entrycount
,
114 sizeof(env_item_t
), comp_env_items
);
118 e
.envvar
= (char *) name
;
120 return bsearch(&e
, env_list
, entrycount
,
121 sizeof(env_item_t
), comp_env_items
);
127 env_item_t
*envlist_enter(env_item_t
*e
)
129 const size_t size
= sizeof(env_item_t
);
132 ep
= bsearch(e
, env_list
, entrycount
,
133 size
, comp_env_items
);
136 if (entrycount
< CONFIG_ENVVAR_MAX
) {
138 env_list
[entrycount
++] = *e
;
139 qsort(env_list
, entrycount
, size
, comp_env_items
);
140 ep
= bsearch(e
, env_list
, entrycount
,
141 size
, comp_env_items
);
145 ep
->envvar
= e
->envvar
;
153 int env_item_delete(env_item_t
*ep
)
161 size_t size
= sizeof(env_item_t
);
162 memmove(ep
, ep
+ 1, (env_list
- ep
)*size
+ entrycount
*size
);
168 int envlist_delete(const MEMX
char *name
)
170 env_item_t
*ep
= envlist_search(name
);
173 return env_item_delete(ep
);
181 int envlist_import(uint8_t flags
)
190 if ((flags
& ENVLIST_DELETE
) != 0)
191 while (entrycount
!= 0)
192 env_item_delete(&env_list
[entrycount
-1]);
194 for (index
= 0; env_get_char(index
) != '\0'; ) {
195 for (len
= 0; env_get_char(index
+ len
) != '\0'; ++len
) {
196 if ((index
+ len
) >= ENV_SIZE
)
200 np
= (char *) xmalloc(len
+1);
202 printf_P(PSTR("## Can't malloc %d bytes\n"), len
+1);
207 while ((c
= env_get_char(index
++)) != '\0') {
208 if (!ef
&& (c
== '=')) {
225 uint16_t env_crc(uint16_t data_offset
)
233 for (i
= 0; !(c
== 0 && c0
== 0) && i
< ENV_SIZE
; i
++)
236 c
= eeprom_read_byte((const uint8_t *) data_offset
+ i
);
247 int env_check_valid(void)
249 const uint16_t offset
[2] = {CONFIG_ENV_OFFSET
,
250 CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
};
251 uint_fast8_t flags
[2], crc_ok
[2];
255 flags
[0] = eeprom_read_byte ((uint8_t *) offset
[0] +
256 offsetof(env_t
, flags
));
257 flags
[1] = eeprom_read_byte ((uint8_t *) offset
[1] +
258 offsetof(env_t
, flags
));
262 eeprom_read_word((uint16_t *) offset
[0] +
263 offsetof(env_t
, crc
))
264 == env_crc(offset
[0] + offsetof(env_t
, data
))
267 eeprom_read_word((uint16_t *) offset
[1] +
268 offsetof(env_t
, crc
))
269 == env_crc(offset
[1] + offsetof(env_t
, data
))
272 if (!crc_ok
[0] && !crc_ok
[1]) {
275 } else if (crc_ok
[0] && !crc_ok
[1]) {
277 } else if (!crc_ok
[0] && crc_ok
[1]) {
280 /* both ok - check serial */
282 if (flags
[1] == ACTIVE_FLAG
&& flags
[0] != ACTIVE_FLAG
)
284 else if (flags
[1] == OBSOLETE_FLAG
&& flags
[0] == 0xFF)
289 if (flags
[0] == ACTIVE_FLAG
&& flags
[1] == OBSOLETE_FLAG
)
291 else if (flags
[0] == OBSOLETE_FLAG
&& flags
[1] == ACTIVE_FLAG
)
293 else if (flags
[0] == 0xFF && flags
[1] == 0)
295 else if (flags
[1] == 0xFF && flags
[0] == 0)
297 else /* flags are equal - almost impossible */
308 env_valid
= env_check_valid();
309 if (env_valid
== 0) {
310 printf_P(PSTR("*** Warning - bad CRC, "
311 "using default environment\n\n"));
314 envlist_import(ENVLIST_DELETE
);
319 char *getenv(const MEMX
char *name
)
324 ep
= envlist_search(name
);
326 ret
= ep
->envvar
+ strlen(ep
->envvar
) +1;
331 int env_item_save(env_item_t
*ep
, uint16_t offset
, int space_left
)
334 char *var
= ep
->envvar
;
339 vlen
= strlen(var
+ nlen
+ 1);
342 if (nlen
+ vlen
+ 2 > space_left
)
345 eeprom_update_block(var
, (uint8_t *) offset
, nlen
);
347 eeprom_update_byte((uint8_t *) offset
++, '=');
348 eeprom_update_block(var
+ nlen
+1, (uint8_t *) offset
, vlen
+1);
350 return nlen
+ vlen
+ 2;
357 unsigned int off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
358 unsigned int off_red
= CONFIG_ENV_OFFSET
;
364 if (env_valid
== 2) {
365 off
= CONFIG_ENV_OFFSET
;
366 off_red
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
369 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
), 0xff);
371 pos
= off
+ offsetof(env_t
, data
);
373 for (int i
= 0 ; i
< entrycount
; i
++) {
374 len
= env_item_save(&env_list
[i
], pos
, left
);
382 eeprom_update_byte((uint8_t *) pos
, 0);
383 crc
= env_crc(off
+ offsetof(env_t
, data
));
384 eeprom_update_word((uint16_t *) off
+ offsetof(env_t
, crc
), crc
);
385 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
),
389 eeprom_update_byte((uint8_t *) off_red
+ offsetof(env_t
, flags
),
391 env_valid
= (env_valid
== 2) ? 1 : 2;
399 int env_item_print(env_item_t
*ep
)
402 char *ev
= ep
->envvar
;
404 len
= printf_P(PSTR("%s="), ev
);
405 len
+= printf_P(PSTR("%s\n"), ev
+ len
);
412 * Command interface: print one or all environment variables
414 * Returns -1 in case of error, or length of printed string
417 int env_print(const MEMX
char *name
)
421 if (name
) { /* print a single name */
423 env_item_t
*ep
= envlist_search(name
);
425 len
= env_item_print(ep
);
427 } else { /* print whole list */
429 for (int i
= 0 ; i
< entrycount
; i
++) {
430 len
+= env_item_print(&env_list
[i
]);
438 * Set or delete environment variable
440 * Set a new environment variable,
441 * or replace or delete an existing one.
443 * @param flag (not used)
445 * @param argv[1] Environment variable to set or delete
447 * @param argv[2] ... Value to set it to
449 * @return 0 if ok, 1 on error
452 command_ret_t
_do_env_set(int flag
, int argc
, char * const argv
[])
455 char *name
, *value
, *valp
, *p
;
463 if (strchr(name
, '=')) {
464 printf_P(PSTR("## Error: illegal character '='"
465 "in variable name \"%s\"\n"), name
);
466 return CMD_RET_FAILURE
;
469 if (len
> CONFIG_SYS_ENV_NAMELEN
) {
470 printf_P(PSTR("## Error: Variable name \"%s\" too long. "
471 "(max %d characters)\n"), name
, CONFIG_SYS_ENV_NAMELEN
);
472 return CMD_RET_FAILURE
;
478 if (argc
< 3 || argv
[2] == NULL
) {
479 int rc
= envlist_delete(name
);
480 return rc
? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
484 * Insert / replace new value
486 for (i
= 2, len
+= 1; i
< argc
; ++i
)
487 len
+= strlen(argv
[i
]) + 1;
489 value
= xmalloc(len
);
491 printf_P(PSTR("## Can't malloc %d bytes\n"), len
);
492 return CMD_RET_FAILURE
;
495 valp
= value
+ strlen(name
) + 1;
496 for (i
= 2, p
= valp
; i
< argc
; ++i
) {
499 while ((*p
++ = *v
++) != '\0')
507 ep
= envlist_enter(&e
);
509 printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
511 return CMD_RET_FAILURE
;
514 return CMD_RET_SUCCESS
;
518 * Set an environment variable
520 * @param varname Environment variable to set
521 * @param varvalue Value to set it to
522 * @return 0 if ok, 1 on error
525 int setenv(const MEMX
char *varname
, const char *varvalue
)
530 char *tmpname
= NULL
;
531 if (__builtin_avr_flash_segment(varname
) != -1) {
532 tmpname
= malloc(strlen_P(varname
)+1);
533 if (tmpname
== NULL
) {
534 printf_P(PSTR("setenv: Out of Memory!\n"));
537 strcpy_P(tmpname
, varname
);
539 tmpname
= (char *) varname
;
542 const char * const argv
[3] = { NULL
, tmpname
, varvalue
};
545 if (varvalue
== NULL
|| varvalue
[0] == '\0')
548 rc
= (int) _do_env_set(0, argc
, (char * const *)argv
);
557 * Set an environment variable to an integer value
559 * @param name Environment variable to set
560 * @param value Value to set it to
562 * @return 0 if ok, 1 on error
565 int setenv_intval(const MEMX
char *name
, unsigned long value
, int radix
)
569 ultoa(value
, buf
, radix
);
571 return setenv(name
, buf
);
575 * Set an environment variable to a decimal integer value
577 * @param name Environment variable to set
578 * @param value Value to set it to
579 * @return 0 if ok, 1 on error
581 int setenv_ulong(const MEMX
char *name
, unsigned long value
)
583 return setenv_intval(name
, value
, 10);
588 * Set an environment variable to a value in hex
590 * @param name Environment variable to set
591 * @param value Value to set it to
592 * @return 0 if ok, 1 on error
594 int setenv_hex(const MEMX
char *name
, unsigned long value
)
596 return setenv_intval(name
, value
, 16);
601 * Decode the integer value of an environment variable and return it.
603 * @param name Name of environemnt variable
604 * @param base Number base to use (normally 10, or 16 for hex)
605 * @param default_val Default value to return if the variable is not
607 * @return the decoded value, or default_val if not found
609 unsigned long getenv_ulong(const MEMX
char *name
, int base
, unsigned long default_val
)
614 env_item_t
*ep
= envlist_search(name
);
617 vp
= ep
->envvar
+ strlen(ep
->envvar
) +1;
618 value
= strtoul(vp
, &endp
, base
);
627 command_ret_t
do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
629 command_ret_t rc
= CMD_RET_SUCCESS
;
631 (void) cmdtp
; (void) flag
;
634 /* print all env vars */
635 int size
= env_print(NULL
);
637 return CMD_RET_FAILURE
;
638 printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
640 return CMD_RET_SUCCESS
;
643 /* print selected env vars */
644 for (int i
= 1; i
< argc
; ++i
) {
645 int rc
= env_print(argv
[i
]);
647 printf_P(PSTR("## Error: \"%s\" not defined\n"), argv
[i
]);
648 rc
= CMD_RET_FAILURE
;
656 command_ret_t
do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
661 return CMD_RET_USAGE
;
663 return _do_env_set(flag
, argc
, argv
);
667 command_ret_t
do_env_default(cmd_tbl_t
*cmdtp
, int flag
,
668 int argc
, char * const argv
[])
670 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
672 uint8_t tmp
= env_valid
;
675 /* Reset the whole environment */
676 printf_P(PSTR("## Resetting to default environment\n"));
677 envlist_import(ENVLIST_DELETE
);
681 return CMD_RET_SUCCESS
;
685 command_ret_t
do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
687 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
689 printf_P(PSTR("Saving Environment ...\n"));
690 return saveenv() ? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
694 #if defined(CONFIG_AUTO_COMPLETE)
695 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
704 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
705 int vallen
= strlen(match
->key
) + 1;
707 if (found
>= maxv
- 2 || bufsz
< vallen
)
711 memcpy(buf
, match
->key
, vallen
);
716 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
719 cmdv
[found
++] = "...";