blob: 27b3ba1e9e59b3dc5cbeb126a3eb641f78c81641 [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 */
59 struct device_node *allnext; /* next in list of all nodes */
Grant Likely75b57ec2014-02-20 18:02:11 +000060 struct kobject kobj;
Grant Likely6f192492009-10-15 10:57:49 -060061 unsigned long _flags;
62 void *data;
63#if defined(CONFIG_SPARC)
Grant Likelyc22618a2012-11-14 22:37:12 +000064 const char *path_component_name;
Grant Likely6f192492009-10-15 10:57:49 -060065 unsigned int unique_id;
66 struct of_irq_controller *irq_trans;
67#endif
68};
69
Andreas Herrmannb66548e22014-01-17 12:08:30 +010070#define MAX_PHANDLE_ARGS 16
Grant Likely15c9a0a2011-12-12 09:25:57 -070071struct of_phandle_args {
72 struct device_node *np;
73 int args_count;
74 uint32_t args[MAX_PHANDLE_ARGS];
75};
76
Pantelis Antoniou0829f6d2013-12-13 20:08:59 +020077/* initialize a node */
78extern struct kobj_type of_node_ktype;
79static inline void of_node_init(struct device_node *node)
80{
81 kobject_init(&node->kobj, &of_node_ktype);
82}
83
84/* true when node is initialized */
85static inline int of_node_is_initialized(struct device_node *node)
86{
87 return node && node->kobj.state_initialized;
88}
89
90/* true when node is attached (i.e. present on sysfs) */
91static inline int of_node_is_attached(struct device_node *node)
92{
93 return node && node->kobj.state_in_sysfs;
94}
95
Grant Likely0f22dd32012-02-15 20:38:40 -070096#ifdef CONFIG_OF_DYNAMIC
97extern struct device_node *of_node_get(struct device_node *node);
98extern void of_node_put(struct device_node *node);
99#else /* CONFIG_OF_DYNAMIC */
Rob Herring3ecdd052011-12-13 09:13:54 -0600100/* Dummy ref counting routines - to be implemented later */
101static inline struct device_node *of_node_get(struct device_node *node)
102{
103 return node;
104}
Grant Likely0f22dd32012-02-15 20:38:40 -0700105static inline void of_node_put(struct device_node *node) { }
106#endif /* !CONFIG_OF_DYNAMIC */
Rob Herring3ecdd052011-12-13 09:13:54 -0600107
Grant Likelyc9e358d2011-01-21 09:24:48 -0700108#ifdef CONFIG_OF
109
Grant Likely41f88002009-11-23 20:07:01 -0700110/* Pointer for first entry in chain of all nodes. */
Randy Dunlap465aac62012-11-30 10:01:51 +0000111extern struct device_node *of_allnodes;
Grant Likelyfc0bdae2010-02-14 07:13:55 -0700112extern struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +0800113extern struct device_node *of_aliases;
Grant Likelya752ee52014-03-28 08:12:18 -0700114extern struct device_node *of_stdout;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500115extern raw_spinlock_t devtree_lock;
Grant Likely41f88002009-11-23 20:07:01 -0700116
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100117static inline bool of_have_populated_dt(void)
118{
Randy Dunlap465aac62012-11-30 10:01:51 +0000119 return of_allnodes != NULL;
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100120}
121
Andres Salomon035ebef2010-07-13 09:42:26 +0000122static inline bool of_node_is_root(const struct device_node *node)
123{
124 return node && (node->parent == NULL);
125}
126
Grant Likely50436312009-10-15 10:57:58 -0600127static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
128{
129 return test_bit(flag, &n->_flags);
130}
131
Pawel Mollc6e126d2014-05-15 16:55:24 +0100132static inline int of_node_test_and_set_flag(struct device_node *n,
133 unsigned long flag)
134{
135 return test_and_set_bit(flag, &n->_flags);
136}
137
Grant Likely50436312009-10-15 10:57:58 -0600138static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
139{
140 set_bit(flag, &n->_flags);
141}
142
Pantelis Antoniou588453c2013-11-08 17:03:56 +0200143static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
144{
145 clear_bit(flag, &n->_flags);
146}
147
148static inline int of_property_check_flag(struct property *p, unsigned long flag)
149{
150 return test_bit(flag, &p->_flags);
151}
152
153static inline void of_property_set_flag(struct property *p, unsigned long flag)
154{
155 set_bit(flag, &p->_flags);
156}
157
158static inline void of_property_clear_flag(struct property *p, unsigned long flag)
159{
160 clear_bit(flag, &p->_flags);
161}
162
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 Likely75b57ec2014-02-20 18:02:11 +0000218#define for_each_of_allnodes(dn) \
219 for (dn = of_allnodes; dn; dn = dn->allnext)
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000220extern struct device_node *of_find_node_by_name(struct device_node *from,
221 const char *name);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000222extern struct device_node *of_find_node_by_type(struct device_node *from,
223 const char *type);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000224extern struct device_node *of_find_compatible_node(struct device_node *from,
225 const char *type, const char *compat);
Stephen Warren50c8af42012-11-20 16:12:20 -0700226extern struct device_node *of_find_matching_node_and_match(
227 struct device_node *from,
228 const struct of_device_id *matches,
229 const struct of_device_id **match);
Rob Herring662372e2014-02-03 08:53:44 -0600230
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000231extern struct device_node *of_find_node_by_path(const char *path);
232extern struct device_node *of_find_node_by_phandle(phandle handle);
233extern struct device_node *of_get_parent(const struct device_node *node);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000234extern struct device_node *of_get_next_parent(struct device_node *node);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000235extern struct device_node *of_get_next_child(const struct device_node *node,
236 struct device_node *prev);
Timur Tabi32961932012-08-14 13:20:23 +0000237extern struct device_node *of_get_next_available_child(
238 const struct device_node *node, struct device_node *prev);
239
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100240extern struct device_node *of_get_child_by_name(const struct device_node *node,
241 const char *name);
Bryan Wu954e04b2013-09-24 10:38:26 -0700242
Sudeep KarkadaNageshaa3e31b42013-09-18 11:53:05 +0100243/* cache lookup */
244extern struct device_node *of_find_next_cache_node(const struct device_node *);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000245extern struct device_node *of_find_node_with_property(
246 struct device_node *from, const char *prop_name);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000247
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000248extern struct property *of_find_property(const struct device_node *np,
249 const char *name,
250 int *lenp);
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100251extern int of_property_count_elems_of_size(const struct device_node *np,
252 const char *propname, int elem_size);
Tony Prisk3daf3722013-03-23 17:02:15 +1300253extern int of_property_read_u32_index(const struct device_node *np,
254 const char *propname,
255 u32 index, u32 *out_value);
Viresh Kumarbe193242012-11-20 10:15:19 +0530256extern int of_property_read_u8_array(const struct device_node *np,
257 const char *propname, u8 *out_values, size_t sz);
258extern int of_property_read_u16_array(const struct device_node *np,
259 const char *propname, u16 *out_values, size_t sz);
Rob Herring0e373632011-07-06 15:42:58 -0500260extern int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100261 const char *propname,
Rob Herring0e373632011-07-06 15:42:58 -0500262 u32 *out_values,
263 size_t sz);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100264extern int of_property_read_u64(const struct device_node *np,
265 const char *propname, u64 *out_value);
Rob Herring0e373632011-07-06 15:42:58 -0500266
Jamie Ilesaac285c2011-08-02 15:45:07 +0100267extern int of_property_read_string(struct device_node *np,
268 const char *propname,
269 const char **out_string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200270extern int of_property_read_string_index(struct device_node *np,
271 const char *propname,
272 int index, const char **output);
Grant Likely7aff0fe2011-12-12 09:25:58 -0700273extern int of_property_match_string(struct device_node *np,
274 const char *propname,
275 const char *string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200276extern int of_property_count_strings(struct device_node *np,
277 const char *propname);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000278extern int of_device_is_compatible(const struct device_node *device,
279 const char *);
Josh Boyer834d97d2008-03-27 00:33:14 +1100280extern int of_device_is_available(const struct device_node *device);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000281extern const void *of_get_property(const struct device_node *node,
282 const char *name,
283 int *lenp);
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100284extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
Dong Aisheng8af0da92011-12-22 20:19:24 +0800285#define for_each_property_of_node(dn, pp) \
286 for (pp = dn->properties; pp != NULL; pp = pp->next)
Shawn Guo611cad72011-08-15 15:28:14 +0800287
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000288extern int of_n_addr_cells(struct device_node *np);
289extern int of_n_size_cells(struct device_node *np);
Grant Likely283029d2008-01-09 06:20:40 +1100290extern const struct of_device_id *of_match_node(
291 const struct of_device_id *matches, const struct device_node *node);
Grant Likely3f07af42008-07-25 22:25:13 -0400292extern int of_modalias_node(struct device_node *node, char *modalias, int len);
Grant Likely624cfca2013-10-11 22:05:10 +0100293extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
Steffen Trumtrarb8fbdc42012-11-22 12:16:43 +0100294extern struct device_node *of_parse_phandle(const struct device_node *np,
Grant Likely739649c2009-04-25 12:52:40 +0000295 const char *phandle_name,
296 int index);
Guennadi Liakhovetski93c667c2012-12-10 20:41:30 +0100297extern int of_parse_phandle_with_args(const struct device_node *np,
Anton Vorontsov64b60e02008-10-10 04:43:17 +0000298 const char *list_name, const char *cells_name, int index,
Grant Likely15c9a0a2011-12-12 09:25:57 -0700299 struct of_phandle_args *out_args);
Stephen Warren035fd942013-08-14 15:27:10 -0600300extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
301 const char *list_name, int cells_count, int index,
302 struct of_phandle_args *out_args);
Grant Likelybd69f732013-02-10 22:57:21 +0000303extern int of_count_phandle_with_args(const struct device_node *np,
304 const char *list_name, const char *cells_name);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000305
Shawn Guo611cad72011-08-15 15:28:14 +0800306extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
307extern int of_alias_get_id(struct device_node *np, const char *stem);
308
Grant Likely21b082e2010-02-14 07:13:38 -0700309extern int of_machine_is_compatible(const char *compat);
310
Nathan Fontenot79d1c712012-10-02 16:58:46 +0000311extern int of_add_property(struct device_node *np, struct property *prop);
312extern int of_remove_property(struct device_node *np, struct property *prop);
313extern int of_update_property(struct device_node *np, struct property *newprop);
Grant Likely21b082e2010-02-14 07:13:38 -0700314
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700315/* For updating the device tree at runtime */
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +0000316#define OF_RECONFIG_ATTACH_NODE 0x0001
317#define OF_RECONFIG_DETACH_NODE 0x0002
318#define OF_RECONFIG_ADD_PROPERTY 0x0003
319#define OF_RECONFIG_REMOVE_PROPERTY 0x0004
320#define OF_RECONFIG_UPDATE_PROPERTY 0x0005
321
322struct of_prop_reconfig {
323 struct device_node *dn;
324 struct property *prop;
Grant Likely259092a2014-07-16 12:48:23 -0600325 struct property *old_prop;
Nathan Fontenot1cf3d8b2012-10-02 16:57:57 +0000326};
327
328extern int of_reconfig_notifier_register(struct notifier_block *);
329extern int of_reconfig_notifier_unregister(struct notifier_block *);
330extern int of_reconfig_notify(unsigned long, void *);
331
332extern int of_attach_node(struct device_node *);
333extern int of_detach_node(struct device_node *);
Grant Likelyfcdeb7f2010-01-29 05:04:33 -0700334
Ben Dooks3a1e3622011-08-03 10:11:42 +0100335#define of_match_ptr(_ptr) (_ptr)
Stephen Warrenc541adc2012-04-04 09:27:46 -0600336
337/*
338 * struct property *prop;
339 * const __be32 *p;
340 * u32 u;
341 *
342 * of_property_for_each_u32(np, "propname", prop, p, u)
343 * printk("U32 value: %x\n", u);
344 */
345const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
346 u32 *pu);
Stephen Warrenc541adc2012-04-04 09:27:46 -0600347/*
348 * struct property *prop;
349 * const char *s;
350 *
351 * of_property_for_each_string(np, "propname", prop, s)
352 * printk("String value: %s\n", s);
353 */
354const char *of_prop_next_string(struct property *prop, const char *cur);
Stephen Warrenc541adc2012-04-04 09:27:46 -0600355
Grant Likely3482f2c2014-03-27 17:18:55 -0700356bool of_console_check(struct device_node *dn, char *name, int index);
Sascha Hauer5c19e952013-08-05 14:40:44 +0200357
Shawn Guob98c0232011-07-08 16:27:33 +0800358#else /* CONFIG_OF */
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100359
Stephen Rothwell4c358e12014-05-15 14:44:30 +1000360static inline const char* of_node_full_name(const struct device_node *np)
Grant Likely74a7f082012-06-15 11:50:25 -0600361{
362 return "<no-node>";
363}
364
Peter Ujfalusi1cc44f42012-09-10 13:46:24 +0300365static inline struct device_node *of_find_node_by_name(struct device_node *from,
366 const char *name)
367{
368 return NULL;
369}
370
Rob Herring662372e2014-02-03 08:53:44 -0600371static inline struct device_node *of_find_node_by_type(struct device_node *from,
372 const char *type)
373{
374 return NULL;
375}
376
377static inline struct device_node *of_find_matching_node_and_match(
378 struct device_node *from,
379 const struct of_device_id *matches,
380 const struct of_device_id **match)
381{
382 return NULL;
383}
384
Alexander Shiyan20cd4772014-04-16 10:49:20 +0400385static inline struct device_node *of_find_node_by_path(const char *path)
386{
387 return NULL;
388}
389
Alexander Shiyan066ec1d2013-04-09 19:47:40 +0400390static inline struct device_node *of_get_parent(const struct device_node *node)
391{
392 return NULL;
393}
394
Rob Herring662372e2014-02-03 08:53:44 -0600395static inline struct device_node *of_get_next_child(
396 const struct device_node *node, struct device_node *prev)
397{
398 return NULL;
399}
400
401static inline struct device_node *of_get_next_available_child(
402 const struct device_node *node, struct device_node *prev)
403{
404 return NULL;
405}
406
407static inline struct device_node *of_find_node_with_property(
408 struct device_node *from, const char *prop_name)
409{
410 return NULL;
411}
412
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100413static inline bool of_have_populated_dt(void)
414{
415 return false;
416}
417
Olof Johansson25c040c2012-10-07 10:40:54 -0700418static inline struct device_node *of_get_child_by_name(
419 const struct device_node *node,
420 const char *name)
421{
422 return NULL;
423}
424
Rajendra Nayak36a09042011-10-10 21:49:35 +0530425static inline int of_device_is_compatible(const struct device_node *device,
426 const char *name)
427{
428 return 0;
429}
430
Rob Herringd7195692013-03-20 16:56:18 -0500431static inline int of_device_is_available(const struct device_node *device)
432{
433 return 0;
434}
435
Stephen Warrenaba3dff2011-09-21 13:23:10 -0600436static inline struct property *of_find_property(const struct device_node *np,
437 const char *name,
438 int *lenp)
439{
440 return NULL;
441}
442
Shawn Guo2261cc62012-02-15 10:47:42 -0800443static inline struct device_node *of_find_compatible_node(
444 struct device_node *from,
445 const char *type,
446 const char *compat)
447{
448 return NULL;
449}
450
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100451static inline int of_property_count_elems_of_size(const struct device_node *np,
452 const char *propname, int elem_size)
453{
454 return -ENOSYS;
455}
456
Tony Prisk3daf3722013-03-23 17:02:15 +1300457static inline int of_property_read_u32_index(const struct device_node *np,
458 const char *propname, u32 index, u32 *out_value)
459{
460 return -ENOSYS;
461}
462
Viresh Kumarbe193242012-11-20 10:15:19 +0530463static inline int of_property_read_u8_array(const struct device_node *np,
464 const char *propname, u8 *out_values, size_t sz)
465{
466 return -ENOSYS;
467}
468
469static inline int of_property_read_u16_array(const struct device_node *np,
470 const char *propname, u16 *out_values, size_t sz)
471{
472 return -ENOSYS;
473}
474
Shawn Guob98c0232011-07-08 16:27:33 +0800475static inline int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100476 const char *propname,
477 u32 *out_values, size_t sz)
Shawn Guob98c0232011-07-08 16:27:33 +0800478{
479 return -ENOSYS;
480}
481
482static inline int of_property_read_string(struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100483 const char *propname,
484 const char **out_string)
Shawn Guob98c0232011-07-08 16:27:33 +0800485{
486 return -ENOSYS;
487}
488
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200489static inline int of_property_read_string_index(struct device_node *np,
490 const char *propname, int index,
491 const char **out_string)
492{
493 return -ENOSYS;
494}
495
496static inline int of_property_count_strings(struct device_node *np,
497 const char *propname)
498{
499 return -ENOSYS;
500}
501
Stephen Warren89272b82011-08-05 16:50:30 -0600502static inline const void *of_get_property(const struct device_node *node,
503 const char *name,
504 int *lenp)
505{
506 return NULL;
507}
508
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100509static inline struct device_node *of_get_cpu_node(int cpu,
510 unsigned int *thread)
511{
512 return NULL;
513}
514
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100515static inline int of_property_read_u64(const struct device_node *np,
516 const char *propname, u64 *out_value)
517{
518 return -ENOSYS;
519}
520
Thierry Redingbd3d5502012-04-13 16:18:34 +0200521static inline int of_property_match_string(struct device_node *np,
522 const char *propname,
523 const char *string)
524{
525 return -ENOSYS;
526}
527
Steffen Trumtrarb8fbdc42012-11-22 12:16:43 +0100528static inline struct device_node *of_parse_phandle(const struct device_node *np,
Rajendra Nayak36a09042011-10-10 21:49:35 +0530529 const char *phandle_name,
530 int index)
531{
532 return NULL;
533}
534
Thierry Redinge05e5072012-04-13 16:19:21 +0200535static inline int of_parse_phandle_with_args(struct device_node *np,
536 const char *list_name,
537 const char *cells_name,
538 int index,
539 struct of_phandle_args *out_args)
540{
541 return -ENOSYS;
542}
543
Stephen Warren035fd942013-08-14 15:27:10 -0600544static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
545 const char *list_name, int cells_count, int index,
546 struct of_phandle_args *out_args)
547{
548 return -ENOSYS;
549}
550
Grant Likelybd69f732013-02-10 22:57:21 +0000551static inline int of_count_phandle_with_args(struct device_node *np,
552 const char *list_name,
553 const char *cells_name)
554{
555 return -ENOSYS;
556}
557
Nicolas Ferreed5f8862011-10-27 11:07:28 +0200558static inline int of_alias_get_id(struct device_node *np, const char *stem)
559{
560 return -ENOSYS;
561}
562
Stephen Warren50e07f82011-10-25 14:01:26 +0200563static inline int of_machine_is_compatible(const char *compat)
564{
565 return 0;
566}
567
Grant Likely3482f2c2014-03-27 17:18:55 -0700568static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
Sascha Hauer5c19e952013-08-05 14:40:44 +0200569{
Grant Likely3482f2c2014-03-27 17:18:55 -0700570 return false;
Sascha Hauer5c19e952013-08-05 14:40:44 +0200571}
572
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200573static inline const __be32 *of_prop_next_u32(struct property *prop,
574 const __be32 *cur, u32 *pu)
575{
576 return NULL;
577}
578
579static inline const char *of_prop_next_string(struct property *prop,
580 const char *cur)
581{
582 return NULL;
583}
584
Ben Dooks3a1e3622011-08-03 10:11:42 +0100585#define of_match_ptr(_ptr) NULL
Nicolas Ferre5762c202011-10-24 11:53:32 +0200586#define of_match_node(_matches, _node) NULL
Jeremy Kerr9dfbf202010-02-14 07:13:43 -0700587#endif /* CONFIG_OF */
Shawn Guob98c0232011-07-08 16:27:33 +0800588
Rob Herring0c3f0612013-09-17 10:42:50 -0500589#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
590extern int of_node_to_nid(struct device_node *np);
591#else
592static inline int of_node_to_nid(struct device_node *device) { return 0; }
Paul Mundt5ca4db62012-06-03 22:04:34 -0700593#endif
594
Rob Herring662372e2014-02-03 08:53:44 -0600595static inline struct device_node *of_find_matching_node(
596 struct device_node *from,
597 const struct of_device_id *matches)
598{
599 return of_find_matching_node_and_match(from, matches, NULL);
600}
601
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800602/**
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100603 * of_property_count_u8_elems - Count the number of u8 elements in a property
604 *
605 * @np: device node from which the property value is to be read.
606 * @propname: name of the property to be searched.
607 *
608 * Search for a property in a device node and count the number of u8 elements
609 * in it. Returns number of elements on sucess, -EINVAL if the property does
610 * not exist or its length does not match a multiple of u8 and -ENODATA if the
611 * property does not have a value.
612 */
613static inline int of_property_count_u8_elems(const struct device_node *np,
614 const char *propname)
615{
616 return of_property_count_elems_of_size(np, propname, sizeof(u8));
617}
618
619/**
620 * of_property_count_u16_elems - Count the number of u16 elements in a property
621 *
622 * @np: device node from which the property value is to be read.
623 * @propname: name of the property to be searched.
624 *
625 * Search for a property in a device node and count the number of u16 elements
626 * in it. Returns number of elements on sucess, -EINVAL if the property does
627 * not exist or its length does not match a multiple of u16 and -ENODATA if the
628 * property does not have a value.
629 */
630static inline int of_property_count_u16_elems(const struct device_node *np,
631 const char *propname)
632{
633 return of_property_count_elems_of_size(np, propname, sizeof(u16));
634}
635
636/**
637 * of_property_count_u32_elems - Count the number of u32 elements in a property
638 *
639 * @np: device node from which the property value is to be read.
640 * @propname: name of the property to be searched.
641 *
642 * Search for a property in a device node and count the number of u32 elements
643 * in it. Returns number of elements on sucess, -EINVAL if the property does
644 * not exist or its length does not match a multiple of u32 and -ENODATA if the
645 * property does not have a value.
646 */
647static inline int of_property_count_u32_elems(const struct device_node *np,
648 const char *propname)
649{
650 return of_property_count_elems_of_size(np, propname, sizeof(u32));
651}
652
653/**
654 * of_property_count_u64_elems - Count the number of u64 elements in a property
655 *
656 * @np: device node from which the property value is to be read.
657 * @propname: name of the property to be searched.
658 *
659 * Search for a property in a device node and count the number of u64 elements
660 * in it. Returns number of elements on sucess, -EINVAL if the property does
661 * not exist or its length does not match a multiple of u64 and -ENODATA if the
662 * property does not have a value.
663 */
664static inline int of_property_count_u64_elems(const struct device_node *np,
665 const char *propname)
666{
667 return of_property_count_elems_of_size(np, propname, sizeof(u64));
668}
669
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800670/**
671 * of_property_read_bool - Findfrom a property
672 * @np: device node from which the property value is to be read.
673 * @propname: name of the property to be searched.
674 *
675 * Search for a property in a device node.
676 * Returns true if the property exist false otherwise.
677 */
678static inline bool of_property_read_bool(const struct device_node *np,
679 const char *propname)
680{
681 struct property *prop = of_find_property(np, propname, NULL);
682
683 return prop ? true : false;
684}
685
Viresh Kumarbe193242012-11-20 10:15:19 +0530686static inline int of_property_read_u8(const struct device_node *np,
687 const char *propname,
688 u8 *out_value)
689{
690 return of_property_read_u8_array(np, propname, out_value, 1);
691}
692
693static inline int of_property_read_u16(const struct device_node *np,
694 const char *propname,
695 u16 *out_value)
696{
697 return of_property_read_u16_array(np, propname, out_value, 1);
698}
699
Shawn Guob98c0232011-07-08 16:27:33 +0800700static inline int of_property_read_u32(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100701 const char *propname,
Shawn Guob98c0232011-07-08 16:27:33 +0800702 u32 *out_value)
703{
704 return of_property_read_u32_array(np, propname, out_value, 1);
705}
706
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200707#define of_property_for_each_u32(np, propname, prop, p, u) \
708 for (prop = of_find_property(np, propname, NULL), \
709 p = of_prop_next_u32(prop, NULL, &u); \
710 p; \
711 p = of_prop_next_u32(prop, p, &u))
712
713#define of_property_for_each_string(np, propname, prop, s) \
714 for (prop = of_find_property(np, propname, NULL), \
715 s = of_prop_next_string(prop, NULL); \
716 s; \
717 s = of_prop_next_string(prop, s))
718
Rob Herring662372e2014-02-03 08:53:44 -0600719#define for_each_node_by_name(dn, name) \
720 for (dn = of_find_node_by_name(NULL, name); dn; \
721 dn = of_find_node_by_name(dn, name))
722#define for_each_node_by_type(dn, type) \
723 for (dn = of_find_node_by_type(NULL, type); dn; \
724 dn = of_find_node_by_type(dn, type))
725#define for_each_compatible_node(dn, type, compatible) \
726 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
727 dn = of_find_compatible_node(dn, type, compatible))
728#define for_each_matching_node(dn, matches) \
729 for (dn = of_find_matching_node(NULL, matches); dn; \
730 dn = of_find_matching_node(dn, matches))
731#define for_each_matching_node_and_match(dn, matches, match) \
732 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
733 dn; dn = of_find_matching_node_and_match(dn, matches, match))
734
735#define for_each_child_of_node(parent, child) \
736 for (child = of_get_next_child(parent, NULL); child != NULL; \
737 child = of_get_next_child(parent, child))
738#define for_each_available_child_of_node(parent, child) \
739 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
740 child = of_get_next_available_child(parent, child))
741
742#define for_each_node_with_property(dn, prop_name) \
743 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
744 dn = of_find_node_with_property(dn, prop_name))
745
746static inline int of_get_child_count(const struct device_node *np)
747{
748 struct device_node *child;
749 int num = 0;
750
751 for_each_child_of_node(np, child)
752 num++;
753
754 return num;
755}
756
757static inline int of_get_available_child_count(const struct device_node *np)
758{
759 struct device_node *child;
760 int num = 0;
761
762 for_each_available_child_of_node(np, child)
763 num++;
764
765 return num;
766}
767
Rob Herring54196cc2014-05-08 16:09:24 -0500768#ifdef CONFIG_OF
769#define _OF_DECLARE(table, name, compat, fn, fn_type) \
770 static const struct of_device_id __of_table_##name \
771 __used __section(__##table##_of_table) \
772 = { .compatible = compat, \
773 .data = (fn == (fn_type)NULL) ? fn : fn }
774#else
775#define _OF_DECLARE(table, name, compat, fn, fn_type) \
776 static const struct of_device_id __of_table_##name \
777 __attribute__((unused)) \
778 = { .compatible = compat, \
779 .data = (fn == (fn_type)NULL) ? fn : fn }
780#endif
781
782typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
783typedef void (*of_init_fn_1)(struct device_node *);
784
785#define OF_DECLARE_1(table, name, compat, fn) \
786 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
787#define OF_DECLARE_2(table, name, compat, fn) \
788 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
789
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300790/**
791 * struct of_changeset_entry - Holds a changeset entry
792 *
793 * @node: list_head for the log list
794 * @action: notifier action
795 * @np: pointer to the device node affected
796 * @prop: pointer to the property affected
797 * @old_prop: hold a pointer to the original property
798 *
799 * Every modification of the device tree during a changeset
800 * is held in a list of of_changeset_entry structures.
801 * That way we can recover from a partial application, or we can
802 * revert the changeset
803 */
804struct of_changeset_entry {
805 struct list_head node;
806 unsigned long action;
807 struct device_node *np;
808 struct property *prop;
809 struct property *old_prop;
810};
811
812/**
813 * struct of_changeset - changeset tracker structure
814 *
815 * @entries: list_head for the changeset entries
816 *
817 * changesets are a convenient way to apply bulk changes to the
818 * live tree. In case of an error, changes are rolled-back.
819 * changesets live on after initial application, and if not
820 * destroyed after use, they can be reverted in one single call.
821 */
822struct of_changeset {
823 struct list_head entries;
824};
825
826#ifdef CONFIG_OF_DYNAMIC
827extern void of_changeset_init(struct of_changeset *ocs);
828extern void of_changeset_destroy(struct of_changeset *ocs);
829extern int of_changeset_apply(struct of_changeset *ocs);
830extern int of_changeset_revert(struct of_changeset *ocs);
831extern int of_changeset_action(struct of_changeset *ocs,
832 unsigned long action, struct device_node *np,
833 struct property *prop);
834
835static inline int of_changeset_attach_node(struct of_changeset *ocs,
836 struct device_node *np)
837{
838 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
839}
840
841static inline int of_changeset_detach_node(struct of_changeset *ocs,
842 struct device_node *np)
843{
844 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
845}
846
847static inline int of_changeset_add_property(struct of_changeset *ocs,
848 struct device_node *np, struct property *prop)
849{
850 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
851}
852
853static inline int of_changeset_remove_property(struct of_changeset *ocs,
854 struct device_node *np, struct property *prop)
855{
856 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
857}
858
859static inline int of_changeset_update_property(struct of_changeset *ocs,
860 struct device_node *np, struct property *prop)
861{
862 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
863}
864#endif
865
Pantelis Antoniou7941b272014-07-04 19:59:20 +0300866/* CONFIG_OF_RESOLVE api */
867extern int of_resolve_phandles(struct device_node *tree);
868
Romain Periera4b4e042014-10-14 06:31:09 +0000869/**
870 * of_system_has_poweroff_source - Tells if poweroff-source is found for device_node
871 * @np: Pointer to the given device_node
872 *
873 * return true if present false otherwise
874 */
875static inline bool of_system_has_poweroff_source(const struct device_node *np)
876{
877 return of_property_read_bool(np, "poweroff-source");
878}
879
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000880#endif /* _LINUX_OF_H */