Subversion Repositories HelenOS

Rev

Rev 1895 | Rev 1907 | Go to most recent revision | 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. #include <ofw_tree.h>
  30. #include <ofw.h>
  31. #include <types.h>
  32. #include <string.h>
  33. #include <balloc.h>
  34. #include <asm.h>
  35.  
  36. #define MAX_PATH_LEN    256
  37.  
  38. static ofw_tree_node_t *ofw_tree_node_alloc(void)
  39. {
  40.     return balloc(sizeof(ofw_tree_node_t), sizeof(ofw_tree_node_t));
  41. }
  42.  
  43. static ofw_tree_property_t *ofw_tree_properties_alloc(unsigned count)
  44. {
  45.     return balloc(count * sizeof(ofw_tree_property_t), sizeof(ofw_tree_property_t));
  46. }
  47.  
  48. static void * ofw_tree_space_alloc(size_t size)
  49. {
  50.     char *addr;
  51.  
  52.     /*
  53.      * What we do here is a nasty hack :-)
  54.      * Problem: string property values that are allocated via this
  55.      * function typically do not contain the trailing '\0'. This
  56.      * is very uncomfortable for kernel, which is supposed to deal
  57.      * with the properties.
  58.      * Solution: when allocating space via this function, we always
  59.      * allocate space for the extra '\0' character that we store
  60.      * behind the requested memory.
  61.      */
  62.     addr = balloc(size + 1, size);
  63.     if (addr)
  64.         addr[size] = '\0';
  65.     return addr;
  66. }
  67.  
  68. /** Transfer information from one OpenFirmware node into its memory representation.
  69.  *
  70.  * Transfer entire information from the OpenFirmware device tree 'current' node to
  71.  * its memory representation in 'current_node'. This function recursively processes
  72.  * all node's peers and children.
  73.  *
  74.  * @param current_node  Pointer to uninitialized ofw_tree_node structure that will
  75.  *          become the memory represenation of 'current'.
  76.  * @param parent_node   Parent ofw_tree_node structure or NULL in case of root node.
  77.  * @param current   OpenFirmware phandle to the current device tree node.
  78.  */
  79. static void ofw_tree_node_process(ofw_tree_node_t *current_node,
  80.     ofw_tree_node_t *parent_node, phandle current)
  81. {
  82.     static char path[MAX_PATH_LEN+1];
  83.     static char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
  84.     phandle peer;
  85.     phandle child;
  86.     unsigned properties = 0;
  87.     size_t len;
  88.     int i;
  89.  
  90.     /*
  91.      * Initialize node.
  92.      */
  93.     current_node->parent = parent_node;
  94.     current_node->peer = NULL;
  95.     current_node->child = NULL;
  96.     current_node->properties = 0;
  97.     current_node->property = NULL;
  98.    
  99.     /*
  100.      * Get the disambigued name.
  101.      */
  102.     len = ofw_package_to_path(current, path, MAX_PATH_LEN);
  103.     if (len == -1)
  104.         return;
  105.    
  106.     path[len] = '\0';
  107.     for (i = len - 1; i >= 0 && path[i] != '/'; i--)
  108.         ;
  109.     i++;                                /* do not include '/' */
  110.    
  111.     len -= i;
  112.     current_node->da_name = ofw_tree_space_alloc(len + 1);      /* add space for trailing '\0' */
  113.     if (!current_node->da_name)
  114.         return;
  115.    
  116.     memcpy(current_node->da_name, &path[i], len);
  117.     current_node->da_name[len] = '\0';
  118.    
  119.     /*
  120.      * Recursively process the potential peer node.
  121.      */
  122.     peer = ofw_get_peer_node(current);
  123.     if (peer != 0 && peer != -1) {
  124.         ofw_tree_node_t *peer_node;
  125.        
  126.         peer_node = ofw_tree_node_alloc();
  127.         if (peer_node) {
  128.             ofw_tree_node_process(peer_node, parent_node, peer);
  129.             current_node->peer = peer_node;
  130.         }
  131.     }
  132.    
  133.     /*
  134.      * Recursively process the potential child node.
  135.      */
  136.     child = ofw_get_child_node(current);
  137.     if (child != 0 && child != -1) {
  138.         ofw_tree_node_t *child_node;
  139.        
  140.         child_node = ofw_tree_node_alloc();
  141.         if (child_node) {
  142.             ofw_tree_node_process(child_node, current_node, child);
  143.             current_node->child = child_node;
  144.         }
  145.     }
  146.    
  147.     /*
  148.      * Count properties.
  149.      */
  150.     name[0] = '\0';
  151.     while (ofw_next_property(current, name, name) == 1)
  152.         current_node->properties++;
  153.    
  154.     if (!current_node->properties)
  155.         return;
  156.    
  157.     /*
  158.      * Copy properties.
  159.      */
  160.     current_node->property = ofw_tree_properties_alloc(current_node->properties);
  161.     if (!current_node->property)
  162.         return;
  163.        
  164.     name[0] = '\0';
  165.     for (i = 0; ofw_next_property(current, name, name) == 1; i++) {
  166.         size_t size;
  167.        
  168.         if (i == current_node->properties)
  169.             break;
  170.        
  171.         memcpy(current_node->property[i].name, name, OFW_TREE_PROPERTY_MAX_NAMELEN);
  172.         current_node->property[i].name[OFW_TREE_PROPERTY_MAX_NAMELEN] = '\0';
  173.  
  174.         size = ofw_get_proplen(current, name);
  175.         current_node->property[i].size = size;
  176.         if (size) {
  177.             void *buf;
  178.            
  179.             buf = ofw_tree_space_alloc(size);
  180.             if (current_node->property[i].value = buf) {
  181.                 /*
  182.                  * Copy property value to memory node.
  183.                  */
  184.                 (void) ofw_get_property(current, name, buf, size);
  185.             }
  186.         } else {
  187.             current_node->property[i].value = NULL;
  188.         }
  189.     }
  190.        
  191.     current_node->properties = i;   /* Just in case we ran out of memory. */
  192. }
  193.  
  194. /** Construct memory representation of OpenFirmware device tree.
  195.  *
  196.  * @return NULL on failure or pointer to the root node.
  197.  */
  198. ofw_tree_node_t *ofw_tree_build(void)
  199. {
  200.     ofw_tree_node_t *root;
  201.    
  202.     root = ofw_tree_node_alloc();
  203.     if (root)
  204.         ofw_tree_node_process(root, NULL, ofw_root);
  205.    
  206.     return root;
  207. }
  208.