Subversion Repositories HelenOS

Rev

Rev 1899 | Rev 1908 | 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. #ifndef KERN_OFW_TREE_H_
  30. #define KERN_OFW_TREE_H_
  31.  
  32. #include <arch/types.h>
  33. #include <typedefs.h>
  34.  
  35. #define OFW_TREE_PROPERTY_MAX_NAMELEN   32
  36.  
  37. typedef struct ofw_tree_node ofw_tree_node_t;
  38. typedef struct ofw_tree_property ofw_tree_property_t;
  39.  
  40. /** Memory representation of OpenFirmware device tree node. */
  41. struct ofw_tree_node {
  42.     ofw_tree_node_t *parent;
  43.     ofw_tree_node_t *peer;
  44.     ofw_tree_node_t *child;
  45.  
  46.     uint32_t node_handle;           /**< Old OpenFirmware node handle. */
  47.  
  48.     char *da_name;              /**< Disambigued name. */
  49.  
  50.     unsigned properties;            /**< Number of properties. */
  51.     ofw_tree_property_t *property;
  52. };
  53.  
  54. /** Memory representation of OpenFirmware device tree node property. */
  55. struct ofw_tree_property {
  56.     char name[OFW_TREE_PROPERTY_MAX_NAMELEN];
  57.     size_t size;
  58.     void *value;
  59. };
  60.  
  61. /*
  62.  * Definition of 'reg' and 'ranges' properties for various buses.
  63.  */
  64.  
  65. struct ofw_fhc_reg {
  66.     uint64_t addr;
  67.     uint32_t size;
  68. } __attribute__ ((packed));
  69. typedef struct ofw_fhc_reg ofw_fhc_reg_t;
  70.            
  71. struct ofw_fhc_range {
  72.     uint64_t child_base;
  73.     uint64_t parent_base;
  74.     uint32_t size;
  75. } __attribute__ ((packed));
  76. typedef struct ofw_fhc_range ofw_fhc_range_t;
  77.  
  78. struct ofw_central_reg {
  79.     uint64_t addr;
  80.     uint32_t size;
  81. } __attribute__ ((packed));
  82. typedef struct ofw_central_reg ofw_central_reg_t;
  83.  
  84. struct ofw_central_range {
  85.     uint64_t child_base;
  86.     uint64_t parent_base;
  87.     uint32_t size;
  88. } __attribute__ ((packed));
  89. typedef struct ofw_central_range ofw_central_range_t;
  90.  
  91. struct ofw_ebus_reg {
  92.     uint32_t space;
  93.     uint32_t addr;
  94.     uint32_t size;
  95. } __attribute__ ((packed));
  96. typedef struct ofw_ebus_reg ofw_ebus_reg_t;
  97.  
  98. struct ofw_ebus_range {
  99.     uint32_t child_space;
  100.     uint32_t child_base;
  101.     uint32_t parent_space;
  102.     uint64_t parent_base;       /* group phys.mid and phys.lo together */
  103.     uint32_t size;
  104. } __attribute__ ((packed));
  105. typedef struct ofw_ebus_range ofw_ebus_range_t;
  106.  
  107. struct ofw_pci_reg {
  108.     uint32_t space;         /* needs to masked to obtain pure space id */
  109.     uint64_t addr;          /* group phys.mid and phys.lo together */
  110.     uint64_t size;
  111. } __attribute__ ((packed));
  112. typedef struct ofw_pci_reg ofw_pci_reg_t;
  113.  
  114. struct ofw_pci_range {
  115.     uint32_t space;
  116.     uint64_t child_base;        /* group phys.mid and phys.lo together */
  117.     uint64_t parent_base;
  118.     uint64_t size;
  119. } __attribute__ ((packed));
  120. typedef struct ofw_pci_range ofw_pci_range_t;
  121.  
  122. struct ofw_upa_reg {
  123.     uint64_t addr;
  124.     uint64_t size;
  125. } __attribute__ ((packed));
  126. typedef struct ofw_upa_reg ofw_upa_reg_t;
  127.  
  128. extern void ofw_tree_init(ofw_tree_node_t *root);
  129. extern void ofw_tree_print(void);
  130. extern const char *ofw_tree_node_name(const ofw_tree_node_t *node);
  131. extern ofw_tree_node_t *ofw_tree_lookup(const char *path);
  132. extern ofw_tree_property_t *ofw_tree_getprop(const ofw_tree_node_t *node, const char *name);
  133. extern ofw_tree_node_t *ofw_tree_find_child(ofw_tree_node_t *node, const char *name);
  134. extern ofw_tree_node_t *ofw_tree_find_child_by_device_type(ofw_tree_node_t *node, const char *device_type);
  135. extern ofw_tree_node_t *ofw_tree_find_peer_by_device_type(ofw_tree_node_t *node, const char *device_type);
  136.  
  137. extern bool ofw_fhc_apply_ranges(ofw_tree_node_t *node, ofw_fhc_reg_t *reg, uintptr_t *pa);
  138. extern bool ofw_central_apply_ranges(ofw_tree_node_t *node, ofw_central_reg_t *reg, uintptr_t *pa);
  139. extern bool ofw_ebus_apply_ranges(ofw_tree_node_t *node, ofw_ebus_reg_t *reg, uintptr_t *pa);
  140. extern bool ofw_pci_apply_ranges(ofw_tree_node_t *node, ofw_pci_reg_t *reg, uintptr_t *pa);
  141. extern bool ofw_upa_apply_ranges(ofw_tree_node_t *node, ofw_upa_reg_t *reg, uintptr_t *pa);
  142.  
  143. extern bool ofw_pci_reg_absolutize(ofw_tree_node_t *node, ofw_pci_reg_t *reg, ofw_pci_reg_t *out);
  144.  
  145. #endif
  146.