2 * (C) Copyright 2014 Leo C. <erbl259-lmu@yahoo.de>
4 * SPDX-License-Identifier: GPL-2.0
11 #include <avr/eeprom.h>
21 #define ENV_SIZE (CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
23 #define OBSOLETE_FLAG 0
25 #define ENVLIST_DELETE (1<<0)
34 const FLASH
char default_env
[] = {
35 ENV_BAUDRATE
"=" "115200" DELIM
36 ENV_BOOTDELAY
"=" "3" DELIM
37 ENV_BOOTCMD
"=" "pin ${pins}; loadcpm3; go ${startaddress}" 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 "pins" "=" "2,8 low 9 high 3 2" DELIM
48 typedef struct environment_s
{
49 uint16_t crc
; /* CRC16 over data bytes */
50 uint8_t flags
; /* active/obsolete flags */
51 char data
[ENV_SIZE
]; /* Environment data */
56 typedef struct env_item_s
{
61 static uint8_t env_valid
;
62 static env_item_t env_list
[CONFIG_ENVVAR_MAX
];
63 static int entrycount
;
67 char env_get_char(uint16_t index
)
69 unsigned int off
= CONFIG_ENV_OFFSET
;
74 off
+= CONFIG_ENV_SIZE
;
76 ret
= (char) eeprom_read_byte((const uint8_t *)off
+ index
+
77 offsetof(env_t
, data
));
81 ret
= default_env
[index
];
88 static const FLASH
char *comp_key
;
91 int comp_env_items(const void *m1
, const void *m2
)
93 env_item_t
*ep1
= (env_item_t
*) m1
;
94 env_item_t
*ep2
= (env_item_t
*) m2
;
97 return - strcmp_P(ep2
->envvar
, comp_key
);
99 return strcmp(ep1
->envvar
, ep2
->envvar
);
103 env_item_t
*envlist_search(const MEMX
char *name
)
106 if (__builtin_avr_flash_segment(name
) != -1) {
108 return bsearch(0, env_list
, entrycount
,
109 sizeof(env_item_t
), comp_env_items
);
113 e
.envvar
= (char *) name
;
115 return bsearch(&e
, env_list
, entrycount
,
116 sizeof(env_item_t
), comp_env_items
);
120 e
.envvar
= (char *) name
;
122 return bsearch(&e
, env_list
, entrycount
,
123 sizeof(env_item_t
), comp_env_items
);
129 env_item_t
*envlist_enter(env_item_t
*e
)
131 const size_t size
= sizeof(env_item_t
);
134 ep
= bsearch(e
, env_list
, entrycount
,
135 size
, comp_env_items
);
138 if (entrycount
< CONFIG_ENVVAR_MAX
) {
140 env_list
[entrycount
++] = *e
;
141 qsort(env_list
, entrycount
, size
, comp_env_items
);
142 ep
= bsearch(e
, env_list
, entrycount
,
143 size
, comp_env_items
);
147 ep
->envvar
= e
->envvar
;
155 int env_item_delete(env_item_t
*ep
)
163 size_t size
= sizeof(env_item_t
);
164 memmove(ep
, ep
+ 1, (env_list
- ep
)*size
+ entrycount
*size
);
170 int envlist_delete(const MEMX
char *name
)
172 env_item_t
*ep
= envlist_search(name
);
175 return env_item_delete(ep
);
183 int envlist_import(uint8_t flags
)
192 if ((flags
& ENVLIST_DELETE
) != 0)
193 while (entrycount
!= 0)
194 env_item_delete(&env_list
[entrycount
-1]);
196 for (index
= 0; env_get_char(index
) != '\0'; ) {
197 for (len
= 0; env_get_char(index
+ len
) != '\0'; ++len
) {
198 if ((index
+ len
) >= ENV_SIZE
)
202 np
= (char *) xmalloc(len
+1);
204 printf_P(PSTR("## Can't malloc %d bytes\n"), len
+1);
209 while ((c
= env_get_char(index
++)) != '\0') {
210 if (!ef
&& (c
== '=')) {
227 uint16_t env_crc(uint16_t data_offset
)
235 for (i
= 0; !(c
== 0 && c0
== 0) && i
< ENV_SIZE
; i
++)
238 c
= eeprom_read_byte((const uint8_t *) data_offset
+ i
);
249 int env_check_valid(void)
251 const uint16_t offset
[2] = {CONFIG_ENV_OFFSET
,
252 CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
};
253 uint_fast8_t flags
[2], crc_ok
[2];
257 flags
[0] = eeprom_read_byte ((uint8_t *) offset
[0] +
258 offsetof(env_t
, flags
));
259 flags
[1] = eeprom_read_byte ((uint8_t *) offset
[1] +
260 offsetof(env_t
, flags
));
264 eeprom_read_word((uint16_t *) offset
[0] +
265 offsetof(env_t
, crc
))
266 == env_crc(offset
[0] + offsetof(env_t
, data
))
269 eeprom_read_word((uint16_t *) offset
[1] +
270 offsetof(env_t
, crc
))
271 == env_crc(offset
[1] + offsetof(env_t
, data
))
274 if (!crc_ok
[0] && !crc_ok
[1]) {
277 } else if (crc_ok
[0] && !crc_ok
[1]) {
279 } else if (!crc_ok
[0] && crc_ok
[1]) {
282 /* both ok - check serial */
284 if (flags
[1] == ACTIVE_FLAG
&& flags
[0] != ACTIVE_FLAG
)
286 else if (flags
[1] == OBSOLETE_FLAG
&& flags
[0] == 0xFF)
291 if (flags
[0] == ACTIVE_FLAG
&& flags
[1] == OBSOLETE_FLAG
)
293 else if (flags
[0] == OBSOLETE_FLAG
&& flags
[1] == ACTIVE_FLAG
)
295 else if (flags
[0] == 0xFF && flags
[1] == 0)
297 else if (flags
[1] == 0xFF && flags
[0] == 0)
299 else /* flags are equal - almost impossible */
310 env_valid
= env_check_valid();
311 if (env_valid
== 0) {
312 printf_P(PSTR("*** Warning - bad CRC, "
313 "using default environment\n\n"));
316 envlist_import(ENVLIST_DELETE
);
321 char *getenv_char(const MEMX
char *name
)
326 ep
= envlist_search(name
);
328 ret
= ep
->envvar
+ strlen(ep
->envvar
) +1;
333 int env_item_save(env_item_t
*ep
, uint16_t offset
, int space_left
)
336 char *var
= ep
->envvar
;
341 vlen
= strlen(var
+ nlen
+ 1);
344 if (nlen
+ vlen
+ 2 > space_left
)
347 eeprom_update_block(var
, (uint8_t *) offset
, nlen
);
349 eeprom_update_byte((uint8_t *) offset
++, '=');
350 eeprom_update_block(var
+ nlen
+1, (uint8_t *) offset
, vlen
+1);
352 return nlen
+ vlen
+ 2;
359 unsigned int off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
360 unsigned int off_red
= CONFIG_ENV_OFFSET
;
366 if (env_valid
== 2) {
367 off
= CONFIG_ENV_OFFSET
;
368 off_red
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
371 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
), 0xff);
373 pos
= off
+ offsetof(env_t
, data
);
375 for (int i
= 0 ; i
< entrycount
; i
++) {
376 len
= env_item_save(&env_list
[i
], pos
, left
);
384 eeprom_update_byte((uint8_t *) pos
, 0);
385 crc
= env_crc(off
+ offsetof(env_t
, data
));
386 eeprom_update_word((uint16_t *) off
+ offsetof(env_t
, crc
), crc
);
387 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
),
391 eeprom_update_byte((uint8_t *) off_red
+ offsetof(env_t
, flags
),
393 env_valid
= (env_valid
== 2) ? 1 : 2;
401 int env_item_print(env_item_t
*ep
)
404 char *ev
= ep
->envvar
;
406 len
= printf_P(PSTR("%s="), ev
);
407 len
+= printf_P(PSTR("%s\n"), ev
+ len
);
414 * Command interface: print one or all environment variables
416 * Returns -1 in case of error, or length of printed string
419 int env_print(const MEMX
char *name
)
423 if (name
) { /* print a single name */
425 env_item_t
*ep
= envlist_search(name
);
427 len
= env_item_print(ep
);
429 } else { /* print whole list */
431 for (int i
= 0 ; i
< entrycount
; i
++) {
432 len
+= env_item_print(&env_list
[i
]);
440 * Set or delete environment variable
442 * Set a new environment variable,
443 * or replace or delete an existing one.
445 * @param flag (not used)
447 * @param argv[1] Environment variable to set or delete
449 * @param argv[2] ... Value to set it to
451 * @return 0 if ok, 1 on error
454 command_ret_t
_do_env_set(int flag
, int argc
, char * const argv
[])
457 char *name
, *value
, *valp
, *p
;
465 if (strchr(name
, '=')) {
466 printf_P(PSTR("## Error: illegal character '='"
467 "in variable name \"%s\"\n"), name
);
468 return CMD_RET_FAILURE
;
471 if (len
> CONFIG_SYS_ENV_NAMELEN
) {
472 printf_P(PSTR("## Error: Variable name \"%s\" too long. "
473 "(max %d characters)\n"), name
, CONFIG_SYS_ENV_NAMELEN
);
474 return CMD_RET_FAILURE
;
480 if (argc
< 3 || argv
[2] == NULL
) {
481 int rc
= envlist_delete(name
);
482 return rc
? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
486 * Insert / replace new value
488 for (i
= 2, len
+= 1; i
< argc
; ++i
)
489 len
+= strlen(argv
[i
]) + 1;
491 value
= xmalloc(len
);
493 printf_P(PSTR("## Can't malloc %d bytes\n"), len
);
494 return CMD_RET_FAILURE
;
497 valp
= value
+ strlen(name
) + 1;
498 for (i
= 2, p
= valp
; i
< argc
; ++i
) {
501 while ((*p
++ = *v
++) != '\0')
509 ep
= envlist_enter(&e
);
511 printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
513 return CMD_RET_FAILURE
;
516 return CMD_RET_SUCCESS
;
520 * Set an environment variable
522 * @param varname Environment variable to set
523 * @param varvalue Value to set it to
524 * @return 0 if ok, 1 on error
527 int setenv(const MEMX
char *varname
, const char *varvalue
)
532 char *tmpname
= NULL
;
533 if (__builtin_avr_flash_segment(varname
) != -1) {
534 tmpname
= malloc(strlen_P(varname
)+1);
535 if (tmpname
== NULL
) {
536 printf_P(PSTR("setenv: Out of Memory!\n"));
539 strcpy_P(tmpname
, varname
);
541 tmpname
= (char *) varname
;
544 const char * const argv
[3] = { NULL
, tmpname
, varvalue
};
547 if (varvalue
== NULL
|| varvalue
[0] == '\0')
550 rc
= (int) _do_env_set(0, argc
, (char * const *)argv
);
559 * Set an environment variable to an integer value
561 * @param name Environment variable to set
562 * @param value Value to set it to
564 * @return 0 if ok, 1 on error
567 int setenv_intval(const MEMX
char *name
, unsigned long value
, int radix
)
571 ultoa(value
, buf
, radix
);
573 return setenv(name
, buf
);
577 * Set an environment variable to a decimal integer value
579 * @param name Environment variable to set
580 * @param value Value to set it to
581 * @return 0 if ok, 1 on error
583 int setenv_ulong(const MEMX
char *name
, unsigned long value
)
585 return setenv_intval(name
, value
, 10);
590 * Set an environment variable to a value in hex
592 * @param name Environment variable to set
593 * @param value Value to set it to
594 * @return 0 if ok, 1 on error
596 int setenv_hex(const MEMX
char *name
, unsigned long value
)
598 return setenv_intval(name
, value
, 16);
603 * Decode the integer value of an environment variable and return it.
605 * @param name Name of environemnt variable
606 * @param base Number base to use (normally 10, or 16 for hex)
607 * @param default_val Default value to return if the variable is not
609 * @return the decoded value, or default_val if not found
611 unsigned long getenv_ulong(const MEMX
char *name
, int base
, unsigned long default_val
)
616 env_item_t
*ep
= envlist_search(name
);
619 vp
= ep
->envvar
+ strlen(ep
->envvar
) +1;
620 value
= strtoul(vp
, &endp
, base
);
630 * Read an environment variable as a boolean
632 bool getenv_yesno(const MEMX
char *name
)
634 char *s
= getenv_char(name
);
639 return strchr_P(PSTR("1yYtT"), *s
) != NULL
;
642 return *s == '1' || *s == 'y' || *s == 'Y' || *s == 't' || *s == 'T' ?
647 command_ret_t
do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
649 command_ret_t rc
= CMD_RET_SUCCESS
;
651 (void) cmdtp
; (void) flag
;
654 /* print all env vars */
655 int size
= env_print(NULL
);
657 return CMD_RET_FAILURE
;
658 printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
660 return CMD_RET_SUCCESS
;
663 /* print selected env vars */
664 for (int i
= 1; i
< argc
; ++i
) {
665 int rc
= env_print(argv
[i
]);
667 printf_P(PSTR("## Error: \"%s\" not defined\n"), argv
[i
]);
668 rc
= CMD_RET_FAILURE
;
676 command_ret_t
do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
681 return CMD_RET_USAGE
;
683 return _do_env_set(flag
, argc
, argv
);
687 command_ret_t
do_env_default(cmd_tbl_t
*cmdtp
, int flag
,
688 int argc
, char * const argv
[])
690 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
692 uint8_t tmp
= env_valid
;
695 /* Reset the whole environment */
696 printf_P(PSTR("## Resetting to default environment\n"));
697 envlist_import(ENVLIST_DELETE
);
701 return CMD_RET_SUCCESS
;
705 command_ret_t
do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
707 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
709 printf_P(PSTR("Saving Environment ...\n"));
710 return saveenv() ? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
714 #if defined(CONFIG_AUTO_COMPLETE)
715 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
724 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
725 int vallen
= strlen(match
->key
) + 1;
727 if (found
>= maxv
- 2 || bufsz
< vallen
)
731 memcpy(buf
, match
->key
, vallen
);
736 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
739 cmdv
[found
++] = "...";