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