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