1 /*- 2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD 3 * 4 * Copyright (c) 2015 Landon Fuller <landon@landonf.org> 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer, 12 * without modification. 13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer 14 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any 15 * redistribution must be conditioned upon including a substantially 16 * similar Disclaimer requirement for further binary redistribution. 17 * 18 * NO WARRANTY 19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY 22 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL 23 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, 24 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 27 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF 29 * THE POSSIBILITY OF SUCH DAMAGES. 30 * 31 * $FreeBSD$ 32 */ 33 34 #ifndef _BHND_CORES_PMU_BHND_PMUVAR_H_ 35 #define _BHND_CORES_PMU_BHND_PMUVAR_H_ 36 37 #include <sys/types.h> 38 #include <sys/rman.h> 39 40 #include "bhnd_pmu.h" 41 42 struct bhnd_pmu_query; 43 struct bhnd_pmu_io; 44 45 DECLARE_CLASS(bhnd_pmu_driver); 46 47 int bhnd_pmu_probe(device_t dev); 48 int bhnd_pmu_attach(device_t dev, struct bhnd_resource *res); 49 int bhnd_pmu_detach(device_t dev); 50 int bhnd_pmu_suspend(device_t dev); 51 int bhnd_pmu_resume(device_t dev); 52 53 int bhnd_pmu_query_init(struct bhnd_pmu_query *query, device_t dev, 54 struct bhnd_chipid id, const struct bhnd_pmu_io *io, 55 void *ctx); 56 void bhnd_pmu_query_fini(struct bhnd_pmu_query *query); 57 58 uint32_t bhnd_pmu_si_clock(struct bhnd_pmu_query *sc); 59 uint32_t bhnd_pmu_cpu_clock(struct bhnd_pmu_query *sc); 60 uint32_t bhnd_pmu_mem_clock(struct bhnd_pmu_query *sc); 61 uint32_t bhnd_pmu_alp_clock(struct bhnd_pmu_query *sc); 62 uint32_t bhnd_pmu_ilp_clock(struct bhnd_pmu_query *sc); 63 64 /** 65 * PMU read-only query support. 66 * 67 * Provides support for querying PMU information prior to availability of 68 * the bhnd(4) bus. 69 */ 70 struct bhnd_pmu_query { 71 device_t dev; /**< owning device, or NULL */ 72 struct bhnd_chipid cid; /**< chip identification */ 73 uint32_t caps; /**< pmu capability flags. */ 74 75 const struct bhnd_pmu_io *io; /**< I/O operations */ 76 void *io_ctx; /**< I/O callback context */ 77 78 uint32_t ilp_cps; /**< measured ILP cycles per second, or 0 */ 79 }; 80 81 /** 82 * PMU abstract I/O operations. 83 */ 84 struct bhnd_pmu_io { 85 /* Read 4 bytes from PMU @p reg */ 86 uint32_t (*rd4)(bus_size_t reg, void *ctx); 87 88 /* Read 4 bytes to PMU @p reg */ 89 void (*wr4)(bus_size_t reg, uint32_t val, void *ctx); 90 91 /* Read ChipCommon's CHIP_ST register */ 92 uint32_t (*rd_chipst)(void *ctx); 93 }; 94 95 /** 96 * bhnd_pmu driver instance state. 97 */ 98 struct bhnd_pmu_softc { 99 device_t dev; 100 uint32_t caps; /**< pmu capability flags. */ 101 struct bhnd_chipid cid; /**< chip identification */ 102 103 struct bhnd_pmu_query query; /**< query instance */ 104 105 struct bhnd_board_info board; /**< board identification */ 106 device_t chipc_dev; /**< chipcommon device */ 107 108 struct bhnd_resource *res; /**< pmu register block. */ 109 int rid; /**< pmu register RID */ 110 struct bhnd_core_clkctl *clkctl; /**< pmu clkctl register */ 111 112 struct mtx mtx; /**< state mutex */ 113 114 /* For compatibility with bhnd_pmu_query APIs and the shared 115 * BHND_PMU_(READ|WRITE) macros. */ 116 const struct bhnd_pmu_io *io; 117 void *io_ctx; 118 119 }; 120 121 #define BPMU_LOCK_INIT(sc) \ 122 mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), NULL, MTX_DEF) 123 #define BPMU_LOCK(sc) mtx_lock(&(sc)->mtx) 124 #define BPMU_UNLOCK(sc) mtx_unlock(&(sc)->mtx) 125 #define BPMU_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->mtx, what) 126 #define BPMU_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx) 127 128 #endif /* _BHND_CORES_PMU_BHND_PMUVAR_H_ */ 129