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_REGEX 42 #define ETHADDR_WILDCARD "\\d?" 43 #else 44 #define ETHADDR_WILDCARD 45 #endif 46 #ifdef CONFIG_ENV_OVERWRITE 47 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:ma," 48 #else 49 #ifdef CONFIG_OVERWRITE_ETHADDR_ONCE 50 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mc," 51 #else 52 #define ETHADDR_FLAGS "eth" ETHADDR_WILDCARD "addr:mo," 53 #endif 54 #endif 55 #else 56 #define ETHADDR_FLAGS "" 57 #endif 58 59 #ifndef CONFIG_ENV_OVERWRITE 60 #define SERIAL_FLAGS "serial#:so," 61 #else 62 #define SERIAL_FLAGS "" 63 #endif 64 65 #define ENV_FLAGS_LIST_STATIC \ 66 ETHADDR_FLAGS \ 67 SERIAL_FLAGS \ 68 CONFIG_ENV_FLAGS_LIST_STATIC 69 70 #ifdef CONFIG_CMD_ENV_FLAGS 71 /* 72 * Print the whole list of available type flags. 73 */ 74 void env_flags_print_vartypes(void); 75 /* 76 * Print the whole list of available access flags. 77 */ 78 void env_flags_print_varaccess(void); 79 /* 80 * Return the name of the type. 81 */ 82 const char *env_flags_get_vartype_name(enum env_flags_vartype type); 83 /* 84 * Return the name of the access. 85 */ 86 const char *env_flags_get_varaccess_name(enum env_flags_varaccess access); 87 #endif 88 89 /* 90 * Parse the flags string from a .flags attribute list into the vartype enum. 91 */ 92 enum env_flags_vartype env_flags_parse_vartype(const char *flags); 93 /* 94 * Parse the flags string from a .flags attribute list into the varaccess enum. 95 */ 96 enum env_flags_varaccess env_flags_parse_varaccess(const char *flags); 97 /* 98 * Parse the binary flags from a hash table entry into the varaccess enum. 99 */ 100 enum env_flags_varaccess env_flags_parse_varaccess_from_binflags(int binflags); 101 102 #ifdef USE_HOSTCC 103 /* 104 * Look up the type of a variable directly from the .flags var. 105 */ 106 enum env_flags_vartype env_flags_get_type(const char *name); 107 /* 108 * Look up the access of a variable directly from the .flags var. 109 */ 110 enum env_flags_varaccess env_flags_get_access(const char *name); 111 /* 112 * Validate the newval for its type to conform with the requirements defined by 113 * its flags (directly looked at the .flags var). 114 */ 115 int env_flags_validate_type(const char *name, const char *newval); 116 /* 117 * Validate the newval for its access to conform with the requirements defined 118 * by its flags (directly looked at the .flags var). 119 */ 120 int env_flags_validate_access(const char *name, int check_mask); 121 /* 122 * Validate that the proposed access to variable "name" is valid according to 123 * the defined flags for that variable, if any. 124 */ 125 int env_flags_validate_varaccess(const char *name, int check_mask); 126 /* 127 * Validate the parameters passed to "env set" for type compliance 128 */ 129 int env_flags_validate_env_set_params(int argc, char * const argv[]); 130 131 #else /* !USE_HOSTCC */ 132 133 #include <search.h> 134 135 /* 136 * When adding a variable to the environment, initialize the flags for that 137 * variable. 138 */ 139 void env_flags_init(ENTRY *var_entry); 140 141 /* 142 * Validate the newval for to conform with the requirements defined by its flags 143 */ 144 int env_flags_validate(const ENTRY *item, const char *newval, enum env_op op, 145 int flag); 146 147 #endif /* USE_HOSTCC */ 148 149 /* 150 * These are the binary flags used in the environment entry->flags variable to 151 * decribe properties of veriables in the table 152 */ 153 #define ENV_FLAGS_VARTYPE_BIN_MASK 0x00000007 154 /* The actual variable type values use the enum value (within the mask) */ 155 #define ENV_FLAGS_VARACCESS_PREVENT_DELETE 0x00000008 156 #define ENV_FLAGS_VARACCESS_PREVENT_CREATE 0x00000010 157 #define ENV_FLAGS_VARACCESS_PREVENT_OVERWR 0x00000020 158 #define ENV_FLAGS_VARACCESS_PREVENT_NONDEF_OVERWR 0x00000040 159 #define ENV_FLAGS_VARACCESS_BIN_MASK 0x00000078 160 161 #endif /* __ENV_FLAGS_H__ */ 162