Subversion Repositories HelenOS

Rev

Rev 4220 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2006 Jakub Jermar
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms, with or without
  6.  * modification, are permitted provided that the following conditions
  7.  * are met:
  8.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup ofw
  30.  * @{
  31.  */
  32. /**
  33.  * @file
  34.  * @brief   OpenFirmware device tree navigation.
  35.  *
  36.  */
  37.  
  38. #include <genarch/ofw/ofw_tree.h>
  39. #include <arch/memstr.h>
  40. #include <mm/slab.h>
  41. #include <string.h>
  42. #include <print.h>
  43. #include <panic.h>
  44.  
  45. #define PATH_MAX_LEN    80
  46. #define NAME_BUF_LEN    50
  47.  
  48. static ofw_tree_node_t *ofw_root;
  49.  
  50. void ofw_tree_init(ofw_tree_node_t *root)
  51. {
  52.     ofw_root = root;
  53. }
  54.  
  55. /** Get OpenFirmware node property.
  56.  *
  57.  * @param node      Node in which to lookup the property.
  58.  * @param name      Name of the property.
  59.  *
  60.  * @return      Pointer to the property structure or NULL if no such
  61.  *          property.
  62.  */
  63. ofw_tree_property_t *
  64. ofw_tree_getprop(const ofw_tree_node_t *node, const char *name)
  65. {
  66.     unsigned int i;
  67.    
  68.     for (i = 0; i < node->properties; i++) {
  69.         if (str_cmp(node->property[i].name, name) == 0)
  70.             return &node->property[i];
  71.     }
  72.  
  73.     return NULL;
  74. }
  75.  
  76. /** Return value of the 'name' property.
  77.  *
  78.  * @param node      Node of interest.
  79.  *
  80.  * @return      Value of the 'name' property belonging to the node.
  81.  */
  82. const char *ofw_tree_node_name(const ofw_tree_node_t *node)
  83. {
  84.     ofw_tree_property_t *prop;
  85.    
  86.     prop = ofw_tree_getprop(node, "name");
  87.     if (!prop)
  88.         panic("Node without name property.");
  89.        
  90.     if (prop->size < 2)
  91.         panic("Invalid name property.");
  92.    
  93.     return prop->value;
  94. }
  95.  
  96. /** Lookup child of given name.
  97.  *
  98.  * @param node      Node whose child is being looked up.
  99.  * @param name      Name of the child being looked up.
  100.  *
  101.  * @return      NULL if there is no such child or pointer to the
  102.  *          matching child node.
  103.  */
  104. ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name)
  105. {
  106.     ofw_tree_node_t *cur;
  107.    
  108.     /*
  109.      * Try to find the disambigued name.
  110.      */
  111.     for (cur = node->child; cur; cur = cur->peer) {
  112.         if (str_cmp(cur->da_name, name) == 0)
  113.             return cur;
  114.     }
  115.    
  116.     /*
  117.      * Disambigued name not found.
  118.      * Lets try our luck with possibly ambiguous "name" property.
  119.      *
  120.      * We need to do this because paths stored in "/aliases"
  121.      * are not always fully-qualified.
  122.      */
  123.     for (cur = node->child; cur; cur = cur->peer) {
  124.         if (str_cmp(ofw_tree_node_name(cur), name) == 0)
  125.             return cur;
  126.     }
  127.        
  128.     return NULL;
  129. }
  130.  
  131. /** Lookup first child of given device type.
  132.  *
  133.  * @param node      Node whose child is being looked up.
  134.  * @param name      Device type of the child being looked up.
  135.  *
  136.  * @return      NULL if there is no such child or pointer to the
  137.  *          matching child node.
  138.  */
  139. ofw_tree_node_t *
  140. ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *name)
  141. {
  142.     ofw_tree_node_t *cur;
  143.     ofw_tree_property_t *prop;
  144.    
  145.     for (cur = node->child; cur; cur = cur->peer) {
  146.         prop = ofw_tree_getprop(cur, "device_type");
  147.         if (!prop || !prop->value)
  148.             continue;
  149.         if (str_cmp(prop->value, name) == 0)
  150.             return cur;
  151.     }
  152.            
  153.     return NULL;
  154. }
  155.  
  156. /** Lookup node with matching node_handle.
  157.  *
  158.  * Child nodes are looked up recursively contrary to peer nodes that
  159.  * are looked up iteratively to avoid stack overflow.
  160.  *
  161.  * @param root      Root of the searched subtree.
  162.  * @param handle    OpenFirmware handle.
  163.  *
  164.  * @return      NULL if there is no such node or pointer to the matching
  165.  *          node.
  166.  */
  167. ofw_tree_node_t *
  168. ofw_tree_find_node_by_handle(ofw_tree_node_t *root, uint32_t handle)
  169. {
  170.     ofw_tree_node_t *cur;
  171.  
  172.     for (cur = root; cur; cur = cur->peer) {       
  173.         if (cur->node_handle == handle)
  174.             return cur;
  175.  
  176.         if (cur->child) {
  177.             ofw_tree_node_t *node;
  178.            
  179.             node = ofw_tree_find_node_by_handle(cur->child, handle);
  180.             if (node)
  181.                 return node;
  182.         }
  183.     }
  184.    
  185.     return NULL;   
  186. }
  187.  
  188. /** Lookup first peer of given device type.
  189.  *
  190.  * @param node      Node whose peer is being looked up.
  191.  * @param name      Device type of the child being looked up.
  192.  *
  193.  * @return      NULL if there is no such child or pointer to the
  194.  *          matching child node.
  195.  */
  196. ofw_tree_node_t *
  197. ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *name)
  198. {
  199.     ofw_tree_node_t *cur;
  200.     ofw_tree_property_t *prop;
  201.    
  202.     for (cur = node->peer; cur; cur = cur->peer) {
  203.         prop = ofw_tree_getprop(cur, "device_type");
  204.         if (!prop || !prop->value)
  205.             continue;
  206.         if (str_cmp(prop->value, name) == 0)
  207.             return cur;
  208.     }
  209.            
  210.     return NULL;
  211. }
  212.  
  213.  
  214. /** Lookup first peer of given name.
  215.  *
  216.  * @param node      Node whose peer is being looked up.
  217.  * @param name      Name of the child being looked up.
  218.  *
  219.  * @return      NULL if there is no such peer or pointer to the matching
  220.  *          peer node.
  221.  */
  222. ofw_tree_node_t *
  223. ofw_tree_find_peer_by_name(ofw_tree_node_t *node, const char *name)
  224. {
  225.     ofw_tree_node_t *cur;
  226.     ofw_tree_property_t *prop;
  227.    
  228.     for (cur = node->peer; cur; cur = cur->peer) {
  229.         prop = ofw_tree_getprop(cur, "name");
  230.         if (!prop || !prop->value)
  231.             continue;
  232.         if (str_cmp(prop->value, name) == 0)
  233.             return cur;
  234.     }
  235.            
  236.     return NULL;
  237. }
  238.  
  239. /** Lookup OpenFirmware node by its path.
  240.  *
  241.  * @param path      Path to the node.
  242.  *
  243.  * @return      NULL if there is no such node or pointer to the leaf
  244.  *          node.
  245.  */
  246. ofw_tree_node_t *ofw_tree_lookup(const char *path)
  247. {
  248.     char buf[NAME_BUF_LEN + 1];
  249.     ofw_tree_node_t *node = ofw_root;
  250.     size_t i;
  251.     size_t j;
  252.    
  253.     if (path[0] != '/')
  254.         return NULL;
  255.    
  256.     for (i = 1; (i < str_size(path)) && (node); i = j + 1) {
  257.         for (j = i; (j < str_size(path)) && (path[j] != '/'); j++);
  258.        
  259.         /* Skip extra slashes */
  260.         if (i == j)
  261.             continue;
  262.        
  263.         memcpy(buf, &path[i], j - i);
  264.         buf[j - i] = 0;
  265.         node = ofw_tree_find_child(node, buf);
  266.     }
  267.    
  268.     return node;
  269. }
  270.  
  271. /** Print OpenFirmware device subtree rooted in a node.
  272.  *
  273.  * Child nodes are processed recursively and peer nodes are processed
  274.  * iteratively in order to avoid stack overflow.
  275.  *
  276.  * @param node      Root of the subtree.
  277.  * @param path      Current path, NULL for the very root of the entire tree.
  278.  */
  279. static void ofw_tree_node_print(const ofw_tree_node_t *node, const char *path)
  280. {
  281.     char *p;
  282.     const ofw_tree_node_t *cur;
  283.  
  284.     p = (char *) malloc(PATH_MAX_LEN, 0);
  285.  
  286.     for (cur = node; cur; cur = cur->peer) {
  287.         if (cur->parent) {
  288.             snprintf(p, PATH_MAX_LEN, "%s/%s", path, cur->da_name);
  289.             printf("%s\n", p);
  290.         } else {
  291.             snprintf(p, PATH_MAX_LEN, "%s", cur->da_name);
  292.             printf("/\n");
  293.         }
  294.  
  295.         if (cur->child)
  296.             ofw_tree_node_print(cur->child, p);
  297.     }
  298.  
  299.     free(p);
  300. }
  301.  
  302. /** Print the structure of the OpenFirmware device tree. */
  303. void ofw_tree_print(void)
  304. {
  305.     ofw_tree_node_print(ofw_root, NULL);
  306. }
  307.  
  308. /** @}
  309.  */
  310.