blob: f54da3b699a87882628abbecce214dc0d53567bd [file] [log] [blame]
Stephen Rothwell76c1ce72007-05-01 16:19:07 +10001#ifndef _LINUX_OF_H
2#define _LINUX_OF_H
3/*
4 * Definitions for talking to the Open Firmware PROM on
5 * Power Macintosh and other computers.
6 *
7 * Copyright (C) 1996-2005 Paul Mackerras.
8 *
9 * Updates for PPC64 by Peter Bergner & David Engebretsen, IBM Corp.
10 * Updates for SPARC64 by David S. Miller
11 * Derived from PowerPC and Sparc prom.h files by Stephen Rothwell, IBM Corp.
12 *
13 * This program is free software; you can redistribute it and/or
14 * modify it under the terms of the GNU General Public License
15 * as published by the Free Software Foundation; either version
16 * 2 of the License, or (at your option) any later version.
17 */
18#include <linux/types.h>
Jiri Slaby1977f032007-10-18 23:40:25 -070019#include <linux/bitops.h>
Kalle Valoe51130c2011-10-06 15:40:44 +030020#include <linux/errno.h>
Grant Likely75b57ec2014-02-20 18:02:11 +000021#include <linux/kobject.h>
Grant Likely283029d2008-01-09 06:20:40 +110022#include <linux/mod_devicetable.h>
Grant Likely0d351c32010-02-14 14:13:57 -070023#include <linux/spinlock.h>
Paul Mundt5ca4db62012-06-03 22:04:34 -070024#include <linux/topology.h>
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +000025#include <linux/notifier.h>
Stephen Rothwell76c1ce72007-05-01 16:19:07 +100026
Jeremy Kerr2e89e682010-01-30 01:41:49 -070027#include <asm/byteorder.h>
Paul Gortmakerd0a99402011-10-29 10:17:06 -040028#include <asm/errno.h>
Jeremy Kerr2e89e682010-01-30 01:41:49 -070029
Grant Likely731581e2009-10-15 10:57:46 -060030typedef u32 phandle;
31typedef u32 ihandle;
32
33struct property {
34 char *name;
35 int length;
36 void *value;
37 struct property *next;
38 unsigned long _flags;
39 unsigned int unique_id;
Grant Likely75b57ec2014-02-20 18:02:11 +000040 struct bin_attribute attr;
Grant Likely731581e2009-10-15 10:57:46 -060041};
42
Grant Likely6f192492009-10-15 10:57:49 -060043#if defined(CONFIG_SPARC)
44struct of_irq_controller;
45#endif
46
47struct device_node {
48 const char *name;
49 const char *type;
Grant Likely6016a362010-01-28 14:06:53 -070050 phandle phandle;
Grant Likelyc22618a2012-11-14 22:37:12 +000051 const char *full_name;
Grant Likely6f192492009-10-15 10:57:49 -060052
53 struct property *properties;
54 struct property *deadprops; /* removed properties */
55 struct device_node *parent;
56 struct device_node *child;
57 struct device_node *sibling;
58 struct device_node *next; /* next device of same type */
Grant Likely75b57ec2014-02-20 18:02:11 +000059 struct kobject kobj;
Grant Likely6f192492009-10-15 10:57:49 -060060 unsigned long _flags;
61 void *data;
62#if defined(CONFIG_SPARC)
Grant Likelyc22618a2012-11-14 22:37:12 +000063 const char *path_component_name;
Grant Likely6f192492009-10-15 10:57:49 -060064 unsigned int unique_id;
65 struct of_irq_controller *irq_trans;
66#endif
67};
68
Andreas Herrmannb66548e2014-01-17 12:08:30 +010069#define MAX_PHANDLE_ARGS 16
Grant Likely15c9a0a2011-12-12 09:25:57 -070070struct of_phandle_args {
71 struct device_node *np;
72 int args_count;
73 uint32_t args[MAX_PHANDLE_ARGS];
74};
75
Pantelis Antoniou0829f6d2013-12-13 20:08:59 +020076/* initialize a node */
77extern struct kobj_type of_node_ktype;
78static inline void of_node_init(struct device_node *node)
79{
80 kobject_init(&node->kobj, &of_node_ktype);
81}
82
83/* true when node is initialized */
84static inline int of_node_is_initialized(struct device_node *node)
85{
86 return node && node->kobj.state_initialized;
87}
88
89/* true when node is attached (i.e. present on sysfs) */
90static inline int of_node_is_attached(struct device_node *node)
91{
92 return node && node->kobj.state_in_sysfs;
93}
94
Grant Likely0f22dd32012-02-15 20:38:40 -070095#ifdef CONFIG_OF_DYNAMIC
96extern struct device_node *of_node_get(struct device_node *node);
97extern void of_node_put(struct device_node *node);
98#else /* CONFIG_OF_DYNAMIC */
Rob Herring3ecdd052011-12-13 09:13:54 -060099/* Dummy ref counting routines - to be implemented later */
100static inline struct device_node *of_node_get(struct device_node *node)
101{
102 return node;
103}
Grant Likely0f22dd32012-02-15 20:38:40 -0700104static inline void of_node_put(struct device_node *node) { }
105#endif /* !CONFIG_OF_DYNAMIC */
Rob Herring3ecdd052011-12-13 09:13:54 -0600106
Grant Likelyc9e358d2011-01-21 09:24:48 -0700107#ifdef CONFIG_OF
108
Grant Likely41f88002009-11-23 20:07:01 -0700109/* Pointer for first entry in chain of all nodes. */
Grant Likely5063e252014-10-03 16:28:27 +0100110extern struct device_node *of_root;
Grant Likelyfc0bdae2010-02-14 07:13:55 -0700111extern struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +0800112extern struct device_node *of_aliases;
Grant Likelya752ee52014-03-28 08:12:18 -0700113extern struct device_node *of_stdout;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500114extern raw_spinlock_t devtree_lock;
Grant Likely41f88002009-11-23 20:07:01 -0700115
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100116static inline bool of_have_populated_dt(void)
117{
Grant Likely5063e252014-10-03 16:28:27 +0100118 return of_root != NULL;
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100119}
120
Andres Salomon035ebef2010-07-13 09:42:26 +0000121static inline bool of_node_is_root(const struct device_node *node)
122{
123 return node && (node->parent == NULL);
124}
125
Grant Likely50436312009-10-15 10:57:58 -0600126static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
127{
128 return test_bit(flag, &n->_flags);
129}
130
Pawel Mollc6e126d2014-05-15 16:55:24 +0100131static inline int of_node_test_and_set_flag(struct device_node *n,
132 unsigned long flag)
133{
134 return test_and_set_bit(flag, &n->_flags);
135}
136
Grant Likely50436312009-10-15 10:57:58 -0600137static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
138{
139 set_bit(flag, &n->_flags);
140}
141
Pantelis Antoniou588453c2013-11-08 17:03:56 +0200142static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
143{
144 clear_bit(flag, &n->_flags);
145}
146
147static inline int of_property_check_flag(struct property *p, unsigned long flag)
148{
149 return test_bit(flag, &p->_flags);
150}
151
152static inline void of_property_set_flag(struct property *p, unsigned long flag)
153{
154 set_bit(flag, &p->_flags);
155}
156
157static inline void of_property_clear_flag(struct property *p, unsigned long flag)
158{
159 clear_bit(flag, &p->_flags);
160}
161
Grant Likely5063e252014-10-03 16:28:27 +0100162extern struct device_node *__of_find_all_nodes(struct device_node *prev);
Grant Likelye91edcf2009-10-15 10:58:09 -0600163extern struct device_node *of_find_all_nodes(struct device_node *prev);
164
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600165/*
Lennert Buytenhek3d6b8822011-02-22 18:18:51 +0100166 * OF address retrieval & translation
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600167 */
168
169/* Helper to read a big number; size is in cells (not bytes) */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700170static inline u64 of_read_number(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600171{
172 u64 r = 0;
173 while (size--)
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700174 r = (r << 32) | be32_to_cpu(*(cell++));
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600175 return r;
176}
177
178/* Like of_read_number, but we want an unsigned long result */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700179static inline unsigned long of_read_ulong(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600180{
Grant Likely2be09cb2009-11-23 20:16:46 -0700181 /* toss away upper bits if unsigned long is smaller than u64 */
182 return of_read_number(cell, size);
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600183}
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600184
Rob Herringb5b4bb32013-09-07 14:08:20 -0500185#if defined(CONFIG_SPARC)
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000186#include <asm/prom.h>
Rob Herringb5b4bb32013-09-07 14:08:20 -0500187#endif
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000188
Grant Likely7c7b60c2010-02-14 07:13:50 -0700189/* Default #address and #size cells. Allow arch asm/prom.h to override */
190#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
191#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
192#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
193#endif
194
195/* Default string compare functions, Allow arch asm/prom.h to override */
196#if !defined(of_compat_cmp)
Grant Likely19761522010-03-18 07:30:31 -0600197#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
Grant Likely7c7b60c2010-02-14 07:13:50 -0700198#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
199#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
200#endif
201
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000202/* flag descriptions */
203#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
204#define OF_DETACHED 2 /* node has been detached from the device tree */
Pawel Mollc6e126d2014-05-15 16:55:24 +0100205#define OF_POPULATED 3 /* device already created for the node */
Grant Likely75f353b2014-06-24 16:13:47 +0100206#define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000207
Grant Likely61e955d2009-10-15 10:57:51 -0600208#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
209#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
210
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000211#define OF_BAD_ADDR ((u64)-1)
212
Steffen Trumtrarc0a05bf2012-12-18 11:32:03 +0100213static inline const char *of_node_full_name(const struct device_node *np)
Grant Likely74a7f082012-06-15 11:50:25 -0600214{
215 return np ? np->full_name : "<no-node>";
216}
217
Grant Likely5063e252014-10-03 16:28:27 +0100218#define for_each_of_allnodes_from(from, dn) \
219 for (dn = __of_find_all_nodes(from); dn; dn = __of_find_all_nodes(dn))
220#define for_each_of_allnodes(dn) for_each_of_allnodes_from(NULL, dn)
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000221extern struct device_node *of_find_node_by_name(struct device_node *from,
222 const char *name);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000223extern struct device_node *of_find_node_by_type(struct device_node *from,
224 const char *type);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000225extern struct device_node *of_find_compatible_node(struct device_node *from,
226 const char *type, const char *compat);
Stephen Warren50c8af42012-11-20 16:12:20 -0700227extern struct device_node *of_find_matching_node_and_match(
228 struct device_node *from,
229 const struct of_device_id *matches,
230 const struct of_device_id **match);
Rob Herring662372e2014-02-03 08:53:44 -0600231
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000232extern struct device_node *of_find_node_by_path(const char *path);
233extern struct device_node *of_find_node_by_phandle(phandle handle);
234extern struct device_node *of_get_parent(const struct device_node *node);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000235extern struct device_node *of_get_next_parent(struct device_node *node);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000236extern struct device_node *of_get_next_child(const struct device_node *node,
237 struct device_node *prev);
Timur Tabi32961932012-08-14 13:20:23 +0000238extern struct device_node *of_get_next_available_child(
239 const struct device_node *node, struct device_node *prev);
240
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100241extern struct device_node *of_get_child_by_name(const struct device_node *node,
242 const char *name);
Bryan Wu954e04b2013-09-24 10:38:26 -0700243
Sudeep KarkadaNageshaa3e31b42013-09-18 11:53:05 +0100244/* cache lookup */
245extern struct device_node *of_find_next_cache_node(const struct device_node *);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000246extern struct device_node *of_find_node_with_property(
247 struct device_node *from, const char *prop_name);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000248
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000249extern struct property *of_find_property(const struct device_node *np,
250 const char *name,
251 int *lenp);
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100252extern int of_property_count_elems_of_size(const struct device_node *np,
253 const char *propname, int elem_size);
Tony Prisk3daf3722013-03-23 17:02:15 +1300254extern int of_property_read_u32_index(const struct device_node *np,
255 const char *propname,
256 u32 index, u32 *out_value);
Viresh Kumarbe193242012-11-20 10:15:19 +0530257extern int of_property_read_u8_array(const struct device_node *np,
258 const char *propname, u8 *out_values, size_t sz);
259extern int of_property_read_u16_array(const struct device_node *np,
260 const char *propname, u16 *out_values, size_t sz);
Rob Herring0e373632011-07-06 15:42:58 -0500261extern int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100262 const char *propname,
Rob Herring0e373632011-07-06 15:42:58 -0500263 u32 *out_values,
264 size_t sz);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100265extern int of_property_read_u64(const struct device_node *np,
266 const char *propname, u64 *out_value);
Rob Herring0e373632011-07-06 15:42:58 -0500267
Jamie Ilesaac285c2011-08-02 15:45:07 +0100268extern int of_property_read_string(struct device_node *np,
269 const char *propname,
270 const char **out_string);
Grant Likely7aff0fe2011-12-12 09:25:58 -0700271extern int of_property_match_string(struct device_node *np,
272 const char *propname,
273 const char *string);
Grant Likelya87fa1d2014-11-03 15:15:35 +0000274extern int of_property_read_string_helper(struct device_node *np,
275 const char *propname,
276 const char **out_strs, size_t sz, int index);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000277extern int of_device_is_compatible(const struct device_node *device,
278 const char *);
Josh Boyer834d97d2008-03-27 00:33:14 +1100279extern int of_device_is_available(const struct device_node *device);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000280extern const void *of_get_property(const struct device_node *node,
281 const char *name,
282 int *lenp);
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100283extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
Dong Aisheng8af0da92011-12-22 20:19:24 +0800284#define for_each_property_of_node(dn, pp) \
285 for (pp = dn->properties; pp != NULL; pp = pp->next)
Shawn Guo611cad72011-08-15 15:28:14 +0800286
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000287extern int of_n_addr_cells(struct device_node *np);
288extern int of_n_size_cells(struct device_node *np);
Grant Likely283029d2008-01-09 06:20:40 +1100289extern const struct of_device_id *of_match_node(
290 const struct of_device_id *matches, const struct device_node *node);
Grant Likely3f07af42008-07-25 22:25:13 -0400291extern int of_modalias_node(struct device_node *node, char *modalias, int len);
Grant Likely624cfca2013-10-11 22:05:10 +0100292extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
Steffen Trumtrarb8fbdc42012-11-22 12:16:43 +0100293extern struct device_node *of_parse_phandle(const struct device_node *np,
Grant Likely739649c2009-04-25 12:52:40 +0000294 const char *phandle_name,
295 int index);
Guennadi Liakhovetski93c667c2012-12-10 20:41:30 +0100296extern int of_parse_phandle_with_args(const struct device_node *np,
Anton Vorontsov64b60e02008-10-10 04:43:17 +0000297 const char *list_name, const char *cells_name, int index,
Grant Likely15c9a0a2011-12-12 09:25:57 -0700298 struct of_phandle_args *out_args);
Stephen Warren035fd942013-08-14 15:27:10 -0600299extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
300 const char *list_name, int cells_count, int index,
301 struct of_phandle_args *out_args);
Grant Likelybd69f732013-02-10 22:57:21 +0000302extern int of_count_phandle_with_args(const struct device_node *np,
303 const char *list_name, const char *cells_name);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000304
Shawn Guo611cad72011-08-15 15:28:14 +0800305extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
306extern int of_alias_get_id(struct device_node *np, const char *stem);
307
Grant Likely21b082e2010-02-14 07:13:38 -0700308extern int of_machine_is_compatible(const char *compat);
309
Nathan Fontenot79d1c712012-10-02 16:58:46 +0000310extern int of_add_property(struct device_node *np, struct property *prop);
311extern int of_remove_property(struct device_node *np, struct property *prop);
312extern int of_update_property(struct device_node *np, struct property *newprop);
Grant Likely21b082e2010-02-14 07:13:38 -0700313
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700314/* For updating the device tree at runtime */
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +0000315#define OF_RECONFIG_ATTACH_NODE 0x0001
316#define OF_RECONFIG_DETACH_NODE 0x0002
317#define OF_RECONFIG_ADD_PROPERTY 0x0003
318#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
319#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
320
321struct of_prop_reconfig {
322 struct device_node *dn;
323 struct property *prop;
Grant Likely259092a2014-07-16 12:48:23 -0600324 struct property *old_prop;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +0000325};
326
327extern int of_reconfig_notifier_register(struct notifier_block *);
328extern int of_reconfig_notifier_unregister(struct notifier_block *);
329extern int of_reconfig_notify(unsigned long, void *);
330
331extern int of_attach_node(struct device_node *);
332extern int of_detach_node(struct device_node *);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700333
Ben Dooks3a1e3622011-08-03 10:11:42 +0100334#define of_match_ptr(_ptr) (_ptr)
Stephen Warrenc541adc2012-04-04 09:27:46 -0600335
336/*
337 * struct property *prop;
338 * const __be32 *p;
339 * u32 u;
340 *
341 * of_property_for_each_u32(np, "propname", prop, p, u)
342 * printk("U32 value: %x\n", u);
343 */
344const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
345 u32 *pu);
Stephen Warrenc541adc2012-04-04 09:27:46 -0600346/*
347 * struct property *prop;
348 * const char *s;
349 *
350 * of_property_for_each_string(np, "propname", prop, s)
351 * printk("String value: %s\n", s);
352 */
353const char *of_prop_next_string(struct property *prop, const char *cur);
Stephen Warrenc541adc2012-04-04 09:27:46 -0600354
Grant Likely3482f2c2014-03-27 17:18:55 -0700355bool of_console_check(struct device_node *dn, char *name, int index);
Sascha Hauer5c19e952013-08-05 14:40:44 +0200356
Shawn Guob98c0232011-07-08 16:27:33 +0800357#else /* CONFIG_OF */
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100358
Stephen Rothwell4c358e12014-05-15 14:44:30 +1000359static inline const char* of_node_full_name(const struct device_node *np)
Grant Likely74a7f082012-06-15 11:50:25 -0600360{
361 return "<no-node>";
362}
363
Peter Ujfalusi1cc44f42012-09-10 13:46:24 +0300364static inline struct device_node *of_find_node_by_name(struct device_node *from,
365 const char *name)
366{
367 return NULL;
368}
369
Rob Herring662372e2014-02-03 08:53:44 -0600370static inline struct device_node *of_find_node_by_type(struct device_node *from,
371 const char *type)
372{
373 return NULL;
374}
375
376static inline struct device_node *of_find_matching_node_and_match(
377 struct device_node *from,
378 const struct of_device_id *matches,
379 const struct of_device_id **match)
380{
381 return NULL;
382}
383
Alexander Shiyan20cd4772014-04-16 10:49:20 +0400384static inline struct device_node *of_find_node_by_path(const char *path)
385{
386 return NULL;
387}
388
Alexander Shiyan066ec1d2013-04-09 19:47:40 +0400389static inline struct device_node *of_get_parent(const struct device_node *node)
390{
391 return NULL;
392}
393
Rob Herring662372e2014-02-03 08:53:44 -0600394static inline struct device_node *of_get_next_child(
395 const struct device_node *node, struct device_node *prev)
396{
397 return NULL;
398}
399
400static inline struct device_node *of_get_next_available_child(
401 const struct device_node *node, struct device_node *prev)
402{
403 return NULL;
404}
405
406static inline struct device_node *of_find_node_with_property(
407 struct device_node *from, const char *prop_name)
408{
409 return NULL;
410}
411
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100412static inline bool of_have_populated_dt(void)
413{
414 return false;
415}
416
Olof Johansson25c040c2012-10-07 10:40:54 -0700417static inline struct device_node *of_get_child_by_name(
418 const struct device_node *node,
419 const char *name)
420{
421 return NULL;
422}
423
Rajendra Nayak36a09042011-10-10 21:49:35 +0530424static inline int of_device_is_compatible(const struct device_node *device,
425 const char *name)
426{
427 return 0;
428}
429
Rob Herringd7195692013-03-20 16:56:18 -0500430static inline int of_device_is_available(const struct device_node *device)
431{
432 return 0;
433}
434
Stephen Warrenaba3dff2011-09-21 13:23:10 -0600435static inline struct property *of_find_property(const struct device_node *np,
436 const char *name,
437 int *lenp)
438{
439 return NULL;
440}
441
Shawn Guo2261cc62012-02-15 10:47:42 -0800442static inline struct device_node *of_find_compatible_node(
443 struct device_node *from,
444 const char *type,
445 const char *compat)
446{
447 return NULL;
448}
449
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100450static inline int of_property_count_elems_of_size(const struct device_node *np,
451 const char *propname, int elem_size)
452{
453 return -ENOSYS;
454}
455
Tony Prisk3daf3722013-03-23 17:02:15 +1300456static inline int of_property_read_u32_index(const struct device_node *np,
457 const char *propname, u32 index, u32 *out_value)
458{
459 return -ENOSYS;
460}
461
Viresh Kumarbe193242012-11-20 10:15:19 +0530462static inline int of_property_read_u8_array(const struct device_node *np,
463 const char *propname, u8 *out_values, size_t sz)
464{
465 return -ENOSYS;
466}
467
468static inline int of_property_read_u16_array(const struct device_node *np,
469 const char *propname, u16 *out_values, size_t sz)
470{
471 return -ENOSYS;
472}
473
Shawn Guob98c0232011-07-08 16:27:33 +0800474static inline int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100475 const char *propname,
476 u32 *out_values, size_t sz)
Shawn Guob98c0232011-07-08 16:27:33 +0800477{
478 return -ENOSYS;
479}
480
481static inline int of_property_read_string(struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100482 const char *propname,
483 const char **out_string)
Shawn Guob98c0232011-07-08 16:27:33 +0800484{
485 return -ENOSYS;
486}
487
Grant Likelya87fa1d2014-11-03 15:15:35 +0000488static inline int of_property_read_string_helper(struct device_node *np,
489 const char *propname,
490 const char **out_strs, size_t sz, int index)
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200491{
492 return -ENOSYS;
493}
494
Stephen Warren89272b82011-08-05 16:50:30 -0600495static inline const void *of_get_property(const struct device_node *node,
496 const char *name,
497 int *lenp)
498{
499 return NULL;
500}
501
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100502static inline struct device_node *of_get_cpu_node(int cpu,
503 unsigned int *thread)
504{
505 return NULL;
506}
507
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100508static inline int of_property_read_u64(const struct device_node *np,
509 const char *propname, u64 *out_value)
510{
511 return -ENOSYS;
512}
513
Thierry Redingbd3d5502012-04-13 16:18:34 +0200514static inline int of_property_match_string(struct device_node *np,
515 const char *propname,
516 const char *string)
517{
518 return -ENOSYS;
519}
520
Steffen Trumtrarb8fbdc42012-11-22 12:16:43 +0100521static inline struct device_node *of_parse_phandle(const struct device_node *np,
Rajendra Nayak36a09042011-10-10 21:49:35 +0530522 const char *phandle_name,
523 int index)
524{
525 return NULL;
526}
527
Thierry Redinge05e5072012-04-13 16:19:21 +0200528static inline int of_parse_phandle_with_args(struct device_node *np,
529 const char *list_name,
530 const char *cells_name,
531 int index,
532 struct of_phandle_args *out_args)
533{
534 return -ENOSYS;
535}
536
Stephen Warren035fd942013-08-14 15:27:10 -0600537static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
538 const char *list_name, int cells_count, int index,
539 struct of_phandle_args *out_args)
540{
541 return -ENOSYS;
542}
543
Grant Likelybd69f732013-02-10 22:57:21 +0000544static inline int of_count_phandle_with_args(struct device_node *np,
545 const char *list_name,
546 const char *cells_name)
547{
548 return -ENOSYS;
549}
550
Nicolas Ferreed5f8862011-10-27 11:07:28 +0200551static inline int of_alias_get_id(struct device_node *np, const char *stem)
552{
553 return -ENOSYS;
554}
555
Stephen Warren50e07f82011-10-25 14:01:26 +0200556static inline int of_machine_is_compatible(const char *compat)
557{
558 return 0;
559}
560
Grant Likely3482f2c2014-03-27 17:18:55 -0700561static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
Sascha Hauer5c19e952013-08-05 14:40:44 +0200562{
Grant Likely3482f2c2014-03-27 17:18:55 -0700563 return false;
Sascha Hauer5c19e952013-08-05 14:40:44 +0200564}
565
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200566static inline const __be32 *of_prop_next_u32(struct property *prop,
567 const __be32 *cur, u32 *pu)
568{
569 return NULL;
570}
571
572static inline const char *of_prop_next_string(struct property *prop,
573 const char *cur)
574{
575 return NULL;
576}
577
Ben Dooks3a1e3622011-08-03 10:11:42 +0100578#define of_match_ptr(_ptr) NULL
Nicolas Ferre5762c202011-10-24 11:53:32 +0200579#define of_match_node(_matches, _node) NULL
Jeremy Kerr9dfbf202010-02-14 07:13:43 -0700580#endif /* CONFIG_OF */
Shawn Guob98c0232011-07-08 16:27:33 +0800581
Rob Herring0c3f0612013-09-17 10:42:50 -0500582#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
583extern int of_node_to_nid(struct device_node *np);
584#else
585static inline int of_node_to_nid(struct device_node *device) { return 0; }
Paul Mundt5ca4db62012-06-03 22:04:34 -0700586#endif
587
Rob Herring662372e2014-02-03 08:53:44 -0600588static inline struct device_node *of_find_matching_node(
589 struct device_node *from,
590 const struct of_device_id *matches)
591{
592 return of_find_matching_node_and_match(from, matches, NULL);
593}
594
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800595/**
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100596 * of_property_count_u8_elems - Count the number of u8 elements in a property
597 *
598 * @np: device node from which the property value is to be read.
599 * @propname: name of the property to be searched.
600 *
601 * Search for a property in a device node and count the number of u8 elements
602 * in it. Returns number of elements on sucess, -EINVAL if the property does
603 * not exist or its length does not match a multiple of u8 and -ENODATA if the
604 * property does not have a value.
605 */
606static inline int of_property_count_u8_elems(const struct device_node *np,
607 const char *propname)
608{
609 return of_property_count_elems_of_size(np, propname, sizeof(u8));
610}
611
612/**
613 * of_property_count_u16_elems - Count the number of u16 elements in a property
614 *
615 * @np: device node from which the property value is to be read.
616 * @propname: name of the property to be searched.
617 *
618 * Search for a property in a device node and count the number of u16 elements
619 * in it. Returns number of elements on sucess, -EINVAL if the property does
620 * not exist or its length does not match a multiple of u16 and -ENODATA if the
621 * property does not have a value.
622 */
623static inline int of_property_count_u16_elems(const struct device_node *np,
624 const char *propname)
625{
626 return of_property_count_elems_of_size(np, propname, sizeof(u16));
627}
628
629/**
630 * of_property_count_u32_elems - Count the number of u32 elements in a property
631 *
632 * @np: device node from which the property value is to be read.
633 * @propname: name of the property to be searched.
634 *
635 * Search for a property in a device node and count the number of u32 elements
636 * in it. Returns number of elements on sucess, -EINVAL if the property does
637 * not exist or its length does not match a multiple of u32 and -ENODATA if the
638 * property does not have a value.
639 */
640static inline int of_property_count_u32_elems(const struct device_node *np,
641 const char *propname)
642{
643 return of_property_count_elems_of_size(np, propname, sizeof(u32));
644}
645
646/**
647 * of_property_count_u64_elems - Count the number of u64 elements in a property
648 *
649 * @np: device node from which the property value is to be read.
650 * @propname: name of the property to be searched.
651 *
652 * Search for a property in a device node and count the number of u64 elements
653 * in it. Returns number of elements on sucess, -EINVAL if the property does
654 * not exist or its length does not match a multiple of u64 and -ENODATA if the
655 * property does not have a value.
656 */
657static inline int of_property_count_u64_elems(const struct device_node *np,
658 const char *propname)
659{
660 return of_property_count_elems_of_size(np, propname, sizeof(u64));
661}
662
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800663/**
Grant Likelya87fa1d2014-11-03 15:15:35 +0000664 * of_property_read_string_array() - Read an array of strings from a multiple
665 * strings property.
666 * @np: device node from which the property value is to be read.
667 * @propname: name of the property to be searched.
668 * @out_strs: output array of string pointers.
669 * @sz: number of array elements to read.
670 *
671 * Search for a property in a device tree node and retrieve a list of
672 * terminated string values (pointer to data, not a copy) in that property.
673 *
674 * If @out_strs is NULL, the number of strings in the property is returned.
675 */
676static inline int of_property_read_string_array(struct device_node *np,
677 const char *propname, const char **out_strs,
678 size_t sz)
679{
680 return of_property_read_string_helper(np, propname, out_strs, sz, 0);
681}
682
683/**
684 * of_property_count_strings() - Find and return the number of strings from a
685 * multiple strings property.
686 * @np: device node from which the property value is to be read.
687 * @propname: name of the property to be searched.
688 *
689 * Search for a property in a device tree node and retrieve the number of null
690 * terminated string contain in it. Returns the number of strings on
691 * success, -EINVAL if the property does not exist, -ENODATA if property
692 * does not have a value, and -EILSEQ if the string is not null-terminated
693 * within the length of the property data.
694 */
695static inline int of_property_count_strings(struct device_node *np,
696 const char *propname)
697{
698 return of_property_read_string_helper(np, propname, NULL, 0, 0);
699}
700
701/**
702 * of_property_read_string_index() - Find and read a string from a multiple
703 * strings property.
704 * @np: device node from which the property value is to be read.
705 * @propname: name of the property to be searched.
706 * @index: index of the string in the list of strings
707 * @out_string: pointer to null terminated return string, modified only if
708 * return value is 0.
709 *
710 * Search for a property in a device tree node and retrieve a null
711 * terminated string value (pointer to data, not a copy) in the list of strings
712 * contained in that property.
713 * Returns 0 on success, -EINVAL if the property does not exist, -ENODATA if
714 * property does not have a value, and -EILSEQ if the string is not
715 * null-terminated within the length of the property data.
716 *
717 * The out_string pointer is modified only if a valid string can be decoded.
718 */
719static inline int of_property_read_string_index(struct device_node *np,
720 const char *propname,
721 int index, const char **output)
722{
723 int rc = of_property_read_string_helper(np, propname, output, 1, index);
724 return rc < 0 ? rc : 0;
725}
726
727/**
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800728 * of_property_read_bool - Findfrom a property
729 * @np: device node from which the property value is to be read.
730 * @propname: name of the property to be searched.
731 *
732 * Search for a property in a device node.
733 * Returns true if the property exist false otherwise.
734 */
735static inline bool of_property_read_bool(const struct device_node *np,
736 const char *propname)
737{
738 struct property *prop = of_find_property(np, propname, NULL);
739
740 return prop ? true : false;
741}
742
Viresh Kumarbe193242012-11-20 10:15:19 +0530743static inline int of_property_read_u8(const struct device_node *np,
744 const char *propname,
745 u8 *out_value)
746{
747 return of_property_read_u8_array(np, propname, out_value, 1);
748}
749
750static inline int of_property_read_u16(const struct device_node *np,
751 const char *propname,
752 u16 *out_value)
753{
754 return of_property_read_u16_array(np, propname, out_value, 1);
755}
756
Shawn Guob98c0232011-07-08 16:27:33 +0800757static inline int of_property_read_u32(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100758 const char *propname,
Shawn Guob98c0232011-07-08 16:27:33 +0800759 u32 *out_value)
760{
761 return of_property_read_u32_array(np, propname, out_value, 1);
762}
763
Sebastian Reichele7a00e42014-04-06 12:52:11 +0200764static inline int of_property_read_s32(const struct device_node *np,
765 const char *propname,
766 s32 *out_value)
767{
768 return of_property_read_u32(np, propname, (u32*) out_value);
769}
770
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200771#define of_property_for_each_u32(np, propname, prop, p, u) \
772 for (prop = of_find_property(np, propname, NULL), \
773 p = of_prop_next_u32(prop, NULL, &u); \
774 p; \
775 p = of_prop_next_u32(prop, p, &u))
776
777#define of_property_for_each_string(np, propname, prop, s) \
778 for (prop = of_find_property(np, propname, NULL), \
779 s = of_prop_next_string(prop, NULL); \
780 s; \
781 s = of_prop_next_string(prop, s))
782
Rob Herring662372e2014-02-03 08:53:44 -0600783#define for_each_node_by_name(dn, name) \
784 for (dn = of_find_node_by_name(NULL, name); dn; \
785 dn = of_find_node_by_name(dn, name))
786#define for_each_node_by_type(dn, type) \
787 for (dn = of_find_node_by_type(NULL, type); dn; \
788 dn = of_find_node_by_type(dn, type))
789#define for_each_compatible_node(dn, type, compatible) \
790 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
791 dn = of_find_compatible_node(dn, type, compatible))
792#define for_each_matching_node(dn, matches) \
793 for (dn = of_find_matching_node(NULL, matches); dn; \
794 dn = of_find_matching_node(dn, matches))
795#define for_each_matching_node_and_match(dn, matches, match) \
796 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
797 dn; dn = of_find_matching_node_and_match(dn, matches, match))
798
799#define for_each_child_of_node(parent, child) \
800 for (child = of_get_next_child(parent, NULL); child != NULL; \
801 child = of_get_next_child(parent, child))
802#define for_each_available_child_of_node(parent, child) \
803 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
804 child = of_get_next_available_child(parent, child))
805
806#define for_each_node_with_property(dn, prop_name) \
807 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
808 dn = of_find_node_with_property(dn, prop_name))
809
810static inline int of_get_child_count(const struct device_node *np)
811{
812 struct device_node *child;
813 int num = 0;
814
815 for_each_child_of_node(np, child)
816 num++;
817
818 return num;
819}
820
821static inline int of_get_available_child_count(const struct device_node *np)
822{
823 struct device_node *child;
824 int num = 0;
825
826 for_each_available_child_of_node(np, child)
827 num++;
828
829 return num;
830}
831
Rob Herring54196cc2014-05-08 16:09:24 -0500832#ifdef CONFIG_OF
833#define _OF_DECLARE(table, name, compat, fn, fn_type) \
834 static const struct of_device_id __of_table_##name \
835 __used __section(__##table##_of_table) \
836 = { .compatible = compat, \
837 .data = (fn == (fn_type)NULL) ? fn : fn }
838#else
839#define _OF_DECLARE(table, name, compat, fn, fn_type) \
840 static const struct of_device_id __of_table_##name \
841 __attribute__((unused)) \
842 = { .compatible = compat, \
843 .data = (fn == (fn_type)NULL) ? fn : fn }
844#endif
845
846typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
847typedef void (*of_init_fn_1)(struct device_node *);
848
849#define OF_DECLARE_1(table, name, compat, fn) \
850 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
851#define OF_DECLARE_2(table, name, compat, fn) \
852 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
853
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300854/**
855 * struct of_changeset_entry - Holds a changeset entry
856 *
857 * @node: list_head for the log list
858 * @action: notifier action
859 * @np: pointer to the device node affected
860 * @prop: pointer to the property affected
861 * @old_prop: hold a pointer to the original property
862 *
863 * Every modification of the device tree during a changeset
864 * is held in a list of of_changeset_entry structures.
865 * That way we can recover from a partial application, or we can
866 * revert the changeset
867 */
868struct of_changeset_entry {
869 struct list_head node;
870 unsigned long action;
871 struct device_node *np;
872 struct property *prop;
873 struct property *old_prop;
874};
875
876/**
877 * struct of_changeset - changeset tracker structure
878 *
879 * @entries: list_head for the changeset entries
880 *
881 * changesets are a convenient way to apply bulk changes to the
882 * live tree. In case of an error, changes are rolled-back.
883 * changesets live on after initial application, and if not
884 * destroyed after use, they can be reverted in one single call.
885 */
886struct of_changeset {
887 struct list_head entries;
888};
889
890#ifdef CONFIG_OF_DYNAMIC
891extern void of_changeset_init(struct of_changeset *ocs);
892extern void of_changeset_destroy(struct of_changeset *ocs);
893extern int of_changeset_apply(struct of_changeset *ocs);
894extern int of_changeset_revert(struct of_changeset *ocs);
895extern int of_changeset_action(struct of_changeset *ocs,
896 unsigned long action, struct device_node *np,
897 struct property *prop);
898
899static inline int of_changeset_attach_node(struct of_changeset *ocs,
900 struct device_node *np)
901{
902 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
903}
904
905static inline int of_changeset_detach_node(struct of_changeset *ocs,
906 struct device_node *np)
907{
908 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
909}
910
911static inline int of_changeset_add_property(struct of_changeset *ocs,
912 struct device_node *np, struct property *prop)
913{
914 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
915}
916
917static inline int of_changeset_remove_property(struct of_changeset *ocs,
918 struct device_node *np, struct property *prop)
919{
920 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
921}
922
923static inline int of_changeset_update_property(struct of_changeset *ocs,
924 struct device_node *np, struct property *prop)
925{
926 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
927}
928#endif
929
Pantelis Antoniou7941b272014-07-04 19:59:20 +0300930/* CONFIG_OF_RESOLVE api */
931extern int of_resolve_phandles(struct device_node *tree);
932
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000933#endif /* _LINUX_OF_H */