Blame view

drivers/of/property.c 28.6 KB
1df09bc66   Sakari Ailus   of: Move OF prope...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
  /*
   * drivers/of/property.c - Procedures for accessing and interpreting
   *			   Devicetree properties and graphs.
   *
   * Initially created by copying procedures from drivers/of/base.c. This
   * file contains the OF property as well as the OF graph interface
   * functions.
   *
   * Paul Mackerras	August 1996.
   * Copyright (C) 1996-2005 Paul Mackerras.
   *
   *  Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
   *    {engebret|bergner}@us.ibm.com
   *
   *  Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
   *
   *  Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
   *  Grant Likely.
   *
   *      This program is free software; you can redistribute it and/or
   *      modify it under the terms of the GNU General Public License
   *      as published by the Free Software Foundation; either version
   *      2 of the License, or (at your option) any later version.
   */
  
  #define pr_fmt(fmt)	"OF: " fmt
  
  #include <linux/of.h>
  #include <linux/of_device.h>
  #include <linux/of_graph.h>
  #include <linux/string.h>
  
  #include "of_private.h"
  
  /**
   * of_property_count_elems_of_size - Count the number of elements in a property
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @elem_size:	size of the individual element
   *
   * Search for a property in a device node and count the number of elements of
   * size elem_size in it. Returns number of elements on sucess, -EINVAL if the
   * property does not exist or its length does not match a multiple of elem_size
   * and -ENODATA if the property does not have a value.
   */
  int of_property_count_elems_of_size(const struct device_node *np,
  				const char *propname, int elem_size)
  {
  	struct property *prop = of_find_property(np, propname, NULL);
  
  	if (!prop)
  		return -EINVAL;
  	if (!prop->value)
  		return -ENODATA;
  
  	if (prop->length % elem_size != 0) {
0d638a07d   Rob Herring   of: Convert to us...
58
59
60
  		pr_err("size of %s in node %pOF is not a multiple of %d
  ",
  		       propname, np, elem_size);
1df09bc66   Sakari Ailus   of: Move OF prope...
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
  		return -EINVAL;
  	}
  
  	return prop->length / elem_size;
  }
  EXPORT_SYMBOL_GPL(of_property_count_elems_of_size);
  
  /**
   * of_find_property_value_of_size
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @min:	minimum allowed length of property value
   * @max:	maximum allowed length of property value (0 means unlimited)
   * @len:	if !=NULL, actual length is written to here
   *
   * Search for a property in a device node and valid the requested size.
   * Returns the property value on success, -EINVAL if the property does not
   *  exist, -ENODATA if property does not have a value, and -EOVERFLOW if the
   * property data is too small or too large.
   *
   */
  static void *of_find_property_value_of_size(const struct device_node *np,
  			const char *propname, u32 min, u32 max, size_t *len)
  {
  	struct property *prop = of_find_property(np, propname, NULL);
  
  	if (!prop)
  		return ERR_PTR(-EINVAL);
  	if (!prop->value)
  		return ERR_PTR(-ENODATA);
  	if (prop->length < min)
  		return ERR_PTR(-EOVERFLOW);
  	if (max && prop->length > max)
  		return ERR_PTR(-EOVERFLOW);
  
  	if (len)
  		*len = prop->length;
  
  	return prop->value;
  }
  
  /**
   * of_property_read_u32_index - Find and read a u32 from a multi-value property.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @index:	index of the u32 in the list of values
   * @out_value:	pointer to return value, modified only if no error.
   *
   * Search for a property in a device node and read nth 32-bit value from
   * it. Returns 0 on success, -EINVAL if the property does not exist,
   * -ENODATA if property does not have a value, and -EOVERFLOW if the
   * property data isn't large enough.
   *
   * The out_value is modified only if a valid u32 value can be decoded.
   */
  int of_property_read_u32_index(const struct device_node *np,
  				       const char *propname,
  				       u32 index, u32 *out_value)
  {
  	const u32 *val = of_find_property_value_of_size(np, propname,
  					((index + 1) * sizeof(*out_value)),
  					0,
  					NULL);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	*out_value = be32_to_cpup(((__be32 *)val) + index);
  	return 0;
  }
  EXPORT_SYMBOL_GPL(of_property_read_u32_index);
  
  /**
   * of_property_read_u64_index - Find and read a u64 from a multi-value property.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @index:	index of the u64 in the list of values
   * @out_value:	pointer to return value, modified only if no error.
   *
   * Search for a property in a device node and read nth 64-bit value from
   * it. Returns 0 on success, -EINVAL if the property does not exist,
   * -ENODATA if property does not have a value, and -EOVERFLOW if the
   * property data isn't large enough.
   *
   * The out_value is modified only if a valid u64 value can be decoded.
   */
  int of_property_read_u64_index(const struct device_node *np,
  				       const char *propname,
  				       u32 index, u64 *out_value)
  {
  	const u64 *val = of_find_property_value_of_size(np, propname,
  					((index + 1) * sizeof(*out_value)),
  					0, NULL);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	*out_value = be64_to_cpup(((__be64 *)val) + index);
  	return 0;
  }
  EXPORT_SYMBOL_GPL(of_property_read_u64_index);
  
  /**
   * of_property_read_variable_u8_array - Find and read an array of u8 from a
   * property, with bounds on the minimum and maximum array size.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_values:	pointer to return value, modified only if return value is 0.
   * @sz_min:	minimum number of array elements to read
   * @sz_max:	maximum number of array elements to read, if zero there is no
   *		upper limit on the number of elements in the dts entry but only
   *		sz_min will be read.
   *
   * Search for a property in a device node and read 8-bit value(s) from
   * it. Returns number of elements read on success, -EINVAL if the property
   * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
   * if the property data is smaller than sz_min or longer than sz_max.
   *
   * dts entry of array should be like:
   *	property = /bits/ 8 <0x50 0x60 0x70>;
   *
   * The out_values is modified only if a valid u8 value can be decoded.
   */
  int of_property_read_variable_u8_array(const struct device_node *np,
  					const char *propname, u8 *out_values,
  					size_t sz_min, size_t sz_max)
  {
  	size_t sz, count;
  	const u8 *val = of_find_property_value_of_size(np, propname,
  						(sz_min * sizeof(*out_values)),
  						(sz_max * sizeof(*out_values)),
  						&sz);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	if (!sz_max)
  		sz = sz_min;
  	else
  		sz /= sizeof(*out_values);
  
  	count = sz;
  	while (count--)
  		*out_values++ = *val++;
  
  	return sz;
  }
  EXPORT_SYMBOL_GPL(of_property_read_variable_u8_array);
  
  /**
   * of_property_read_variable_u16_array - Find and read an array of u16 from a
   * property, with bounds on the minimum and maximum array size.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_values:	pointer to return value, modified only if return value is 0.
   * @sz_min:	minimum number of array elements to read
   * @sz_max:	maximum number of array elements to read, if zero there is no
   *		upper limit on the number of elements in the dts entry but only
   *		sz_min will be read.
   *
   * Search for a property in a device node and read 16-bit value(s) from
   * it. Returns number of elements read on success, -EINVAL if the property
   * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
   * if the property data is smaller than sz_min or longer than sz_max.
   *
   * dts entry of array should be like:
   *	property = /bits/ 16 <0x5000 0x6000 0x7000>;
   *
   * The out_values is modified only if a valid u16 value can be decoded.
   */
  int of_property_read_variable_u16_array(const struct device_node *np,
  					const char *propname, u16 *out_values,
  					size_t sz_min, size_t sz_max)
  {
  	size_t sz, count;
  	const __be16 *val = of_find_property_value_of_size(np, propname,
  						(sz_min * sizeof(*out_values)),
  						(sz_max * sizeof(*out_values)),
  						&sz);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	if (!sz_max)
  		sz = sz_min;
  	else
  		sz /= sizeof(*out_values);
  
  	count = sz;
  	while (count--)
  		*out_values++ = be16_to_cpup(val++);
  
  	return sz;
  }
  EXPORT_SYMBOL_GPL(of_property_read_variable_u16_array);
  
  /**
   * of_property_read_variable_u32_array - Find and read an array of 32 bit
   * integers from a property, with bounds on the minimum and maximum array size.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_values:	pointer to return value, modified only if return value is 0.
   * @sz_min:	minimum number of array elements to read
   * @sz_max:	maximum number of array elements to read, if zero there is no
   *		upper limit on the number of elements in the dts entry but only
   *		sz_min will be read.
   *
   * Search for a property in a device node and read 32-bit value(s) from
   * it. Returns number of elements read on success, -EINVAL if the property
   * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
   * if the property data is smaller than sz_min or longer than sz_max.
   *
   * The out_values is modified only if a valid u32 value can be decoded.
   */
  int of_property_read_variable_u32_array(const struct device_node *np,
  			       const char *propname, u32 *out_values,
  			       size_t sz_min, size_t sz_max)
  {
  	size_t sz, count;
  	const __be32 *val = of_find_property_value_of_size(np, propname,
  						(sz_min * sizeof(*out_values)),
  						(sz_max * sizeof(*out_values)),
  						&sz);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	if (!sz_max)
  		sz = sz_min;
  	else
  		sz /= sizeof(*out_values);
  
  	count = sz;
  	while (count--)
  		*out_values++ = be32_to_cpup(val++);
  
  	return sz;
  }
  EXPORT_SYMBOL_GPL(of_property_read_variable_u32_array);
  
  /**
   * of_property_read_u64 - Find and read a 64 bit integer from a property
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_value:	pointer to return value, modified only if return value is 0.
   *
   * Search for a property in a device node and read a 64-bit value from
   * it. Returns 0 on success, -EINVAL if the property does not exist,
   * -ENODATA if property does not have a value, and -EOVERFLOW if the
   * property data isn't large enough.
   *
   * The out_value is modified only if a valid u64 value can be decoded.
   */
  int of_property_read_u64(const struct device_node *np, const char *propname,
  			 u64 *out_value)
  {
  	const __be32 *val = of_find_property_value_of_size(np, propname,
  						sizeof(*out_value),
  						0,
  						NULL);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	*out_value = of_read_number(val, 2);
  	return 0;
  }
  EXPORT_SYMBOL_GPL(of_property_read_u64);
  
  /**
   * of_property_read_variable_u64_array - Find and read an array of 64 bit
   * integers from a property, with bounds on the minimum and maximum array size.
   *
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_values:	pointer to return value, modified only if return value is 0.
   * @sz_min:	minimum number of array elements to read
   * @sz_max:	maximum number of array elements to read, if zero there is no
   *		upper limit on the number of elements in the dts entry but only
   *		sz_min will be read.
   *
   * Search for a property in a device node and read 64-bit value(s) from
   * it. Returns number of elements read on success, -EINVAL if the property
   * does not exist, -ENODATA if property does not have a value, and -EOVERFLOW
   * if the property data is smaller than sz_min or longer than sz_max.
   *
   * The out_values is modified only if a valid u64 value can be decoded.
   */
  int of_property_read_variable_u64_array(const struct device_node *np,
  			       const char *propname, u64 *out_values,
  			       size_t sz_min, size_t sz_max)
  {
  	size_t sz, count;
  	const __be32 *val = of_find_property_value_of_size(np, propname,
  						(sz_min * sizeof(*out_values)),
  						(sz_max * sizeof(*out_values)),
  						&sz);
  
  	if (IS_ERR(val))
  		return PTR_ERR(val);
  
  	if (!sz_max)
  		sz = sz_min;
  	else
  		sz /= sizeof(*out_values);
  
  	count = sz;
  	while (count--) {
  		*out_values++ = of_read_number(val, 2);
  		val += 2;
  	}
  
  	return sz;
  }
  EXPORT_SYMBOL_GPL(of_property_read_variable_u64_array);
  
  /**
   * of_property_read_string - Find and read a string from a property
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_string:	pointer to null terminated return string, modified only if
   *		return value is 0.
   *
   * Search for a property in a device tree node and retrieve a null
   * terminated string value (pointer to data, not a copy). Returns 0 on
   * success, -EINVAL if the property does not exist, -ENODATA if property
   * does not have a value, and -EILSEQ if the string is not null-terminated
   * within the length of the property data.
   *
   * The out_string pointer is modified only if a valid string can be decoded.
   */
  int of_property_read_string(const struct device_node *np, const char *propname,
  				const char **out_string)
  {
  	const struct property *prop = of_find_property(np, propname, NULL);
  	if (!prop)
  		return -EINVAL;
  	if (!prop->value)
  		return -ENODATA;
  	if (strnlen(prop->value, prop->length) >= prop->length)
  		return -EILSEQ;
  	*out_string = prop->value;
  	return 0;
  }
  EXPORT_SYMBOL_GPL(of_property_read_string);
  
  /**
   * of_property_match_string() - Find string in a list and return index
   * @np: pointer to node containing string list property
   * @propname: string list property name
   * @string: pointer to string to search for in string list
   *
   * This function searches a string list property and returns the index
   * of a specific string value.
   */
  int of_property_match_string(const struct device_node *np, const char *propname,
  			     const char *string)
  {
  	const struct property *prop = of_find_property(np, propname, NULL);
  	size_t l;
  	int i;
  	const char *p, *end;
  
  	if (!prop)
  		return -EINVAL;
  	if (!prop->value)
  		return -ENODATA;
  
  	p = prop->value;
  	end = p + prop->length;
  
  	for (i = 0; p < end; i++, p += l) {
  		l = strnlen(p, end - p) + 1;
  		if (p + l > end)
  			return -EILSEQ;
  		pr_debug("comparing %s with %s
  ", string, p);
  		if (strcmp(string, p) == 0)
  			return i; /* Found it; return index */
  	}
  	return -ENODATA;
  }
  EXPORT_SYMBOL_GPL(of_property_match_string);
  
  /**
   * of_property_read_string_helper() - Utility helper for parsing string properties
   * @np:		device node from which the property value is to be read.
   * @propname:	name of the property to be searched.
   * @out_strs:	output array of string pointers.
   * @sz:		number of array elements to read.
   * @skip:	Number of strings to skip over at beginning of list.
   *
   * Don't call this function directly. It is a utility helper for the
   * of_property_read_string*() family of functions.
   */
  int of_property_read_string_helper(const struct device_node *np,
  				   const char *propname, const char **out_strs,
  				   size_t sz, int skip)
  {
  	const struct property *prop = of_find_property(np, propname, NULL);
  	int l = 0, i = 0;
  	const char *p, *end;
  
  	if (!prop)
  		return -EINVAL;
  	if (!prop->value)
  		return -ENODATA;
  	p = prop->value;
  	end = p + prop->length;
  
  	for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
  		l = strnlen(p, end - p) + 1;
  		if (p + l > end)
  			return -EILSEQ;
  		if (out_strs && i >= skip)
  			*out_strs++ = p;
  	}
  	i -= skip;
  	return i <= 0 ? -ENODATA : i;
  }
  EXPORT_SYMBOL_GPL(of_property_read_string_helper);
  
  const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
  			       u32 *pu)
  {
  	const void *curv = cur;
  
  	if (!prop)
  		return NULL;
  
  	if (!cur) {
  		curv = prop->value;
  		goto out_val;
  	}
  
  	curv += sizeof(*cur);
  	if (curv >= prop->value + prop->length)
  		return NULL;
  
  out_val:
  	*pu = be32_to_cpup(curv);
  	return curv;
  }
  EXPORT_SYMBOL_GPL(of_prop_next_u32);
  
  const char *of_prop_next_string(struct property *prop, const char *cur)
  {
  	const void *curv = cur;
  
  	if (!prop)
  		return NULL;
  
  	if (!cur)
  		return prop->value;
  
  	curv += strlen(cur) + 1;
  	if (curv >= prop->value + prop->length)
  		return NULL;
  
  	return curv;
  }
  EXPORT_SYMBOL_GPL(of_prop_next_string);
  
  /**
   * of_graph_parse_endpoint() - parse common endpoint node properties
   * @node: pointer to endpoint device_node
   * @endpoint: pointer to the OF endpoint data structure
   *
   * The caller should hold a reference to @node.
   */
  int of_graph_parse_endpoint(const struct device_node *node,
  			    struct of_endpoint *endpoint)
  {
  	struct device_node *port_node = of_get_parent(node);
0d638a07d   Rob Herring   of: Convert to us...
541
542
543
  	WARN_ONCE(!port_node, "%s(): endpoint %pOF has no parent node
  ",
  		  __func__, node);
1df09bc66   Sakari Ailus   of: Move OF prope...
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
  
  	memset(endpoint, 0, sizeof(*endpoint));
  
  	endpoint->local_node = node;
  	/*
  	 * It doesn't matter whether the two calls below succeed.
  	 * If they don't then the default value 0 is used.
  	 */
  	of_property_read_u32(port_node, "reg", &endpoint->port);
  	of_property_read_u32(node, "reg", &endpoint->id);
  
  	of_node_put(port_node);
  
  	return 0;
  }
  EXPORT_SYMBOL(of_graph_parse_endpoint);
  
  /**
   * of_graph_get_port_by_id() - get the port matching a given id
   * @parent: pointer to the parent device node
   * @id: id of the port
   *
   * Return: A 'port' node pointer with refcount incremented. The caller
   * has to use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_port_by_id(struct device_node *parent, u32 id)
  {
  	struct device_node *node, *port;
  
  	node = of_get_child_by_name(parent, "ports");
  	if (node)
  		parent = node;
  
  	for_each_child_of_node(parent, port) {
  		u32 port_id = 0;
  
  		if (of_node_cmp(port->name, "port") != 0)
  			continue;
  		of_property_read_u32(port, "reg", &port_id);
  		if (id == port_id)
  			break;
  	}
  
  	of_node_put(node);
  
  	return port;
  }
  EXPORT_SYMBOL(of_graph_get_port_by_id);
  
  /**
   * of_graph_get_next_endpoint() - get next endpoint node
   * @parent: pointer to the parent device node
   * @prev: previous endpoint node, or NULL to get first
   *
   * Return: An 'endpoint' node pointer with refcount incremented. Refcount
   * of the passed @prev node is decremented.
   */
  struct device_node *of_graph_get_next_endpoint(const struct device_node *parent,
  					struct device_node *prev)
  {
  	struct device_node *endpoint;
  	struct device_node *port;
  
  	if (!parent)
  		return NULL;
  
  	/*
  	 * Start by locating the port node. If no previous endpoint is specified
  	 * search for the first port node, otherwise get the previous endpoint
  	 * parent port node.
  	 */
  	if (!prev) {
  		struct device_node *node;
  
  		node = of_get_child_by_name(parent, "ports");
  		if (node)
  			parent = node;
  
  		port = of_get_child_by_name(parent, "port");
  		of_node_put(node);
  
  		if (!port) {
0d638a07d   Rob Herring   of: Convert to us...
626
627
  			pr_err("graph: no port node found in %pOF
  ", parent);
1df09bc66   Sakari Ailus   of: Move OF prope...
628
629
630
631
  			return NULL;
  		}
  	} else {
  		port = of_get_parent(prev);
0d638a07d   Rob Herring   of: Convert to us...
632
633
634
  		if (WARN_ONCE(!port, "%s(): endpoint %pOF has no parent node
  ",
  			      __func__, prev))
1df09bc66   Sakari Ailus   of: Move OF prope...
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
  			return NULL;
  	}
  
  	while (1) {
  		/*
  		 * Now that we have a port node, get the next endpoint by
  		 * getting the next child. If the previous endpoint is NULL this
  		 * will return the first child.
  		 */
  		endpoint = of_get_next_child(port, prev);
  		if (endpoint) {
  			of_node_put(port);
  			return endpoint;
  		}
  
  		/* No more endpoints under this port, try the next one. */
  		prev = NULL;
  
  		do {
  			port = of_get_next_child(parent, port);
  			if (!port)
  				return NULL;
  		} while (of_node_cmp(port->name, "port"));
  	}
  }
  EXPORT_SYMBOL(of_graph_get_next_endpoint);
  
  /**
   * of_graph_get_endpoint_by_regs() - get endpoint node of specific identifiers
   * @parent: pointer to the parent device node
   * @port_reg: identifier (value of reg property) of the parent port node
   * @reg: identifier (value of reg property) of the endpoint node
   *
   * Return: An 'endpoint' node pointer which is identified by reg and at the same
   * is the child of a port node identified by port_reg. reg and port_reg are
   * ignored when they are -1.
   */
  struct device_node *of_graph_get_endpoint_by_regs(
  	const struct device_node *parent, int port_reg, int reg)
  {
  	struct of_endpoint endpoint;
  	struct device_node *node = NULL;
  
  	for_each_endpoint_of_node(parent, node) {
  		of_graph_parse_endpoint(node, &endpoint);
  		if (((port_reg == -1) || (endpoint.port == port_reg)) &&
  			((reg == -1) || (endpoint.id == reg)))
  			return node;
  	}
  
  	return NULL;
  }
  EXPORT_SYMBOL(of_graph_get_endpoint_by_regs);
  
  /**
b8ba92b10   Rob Herring   Merge branch 'top...
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
   * of_graph_get_remote_endpoint() - get remote endpoint node
   * @node: pointer to a local endpoint device_node
   *
   * Return: Remote endpoint node associated with remote endpoint node linked
   *	   to @node. Use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_remote_endpoint(const struct device_node *node)
  {
  	/* Get remote endpoint node. */
  	return of_parse_phandle(node, "remote-endpoint", 0);
  }
  EXPORT_SYMBOL(of_graph_get_remote_endpoint);
  
  /**
   * of_graph_get_port_parent() - get port's parent node
   * @node: pointer to a local endpoint device_node
   *
   * Return: device node associated with endpoint node linked
   *	   to @node. Use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_port_parent(struct device_node *node)
  {
  	unsigned int depth;
c0a480d1a   Tony Lindgren   device property: ...
713
714
715
716
717
718
719
720
  	if (!node)
  		return NULL;
  
  	/*
  	 * Preserve usecount for passed in node as of_get_next_parent()
  	 * will do of_node_put() on it.
  	 */
  	of_node_get(node);
b8ba92b10   Rob Herring   Merge branch 'top...
721
722
723
724
725
726
727
728
729
730
731
  	/* Walk 3 levels up only if there is 'ports' node. */
  	for (depth = 3; depth && node; depth--) {
  		node = of_get_next_parent(node);
  		if (depth == 2 && of_node_cmp(node->name, "ports"))
  			break;
  	}
  	return node;
  }
  EXPORT_SYMBOL(of_graph_get_port_parent);
  
  /**
1df09bc66   Sakari Ailus   of: Move OF prope...
732
733
734
735
736
737
738
739
740
   * of_graph_get_remote_port_parent() - get remote port's parent node
   * @node: pointer to a local endpoint device_node
   *
   * Return: Remote device node associated with remote endpoint node linked
   *	   to @node. Use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_remote_port_parent(
  			       const struct device_node *node)
  {
c0a480d1a   Tony Lindgren   device property: ...
741
  	struct device_node *np, *pp;
1df09bc66   Sakari Ailus   of: Move OF prope...
742
743
  
  	/* Get remote endpoint node. */
b8ba92b10   Rob Herring   Merge branch 'top...
744
  	np = of_graph_get_remote_endpoint(node);
1df09bc66   Sakari Ailus   of: Move OF prope...
745

c0a480d1a   Tony Lindgren   device property: ...
746
747
748
749
750
  	pp = of_graph_get_port_parent(np);
  
  	of_node_put(np);
  
  	return pp;
1df09bc66   Sakari Ailus   of: Move OF prope...
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
  }
  EXPORT_SYMBOL(of_graph_get_remote_port_parent);
  
  /**
   * of_graph_get_remote_port() - get remote port node
   * @node: pointer to a local endpoint device_node
   *
   * Return: Remote port node associated with remote endpoint node linked
   *	   to @node. Use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_remote_port(const struct device_node *node)
  {
  	struct device_node *np;
  
  	/* Get remote endpoint node. */
b8ba92b10   Rob Herring   Merge branch 'top...
766
  	np = of_graph_get_remote_endpoint(node);
1df09bc66   Sakari Ailus   of: Move OF prope...
767
768
769
770
771
  	if (!np)
  		return NULL;
  	return of_get_next_parent(np);
  }
  EXPORT_SYMBOL(of_graph_get_remote_port);
b8ba92b10   Rob Herring   Merge branch 'top...
772
773
774
775
776
777
778
779
780
781
782
  int of_graph_get_endpoint_count(const struct device_node *np)
  {
  	struct device_node *endpoint;
  	int num = 0;
  
  	for_each_endpoint_of_node(np, endpoint)
  		num++;
  
  	return num;
  }
  EXPORT_SYMBOL(of_graph_get_endpoint_count);
1df09bc66   Sakari Ailus   of: Move OF prope...
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
  /**
   * of_graph_get_remote_node() - get remote parent device_node for given port/endpoint
   * @node: pointer to parent device_node containing graph port/endpoint
   * @port: identifier (value of reg property) of the parent port node
   * @endpoint: identifier (value of reg property) of the endpoint node
   *
   * Return: Remote device node associated with remote endpoint node linked
   *	   to @node. Use of_node_put() on it when done.
   */
  struct device_node *of_graph_get_remote_node(const struct device_node *node,
  					     u32 port, u32 endpoint)
  {
  	struct device_node *endpoint_node, *remote;
  
  	endpoint_node = of_graph_get_endpoint_by_regs(node, port, endpoint);
  	if (!endpoint_node) {
0d638a07d   Rob Herring   of: Convert to us...
799
800
801
  		pr_debug("no valid endpoint (%d, %d) for node %pOF
  ",
  			 port, endpoint, node);
1df09bc66   Sakari Ailus   of: Move OF prope...
802
803
804
805
806
807
808
809
810
811
812
813
814
815
  		return NULL;
  	}
  
  	remote = of_graph_get_remote_port_parent(endpoint_node);
  	of_node_put(endpoint_node);
  	if (!remote) {
  		pr_debug("no valid remote node
  ");
  		return NULL;
  	}
  
  	if (!of_device_is_available(remote)) {
  		pr_debug("not available for remote node
  ");
a7c0d6db3   Julia Lawall   OF: properties: a...
816
  		of_node_put(remote);
1df09bc66   Sakari Ailus   of: Move OF prope...
817
818
819
820
821
822
  		return NULL;
  	}
  
  	return remote;
  }
  EXPORT_SYMBOL(of_graph_get_remote_node);
3708184af   Sakari Ailus   device property: ...
823
824
825
826
827
828
829
830
831
832
  
  static void of_fwnode_get(struct fwnode_handle *fwnode)
  {
  	of_node_get(to_of_node(fwnode));
  }
  
  static void of_fwnode_put(struct fwnode_handle *fwnode)
  {
  	of_node_put(to_of_node(fwnode));
  }
37ba983cf   Sakari Ailus   device property: ...
833
  static bool of_fwnode_device_is_available(const struct fwnode_handle *fwnode)
2294b3af0   Sakari Ailus   device property: ...
834
835
836
  {
  	return of_device_is_available(to_of_node(fwnode));
  }
37ba983cf   Sakari Ailus   device property: ...
837
  static bool of_fwnode_property_present(const struct fwnode_handle *fwnode,
3708184af   Sakari Ailus   device property: ...
838
839
840
841
  				       const char *propname)
  {
  	return of_property_read_bool(to_of_node(fwnode), propname);
  }
37ba983cf   Sakari Ailus   device property: ...
842
  static int of_fwnode_property_read_int_array(const struct fwnode_handle *fwnode,
3708184af   Sakari Ailus   device property: ...
843
844
845
846
  					     const char *propname,
  					     unsigned int elem_size, void *val,
  					     size_t nval)
  {
37ba983cf   Sakari Ailus   device property: ...
847
  	const struct device_node *node = to_of_node(fwnode);
3708184af   Sakari Ailus   device property: ...
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
  
  	if (!val)
  		return of_property_count_elems_of_size(node, propname,
  						       elem_size);
  
  	switch (elem_size) {
  	case sizeof(u8):
  		return of_property_read_u8_array(node, propname, val, nval);
  	case sizeof(u16):
  		return of_property_read_u16_array(node, propname, val, nval);
  	case sizeof(u32):
  		return of_property_read_u32_array(node, propname, val, nval);
  	case sizeof(u64):
  		return of_property_read_u64_array(node, propname, val, nval);
  	}
  
  	return -ENXIO;
  }
37ba983cf   Sakari Ailus   device property: ...
866
867
868
869
  static int
  of_fwnode_property_read_string_array(const struct fwnode_handle *fwnode,
  				     const char *propname, const char **val,
  				     size_t nval)
3708184af   Sakari Ailus   device property: ...
870
  {
37ba983cf   Sakari Ailus   device property: ...
871
  	const struct device_node *node = to_of_node(fwnode);
3708184af   Sakari Ailus   device property: ...
872
873
874
875
876
  
  	return val ?
  		of_property_read_string_array(node, propname, val, nval) :
  		of_property_count_strings(node, propname);
  }
37ba983cf   Sakari Ailus   device property: ...
877
878
  static struct fwnode_handle *
  of_fwnode_get_parent(const struct fwnode_handle *fwnode)
3708184af   Sakari Ailus   device property: ...
879
880
881
882
883
  {
  	return of_fwnode_handle(of_get_parent(to_of_node(fwnode)));
  }
  
  static struct fwnode_handle *
37ba983cf   Sakari Ailus   device property: ...
884
  of_fwnode_get_next_child_node(const struct fwnode_handle *fwnode,
3708184af   Sakari Ailus   device property: ...
885
886
887
888
889
890
891
  			      struct fwnode_handle *child)
  {
  	return of_fwnode_handle(of_get_next_available_child(to_of_node(fwnode),
  							    to_of_node(child)));
  }
  
  static struct fwnode_handle *
37ba983cf   Sakari Ailus   device property: ...
892
  of_fwnode_get_named_child_node(const struct fwnode_handle *fwnode,
3708184af   Sakari Ailus   device property: ...
893
894
  			       const char *childname)
  {
37ba983cf   Sakari Ailus   device property: ...
895
  	const struct device_node *node = to_of_node(fwnode);
3708184af   Sakari Ailus   device property: ...
896
897
898
899
900
901
902
903
  	struct device_node *child;
  
  	for_each_available_child_of_node(node, child)
  		if (!of_node_cmp(child->name, childname))
  			return of_fwnode_handle(child);
  
  	return NULL;
  }
3e3119d30   Sakari Ailus   device property: ...
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
  static int
  of_fwnode_get_reference_args(const struct fwnode_handle *fwnode,
  			     const char *prop, const char *nargs_prop,
  			     unsigned int nargs, unsigned int index,
  			     struct fwnode_reference_args *args)
  {
  	struct of_phandle_args of_args;
  	unsigned int i;
  	int ret;
  
  	if (nargs_prop)
  		ret = of_parse_phandle_with_args(to_of_node(fwnode), prop,
  						 nargs_prop, index, &of_args);
  	else
  		ret = of_parse_phandle_with_fixed_args(to_of_node(fwnode), prop,
  						       nargs, index, &of_args);
  	if (ret < 0)
  		return ret;
  	if (!args)
  		return 0;
  
  	args->nargs = of_args.args_count;
  	args->fwnode = of_fwnode_handle(of_args.np);
  
  	for (i = 0; i < NR_FWNODE_REFERENCE_ARGS; i++)
  		args->args[i] = i < of_args.args_count ? of_args.args[i] : 0;
  
  	return 0;
  }
3b27d00e7   Sakari Ailus   device property: ...
933
  static struct fwnode_handle *
37ba983cf   Sakari Ailus   device property: ...
934
  of_fwnode_graph_get_next_endpoint(const struct fwnode_handle *fwnode,
3b27d00e7   Sakari Ailus   device property: ...
935
936
937
938
939
940
941
  				  struct fwnode_handle *prev)
  {
  	return of_fwnode_handle(of_graph_get_next_endpoint(to_of_node(fwnode),
  							   to_of_node(prev)));
  }
  
  static struct fwnode_handle *
37ba983cf   Sakari Ailus   device property: ...
942
  of_fwnode_graph_get_remote_endpoint(const struct fwnode_handle *fwnode)
3b27d00e7   Sakari Ailus   device property: ...
943
  {
358155ede   Kuninori Morimoto   device property: ...
944
945
  	return of_fwnode_handle(
  		of_graph_get_remote_endpoint(to_of_node(fwnode)));
3b27d00e7   Sakari Ailus   device property: ...
946
947
948
949
950
951
952
953
  }
  
  static struct fwnode_handle *
  of_fwnode_graph_get_port_parent(struct fwnode_handle *fwnode)
  {
  	struct device_node *np;
  
  	/* Get the parent of the port */
3314c6bdd   Niklas Söderlund   device property: ...
954
  	np = of_get_parent(to_of_node(fwnode));
3b27d00e7   Sakari Ailus   device property: ...
955
956
957
958
959
960
961
962
963
  	if (!np)
  		return NULL;
  
  	/* Is this the "ports" node? If not, it's the port parent. */
  	if (of_node_cmp(np->name, "ports"))
  		return of_fwnode_handle(np);
  
  	return of_fwnode_handle(of_get_next_parent(np));
  }
37ba983cf   Sakari Ailus   device property: ...
964
  static int of_fwnode_graph_parse_endpoint(const struct fwnode_handle *fwnode,
3b27d00e7   Sakari Ailus   device property: ...
965
966
  					  struct fwnode_endpoint *endpoint)
  {
37ba983cf   Sakari Ailus   device property: ...
967
  	const struct device_node *node = to_of_node(fwnode);
3b27d00e7   Sakari Ailus   device property: ...
968
969
970
971
972
973
974
975
976
977
978
  	struct device_node *port_node = of_get_parent(node);
  
  	endpoint->local_fwnode = fwnode;
  
  	of_property_read_u32(port_node, "reg", &endpoint->port);
  	of_property_read_u32(node, "reg", &endpoint->id);
  
  	of_node_put(port_node);
  
  	return 0;
  }
3708184af   Sakari Ailus   device property: ...
979
980
981
  const struct fwnode_operations of_fwnode_ops = {
  	.get = of_fwnode_get,
  	.put = of_fwnode_put,
2294b3af0   Sakari Ailus   device property: ...
982
  	.device_is_available = of_fwnode_device_is_available,
3708184af   Sakari Ailus   device property: ...
983
984
985
986
987
988
  	.property_present = of_fwnode_property_present,
  	.property_read_int_array = of_fwnode_property_read_int_array,
  	.property_read_string_array = of_fwnode_property_read_string_array,
  	.get_parent = of_fwnode_get_parent,
  	.get_next_child_node = of_fwnode_get_next_child_node,
  	.get_named_child_node = of_fwnode_get_named_child_node,
3e3119d30   Sakari Ailus   device property: ...
989
  	.get_reference_args = of_fwnode_get_reference_args,
3b27d00e7   Sakari Ailus   device property: ...
990
991
992
993
  	.graph_get_next_endpoint = of_fwnode_graph_get_next_endpoint,
  	.graph_get_remote_endpoint = of_fwnode_graph_get_remote_endpoint,
  	.graph_get_port_parent = of_fwnode_graph_get_port_parent,
  	.graph_parse_endpoint = of_fwnode_graph_parse_endpoint,
3708184af   Sakari Ailus   device property: ...
994
  };
db3e50f32   Sakari Ailus   device property: ...
995
  EXPORT_SYMBOL_GPL(of_fwnode_ops);