1 // SPDX-License-Identifier: GPL-2.0+
2 /*
3 * Copyright (C) 2016 Freescale Semiconductor, Inc.
4 * Copyright 2017-2018 NXP
5 * Dong Aisheng <aisheng.dong@nxp.com>
6 *
7 * Implementation of the SCU based Power Domains
8 *
9 * NOTE: a better implementation suggested by Ulf Hansson is using a
10 * single global power domain and implement the ->attach|detach_dev()
11 * callback for the genpd and use the regular of_genpd_add_provider_simple().
12 * From within the ->attach_dev(), we could get the OF node for
13 * the device that is being attached and then parse the power-domain
14 * cell containing the "resource id" and store that in the per device
15 * struct generic_pm_domain_data (we have void pointer there for
16 * storing these kind of things).
17 *
18 * Additionally, we need to implement the ->stop() and ->start()
19 * callbacks of genpd, which is where you "power on/off" devices,
20 * rather than using the above ->power_on|off() callbacks.
21 *
22 * However, there're two known issues:
23 * 1. The ->attach_dev() of power domain infrastructure still does
24 * not support multi domains case as the struct device *dev passed
25 * in is a virtual PD device, it does not help for parsing the real
26 * device resource id from device tree, so it's unware of which
27 * real sub power domain of device should be attached.
28 *
29 * The framework needs some proper extension to support multi power
30 * domain cases.
31 *
32 * 2. It also breaks most of current drivers as the driver probe sequence
33 * behavior changed if removing ->power_on|off() callback and use
34 * ->start() and ->stop() instead. genpd_dev_pm_attach will only power
35 * up the domain and attach device, but will not call .start() which
36 * relies on device runtime pm. That means the device power is still
37 * not up before running driver probe function. For SCU enabled
38 * platforms, all device drivers accessing registers/clock without power
39 * domain enabled will trigger a HW access error. That means we need fix
40 * most drivers probe sequence with proper runtime pm.
41 *
42 * In summary, we need fix above two issue before being able to switch to
43 * the "single global power domain" way.
44 *
45 */
46
47 #include <dt-bindings/firmware/imx/rsrc.h>
48 #include <linux/firmware/imx/sci.h>
49 #include <linux/firmware/imx/svc/rm.h>
50 #include <linux/io.h>
51 #include <linux/module.h>
52 #include <linux/of.h>
53 #include <linux/of_address.h>
54 #include <linux/of_platform.h>
55 #include <linux/platform_device.h>
56 #include <linux/pm.h>
57 #include <linux/pm_domain.h>
58 #include <linux/slab.h>
59
60 /* SCU Power Mode Protocol definition */
61 struct imx_sc_msg_req_set_resource_power_mode {
62 struct imx_sc_rpc_msg hdr;
63 u16 resource;
64 u8 mode;
65 } __packed __aligned(4);
66
67 #define IMX_SCU_PD_NAME_SIZE 20
68 struct imx_sc_pm_domain {
69 struct generic_pm_domain pd;
70 char name[IMX_SCU_PD_NAME_SIZE];
71 u32 rsrc;
72 };
73
74 struct imx_sc_pd_range {
75 char *name;
76 u32 rsrc;
77 u8 num;
78
79 /* add domain index */
80 bool postfix;
81 u8 start_from;
82 };
83
84 struct imx_sc_pd_soc {
85 const struct imx_sc_pd_range *pd_ranges;
86 u8 num_ranges;
87 };
88
89 static const struct imx_sc_pd_range imx8qxp_scu_pd_ranges[] = {
90 /* LSIO SS */
91 { "pwm", IMX_SC_R_PWM_0, 8, true, 0 },
92 { "gpio", IMX_SC_R_GPIO_0, 8, true, 0 },
93 { "gpt", IMX_SC_R_GPT_0, 5, true, 0 },
94 { "kpp", IMX_SC_R_KPP, 1, false, 0 },
95 { "fspi", IMX_SC_R_FSPI_0, 2, true, 0 },
96 { "mu_a", IMX_SC_R_MU_0A, 14, true, 0 },
97 { "mu_b", IMX_SC_R_MU_5B, 9, true, 5 },
98
99 /* CONN SS */
100 { "usb", IMX_SC_R_USB_0, 2, true, 0 },
101 { "usb0phy", IMX_SC_R_USB_0_PHY, 1, false, 0 },
102 { "usb2", IMX_SC_R_USB_2, 1, false, 0 },
103 { "usb2phy", IMX_SC_R_USB_2_PHY, 1, false, 0 },
104 { "sdhc", IMX_SC_R_SDHC_0, 3, true, 0 },
105 { "enet", IMX_SC_R_ENET_0, 2, true, 0 },
106 { "nand", IMX_SC_R_NAND, 1, false, 0 },
107 { "mlb", IMX_SC_R_MLB_0, 1, true, 0 },
108
109 /* AUDIO SS */
110 { "audio-pll0", IMX_SC_R_AUDIO_PLL_0, 1, false, 0 },
111 { "audio-pll1", IMX_SC_R_AUDIO_PLL_1, 1, false, 0 },
112 { "audio-clk-0", IMX_SC_R_AUDIO_CLK_0, 1, false, 0 },
113 { "audio-clk-1", IMX_SC_R_AUDIO_CLK_1, 1, false, 0 },
114 { "dma0-ch", IMX_SC_R_DMA_0_CH0, 16, true, 0 },
115 { "dma1-ch", IMX_SC_R_DMA_1_CH0, 16, true, 0 },
116 { "dma2-ch", IMX_SC_R_DMA_2_CH0, 5, true, 0 },
117 { "asrc0", IMX_SC_R_ASRC_0, 1, false, 0 },
118 { "asrc1", IMX_SC_R_ASRC_1, 1, false, 0 },
119 { "esai0", IMX_SC_R_ESAI_0, 1, false, 0 },
120 { "spdif0", IMX_SC_R_SPDIF_0, 1, false, 0 },
121 { "spdif1", IMX_SC_R_SPDIF_1, 1, false, 0 },
122 { "sai", IMX_SC_R_SAI_0, 3, true, 0 },
123 { "sai3", IMX_SC_R_SAI_3, 1, false, 0 },
124 { "sai4", IMX_SC_R_SAI_4, 1, false, 0 },
125 { "sai5", IMX_SC_R_SAI_5, 1, false, 0 },
126 { "sai6", IMX_SC_R_SAI_6, 1, false, 0 },
127 { "sai7", IMX_SC_R_SAI_7, 1, false, 0 },
128 { "amix", IMX_SC_R_AMIX, 1, false, 0 },
129 { "mqs0", IMX_SC_R_MQS_0, 1, false, 0 },
130 { "dsp", IMX_SC_R_DSP, 1, false, 0 },
131 { "dsp-ram", IMX_SC_R_DSP_RAM, 1, false, 0 },
132
133 /* DMA SS */
134 { "can", IMX_SC_R_CAN_0, 3, true, 0 },
135 { "ftm", IMX_SC_R_FTM_0, 2, true, 0 },
136 { "lpi2c", IMX_SC_R_I2C_0, 4, true, 0 },
137 { "adc", IMX_SC_R_ADC_0, 1, true, 0 },
138 { "lcd", IMX_SC_R_LCD_0, 1, true, 0 },
139 { "lcd0-pwm", IMX_SC_R_LCD_0_PWM_0, 1, true, 0 },
140 { "lpuart", IMX_SC_R_UART_0, 4, true, 0 },
141 { "lpspi", IMX_SC_R_SPI_0, 4, true, 0 },
142 { "irqstr_dsp", IMX_SC_R_IRQSTR_DSP, 1, false, 0 },
143
144 /* VPU SS */
145 { "vpu", IMX_SC_R_VPU, 1, false, 0 },
146 { "vpu-pid", IMX_SC_R_VPU_PID0, 8, true, 0 },
147 { "vpu-dec0", IMX_SC_R_VPU_DEC_0, 1, false, 0 },
148 { "vpu-enc0", IMX_SC_R_VPU_ENC_0, 1, false, 0 },
149
150 /* GPU SS */
151 { "gpu0-pid", IMX_SC_R_GPU_0_PID0, 4, true, 0 },
152
153 /* HSIO SS */
154 { "pcie-b", IMX_SC_R_PCIE_B, 1, false, 0 },
155 { "serdes-1", IMX_SC_R_SERDES_1, 1, false, 0 },
156 { "hsio-gpio", IMX_SC_R_HSIO_GPIO, 1, false, 0 },
157
158 /* MIPI SS */
159 { "mipi0", IMX_SC_R_MIPI_0, 1, false, 0 },
160 { "mipi0-pwm0", IMX_SC_R_MIPI_0_PWM_0, 1, false, 0 },
161 { "mipi0-i2c", IMX_SC_R_MIPI_0_I2C_0, 2, true, 0 },
162
163 /* LVDS SS */
164 { "lvds0", IMX_SC_R_LVDS_0, 1, false, 0 },
165
166 /* DC SS */
167 { "dc0", IMX_SC_R_DC_0, 1, false, 0 },
168 { "dc0-pll", IMX_SC_R_DC_0_PLL_0, 2, true, 0 },
169
170 /* CM40 SS */
171 { "cm40-i2c", IMX_SC_R_M4_0_I2C, 1, false, 0 },
172 { "cm40-intmux", IMX_SC_R_M4_0_INTMUX, 1, false, 0 },
173 { "cm40-pid", IMX_SC_R_M4_0_PID0, 5, true, 0},
174 { "cm40-mu-a1", IMX_SC_R_M4_0_MU_1A, 1, false, 0},
175 { "cm40-lpuart", IMX_SC_R_M4_0_UART, 1, false, 0},
176
177 /* CM41 SS */
178 { "cm41-i2c", IMX_SC_R_M4_1_I2C, 1, false, 0 },
179 { "cm41-intmux", IMX_SC_R_M4_1_INTMUX, 1, false, 0 },
180 { "cm41-pid", IMX_SC_R_M4_1_PID0, 5, true, 0},
181 { "cm41-mu-a1", IMX_SC_R_M4_1_MU_1A, 1, false, 0},
182 { "cm41-lpuart", IMX_SC_R_M4_1_UART, 1, false, 0},
183 };
184
185 static const struct imx_sc_pd_soc imx8qxp_scu_pd = {
186 .pd_ranges = imx8qxp_scu_pd_ranges,
187 .num_ranges = ARRAY_SIZE(imx8qxp_scu_pd_ranges),
188 };
189
190 static struct imx_sc_ipc *pm_ipc_handle;
191
192 static inline struct imx_sc_pm_domain *
to_imx_sc_pd(struct generic_pm_domain * genpd)193 to_imx_sc_pd(struct generic_pm_domain *genpd)
194 {
195 return container_of(genpd, struct imx_sc_pm_domain, pd);
196 }
197
imx_sc_pd_power(struct generic_pm_domain * domain,bool power_on)198 static int imx_sc_pd_power(struct generic_pm_domain *domain, bool power_on)
199 {
200 struct imx_sc_msg_req_set_resource_power_mode msg;
201 struct imx_sc_rpc_msg *hdr = &msg.hdr;
202 struct imx_sc_pm_domain *pd;
203 int ret;
204
205 pd = to_imx_sc_pd(domain);
206
207 hdr->ver = IMX_SC_RPC_VERSION;
208 hdr->svc = IMX_SC_RPC_SVC_PM;
209 hdr->func = IMX_SC_PM_FUNC_SET_RESOURCE_POWER_MODE;
210 hdr->size = 2;
211
212 msg.resource = pd->rsrc;
213 msg.mode = power_on ? IMX_SC_PM_PW_MODE_ON : IMX_SC_PM_PW_MODE_LP;
214
215 ret = imx_scu_call_rpc(pm_ipc_handle, &msg, true);
216 if (ret)
217 dev_err(&domain->dev, "failed to power %s resource %d ret %d\n",
218 power_on ? "up" : "off", pd->rsrc, ret);
219
220 return ret;
221 }
222
imx_sc_pd_power_on(struct generic_pm_domain * domain)223 static int imx_sc_pd_power_on(struct generic_pm_domain *domain)
224 {
225 return imx_sc_pd_power(domain, true);
226 }
227
imx_sc_pd_power_off(struct generic_pm_domain * domain)228 static int imx_sc_pd_power_off(struct generic_pm_domain *domain)
229 {
230 return imx_sc_pd_power(domain, false);
231 }
232
imx_scu_pd_xlate(struct of_phandle_args * spec,void * data)233 static struct generic_pm_domain *imx_scu_pd_xlate(struct of_phandle_args *spec,
234 void *data)
235 {
236 struct generic_pm_domain *domain = ERR_PTR(-ENOENT);
237 struct genpd_onecell_data *pd_data = data;
238 unsigned int i;
239
240 for (i = 0; i < pd_data->num_domains; i++) {
241 struct imx_sc_pm_domain *sc_pd;
242
243 sc_pd = to_imx_sc_pd(pd_data->domains[i]);
244 if (sc_pd->rsrc == spec->args[0]) {
245 domain = &sc_pd->pd;
246 break;
247 }
248 }
249
250 return domain;
251 }
252
253 static struct imx_sc_pm_domain *
imx_scu_add_pm_domain(struct device * dev,int idx,const struct imx_sc_pd_range * pd_ranges)254 imx_scu_add_pm_domain(struct device *dev, int idx,
255 const struct imx_sc_pd_range *pd_ranges)
256 {
257 struct imx_sc_pm_domain *sc_pd;
258 int ret;
259
260 if (!imx_sc_rm_is_resource_owned(pm_ipc_handle, pd_ranges->rsrc + idx))
261 return NULL;
262
263 sc_pd = devm_kzalloc(dev, sizeof(*sc_pd), GFP_KERNEL);
264 if (!sc_pd)
265 return ERR_PTR(-ENOMEM);
266
267 sc_pd->rsrc = pd_ranges->rsrc + idx;
268 sc_pd->pd.power_off = imx_sc_pd_power_off;
269 sc_pd->pd.power_on = imx_sc_pd_power_on;
270
271 if (pd_ranges->postfix)
272 snprintf(sc_pd->name, sizeof(sc_pd->name),
273 "%s%i", pd_ranges->name, pd_ranges->start_from + idx);
274 else
275 snprintf(sc_pd->name, sizeof(sc_pd->name),
276 "%s", pd_ranges->name);
277
278 sc_pd->pd.name = sc_pd->name;
279
280 if (sc_pd->rsrc >= IMX_SC_R_LAST) {
281 dev_warn(dev, "invalid pd %s rsrc id %d found",
282 sc_pd->name, sc_pd->rsrc);
283
284 devm_kfree(dev, sc_pd);
285 return NULL;
286 }
287
288 ret = pm_genpd_init(&sc_pd->pd, NULL, true);
289 if (ret) {
290 dev_warn(dev, "failed to init pd %s rsrc id %d",
291 sc_pd->name, sc_pd->rsrc);
292 devm_kfree(dev, sc_pd);
293 return NULL;
294 }
295
296 return sc_pd;
297 }
298
imx_scu_init_pm_domains(struct device * dev,const struct imx_sc_pd_soc * pd_soc)299 static int imx_scu_init_pm_domains(struct device *dev,
300 const struct imx_sc_pd_soc *pd_soc)
301 {
302 const struct imx_sc_pd_range *pd_ranges = pd_soc->pd_ranges;
303 struct generic_pm_domain **domains;
304 struct genpd_onecell_data *pd_data;
305 struct imx_sc_pm_domain *sc_pd;
306 u32 count = 0;
307 int i, j;
308
309 for (i = 0; i < pd_soc->num_ranges; i++)
310 count += pd_ranges[i].num;
311
312 domains = devm_kcalloc(dev, count, sizeof(*domains), GFP_KERNEL);
313 if (!domains)
314 return -ENOMEM;
315
316 pd_data = devm_kzalloc(dev, sizeof(*pd_data), GFP_KERNEL);
317 if (!pd_data)
318 return -ENOMEM;
319
320 count = 0;
321 for (i = 0; i < pd_soc->num_ranges; i++) {
322 for (j = 0; j < pd_ranges[i].num; j++) {
323 sc_pd = imx_scu_add_pm_domain(dev, j, &pd_ranges[i]);
324 if (IS_ERR_OR_NULL(sc_pd))
325 continue;
326
327 domains[count++] = &sc_pd->pd;
328 dev_dbg(dev, "added power domain %s\n", sc_pd->pd.name);
329 }
330 }
331
332 pd_data->domains = domains;
333 pd_data->num_domains = count;
334 pd_data->xlate = imx_scu_pd_xlate;
335
336 of_genpd_add_provider_onecell(dev->of_node, pd_data);
337
338 return 0;
339 }
340
imx_sc_pd_probe(struct platform_device * pdev)341 static int imx_sc_pd_probe(struct platform_device *pdev)
342 {
343 const struct imx_sc_pd_soc *pd_soc;
344 int ret;
345
346 ret = imx_scu_get_handle(&pm_ipc_handle);
347 if (ret)
348 return ret;
349
350 pd_soc = of_device_get_match_data(&pdev->dev);
351 if (!pd_soc)
352 return -ENODEV;
353
354 return imx_scu_init_pm_domains(&pdev->dev, pd_soc);
355 }
356
357 static const struct of_device_id imx_sc_pd_match[] = {
358 { .compatible = "fsl,imx8qxp-scu-pd", &imx8qxp_scu_pd},
359 { .compatible = "fsl,scu-pd", &imx8qxp_scu_pd},
360 { /* sentinel */ }
361 };
362
363 static struct platform_driver imx_sc_pd_driver = {
364 .driver = {
365 .name = "imx-scu-pd",
366 .of_match_table = imx_sc_pd_match,
367 },
368 .probe = imx_sc_pd_probe,
369 };
370 builtin_platform_driver(imx_sc_pd_driver);
371
372 MODULE_AUTHOR("Dong Aisheng <aisheng.dong@nxp.com>");
373 MODULE_DESCRIPTION("IMX SCU Power Domain driver");
374 MODULE_LICENSE("GPL v2");
375
