1 /*-
2  * SPDX-License-Identifier: BSD-2-Clause
3  *
4  * Copyright (c) 2016 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 
32 #include <sys/cdefs.h>
33 /*
34  * ChipCommon attachment support for the bhnd(4) PMU driver.
35  *
36  * Supports non-AOB ("Always-on Bus") devices that map the PMU register blocks
37  * via the ChipCommon core, rather than vending a distinct PMU core on the
38  * bhnd bus.
39  */
40 
41 #include <sys/param.h>
42 #include <sys/kernel.h>
43 #include <sys/bus.h>
44 #include <sys/limits.h>
45 #include <sys/malloc.h>
46 #include <sys/module.h>
47 #include <sys/systm.h>
48 
49 #include <dev/bhnd/bhnd.h>
50 
51 #include <dev/bhnd/cores/pmu/bhnd_pmuvar.h>
52 #include <dev/bhnd/cores/pmu/bhnd_pmureg.h>
53 
54 #include "bhnd_chipc_if.h"
55 #include "bhnd_pmu_if.h"
56 
57 #include "chipcvar.h"
58 
59 static int
60 bhnd_pmu_chipc_probe(device_t dev)
61 {
62 	struct chipc_caps	*ccaps;
63 	struct chipc_softc	*chipc_sc;
64 	device_t		 chipc;
65 	char			 desc[34];
66 	int			 error;
67 	uint32_t		 pcaps;
68 	uint8_t			 rev;
69 
70 	/* Look for chipc parent */
71 	chipc = device_get_parent(dev);
72 	if (device_get_devclass(chipc) != devclass_find("bhnd_chipc"))
73 		return (ENXIO);
74 
75 	/* Check the chipc PMU capability flag. */
76 	ccaps = BHND_CHIPC_GET_CAPS(chipc);
77 	if (!ccaps->pmu)
78 		return (ENXIO);
79 
80 	/* Delegate to common driver implementation */
81 	if ((error = bhnd_pmu_probe(dev)) > 0)
82 		return (error);
83 
84 	/* Fetch PMU capability flags */
85 	chipc_sc = device_get_softc(chipc);
86 	pcaps = bhnd_bus_read_4(chipc_sc->core, BHND_PMU_CAP);
87 
88 	/* Set description */
89 	rev = BHND_PMU_GET_BITS(pcaps, BHND_PMU_CAP_REV);
90 	snprintf(desc, sizeof(desc), "Broadcom ChipCommon PMU, rev %hhu", rev);
91 	device_set_desc_copy(dev, desc);
92 
93 	return (BUS_PROBE_NOWILDCARD);
94 }
95 
96 static int
97 bhnd_pmu_chipc_attach(device_t dev)
98 {
99 	struct chipc_softc	*chipc_sc;
100 	struct bhnd_resource	*r;
101 
102 	/* Fetch core registers from ChipCommon parent */
103 	chipc_sc = device_get_softc(device_get_parent(dev));
104 	r = chipc_sc->core;
105 
106 	return (bhnd_pmu_attach(dev, r));
107 }
108 
109 static device_method_t bhnd_pmu_chipc_methods[] = {
110 	/* Device interface */
111 	DEVMETHOD(device_probe,			bhnd_pmu_chipc_probe),
112 	DEVMETHOD(device_attach,		bhnd_pmu_chipc_attach),
113 
114 	DEVMETHOD_END
115 };
116 
117 DEFINE_CLASS_1(bhnd_pmu, bhnd_pmu_chipc_driver, bhnd_pmu_chipc_methods,
118     sizeof(struct bhnd_pmu_softc), bhnd_pmu_driver);
119 EARLY_DRIVER_MODULE(bhnd_pmu_chipc, bhnd_chipc, bhnd_pmu_chipc_driver,
120     NULL, NULL, BUS_PASS_TIMER + BUS_PASS_ORDER_MIDDLE);
121 
122 MODULE_DEPEND(bhnd_pmu_chipc, bhnd, 1, 1, 1);
123 MODULE_VERSION(bhnd_pmu_chipc, 1);
124