1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270 |
- /*
- * Procedures for creating, accessing and interpreting the device tree.
- *
- * Paul Mackerras August 1996.
- * Copyright (C) 1996-2005 Paul Mackerras.
- *
- * Adapted for 64bit PowerPC by Dave Engebretsen and Peter Bergner.
- * {engebret|bergner}@us.ibm.com
- *
- * Adapted for sparc and sparc64 by David S. Miller davem@davemloft.net
- *
- * Reconsolidated from arch/x/kernel/prom.c by Stephen Rothwell and
- * Grant Likely.
- *
- * This program is free software; you can redistribute it and/or
- * modify it under the terms of the GNU General Public License
- * as published by the Free Software Foundation; either version
- * 2 of the License, or (at your option) any later version.
- */
- #include <linux/ctype.h>
- #include <linux/module.h>
- #include <linux/of.h>
- #include <linux/spinlock.h>
- #include <linux/slab.h>
- #include <linux/proc_fs.h>
- #include "of_private.h"
- LIST_HEAD(aliases_lookup);
- struct device_node *allnodes;
- struct device_node *of_chosen;
- struct device_node *of_aliases;
- DEFINE_MUTEX(of_aliases_mutex);
- /* use when traversing tree through the allnext, child, sibling,
- * or parent members of struct device_node.
- */
- DEFINE_RWLOCK(devtree_lock);
- int of_n_addr_cells(struct device_node *np)
- {
- const __be32 *ip;
- do {
- if (np->parent)
- np = np->parent;
- ip = of_get_property(np, "#address-cells", NULL);
- if (ip)
- return be32_to_cpup(ip);
- } while (np->parent);
- /* No #address-cells property for the root node */
- return OF_ROOT_NODE_ADDR_CELLS_DEFAULT;
- }
- EXPORT_SYMBOL(of_n_addr_cells);
- int of_n_size_cells(struct device_node *np)
- {
- const __be32 *ip;
- do {
- if (np->parent)
- np = np->parent;
- ip = of_get_property(np, "#size-cells", NULL);
- if (ip)
- return be32_to_cpup(ip);
- } while (np->parent);
- /* No #size-cells property for the root node */
- return OF_ROOT_NODE_SIZE_CELLS_DEFAULT;
- }
- EXPORT_SYMBOL(of_n_size_cells);
- #if defined(CONFIG_OF_DYNAMIC)
- /**
- * of_node_get - Increment refcount of a node
- * @node: Node to inc refcount, NULL is supported to
- * simplify writing of callers
- *
- * Returns node.
- */
- struct device_node *of_node_get(struct device_node *node)
- {
- if (node)
- kref_get(&node->kref);
- return node;
- }
- EXPORT_SYMBOL(of_node_get);
- static inline struct device_node *kref_to_device_node(struct kref *kref)
- {
- return container_of(kref, struct device_node, kref);
- }
- /**
- * of_node_release - release a dynamically allocated node
- * @kref: kref element of the node to be released
- *
- * In of_node_put() this function is passed to kref_put()
- * as the destructor.
- */
- static void of_node_release(struct kref *kref)
- {
- struct device_node *node = kref_to_device_node(kref);
- struct property *prop = node->properties;
- /* We should never be releasing nodes that haven't been detached. */
- if (!of_node_check_flag(node, OF_DETACHED)) {
- pr_err("ERROR: Bad of_node_put() on %s\n", node->full_name);
- dump_stack();
- kref_init(&node->kref);
- return;
- }
- if (!of_node_check_flag(node, OF_DYNAMIC))
- return;
- while (prop) {
- struct property *next = prop->next;
- kfree(prop->name);
- kfree(prop->value);
- kfree(prop);
- prop = next;
- if (!prop) {
- prop = node->deadprops;
- node->deadprops = NULL;
- }
- }
- kfree(node->full_name);
- kfree(node->data);
- kfree(node);
- }
- /**
- * of_node_put - Decrement refcount of a node
- * @node: Node to dec refcount, NULL is supported to
- * simplify writing of callers
- *
- */
- void of_node_put(struct device_node *node)
- {
- if (node)
- kref_put(&node->kref, of_node_release);
- }
- EXPORT_SYMBOL(of_node_put);
- #endif /* CONFIG_OF_DYNAMIC */
- struct property *of_find_property(const struct device_node *np,
- const char *name,
- int *lenp)
- {
- struct property *pp;
- if (!np)
- return NULL;
- read_lock(&devtree_lock);
- for (pp = np->properties; pp != 0; pp = pp->next) {
- if (of_prop_cmp(pp->name, name) == 0) {
- if (lenp != 0)
- *lenp = pp->length;
- break;
- }
- }
- read_unlock(&devtree_lock);
- return pp;
- }
- EXPORT_SYMBOL(of_find_property);
- /**
- * of_find_all_nodes - Get next node in global list
- * @prev: Previous node or NULL to start iteration
- * of_node_put() will be called on it
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_all_nodes(struct device_node *prev)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- np = prev ? prev->allnext : allnodes;
- for (; np != NULL; np = np->allnext)
- if (of_node_get(np))
- break;
- of_node_put(prev);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_all_nodes);
- /*
- * Find a property with a given name for a given node
- * and return the value.
- */
- const void *of_get_property(const struct device_node *np, const char *name,
- int *lenp)
- {
- struct property *pp = of_find_property(np, name, lenp);
- return pp ? pp->value : NULL;
- }
- EXPORT_SYMBOL(of_get_property);
- /** Checks if the given "compat" string matches one of the strings in
- * the device's "compatible" property
- */
- int of_device_is_compatible(const struct device_node *device,
- const char *compat)
- {
- const char* cp;
- int cplen, l;
- cp = of_get_property(device, "compatible", &cplen);
- if (cp == NULL)
- return 0;
- while (cplen > 0) {
- if (of_compat_cmp(cp, compat, strlen(compat)) == 0)
- return 1;
- l = strlen(cp) + 1;
- cp += l;
- cplen -= l;
- }
- return 0;
- }
- EXPORT_SYMBOL(of_device_is_compatible);
- /**
- * of_machine_is_compatible - Test root of device tree for a given compatible value
- * @compat: compatible string to look for in root node's compatible property.
- *
- * Returns true if the root node has the given value in its
- * compatible property.
- */
- int of_machine_is_compatible(const char *compat)
- {
- struct device_node *root;
- int rc = 0;
- root = of_find_node_by_path("/");
- if (root) {
- rc = of_device_is_compatible(root, compat);
- of_node_put(root);
- }
- return rc;
- }
- EXPORT_SYMBOL(of_machine_is_compatible);
- /**
- * of_device_is_available - check if a device is available for use
- *
- * @device: Node to check for availability
- *
- * Returns 1 if the status property is absent or set to "okay" or "ok",
- * 0 otherwise
- */
- int of_device_is_available(const struct device_node *device)
- {
- const char *status;
- int statlen;
- status = of_get_property(device, "status", &statlen);
- if (status == NULL)
- return 1;
- if (statlen > 0) {
- if (!strcmp(status, "okay") || !strcmp(status, "ok"))
- return 1;
- }
- return 0;
- }
- EXPORT_SYMBOL(of_device_is_available);
- /**
- * of_get_parent - Get a node's parent if any
- * @node: Node to get parent
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_get_parent(const struct device_node *node)
- {
- struct device_node *np;
- if (!node)
- return NULL;
- read_lock(&devtree_lock);
- np = of_node_get(node->parent);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_get_parent);
- /**
- * of_get_next_parent - Iterate to a node's parent
- * @node: Node to get parent of
- *
- * This is like of_get_parent() except that it drops the
- * refcount on the passed node, making it suitable for iterating
- * through a node's parents.
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_get_next_parent(struct device_node *node)
- {
- struct device_node *parent;
- if (!node)
- return NULL;
- read_lock(&devtree_lock);
- parent = of_node_get(node->parent);
- of_node_put(node);
- read_unlock(&devtree_lock);
- return parent;
- }
- /**
- * of_get_next_child - Iterate a node childs
- * @node: parent node
- * @prev: previous child of the parent node, or NULL to get first
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_get_next_child(const struct device_node *node,
- struct device_node *prev)
- {
- struct device_node *next;
- read_lock(&devtree_lock);
- next = prev ? prev->sibling : node->child;
- for (; next; next = next->sibling)
- if (of_node_get(next))
- break;
- of_node_put(prev);
- read_unlock(&devtree_lock);
- return next;
- }
- EXPORT_SYMBOL(of_get_next_child);
- /**
- * of_get_next_available_child - Find the next available child node
- * @node: parent node
- * @prev: previous child of the parent node, or NULL to get first
- *
- * This function is like of_get_next_child(), except that it
- * automatically skips any disabled nodes (i.e. status = "disabled").
- */
- struct device_node *of_get_next_available_child(const struct device_node *node,
- struct device_node *prev)
- {
- struct device_node *next;
- read_lock(&devtree_lock);
- next = prev ? prev->sibling : node->child;
- for (; next; next = next->sibling) {
- if (!of_device_is_available(next))
- continue;
- if (of_node_get(next))
- break;
- }
- of_node_put(prev);
- read_unlock(&devtree_lock);
- return next;
- }
- EXPORT_SYMBOL(of_get_next_available_child);
- /**
- * of_find_node_by_path - Find a node matching a full OF path
- * @path: The full path to match
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_node_by_path(const char *path)
- {
- struct device_node *np = allnodes;
- read_lock(&devtree_lock);
- for (; np; np = np->allnext) {
- if (np->full_name && (of_node_cmp(np->full_name, path) == 0)
- && of_node_get(np))
- break;
- }
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_node_by_path);
- /**
- * of_find_node_by_name - Find a node by its "name" property
- * @from: The node to start searching from or NULL, the node
- * you pass will not be searched, only the next one
- * will; typically, you pass what the previous call
- * returned. of_node_put() will be called on it
- * @name: The name string to match against
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_node_by_name(struct device_node *from,
- const char *name)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- np = from ? from->allnext : allnodes;
- for (; np; np = np->allnext)
- if (np->name && (of_node_cmp(np->name, name) == 0)
- && of_node_get(np))
- break;
- of_node_put(from);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_node_by_name);
- /**
- * of_find_node_by_type - Find a node by its "device_type" property
- * @from: The node to start searching from, or NULL to start searching
- * the entire device tree. The node you pass will not be
- * searched, only the next one will; typically, you pass
- * what the previous call returned. of_node_put() will be
- * called on from for you.
- * @type: The type string to match against
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_node_by_type(struct device_node *from,
- const char *type)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- np = from ? from->allnext : allnodes;
- for (; np; np = np->allnext)
- if (np->type && (of_node_cmp(np->type, type) == 0)
- && of_node_get(np))
- break;
- of_node_put(from);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_node_by_type);
- /**
- * of_find_compatible_node - Find a node based on type and one of the
- * tokens in its "compatible" property
- * @from: The node to start searching from or NULL, the node
- * you pass will not be searched, only the next one
- * will; typically, you pass what the previous call
- * returned. of_node_put() will be called on it
- * @type: The type string to match "device_type" or NULL to ignore
- * @compatible: The string to match to one of the tokens in the device
- * "compatible" list.
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_compatible_node(struct device_node *from,
- const char *type, const char *compatible)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- np = from ? from->allnext : allnodes;
- for (; np; np = np->allnext) {
- if (type
- && !(np->type && (of_node_cmp(np->type, type) == 0)))
- continue;
- if (of_device_is_compatible(np, compatible) && of_node_get(np))
- break;
- }
- of_node_put(from);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_compatible_node);
- /**
- * of_find_node_with_property - Find a node which has a property with
- * the given name.
- * @from: The node to start searching from or NULL, the node
- * you pass will not be searched, only the next one
- * will; typically, you pass what the previous call
- * returned. of_node_put() will be called on it
- * @prop_name: The name of the property to look for.
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_node_with_property(struct device_node *from,
- const char *prop_name)
- {
- struct device_node *np;
- struct property *pp;
- read_lock(&devtree_lock);
- np = from ? from->allnext : allnodes;
- for (; np; np = np->allnext) {
- for (pp = np->properties; pp != 0; pp = pp->next) {
- if (of_prop_cmp(pp->name, prop_name) == 0) {
- of_node_get(np);
- goto out;
- }
- }
- }
- out:
- of_node_put(from);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_node_with_property);
- /**
- * of_match_node - Tell if an device_node has a matching of_match structure
- * @matches: array of of device match structures to search in
- * @node: the of device structure to match against
- *
- * Low level utility function used by device matching.
- */
- const struct of_device_id *of_match_node(const struct of_device_id *matches,
- const struct device_node *node)
- {
- if (!matches)
- return NULL;
- while (matches->name[0] || matches->type[0] || matches->compatible[0]) {
- int match = 1;
- if (matches->name[0])
- match &= node->name
- && !strcmp(matches->name, node->name);
- if (matches->type[0])
- match &= node->type
- && !strcmp(matches->type, node->type);
- if (matches->compatible[0])
- match &= of_device_is_compatible(node,
- matches->compatible);
- if (match)
- return matches;
- matches++;
- }
- return NULL;
- }
- EXPORT_SYMBOL(of_match_node);
- /**
- * of_find_matching_node - Find a node based on an of_device_id match
- * table.
- * @from: The node to start searching from or NULL, the node
- * you pass will not be searched, only the next one
- * will; typically, you pass what the previous call
- * returned. of_node_put() will be called on it
- * @matches: array of of device match structures to search in
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_matching_node(struct device_node *from,
- const struct of_device_id *matches)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- np = from ? from->allnext : allnodes;
- for (; np; np = np->allnext) {
- if (of_match_node(matches, np) && of_node_get(np))
- break;
- }
- of_node_put(from);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_matching_node);
- /**
- * of_modalias_node - Lookup appropriate modalias for a device node
- * @node: pointer to a device tree node
- * @modalias: Pointer to buffer that modalias value will be copied into
- * @len: Length of modalias value
- *
- * Based on the value of the compatible property, this routine will attempt
- * to choose an appropriate modalias value for a particular device tree node.
- * It does this by stripping the manufacturer prefix (as delimited by a ',')
- * from the first entry in the compatible list property.
- *
- * This routine returns 0 on success, <0 on failure.
- */
- int of_modalias_node(struct device_node *node, char *modalias, int len)
- {
- const char *compatible, *p;
- int cplen;
- compatible = of_get_property(node, "compatible", &cplen);
- if (!compatible || strlen(compatible) > cplen)
- return -ENODEV;
- p = strchr(compatible, ',');
- strlcpy(modalias, p ? p + 1 : compatible, len);
- return 0;
- }
- EXPORT_SYMBOL_GPL(of_modalias_node);
- /**
- * of_find_node_by_phandle - Find a node given a phandle
- * @handle: phandle of the node to find
- *
- * Returns a node pointer with refcount incremented, use
- * of_node_put() on it when done.
- */
- struct device_node *of_find_node_by_phandle(phandle handle)
- {
- struct device_node *np;
- read_lock(&devtree_lock);
- for (np = allnodes; np; np = np->allnext)
- if (np->phandle == handle)
- break;
- of_node_get(np);
- read_unlock(&devtree_lock);
- return np;
- }
- EXPORT_SYMBOL(of_find_node_by_phandle);
- /**
- * of_property_read_u32_array - Find and read an array of 32 bit integers
- * from a property.
- *
- * @np: device node from which the property value is to be read.
- * @propname: name of the property to be searched.
- * @out_value: pointer to return value, modified only if return value is 0.
- *
- * Search for a property in a device node and read 32-bit value(s) from
- * it. Returns 0 on success, -EINVAL if the property does not exist,
- * -ENODATA if property does not have a value, and -EOVERFLOW if the
- * property data isn't large enough.
- *
- * The out_value is modified only if a valid u32 value can be decoded.
- */
- int of_property_read_u32_array(const struct device_node *np,
- const char *propname, u32 *out_values,
- size_t sz)
- {
- struct property *prop = of_find_property(np, propname, NULL);
- const __be32 *val;
- if (!prop)
- return -EINVAL;
- if (!prop->value)
- return -ENODATA;
- if ((sz * sizeof(*out_values)) > prop->length)
- return -EOVERFLOW;
- val = prop->value;
- while (sz--)
- *out_values++ = be32_to_cpup(val++);
- return 0;
- }
- EXPORT_SYMBOL_GPL(of_property_read_u32_array);
- /**
- * of_property_read_u64 - Find and read a 64 bit integer from a property
- * @np: device node from which the property value is to be read.
- * @propname: name of the property to be searched.
- * @out_value: pointer to return value, modified only if return value is 0.
- *
- * Search for a property in a device node and read a 64-bit value from
- * it. Returns 0 on success, -EINVAL if the property does not exist,
- * -ENODATA if property does not have a value, and -EOVERFLOW if the
- * property data isn't large enough.
- *
- * The out_value is modified only if a valid u64 value can be decoded.
- */
- int of_property_read_u64(const struct device_node *np, const char *propname,
- u64 *out_value)
- {
- struct property *prop = of_find_property(np, propname, NULL);
- if (!prop)
- return -EINVAL;
- if (!prop->value)
- return -ENODATA;
- if (sizeof(*out_value) > prop->length)
- return -EOVERFLOW;
- *out_value = of_read_number(prop->value, 2);
- return 0;
- }
- EXPORT_SYMBOL_GPL(of_property_read_u64);
- /**
- * of_property_read_string - Find and read a string from a property
- * @np: device node from which the property value is to be read.
- * @propname: name of the property to be searched.
- * @out_string: pointer to null terminated return string, modified only if
- * return value is 0.
- *
- * Search for a property in a device tree node and retrieve a null
- * terminated string value (pointer to data, not a copy). Returns 0 on
- * success, -EINVAL if the property does not exist, -ENODATA if property
- * does not have a value, and -EILSEQ if the string is not null-terminated
- * within the length of the property data.
- *
- * The out_string pointer is modified only if a valid string can be decoded.
- */
- int of_property_read_string(struct device_node *np, const char *propname,
- const char **out_string)
- {
- struct property *prop = of_find_property(np, propname, NULL);
- if (!prop)
- return -EINVAL;
- if (!prop->value)
- return -ENODATA;
- if (strnlen(prop->value, prop->length) >= prop->length)
- return -EILSEQ;
- *out_string = prop->value;
- return 0;
- }
- EXPORT_SYMBOL_GPL(of_property_read_string);
- /**
- * of_property_match_string() - Find string in a list and return index
- * @np: pointer to node containing string list property
- * @propname: string list property name
- * @string: pointer to string to search for in string list
- *
- * This function searches a string list property and returns the index
- * of a specific string value.
- */
- int of_property_match_string(struct device_node *np, const char *propname,
- const char *string)
- {
- struct property *prop = of_find_property(np, propname, NULL);
- size_t l;
- int i;
- const char *p, *end;
- if (!prop)
- return -EINVAL;
- if (!prop->value)
- return -ENODATA;
- p = prop->value;
- end = p + prop->length;
- for (i = 0; p < end; i++, p += l) {
- l = strnlen(p, end - p) + 1;
- if (p + l > end)
- return -EILSEQ;
- pr_debug("comparing %s with %s\n", string, p);
- if (strcmp(string, p) == 0)
- return i; /* Found it; return index */
- }
- return -ENODATA;
- }
- EXPORT_SYMBOL_GPL(of_property_match_string);
- /**
- * of_property_read_string_util() - Utility helper for parsing string properties
- * @np: device node from which the property value is to be read.
- * @propname: name of the property to be searched.
- * @out_strs: output array of string pointers.
- * @sz: number of array elements to read.
- * @skip: Number of strings to skip over at beginning of list.
- *
- * Don't call this function directly. It is a utility helper for the
- * of_property_read_string*() family of functions.
- */
- int of_property_read_string_helper(struct device_node *np, const char *propname,
- const char **out_strs, size_t sz, int skip)
- {
- struct property *prop = of_find_property(np, propname, NULL);
- int l = 0, i = 0;
- const char *p, *end;
- if (!prop)
- return -EINVAL;
- if (!prop->value)
- return -ENODATA;
- p = prop->value;
- end = p + prop->length;
- for (i = 0; p < end && (!out_strs || i < skip + sz); i++, p += l) {
- l = strnlen(p, end - p) + 1;
- if (p + l > end)
- return -EILSEQ;
- if (out_strs && i >= skip)
- *out_strs++ = p;
- }
- i -= skip;
- return i <= 0 ? -ENODATA : i;
- }
- EXPORT_SYMBOL_GPL(of_property_read_string_helper);
- /**
- * of_parse_phandle - Resolve a phandle property to a device_node pointer
- * @np: Pointer to device node holding phandle property
- * @phandle_name: Name of property holding a phandle value
- * @index: For properties holding a table of phandles, this is the index into
- * the table
- *
- * Returns the device_node pointer with refcount incremented. Use
- * of_node_put() on it when done.
- */
- struct device_node *
- of_parse_phandle(struct device_node *np, const char *phandle_name, int index)
- {
- const __be32 *phandle;
- int size;
- phandle = of_get_property(np, phandle_name, &size);
- if ((!phandle) || (size < sizeof(*phandle) * (index + 1)))
- return NULL;
- return of_find_node_by_phandle(be32_to_cpup(phandle + index));
- }
- EXPORT_SYMBOL(of_parse_phandle);
- /**
- * of_parse_phandle_with_args() - Find a node pointed by phandle in a list
- * @np: pointer to a device tree node containing a list
- * @list_name: property name that contains a list
- * @cells_name: property name that specifies phandles' arguments count
- * @index: index of a phandle to parse out
- * @out_args: optional pointer to output arguments structure (will be filled)
- *
- * This function is useful to parse lists of phandles and their arguments.
- * Returns 0 on success and fills out_args, on error returns appropriate
- * errno value.
- *
- * Caller is responsible to call of_node_put() on the returned out_args->node
- * pointer.
- *
- * Example:
- *
- * phandle1: node1 {
- * #list-cells = <2>;
- * }
- *
- * phandle2: node2 {
- * #list-cells = <1>;
- * }
- *
- * node3 {
- * list = <&phandle1 1 2 &phandle2 3>;
- * }
- *
- * To get a device_node of the `node2' node you may call this:
- * of_parse_phandle_with_args(node3, "list", "#list-cells", 1, &args);
- */
- int of_parse_phandle_with_args(struct device_node *np, const char *list_name,
- const char *cells_name, int index,
- struct of_phandle_args *out_args)
- {
- const __be32 *list, *list_end;
- int size, cur_index = 0;
- uint32_t count = 0;
- struct device_node *node = NULL;
- phandle phandle;
- /* Retrieve the phandle list property */
- list = of_get_property(np, list_name, &size);
- if (!list)
- return -EINVAL;
- list_end = list + size / sizeof(*list);
- /* Loop over the phandles until all the requested entry is found */
- while (list < list_end) {
- count = 0;
- /*
- * If phandle is 0, then it is an empty entry with no
- * arguments. Skip forward to the next entry.
- */
- phandle = be32_to_cpup(list++);
- if (phandle) {
- /*
- * Find the provider node and parse the #*-cells
- * property to determine the argument length
- */
- node = of_find_node_by_phandle(phandle);
- if (!node) {
- pr_err("%s: could not find phandle\n",
- np->full_name);
- break;
- }
- if (of_property_read_u32(node, cells_name, &count)) {
- pr_err("%s: could not get %s for %s\n",
- np->full_name, cells_name,
- node->full_name);
- break;
- }
- /*
- * Make sure that the arguments actually fit in the
- * remaining property data length
- */
- if (list + count > list_end) {
- pr_err("%s: arguments longer than property\n",
- np->full_name);
- break;
- }
- }
- /*
- * All of the error cases above bail out of the loop, so at
- * this point, the parsing is successful. If the requested
- * index matches, then fill the out_args structure and return,
- * or return -ENOENT for an empty entry.
- */
- if (cur_index == index) {
- if (!phandle)
- return -ENOENT;
- if (out_args) {
- int i;
- if (WARN_ON(count > MAX_PHANDLE_ARGS))
- count = MAX_PHANDLE_ARGS;
- out_args->np = node;
- out_args->args_count = count;
- for (i = 0; i < count; i++)
- out_args->args[i] = be32_to_cpup(list++);
- }
- return 0;
- }
- of_node_put(node);
- node = NULL;
- list += count;
- cur_index++;
- }
- /* Loop exited without finding a valid entry; return an error */
- if (node)
- of_node_put(node);
- return -EINVAL;
- }
- EXPORT_SYMBOL(of_parse_phandle_with_args);
- /**
- * prom_add_property - Add a property to a node
- */
- int prom_add_property(struct device_node *np, struct property *prop)
- {
- struct property **next;
- unsigned long flags;
- prop->next = NULL;
- write_lock_irqsave(&devtree_lock, flags);
- next = &np->properties;
- while (*next) {
- if (strcmp(prop->name, (*next)->name) == 0) {
- /* duplicate ! don't insert it */
- write_unlock_irqrestore(&devtree_lock, flags);
- return -1;
- }
- next = &(*next)->next;
- }
- *next = prop;
- write_unlock_irqrestore(&devtree_lock, flags);
- #ifdef CONFIG_PROC_DEVICETREE
- /* try to add to proc as well if it was initialized */
- if (np->pde)
- proc_device_tree_add_prop(np->pde, prop);
- #endif /* CONFIG_PROC_DEVICETREE */
- return 0;
- }
- /**
- * prom_remove_property - Remove a property from a node.
- *
- * Note that we don't actually remove it, since we have given out
- * who-knows-how-many pointers to the data using get-property.
- * Instead we just move the property to the "dead properties"
- * list, so it won't be found any more.
- */
- int prom_remove_property(struct device_node *np, struct property *prop)
- {
- struct property **next;
- unsigned long flags;
- int found = 0;
- write_lock_irqsave(&devtree_lock, flags);
- next = &np->properties;
- while (*next) {
- if (*next == prop) {
- /* found the node */
- *next = prop->next;
- prop->next = np->deadprops;
- np->deadprops = prop;
- found = 1;
- break;
- }
- next = &(*next)->next;
- }
- write_unlock_irqrestore(&devtree_lock, flags);
- if (!found)
- return -ENODEV;
- #ifdef CONFIG_PROC_DEVICETREE
- /* try to remove the proc node as well */
- if (np->pde)
- proc_device_tree_remove_prop(np->pde, prop);
- #endif /* CONFIG_PROC_DEVICETREE */
- return 0;
- }
- /*
- * prom_update_property - Update a property in a node.
- *
- * Note that we don't actually remove it, since we have given out
- * who-knows-how-many pointers to the data using get-property.
- * Instead we just move the property to the "dead properties" list,
- * and add the new property to the property list
- */
- int prom_update_property(struct device_node *np,
- struct property *newprop,
- struct property *oldprop)
- {
- struct property **next;
- unsigned long flags;
- int found = 0;
- write_lock_irqsave(&devtree_lock, flags);
- next = &np->properties;
- while (*next) {
- if (*next == oldprop) {
- /* found the node */
- newprop->next = oldprop->next;
- *next = newprop;
- oldprop->next = np->deadprops;
- np->deadprops = oldprop;
- found = 1;
- break;
- }
- next = &(*next)->next;
- }
- write_unlock_irqrestore(&devtree_lock, flags);
- if (!found)
- return -ENODEV;
- #ifdef CONFIG_PROC_DEVICETREE
- /* try to add to proc as well if it was initialized */
- if (np->pde)
- proc_device_tree_update_prop(np->pde, newprop, oldprop);
- #endif /* CONFIG_PROC_DEVICETREE */
- return 0;
- }
- #if defined(CONFIG_OF_DYNAMIC)
- /*
- * Support for dynamic device trees.
- *
- * On some platforms, the device tree can be manipulated at runtime.
- * The routines in this section support adding, removing and changing
- * device tree nodes.
- */
- /**
- * of_attach_node - Plug a device node into the tree and global list.
- */
- void of_attach_node(struct device_node *np)
- {
- unsigned long flags;
- write_lock_irqsave(&devtree_lock, flags);
- np->sibling = np->parent->child;
- np->allnext = allnodes;
- np->parent->child = np;
- allnodes = np;
- write_unlock_irqrestore(&devtree_lock, flags);
- }
- /**
- * of_detach_node - "Unplug" a node from the device tree.
- *
- * The caller must hold a reference to the node. The memory associated with
- * the node is not freed until its refcount goes to zero.
- */
- void of_detach_node(struct device_node *np)
- {
- struct device_node *parent;
- unsigned long flags;
- write_lock_irqsave(&devtree_lock, flags);
- parent = np->parent;
- if (!parent)
- goto out_unlock;
- if (allnodes == np)
- allnodes = np->allnext;
- else {
- struct device_node *prev;
- for (prev = allnodes;
- prev->allnext != np;
- prev = prev->allnext)
- ;
- prev->allnext = np->allnext;
- }
- if (parent->child == np)
- parent->child = np->sibling;
- else {
- struct device_node *prevsib;
- for (prevsib = np->parent->child;
- prevsib->sibling != np;
- prevsib = prevsib->sibling)
- ;
- prevsib->sibling = np->sibling;
- }
- of_node_set_flag(np, OF_DETACHED);
- out_unlock:
- write_unlock_irqrestore(&devtree_lock, flags);
- }
- #endif /* defined(CONFIG_OF_DYNAMIC) */
- static void of_alias_add(struct alias_prop *ap, struct device_node *np,
- int id, const char *stem, int stem_len)
- {
- ap->np = np;
- ap->id = id;
- strncpy(ap->stem, stem, stem_len);
- ap->stem[stem_len] = 0;
- list_add_tail(&ap->link, &aliases_lookup);
- pr_debug("adding DT alias:%s: stem=%s id=%i node=%s\n",
- ap->alias, ap->stem, ap->id, np ? np->full_name : NULL);
- }
- /**
- * of_alias_scan - Scan all properties of 'aliases' node
- *
- * The function scans all the properties of 'aliases' node and populate
- * the the global lookup table with the properties. It returns the
- * number of alias_prop found, or error code in error case.
- *
- * @dt_alloc: An allocator that provides a virtual address to memory
- * for the resulting tree
- */
- void of_alias_scan(void * (*dt_alloc)(u64 size, u64 align))
- {
- struct property *pp;
- of_chosen = of_find_node_by_path("/chosen");
- if (of_chosen == NULL)
- of_chosen = of_find_node_by_path("/chosen@0");
- of_aliases = of_find_node_by_path("/aliases");
- if (!of_aliases)
- return;
- for_each_property_of_node(of_aliases, pp) {
- const char *start = pp->name;
- const char *end = start + strlen(start);
- struct device_node *np;
- struct alias_prop *ap;
- int id, len;
- /* Skip those we do not want to proceed */
- if (!strcmp(pp->name, "name") ||
- !strcmp(pp->name, "phandle") ||
- !strcmp(pp->name, "linux,phandle"))
- continue;
- np = of_find_node_by_path(pp->value);
- if (!np)
- continue;
- /* walk the alias backwards to extract the id and work out
- * the 'stem' string */
- while (isdigit(*(end-1)) && end > start)
- end--;
- len = end - start;
- if (kstrtoint(end, 10, &id) < 0)
- continue;
- /* Allocate an alias_prop with enough space for the stem */
- ap = dt_alloc(sizeof(*ap) + len + 1, 4);
- if (!ap)
- continue;
- memset(ap, 0, sizeof(*ap) + len + 1);
- ap->alias = start;
- of_alias_add(ap, np, id, start, len);
- }
- }
- /**
- * of_alias_get_id - Get alias id for the given device_node
- * @np: Pointer to the given device_node
- * @stem: Alias stem of the given device_node
- *
- * The function travels the lookup table to get alias id for the given
- * device_node and alias stem. It returns the alias id if find it.
- */
- int of_alias_get_id(struct device_node *np, const char *stem)
- {
- struct alias_prop *app;
- int id = -ENODEV;
- mutex_lock(&of_aliases_mutex);
- list_for_each_entry(app, &aliases_lookup, link) {
- if (strcmp(app->stem, stem) != 0)
- continue;
- if (np == app->np) {
- id = app->id;
- break;
- }
- }
- mutex_unlock(&of_aliases_mutex);
- return id;
- }
- EXPORT_SYMBOL_GPL(of_alias_get_id);
- #ifdef CONFIG_OF_SUBCMDLINE_PARSE
- int of_parse_args_on_subcmdline(const char *name, char *buf)
- {
- struct device_node *node;
- static const char *subcmdline;
- char *param_start, *param_end;
- int len = 0, name_len, cmd_len;
- node = of_find_node_by_path("/chosen");
- if (!node) {
- pr_err("%s: get chosen node failed\n", __func__);
- return -ENODEV;
- }
- subcmdline = of_get_property(node, "subcmdline", &len);
- if (!subcmdline || len <= 0) {
- pr_err("%s: get bootargs failed\n", __func__);
- return -ENODEV;
- }
- name_len = strlen(name);
- cmd_len = strlen(subcmdline);
- param_start = strnstr(subcmdline, name, cmd_len);
- if (!param_start) {
- pr_err("%s: %s not found within cmdline\n", __func__, name);
- return -1;
- }
- param_start += name_len;
- param_end = strnstr(param_start, " ", 100);
- if (!param_end) {
- pr_err("%s: no space after %s found within cmdline\n", __func__, name);
- return -1;
- }
- strlcpy(buf, param_start, param_end-param_start+1);
- /* All parsed OK. */
- return 0;
- }
- EXPORT_SYMBOL(of_parse_args_on_subcmdline);
- #endif
|