blob: f83ca9dddcba00dfc05e449ce0a5a709c5bfc3c7 [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 Herrmannb66548e2014-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 Likely41f88002009-11-23 20:07:01 -0700108/* Pointer for first entry in chain of all nodes. */
Randy Dunlap465aac62012-11-30 10:01:51 +0000109extern struct device_node *of_allnodes;
Grant Likelyfc0bdae2010-02-14 07:13:55 -0700110extern struct device_node *of_chosen;
Shawn Guo611cad72011-08-15 15:28:14 +0800111extern struct device_node *of_aliases;
Grant Likelya752ee52014-03-28 08:12:18 -0700112extern struct device_node *of_stdout;
Thomas Gleixnerd6d3c4e2013-02-06 15:30:56 -0500113extern raw_spinlock_t devtree_lock;
Grant Likely41f88002009-11-23 20:07:01 -0700114
Hans de Goede6d09dc62014-11-14 13:26:52 +0100115#ifdef CONFIG_OF
Sebastian Andrzej Siewior3bcbaf62011-02-22 21:07:46 +0100116static inline bool of_have_populated_dt(void)
117{
Randy Dunlap465aac62012-11-30 10:01:51 +0000118 return of_allnodes != 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 Likelye91edcf2009-10-15 10:58:09 -0600162extern struct device_node *of_find_all_nodes(struct device_node *prev);
163
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600164/*
Lennert Buytenhek3d6b8822011-02-22 18:18:51 +0100165 * OF address retrieval & translation
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600166 */
167
168/* Helper to read a big number; size is in cells (not bytes) */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700169static inline u64 of_read_number(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600170{
171 u64 r = 0;
172 while (size--)
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700173 r = (r << 32) | be32_to_cpu(*(cell++));
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600174 return r;
175}
176
177/* Like of_read_number, but we want an unsigned long result */
Jeremy Kerr2e89e682010-01-30 01:41:49 -0700178static inline unsigned long of_read_ulong(const __be32 *cell, int size)
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600179{
Grant Likely2be09cb2009-11-23 20:16:46 -0700180 /* toss away upper bits if unsigned long is smaller than u64 */
181 return of_read_number(cell, size);
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600182}
Grant Likelyb6caf2a2009-10-15 10:58:00 -0600183
Rob Herringb5b4bb32013-09-07 14:08:20 -0500184#if defined(CONFIG_SPARC)
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000185#include <asm/prom.h>
Rob Herringb5b4bb32013-09-07 14:08:20 -0500186#endif
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000187
Grant Likely7c7b60c2010-02-14 07:13:50 -0700188/* Default #address and #size cells. Allow arch asm/prom.h to override */
189#if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
190#define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
191#define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
192#endif
193
194/* Default string compare functions, Allow arch asm/prom.h to override */
195#if !defined(of_compat_cmp)
Grant Likely19761522010-03-18 07:30:31 -0600196#define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
Grant Likely7c7b60c2010-02-14 07:13:50 -0700197#define of_prop_cmp(s1, s2) strcmp((s1), (s2))
198#define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
199#endif
200
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000201/* flag descriptions */
202#define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
203#define OF_DETACHED 2 /* node has been detached from the device tree */
Pawel Mollc6e126d2014-05-15 16:55:24 +0100204#define OF_POPULATED 3 /* device already created for the node */
Grant Likely75f353b2014-06-24 16:13:47 +0100205#define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000206
Grant Likely61e955d2009-10-15 10:57:51 -0600207#define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
208#define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
209
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000210#define OF_BAD_ADDR ((u64)-1)
211
Steffen Trumtrarc0a05bf2012-12-18 11:32:03 +0100212static inline const char *of_node_full_name(const struct device_node *np)
Grant Likely74a7f082012-06-15 11:50:25 -0600213{
214 return np ? np->full_name : "<no-node>";
215}
216
Grant Likely75b57ec2014-02-20 18:02:11 +0000217#define for_each_of_allnodes(dn) \
218 for (dn = of_allnodes; dn; dn = dn->allnext)
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000219extern struct device_node *of_find_node_by_name(struct device_node *from,
220 const char *name);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000221extern struct device_node *of_find_node_by_type(struct device_node *from,
222 const char *type);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000223extern struct device_node *of_find_compatible_node(struct device_node *from,
224 const char *type, const char *compat);
Stephen Warren50c8af42012-11-20 16:12:20 -0700225extern struct device_node *of_find_matching_node_and_match(
226 struct device_node *from,
227 const struct of_device_id *matches,
228 const struct of_device_id **match);
Rob Herring662372e2014-02-03 08:53:44 -0600229
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000230extern struct device_node *of_find_node_by_path(const char *path);
231extern struct device_node *of_find_node_by_phandle(phandle handle);
232extern struct device_node *of_get_parent(const struct device_node *node);
Michael Ellermanf4eb0102007-10-26 16:54:31 +1000233extern struct device_node *of_get_next_parent(struct device_node *node);
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000234extern struct device_node *of_get_next_child(const struct device_node *node,
235 struct device_node *prev);
Timur Tabi32961932012-08-14 13:20:23 +0000236extern struct device_node *of_get_next_available_child(
237 const struct device_node *node, struct device_node *prev);
238
Srinivas Kandagatla9c197612012-09-18 08:10:28 +0100239extern struct device_node *of_get_child_by_name(const struct device_node *node,
240 const char *name);
Bryan Wu954e04b2013-09-24 10:38:26 -0700241
Sudeep KarkadaNageshaa3e31b42013-09-18 11:53:05 +0100242/* cache lookup */
243extern struct device_node *of_find_next_cache_node(const struct device_node *);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000244extern struct device_node *of_find_node_with_property(
245 struct device_node *from, const char *prop_name);
Michael Ellerman1e291b12008-11-12 18:54:42 +0000246
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000247extern struct property *of_find_property(const struct device_node *np,
248 const char *name,
249 int *lenp);
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100250extern int of_property_count_elems_of_size(const struct device_node *np,
251 const char *propname, int elem_size);
Tony Prisk3daf3722013-03-23 17:02:15 +1300252extern int of_property_read_u32_index(const struct device_node *np,
253 const char *propname,
254 u32 index, u32 *out_value);
Viresh Kumarbe193242012-11-20 10:15:19 +0530255extern int of_property_read_u8_array(const struct device_node *np,
256 const char *propname, u8 *out_values, size_t sz);
257extern int of_property_read_u16_array(const struct device_node *np,
258 const char *propname, u16 *out_values, size_t sz);
Rob Herring0e373632011-07-06 15:42:58 -0500259extern int of_property_read_u32_array(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100260 const char *propname,
Rob Herring0e373632011-07-06 15:42:58 -0500261 u32 *out_values,
262 size_t sz);
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100263extern int of_property_read_u64(const struct device_node *np,
264 const char *propname, u64 *out_value);
Rob Herring0e373632011-07-06 15:42:58 -0500265
Jamie Ilesaac285c2011-08-02 15:45:07 +0100266extern int of_property_read_string(struct device_node *np,
267 const char *propname,
268 const char **out_string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200269extern int of_property_read_string_index(struct device_node *np,
270 const char *propname,
271 int index, const char **output);
Grant Likely7aff0fe2011-12-12 09:25:58 -0700272extern int of_property_match_string(struct device_node *np,
273 const char *propname,
274 const char *string);
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200275extern int of_property_count_strings(struct device_node *np,
276 const char *propname);
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
Benoit Cousson4fcd15a2011-09-27 17:45:43 +0200488static inline int of_property_read_string_index(struct device_node *np,
489 const char *propname, int index,
490 const char **out_string)
491{
492 return -ENOSYS;
493}
494
495static inline int of_property_count_strings(struct device_node *np,
496 const char *propname)
497{
498 return -ENOSYS;
499}
500
Stephen Warren89272b82011-08-05 16:50:30 -0600501static inline const void *of_get_property(const struct device_node *node,
502 const char *name,
503 int *lenp)
504{
505 return NULL;
506}
507
Sudeep KarkadaNagesha183912d2013-08-15 14:01:40 +0100508static inline struct device_node *of_get_cpu_node(int cpu,
509 unsigned int *thread)
510{
511 return NULL;
512}
513
Jamie Iles4cd7f7a2011-09-14 20:49:59 +0100514static inline int of_property_read_u64(const struct device_node *np,
515 const char *propname, u64 *out_value)
516{
517 return -ENOSYS;
518}
519
Thierry Redingbd3d5502012-04-13 16:18:34 +0200520static inline int of_property_match_string(struct device_node *np,
521 const char *propname,
522 const char *string)
523{
524 return -ENOSYS;
525}
526
Steffen Trumtrarb8fbdc42012-11-22 12:16:43 +0100527static inline struct device_node *of_parse_phandle(const struct device_node *np,
Rajendra Nayak36a09042011-10-10 21:49:35 +0530528 const char *phandle_name,
529 int index)
530{
531 return NULL;
532}
533
Thierry Redinge05e5072012-04-13 16:19:21 +0200534static inline int of_parse_phandle_with_args(struct device_node *np,
535 const char *list_name,
536 const char *cells_name,
537 int index,
538 struct of_phandle_args *out_args)
539{
540 return -ENOSYS;
541}
542
Stephen Warren035fd942013-08-14 15:27:10 -0600543static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
544 const char *list_name, int cells_count, int index,
545 struct of_phandle_args *out_args)
546{
547 return -ENOSYS;
548}
549
Grant Likelybd69f732013-02-10 22:57:21 +0000550static inline int of_count_phandle_with_args(struct device_node *np,
551 const char *list_name,
552 const char *cells_name)
553{
554 return -ENOSYS;
555}
556
Nicolas Ferreed5f8862011-10-27 11:07:28 +0200557static inline int of_alias_get_id(struct device_node *np, const char *stem)
558{
559 return -ENOSYS;
560}
561
Stephen Warren50e07f82011-10-25 14:01:26 +0200562static inline int of_machine_is_compatible(const char *compat)
563{
564 return 0;
565}
566
Grant Likely3482f2c2014-03-27 17:18:55 -0700567static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
Sascha Hauer5c19e952013-08-05 14:40:44 +0200568{
Grant Likely3482f2c2014-03-27 17:18:55 -0700569 return false;
Sascha Hauer5c19e952013-08-05 14:40:44 +0200570}
571
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200572static inline const __be32 *of_prop_next_u32(struct property *prop,
573 const __be32 *cur, u32 *pu)
574{
575 return NULL;
576}
577
578static inline const char *of_prop_next_string(struct property *prop,
579 const char *cur)
580{
581 return NULL;
582}
583
Ben Dooks3a1e3622011-08-03 10:11:42 +0100584#define of_match_ptr(_ptr) NULL
Nicolas Ferre5762c202011-10-24 11:53:32 +0200585#define of_match_node(_matches, _node) NULL
Jeremy Kerr9dfbf202010-02-14 07:13:43 -0700586#endif /* CONFIG_OF */
Shawn Guob98c0232011-07-08 16:27:33 +0800587
Rob Herring0c3f0612013-09-17 10:42:50 -0500588#if defined(CONFIG_OF) && defined(CONFIG_NUMA)
589extern int of_node_to_nid(struct device_node *np);
590#else
591static inline int of_node_to_nid(struct device_node *device) { return 0; }
Paul Mundt5ca4db62012-06-03 22:04:34 -0700592#endif
593
Rob Herring662372e2014-02-03 08:53:44 -0600594static inline struct device_node *of_find_matching_node(
595 struct device_node *from,
596 const struct of_device_id *matches)
597{
598 return of_find_matching_node_and_match(from, matches, NULL);
599}
600
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800601/**
Heiko Stuebnerad54a0c2014-02-12 01:00:34 +0100602 * of_property_count_u8_elems - Count the number of u8 elements in a property
603 *
604 * @np: device node from which the property value is to be read.
605 * @propname: name of the property to be searched.
606 *
607 * Search for a property in a device node and count the number of u8 elements
608 * in it. Returns number of elements on sucess, -EINVAL if the property does
609 * not exist or its length does not match a multiple of u8 and -ENODATA if the
610 * property does not have a value.
611 */
612static inline int of_property_count_u8_elems(const struct device_node *np,
613 const char *propname)
614{
615 return of_property_count_elems_of_size(np, propname, sizeof(u8));
616}
617
618/**
619 * of_property_count_u16_elems - Count the number of u16 elements in a property
620 *
621 * @np: device node from which the property value is to be read.
622 * @propname: name of the property to be searched.
623 *
624 * Search for a property in a device node and count the number of u16 elements
625 * in it. Returns number of elements on sucess, -EINVAL if the property does
626 * not exist or its length does not match a multiple of u16 and -ENODATA if the
627 * property does not have a value.
628 */
629static inline int of_property_count_u16_elems(const struct device_node *np,
630 const char *propname)
631{
632 return of_property_count_elems_of_size(np, propname, sizeof(u16));
633}
634
635/**
636 * of_property_count_u32_elems - Count the number of u32 elements in a property
637 *
638 * @np: device node from which the property value is to be read.
639 * @propname: name of the property to be searched.
640 *
641 * Search for a property in a device node and count the number of u32 elements
642 * in it. Returns number of elements on sucess, -EINVAL if the property does
643 * not exist or its length does not match a multiple of u32 and -ENODATA if the
644 * property does not have a value.
645 */
646static inline int of_property_count_u32_elems(const struct device_node *np,
647 const char *propname)
648{
649 return of_property_count_elems_of_size(np, propname, sizeof(u32));
650}
651
652/**
653 * of_property_count_u64_elems - Count the number of u64 elements in a property
654 *
655 * @np: device node from which the property value is to be read.
656 * @propname: name of the property to be searched.
657 *
658 * Search for a property in a device node and count the number of u64 elements
659 * in it. Returns number of elements on sucess, -EINVAL if the property does
660 * not exist or its length does not match a multiple of u64 and -ENODATA if the
661 * property does not have a value.
662 */
663static inline int of_property_count_u64_elems(const struct device_node *np,
664 const char *propname)
665{
666 return of_property_count_elems_of_size(np, propname, sizeof(u64));
667}
668
Jean-Christophe PLAGNIOL-VILLARDfa4d34c2012-02-07 12:12:51 +0800669/**
670 * of_property_read_bool - Findfrom a property
671 * @np: device node from which the property value is to be read.
672 * @propname: name of the property to be searched.
673 *
674 * Search for a property in a device node.
675 * Returns true if the property exist false otherwise.
676 */
677static inline bool of_property_read_bool(const struct device_node *np,
678 const char *propname)
679{
680 struct property *prop = of_find_property(np, propname, NULL);
681
682 return prop ? true : false;
683}
684
Viresh Kumarbe193242012-11-20 10:15:19 +0530685static inline int of_property_read_u8(const struct device_node *np,
686 const char *propname,
687 u8 *out_value)
688{
689 return of_property_read_u8_array(np, propname, out_value, 1);
690}
691
692static inline int of_property_read_u16(const struct device_node *np,
693 const char *propname,
694 u16 *out_value)
695{
696 return of_property_read_u16_array(np, propname, out_value, 1);
697}
698
Shawn Guob98c0232011-07-08 16:27:33 +0800699static inline int of_property_read_u32(const struct device_node *np,
Jamie Ilesaac285c2011-08-02 15:45:07 +0100700 const char *propname,
Shawn Guob98c0232011-07-08 16:27:33 +0800701 u32 *out_value)
702{
703 return of_property_read_u32_array(np, propname, out_value, 1);
704}
705
Sebastian Andrzej Siewior2adfffa2013-06-17 16:48:13 +0200706#define of_property_for_each_u32(np, propname, prop, p, u) \
707 for (prop = of_find_property(np, propname, NULL), \
708 p = of_prop_next_u32(prop, NULL, &u); \
709 p; \
710 p = of_prop_next_u32(prop, p, &u))
711
712#define of_property_for_each_string(np, propname, prop, s) \
713 for (prop = of_find_property(np, propname, NULL), \
714 s = of_prop_next_string(prop, NULL); \
715 s; \
716 s = of_prop_next_string(prop, s))
717
Rob Herring662372e2014-02-03 08:53:44 -0600718#define for_each_node_by_name(dn, name) \
719 for (dn = of_find_node_by_name(NULL, name); dn; \
720 dn = of_find_node_by_name(dn, name))
721#define for_each_node_by_type(dn, type) \
722 for (dn = of_find_node_by_type(NULL, type); dn; \
723 dn = of_find_node_by_type(dn, type))
724#define for_each_compatible_node(dn, type, compatible) \
725 for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
726 dn = of_find_compatible_node(dn, type, compatible))
727#define for_each_matching_node(dn, matches) \
728 for (dn = of_find_matching_node(NULL, matches); dn; \
729 dn = of_find_matching_node(dn, matches))
730#define for_each_matching_node_and_match(dn, matches, match) \
731 for (dn = of_find_matching_node_and_match(NULL, matches, match); \
732 dn; dn = of_find_matching_node_and_match(dn, matches, match))
733
734#define for_each_child_of_node(parent, child) \
735 for (child = of_get_next_child(parent, NULL); child != NULL; \
736 child = of_get_next_child(parent, child))
737#define for_each_available_child_of_node(parent, child) \
738 for (child = of_get_next_available_child(parent, NULL); child != NULL; \
739 child = of_get_next_available_child(parent, child))
740
741#define for_each_node_with_property(dn, prop_name) \
742 for (dn = of_find_node_with_property(NULL, prop_name); dn; \
743 dn = of_find_node_with_property(dn, prop_name))
744
745static inline int of_get_child_count(const struct device_node *np)
746{
747 struct device_node *child;
748 int num = 0;
749
750 for_each_child_of_node(np, child)
751 num++;
752
753 return num;
754}
755
756static inline int of_get_available_child_count(const struct device_node *np)
757{
758 struct device_node *child;
759 int num = 0;
760
761 for_each_available_child_of_node(np, child)
762 num++;
763
764 return num;
765}
766
Rob Herring54196cc2014-05-08 16:09:24 -0500767#ifdef CONFIG_OF
768#define _OF_DECLARE(table, name, compat, fn, fn_type) \
769 static const struct of_device_id __of_table_##name \
770 __used __section(__##table##_of_table) \
771 = { .compatible = compat, \
772 .data = (fn == (fn_type)NULL) ? fn : fn }
773#else
774#define _OF_DECLARE(table, name, compat, fn, fn_type) \
775 static const struct of_device_id __of_table_##name \
776 __attribute__((unused)) \
777 = { .compatible = compat, \
778 .data = (fn == (fn_type)NULL) ? fn : fn }
779#endif
780
781typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
782typedef void (*of_init_fn_1)(struct device_node *);
783
784#define OF_DECLARE_1(table, name, compat, fn) \
785 _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
786#define OF_DECLARE_2(table, name, compat, fn) \
787 _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
788
Pantelis Antoniou201c9102014-07-04 19:58:49 +0300789/**
790 * struct of_changeset_entry - Holds a changeset entry
791 *
792 * @node: list_head for the log list
793 * @action: notifier action
794 * @np: pointer to the device node affected
795 * @prop: pointer to the property affected
796 * @old_prop: hold a pointer to the original property
797 *
798 * Every modification of the device tree during a changeset
799 * is held in a list of of_changeset_entry structures.
800 * That way we can recover from a partial application, or we can
801 * revert the changeset
802 */
803struct of_changeset_entry {
804 struct list_head node;
805 unsigned long action;
806 struct device_node *np;
807 struct property *prop;
808 struct property *old_prop;
809};
810
811/**
812 * struct of_changeset - changeset tracker structure
813 *
814 * @entries: list_head for the changeset entries
815 *
816 * changesets are a convenient way to apply bulk changes to the
817 * live tree. In case of an error, changes are rolled-back.
818 * changesets live on after initial application, and if not
819 * destroyed after use, they can be reverted in one single call.
820 */
821struct of_changeset {
822 struct list_head entries;
823};
824
825#ifdef CONFIG_OF_DYNAMIC
826extern void of_changeset_init(struct of_changeset *ocs);
827extern void of_changeset_destroy(struct of_changeset *ocs);
828extern int of_changeset_apply(struct of_changeset *ocs);
829extern int of_changeset_revert(struct of_changeset *ocs);
830extern int of_changeset_action(struct of_changeset *ocs,
831 unsigned long action, struct device_node *np,
832 struct property *prop);
833
834static inline int of_changeset_attach_node(struct of_changeset *ocs,
835 struct device_node *np)
836{
837 return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
838}
839
840static inline int of_changeset_detach_node(struct of_changeset *ocs,
841 struct device_node *np)
842{
843 return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
844}
845
846static inline int of_changeset_add_property(struct of_changeset *ocs,
847 struct device_node *np, struct property *prop)
848{
849 return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
850}
851
852static inline int of_changeset_remove_property(struct of_changeset *ocs,
853 struct device_node *np, struct property *prop)
854{
855 return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
856}
857
858static inline int of_changeset_update_property(struct of_changeset *ocs,
859 struct device_node *np, struct property *prop)
860{
861 return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
862}
863#endif
864
Pantelis Antoniou7941b272014-07-04 19:59:20 +0300865/* CONFIG_OF_RESOLVE api */
866extern int of_resolve_phandles(struct device_node *tree);
867
Stephen Rothwell76c1ce72007-05-01 16:19:07 +1000868#endif /* _LINUX_OF_H */