blob: cac0b6348f469aa1bb0fdd13ca1a38dfe5c596bd [file] [log] [blame]
Tom Rini83d290c2018-05-06 17:58:06 -04001// SPDX-License-Identifier: GPL-2.0+
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +04002/*
3 * An inteface for configuring a hardware via u-boot environment.
4 *
5 * Copyright (c) 2009 MontaVista Software, Inc.
Kumar Galadd50af22011-01-09 11:37:00 -06006 * Copyright 2011 Freescale Semiconductor, Inc.
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +04007 *
8 * Author: Anton Vorontsov <avorontsov@ru.mvista.com>
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +04009 */
10
Anton Vorontsov3bf74a42010-06-18 15:08:27 +040011#ifndef HWCONFIG_TEST
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040012#include <config.h>
13#include <common.h>
Simon Glass9fb625c2019-08-01 09:46:51 -060014#include <env.h>
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040015#include <exports.h>
16#include <hwconfig.h>
Simon Glassf7ae49f2020-05-10 11:40:05 -060017#include <log.h>
Simon Glass401d1c42020-10-30 21:38:53 -060018#include <asm/global_data.h>
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040019#include <linux/types.h>
20#include <linux/string.h>
Anton Vorontsov3bf74a42010-06-18 15:08:27 +040021#else
22#include <stdio.h>
23#include <stdlib.h>
24#include <string.h>
25#include <assert.h>
26#define min(a, b) (((a) < (b)) ? (a) : (b))
27#endif /* HWCONFIG_TEST */
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040028
Kumar Galac4b115f2010-10-22 03:18:13 -050029DECLARE_GLOBAL_DATA_PTR;
30
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040031static const char *hwconfig_parse(const char *opts, size_t maxlen,
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +040032 const char *opt, char *stopchs, char eqch,
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040033 size_t *arglen)
34{
35 size_t optlen = strlen(opt);
36 char *str;
37 const char *start = opts;
38 const char *end;
39
40next:
41 str = strstr(opts, opt);
42 end = str + optlen;
43 if (end - start > maxlen)
44 return NULL;
45
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +040046 if (str && (str == opts || strpbrk(str - 1, stopchs) == str - 1) &&
47 (strpbrk(end, stopchs) == end || *end == eqch ||
48 *end == '\0')) {
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040049 const char *arg_end;
50
51 if (!arglen)
52 return str;
53
54 if (*end != eqch)
55 return NULL;
56
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +040057 arg_end = strpbrk(str, stopchs);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040058 if (!arg_end)
59 *arglen = min(maxlen, strlen(str)) - optlen - 1;
60 else
61 *arglen = arg_end - end - 1;
62
63 return end + 1;
64 } else if (str) {
65 opts = end;
66 goto next;
67 }
68 return NULL;
69}
70
Kumar Galab1945772010-11-30 15:01:28 -060071const char cpu_hwconfig[] __attribute__((weak)) = "";
72const char board_hwconfig[] __attribute__((weak)) = "";
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040073
Kumar Galadd50af22011-01-09 11:37:00 -060074static const char *__hwconfig(const char *opt, size_t *arglen,
75 const char *env_hwconfig)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040076{
Kumar Galadd50af22011-01-09 11:37:00 -060077 const char *ret;
Kumar Galac4b115f2010-10-22 03:18:13 -050078
Kumar Galadd50af22011-01-09 11:37:00 -060079 /* if we are passed a buffer use it, otherwise try the environment */
80 if (!env_hwconfig) {
Pali Rohára871af22022-08-07 21:06:04 +020081 if (!(gd->flags & GD_FLG_ENV_READY) && gd->env_valid != ENV_VALID) {
Kumar Galadd50af22011-01-09 11:37:00 -060082 printf("WARNING: Calling __hwconfig without a buffer "
Wolfgang Denkd1a24f02011-02-02 22:36:10 +010083 "and before environment is ready\n");
84 return NULL;
Kumar Galadd50af22011-01-09 11:37:00 -060085 }
Pali Rohárd64a8fd2022-04-03 00:24:25 +020086#if CONFIG_IS_ENABLED(ENV_SUPPORT)
Simon Glass00caae62017-08-03 12:22:12 -060087 env_hwconfig = env_get("hwconfig");
Pali Rohárd64a8fd2022-04-03 00:24:25 +020088#endif
Kumar Galac4b115f2010-10-22 03:18:13 -050089 }
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040090
Kumar Galabb141072010-11-30 15:58:27 -060091 if (env_hwconfig) {
92 ret = hwconfig_parse(env_hwconfig, strlen(env_hwconfig),
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +040093 opt, ";", ':', arglen);
Kumar Galabb141072010-11-30 15:58:27 -060094 if (ret)
95 return ret;
96 }
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +040097
Kumar Galabb141072010-11-30 15:58:27 -060098 ret = hwconfig_parse(board_hwconfig, strlen(board_hwconfig),
Kumar Galab1945772010-11-30 15:01:28 -060099 opt, ";", ':', arglen);
Kumar Galabb141072010-11-30 15:58:27 -0600100 if (ret)
101 return ret;
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400102
Kumar Galab1945772010-11-30 15:01:28 -0600103 return hwconfig_parse(cpu_hwconfig, strlen(cpu_hwconfig),
104 opt, ";", ':', arglen);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400105}
106
107/*
Kumar Galadd50af22011-01-09 11:37:00 -0600108 * hwconfig_f - query if a particular hwconfig option is specified
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400109 * @opt: a string representing an option
Kumar Galadd50af22011-01-09 11:37:00 -0600110 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400111 *
112 * This call can be used to find out whether U-Boot should configure
113 * a particular hardware option.
114 *
115 * Returns non-zero value if the hardware option can be used and thus
116 * should be configured, 0 otherwise.
117 *
118 * This function also returns non-zero value if CONFIG_HWCONFIG is
119 * undefined.
120 *
121 * Returning non-zero value without CONFIG_HWCONFIG has its crucial
122 * purpose: the hwconfig() call should be a "transparent" interface,
123 * e.g. if a board doesn't need hwconfig facility, then we assume
124 * that the board file only calls things that are actually used, so
125 * hwconfig() will always return true result.
126 */
Kumar Galadd50af22011-01-09 11:37:00 -0600127int hwconfig_f(const char *opt, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400128{
Kumar Galadd50af22011-01-09 11:37:00 -0600129 return !!__hwconfig(opt, NULL, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400130}
131
132/*
Kumar Galadd50af22011-01-09 11:37:00 -0600133 * hwconfig_arg_f - get hwconfig option's argument
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400134 * @opt: a string representing an option
135 * @arglen: a pointer to an allocated size_t variable
Kumar Galadd50af22011-01-09 11:37:00 -0600136 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400137 *
Kumar Galadd50af22011-01-09 11:37:00 -0600138 * Unlike hwconfig_f() function, this function returns a pointer to the
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400139 * start of the hwconfig arguments, if option is not found or it has
140 * no specified arguments, the function returns NULL pointer.
141 *
142 * If CONFIG_HWCONFIG is undefined, the function returns "", and
143 * arglen is set to 0.
144 */
Kumar Galadd50af22011-01-09 11:37:00 -0600145const char *hwconfig_arg_f(const char *opt, size_t *arglen, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400146{
Kumar Galadd50af22011-01-09 11:37:00 -0600147 return __hwconfig(opt, arglen, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400148}
149
150/*
Kumar Galadd50af22011-01-09 11:37:00 -0600151 * hwconfig_arg_cmp_f - compare hwconfig option's argument
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400152 * @opt: a string representing an option
153 * @arg: a string for comparing an option's argument
Kumar Galadd50af22011-01-09 11:37:00 -0600154 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400155 *
Kumar Galadd50af22011-01-09 11:37:00 -0600156 * This call is similar to hwconfig_arg_f, but instead of returning
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400157 * hwconfig argument and its length, it is comparing it to @arg.
158 *
159 * Returns non-zero value if @arg matches, 0 otherwise.
160 *
161 * If CONFIG_HWCONFIG is undefined, the function returns a non-zero
162 * value, i.e. the argument matches.
163 */
Kumar Galadd50af22011-01-09 11:37:00 -0600164int hwconfig_arg_cmp_f(const char *opt, const char *arg, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400165{
166 const char *argstr;
167 size_t arglen;
168
Kumar Galadd50af22011-01-09 11:37:00 -0600169 argstr = hwconfig_arg_f(opt, &arglen, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400170 if (!argstr || arglen != strlen(arg))
171 return 0;
172
173 return !strncmp(argstr, arg, arglen);
174}
175
176/*
Kumar Galadd50af22011-01-09 11:37:00 -0600177 * hwconfig_sub_f - query if a particular hwconfig sub-option is specified
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400178 * @opt: a string representing an option
179 * @subopt: a string representing a sub-option
Kumar Galadd50af22011-01-09 11:37:00 -0600180 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400181 *
Kumar Galadd50af22011-01-09 11:37:00 -0600182 * This call is similar to hwconfig_f(), except that it takes additional
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400183 * argument @subopt. In this example:
Wolfgang Denk0cf207e2021-09-27 17:42:39 +0200184 * "dr_usb:mode=peripheral"
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400185 * "dr_usb" is an option, "mode" is a sub-option, and "peripheral" is its
186 * argument.
187 */
Kumar Galadd50af22011-01-09 11:37:00 -0600188int hwconfig_sub_f(const char *opt, const char *subopt, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400189{
190 size_t arglen;
191 const char *arg;
192
Kumar Galadd50af22011-01-09 11:37:00 -0600193 arg = __hwconfig(opt, &arglen, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400194 if (!arg)
195 return 0;
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +0400196 return !!hwconfig_parse(arg, arglen, subopt, ",;", '=', NULL);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400197}
198
199/*
Kumar Galadd50af22011-01-09 11:37:00 -0600200 * hwconfig_subarg_f - get hwconfig sub-option's argument
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400201 * @opt: a string representing an option
202 * @subopt: a string representing a sub-option
203 * @subarglen: a pointer to an allocated size_t variable
Kumar Galadd50af22011-01-09 11:37:00 -0600204 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400205 *
Kumar Galadd50af22011-01-09 11:37:00 -0600206 * This call is similar to hwconfig_arg_f(), except that it takes an
207 * additional argument @subopt, and so works with sub-options.
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400208 */
Kumar Galadd50af22011-01-09 11:37:00 -0600209const char *hwconfig_subarg_f(const char *opt, const char *subopt,
210 size_t *subarglen, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400211{
212 size_t arglen;
213 const char *arg;
214
Kumar Galadd50af22011-01-09 11:37:00 -0600215 arg = __hwconfig(opt, &arglen, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400216 if (!arg)
217 return NULL;
Anton Vorontsov81f8d3b2010-06-18 15:08:12 +0400218 return hwconfig_parse(arg, arglen, subopt, ",;", '=', subarglen);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400219}
220
221/*
Kumar Galadd50af22011-01-09 11:37:00 -0600222 * hwconfig_arg_cmp_f - compare hwconfig sub-option's argument
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400223 * @opt: a string representing an option
224 * @subopt: a string representing a sub-option
225 * @subarg: a string for comparing an sub-option's argument
Kumar Galadd50af22011-01-09 11:37:00 -0600226 * @buf: if non-NULL use this buffer to parse, otherwise try env
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400227 *
Kumar Galadd50af22011-01-09 11:37:00 -0600228 * This call is similar to hwconfig_arg_cmp_f, except that it takes an
229 * additional argument @subopt, and so works with sub-options.
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400230 */
Kumar Galadd50af22011-01-09 11:37:00 -0600231int hwconfig_subarg_cmp_f(const char *opt, const char *subopt,
232 const char *subarg, char *buf)
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400233{
234 const char *argstr;
235 size_t arglen;
236
Kumar Galadd50af22011-01-09 11:37:00 -0600237 argstr = hwconfig_subarg_f(opt, subopt, &arglen, buf);
Anton Vorontsov93f9dcf2009-06-10 00:25:27 +0400238 if (!argstr || arglen != strlen(subarg))
239 return 0;
240
241 return !strncmp(argstr, subarg, arglen);
242}
Anton Vorontsov3bf74a42010-06-18 15:08:27 +0400243
244#ifdef HWCONFIG_TEST
245int main()
246{
247 const char *ret;
248 size_t len;
249
Simon Glass382bee52017-08-03 12:22:09 -0600250 env_set("hwconfig", "key1:subkey1=value1,subkey2=value2;key2:value3;;;;"
Anton Vorontsov3bf74a42010-06-18 15:08:27 +0400251 "key3;:,:=;key4", 1);
252
253 ret = hwconfig_arg("key1", &len);
254 printf("%zd %.*s\n", len, (int)len, ret);
255 assert(len == 29);
256 assert(hwconfig_arg_cmp("key1", "subkey1=value1,subkey2=value2"));
257 assert(!strncmp(ret, "subkey1=value1,subkey2=value2", len));
258
259 ret = hwconfig_subarg("key1", "subkey1", &len);
260 printf("%zd %.*s\n", len, (int)len, ret);
261 assert(len == 6);
262 assert(hwconfig_subarg_cmp("key1", "subkey1", "value1"));
263 assert(!strncmp(ret, "value1", len));
264
265 ret = hwconfig_subarg("key1", "subkey2", &len);
266 printf("%zd %.*s\n", len, (int)len, ret);
267 assert(len == 6);
268 assert(hwconfig_subarg_cmp("key1", "subkey2", "value2"));
269 assert(!strncmp(ret, "value2", len));
270
271 ret = hwconfig_arg("key2", &len);
272 printf("%zd %.*s\n", len, (int)len, ret);
273 assert(len == 6);
274 assert(hwconfig_arg_cmp("key2", "value3"));
275 assert(!strncmp(ret, "value3", len));
276
277 assert(hwconfig("key3"));
278 assert(hwconfig_arg("key4", &len) == NULL);
279 assert(hwconfig_arg("bogus", &len) == NULL);
280
Simon Glass382bee52017-08-03 12:22:09 -0600281 unenv_set("hwconfig");
Anton Vorontsov3bf74a42010-06-18 15:08:27 +0400282
283 assert(hwconfig(NULL) == 0);
284 assert(hwconfig("") == 0);
285 assert(hwconfig("key3") == 0);
286
287 return 0;
288}
289#endif /* HWCONFIG_TEST */