common/hwconfig.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * An inteface for configuring a hardware via u-boot environment.
   4  *
   5  * Copyright (c) 2009  MontaVista Software, Inc.
   6  * Copyright 2011 Freescale Semiconductor, Inc.
   7  *
   8  * Author: Anton Vorontsov <[email protected]>
   9  */
  10
  11 #ifndef HWCONFIG_TEST
  12 #include <config.h>
  13 #include <env.h>
  14 #include <exports.h>
  15 #include <hwconfig.h>
  16 #include <log.h>
  17 #include <asm/global_data.h>
  18 #include <linux/types.h>
  19 #include <linux/string.h>
  20 #else
  21 #include <stdio.h>
  22 #include <stdlib.h>
  23 #include <string.h>
  24 #include <assert.h>
  25 #define min(a, b) (((a) < (b)) ? (a) : (b))
  26 #endif /* HWCONFIG_TEST */
  27
  28 DECLARE_GLOBAL_DATA_PTR;
  29
  30 static const char *hwconfig_parse(const char *opts, size_t maxlen,
  31                                   const char *opt, char *stopchs, char eqch,
  32                                   size_t *arglen)
  33 {
  34         size_t optlen = strlen(opt);
  35         char *str;
  36         const char *start = opts;
  37         const char *end;
  38
  39 next:
  40         str = strstr(opts, opt);
  41         end = str + optlen;
  42         if (end - start > maxlen)
  43                 return NULL;
  44
  45         if (str && (str == opts || strpbrk(str - 1, stopchs) == str - 1) &&
  46                         (strpbrk(end, stopchs) == end || *end == eqch ||
  47                          *end == '\0')) {
  48                 const char *arg_end;
  49
  50                 if (!arglen)
  51                         return str;
  52
  53                 if (*end != eqch)
  54                         return NULL;
  55
  56                 arg_end = strpbrk(str, stopchs);
  57                 if (!arg_end)
  58                         *arglen = min(maxlen, strlen(str)) - optlen - 1;
  59                 else
  60                         *arglen = arg_end - end - 1;
  61
  62                 return end + 1;
  63         } else if (str) {
  64                 opts = end;
  65                 goto next;
  66         }
  67         return NULL;
  68 }
  69
  70 const char cpu_hwconfig[] __attribute__((weak)) = "";
  71 const char board_hwconfig[] __attribute__((weak)) = "";
  72
  73 static const char *__hwconfig(const char *opt, size_t *arglen,
  74                               const char *env_hwconfig)
  75 {
  76         const char *ret;
  77
  78         /* if we are passed a buffer use it, otherwise try the environment */
  79         if (!env_hwconfig) {
  80 #if CONFIG_IS_ENABLED(ENV_SUPPORT)
  81                 if (!(gd->flags & GD_FLG_ENV_READY) &&
  82                     gd->env_valid != ENV_VALID)
  83 #else
  84                 if (true)
  85 #endif
  86                 {
  87                         printf("WARNING: Calling __hwconfig without a buffer "
  88                                         "and before environment is ready\n");
  89                         return NULL;
  90                 }
  91 #if CONFIG_IS_ENABLED(ENV_SUPPORT)
  92                 env_hwconfig = env_get("hwconfig");
  93 #endif
  94         }
  95
  96         if (env_hwconfig) {
  97                 ret = hwconfig_parse(env_hwconfig, strlen(env_hwconfig),
  98                                       opt, ";", ':', arglen);
  99                 if (ret)
 100                         return ret;
 101         }
 102
 103         ret = hwconfig_parse(board_hwconfig, strlen(board_hwconfig),
 104                         opt, ";", ':', arglen);
 105         if (ret)
 106                 return ret;
 107
 108         return hwconfig_parse(cpu_hwconfig, strlen(cpu_hwconfig),
 109                         opt, ";", ':', arglen);
 110 }
 111
 112 /*
 113  * hwconfig_f - query if a particular hwconfig option is specified
 114  * @opt:        a string representing an option
 115  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 116  *
 117  * This call can be used to find out whether U-Boot should configure
 118  * a particular hardware option.
 119  *
 120  * Returns non-zero value if the hardware option can be used and thus
 121  * should be configured, 0 otherwise.
 122  *
 123  * This function also returns non-zero value if CONFIG_HWCONFIG is
 124  * undefined.
 125  *
 126  * Returning non-zero value without CONFIG_HWCONFIG has its crucial
 127  * purpose: the hwconfig() call should be a "transparent" interface,
 128  * e.g. if a board doesn't need hwconfig facility, then we assume
 129  * that the board file only calls things that are actually used, so
 130  * hwconfig() will always return true result.
 131  */
 132 int hwconfig_f(const char *opt, char *buf)
 133 {
 134         return !!__hwconfig(opt, NULL, buf);
 135 }
 136
 137 /*
 138  * hwconfig_arg_f - get hwconfig option's argument
 139  * @opt:        a string representing an option
 140  * @arglen:     a pointer to an allocated size_t variable
 141  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 142  *
 143  * Unlike hwconfig_f() function, this function returns a pointer to the
 144  * start of the hwconfig arguments, if option is not found or it has
 145  * no specified arguments, the function returns NULL pointer.
 146  *
 147  * If CONFIG_HWCONFIG is undefined, the function returns "", and
 148  * arglen is set to 0.
 149  */
 150 const char *hwconfig_arg_f(const char *opt, size_t *arglen, char *buf)
 151 {
 152         return __hwconfig(opt, arglen, buf);
 153 }
 154
 155 /*
 156  * hwconfig_arg_cmp_f - compare hwconfig option's argument
 157  * @opt:        a string representing an option
 158  * @arg:        a string for comparing an option's argument
 159  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 160  *
 161  * This call is similar to hwconfig_arg_f, but instead of returning
 162  * hwconfig argument and its length, it is comparing it to @arg.
 163  *
 164  * Returns non-zero value if @arg matches, 0 otherwise.
 165  *
 166  * If CONFIG_HWCONFIG is undefined, the function returns a non-zero
 167  * value, i.e. the argument matches.
 168  */
 169 int hwconfig_arg_cmp_f(const char *opt, const char *arg, char *buf)
 170 {
 171         const char *argstr;
 172         size_t arglen;
 173
 174         argstr = hwconfig_arg_f(opt, &arglen, buf);
 175         if (!argstr || arglen != strlen(arg))
 176                 return 0;
 177
 178         return !strncmp(argstr, arg, arglen);
 179 }
 180
 181 /*
 182  * hwconfig_sub_f - query if a particular hwconfig sub-option is specified
 183  * @opt:        a string representing an option
 184  * @subopt:     a string representing a sub-option
 185  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 186  *
 187  * This call is similar to hwconfig_f(), except that it takes additional
 188  * argument @subopt. In this example:
 189  *      "dr_usb:mode=peripheral"
 190  * "dr_usb" is an option, "mode" is a sub-option, and "peripheral" is its
 191  * argument.
 192  */
 193 int hwconfig_sub_f(const char *opt, const char *subopt, char *buf)
 194 {
 195         size_t arglen;
 196         const char *arg;
 197
 198         arg = __hwconfig(opt, &arglen, buf);
 199         if (!arg)
 200                 return 0;
 201         return !!hwconfig_parse(arg, arglen, subopt, ",;", '=', NULL);
 202 }
 203
 204 /*
 205  * hwconfig_subarg_f - get hwconfig sub-option's argument
 206  * @opt:        a string representing an option
 207  * @subopt:     a string representing a sub-option
 208  * @subarglen:  a pointer to an allocated size_t variable
 209  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 210  *
 211  * This call is similar to hwconfig_arg_f(), except that it takes an
 212  * additional argument @subopt, and so works with sub-options.
 213  */
 214 const char *hwconfig_subarg_f(const char *opt, const char *subopt,
 215                               size_t *subarglen, char *buf)
 216 {
 217         size_t arglen;
 218         const char *arg;
 219
 220         arg = __hwconfig(opt, &arglen, buf);
 221         if (!arg)
 222                 return NULL;
 223         return hwconfig_parse(arg, arglen, subopt, ",;", '=', subarglen);
 224 }
 225
 226 /*
 227  * hwconfig_arg_cmp_f - compare hwconfig sub-option's argument
 228  * @opt:        a string representing an option
 229  * @subopt:     a string representing a sub-option
 230  * @subarg:     a string for comparing an sub-option's argument
 231  * @buf:        if non-NULL use this buffer to parse, otherwise try env
 232  *
 233  * This call is similar to hwconfig_arg_cmp_f, except that it takes an
 234  * additional argument @subopt, and so works with sub-options.
 235  */
 236 int hwconfig_subarg_cmp_f(const char *opt, const char *subopt,
 237                           const char *subarg, char *buf)
 238 {
 239         const char *argstr;
 240         size_t arglen;
 241
 242         argstr = hwconfig_subarg_f(opt, subopt, &arglen, buf);
 243         if (!argstr || arglen != strlen(subarg))
 244                 return 0;
 245
 246         return !strncmp(argstr, subarg, arglen);
 247 }
 248
 249 #ifdef HWCONFIG_TEST
 250 int main()
 251 {
 252         const char *ret;
 253         size_t len;
 254
 255         env_set("hwconfig", "key1:subkey1=value1,subkey2=value2;key2:value3;;;;"
 256                            "key3;:,:=;key4", 1);
 257
 258         ret = hwconfig_arg("key1", &len);
 259         printf("%zd %.*s\n", len, (int)len, ret);
 260         assert(len == 29);
 261         assert(hwconfig_arg_cmp("key1", "subkey1=value1,subkey2=value2"));
 262         assert(!strncmp(ret, "subkey1=value1,subkey2=value2", len));
 263
 264         ret = hwconfig_subarg("key1", "subkey1", &len);
 265         printf("%zd %.*s\n", len, (int)len, ret);
 266         assert(len == 6);
 267         assert(hwconfig_subarg_cmp("key1", "subkey1", "value1"));
 268         assert(!strncmp(ret, "value1", len));
 269
 270         ret = hwconfig_subarg("key1", "subkey2", &len);
 271         printf("%zd %.*s\n", len, (int)len, ret);
 272         assert(len == 6);
 273         assert(hwconfig_subarg_cmp("key1", "subkey2", "value2"));
 274         assert(!strncmp(ret, "value2", len));
 275
 276         ret = hwconfig_arg("key2", &len);
 277         printf("%zd %.*s\n", len, (int)len, ret);
 278         assert(len == 6);
 279         assert(hwconfig_arg_cmp("key2", "value3"));
 280         assert(!strncmp(ret, "value3", len));
 281
 282         assert(hwconfig("key3"));
 283         assert(hwconfig_arg("key4", &len) == NULL);
 284         assert(hwconfig_arg("bogus", &len) == NULL);
 285
 286         unenv_set("hwconfig");
 287
 288         assert(hwconfig(NULL) == 0);
 289         assert(hwconfig("") == 0);
 290         assert(hwconfig("key3") == 0);
 291
 292         return 0;
 293 }
 294 #endif /* HWCONFIG_TEST */