1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause 3 * 4 * Copyright (c) 2005 Peter Grehan 5 * Copyright (c) 2008 Nathan Whitehorn 6 * All rights reserved. 7 * 8 * Redistribution and use in source and binary forms, with or without 9 * modification, are permitted provided that the following conditions 10 * are met: 11 * 1. Redistributions of source code must retain the above copyright 12 * notice, this list of conditions and the following disclaimer. 13 * 2. Redistributions in binary form must reproduce the above copyright 14 * notice, this list of conditions and the following disclaimer in the 15 * documentation and/or other materials provided with the distribution. 16 * 17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 27 * SUCH DAMAGE. 28 */ 29 30 #ifndef _DEV_OFW_OFWVAR_H_ 31 #define _DEV_OFW_OFWVAR_H_ 32 33 /* 34 * An Open Firmware client implementation is declared with a kernel object and 35 * an associated method table, similar to a device driver. 36 * 37 * e.g. 38 * 39 * static ofw_method_t fdt_methods[] = { 40 * OFWMETHOD(ofw_init, fdt_init), 41 * OFWMETHOD(ofw_finddevice, fdt_finddevice), 42 * ... 43 * OFWMETHOD(ofw_nextprop, fdt_nextprop), 44 * { 0, 0 } 45 * }; 46 * 47 * static ofw_def_t ofw_fdt = { 48 * "ofw_fdt", 49 * fdt_methods, 50 * sizeof(fdt_softc), // or 0 if no softc 51 * }; 52 * 53 * OFW_DEF(ofw_fdt); 54 */ 55 56 #include <sys/kobj.h> 57 58 struct ofw_kobj { 59 /* 60 * An OFW instance is a kernel object. 61 */ 62 KOBJ_FIELDS; 63 64 /* 65 * Utility elements that an instance may use 66 */ 67 struct mtx ofw_mtx; /* available for instance use */ 68 void *ofw_iptr; /* instance data pointer */ 69 70 /* 71 * Opaque data that can be overlaid with an instance-private 72 * structure. OFW code can test that this is large enough at 73 * compile time with a sizeof() test againt it's softc. There 74 * is also a run-time test when the MMU kernel object is 75 * registered. 76 */ 77 #define OFW_OPAQUESZ 64 78 u_int ofw_opaque[OFW_OPAQUESZ]; 79 }; 80 81 typedef struct ofw_kobj *ofw_t; 82 typedef struct kobj_class ofw_def_t; 83 84 #define ofw_method_t kobj_method_t 85 #define OFWMETHOD KOBJMETHOD 86 87 #define OFW_DEF(name) DATA_SET(ofw_set, name) 88 89 #endif /* _DEV_OFW_OFWVAR_H_ */ 90