ofw_bus_subr.h revision 266128
1252190Srpaulo/*- 2252190Srpaulo * Copyright (c) 2005 Marius Strobl <marius@FreeBSD.org> 3252190Srpaulo * All rights reserved. 4252190Srpaulo * 5252190Srpaulo * Redistribution and use in source and binary forms, with or without 6252190Srpaulo * modification, are permitted provided that the following conditions 7252190Srpaulo * are met: 8252190Srpaulo * 1. Redistributions of source code must retain the above copyright 9252190Srpaulo * notice, this list of conditions, and the following disclaimer, 10252190Srpaulo * without modification, immediately at the beginning of the file. 11252190Srpaulo * 2. Redistributions in binary form must reproduce the above copyright 12252190Srpaulo * notice, this list of conditions and the following disclaimer in 13252190Srpaulo * the documentation and/or other materials provided with the 14252190Srpaulo * distribution. 15252190Srpaulo * 16252190Srpaulo * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 17252190Srpaulo * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 18252190Srpaulo * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 19252190Srpaulo * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR 20252190Srpaulo * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 21252190Srpaulo * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 22252190Srpaulo * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 23252190Srpaulo * 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: stable/10/sys/dev/ofw/ofw_bus_subr.h 266128 2014-05-15 14:26:11Z ian $ 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 43struct ofw_bus_iinfo { 44 uint8_t *opi_imap; 45 uint8_t *opi_imapmsk; 46 int opi_imapsz; 47 pcell_t opi_addrc; 48}; 49 50struct ofw_compat_data { 51 const char *ocd_str; 52 uintptr_t ocd_data; 53}; 54 55/* Generic implementation of ofw_bus_if.m methods and helper routines */ 56int ofw_bus_gen_setup_devinfo(struct ofw_bus_devinfo *, phandle_t); 57void ofw_bus_gen_destroy_devinfo(struct ofw_bus_devinfo *); 58 59ofw_bus_get_compat_t ofw_bus_gen_get_compat; 60ofw_bus_get_model_t ofw_bus_gen_get_model; 61ofw_bus_get_name_t ofw_bus_gen_get_name; 62ofw_bus_get_node_t ofw_bus_gen_get_node; 63ofw_bus_get_type_t ofw_bus_gen_get_type; 64 65/* Helper method to report interesting OF properties in pnpinfo */ 66bus_child_pnpinfo_str_t ofw_bus_gen_child_pnpinfo_str; 67 68/* Routines for processing firmware interrupt maps */ 69void ofw_bus_setup_iinfo(phandle_t, struct ofw_bus_iinfo *, int); 70int ofw_bus_lookup_imap(phandle_t, struct ofw_bus_iinfo *, void *, int, 71 void *, int, void *, int, phandle_t *); 72int ofw_bus_search_intrmap(void *, int, void *, int, void *, int, void *, 73 void *, void *, int, phandle_t *); 74 75/* Helper to get device status property */ 76const char *ofw_bus_get_status(device_t dev); 77int ofw_bus_status_okay(device_t dev); 78 79/* Helper to get node's interrupt parent */ 80void ofw_bus_find_iparent(phandle_t); 81 82/* Helper routine for checking compat prop */ 83int ofw_bus_is_compatible(device_t, const char *); 84int ofw_bus_is_compatible_strict(device_t, const char *); 85 86/* 87 * Helper routine to search a list of compat properties. The table is 88 * terminated by an entry with a NULL compat-string pointer; a pointer to that 89 * table entry is returned if none of the compat strings match for the device, 90 * giving you control over the not-found value. Will not return NULL unless the 91 * provided table pointer is NULL. 92 */ 93const struct ofw_compat_data * 94 ofw_bus_search_compatible(device_t, const struct ofw_compat_data *); 95 96/* Helper routine for checking existence of a prop */ 97int ofw_bus_has_prop(device_t, const char *); 98 99#endif /* !_DEV_OFW_OFW_BUS_SUBR_H_ */ 100