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 struct intr_map_data_fdt {
  56         struct intr_map_data    hdr;
  57         phandle_t               iparent;
  58         u_int                   ncells;
  59         pcell_t                 *cells;
  60 };
  61
  62 #define SIMPLEBUS_PNP_DESCR "Z:compat;P:private;"
  63 #define SIMPLEBUS_PNP_INFO(t) \
  64         MODULE_PNP_INFO(SIMPLEBUS_PNP_DESCR, simplebus, t, t, sizeof(t[0]), sizeof(t) / sizeof(t[0]));
  65
  66 /* Generic implementation of ofw_bus_if.m methods and helper routines */
  67 int     ofw_bus_gen_setup_devinfo(struct ofw_bus_devinfo *, phandle_t);
  68 void    ofw_bus_gen_destroy_devinfo(struct ofw_bus_devinfo *);
  69
  70 ofw_bus_get_compat_t    ofw_bus_gen_get_compat;
  71 ofw_bus_get_model_t     ofw_bus_gen_get_model;
  72 ofw_bus_get_name_t      ofw_bus_gen_get_name;
  73 ofw_bus_get_node_t      ofw_bus_gen_get_node;
  74 ofw_bus_get_type_t      ofw_bus_gen_get_type;
  75
  76 /* Helper method to report interesting OF properties in pnpinfo */
  77 bus_child_pnpinfo_str_t ofw_bus_gen_child_pnpinfo_str;
  78
  79 /* Routines for processing firmware interrupt maps */
  80 void    ofw_bus_setup_iinfo(phandle_t, struct ofw_bus_iinfo *, int);
  81 int     ofw_bus_lookup_imap(phandle_t, struct ofw_bus_iinfo *, void *, int,
  82             void *, int, void *, int, phandle_t *);
  83 int     ofw_bus_search_intrmap(void *, int, void *, int, void *, int, void *,
  84             void *, void *, int, phandle_t *);
  85
  86 /* Routines for processing msi maps */
  87 int ofw_bus_msimap(phandle_t, uint16_t, phandle_t *, uint32_t *);
  88
  89 /* Routines for parsing device-tree data into resource lists. */
  90 int ofw_bus_reg_to_rl(device_t, phandle_t, pcell_t, pcell_t,
  91     struct resource_list *);
  92 #ifndef INTRNG
  93 int ofw_bus_intr_to_rl(device_t, phandle_t, struct resource_list *, int *);
  94 #endif
  95 int ofw_bus_intr_by_rid(device_t, phandle_t, int, phandle_t *, int *,
  96     pcell_t **);
  97
  98 /* Helper to get device status property */
  99 const char *ofw_bus_get_status(device_t dev);
 100 int ofw_bus_status_okay(device_t dev);
 101
 102 /* Helper to get node's interrupt parent */
 103 phandle_t ofw_bus_find_iparent(phandle_t);
 104
 105 /* Helper routine for checking compat prop */
 106 int ofw_bus_is_compatible(device_t, const char *);
 107 int ofw_bus_is_compatible_strict(device_t, const char *);
 108
 109 /*
 110  * Helper routine to search a list of compat properties.  The table is
 111  * terminated by an entry with a NULL compat-string pointer; a pointer to that
 112  * table entry is returned if none of the compat strings match for the device,
 113  * giving you control over the not-found value.  Will not return NULL unless the
 114  * provided table pointer is NULL.
 115  */
 116 const struct ofw_compat_data *
 117     ofw_bus_search_compatible(device_t, const struct ofw_compat_data *);
 118
 119 /* Helper routine for checking existence of a prop */
 120 int ofw_bus_has_prop(device_t, const char *);
 121
 122 /* Helper to search for a child with a given compat prop */
 123 phandle_t ofw_bus_find_compatible(phandle_t, const char *);
 124
 125 /* Helper to search for a child with a given name */
 126 phandle_t ofw_bus_find_child(phandle_t, const char *);
 127
 128 /* Helper routine to find a device_t child matching a given phandle_t */
 129 device_t ofw_bus_find_child_device_by_phandle(device_t bus, phandle_t node);
 130
 131 /* Helper routines for parsing lists  */
 132 int ofw_bus_parse_xref_list_alloc(phandle_t node, const char *list_name,
 133     const char *cells_name, int idx, phandle_t *producer, int *ncells,
 134     pcell_t **cells);
 135 int ofw_bus_parse_xref_list_get_length(phandle_t node, const char *list_name,
 136     const char *cells_name, int *count);
 137 int ofw_bus_find_string_index(phandle_t node, const char *list_name,
 138     const char *name, int *idx);
 139 int ofw_bus_string_list_to_array(phandle_t node, const char *list_name,
 140     const char ***array);
 141
 142 #endif /* !_DEV_OFW_OFW_BUS_SUBR_H_ */