]>
cloudbase.mooo.com Git - z180-stamp.git/blob - avr/env.c
4 #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 "bootdelay=" "3" DELIM
30 "bootcmd=" "reset; loadf; go ${startaddr}" DELIM
31 "baudrate=" "115200" DELIM
32 "startaddr=" "0" DELIM
37 typedef struct environment_s
{
38 uint16_t crc
; /* CRC16 over data bytes */
39 uint8_t flags
; /* active/obsolete flags */
40 char data
[ENV_SIZE
]; /* Environment data */
45 typedef struct env_item_s
{
50 static uint8_t env_valid
;
51 static env_item_t env_list
[CONFIG_ENVVAR_MAX
];
52 static int entrycount
;
56 char env_get_char(uint16_t index
)
58 unsigned int off
= CONFIG_ENV_OFFSET
;
63 off
+= CONFIG_ENV_SIZE
;
65 ret
= (char) eeprom_read_byte((const uint8_t *)off
+ index
+
66 offsetof(env_t
, data
));
70 ret
= default_env
[index
];
77 static const FLASH
char *comp_key
;
80 int comp_env_items(const void *m1
, const void *m2
)
82 env_item_t
*ep1
= (env_item_t
*) m1
;
83 env_item_t
*ep2
= (env_item_t
*) m2
;
86 return - strcmp_P(ep2
->envvar
, comp_key
);
88 return strcmp(ep1
->envvar
, ep2
->envvar
);
92 env_item_t
*envlist_search(const MEMX
char *name
)
95 if (__builtin_avr_flash_segment(name
) != -1) {
97 return bsearch(0, env_list
, entrycount
,
98 sizeof(env_item_t
), comp_env_items
);
102 e
.envvar
= (char *) name
;
104 return bsearch(&e
, env_list
, entrycount
,
105 sizeof(env_item_t
), comp_env_items
);
109 e
.envvar
= (char *) name
;
111 return bsearch(&e
, env_list
, entrycount
,
112 sizeof(env_item_t
), comp_env_items
);
118 env_item_t
*envlist_enter(env_item_t
*e
)
120 const size_t size
= sizeof(env_item_t
);
123 ep
= bsearch(e
, env_list
, entrycount
,
124 size
, comp_env_items
);
127 if (entrycount
< CONFIG_ENVVAR_MAX
) {
129 env_list
[entrycount
++] = *e
;
130 qsort(env_list
, entrycount
, size
, comp_env_items
);
131 ep
= bsearch(e
, env_list
, entrycount
,
132 size
, comp_env_items
);
136 ep
->envvar
= e
->envvar
;
144 int env_item_delete(env_item_t
*ep
)
152 size_t size
= sizeof(env_item_t
);
153 memmove(ep
, ep
+ 1, (env_list
- ep
)*size
+ entrycount
*size
);
159 int envlist_delete(const MEMX
char *name
)
161 env_item_t
*ep
= envlist_search(name
);
164 return env_item_delete(ep
);
172 int envlist_import(uint8_t flags
)
181 if ((flags
& ENVLIST_DELETE
) != 0)
182 while (entrycount
!= 0)
183 env_item_delete(&env_list
[entrycount
-1]);
185 for (index
= 0; env_get_char(index
) != '\0'; ) {
186 for (len
= 0; env_get_char(index
+ len
) != '\0'; ++len
) {
187 if ((index
+ len
) >= ENV_SIZE
)
191 np
= (char *) xmalloc(len
+1);
193 printf_P(PSTR("## Can't malloc %d bytes\n"), len
+1);
198 while ((c
= env_get_char(index
++)) != '\0') {
199 if (!ef
&& (c
== '=')) {
216 uint16_t env_crc(uint16_t data_offset
)
224 for (i
= 0; !(c
== 0 && c0
== 0) && i
< ENV_SIZE
; i
++)
227 c
= eeprom_read_byte((const uint8_t *) data_offset
+ i
);
238 int env_check_valid(void)
240 const uint16_t offset
[2] = {CONFIG_ENV_OFFSET
,
241 CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
};
242 uint_fast8_t flags
[2], crc_ok
[2];
246 flags
[0] = eeprom_read_byte ((uint8_t *) offset
[0] +
247 offsetof(env_t
, flags
));
248 flags
[1] = eeprom_read_byte ((uint8_t *) offset
[1] +
249 offsetof(env_t
, flags
));
253 eeprom_read_word((uint16_t *) offset
[0] +
254 offsetof(env_t
, crc
))
255 == env_crc(offset
[0] + offsetof(env_t
, data
))
258 eeprom_read_word((uint16_t *) offset
[1] +
259 offsetof(env_t
, crc
))
260 == env_crc(offset
[1] + offsetof(env_t
, data
))
263 if (!crc_ok
[0] && !crc_ok
[1]) {
266 } else if (crc_ok
[0] && !crc_ok
[1]) {
268 } else if (!crc_ok
[0] && crc_ok
[1]) {
271 /* both ok - check serial */
273 if (flags
[1] == ACTIVE_FLAG
&& flags
[0] != ACTIVE_FLAG
)
275 else if (flags
[1] == OBSOLETE_FLAG
&& flags
[0] == 0xFF)
280 if (flags
[0] == ACTIVE_FLAG
&& flags
[1] == OBSOLETE_FLAG
)
282 else if (flags
[0] == OBSOLETE_FLAG
&& flags
[1] == ACTIVE_FLAG
)
284 else if (flags
[0] == 0xFF && flags
[1] == 0)
286 else if (flags
[1] == 0xFF && flags
[0] == 0)
288 else /* flags are equal - almost impossible */
299 env_valid
= env_check_valid();
300 if (env_valid
== 0) {
301 printf_P(PSTR("*** Warning - bad CRC, "
302 "using default environment\n\n"));
305 envlist_import(ENVLIST_DELETE
);
310 char *getenv(const MEMX
char *name
)
315 ep
= envlist_search(name
);
317 ret
= ep
->envvar
+ strlen(ep
->envvar
) +1;
322 int env_item_save(env_item_t
*ep
, uint16_t offset
, int space_left
)
325 char *var
= ep
->envvar
;
330 vlen
= strlen(var
+ nlen
+ 1);
333 if (nlen
+ vlen
+ 2 > space_left
)
336 eeprom_update_block(var
, (uint8_t *) offset
, nlen
);
338 eeprom_update_byte((uint8_t *) offset
++, '=');
339 eeprom_update_block(var
+ nlen
+1, (uint8_t *) offset
, vlen
+1);
341 return nlen
+ vlen
+ 2;
348 unsigned int off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
349 unsigned int off_red
= CONFIG_ENV_OFFSET
;
355 if (env_valid
== 2) {
356 off
= CONFIG_ENV_OFFSET
;
357 off_red
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
360 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
), 0xff);
362 pos
= off
+ offsetof(env_t
, data
);
364 for (int i
= 0 ; i
< entrycount
; i
++) {
365 len
= env_item_save(&env_list
[i
], pos
, left
);
373 eeprom_update_byte((uint8_t *) pos
, 0);
374 crc
= env_crc(off
+ offsetof(env_t
, data
));
375 eeprom_update_word((uint16_t *) off
+ offsetof(env_t
, crc
), crc
);
376 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
),
380 eeprom_update_byte((uint8_t *) off_red
+ offsetof(env_t
, flags
),
382 env_valid
= (env_valid
== 2) ? 1 : 2;
390 int env_item_print(env_item_t
*ep
)
393 char *ev
= ep
->envvar
;
395 len
= printf_P(PSTR("%s="), ev
);
396 len
+= printf_P(PSTR("%s\n"), ev
+ len
);
403 * Command interface: print one or all environment variables
405 * Returns -1 in case of error, or length of printed string
408 int env_print(const MEMX
char *name
)
412 if (name
) { /* print a single name */
414 env_item_t
*ep
= envlist_search(name
);
416 len
= env_item_print(ep
);
418 } else { /* print whole list */
420 for (int i
= 0 ; i
< entrycount
; i
++) {
421 len
+= env_item_print(&env_list
[i
]);
429 * Set or delete environment variable
431 * Set a new environment variable,
432 * or replace or delete an existing one.
434 * @param flag (not used)
436 * @param argv[1] Environment variable to set or delete
438 * @param argv[2] ... Value to set it to
440 * @return 0 if ok, 1 on error
443 command_ret_t
_do_env_set(int flag
, int argc
, char * const argv
[])
446 char *name
, *value
, *valp
, *p
;
450 debug("Initial value for argc=%d\n", argc
);
455 if (strchr(name
, '=')) {
456 printf_P(PSTR("## Error: illegal character '='"
457 "in variable name \"%s\"\n"), name
);
458 return CMD_RET_FAILURE
;
461 if (len
> CONFIG_SYS_ENV_NAMELEN
) {
462 printf_P(PSTR("## Error: Variable name \"%s\" too long. "
463 "(max %d characters)\n"), name
, CONFIG_SYS_ENV_NAMELEN
);
464 return CMD_RET_FAILURE
;
470 if (argc
< 3 || argv
[2] == NULL
) {
471 int rc
= envlist_delete(name
);
472 return rc
? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
476 * Insert / replace new value
478 for (i
= 2, len
+= 1; i
< argc
; ++i
)
479 len
+= strlen(argv
[i
]) + 1;
481 value
= xmalloc(len
);
483 printf_P(PSTR("## Can't malloc %d bytes\n"), len
);
484 return CMD_RET_FAILURE
;
487 valp
= value
+ strlen(name
) + 1;
488 for (i
= 2, p
= valp
; i
< argc
; ++i
) {
491 while ((*p
++ = *v
++) != '\0')
499 ep
= envlist_enter(&e
);
501 printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
503 return CMD_RET_FAILURE
;
506 return CMD_RET_SUCCESS
;
510 * Set an environment variable
512 * @param varname Environment variable to set
513 * @param varvalue Value to set it to
514 * @return 0 if ok, 1 on error
517 int setenv(const char *varname
, const char *varvalue
)
519 const char * const argv
[3] = { NULL
, varname
, varvalue
};
522 if (varvalue
== NULL
|| varvalue
[0] == '\0')
525 return (int) _do_env_set(0, argc
, (char * const *)argv
);
529 * Set an environment variable to an integer value
531 * @param name Environment variable to set
532 * @param value Value to set it to
534 * @return 0 if ok, 1 on error
537 int setenv_intval(const MEMX
char *name
, unsigned long value
, int radix
)
541 ultoa(value
, buf
, radix
);
543 return setenv(name
, buf
);
547 * Set an environment variable to a decimal integer value
549 * @param name Environment variable to set
550 * @param value Value to set it to
551 * @return 0 if ok, 1 on error
553 int setenv_ulong(const MEMX
char *name
, unsigned long value
)
555 return setenv_intval(name
, value
, 10);
560 * Set an environment variable to a value in hex
562 * @param name Environment variable to set
563 * @param value Value to set it to
564 * @return 0 if ok, 1 on error
566 int setenv_hex(const MEMX
char *name
, unsigned long value
)
568 return setenv_intval(name
, value
, 16);
573 * Decode the integer value of an environment variable and return it.
575 * @param name Name of environemnt variable
576 * @param base Number base to use (normally 10, or 16 for hex)
577 * @param default_val Default value to return if the variable is not
579 * @return the decoded value, or default_val if not found
581 unsigned long getenv_ulong(const MEMX
char *name
, int base
, unsigned long default_val
)
586 env_item_t
*ep
= envlist_search(name
);
589 vp
= ep
->envvar
+ strlen(ep
->envvar
) +1;
590 value
= strtoul(vp
, &endp
, base
);
599 command_ret_t
do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
601 command_ret_t rc
= CMD_RET_SUCCESS
;
603 (void) cmdtp
; (void) flag
;
606 /* print all env vars */
607 int size
= env_print(NULL
);
609 return CMD_RET_FAILURE
;
610 printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
612 return CMD_RET_SUCCESS
;
615 /* print selected env vars */
616 for (int i
= 1; i
< argc
; ++i
) {
617 int rc
= env_print(argv
[i
]);
619 printf_P(PSTR("## Error: \"%s\" not defined\n"), argv
[i
]);
620 rc
= CMD_RET_FAILURE
;
628 command_ret_t
do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
633 return CMD_RET_USAGE
;
635 return _do_env_set(flag
, argc
, argv
);
639 command_ret_t
do_env_default(cmd_tbl_t
*cmdtp
, int flag
,
640 int argc
, char * const argv
[])
642 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
644 uint8_t tmp
= env_valid
;
647 /* Reset the whole environment */
648 printf_P(PSTR("## Resetting to default environment\n"));
649 envlist_import(ENVLIST_DELETE
);
653 return CMD_RET_SUCCESS
;
657 command_ret_t
do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
659 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
661 printf_P(PSTR("Saving Environment ...\n"));
662 return saveenv() ? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
666 #if defined(CONFIG_AUTO_COMPLETE)
667 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
676 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
677 int vallen
= strlen(match
->key
) + 1;
679 if (found
>= maxv
- 2 || bufsz
< vallen
)
683 memcpy(buf
, match
->key
, vallen
);
688 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
691 cmdv
[found
++] = "...";