Subversion Repositories HelenOS-historic

Rev

Rev 186 | Go to most recent revision | Blame | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (C) 2005 Martin Decky
  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 __OFW_H__
  30. #define __OFW_H__
  31.  
  32. #include <arch/types.h>
  33.  
  34. #define MAX_OFW_ARGS    10
  35.  
  36. typedef __u32 ofw_arg_t;
  37. typedef __u32 ihandle;
  38. typedef __u32 phandle;
  39.  
  40. /** OpenFirmware command structure
  41.  *
  42.  */
  43. typedef struct {
  44.     const char *service;          /**< Command name */
  45.     __u32 nargs;                  /**< Number of in arguments */
  46.     __u32 nret;                   /**< Number of out arguments */
  47.     ofw_arg_t args[MAX_OFW_ARGS]; /**< List of arguments */
  48. } ofw_args_t;
  49.  
  50. /** OpenFirmware device address range structure
  51.  *
  52.  */
  53. typedef struct {
  54.     __u32 space;
  55.     __u32 address;
  56.     __u32 size;
  57. } address_range_t;
  58.  
  59. /** OpenFirmware device interrupt structure
  60.  *
  61.  */
  62. typedef struct {
  63.     __u32 line;  /**< Interrupt number */
  64.     __u32 flags; /**< Interrupt flags/logic */
  65. } interrupt_info_t;
  66.  
  67. /** OpenFirmware property structure
  68.  *
  69.  */
  70. typedef struct property_t {
  71.     char *name;              /**< Property name */
  72.     __u32 length;            /**< Value length */
  73.     char *value;             /**< Property value */
  74.     struct property_t *next; /**< Next property in list */
  75. } property_t;
  76.  
  77. /** OpenFirmware device descritor
  78.  *
  79.  */
  80. typedef struct device_node_t {
  81.     char *name;                     /**< Device name */
  82.     char *type;                     /**< Device type */
  83.     phandle node;                   /**< Device handle */
  84.    
  85.     __u32 n_addrs;                  /**< Number of address ranges */
  86.     address_range_t *addrs;         /**< Address ranges list */
  87.    
  88.     __u32 n_intrs;                  /**< Number of interrupts */
  89.     interrupt_info_t *intrs;        /**< Interrupts list */
  90.    
  91.     char *full_name;                /**< Device full name */
  92.    
  93.     property_t *properties;         /**< Device properties */
  94.    
  95.     struct device_node_t *parent;   /**< Parent device */
  96.     struct device_node_t *child;    /**< First child in tree */
  97.     struct device_node_t *sibling;  /**< Next device on tree level */
  98.     struct device_node_t *next;     /**< Next device of the same type */
  99.     struct device_node_t *next_all; /**< Next device in list of all nodes */
  100. } device_node_t;
  101.  
  102. typedef void (*ofw_entry)(ofw_args_t *);
  103.  
  104. extern ofw_entry ofw;
  105.  
  106. extern void ofw_init(void);
  107. extern void ofw_done(void);
  108. extern int ofw_call(const char *service, const int nargs, const int nret, ...);
  109. extern void ofw_putchar(const char ch);
  110. extern phandle ofw_find_device(const char *name);
  111. extern int ofw_get_property(const phandle device, const char *name, void *buf, const int buflen);
  112. extern void putchar(const char ch);
  113.  
  114. #endif
  115.