1 /*- 2 * Copyright (c) 2015-2016 Landon Fuller <landonf@FreeBSD.org> 3 * Copyright (c) 2017 The FreeBSD Foundation 4 * All rights reserved. 5 * 6 * Portions of this software were developed by Landon Fuller 7 * under sponsorship from the FreeBSD Foundation. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 1. Redistributions of source code must retain the above copyright 13 * notice, this list of conditions and the following disclaimer, 14 * without modification. 15 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 16 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 17 * redistribution must be conditioned upon including a substantially 18 * similar Disclaimer requirement for further binary redistribution. 19 * 20 * NO WARRANTY 21 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 22 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 23 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 24 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 25 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 26 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 27 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 28 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 29 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 30 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 31 * THE POSSIBILITY OF SUCH DAMAGES. 32 * 33 * $FreeBSD$ 34 */ 35 36 #ifndef _BHND_BHNDVAR_H_ 37 #define _BHND_BHNDVAR_H_ 38 39 #include <sys/param.h> 40 #include <sys/bus.h> 41 #include <sys/malloc.h> 42 43 #include "bhnd.h" 44 45 /* 46 * Definitions shared by bhnd(4) bus and bhndb(4) bridge driver implementations. 47 */ 48 49 MALLOC_DECLARE(M_BHND); 50 DECLARE_CLASS(bhnd_driver); 51 52 struct bhnd_core_clkctl; 53 54 struct bhnd_core_clkctl *bhnd_alloc_core_clkctl(device_t dev, 55 device_t pmu_dev, struct bhnd_resource *r, 56 bus_size_t offset, u_int max_latency); 57 void bhnd_free_core_clkctl( 58 struct bhnd_core_clkctl *clkctl); 59 int bhnd_core_clkctl_wait( 60 struct bhnd_core_clkctl *clkctl, 61 uint32_t value, uint32_t mask); 62 63 int bhnd_generic_attach(device_t dev); 64 int bhnd_generic_detach(device_t dev); 65 int bhnd_generic_shutdown(device_t dev); 66 int bhnd_generic_resume(device_t dev); 67 int bhnd_generic_suspend(device_t dev); 68 69 int bhnd_generic_get_probe_order(device_t dev, 70 device_t child); 71 72 int bhnd_generic_alloc_pmu(device_t dev, 73 device_t child); 74 int bhnd_generic_release_pmu(device_t dev, 75 device_t child); 76 int bhnd_generic_get_clock_latency(device_t dev, 77 device_t child, bhnd_clock clock, 78 u_int *latency); 79 int bhnd_generic_get_clock_freq(device_t dev, 80 device_t child, bhnd_clock clock, 81 u_int *freq); 82 int bhnd_generic_request_clock(device_t dev, 83 device_t child, bhnd_clock clock); 84 int bhnd_generic_enable_clocks(device_t dev, 85 device_t child, uint32_t clocks); 86 int bhnd_generic_request_ext_rsrc(device_t dev, 87 device_t child, u_int rsrc); 88 int bhnd_generic_release_ext_rsrc(device_t dev, 89 device_t child, u_int rsrc); 90 91 int bhnd_generic_print_child(device_t dev, 92 device_t child); 93 void bhnd_generic_probe_nomatch(device_t dev, 94 device_t child); 95 96 void bhnd_generic_child_deleted(device_t dev, 97 device_t child); 98 int bhnd_generic_suspend_child(device_t dev, 99 device_t child); 100 int bhnd_generic_resume_child(device_t dev, 101 device_t child); 102 103 int bhnd_generic_setup_intr(device_t dev, 104 device_t child, struct resource *irq, 105 int flags, driver_filter_t *filter, 106 driver_intr_t *intr, void *arg, 107 void **cookiep); 108 109 int bhnd_generic_get_nvram_var(device_t dev, 110 device_t child, const char *name, 111 void *buf, size_t *size, 112 bhnd_nvram_type type); 113 114 /** 115 * bhnd driver instance state. Must be first member of all subclass 116 * softc structures. 117 */ 118 struct bhnd_softc { 119 device_t dev; /**< bus device */ 120 }; 121 122 #endif /* _BHND_BHNDVAR_H_ */ 123