1*e2ad626fSUlf Hansson // SPDX-License-Identifier: GPL-2.0
2*e2ad626fSUlf Hansson /* (C) 2015 Pengutronix, Alexander Aring <aar@pengutronix.de>
3*e2ad626fSUlf Hansson *
4*e2ad626fSUlf Hansson * Authors:
5*e2ad626fSUlf Hansson * Alexander Aring <aar@pengutronix.de>
6*e2ad626fSUlf Hansson * Eric Anholt <eric@anholt.net>
7*e2ad626fSUlf Hansson */
8*e2ad626fSUlf Hansson
9*e2ad626fSUlf Hansson #include <linux/module.h>
10*e2ad626fSUlf Hansson #include <linux/of.h>
11*e2ad626fSUlf Hansson #include <linux/platform_device.h>
12*e2ad626fSUlf Hansson #include <linux/pm_domain.h>
13*e2ad626fSUlf Hansson #include <dt-bindings/power/raspberrypi-power.h>
14*e2ad626fSUlf Hansson #include <soc/bcm2835/raspberrypi-firmware.h>
15*e2ad626fSUlf Hansson
16*e2ad626fSUlf Hansson /*
17*e2ad626fSUlf Hansson * Firmware indices for the old power domains interface. Only a few
18*e2ad626fSUlf Hansson * of them were actually implemented.
19*e2ad626fSUlf Hansson */
20*e2ad626fSUlf Hansson #define RPI_OLD_POWER_DOMAIN_USB 3
21*e2ad626fSUlf Hansson #define RPI_OLD_POWER_DOMAIN_V3D 10
22*e2ad626fSUlf Hansson
23*e2ad626fSUlf Hansson struct rpi_power_domain {
24*e2ad626fSUlf Hansson u32 domain;
25*e2ad626fSUlf Hansson bool enabled;
26*e2ad626fSUlf Hansson bool old_interface;
27*e2ad626fSUlf Hansson struct generic_pm_domain base;
28*e2ad626fSUlf Hansson struct rpi_firmware *fw;
29*e2ad626fSUlf Hansson };
30*e2ad626fSUlf Hansson
31*e2ad626fSUlf Hansson struct rpi_power_domains {
32*e2ad626fSUlf Hansson bool has_new_interface;
33*e2ad626fSUlf Hansson struct genpd_onecell_data xlate;
34*e2ad626fSUlf Hansson struct rpi_firmware *fw;
35*e2ad626fSUlf Hansson struct rpi_power_domain domains[RPI_POWER_DOMAIN_COUNT];
36*e2ad626fSUlf Hansson };
37*e2ad626fSUlf Hansson
38*e2ad626fSUlf Hansson /*
39*e2ad626fSUlf Hansson * Packet definition used by RPI_FIRMWARE_SET_POWER_STATE and
40*e2ad626fSUlf Hansson * RPI_FIRMWARE_SET_DOMAIN_STATE
41*e2ad626fSUlf Hansson */
42*e2ad626fSUlf Hansson struct rpi_power_domain_packet {
43*e2ad626fSUlf Hansson u32 domain;
44*e2ad626fSUlf Hansson u32 on;
45*e2ad626fSUlf Hansson };
46*e2ad626fSUlf Hansson
47*e2ad626fSUlf Hansson /*
48*e2ad626fSUlf Hansson * Asks the firmware to enable or disable power on a specific power
49*e2ad626fSUlf Hansson * domain.
50*e2ad626fSUlf Hansson */
rpi_firmware_set_power(struct rpi_power_domain * rpi_domain,bool on)51*e2ad626fSUlf Hansson static int rpi_firmware_set_power(struct rpi_power_domain *rpi_domain, bool on)
52*e2ad626fSUlf Hansson {
53*e2ad626fSUlf Hansson struct rpi_power_domain_packet packet;
54*e2ad626fSUlf Hansson
55*e2ad626fSUlf Hansson packet.domain = rpi_domain->domain;
56*e2ad626fSUlf Hansson packet.on = on;
57*e2ad626fSUlf Hansson return rpi_firmware_property(rpi_domain->fw,
58*e2ad626fSUlf Hansson rpi_domain->old_interface ?
59*e2ad626fSUlf Hansson RPI_FIRMWARE_SET_POWER_STATE :
60*e2ad626fSUlf Hansson RPI_FIRMWARE_SET_DOMAIN_STATE,
61*e2ad626fSUlf Hansson &packet, sizeof(packet));
62*e2ad626fSUlf Hansson }
63*e2ad626fSUlf Hansson
rpi_domain_off(struct generic_pm_domain * domain)64*e2ad626fSUlf Hansson static int rpi_domain_off(struct generic_pm_domain *domain)
65*e2ad626fSUlf Hansson {
66*e2ad626fSUlf Hansson struct rpi_power_domain *rpi_domain =
67*e2ad626fSUlf Hansson container_of(domain, struct rpi_power_domain, base);
68*e2ad626fSUlf Hansson
69*e2ad626fSUlf Hansson return rpi_firmware_set_power(rpi_domain, false);
70*e2ad626fSUlf Hansson }
71*e2ad626fSUlf Hansson
rpi_domain_on(struct generic_pm_domain * domain)72*e2ad626fSUlf Hansson static int rpi_domain_on(struct generic_pm_domain *domain)
73*e2ad626fSUlf Hansson {
74*e2ad626fSUlf Hansson struct rpi_power_domain *rpi_domain =
75*e2ad626fSUlf Hansson container_of(domain, struct rpi_power_domain, base);
76*e2ad626fSUlf Hansson
77*e2ad626fSUlf Hansson return rpi_firmware_set_power(rpi_domain, true);
78*e2ad626fSUlf Hansson }
79*e2ad626fSUlf Hansson
rpi_common_init_power_domain(struct rpi_power_domains * rpi_domains,int xlate_index,const char * name)80*e2ad626fSUlf Hansson static void rpi_common_init_power_domain(struct rpi_power_domains *rpi_domains,
81*e2ad626fSUlf Hansson int xlate_index, const char *name)
82*e2ad626fSUlf Hansson {
83*e2ad626fSUlf Hansson struct rpi_power_domain *dom = &rpi_domains->domains[xlate_index];
84*e2ad626fSUlf Hansson
85*e2ad626fSUlf Hansson dom->fw = rpi_domains->fw;
86*e2ad626fSUlf Hansson
87*e2ad626fSUlf Hansson dom->base.name = name;
88*e2ad626fSUlf Hansson dom->base.power_on = rpi_domain_on;
89*e2ad626fSUlf Hansson dom->base.power_off = rpi_domain_off;
90*e2ad626fSUlf Hansson
91*e2ad626fSUlf Hansson /*
92*e2ad626fSUlf Hansson * Treat all power domains as off at boot.
93*e2ad626fSUlf Hansson *
94*e2ad626fSUlf Hansson * The firmware itself may be keeping some domains on, but
95*e2ad626fSUlf Hansson * from Linux's perspective all we control is the refcounts
96*e2ad626fSUlf Hansson * that we give to the firmware, and we can't ask the firmware
97*e2ad626fSUlf Hansson * to turn off something that we haven't ourselves turned on.
98*e2ad626fSUlf Hansson */
99*e2ad626fSUlf Hansson pm_genpd_init(&dom->base, NULL, true);
100*e2ad626fSUlf Hansson
101*e2ad626fSUlf Hansson rpi_domains->xlate.domains[xlate_index] = &dom->base;
102*e2ad626fSUlf Hansson }
103*e2ad626fSUlf Hansson
rpi_init_power_domain(struct rpi_power_domains * rpi_domains,int xlate_index,const char * name)104*e2ad626fSUlf Hansson static void rpi_init_power_domain(struct rpi_power_domains *rpi_domains,
105*e2ad626fSUlf Hansson int xlate_index, const char *name)
106*e2ad626fSUlf Hansson {
107*e2ad626fSUlf Hansson struct rpi_power_domain *dom = &rpi_domains->domains[xlate_index];
108*e2ad626fSUlf Hansson
109*e2ad626fSUlf Hansson if (!rpi_domains->has_new_interface)
110*e2ad626fSUlf Hansson return;
111*e2ad626fSUlf Hansson
112*e2ad626fSUlf Hansson /* The DT binding index is the firmware's domain index minus one. */
113*e2ad626fSUlf Hansson dom->domain = xlate_index + 1;
114*e2ad626fSUlf Hansson
115*e2ad626fSUlf Hansson rpi_common_init_power_domain(rpi_domains, xlate_index, name);
116*e2ad626fSUlf Hansson }
117*e2ad626fSUlf Hansson
rpi_init_old_power_domain(struct rpi_power_domains * rpi_domains,int xlate_index,int domain,const char * name)118*e2ad626fSUlf Hansson static void rpi_init_old_power_domain(struct rpi_power_domains *rpi_domains,
119*e2ad626fSUlf Hansson int xlate_index, int domain,
120*e2ad626fSUlf Hansson const char *name)
121*e2ad626fSUlf Hansson {
122*e2ad626fSUlf Hansson struct rpi_power_domain *dom = &rpi_domains->domains[xlate_index];
123*e2ad626fSUlf Hansson
124*e2ad626fSUlf Hansson dom->old_interface = true;
125*e2ad626fSUlf Hansson dom->domain = domain;
126*e2ad626fSUlf Hansson
127*e2ad626fSUlf Hansson rpi_common_init_power_domain(rpi_domains, xlate_index, name);
128*e2ad626fSUlf Hansson }
129*e2ad626fSUlf Hansson
130*e2ad626fSUlf Hansson /*
131*e2ad626fSUlf Hansson * Detects whether the firmware supports the new power domains interface.
132*e2ad626fSUlf Hansson *
133*e2ad626fSUlf Hansson * The firmware doesn't actually return an error on an unknown tag,
134*e2ad626fSUlf Hansson * and just skips over it, so we do the detection by putting an
135*e2ad626fSUlf Hansson * unexpected value in the return field and checking if it was
136*e2ad626fSUlf Hansson * unchanged.
137*e2ad626fSUlf Hansson */
138*e2ad626fSUlf Hansson static bool
rpi_has_new_domain_support(struct rpi_power_domains * rpi_domains)139*e2ad626fSUlf Hansson rpi_has_new_domain_support(struct rpi_power_domains *rpi_domains)
140*e2ad626fSUlf Hansson {
141*e2ad626fSUlf Hansson struct rpi_power_domain_packet packet;
142*e2ad626fSUlf Hansson int ret;
143*e2ad626fSUlf Hansson
144*e2ad626fSUlf Hansson packet.domain = RPI_POWER_DOMAIN_ARM;
145*e2ad626fSUlf Hansson packet.on = ~0;
146*e2ad626fSUlf Hansson
147*e2ad626fSUlf Hansson ret = rpi_firmware_property(rpi_domains->fw,
148*e2ad626fSUlf Hansson RPI_FIRMWARE_GET_DOMAIN_STATE,
149*e2ad626fSUlf Hansson &packet, sizeof(packet));
150*e2ad626fSUlf Hansson
151*e2ad626fSUlf Hansson return ret == 0 && packet.on != ~0;
152*e2ad626fSUlf Hansson }
153*e2ad626fSUlf Hansson
rpi_power_probe(struct platform_device * pdev)154*e2ad626fSUlf Hansson static int rpi_power_probe(struct platform_device *pdev)
155*e2ad626fSUlf Hansson {
156*e2ad626fSUlf Hansson struct device_node *fw_np;
157*e2ad626fSUlf Hansson struct device *dev = &pdev->dev;
158*e2ad626fSUlf Hansson struct rpi_power_domains *rpi_domains;
159*e2ad626fSUlf Hansson
160*e2ad626fSUlf Hansson rpi_domains = devm_kzalloc(dev, sizeof(*rpi_domains), GFP_KERNEL);
161*e2ad626fSUlf Hansson if (!rpi_domains)
162*e2ad626fSUlf Hansson return -ENOMEM;
163*e2ad626fSUlf Hansson
164*e2ad626fSUlf Hansson rpi_domains->xlate.domains =
165*e2ad626fSUlf Hansson devm_kcalloc(dev,
166*e2ad626fSUlf Hansson RPI_POWER_DOMAIN_COUNT,
167*e2ad626fSUlf Hansson sizeof(*rpi_domains->xlate.domains),
168*e2ad626fSUlf Hansson GFP_KERNEL);
169*e2ad626fSUlf Hansson if (!rpi_domains->xlate.domains)
170*e2ad626fSUlf Hansson return -ENOMEM;
171*e2ad626fSUlf Hansson
172*e2ad626fSUlf Hansson rpi_domains->xlate.num_domains = RPI_POWER_DOMAIN_COUNT;
173*e2ad626fSUlf Hansson
174*e2ad626fSUlf Hansson fw_np = of_parse_phandle(pdev->dev.of_node, "firmware", 0);
175*e2ad626fSUlf Hansson if (!fw_np) {
176*e2ad626fSUlf Hansson dev_err(&pdev->dev, "no firmware node\n");
177*e2ad626fSUlf Hansson return -ENODEV;
178*e2ad626fSUlf Hansson }
179*e2ad626fSUlf Hansson
180*e2ad626fSUlf Hansson rpi_domains->fw = devm_rpi_firmware_get(&pdev->dev, fw_np);
181*e2ad626fSUlf Hansson of_node_put(fw_np);
182*e2ad626fSUlf Hansson if (!rpi_domains->fw)
183*e2ad626fSUlf Hansson return -EPROBE_DEFER;
184*e2ad626fSUlf Hansson
185*e2ad626fSUlf Hansson rpi_domains->has_new_interface =
186*e2ad626fSUlf Hansson rpi_has_new_domain_support(rpi_domains);
187*e2ad626fSUlf Hansson
188*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_I2C0, "I2C0");
189*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_I2C1, "I2C1");
190*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_I2C2, "I2C2");
191*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_VIDEO_SCALER,
192*e2ad626fSUlf Hansson "VIDEO_SCALER");
193*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_VPU1, "VPU1");
194*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_HDMI, "HDMI");
195*e2ad626fSUlf Hansson
196*e2ad626fSUlf Hansson /*
197*e2ad626fSUlf Hansson * Use the old firmware interface for USB power, so that we
198*e2ad626fSUlf Hansson * can turn it on even if the firmware hasn't been updated.
199*e2ad626fSUlf Hansson */
200*e2ad626fSUlf Hansson rpi_init_old_power_domain(rpi_domains, RPI_POWER_DOMAIN_USB,
201*e2ad626fSUlf Hansson RPI_OLD_POWER_DOMAIN_USB, "USB");
202*e2ad626fSUlf Hansson
203*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_VEC, "VEC");
204*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_JPEG, "JPEG");
205*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_H264, "H264");
206*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_V3D, "V3D");
207*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_ISP, "ISP");
208*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_UNICAM0, "UNICAM0");
209*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_UNICAM1, "UNICAM1");
210*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_CCP2RX, "CCP2RX");
211*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_CSI2, "CSI2");
212*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_CPI, "CPI");
213*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_DSI0, "DSI0");
214*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_DSI1, "DSI1");
215*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_TRANSPOSER,
216*e2ad626fSUlf Hansson "TRANSPOSER");
217*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_CCP2TX, "CCP2TX");
218*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_CDP, "CDP");
219*e2ad626fSUlf Hansson rpi_init_power_domain(rpi_domains, RPI_POWER_DOMAIN_ARM, "ARM");
220*e2ad626fSUlf Hansson
221*e2ad626fSUlf Hansson of_genpd_add_provider_onecell(dev->of_node, &rpi_domains->xlate);
222*e2ad626fSUlf Hansson
223*e2ad626fSUlf Hansson platform_set_drvdata(pdev, rpi_domains);
224*e2ad626fSUlf Hansson
225*e2ad626fSUlf Hansson return 0;
226*e2ad626fSUlf Hansson }
227*e2ad626fSUlf Hansson
228*e2ad626fSUlf Hansson static const struct of_device_id rpi_power_of_match[] = {
229*e2ad626fSUlf Hansson { .compatible = "raspberrypi,bcm2835-power", },
230*e2ad626fSUlf Hansson {},
231*e2ad626fSUlf Hansson };
232*e2ad626fSUlf Hansson MODULE_DEVICE_TABLE(of, rpi_power_of_match);
233*e2ad626fSUlf Hansson
234*e2ad626fSUlf Hansson static struct platform_driver rpi_power_driver = {
235*e2ad626fSUlf Hansson .driver = {
236*e2ad626fSUlf Hansson .name = "raspberrypi-power",
237*e2ad626fSUlf Hansson .of_match_table = rpi_power_of_match,
238*e2ad626fSUlf Hansson },
239*e2ad626fSUlf Hansson .probe = rpi_power_probe,
240*e2ad626fSUlf Hansson };
241*e2ad626fSUlf Hansson builtin_platform_driver(rpi_power_driver);
242*e2ad626fSUlf Hansson
243*e2ad626fSUlf Hansson MODULE_AUTHOR("Alexander Aring <aar@pengutronix.de>");
244*e2ad626fSUlf Hansson MODULE_AUTHOR("Eric Anholt <eric@anholt.net>");
245*e2ad626fSUlf Hansson MODULE_DESCRIPTION("Raspberry Pi power domain driver");
246