base.c 29 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140
  1. /*
  2. * Procedures for creating, accessing and interpreting the device tree.
  3. *
  4. * Paul Mackerras August 1996.
  5. * Copyright (C) 1996-2005 Paul Mackerras.
  6. *
  7. * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
  8. * {engebret|bergner}@us.ibm.com
  9. *
  10. * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
  11. *
  12. * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
  13. * Grant Likely.
  14. *
  15. * This program is free software; you can redistribute it and/or
  16. * modify it under the terms of the GNU General Public License
  17. * as published by the Free Software Foundation; either version
  18. * 2 of the License, or (at your option) any later version.
  19. */
  20. #include <linux/ctype.h>
  21. #include <linux/module.h>
  22. #include <linux/of.h>
  23. #include <linux/spinlock.h>
  24. #include <linux/slab.h>
  25. #include <linux/proc_fs.h>
  26. /**
  27. * struct alias_prop - Alias property in 'aliases' node
  28. * @link: List node to link the structure in aliases_lookup list
  29. * @alias: Alias property name
  30. * @np: Pointer to device_node that the alias stands for
  31. * @id: Index value from end of alias name
  32. * @stem: Alias string without the index
  33. *
  34. * The structure represents one alias property of 'aliases' node as
  35. * an entry in aliases_lookup list.
  36. */
  37. struct alias_prop {
  38. struct list_head link;
  39. const char *alias;
  40. struct device_node *np;
  41. int id;
  42. char stem[0];
  43. };
  44. static LIST_HEAD(aliases_lookup);
  45. struct device_node *allnodes;
  46. struct device_node *of_chosen;
  47. struct device_node *of_aliases;
  48. static DEFINE_MUTEX(of_aliases_mutex);
  49. /* use when traversing tree through the allnext, child, sibling,
  50. * or parent members of struct device_node.
  51. */
  52. DEFINE_RWLOCK(devtree_lock);
  53. int of_n_addr_cells(struct device_node *np)
  54. {
  55. const __be32 *ip;
  56. do {
  57. if (np->parent)
  58. np = np->parent;
  59. ip = of_get_property(np, "#address-cells", NULL);
  60. if (ip)
  61. return be32_to_cpup(ip);
  62. } while (np->parent);
  63. /* No #address-cells property for the root node */
  64. return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
  65. }
  66. EXPORT_SYMBOL(of_n_addr_cells);
  67. int of_n_size_cells(struct device_node *np)
  68. {
  69. const __be32 *ip;
  70. do {
  71. if (np->parent)
  72. np = np->parent;
  73. ip = of_get_property(np, "#size-cells", NULL);
  74. if (ip)
  75. return be32_to_cpup(ip);
  76. } while (np->parent);
  77. /* No #size-cells property for the root node */
  78. return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
  79. }
  80. EXPORT_SYMBOL(of_n_size_cells);
  81. #if !defined(CONFIG_SPARC) /* SPARC doesn't do ref counting (yet) */
  82. /**
  83. * of_node_get - Increment refcount of a node
  84. * @node: Node to inc refcount, NULL is supported to
  85. * simplify writing of callers
  86. *
  87. * Returns node.
  88. */
  89. struct device_node *of_node_get(struct device_node *node)
  90. {
  91. if (node)
  92. kref_get(&node->kref);
  93. return node;
  94. }
  95. EXPORT_SYMBOL(of_node_get);
  96. static inline struct device_node *kref_to_device_node(struct kref *kref)
  97. {
  98. return container_of(kref, struct device_node, kref);
  99. }
  100. /**
  101. * of_node_release - release a dynamically allocated node
  102. * @kref: kref element of the node to be released
  103. *
  104. * In of_node_put() this function is passed to kref_put()
  105. * as the destructor.
  106. */
  107. static void of_node_release(struct kref *kref)
  108. {
  109. struct device_node *node = kref_to_device_node(kref);
  110. struct property *prop = node->properties;
  111. /* We should never be releasing nodes that haven't been detached. */
  112. if (!of_node_check_flag(node, OF_DETACHED)) {
  113. pr_err("ERROR: Bad of_node_put() on %s\n", node->full_name);
  114. dump_stack();
  115. kref_init(&node->kref);
  116. return;
  117. }
  118. if (!of_node_check_flag(node, OF_DYNAMIC))
  119. return;
  120. while (prop) {
  121. struct property *next = prop->next;
  122. kfree(prop->name);
  123. kfree(prop->value);
  124. kfree(prop);
  125. prop = next;
  126. if (!prop) {
  127. prop = node->deadprops;
  128. node->deadprops = NULL;
  129. }
  130. }
  131. kfree(node->full_name);
  132. kfree(node->data);
  133. kfree(node);
  134. }
  135. /**
  136. * of_node_put - Decrement refcount of a node
  137. * @node: Node to dec refcount, NULL is supported to
  138. * simplify writing of callers
  139. *
  140. */
  141. void of_node_put(struct device_node *node)
  142. {
  143. if (node)
  144. kref_put(&node->kref, of_node_release);
  145. }
  146. EXPORT_SYMBOL(of_node_put);
  147. #endif /* !CONFIG_SPARC */
  148. struct property *of_find_property(const struct device_node *np,
  149. const char *name,
  150. int *lenp)
  151. {
  152. struct property *pp;
  153. if (!np)
  154. return NULL;
  155. read_lock(&devtree_lock);
  156. for (pp = np->properties; pp != 0; pp = pp->next) {
  157. if (of_prop_cmp(pp->name, name) == 0) {
  158. if (lenp != 0)
  159. *lenp = pp->length;
  160. break;
  161. }
  162. }
  163. read_unlock(&devtree_lock);
  164. return pp;
  165. }
  166. EXPORT_SYMBOL(of_find_property);
  167. /**
  168. * of_find_all_nodes - Get next node in global list
  169. * @prev: Previous node or NULL to start iteration
  170. * of_node_put() will be called on it
  171. *
  172. * Returns a node pointer with refcount incremented, use
  173. * of_node_put() on it when done.
  174. */
  175. struct device_node *of_find_all_nodes(struct device_node *prev)
  176. {
  177. struct device_node *np;
  178. read_lock(&devtree_lock);
  179. np = prev ? prev->allnext : allnodes;
  180. for (; np != NULL; np = np->allnext)
  181. if (of_node_get(np))
  182. break;
  183. of_node_put(prev);
  184. read_unlock(&devtree_lock);
  185. return np;
  186. }
  187. EXPORT_SYMBOL(of_find_all_nodes);
  188. /*
  189. * Find a property with a given name for a given node
  190. * and return the value.
  191. */
  192. const void *of_get_property(const struct device_node *np, const char *name,
  193. int *lenp)
  194. {
  195. struct property *pp = of_find_property(np, name, lenp);
  196. return pp ? pp->value : NULL;
  197. }
  198. EXPORT_SYMBOL(of_get_property);
  199. /** Checks if the given "compat" string matches one of the strings in
  200. * the device's "compatible" property
  201. */
  202. int of_device_is_compatible(const struct device_node *device,
  203. const char *compat)
  204. {
  205. const char* cp;
  206. int cplen, l;
  207. cp = of_get_property(device, "compatible", &cplen);
  208. if (cp == NULL)
  209. return 0;
  210. while (cplen > 0) {
  211. if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
  212. return 1;
  213. l = strlen(cp) + 1;
  214. cp += l;
  215. cplen -= l;
  216. }
  217. return 0;
  218. }
  219. EXPORT_SYMBOL(of_device_is_compatible);
  220. /**
  221. * of_machine_is_compatible - Test root of device tree for a given compatible value
  222. * @compat: compatible string to look for in root node's compatible property.
  223. *
  224. * Returns true if the root node has the given value in its
  225. * compatible property.
  226. */
  227. int of_machine_is_compatible(const char *compat)
  228. {
  229. struct device_node *root;
  230. int rc = 0;
  231. root = of_find_node_by_path("/");
  232. if (root) {
  233. rc = of_device_is_compatible(root, compat);
  234. of_node_put(root);
  235. }
  236. return rc;
  237. }
  238. EXPORT_SYMBOL(of_machine_is_compatible);
  239. /**
  240. * of_device_is_available - check if a device is available for use
  241. *
  242. * @device: Node to check for availability
  243. *
  244. * Returns 1 if the status property is absent or set to "okay" or "ok",
  245. * 0 otherwise
  246. */
  247. int of_device_is_available(const struct device_node *device)
  248. {
  249. const char *status;
  250. int statlen;
  251. status = of_get_property(device, "status", &statlen);
  252. if (status == NULL)
  253. return 1;
  254. if (statlen > 0) {
  255. if (!strcmp(status, "okay") || !strcmp(status, "ok"))
  256. return 1;
  257. }
  258. return 0;
  259. }
  260. EXPORT_SYMBOL(of_device_is_available);
  261. /**
  262. * of_get_parent - Get a node's parent if any
  263. * @node: Node to get parent
  264. *
  265. * Returns a node pointer with refcount incremented, use
  266. * of_node_put() on it when done.
  267. */
  268. struct device_node *of_get_parent(const struct device_node *node)
  269. {
  270. struct device_node *np;
  271. if (!node)
  272. return NULL;
  273. read_lock(&devtree_lock);
  274. np = of_node_get(node->parent);
  275. read_unlock(&devtree_lock);
  276. return np;
  277. }
  278. EXPORT_SYMBOL(of_get_parent);
  279. /**
  280. * of_get_next_parent - Iterate to a node's parent
  281. * @node: Node to get parent of
  282. *
  283. * This is like of_get_parent() except that it drops the
  284. * refcount on the passed node, making it suitable for iterating
  285. * through a node's parents.
  286. *
  287. * Returns a node pointer with refcount incremented, use
  288. * of_node_put() on it when done.
  289. */
  290. struct device_node *of_get_next_parent(struct device_node *node)
  291. {
  292. struct device_node *parent;
  293. if (!node)
  294. return NULL;
  295. read_lock(&devtree_lock);
  296. parent = of_node_get(node->parent);
  297. of_node_put(node);
  298. read_unlock(&devtree_lock);
  299. return parent;
  300. }
  301. /**
  302. * of_get_next_child - Iterate a node childs
  303. * @node: parent node
  304. * @prev: previous child of the parent node, or NULL to get first
  305. *
  306. * Returns a node pointer with refcount incremented, use
  307. * of_node_put() on it when done.
  308. */
  309. struct device_node *of_get_next_child(const struct device_node *node,
  310. struct device_node *prev)
  311. {
  312. struct device_node *next;
  313. read_lock(&devtree_lock);
  314. next = prev ? prev->sibling : node->child;
  315. for (; next; next = next->sibling)
  316. if (of_node_get(next))
  317. break;
  318. of_node_put(prev);
  319. read_unlock(&devtree_lock);
  320. return next;
  321. }
  322. EXPORT_SYMBOL(of_get_next_child);
  323. /**
  324. * of_find_node_by_path - Find a node matching a full OF path
  325. * @path: The full path to match
  326. *
  327. * Returns a node pointer with refcount incremented, use
  328. * of_node_put() on it when done.
  329. */
  330. struct device_node *of_find_node_by_path(const char *path)
  331. {
  332. struct device_node *np = allnodes;
  333. read_lock(&devtree_lock);
  334. for (; np; np = np->allnext) {
  335. if (np->full_name && (of_node_cmp(np->full_name, path) == 0)
  336. && of_node_get(np))
  337. break;
  338. }
  339. read_unlock(&devtree_lock);
  340. return np;
  341. }
  342. EXPORT_SYMBOL(of_find_node_by_path);
  343. /**
  344. * of_find_node_by_name - Find a node by its "name" property
  345. * @from: The node to start searching from or NULL, the node
  346. * you pass will not be searched, only the next one
  347. * will; typically, you pass what the previous call
  348. * returned. of_node_put() will be called on it
  349. * @name: The name string to match against
  350. *
  351. * Returns a node pointer with refcount incremented, use
  352. * of_node_put() on it when done.
  353. */
  354. struct device_node *of_find_node_by_name(struct device_node *from,
  355. const char *name)
  356. {
  357. struct device_node *np;
  358. read_lock(&devtree_lock);
  359. np = from ? from->allnext : allnodes;
  360. for (; np; np = np->allnext)
  361. if (np->name && (of_node_cmp(np->name, name) == 0)
  362. && of_node_get(np))
  363. break;
  364. of_node_put(from);
  365. read_unlock(&devtree_lock);
  366. return np;
  367. }
  368. EXPORT_SYMBOL(of_find_node_by_name);
  369. /**
  370. * of_find_node_by_type - Find a node by its "device_type" property
  371. * @from: The node to start searching from, or NULL to start searching
  372. * the entire device tree. The node you pass will not be
  373. * searched, only the next one will; typically, you pass
  374. * what the previous call returned. of_node_put() will be
  375. * called on from for you.
  376. * @type: The type string to match against
  377. *
  378. * Returns a node pointer with refcount incremented, use
  379. * of_node_put() on it when done.
  380. */
  381. struct device_node *of_find_node_by_type(struct device_node *from,
  382. const char *type)
  383. {
  384. struct device_node *np;
  385. read_lock(&devtree_lock);
  386. np = from ? from->allnext : allnodes;
  387. for (; np; np = np->allnext)
  388. if (np->type && (of_node_cmp(np->type, type) == 0)
  389. && of_node_get(np))
  390. break;
  391. of_node_put(from);
  392. read_unlock(&devtree_lock);
  393. return np;
  394. }
  395. EXPORT_SYMBOL(of_find_node_by_type);
  396. /**
  397. * of_find_compatible_node - Find a node based on type and one of the
  398. * tokens in its "compatible" property
  399. * @from: The node to start searching from or NULL, the node
  400. * you pass will not be searched, only the next one
  401. * will; typically, you pass what the previous call
  402. * returned. of_node_put() will be called on it
  403. * @type: The type string to match "device_type" or NULL to ignore
  404. * @compatible: The string to match to one of the tokens in the device
  405. * "compatible" list.
  406. *
  407. * Returns a node pointer with refcount incremented, use
  408. * of_node_put() on it when done.
  409. */
  410. struct device_node *of_find_compatible_node(struct device_node *from,
  411. const char *type, const char *compatible)
  412. {
  413. struct device_node *np;
  414. read_lock(&devtree_lock);
  415. np = from ? from->allnext : allnodes;
  416. for (; np; np = np->allnext) {
  417. if (type
  418. && !(np->type && (of_node_cmp(np->type, type) == 0)))
  419. continue;
  420. if (of_device_is_compatible(np, compatible) && of_node_get(np))
  421. break;
  422. }
  423. of_node_put(from);
  424. read_unlock(&devtree_lock);
  425. return np;
  426. }
  427. EXPORT_SYMBOL(of_find_compatible_node);
  428. /**
  429. * of_find_node_with_property - Find a node which has a property with
  430. * the given name.
  431. * @from: The node to start searching from or NULL, the node
  432. * you pass will not be searched, only the next one
  433. * will; typically, you pass what the previous call
  434. * returned. of_node_put() will be called on it
  435. * @prop_name: The name of the property to look for.
  436. *
  437. * Returns a node pointer with refcount incremented, use
  438. * of_node_put() on it when done.
  439. */
  440. struct device_node *of_find_node_with_property(struct device_node *from,
  441. const char *prop_name)
  442. {
  443. struct device_node *np;
  444. struct property *pp;
  445. read_lock(&devtree_lock);
  446. np = from ? from->allnext : allnodes;
  447. for (; np; np = np->allnext) {
  448. for (pp = np->properties; pp != 0; pp = pp->next) {
  449. if (of_prop_cmp(pp->name, prop_name) == 0) {
  450. of_node_get(np);
  451. goto out;
  452. }
  453. }
  454. }
  455. out:
  456. of_node_put(from);
  457. read_unlock(&devtree_lock);
  458. return np;
  459. }
  460. EXPORT_SYMBOL(of_find_node_with_property);
  461. /**
  462. * of_match_node - Tell if an device_node has a matching of_match structure
  463. * @matches: array of of device match structures to search in
  464. * @node: the of device structure to match against
  465. *
  466. * Low level utility function used by device matching.
  467. */
  468. const struct of_device_id *of_match_node(const struct of_device_id *matches,
  469. const struct device_node *node)
  470. {
  471. if (!matches)
  472. return NULL;
  473. while (matches->name[0] || matches->type[0] || matches->compatible[0]) {
  474. int match = 1;
  475. if (matches->name[0])
  476. match &= node->name
  477. && !strcmp(matches->name, node->name);
  478. if (matches->type[0])
  479. match &= node->type
  480. && !strcmp(matches->type, node->type);
  481. if (matches->compatible[0])
  482. match &= of_device_is_compatible(node,
  483. matches->compatible);
  484. if (match)
  485. return matches;
  486. matches++;
  487. }
  488. return NULL;
  489. }
  490. EXPORT_SYMBOL(of_match_node);
  491. /**
  492. * of_find_matching_node - Find a node based on an of_device_id match
  493. * table.
  494. * @from: The node to start searching from or NULL, the node
  495. * you pass will not be searched, only the next one
  496. * will; typically, you pass what the previous call
  497. * returned. of_node_put() will be called on it
  498. * @matches: array of of device match structures to search in
  499. *
  500. * Returns a node pointer with refcount incremented, use
  501. * of_node_put() on it when done.
  502. */
  503. struct device_node *of_find_matching_node(struct device_node *from,
  504. const struct of_device_id *matches)
  505. {
  506. struct device_node *np;
  507. read_lock(&devtree_lock);
  508. np = from ? from->allnext : allnodes;
  509. for (; np; np = np->allnext) {
  510. if (of_match_node(matches, np) && of_node_get(np))
  511. break;
  512. }
  513. of_node_put(from);
  514. read_unlock(&devtree_lock);
  515. return np;
  516. }
  517. EXPORT_SYMBOL(of_find_matching_node);
  518. /**
  519. * of_modalias_node - Lookup appropriate modalias for a device node
  520. * @node: pointer to a device tree node
  521. * @modalias: Pointer to buffer that modalias value will be copied into
  522. * @len: Length of modalias value
  523. *
  524. * Based on the value of the compatible property, this routine will attempt
  525. * to choose an appropriate modalias value for a particular device tree node.
  526. * It does this by stripping the manufacturer prefix (as delimited by a ',')
  527. * from the first entry in the compatible list property.
  528. *
  529. * This routine returns 0 on success, <0 on failure.
  530. */
  531. int of_modalias_node(struct device_node *node, char *modalias, int len)
  532. {
  533. const char *compatible, *p;
  534. int cplen;
  535. compatible = of_get_property(node, "compatible", &cplen);
  536. if (!compatible || strlen(compatible) > cplen)
  537. return -ENODEV;
  538. p = strchr(compatible, ',');
  539. strlcpy(modalias, p ? p + 1 : compatible, len);
  540. return 0;
  541. }
  542. EXPORT_SYMBOL_GPL(of_modalias_node);
  543. /**
  544. * of_find_node_by_phandle - Find a node given a phandle
  545. * @handle: phandle of the node to find
  546. *
  547. * Returns a node pointer with refcount incremented, use
  548. * of_node_put() on it when done.
  549. */
  550. struct device_node *of_find_node_by_phandle(phandle handle)
  551. {
  552. struct device_node *np;
  553. read_lock(&devtree_lock);
  554. for (np = allnodes; np; np = np->allnext)
  555. if (np->phandle == handle)
  556. break;
  557. of_node_get(np);
  558. read_unlock(&devtree_lock);
  559. return np;
  560. }
  561. EXPORT_SYMBOL(of_find_node_by_phandle);
  562. /**
  563. * of_property_read_u32_array - Find and read an array of 32 bit integers
  564. * from a property.
  565. *
  566. * @np: device node from which the property value is to be read.
  567. * @propname: name of the property to be searched.
  568. * @out_value: pointer to return value, modified only if return value is 0.
  569. *
  570. * Search for a property in a device node and read 32-bit value(s) from
  571. * it. Returns 0 on success, -EINVAL if the property does not exist,
  572. * -ENODATA if property does not have a value, and -EOVERFLOW if the
  573. * property data isn't large enough.
  574. *
  575. * The out_value is modified only if a valid u32 value can be decoded.
  576. */
  577. int of_property_read_u32_array(const struct device_node *np,
  578. const char *propname, u32 *out_values,
  579. size_t sz)
  580. {
  581. struct property *prop = of_find_property(np, propname, NULL);
  582. const __be32 *val;
  583. if (!prop)
  584. return -EINVAL;
  585. if (!prop->value)
  586. return -ENODATA;
  587. if ((sz * sizeof(*out_values)) > prop->length)
  588. return -EOVERFLOW;
  589. val = prop->value;
  590. while (sz--)
  591. *out_values++ = be32_to_cpup(val++);
  592. return 0;
  593. }
  594. EXPORT_SYMBOL_GPL(of_property_read_u32_array);
  595. /**
  596. * of_property_read_u64 - Find and read a 64 bit integer from a property
  597. * @np: device node from which the property value is to be read.
  598. * @propname: name of the property to be searched.
  599. * @out_value: pointer to return value, modified only if return value is 0.
  600. *
  601. * Search for a property in a device node and read a 64-bit value from
  602. * it. Returns 0 on success, -EINVAL if the property does not exist,
  603. * -ENODATA if property does not have a value, and -EOVERFLOW if the
  604. * property data isn't large enough.
  605. *
  606. * The out_value is modified only if a valid u64 value can be decoded.
  607. */
  608. int of_property_read_u64(const struct device_node *np, const char *propname,
  609. u64 *out_value)
  610. {
  611. struct property *prop = of_find_property(np, propname, NULL);
  612. if (!prop)
  613. return -EINVAL;
  614. if (!prop->value)
  615. return -ENODATA;
  616. if (sizeof(*out_value) > prop->length)
  617. return -EOVERFLOW;
  618. *out_value = of_read_number(prop->value, 2);
  619. return 0;
  620. }
  621. EXPORT_SYMBOL_GPL(of_property_read_u64);
  622. /**
  623. * of_property_read_string - Find and read a string from a property
  624. * @np: device node from which the property value is to be read.
  625. * @propname: name of the property to be searched.
  626. * @out_string: pointer to null terminated return string, modified only if
  627. * return value is 0.
  628. *
  629. * Search for a property in a device tree node and retrieve a null
  630. * terminated string value (pointer to data, not a copy). Returns 0 on
  631. * success, -EINVAL if the property does not exist, -ENODATA if property
  632. * does not have a value, and -EILSEQ if the string is not null-terminated
  633. * within the length of the property data.
  634. *
  635. * The out_string pointer is modified only if a valid string can be decoded.
  636. */
  637. int of_property_read_string(struct device_node *np, const char *propname,
  638. const char **out_string)
  639. {
  640. struct property *prop = of_find_property(np, propname, NULL);
  641. if (!prop)
  642. return -EINVAL;
  643. if (!prop->value)
  644. return -ENODATA;
  645. if (strnlen(prop->value, prop->length) >= prop->length)
  646. return -EILSEQ;
  647. *out_string = prop->value;
  648. return 0;
  649. }
  650. EXPORT_SYMBOL_GPL(of_property_read_string);
  651. /**
  652. * of_parse_phandle - Resolve a phandle property to a device_node pointer
  653. * @np: Pointer to device node holding phandle property
  654. * @phandle_name: Name of property holding a phandle value
  655. * @index: For properties holding a table of phandles, this is the index into
  656. * the table
  657. *
  658. * Returns the device_node pointer with refcount incremented. Use
  659. * of_node_put() on it when done.
  660. */
  661. struct device_node *
  662. of_parse_phandle(struct device_node *np, const char *phandle_name, int index)
  663. {
  664. const __be32 *phandle;
  665. int size;
  666. phandle = of_get_property(np, phandle_name, &size);
  667. if ((!phandle) || (size < sizeof(*phandle) * (index + 1)))
  668. return NULL;
  669. return of_find_node_by_phandle(be32_to_cpup(phandle + index));
  670. }
  671. EXPORT_SYMBOL(of_parse_phandle);
  672. /**
  673. * of_parse_phandles_with_args - Find a node pointed by phandle in a list
  674. * @np: pointer to a device tree node containing a list
  675. * @list_name: property name that contains a list
  676. * @cells_name: property name that specifies phandles' arguments count
  677. * @index: index of a phandle to parse out
  678. * @out_node: optional pointer to device_node struct pointer (will be filled)
  679. * @out_args: optional pointer to arguments pointer (will be filled)
  680. *
  681. * This function is useful to parse lists of phandles and their arguments.
  682. * Returns 0 on success and fills out_node and out_args, on error returns
  683. * appropriate errno value.
  684. *
  685. * Example:
  686. *
  687. * phandle1: node1 {
  688. * #list-cells = <2>;
  689. * }
  690. *
  691. * phandle2: node2 {
  692. * #list-cells = <1>;
  693. * }
  694. *
  695. * node3 {
  696. * list = <&phandle1 1 2 &phandle2 3>;
  697. * }
  698. *
  699. * To get a device_node of the `node2' node you may call this:
  700. * of_parse_phandles_with_args(node3, "list", "#list-cells", 2, &node2, &args);
  701. */
  702. int of_parse_phandles_with_args(struct device_node *np, const char *list_name,
  703. const char *cells_name, int index,
  704. struct device_node **out_node,
  705. const void **out_args)
  706. {
  707. int ret = -EINVAL;
  708. const __be32 *list;
  709. const __be32 *list_end;
  710. int size;
  711. int cur_index = 0;
  712. struct device_node *node = NULL;
  713. const void *args = NULL;
  714. list = of_get_property(np, list_name, &size);
  715. if (!list) {
  716. ret = -ENOENT;
  717. goto err0;
  718. }
  719. list_end = list + size / sizeof(*list);
  720. while (list < list_end) {
  721. const __be32 *cells;
  722. phandle phandle;
  723. phandle = be32_to_cpup(list++);
  724. args = list;
  725. /* one cell hole in the list = <>; */
  726. if (!phandle)
  727. goto next;
  728. node = of_find_node_by_phandle(phandle);
  729. if (!node) {
  730. pr_debug("%s: could not find phandle\n",
  731. np->full_name);
  732. goto err0;
  733. }
  734. cells = of_get_property(node, cells_name, &size);
  735. if (!cells || size != sizeof(*cells)) {
  736. pr_debug("%s: could not get %s for %s\n",
  737. np->full_name, cells_name, node->full_name);
  738. goto err1;
  739. }
  740. list += be32_to_cpup(cells);
  741. if (list > list_end) {
  742. pr_debug("%s: insufficient arguments length\n",
  743. np->full_name);
  744. goto err1;
  745. }
  746. next:
  747. if (cur_index == index)
  748. break;
  749. of_node_put(node);
  750. node = NULL;
  751. args = NULL;
  752. cur_index++;
  753. }
  754. if (!node) {
  755. /*
  756. * args w/o node indicates that the loop above has stopped at
  757. * the 'hole' cell. Report this differently.
  758. */
  759. if (args)
  760. ret = -EEXIST;
  761. else
  762. ret = -ENOENT;
  763. goto err0;
  764. }
  765. if (out_node)
  766. *out_node = node;
  767. if (out_args)
  768. *out_args = args;
  769. return 0;
  770. err1:
  771. of_node_put(node);
  772. err0:
  773. pr_debug("%s failed with status %d\n", __func__, ret);
  774. return ret;
  775. }
  776. EXPORT_SYMBOL(of_parse_phandles_with_args);
  777. /**
  778. * prom_add_property - Add a property to a node
  779. */
  780. int prom_add_property(struct device_node *np, struct property *prop)
  781. {
  782. struct property **next;
  783. unsigned long flags;
  784. prop->next = NULL;
  785. write_lock_irqsave(&devtree_lock, flags);
  786. next = &np->properties;
  787. while (*next) {
  788. if (strcmp(prop->name, (*next)->name) == 0) {
  789. /* duplicate ! don't insert it */
  790. write_unlock_irqrestore(&devtree_lock, flags);
  791. return -1;
  792. }
  793. next = &(*next)->next;
  794. }
  795. *next = prop;
  796. write_unlock_irqrestore(&devtree_lock, flags);
  797. #ifdef CONFIG_PROC_DEVICETREE
  798. /* try to add to proc as well if it was initialized */
  799. if (np->pde)
  800. proc_device_tree_add_prop(np->pde, prop);
  801. #endif /* CONFIG_PROC_DEVICETREE */
  802. return 0;
  803. }
  804. /**
  805. * prom_remove_property - Remove a property from a node.
  806. *
  807. * Note that we don't actually remove it, since we have given out
  808. * who-knows-how-many pointers to the data using get-property.
  809. * Instead we just move the property to the "dead properties"
  810. * list, so it won't be found any more.
  811. */
  812. int prom_remove_property(struct device_node *np, struct property *prop)
  813. {
  814. struct property **next;
  815. unsigned long flags;
  816. int found = 0;
  817. write_lock_irqsave(&devtree_lock, flags);
  818. next = &np->properties;
  819. while (*next) {
  820. if (*next == prop) {
  821. /* found the node */
  822. *next = prop->next;
  823. prop->next = np->deadprops;
  824. np->deadprops = prop;
  825. found = 1;
  826. break;
  827. }
  828. next = &(*next)->next;
  829. }
  830. write_unlock_irqrestore(&devtree_lock, flags);
  831. if (!found)
  832. return -ENODEV;
  833. #ifdef CONFIG_PROC_DEVICETREE
  834. /* try to remove the proc node as well */
  835. if (np->pde)
  836. proc_device_tree_remove_prop(np->pde, prop);
  837. #endif /* CONFIG_PROC_DEVICETREE */
  838. return 0;
  839. }
  840. /*
  841. * prom_update_property - Update a property in a node.
  842. *
  843. * Note that we don't actually remove it, since we have given out
  844. * who-knows-how-many pointers to the data using get-property.
  845. * Instead we just move the property to the "dead properties" list,
  846. * and add the new property to the property list
  847. */
  848. int prom_update_property(struct device_node *np,
  849. struct property *newprop,
  850. struct property *oldprop)
  851. {
  852. struct property **next;
  853. unsigned long flags;
  854. int found = 0;
  855. write_lock_irqsave(&devtree_lock, flags);
  856. next = &np->properties;
  857. while (*next) {
  858. if (*next == oldprop) {
  859. /* found the node */
  860. newprop->next = oldprop->next;
  861. *next = newprop;
  862. oldprop->next = np->deadprops;
  863. np->deadprops = oldprop;
  864. found = 1;
  865. break;
  866. }
  867. next = &(*next)->next;
  868. }
  869. write_unlock_irqrestore(&devtree_lock, flags);
  870. if (!found)
  871. return -ENODEV;
  872. #ifdef CONFIG_PROC_DEVICETREE
  873. /* try to add to proc as well if it was initialized */
  874. if (np->pde)
  875. proc_device_tree_update_prop(np->pde, newprop, oldprop);
  876. #endif /* CONFIG_PROC_DEVICETREE */
  877. return 0;
  878. }
  879. #if defined(CONFIG_OF_DYNAMIC)
  880. /*
  881. * Support for dynamic device trees.
  882. *
  883. * On some platforms, the device tree can be manipulated at runtime.
  884. * The routines in this section support adding, removing and changing
  885. * device tree nodes.
  886. */
  887. /**
  888. * of_attach_node - Plug a device node into the tree and global list.
  889. */
  890. void of_attach_node(struct device_node *np)
  891. {
  892. unsigned long flags;
  893. write_lock_irqsave(&devtree_lock, flags);
  894. np->sibling = np->parent->child;
  895. np->allnext = allnodes;
  896. np->parent->child = np;
  897. allnodes = np;
  898. write_unlock_irqrestore(&devtree_lock, flags);
  899. }
  900. /**
  901. * of_detach_node - "Unplug" a node from the device tree.
  902. *
  903. * The caller must hold a reference to the node. The memory associated with
  904. * the node is not freed until its refcount goes to zero.
  905. */
  906. void of_detach_node(struct device_node *np)
  907. {
  908. struct device_node *parent;
  909. unsigned long flags;
  910. write_lock_irqsave(&devtree_lock, flags);
  911. parent = np->parent;
  912. if (!parent)
  913. goto out_unlock;
  914. if (allnodes == np)
  915. allnodes = np->allnext;
  916. else {
  917. struct device_node *prev;
  918. for (prev = allnodes;
  919. prev->allnext != np;
  920. prev = prev->allnext)
  921. ;
  922. prev->allnext = np->allnext;
  923. }
  924. if (parent->child == np)
  925. parent->child = np->sibling;
  926. else {
  927. struct device_node *prevsib;
  928. for (prevsib = np->parent->child;
  929. prevsib->sibling != np;
  930. prevsib = prevsib->sibling)
  931. ;
  932. prevsib->sibling = np->sibling;
  933. }
  934. of_node_set_flag(np, OF_DETACHED);
  935. out_unlock:
  936. write_unlock_irqrestore(&devtree_lock, flags);
  937. }
  938. #endif /* defined(CONFIG_OF_DYNAMIC) */
  939. static void of_alias_add(struct alias_prop *ap, struct device_node *np,
  940. int id, const char *stem, int stem_len)
  941. {
  942. ap->np = np;
  943. ap->id = id;
  944. strncpy(ap->stem, stem, stem_len);
  945. ap->stem[stem_len] = 0;
  946. list_add_tail(&ap->link, &aliases_lookup);
  947. pr_debug("adding DT alias:%s: stem=%s id=%i node=%s\n",
  948. ap->alias, ap->stem, ap->id, np ? np->full_name : NULL);
  949. }
  950. /**
  951. * of_alias_scan - Scan all properties of 'aliases' node
  952. *
  953. * The function scans all the properties of 'aliases' node and populate
  954. * the the global lookup table with the properties. It returns the
  955. * number of alias_prop found, or error code in error case.
  956. *
  957. * @dt_alloc: An allocator that provides a virtual address to memory
  958. * for the resulting tree
  959. */
  960. void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align))
  961. {
  962. struct property *pp;
  963. of_chosen = of_find_node_by_path("/chosen");
  964. if (of_chosen == NULL)
  965. of_chosen = of_find_node_by_path("/chosen@0");
  966. of_aliases = of_find_node_by_path("/aliases");
  967. if (!of_aliases)
  968. return;
  969. for_each_property(pp, of_aliases->properties) {
  970. const char *start = pp->name;
  971. const char *end = start + strlen(start);
  972. struct device_node *np;
  973. struct alias_prop *ap;
  974. int id, len;
  975. /* Skip those we do not want to proceed */
  976. if (!strcmp(pp->name, "name") ||
  977. !strcmp(pp->name, "phandle") ||
  978. !strcmp(pp->name, "linux,phandle"))
  979. continue;
  980. np = of_find_node_by_path(pp->value);
  981. if (!np)
  982. continue;
  983. /* walk the alias backwards to extract the id and work out
  984. * the 'stem' string */
  985. while (isdigit(*(end-1)) && end > start)
  986. end--;
  987. len = end - start;
  988. if (kstrtoint(end, 10, &id) < 0)
  989. continue;
  990. /* Allocate an alias_prop with enough space for the stem */
  991. ap = dt_alloc(sizeof(*ap) + len + 1, 4);
  992. if (!ap)
  993. continue;
  994. ap->alias = start;
  995. of_alias_add(ap, np, id, start, len);
  996. }
  997. }
  998. /**
  999. * of_alias_get_id - Get alias id for the given device_node
  1000. * @np: Pointer to the given device_node
  1001. * @stem: Alias stem of the given device_node
  1002. *
  1003. * The function travels the lookup table to get alias id for the given
  1004. * device_node and alias stem. It returns the alias id if find it.
  1005. */
  1006. int of_alias_get_id(struct device_node *np, const char *stem)
  1007. {
  1008. struct alias_prop *app;
  1009. int id = -ENODEV;
  1010. mutex_lock(&of_aliases_mutex);
  1011. list_for_each_entry(app, &aliases_lookup, link) {
  1012. if (strcmp(app->stem, stem) != 0)
  1013. continue;
  1014. if (np == app->np) {
  1015. id = app->id;
  1016. break;
  1017. }
  1018. }
  1019. mutex_unlock(&of_aliases_mutex);
  1020. return id;
  1021. }
  1022. EXPORT_SYMBOL_GPL(of_alias_get_id);