1 /*- 2 * Copyright (c) 2015-2016 Landon Fuller <landonf@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. 11 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 12 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 13 * redistribution must be conditioned upon including a substantially 14 * similar Disclaimer requirement for further binary redistribution. 15 * 16 * NO WARRANTY 17 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 20 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 21 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 22 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 26 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 27 * THE POSSIBILITY OF SUCH DAMAGES. 28 * 29 * $FreeBSD$ 30 */ 31 32 #ifndef _BHND_BHNDVAR_H_ 33 #define _BHND_BHNDVAR_H_ 34 35 #include <sys/param.h> 36 #include <sys/bus.h> 37 #include <sys/malloc.h> 38 39 #include "bhnd.h" 40 41 /* 42 * Definitions shared by bhnd(4) bus and bhndb(4) bridge driver implementations. 43 */ 44 45 MALLOC_DECLARE(M_BHND); 46 DECLARE_CLASS(bhnd_driver); 47 48 struct bhnd_core_pmu_info; 49 50 int bhnd_generic_attach(device_t dev); 51 int bhnd_generic_detach(device_t dev); 52 int bhnd_generic_shutdown(device_t dev); 53 int bhnd_generic_resume(device_t dev); 54 int bhnd_generic_suspend(device_t dev); 55 56 int bhnd_generic_get_probe_order(device_t dev, 57 device_t child); 58 59 int bhnd_generic_alloc_pmu(device_t dev, 60 device_t child); 61 int bhnd_generic_release_pmu(device_t dev, 62 device_t child); 63 int bhnd_generic_request_clock(device_t dev, 64 device_t child, bhnd_clock clock); 65 int bhnd_generic_enable_clocks(device_t dev, 66 device_t child, uint32_t clocks); 67 int bhnd_generic_request_ext_rsrc(device_t dev, 68 device_t child, u_int rsrc); 69 int bhnd_generic_release_ext_rsrc(device_t dev, 70 device_t child, u_int rsrc); 71 72 int bhnd_generic_print_child(device_t dev, 73 device_t child); 74 void bhnd_generic_probe_nomatch(device_t dev, 75 device_t child); 76 77 device_t bhnd_generic_add_child(device_t dev, u_int order, 78 const char *name, int unit); 79 void bhnd_generic_child_added(device_t dev, device_t child); 80 void bhnd_generic_child_deleted(device_t dev, 81 device_t child); 82 int bhnd_generic_suspend_child(device_t dev, 83 device_t child); 84 int bhnd_generic_resume_child(device_t dev, 85 device_t child); 86 87 int bhnd_generic_get_nvram_var(device_t dev, 88 device_t child, const char *name, void *buf, 89 size_t *size, bhnd_nvram_type type); 90 91 92 /** 93 * bhnd per-device info. Must be first member of all subclass 94 * devinfo structures. 95 */ 96 struct bhnd_devinfo { 97 struct bhnd_core_pmu_info *pmu_info; /**< PMU info, or NULL */ 98 }; 99 100 /** 101 * bhnd driver instance state. Must be first member of all subclass 102 * softc structures. 103 */ 104 struct bhnd_softc { 105 device_t dev; /**< bus device */ 106 107 bool attach_done; /**< true if initialization of 108 * all platform devices has 109 * been completed */ 110 device_t chipc_dev; /**< bhnd_chipc device */ 111 device_t nvram_dev; /**< bhnd_nvram device, if any */ 112 device_t pmu_dev; /**< bhnd_pmu device, if any */ 113 }; 114 115 #endif /* _BHND_BHNDVAR_H_ */ 116