blob: 8823fb9602eaa78fdffc161004b003bfc65bff4d [file] [log] [blame]
Joe Hershberger25980902012-12-11 22:16:31 -06001/*
2 * (C) Copyright 2012
3 * Joe Hershberger, National Instruments, joe.hershberger@ni.com
4 *
Wolfgang Denk1a459662013-07-08 09:37:19 +02005 * SPDX-License-Identifier: GPL-2.0+
Joe Hershberger25980902012-12-11 22:16:31 -06006 */
7
8#ifndef __ENV_FLAGS_H__
9#define __ENV_FLAGS_H__
10
11enum 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
Joe Hershberger267541f2012-12-11 22:16:34 -060023enum 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
Joe Hershberger25980902012-12-11 22:16:31 -060031#define ENV_FLAGS_VAR ".flags"
32#define ENV_FLAGS_ATTR_MAX_LEN 2
33#define ENV_FLAGS_VARTYPE_LOC 0
Joe Hershberger267541f2012-12-11 22:16:34 -060034#define ENV_FLAGS_VARACCESS_LOC 1
Joe Hershberger25980902012-12-11 22:16:31 -060035
36#ifndef CONFIG_ENV_FLAGS_LIST_STATIC
37#define CONFIG_ENV_FLAGS_LIST_STATIC ""
38#endif
39
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060040#ifdef CONFIG_CMD_NET
Joe Hershberger73c2bbe2015-05-20 14:27:22 -050041#ifdef CONFIG_REGEX
42#define ETHADDR_WILDCARD "\\d?"
43#else
44#define ETHADDR_WILDCARD
45#endif
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060046#ifdef CONFIG_ENV_OVERWRITE
Joe Hershberger73c2bbe2015-05-20 14:27:22 -050047#define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:ma,"
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060048#else
49#ifdef CONFIG_OVERWRITE_ETHADDR_ONCE
Joe Hershberger73c2bbe2015-05-20 14:27:22 -050050#define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mc,"
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060051#else
Joe Hershberger73c2bbe2015-05-20 14:27:22 -050052#define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mo,"
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060053#endif
54#endif
Joe Hershbergerc0a93442015-05-20 14:27:24 -050055#define NET_FLAGS \
56 "ipaddr:i," \
57 "gatewayip:i," \
58 "netmask:i," \
59 "serverip:i," \
60 "nvlan:i," \
61 "vlan:i," \
62 "dnsip:i,"
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060063#else
Joe Hershbergerc0a93442015-05-20 14:27:24 -050064#define ETHADDR_FLAGS
65#define NET_FLAGS
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060066#endif
67
68#ifndef CONFIG_ENV_OVERWRITE
69#define SERIAL_FLAGS "serial#:so,"
70#else
71#define SERIAL_FLAGS ""
72#endif
73
Joe Hershberger25980902012-12-11 22:16:31 -060074#define ENV_FLAGS_LIST_STATIC \
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060075 ETHADDR_FLAGS \
Joe Hershbergerc0a93442015-05-20 14:27:24 -050076 NET_FLAGS \
Joe Hershberger1d6cd0a2012-12-11 22:16:37 -060077 SERIAL_FLAGS \
Joe Hershberger25980902012-12-11 22:16:31 -060078 CONFIG_ENV_FLAGS_LIST_STATIC
79
Joe Hershbergerfffad712012-12-11 22:16:33 -060080#ifdef CONFIG_CMD_ENV_FLAGS
81/*
82 * Print the whole list of available type flags.
83 */
84void env_flags_print_vartypes(void);
85/*
Joe Hershberger267541f2012-12-11 22:16:34 -060086 * Print the whole list of available access flags.
87 */
88void env_flags_print_varaccess(void);
89/*
Joe Hershbergerfffad712012-12-11 22:16:33 -060090 * Return the name of the type.
91 */
92const char *env_flags_get_vartype_name(enum env_flags_vartype type);
Joe Hershberger267541f2012-12-11 22:16:34 -060093/*
94 * Return the name of the access.
95 */
96const char *env_flags_get_varaccess_name(enum env_flags_varaccess access);
Joe Hershbergerfffad712012-12-11 22:16:33 -060097#endif
98
Joe Hershberger25980902012-12-11 22:16:31 -060099/*
100 * Parse the flags string from a .flags attribute list into the vartype enum.
101 */
102enum env_flags_vartype env_flags_parse_vartype(const char *flags);
Joe Hershberger267541f2012-12-11 22:16:34 -0600103/*
104 * Parse the flags string from a .flags attribute list into the varaccess enum.
105 */
106enum env_flags_varaccess env_flags_parse_varaccess(const char *flags);
107/*
108 * Parse the binary flags from a hash table entry into the varaccess enum.
109 */
110enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags);
Joe Hershberger25980902012-12-11 22:16:31 -0600111
Codrin Ciubotariu0118e832015-09-09 18:00:51 +0300112#ifdef CONFIG_CMD_NET
113/*
114 * Check if a string has the format of an Ethernet MAC address
115 */
116int eth_validate_ethaddr_str(const char *addr);
117#endif
118
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600119#ifdef USE_HOSTCC
120/*
121 * Look up the type of a variable directly from the .flags var.
122 */
123enum env_flags_vartype env_flags_get_type(const char *name);
124/*
Joe Hershberger267541f2012-12-11 22:16:34 -0600125 * Look up the access of a variable directly from the .flags var.
126 */
127enum env_flags_varaccess env_flags_get_access(const char *name);
128/*
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600129 * Validate the newval for its type to conform with the requirements defined by
130 * its flags (directly looked at the .flags var).
131 */
132int env_flags_validate_type(const char *name, const char *newval);
133/*
Joe Hershberger267541f2012-12-11 22:16:34 -0600134 * Validate the newval for its access to conform with the requirements defined
135 * by its flags (directly looked at the .flags var).
136 */
137int env_flags_validate_access(const char *name, int check_mask);
138/*
139 * Validate that the proposed access to variable "name" is valid according to
140 * the defined flags for that variable, if any.
141 */
142int env_flags_validate_varaccess(const char *name, int check_mask);
143/*
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600144 * Validate the parameters passed to "env set" for type compliance
145 */
146int env_flags_validate_env_set_params(int argc, char * const argv[]);
147
148#else /* !USE_HOSTCC */
149
Joe Hershberger25980902012-12-11 22:16:31 -0600150#include <search.h>
151
152/*
153 * When adding a variable to the environment, initialize the flags for that
154 * variable.
155 */
156void env_flags_init(ENTRY *var_entry);
157
158/*
159 * Validate the newval for to conform with the requirements defined by its flags
160 */
161int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op,
162 int flag);
163
Joe Hershberger267541f2012-12-11 22:16:34 -0600164#endif /* USE_HOSTCC */
165
Joe Hershberger25980902012-12-11 22:16:31 -0600166/*
167 * These are the binary flags used in the environment entry->flags variable to
168 * decribe properties of veriables in the table
169 */
Joe Hershberger267541f2012-12-11 22:16:34 -0600170#define ENV_FLAGS_VARTYPE_BIN_MASK 0x00000007
Joe Hershberger25980902012-12-11 22:16:31 -0600171/* The actual variable type values use the enum value (within the mask) */
Joe Hershberger267541f2012-12-11 22:16:34 -0600172#define ENV_FLAGS_VARACCESS_PREVENT_DELETE 0x00000008
173#define ENV_FLAGS_VARACCESS_PREVENT_CREATE 0x00000010
174#define ENV_FLAGS_VARACCESS_PREVENT_OVERWR 0x00000020
175#define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR 0x00000040
176#define ENV_FLAGS_VARACCESS_BIN_MASK 0x00000078
Joe Hershberger30fd4fad2012-12-11 22:16:32 -0600177
Joe Hershberger25980902012-12-11 22:16:31 -0600178#endif /* __ENV_FLAGS_H__ */