xref: /openbmc/u-boot/include/env_flags.h (revision ed09a554)
1 /*
2  * (C) Copyright 2012
3  * Joe Hershberger, National Instruments, joe.hershberger@ni.com
4  *
5  * SPDX-License-Identifier:	GPL-2.0+
6  */
7 
8 #ifndef __ENV_FLAGS_H__
9 #define __ENV_FLAGS_H__
10 
11 enum env_flags_vartype {
12 	env_flags_vartype_string,
13 	env_flags_vartype_decimal,
14 	env_flags_vartype_hex,
15 	env_flags_vartype_bool,
16 #ifdef CONFIG_CMD_NET
17 	env_flags_vartype_ipaddr,
18 	env_flags_vartype_macaddr,
19 #endif
20 	env_flags_vartype_end
21 };
22 
23 enum env_flags_varaccess {
24 	env_flags_varaccess_any,
25 	env_flags_varaccess_readonly,
26 	env_flags_varaccess_writeonce,
27 	env_flags_varaccess_changedefault,
28 	env_flags_varaccess_end
29 };
30 
31 #define ENV_FLAGS_VAR ".flags"
32 #define ENV_FLAGS_ATTR_MAX_LEN 2
33 #define ENV_FLAGS_VARTYPE_LOC 0
34 #define ENV_FLAGS_VARACCESS_LOC 1
35 
36 #ifndef CONFIG_ENV_FLAGS_LIST_STATIC
37 #define CONFIG_ENV_FLAGS_LIST_STATIC ""
38 #endif
39 
40 #ifdef CONFIG_CMD_NET
41 #ifdef CONFIG_ENV_OVERWRITE
42 #define ETHADDR_FLAGS "ethaddr:ma,"
43 #else
44 #ifdef CONFIG_OVERWRITE_ETHADDR_ONCE
45 #define ETHADDR_FLAGS "ethaddr:mc,"
46 #else
47 #define ETHADDR_FLAGS "ethaddr:mo,"
48 #endif
49 #endif
50 #else
51 #define ETHADDR_FLAGS ""
52 #endif
53 
54 #ifndef CONFIG_ENV_OVERWRITE
55 #define SERIAL_FLAGS "serial#:so,"
56 #else
57 #define SERIAL_FLAGS ""
58 #endif
59 
60 #define ENV_FLAGS_LIST_STATIC \
61 	ETHADDR_FLAGS \
62 	SERIAL_FLAGS \
63 	CONFIG_ENV_FLAGS_LIST_STATIC
64 
65 #ifdef CONFIG_CMD_ENV_FLAGS
66 /*
67  * Print the whole list of available type flags.
68  */
69 void env_flags_print_vartypes(void);
70 /*
71  * Print the whole list of available access flags.
72  */
73 void env_flags_print_varaccess(void);
74 /*
75  * Return the name of the type.
76  */
77 const char *env_flags_get_vartype_name(enum env_flags_vartype type);
78 /*
79  * Return the name of the access.
80  */
81 const char *env_flags_get_varaccess_name(enum env_flags_varaccess access);
82 #endif
83 
84 /*
85  * Parse the flags string from a .flags attribute list into the vartype enum.
86  */
87 enum env_flags_vartype env_flags_parse_vartype(const char *flags);
88 /*
89  * Parse the flags string from a .flags attribute list into the varaccess enum.
90  */
91 enum env_flags_varaccess env_flags_parse_varaccess(const char *flags);
92 /*
93  * Parse the binary flags from a hash table entry into the varaccess enum.
94  */
95 enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags);
96 
97 #ifdef USE_HOSTCC
98 /*
99  * Look up the type of a variable directly from the .flags var.
100  */
101 enum env_flags_vartype env_flags_get_type(const char *name);
102 /*
103  * Look up the access of a variable directly from the .flags var.
104  */
105 enum env_flags_varaccess env_flags_get_access(const char *name);
106 /*
107  * Validate the newval for its type to conform with the requirements defined by
108  * its flags (directly looked at the .flags var).
109  */
110 int env_flags_validate_type(const char *name, const char *newval);
111 /*
112  * Validate the newval for its access to conform with the requirements defined
113  * by its flags (directly looked at the .flags var).
114  */
115 int env_flags_validate_access(const char *name, int check_mask);
116 /*
117  * Validate that the proposed access to variable "name" is valid according to
118  * the defined flags for that variable, if any.
119  */
120 int env_flags_validate_varaccess(const char *name, int check_mask);
121 /*
122  * Validate the parameters passed to "env set" for type compliance
123  */
124 int env_flags_validate_env_set_params(int argc, char * const argv[]);
125 
126 #else /* !USE_HOSTCC */
127 
128 #include <search.h>
129 
130 /*
131  * When adding a variable to the environment, initialize the flags for that
132  * variable.
133  */
134 void env_flags_init(ENTRY *var_entry);
135 
136 /*
137  * Validate the newval for to conform with the requirements defined by its flags
138  */
139 int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op,
140 	int flag);
141 
142 #endif /* USE_HOSTCC */
143 
144 /*
145  * These are the binary flags used in the environment entry->flags variable to
146  * decribe properties of veriables in the table
147  */
148 #define ENV_FLAGS_VARTYPE_BIN_MASK			0x00000007
149 /* The actual variable type values use the enum value (within the mask) */
150 #define ENV_FLAGS_VARACCESS_PREVENT_DELETE		0x00000008
151 #define ENV_FLAGS_VARACCESS_PREVENT_CREATE		0x00000010
152 #define ENV_FLAGS_VARACCESS_PREVENT_OVERWR		0x00000020
153 #define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR	0x00000040
154 #define ENV_FLAGS_VARACCESS_BIN_MASK			0x00000078
155 
156 #endif /* __ENV_FLAGS_H__ */
157