2 * Copyright (c) 2015 Landon Fuller <landon@landonf.org>
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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.
32 #ifndef _BHND_CORES_PMU_BHND_PMUVAR_H_
33 #define _BHND_CORES_PMU_BHND_PMUVAR_H_
35 #include <sys/types.h>
40 struct bhnd_pmu_query;
43 DECLARE_CLASS(bhnd_pmu_driver);
44 extern devclass_t bhnd_pmu_devclass;
46 int bhnd_pmu_probe(device_t dev);
47 int bhnd_pmu_attach(device_t dev, struct bhnd_resource *res);
48 int bhnd_pmu_detach(device_t dev);
49 int bhnd_pmu_suspend(device_t dev);
50 int bhnd_pmu_resume(device_t dev);
52 int bhnd_pmu_query_init(struct bhnd_pmu_query *query, device_t dev,
53 struct bhnd_chipid id, const struct bhnd_pmu_io *io,
55 void bhnd_pmu_query_fini(struct bhnd_pmu_query *query);
57 uint32_t bhnd_pmu_si_clock(struct bhnd_pmu_query *sc);
58 uint32_t bhnd_pmu_cpu_clock(struct bhnd_pmu_query *sc);
59 uint32_t bhnd_pmu_mem_clock(struct bhnd_pmu_query *sc);
60 uint32_t bhnd_pmu_alp_clock(struct bhnd_pmu_query *sc);
61 uint32_t bhnd_pmu_ilp_clock(struct bhnd_pmu_query *sc);
64 * PMU read-only query support.
66 * Provides support for querying PMU information prior to availability of
69 struct bhnd_pmu_query {
70 device_t dev; /**< owning device, or NULL */
71 struct bhnd_chipid cid; /**< chip identification */
72 uint32_t caps; /**< pmu capability flags. */
74 const struct bhnd_pmu_io *io; /**< I/O operations */
75 void *io_ctx; /**< I/O callback context */
77 uint32_t ilp_cps; /**< measured ILP cycles per second, or 0 */
81 * PMU abstract I/O operations.
84 /* Read 4 bytes from PMU @p reg */
85 uint32_t (*rd4)(bus_size_t reg, void *ctx);
87 /* Read 4 bytes to PMU @p reg */
88 void (*wr4)(bus_size_t reg, uint32_t val, void *ctx);
90 /* Read ChipCommon's CHIP_ST register */
91 uint32_t (*rd_chipst)(void *ctx);
95 * bhnd_pmu driver instance state.
97 struct bhnd_pmu_softc {
99 uint32_t caps; /**< pmu capability flags. */
100 struct bhnd_chipid cid; /**< chip identification */
102 struct bhnd_pmu_query query; /**< query instance */
104 struct bhnd_board_info board; /**< board identification */
105 device_t chipc_dev; /**< chipcommon device */
107 struct bhnd_resource *res; /**< pmu register block. */
108 int rid; /**< pmu register RID */
109 struct bhnd_core_clkctl *clkctl; /**< pmu clkctl register */
111 struct mtx mtx; /**< state mutex */
113 /* For compatibility with bhnd_pmu_query APIs and the shared
114 * BHND_PMU_(READ|WRITE) macros. */
115 const struct bhnd_pmu_io *io;
120 #define BPMU_LOCK_INIT(sc) \
121 mtx_init(&(sc)->mtx, device_get_nameunit((sc)->dev), NULL, MTX_DEF)
122 #define BPMU_LOCK(sc) mtx_lock(&(sc)->mtx)
123 #define BPMU_UNLOCK(sc) mtx_unlock(&(sc)->mtx)
124 #define BPMU_LOCK_ASSERT(sc, what) mtx_assert(&(sc)->mtx, what)
125 #define BPMU_LOCK_DESTROY(sc) mtx_destroy(&(sc)->mtx)
127 #endif /* _BHND_CORES_PMU_BHND_PMUVAR_H_ */