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