of.h 26 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880
  1. #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>
  19. #include <linux/bitops.h>
  20. #include <linux/errno.h>
  21. #include <linux/kobject.h>
  22. #include <linux/mod_devicetable.h>
  23. #include <linux/spinlock.h>
  24. #include <linux/topology.h>
  25. #include <linux/notifier.h>
  26. #include <asm/byteorder.h>
  27. #include <asm/errno.h>
  28. typedef u32 phandle;
  29. typedef u32 ihandle;
  30. struct property {
  31. char *name;
  32. int length;
  33. void *value;
  34. struct property *next;
  35. unsigned long _flags;
  36. unsigned int unique_id;
  37. struct bin_attribute attr;
  38. };
  39. #if defined(CONFIG_SPARC)
  40. struct of_irq_controller;
  41. #endif
  42. struct device_node {
  43. const char *name;
  44. const char *type;
  45. phandle phandle;
  46. const char *full_name;
  47. struct property *properties;
  48. struct property *deadprops; /* removed properties */
  49. struct device_node *parent;
  50. struct device_node *child;
  51. struct device_node *sibling;
  52. struct device_node *next; /* next device of same type */
  53. struct device_node *allnext; /* next in list of all nodes */
  54. struct kobject kobj;
  55. unsigned long _flags;
  56. void *data;
  57. #if defined(CONFIG_SPARC)
  58. const char *path_component_name;
  59. unsigned int unique_id;
  60. struct of_irq_controller *irq_trans;
  61. #endif
  62. };
  63. #define MAX_PHANDLE_ARGS 16
  64. struct of_phandle_args {
  65. struct device_node *np;
  66. int args_count;
  67. uint32_t args[MAX_PHANDLE_ARGS];
  68. };
  69. /* initialize a node */
  70. extern struct kobj_type of_node_ktype;
  71. static inline void of_node_init(struct device_node *node)
  72. {
  73. kobject_init(&node->kobj, &of_node_ktype);
  74. }
  75. /* true when node is initialized */
  76. static inline int of_node_is_initialized(struct device_node *node)
  77. {
  78. return node && node->kobj.state_initialized;
  79. }
  80. /* true when node is attached (i.e. present on sysfs) */
  81. static inline int of_node_is_attached(struct device_node *node)
  82. {
  83. return node && node->kobj.state_in_sysfs;
  84. }
  85. #ifdef CONFIG_OF_DYNAMIC
  86. extern struct device_node *of_node_get(struct device_node *node);
  87. extern void of_node_put(struct device_node *node);
  88. #else /* CONFIG_OF_DYNAMIC */
  89. /* Dummy ref counting routines - to be implemented later */
  90. static inline struct device_node *of_node_get(struct device_node *node)
  91. {
  92. return node;
  93. }
  94. static inline void of_node_put(struct device_node *node) { }
  95. #endif /* !CONFIG_OF_DYNAMIC */
  96. #ifdef CONFIG_OF
  97. /* Pointer for first entry in chain of all nodes. */
  98. extern struct device_node *of_allnodes;
  99. extern struct device_node *of_chosen;
  100. extern struct device_node *of_aliases;
  101. extern struct device_node *of_stdout;
  102. extern raw_spinlock_t devtree_lock;
  103. static inline bool of_have_populated_dt(void)
  104. {
  105. return of_allnodes != NULL;
  106. }
  107. static inline bool of_node_is_root(const struct device_node *node)
  108. {
  109. return node && (node->parent == NULL);
  110. }
  111. static inline int of_node_check_flag(struct device_node *n, unsigned long flag)
  112. {
  113. return test_bit(flag, &n->_flags);
  114. }
  115. static inline int of_node_test_and_set_flag(struct device_node *n,
  116. unsigned long flag)
  117. {
  118. return test_and_set_bit(flag, &n->_flags);
  119. }
  120. static inline void of_node_set_flag(struct device_node *n, unsigned long flag)
  121. {
  122. set_bit(flag, &n->_flags);
  123. }
  124. static inline void of_node_clear_flag(struct device_node *n, unsigned long flag)
  125. {
  126. clear_bit(flag, &n->_flags);
  127. }
  128. static inline int of_property_check_flag(struct property *p, unsigned long flag)
  129. {
  130. return test_bit(flag, &p->_flags);
  131. }
  132. static inline void of_property_set_flag(struct property *p, unsigned long flag)
  133. {
  134. set_bit(flag, &p->_flags);
  135. }
  136. static inline void of_property_clear_flag(struct property *p, unsigned long flag)
  137. {
  138. clear_bit(flag, &p->_flags);
  139. }
  140. extern struct device_node *of_find_all_nodes(struct device_node *prev);
  141. /*
  142. * OF address retrieval & translation
  143. */
  144. /* Helper to read a big number; size is in cells (not bytes) */
  145. static inline u64 of_read_number(const __be32 *cell, int size)
  146. {
  147. u64 r = 0;
  148. while (size--)
  149. r = (r << 32) | be32_to_cpu(*(cell++));
  150. return r;
  151. }
  152. /* Like of_read_number, but we want an unsigned long result */
  153. static inline unsigned long of_read_ulong(const __be32 *cell, int size)
  154. {
  155. /* toss away upper bits if unsigned long is smaller than u64 */
  156. return of_read_number(cell, size);
  157. }
  158. #if defined(CONFIG_SPARC)
  159. #include <asm/prom.h>
  160. #endif
  161. /* Default #address and #size cells. Allow arch asm/prom.h to override */
  162. #if !defined(OF_ROOT_NODE_ADDR_CELLS_DEFAULT)
  163. #define OF_ROOT_NODE_ADDR_CELLS_DEFAULT 1
  164. #define OF_ROOT_NODE_SIZE_CELLS_DEFAULT 1
  165. #endif
  166. /* Default string compare functions, Allow arch asm/prom.h to override */
  167. #if !defined(of_compat_cmp)
  168. #define of_compat_cmp(s1, s2, l) strcasecmp((s1), (s2))
  169. #define of_prop_cmp(s1, s2) strcmp((s1), (s2))
  170. #define of_node_cmp(s1, s2) strcasecmp((s1), (s2))
  171. #endif
  172. /* flag descriptions */
  173. #define OF_DYNAMIC 1 /* node and properties were allocated via kmalloc */
  174. #define OF_DETACHED 2 /* node has been detached from the device tree */
  175. #define OF_POPULATED 3 /* device already created for the node */
  176. #define OF_POPULATED_BUS 4 /* of_platform_populate recursed to children of this node */
  177. #define OF_IS_DYNAMIC(x) test_bit(OF_DYNAMIC, &x->_flags)
  178. #define OF_MARK_DYNAMIC(x) set_bit(OF_DYNAMIC, &x->_flags)
  179. #define OF_BAD_ADDR ((u64)-1)
  180. static inline const char *of_node_full_name(const struct device_node *np)
  181. {
  182. return np ? np->full_name : "<no-node>";
  183. }
  184. #define for_each_of_allnodes(dn) \
  185. for (dn = of_allnodes; dn; dn = dn->allnext)
  186. extern struct device_node *of_find_node_by_name(struct device_node *from,
  187. const char *name);
  188. extern struct device_node *of_find_node_by_type(struct device_node *from,
  189. const char *type);
  190. extern struct device_node *of_find_compatible_node(struct device_node *from,
  191. const char *type, const char *compat);
  192. extern struct device_node *of_find_matching_node_and_match(
  193. struct device_node *from,
  194. const struct of_device_id *matches,
  195. const struct of_device_id **match);
  196. extern struct device_node *of_find_node_by_path(const char *path);
  197. extern struct device_node *of_find_node_by_phandle(phandle handle);
  198. extern struct device_node *of_get_parent(const struct device_node *node);
  199. extern struct device_node *of_get_next_parent(struct device_node *node);
  200. extern struct device_node *of_get_next_child(const struct device_node *node,
  201. struct device_node *prev);
  202. extern struct device_node *of_get_next_available_child(
  203. const struct device_node *node, struct device_node *prev);
  204. extern struct device_node *of_get_child_by_name(const struct device_node *node,
  205. const char *name);
  206. /* cache lookup */
  207. extern struct device_node *of_find_next_cache_node(const struct device_node *);
  208. extern struct device_node *of_find_node_with_property(
  209. struct device_node *from, const char *prop_name);
  210. extern struct property *of_find_property(const struct device_node *np,
  211. const char *name,
  212. int *lenp);
  213. extern int of_property_count_elems_of_size(const struct device_node *np,
  214. const char *propname, int elem_size);
  215. extern int of_property_read_u32_index(const struct device_node *np,
  216. const char *propname,
  217. u32 index, u32 *out_value);
  218. extern int of_property_read_u8_array(const struct device_node *np,
  219. const char *propname, u8 *out_values, size_t sz);
  220. extern int of_property_read_u16_array(const struct device_node *np,
  221. const char *propname, u16 *out_values, size_t sz);
  222. extern int of_property_read_u32_array(const struct device_node *np,
  223. const char *propname,
  224. u32 *out_values,
  225. size_t sz);
  226. extern int of_property_read_u64(const struct device_node *np,
  227. const char *propname, u64 *out_value);
  228. extern int of_property_read_string(struct device_node *np,
  229. const char *propname,
  230. const char **out_string);
  231. extern int of_property_read_string_index(struct device_node *np,
  232. const char *propname,
  233. int index, const char **output);
  234. extern int of_property_match_string(struct device_node *np,
  235. const char *propname,
  236. const char *string);
  237. extern int of_property_count_strings(struct device_node *np,
  238. const char *propname);
  239. extern int of_device_is_compatible(const struct device_node *device,
  240. const char *);
  241. extern int of_device_is_available(const struct device_node *device);
  242. extern const void *of_get_property(const struct device_node *node,
  243. const char *name,
  244. int *lenp);
  245. extern struct device_node *of_get_cpu_node(int cpu, unsigned int *thread);
  246. #define for_each_property_of_node(dn, pp) \
  247. for (pp = dn->properties; pp != NULL; pp = pp->next)
  248. extern int of_n_addr_cells(struct device_node *np);
  249. extern int of_n_size_cells(struct device_node *np);
  250. extern const struct of_device_id *of_match_node(
  251. const struct of_device_id *matches, const struct device_node *node);
  252. extern int of_modalias_node(struct device_node *node, char *modalias, int len);
  253. extern void of_print_phandle_args(const char *msg, const struct of_phandle_args *args);
  254. extern struct device_node *of_parse_phandle(const struct device_node *np,
  255. const char *phandle_name,
  256. int index);
  257. extern int of_parse_phandle_with_args(const struct device_node *np,
  258. const char *list_name, const char *cells_name, int index,
  259. struct of_phandle_args *out_args);
  260. extern int of_parse_phandle_with_fixed_args(const struct device_node *np,
  261. const char *list_name, int cells_count, int index,
  262. struct of_phandle_args *out_args);
  263. extern int of_count_phandle_with_args(const struct device_node *np,
  264. const char *list_name, const char *cells_name);
  265. extern void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align));
  266. extern int of_alias_get_id(struct device_node *np, const char *stem);
  267. extern int of_machine_is_compatible(const char *compat);
  268. extern int of_add_property(struct device_node *np, struct property *prop);
  269. extern int of_remove_property(struct device_node *np, struct property *prop);
  270. extern int of_update_property(struct device_node *np, struct property *newprop);
  271. /* For updating the device tree at runtime */
  272. #define OF_RECONFIG_ATTACH_NODE 0x0001
  273. #define OF_RECONFIG_DETACH_NODE 0x0002
  274. #define OF_RECONFIG_ADD_PROPERTY 0x0003
  275. #define OF_RECONFIG_REMOVE_PROPERTY 0x0004
  276. #define OF_RECONFIG_UPDATE_PROPERTY 0x0005
  277. struct of_prop_reconfig {
  278. struct device_node *dn;
  279. struct property *prop;
  280. struct property *old_prop;
  281. };
  282. extern int of_reconfig_notifier_register(struct notifier_block *);
  283. extern int of_reconfig_notifier_unregister(struct notifier_block *);
  284. extern int of_reconfig_notify(unsigned long, void *);
  285. extern int of_attach_node(struct device_node *);
  286. extern int of_detach_node(struct device_node *);
  287. #define of_match_ptr(_ptr) (_ptr)
  288. /*
  289. * struct property *prop;
  290. * const __be32 *p;
  291. * u32 u;
  292. *
  293. * of_property_for_each_u32(np, "propname", prop, p, u)
  294. * printk("U32 value: %x\n", u);
  295. */
  296. const __be32 *of_prop_next_u32(struct property *prop, const __be32 *cur,
  297. u32 *pu);
  298. /*
  299. * struct property *prop;
  300. * const char *s;
  301. *
  302. * of_property_for_each_string(np, "propname", prop, s)
  303. * printk("String value: %s\n", s);
  304. */
  305. const char *of_prop_next_string(struct property *prop, const char *cur);
  306. bool of_console_check(struct device_node *dn, char *name, int index);
  307. #else /* CONFIG_OF */
  308. static inline const char* of_node_full_name(const struct device_node *np)
  309. {
  310. return "<no-node>";
  311. }
  312. static inline struct device_node *of_find_node_by_name(struct device_node *from,
  313. const char *name)
  314. {
  315. return NULL;
  316. }
  317. static inline struct device_node *of_find_node_by_type(struct device_node *from,
  318. const char *type)
  319. {
  320. return NULL;
  321. }
  322. static inline struct device_node *of_find_matching_node_and_match(
  323. struct device_node *from,
  324. const struct of_device_id *matches,
  325. const struct of_device_id **match)
  326. {
  327. return NULL;
  328. }
  329. static inline struct device_node *of_find_node_by_path(const char *path)
  330. {
  331. return NULL;
  332. }
  333. static inline struct device_node *of_get_parent(const struct device_node *node)
  334. {
  335. return NULL;
  336. }
  337. static inline struct device_node *of_get_next_child(
  338. const struct device_node *node, struct device_node *prev)
  339. {
  340. return NULL;
  341. }
  342. static inline struct device_node *of_get_next_available_child(
  343. const struct device_node *node, struct device_node *prev)
  344. {
  345. return NULL;
  346. }
  347. static inline struct device_node *of_find_node_with_property(
  348. struct device_node *from, const char *prop_name)
  349. {
  350. return NULL;
  351. }
  352. static inline bool of_have_populated_dt(void)
  353. {
  354. return false;
  355. }
  356. static inline struct device_node *of_get_child_by_name(
  357. const struct device_node *node,
  358. const char *name)
  359. {
  360. return NULL;
  361. }
  362. static inline int of_device_is_compatible(const struct device_node *device,
  363. const char *name)
  364. {
  365. return 0;
  366. }
  367. static inline int of_device_is_available(const struct device_node *device)
  368. {
  369. return 0;
  370. }
  371. static inline struct property *of_find_property(const struct device_node *np,
  372. const char *name,
  373. int *lenp)
  374. {
  375. return NULL;
  376. }
  377. static inline struct device_node *of_find_compatible_node(
  378. struct device_node *from,
  379. const char *type,
  380. const char *compat)
  381. {
  382. return NULL;
  383. }
  384. static inline int of_property_count_elems_of_size(const struct device_node *np,
  385. const char *propname, int elem_size)
  386. {
  387. return -ENOSYS;
  388. }
  389. static inline int of_property_read_u32_index(const struct device_node *np,
  390. const char *propname, u32 index, u32 *out_value)
  391. {
  392. return -ENOSYS;
  393. }
  394. static inline int of_property_read_u8_array(const struct device_node *np,
  395. const char *propname, u8 *out_values, size_t sz)
  396. {
  397. return -ENOSYS;
  398. }
  399. static inline int of_property_read_u16_array(const struct device_node *np,
  400. const char *propname, u16 *out_values, size_t sz)
  401. {
  402. return -ENOSYS;
  403. }
  404. static inline int of_property_read_u32_array(const struct device_node *np,
  405. const char *propname,
  406. u32 *out_values, size_t sz)
  407. {
  408. return -ENOSYS;
  409. }
  410. static inline int of_property_read_string(struct device_node *np,
  411. const char *propname,
  412. const char **out_string)
  413. {
  414. return -ENOSYS;
  415. }
  416. static inline int of_property_read_string_index(struct device_node *np,
  417. const char *propname, int index,
  418. const char **out_string)
  419. {
  420. return -ENOSYS;
  421. }
  422. static inline int of_property_count_strings(struct device_node *np,
  423. const char *propname)
  424. {
  425. return -ENOSYS;
  426. }
  427. static inline const void *of_get_property(const struct device_node *node,
  428. const char *name,
  429. int *lenp)
  430. {
  431. return NULL;
  432. }
  433. static inline struct device_node *of_get_cpu_node(int cpu,
  434. unsigned int *thread)
  435. {
  436. return NULL;
  437. }
  438. static inline int of_property_read_u64(const struct device_node *np,
  439. const char *propname, u64 *out_value)
  440. {
  441. return -ENOSYS;
  442. }
  443. static inline int of_property_match_string(struct device_node *np,
  444. const char *propname,
  445. const char *string)
  446. {
  447. return -ENOSYS;
  448. }
  449. static inline struct device_node *of_parse_phandle(const struct device_node *np,
  450. const char *phandle_name,
  451. int index)
  452. {
  453. return NULL;
  454. }
  455. static inline int of_parse_phandle_with_args(struct device_node *np,
  456. const char *list_name,
  457. const char *cells_name,
  458. int index,
  459. struct of_phandle_args *out_args)
  460. {
  461. return -ENOSYS;
  462. }
  463. static inline int of_parse_phandle_with_fixed_args(const struct device_node *np,
  464. const char *list_name, int cells_count, int index,
  465. struct of_phandle_args *out_args)
  466. {
  467. return -ENOSYS;
  468. }
  469. static inline int of_count_phandle_with_args(struct device_node *np,
  470. const char *list_name,
  471. const char *cells_name)
  472. {
  473. return -ENOSYS;
  474. }
  475. static inline int of_alias_get_id(struct device_node *np, const char *stem)
  476. {
  477. return -ENOSYS;
  478. }
  479. static inline int of_machine_is_compatible(const char *compat)
  480. {
  481. return 0;
  482. }
  483. static inline bool of_console_check(const struct device_node *dn, const char *name, int index)
  484. {
  485. return false;
  486. }
  487. static inline const __be32 *of_prop_next_u32(struct property *prop,
  488. const __be32 *cur, u32 *pu)
  489. {
  490. return NULL;
  491. }
  492. static inline const char *of_prop_next_string(struct property *prop,
  493. const char *cur)
  494. {
  495. return NULL;
  496. }
  497. #define of_match_ptr(_ptr) NULL
  498. #define of_match_node(_matches, _node) NULL
  499. #endif /* CONFIG_OF */
  500. #if defined(CONFIG_OF) && defined(CONFIG_NUMA)
  501. extern int of_node_to_nid(struct device_node *np);
  502. #else
  503. static inline int of_node_to_nid(struct device_node *device) { return 0; }
  504. #endif
  505. static inline struct device_node *of_find_matching_node(
  506. struct device_node *from,
  507. const struct of_device_id *matches)
  508. {
  509. return of_find_matching_node_and_match(from, matches, NULL);
  510. }
  511. /**
  512. * of_property_count_u8_elems - Count the number of u8 elements in a property
  513. *
  514. * @np: device node from which the property value is to be read.
  515. * @propname: name of the property to be searched.
  516. *
  517. * Search for a property in a device node and count the number of u8 elements
  518. * in it. Returns number of elements on sucess, -EINVAL if the property does
  519. * not exist or its length does not match a multiple of u8 and -ENODATA if the
  520. * property does not have a value.
  521. */
  522. static inline int of_property_count_u8_elems(const struct device_node *np,
  523. const char *propname)
  524. {
  525. return of_property_count_elems_of_size(np, propname, sizeof(u8));
  526. }
  527. /**
  528. * of_property_count_u16_elems - Count the number of u16 elements in a property
  529. *
  530. * @np: device node from which the property value is to be read.
  531. * @propname: name of the property to be searched.
  532. *
  533. * Search for a property in a device node and count the number of u16 elements
  534. * in it. Returns number of elements on sucess, -EINVAL if the property does
  535. * not exist or its length does not match a multiple of u16 and -ENODATA if the
  536. * property does not have a value.
  537. */
  538. static inline int of_property_count_u16_elems(const struct device_node *np,
  539. const char *propname)
  540. {
  541. return of_property_count_elems_of_size(np, propname, sizeof(u16));
  542. }
  543. /**
  544. * of_property_count_u32_elems - Count the number of u32 elements in a property
  545. *
  546. * @np: device node from which the property value is to be read.
  547. * @propname: name of the property to be searched.
  548. *
  549. * Search for a property in a device node and count the number of u32 elements
  550. * in it. Returns number of elements on sucess, -EINVAL if the property does
  551. * not exist or its length does not match a multiple of u32 and -ENODATA if the
  552. * property does not have a value.
  553. */
  554. static inline int of_property_count_u32_elems(const struct device_node *np,
  555. const char *propname)
  556. {
  557. return of_property_count_elems_of_size(np, propname, sizeof(u32));
  558. }
  559. /**
  560. * of_property_count_u64_elems - Count the number of u64 elements in a property
  561. *
  562. * @np: device node from which the property value is to be read.
  563. * @propname: name of the property to be searched.
  564. *
  565. * Search for a property in a device node and count the number of u64 elements
  566. * in it. Returns number of elements on sucess, -EINVAL if the property does
  567. * not exist or its length does not match a multiple of u64 and -ENODATA if the
  568. * property does not have a value.
  569. */
  570. static inline int of_property_count_u64_elems(const struct device_node *np,
  571. const char *propname)
  572. {
  573. return of_property_count_elems_of_size(np, propname, sizeof(u64));
  574. }
  575. /**
  576. * of_property_read_bool - Findfrom a property
  577. * @np: device node from which the property value is to be read.
  578. * @propname: name of the property to be searched.
  579. *
  580. * Search for a property in a device node.
  581. * Returns true if the property exist false otherwise.
  582. */
  583. static inline bool of_property_read_bool(const struct device_node *np,
  584. const char *propname)
  585. {
  586. struct property *prop = of_find_property(np, propname, NULL);
  587. return prop ? true : false;
  588. }
  589. static inline int of_property_read_u8(const struct device_node *np,
  590. const char *propname,
  591. u8 *out_value)
  592. {
  593. return of_property_read_u8_array(np, propname, out_value, 1);
  594. }
  595. static inline int of_property_read_u16(const struct device_node *np,
  596. const char *propname,
  597. u16 *out_value)
  598. {
  599. return of_property_read_u16_array(np, propname, out_value, 1);
  600. }
  601. static inline int of_property_read_u32(const struct device_node *np,
  602. const char *propname,
  603. u32 *out_value)
  604. {
  605. return of_property_read_u32_array(np, propname, out_value, 1);
  606. }
  607. #define of_property_for_each_u32(np, propname, prop, p, u) \
  608. for (prop = of_find_property(np, propname, NULL), \
  609. p = of_prop_next_u32(prop, NULL, &u); \
  610. p; \
  611. p = of_prop_next_u32(prop, p, &u))
  612. #define of_property_for_each_string(np, propname, prop, s) \
  613. for (prop = of_find_property(np, propname, NULL), \
  614. s = of_prop_next_string(prop, NULL); \
  615. s; \
  616. s = of_prop_next_string(prop, s))
  617. #define for_each_node_by_name(dn, name) \
  618. for (dn = of_find_node_by_name(NULL, name); dn; \
  619. dn = of_find_node_by_name(dn, name))
  620. #define for_each_node_by_type(dn, type) \
  621. for (dn = of_find_node_by_type(NULL, type); dn; \
  622. dn = of_find_node_by_type(dn, type))
  623. #define for_each_compatible_node(dn, type, compatible) \
  624. for (dn = of_find_compatible_node(NULL, type, compatible); dn; \
  625. dn = of_find_compatible_node(dn, type, compatible))
  626. #define for_each_matching_node(dn, matches) \
  627. for (dn = of_find_matching_node(NULL, matches); dn; \
  628. dn = of_find_matching_node(dn, matches))
  629. #define for_each_matching_node_and_match(dn, matches, match) \
  630. for (dn = of_find_matching_node_and_match(NULL, matches, match); \
  631. dn; dn = of_find_matching_node_and_match(dn, matches, match))
  632. #define for_each_child_of_node(parent, child) \
  633. for (child = of_get_next_child(parent, NULL); child != NULL; \
  634. child = of_get_next_child(parent, child))
  635. #define for_each_available_child_of_node(parent, child) \
  636. for (child = of_get_next_available_child(parent, NULL); child != NULL; \
  637. child = of_get_next_available_child(parent, child))
  638. #define for_each_node_with_property(dn, prop_name) \
  639. for (dn = of_find_node_with_property(NULL, prop_name); dn; \
  640. dn = of_find_node_with_property(dn, prop_name))
  641. static inline int of_get_child_count(const struct device_node *np)
  642. {
  643. struct device_node *child;
  644. int num = 0;
  645. for_each_child_of_node(np, child)
  646. num++;
  647. return num;
  648. }
  649. static inline int of_get_available_child_count(const struct device_node *np)
  650. {
  651. struct device_node *child;
  652. int num = 0;
  653. for_each_available_child_of_node(np, child)
  654. num++;
  655. return num;
  656. }
  657. #ifdef CONFIG_OF
  658. #define _OF_DECLARE(table, name, compat, fn, fn_type) \
  659. static const struct of_device_id __of_table_##name \
  660. __used __section(__##table##_of_table) \
  661. = { .compatible = compat, \
  662. .data = (fn == (fn_type)NULL) ? fn : fn }
  663. #else
  664. #define _OF_DECLARE(table, name, compat, fn, fn_type) \
  665. static const struct of_device_id __of_table_##name \
  666. __attribute__((unused)) \
  667. = { .compatible = compat, \
  668. .data = (fn == (fn_type)NULL) ? fn : fn }
  669. #endif
  670. typedef int (*of_init_fn_2)(struct device_node *, struct device_node *);
  671. typedef void (*of_init_fn_1)(struct device_node *);
  672. #define OF_DECLARE_1(table, name, compat, fn) \
  673. _OF_DECLARE(table, name, compat, fn, of_init_fn_1)
  674. #define OF_DECLARE_2(table, name, compat, fn) \
  675. _OF_DECLARE(table, name, compat, fn, of_init_fn_2)
  676. /**
  677. * struct of_changeset_entry - Holds a changeset entry
  678. *
  679. * @node: list_head for the log list
  680. * @action: notifier action
  681. * @np: pointer to the device node affected
  682. * @prop: pointer to the property affected
  683. * @old_prop: hold a pointer to the original property
  684. *
  685. * Every modification of the device tree during a changeset
  686. * is held in a list of of_changeset_entry structures.
  687. * That way we can recover from a partial application, or we can
  688. * revert the changeset
  689. */
  690. struct of_changeset_entry {
  691. struct list_head node;
  692. unsigned long action;
  693. struct device_node *np;
  694. struct property *prop;
  695. struct property *old_prop;
  696. };
  697. /**
  698. * struct of_changeset - changeset tracker structure
  699. *
  700. * @entries: list_head for the changeset entries
  701. *
  702. * changesets are a convenient way to apply bulk changes to the
  703. * live tree. In case of an error, changes are rolled-back.
  704. * changesets live on after initial application, and if not
  705. * destroyed after use, they can be reverted in one single call.
  706. */
  707. struct of_changeset {
  708. struct list_head entries;
  709. };
  710. #ifdef CONFIG_OF_DYNAMIC
  711. extern void of_changeset_init(struct of_changeset *ocs);
  712. extern void of_changeset_destroy(struct of_changeset *ocs);
  713. extern int of_changeset_apply(struct of_changeset *ocs);
  714. extern int of_changeset_revert(struct of_changeset *ocs);
  715. extern int of_changeset_action(struct of_changeset *ocs,
  716. unsigned long action, struct device_node *np,
  717. struct property *prop);
  718. static inline int of_changeset_attach_node(struct of_changeset *ocs,
  719. struct device_node *np)
  720. {
  721. return of_changeset_action(ocs, OF_RECONFIG_ATTACH_NODE, np, NULL);
  722. }
  723. static inline int of_changeset_detach_node(struct of_changeset *ocs,
  724. struct device_node *np)
  725. {
  726. return of_changeset_action(ocs, OF_RECONFIG_DETACH_NODE, np, NULL);
  727. }
  728. static inline int of_changeset_add_property(struct of_changeset *ocs,
  729. struct device_node *np, struct property *prop)
  730. {
  731. return of_changeset_action(ocs, OF_RECONFIG_ADD_PROPERTY, np, prop);
  732. }
  733. static inline int of_changeset_remove_property(struct of_changeset *ocs,
  734. struct device_node *np, struct property *prop)
  735. {
  736. return of_changeset_action(ocs, OF_RECONFIG_REMOVE_PROPERTY, np, prop);
  737. }
  738. static inline int of_changeset_update_property(struct of_changeset *ocs,
  739. struct device_node *np, struct property *prop)
  740. {
  741. return of_changeset_action(ocs, OF_RECONFIG_UPDATE_PROPERTY, np, prop);
  742. }
  743. #endif
  744. /* CONFIG_OF_RESOLVE api */
  745. extern int of_resolve_phandles(struct device_node *tree);
  746. /**
  747. * of_device_is_system_power_controller - Tells if system-power-controller is found for device_node
  748. * @np: Pointer to the given device_node
  749. *
  750. * return true if present false otherwise
  751. */
  752. static inline bool of_device_is_system_power_controller(const struct device_node *np)
  753. {
  754. return of_property_read_bool(np, "system-power-controller");
  755. }
  756. #endif /* _LINUX_OF_H */