sys/dev/ofw/ofw_bus_subr.h

   1 /*-
   2  * Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org>
   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  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions, and the following disclaimer,
  10  *    without modification, immediately at the beginning of the file.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in
  13  *    the documentation and/or other materials provided with the
  14  *    distribution.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  20  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26  * SUCH DAMAGE.
  27  *
  28  * $FreeBSD$
  29  */
  30
  31 #ifndef _DEV_OFW_OFW_BUS_SUBR_H_
  32 #define _DEV_OFW_OFW_BUS_SUBR_H_
  33
  34 #include <sys/bus.h>
  35
  36 #include <dev/ofw/openfirm.h>
  37
  38 #include "ofw_bus_if.h"
  39
  40 #define ORIP_NOINT      -1
  41 #define ORIR_NOTFOUND   0xffffffff
  42
  43 struct ofw_bus_iinfo {
  44         uint8_t                 *opi_imap;
  45         uint8_t                 *opi_imapmsk;
  46         int                     opi_imapsz;
  47         pcell_t                 opi_addrc;
  48 };
  49
  50 struct ofw_compat_data {
  51         const char      *ocd_str;
  52         uintptr_t        ocd_data;
  53 };
  54
  55 #define SIMPLEBUS_PNP_DESCR "Z:compat;P:private;"
  56 #define SIMPLEBUS_PNP_INFO(t) \
  57         MODULE_PNP_INFO(SIMPLEBUS_PNP_DESCR, simplebus, t, t, sizeof(t[0]), sizeof(t) / sizeof(t[0]));
  58
  59 /* Generic implementation of ofw_bus_if.m methods and helper routines */
  60 int     ofw_bus_gen_setup_devinfo(struct ofw_bus_devinfo *, phandle_t);
  61 void    ofw_bus_gen_destroy_devinfo(struct ofw_bus_devinfo *);
  62
  63 ofw_bus_get_compat_t    ofw_bus_gen_get_compat;
  64 ofw_bus_get_model_t     ofw_bus_gen_get_model;
  65 ofw_bus_get_name_t      ofw_bus_gen_get_name;
  66 ofw_bus_get_node_t      ofw_bus_gen_get_node;
  67 ofw_bus_get_type_t      ofw_bus_gen_get_type;
  68
  69 /* Helper method to report interesting OF properties in pnpinfo */
  70 bus_child_pnpinfo_str_t ofw_bus_gen_child_pnpinfo_str;
  71
  72 /* Routines for processing firmware interrupt maps */
  73 void    ofw_bus_setup_iinfo(phandle_t, struct ofw_bus_iinfo *, int);
  74 int     ofw_bus_lookup_imap(phandle_t, struct ofw_bus_iinfo *, void *, int,
  75             void *, int, void *, int, phandle_t *);
  76 int     ofw_bus_search_intrmap(void *, int, void *, int, void *, int, void *,
  77             void *, void *, int, phandle_t *);
  78
  79 /* Routines for parsing device-tree data into resource lists. */
  80 int ofw_bus_reg_to_rl(device_t, phandle_t, pcell_t, pcell_t,
  81     struct resource_list *);
  82 int ofw_bus_intr_to_rl(device_t, phandle_t, struct resource_list *, int *);
  83
  84 /* Helper to get device status property */
  85 const char *ofw_bus_get_status(device_t dev);
  86 int ofw_bus_status_okay(device_t dev);
  87
  88 /* Helper to get node's interrupt parent */
  89 phandle_t ofw_bus_find_iparent(phandle_t);
  90
  91 /* Helper routine for checking compat prop */
  92 int ofw_bus_is_compatible(device_t, const char *);
  93 int ofw_bus_is_compatible_strict(device_t, const char *);
  94
  95 /*
  96  * Helper routine to search a list of compat properties.  The table is
  97  * terminated by an entry with a NULL compat-string pointer; a pointer to that
  98  * table entry is returned if none of the compat strings match for the device,
  99  * giving you control over the not-found value.  Will not return NULL unless the
 100  * provided table pointer is NULL.
 101  */
 102 const struct ofw_compat_data *
 103     ofw_bus_search_compatible(device_t, const struct ofw_compat_data *);
 104
 105 /* Helper routine for checking existence of a prop */
 106 int ofw_bus_has_prop(device_t, const char *);
 107
 108 /* Helper to search for a child with a given compat prop */
 109 phandle_t ofw_bus_find_compatible(phandle_t, const char *);
 110
 111 /* Helper to search for a child with a given name */
 112 phandle_t ofw_bus_find_child(phandle_t, const char *);
 113
 114 /* Helper routine to find a device_t child matchig a given phandle_t */
 115 device_t ofw_bus_find_child_device_by_phandle(device_t bus, phandle_t node);
 116
 117 /* Helper routines for parsing lists  */
 118 int ofw_bus_parse_xref_list_alloc(phandle_t node, const char *list_name,
 119     const char *cells_name, int idx, phandle_t *producer, int *ncells,
 120     pcell_t **cells);
 121 int ofw_bus_find_string_index(phandle_t node, const char *list_name,
 122     const char *name, int *idx);
 123 int ofw_bus_string_list_to_array(phandle_t node, const char *list_name,
 124     const char ***array);
 125
 126 #endif /* !_DEV_OFW_OFW_BUS_SUBR_H_ */