]>
cloudbase.mooo.com Git - z180-stamp.git/blob - avr/env.c
5 #include <avr/eeprom.h>
16 #define ENV_SIZE (CONFIG_ENV_SIZE - sizeof(uint16_t) -1)
18 #define OBSOLETE_FLAG 0
19 #define ENV_GET_VAL (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
{
46 #define EF_N_EEP (1<<7) /* Variable name is in EEPROM */
47 #define EF_V_EEP (1<<6) /* Variable value is in EEPROM */
48 #define EF_DIRTY (1<<0) /* Variable is new or value changed */
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
;
72 off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
74 return (char) eeprom_read_byte((const uint8_t *)off
+ index
+
75 offsetof(env_t
, data
));
80 uint16_t varname_get(char *buf
, env_item_t
*ep
)
85 if (ep
->flags
& EF_N_EEP
) {
87 while ((c
= env_get_char(ep
->name
.eep
+ i
)) != '=' &&
88 c
!= '\0' && i
< CONFIG_SYS_ENV_NAMELEN
) {
93 if (i
> 0 && c
!= '=') {
94 debug("** ee_name: '%s' not '=' terminated!\n", buf
);
97 strncpy(buf
, ep
->name
.ram
, CONFIG_SYS_ENV_NAMELEN
);
98 i
= strnlen(buf
, CONFIG_SYS_ENV_NAMELEN
);
106 uint16_t varval_getlen(uint16_t index
)
111 while ((c
= env_get_char (index
+ i
)) != '\0') {
119 uint16_t varval_get(char *buf
, uint16_t index
, int len
)
124 while ((c
= env_get_char (index
+ i
)) != '\0' && i
< len
) {
131 /* TODO: len check */
137 int comp_env_key_item(const void *key
, const void *item
)
139 char buf
[CONFIG_SYS_ENV_NAMELEN
+1];
140 env_item_t
*ep
= (env_item_t
*) item
;
142 varname_get(buf
, ep
);
144 return strcmp((char *) key
, buf
);
148 int comp_env_items(const void *m1
, const void *m2
)
150 char b1
[CONFIG_SYS_ENV_NAMELEN
+1];
151 char b2
[CONFIG_SYS_ENV_NAMELEN
+1];
153 env_item_t
*ep1
= (env_item_t
*) m1
;
154 env_item_t
*ep2
= (env_item_t
*) m2
;
156 varname_get(b1
, ep1
);
157 varname_get(b2
, ep2
);
159 return strcmp(b1
, b2
);
164 int envlist_import(void)
166 char name
[CONFIG_SYS_ENV_NAMELEN
+1];
171 e
.flags
= EF_N_EEP
| EF_V_EEP
;
173 while ((nlen
= varname_get(name
, &e
)) != 0 && idx
< ENV_SIZE
) {
175 if (entrycount
<= CONFIG_ENVVAR_MAX
) {
176 e
.val
.eep
= idx
+ nlen
+ 1;
178 env_list
[entrycount
++] = e
;
181 while (env_get_char(idx
++) != 0 && idx
< ENV_SIZE
)
185 debug("** Too many environment variables!\n");
189 qsort(env_list
, entrycount
, sizeof(env_item_t
), comp_env_items
);
196 int set_default_env(void)
199 uint16_t eep
= CONFIG_ENV_OFFSET
+ offsetof(env_t
, data
);
200 unsigned int len
= ENV_SIZE
;
201 unsigned int i
, src
= 0;
202 char c
= 0xff, c0
= c
;
204 if (env_valid
== 1) {
205 eep
= CONFIG_ENV_OFFSET
+ offsetof(env_t
, data
) + CONFIG_ENV_SIZE
;
209 memcpy_P(buf
, default_env
+src
, sizeof(buf
));
210 for (i
=0; i
< (len
< sizeof(buf
) ? len
: sizeof(buf
)) &&
211 !(c
== 0 && c0
== 0);
215 eeprom_update_block(buf
, (char *) eep
, i
);
216 if (c
== 0 && c0
== 0)
218 if (len
> sizeof(buf
))
229 uint16_t env_crc(uint16_t data_offset
)
237 for (i
= 0; !(c
== 0 && c0
== 0) && i
< ENV_SIZE
; i
++)
240 c
= eeprom_read_byte((const uint8_t *) data_offset
+ i
);
251 int env_check_valid(void)
253 const uint16_t offset
[2] = {CONFIG_ENV_OFFSET
,
254 CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
};
255 uint_fast8_t flags
[2], crc_ok
[2];
259 flags
[0] = eeprom_read_byte ((uint8_t *) offset
[0] +
260 offsetof(env_t
, flags
));
261 flags
[1] = eeprom_read_byte ((uint8_t *) offset
[1] +
262 offsetof(env_t
, flags
));
266 eeprom_read_word((uint16_t *) offset
[0] +
267 offsetof(env_t
, crc
))
268 == env_crc(offset
[0] + offsetof(env_t
, data
))
271 eeprom_read_word((uint16_t *) offset
[1] +
272 offsetof(env_t
, crc
))
273 == env_crc(offset
[1] + offsetof(env_t
, data
))
276 if (!crc_ok
[0] && !crc_ok
[1]) {
279 } else if (crc_ok
[0] && !crc_ok
[1]) {
281 } else if (!crc_ok
[0] && crc_ok
[1]) {
284 /* both ok - check serial */
286 if (flags
[1] == ACTIVE_FLAG
&& flags
[0] != ACTIVE_FLAG
)
288 else if (flags
[1] == OBSOLETE_FLAG
&& flags
[0] == 0xFF)
293 if (flags
[0] == ACTIVE_FLAG
&& flags
[1] == OBSOLETE_FLAG
)
295 else if (flags
[0] == OBSOLETE_FLAG
&& flags
[1] == ACTIVE_FLAG
)
297 else if (flags
[0] == 0xFF && flags
[1] == 0)
299 else if (flags
[1] == 0xFF && flags
[0] == 0)
301 else /* flags are equal - almost impossible */
312 env_valid
= env_check_valid();
313 if (env_valid
== 0) {
314 printf_P(PSTR("*** Warning - bad CRC, "
315 "using default environment\n\n"));
325 env_item_t
*envlist_search(const MEMX
char *name
)
327 char *p
= (char *) name
;
330 char buf
[CONFIG_SYS_ENV_NAMELEN
+1];
332 if (__builtin_avr_flash_segment(name
) != -1) {
334 while ((*p
++ = *name
++) != '\0')
340 return bsearch(p
, env_list
, entrycount
,
341 sizeof(env_item_t
), comp_env_key_item
);
346 env_item_t
*envlist_enter(env_item_t
*e
)
348 char *key
= e
->name
.ram
;
349 const size_t size
= sizeof(env_item_t
);
352 ep
= bsearch(key
, env_list
, entrycount
,
353 size
, comp_env_key_item
);
356 if (entrycount
< CONFIG_ENVVAR_MAX
) {
358 env_list
[entrycount
++] = *e
;
359 qsort(env_list
, entrycount
, size
, comp_env_items
);
360 ep
= bsearch(key
, env_list
, entrycount
,
361 size
, comp_env_key_item
);
364 if ((ep
->flags
& EF_V_EEP
) == 0) {
367 ep
->val
.ram
= e
->val
.ram
;
371 ep
->flags
|= EF_DIRTY
;
372 ep
->flags
&= ~EF_V_EEP
;
374 if ((ep
->flags
& EF_N_EEP
) == 0) {
375 int nlen
= strnlen(key
, CONFIG_SYS_ENV_NAMELEN
);
376 char *name
= xmalloc(nlen
+ 1);
378 printf_P(PSTR("## Can't malloc %d bytes\n"),
393 int env_item_delete(env_item_t
*ep
)
397 if ((ep
->flags
& EF_V_EEP
) == 0)
399 if ((ep
->flags
& EF_N_EEP
) == 0)
403 size_t size
= sizeof(env_item_t
);
404 memmove(ep
, ep
+ 1, (env_list
- ep
)*size
+ entrycount
*size
);
410 int envlist_delete(const char *name
)
412 env_item_t
*ep
= bsearch(name
, env_list
, entrycount
,
413 sizeof(env_item_t
), comp_env_key_item
);
416 return env_item_delete(ep
);
423 env_item_t
*envlist_get(const MEMX
char *name
, uint_fast8_t flag
)
427 ep
= envlist_search(name
);
429 if (ep
!= NULL
&& (flag
& ENV_GET_VAL
)) {
430 if (ep
->flags
& EF_V_EEP
) {
433 len
= varval_getlen(ep
->val
.eep
);
434 if (len
> CONFIG_SYS_CBSIZE
)
435 len
= CONFIG_SYS_CBSIZE
;
436 vp
= xmalloc(len
+ 1);
438 varval_get(vp
, ep
->val
.eep
, len
+ 1);
440 ep
->flags
&= ~EF_V_EEP
;
442 printf_P(PSTR("Out of memory!\n"));
450 char *getenv(const MEMX
char *name
)
455 ep
= envlist_get(name
, ENV_GET_VAL
);
462 int env_item_save(env_item_t
*ep
, uint16_t offset
, int space_left
)
464 char buf
[CONFIG_SYS_ENV_NAMELEN
+1];
468 len
= varname_get(buf
, ep
);
477 eeprom_update_block(buf
, (uint8_t *) offset
, len
);
480 if (e
.val
.ram
!= NULL
) {
483 if (e
.flags
& EF_V_EEP
)
484 c
= env_get_char(e
.val
.eep
++);
488 eeprom_update_byte((uint8_t *) offset
, c
);
492 } while ((c
!= '\0') && space_left
);
501 unsigned int off
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
502 unsigned int off_red
= CONFIG_ENV_OFFSET
;
508 if (env_valid
== 2) {
509 off
= CONFIG_ENV_OFFSET
;
510 off_red
= CONFIG_ENV_OFFSET
+ CONFIG_ENV_SIZE
;
513 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
), 0xff);
515 pos
= off
+ offsetof(env_t
, data
);
517 for (int i
= 0 ; i
< entrycount
; i
++) {
518 len
= env_item_save(&env_list
[i
], pos
, left
);
526 eeprom_update_byte((uint8_t *) pos
, 0);
527 crc
= env_crc(off
+ offsetof(env_t
, data
));
528 eeprom_update_word((uint16_t *) off
+ offsetof(env_t
, crc
), crc
);
529 eeprom_update_byte((uint8_t *) off
+ offsetof(env_t
, flags
),
533 while (entrycount
!= 0) {
534 env_item_delete(&env_list
[entrycount
-1]);
536 eeprom_update_byte((uint8_t *) off_red
+ offsetof(env_t
, flags
),
538 env_valid
= (env_valid
== 2) ? 1 : 2;
548 int env_item_print(env_item_t
*ep
)
550 char buf
[CONFIG_SYS_ENV_NAMELEN
+1];
554 varname_get(buf
, ep
);
555 len
= printf_P(PSTR("%s="), buf
);
557 if (e
.val
.ram
!= NULL
) {
560 if (e
.flags
& EF_V_EEP
)
561 c
= env_get_char(e
.val
.eep
++);
580 * Command interface: print one or all environment variables
582 * Returns -1 in case of error, or length of printed string
585 int env_print(const MEMX
char *name
)
589 if (name
) { /* print a single name */
591 env_item_t
*ep
= envlist_search(name
);
593 len
= env_item_print(ep
);
595 } else { /* print whole list */
597 for (int i
= 0 ; i
< entrycount
; i
++) {
598 len
+= env_item_print(&env_list
[i
]);
605 int env_print_ramsize(void)
608 uint8_t name_cnt
= 0;
611 for (int i
= 0 ; i
< entrycount
; i
++) {
612 if ((env_list
[i
].flags
& EF_N_EEP
) == 0 &&
613 (env_list
[i
].name
.ram
!= NULL
)) {
615 size
+= strlen(env_list
[i
].name
.ram
) + 3;
617 if ((env_list
[i
].flags
& EF_V_EEP
) == 0 &&
618 (env_list
[i
].val
.ram
!= NULL
)) {
620 size
+= strlen(env_list
[i
].val
.ram
) + 3;
623 printf_P(PSTR("%d bytes RAM used for %u names and %u values\n"),
624 size
, name_cnt
, val_cnt
);
629 command_ret_t
do_env_print(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
631 command_ret_t rc
= CMD_RET_SUCCESS
;
633 (void) cmdtp
; (void) flag
;
636 /* print all env vars */
637 int size
= env_print(NULL
);
639 return CMD_RET_FAILURE
;
640 printf_P(PSTR("\nEnvironment size: %d/%d bytes\n"),
643 return CMD_RET_SUCCESS
;
646 /* print selected env vars */
647 for (int i
= 1; i
< argc
; ++i
) {
648 int rc
= env_print(argv
[i
]);
650 printf_P(PSTR("## Error: \"%s\" not defined\n"), argv
[i
]);
651 rc
= CMD_RET_FAILURE
;
660 * Set or delete environment variable
662 * Set a new environment variable,
663 * or replace or delete an existing one.
665 * @param flag (not used)
667 * @param argv[1] Environment variable to set or delete
669 * @param argv[2] ... Value to set it to
671 * @return 0 if ok, 1 on error
674 command_ret_t
_do_env_set(int flag
, int argc
, char * const argv
[])
677 char *name
, *value
, *s
;
681 debug("Initial value for argc=%d\n", argc
);
686 if (strchr(name
, '=')) {
687 printf_P(PSTR("## Error: illegal character '='"
688 "in variable name \"%s\"\n"), name
);
689 return CMD_RET_FAILURE
;
691 if (strlen(name
) > CONFIG_SYS_ENV_NAMELEN
) {
692 printf_P(PSTR("## Error: Variable name \"%s\" too long. "
693 "(max %d characters)\n"), name
, CONFIG_SYS_ENV_NAMELEN
);
694 return CMD_RET_FAILURE
;
700 if (argc
< 3 || argv
[2] == NULL
) {
701 int rc
= envlist_delete(name
);
702 return rc
? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
706 * Insert / replace new value
708 for (i
= 2, len
= 0; i
< argc
; ++i
)
709 len
+= strlen(argv
[i
]) + 1;
711 value
= xmalloc(len
);
713 printf_P(PSTR("## Can't malloc %d bytes\n"), len
);
714 return CMD_RET_FAILURE
;
716 for (i
= 2, s
= value
; i
< argc
; ++i
) {
719 while ((*s
++ = *v
++) != '\0')
729 ep
= envlist_enter(&e
);
731 printf_P(PSTR("## Error inserting \"%s\" variable.\n"),
733 return CMD_RET_FAILURE
;
736 return CMD_RET_SUCCESS
;
740 * Set an environment variable
742 * @param varname Environment variable to set
743 * @param varvalue Value to set it to
744 * @return 0 if ok, 1 on error
747 int setenv(const char *varname
, const char *varvalue
)
749 const char * const argv
[3] = { NULL
, varname
, varvalue
};
752 if (varvalue
== NULL
|| varvalue
[0] == '\0')
755 return (int) _do_env_set(0, argc
, (char * const *)argv
);
760 * Set an environment variable to an integer value
762 * @param varname Environment variable to set
763 * @param value Value to set it to
764 * @return 0 if ok, 1 on error
766 int setenv_ulong(const char *varname
, unsigned long value
)
768 /* TODO: this should be unsigned */
769 char *str
= simple_itoa(value
);
771 return setenv(varname
, str
);
777 * Set an environment variable to an value in hex
779 * @param varname Environment variable to set
780 * @param value Value to set it to
781 * @return 0 if ok, 1 on error
783 int setenv_hex(const MEMX
char *varname
, unsigned long value
)
785 char str
[sizeof(unsigned long) *2 + 1];
787 sprintf_P(str
, PSTR("%lx"), value
);
788 return setenv(varname
, str
);
793 * Decode the integer value of an environment variable and return it.
795 * @param name Name of environemnt variable
796 * @param base Number base to use (normally 10, or 16 for hex)
797 * @param default_val Default value to return if the variable is not
799 * @return the decoded value, or default_val if not found
801 unsigned long getenv_ulong(const MEMX
char *name
, int base
, unsigned long default_val
)
807 env_item_t
*ep
= envlist_search(name
);
810 if (ep
->flags
& EF_V_EEP
) {
811 varval_get(buf
, ep
->val
.eep
, sizeof(buf
));
816 value
= strtoul(vp
, &endp
, base
);
826 command_ret_t
do_env_set(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
831 return CMD_RET_USAGE
;
833 return _do_env_set(flag
, argc
, argv
);
837 command_ret_t
do_env_save(cmd_tbl_t
*cmdtp
, int flag
, int argc
, char * const argv
[])
839 (void) cmdtp
; (void) flag
; (void) argc
; (void) argv
;
841 printf_P(PSTR("Saving Environment ...\n"));
842 return saveenv() ? CMD_RET_FAILURE
: CMD_RET_SUCCESS
;
845 #if defined(CONFIG_AUTO_COMPLETE)
846 int env_complete(char *var
, int maxv
, char *cmdv
[], int bufsz
, char *buf
)
855 while ((idx
= hmatch_r(var
, idx
, &match
, &env_htab
))) {
856 int vallen
= strlen(match
->key
) + 1;
858 if (found
>= maxv
- 2 || bufsz
< vallen
)
862 memcpy(buf
, match
->key
, vallen
);
867 qsort(cmdv
, found
, sizeof(cmdv
[0]), strcmp_compar
);
870 cmdv
[found
++] = "...";