ASoC: SOF: topology: Extend the optionality of IPC ops to IPC as well
[linux-2.6-block.git] / sound / soc / sof / pm.c
CommitLineData
e149ca29 1// SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
8920153c
LG
2//
3// This file is provided under a dual BSD/GPLv2 license. When using or
4// redistributing this file, you may do so under either license.
5//
6// Copyright(c) 2018 Intel Corporation. All rights reserved.
7//
8// Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
9//
10
11#include "ops.h"
12#include "sof-priv.h"
ee1e79b7 13#include "sof-audio.h"
8920153c 14
700d1677
RS
15/*
16 * Helper function to determine the target DSP state during
17 * system suspend. This function only cares about the device
18 * D-states. Platform-specific substates, if any, should be
19 * handled by the platform-specific parts.
20 */
21static u32 snd_sof_dsp_power_target(struct snd_sof_dev *sdev)
22{
23 u32 target_dsp_state;
24
25 switch (sdev->system_suspend_target) {
9d2d4627
PLB
26 case SOF_SUSPEND_S5:
27 case SOF_SUSPEND_S4:
28 /* DSP should be in D3 if the system is suspending to S3+ */
700d1677
RS
29 case SOF_SUSPEND_S3:
30 /* DSP should be in D3 if the system is suspending to S3 */
31 target_dsp_state = SOF_DSP_PM_D3;
32 break;
33 case SOF_SUSPEND_S0IX:
34 /*
35 * Currently, the only criterion for retaining the DSP in D0
36 * is that there are streams that ignored the suspend trigger.
37 * Additional criteria such Soundwire clock-stop mode and
38 * device suspend latency considerations will be added later.
39 */
40 if (snd_sof_stream_suspend_ignored(sdev))
41 target_dsp_state = SOF_DSP_PM_D0;
42 else
43 target_dsp_state = SOF_DSP_PM_D3;
44 break;
45 default:
46 /* This case would be during runtime suspend */
47 target_dsp_state = SOF_DSP_PM_D3;
48 break;
49 }
50
51 return target_dsp_state;
52}
53
8920153c
LG
54#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE)
55static void sof_cache_debugfs(struct snd_sof_dev *sdev)
56{
57 struct snd_sof_dfsentry *dfse;
58
59 list_for_each_entry(dfse, &sdev->dfsentry_list, list) {
60
61 /* nothing to do if debugfs buffer is not IO mem */
62 if (dfse->type == SOF_DFSENTRY_TYPE_BUF)
63 continue;
64
65 /* cache memory that is only accessible in D0 */
66 if (dfse->access_type == SOF_DEBUGFS_ACCESS_D0_ONLY)
67 memcpy_fromio(dfse->cache_buf, dfse->io_mem,
68 dfse->size);
69 }
70}
71#endif
72
73static int sof_resume(struct device *dev, bool runtime_resume)
74{
75 struct snd_sof_dev *sdev = dev_get_drvdata(dev);
657774ac 76 const struct sof_ipc_pm_ops *pm_ops = sdev->ipc->ops->pm;
31cd6e46 77 const struct sof_ipc_tplg_ops *tplg_ops = sdev->ipc->ops->tplg;
61e285ca 78 u32 old_state = sdev->dsp_power_state.state;
8920153c
LG
79 int ret;
80
81 /* do nothing if dsp resume callbacks are not set */
c26fde3b
DB
82 if (!runtime_resume && !sof_ops(sdev)->resume)
83 return 0;
84
85 if (runtime_resume && !sof_ops(sdev)->runtime_resume)
8920153c
LG
86 return 0;
87
410e5e55
PLB
88 /* DSP was never successfully started, nothing to resume */
89 if (sdev->first_boot)
90 return 0;
91
8920153c
LG
92 /*
93 * if the runtime_resume flag is set, call the runtime_resume routine
94 * or else call the system resume routine
95 */
96 if (runtime_resume)
97 ret = snd_sof_dsp_runtime_resume(sdev);
98 else
99 ret = snd_sof_dsp_resume(sdev);
100 if (ret < 0) {
101 dev_err(sdev->dev,
102 "error: failed to power up DSP after resume\n");
103 return ret;
104 }
105
fc907cc5
RS
106 /*
107 * Nothing further to be done for platforms that support the low power
249ee180
LY
108 * D0 substate. Resume trace and return when resuming from
109 * low-power D0 substate
fc907cc5
RS
110 */
111 if (!runtime_resume && sof_ops(sdev)->set_power_state &&
249ee180 112 old_state == SOF_DSP_PM_D0) {
1dedbe4f 113 ret = sof_fw_trace_resume(sdev);
249ee180
LY
114 if (ret < 0)
115 /* non fatal */
116 dev_warn(sdev->dev,
117 "failed to enable trace after resume %d\n", ret);
fb9a8119 118 return 0;
249ee180 119 }
fb9a8119 120
58a5c9a4 121 sof_set_fw_state(sdev, SOF_FW_BOOT_PREPARE);
6ca5cecb 122
8920153c
LG
123 /* load the firmware */
124 ret = snd_sof_load_firmware(sdev);
125 if (ret < 0) {
126 dev_err(sdev->dev,
127 "error: failed to load DSP firmware after resume %d\n",
128 ret);
e2406275 129 sof_set_fw_state(sdev, SOF_FW_BOOT_FAILED);
8920153c
LG
130 return ret;
131 }
132
58a5c9a4 133 sof_set_fw_state(sdev, SOF_FW_BOOT_IN_PROGRESS);
6ca5cecb
RS
134
135 /*
136 * Boot the firmware. The FW boot status will be modified
137 * in snd_sof_run_firmware() depending on the outcome.
138 */
8920153c
LG
139 ret = snd_sof_run_firmware(sdev);
140 if (ret < 0) {
141 dev_err(sdev->dev,
142 "error: failed to boot DSP firmware after resume %d\n",
143 ret);
e2406275 144 sof_set_fw_state(sdev, SOF_FW_BOOT_FAILED);
8920153c
LG
145 return ret;
146 }
147
758f24d4 148 /* resume DMA trace */
1dedbe4f 149 ret = sof_fw_trace_resume(sdev);
8920153c
LG
150 if (ret < 0) {
151 /* non fatal */
152 dev_warn(sdev->dev,
153 "warning: failed to init trace after resume %d\n",
154 ret);
155 }
156
157 /* restore pipelines */
31cd6e46
RS
158 if (tplg_ops->set_up_all_pipelines) {
159 ret = tplg_ops->set_up_all_pipelines(sdev, false);
160 if (ret < 0) {
161 dev_err(sdev->dev, "Failed to restore pipeline after resume %d\n", ret);
162 return ret;
163 }
8920153c
LG
164 }
165
1069967a
PU
166 /* Notify clients not managed by pm framework about core resume */
167 sof_resume_clients(sdev);
168
8920153c 169 /* notify DSP of system resume */
657774ac
RS
170 if (pm_ops && pm_ops->ctx_restore) {
171 ret = pm_ops->ctx_restore(sdev);
172 if (ret < 0)
173 dev_err(sdev->dev, "ctx_restore IPC error during resume: %d\n", ret);
174 }
8920153c
LG
175
176 return ret;
177}
178
179static int sof_suspend(struct device *dev, bool runtime_suspend)
180{
181 struct snd_sof_dev *sdev = dev_get_drvdata(dev);
657774ac 182 const struct sof_ipc_pm_ops *pm_ops = sdev->ipc->ops->pm;
31cd6e46 183 const struct sof_ipc_tplg_ops *tplg_ops = sdev->ipc->ops->tplg;
1069967a 184 pm_message_t pm_state;
61e285ca 185 u32 target_state = 0;
8920153c
LG
186 int ret;
187
188 /* do nothing if dsp suspend callback is not set */
c26fde3b
DB
189 if (!runtime_suspend && !sof_ops(sdev)->suspend)
190 return 0;
191
192 if (runtime_suspend && !sof_ops(sdev)->runtime_suspend)
8920153c
LG
193 return 0;
194
6ca5cecb 195 if (sdev->fw_state != SOF_FW_BOOT_COMPLETE)
fb9a8119 196 goto suspend;
8920153c 197
a1ce6e43 198 /* prepare for streams to be resumed properly upon resume */
7077a07a 199 if (!runtime_suspend) {
8e84b6a4 200 ret = snd_sof_dsp_hw_params_upon_resume(sdev);
7077a07a
RS
201 if (ret < 0) {
202 dev_err(sdev->dev,
203 "error: setting hw_params flag during suspend %d\n",
204 ret);
205 return ret;
206 }
207 }
8920153c 208
61e285ca 209 target_state = snd_sof_dsp_power_target(sdev);
1069967a 210 pm_state.event = target_state;
fb9a8119 211
61e285ca 212 /* Skip to platform-specific suspend if DSP is entering D0 */
1069967a 213 if (target_state == SOF_DSP_PM_D0) {
1dedbe4f 214 sof_fw_trace_suspend(sdev, pm_state);
1069967a
PU
215 /* Notify clients not managed by pm framework about core suspend */
216 sof_suspend_clients(sdev, pm_state);
fb9a8119 217 goto suspend;
1069967a 218 }
fb9a8119 219
31cd6e46
RS
220 if (tplg_ops->tear_down_all_pipelines)
221 tplg_ops->tear_down_all_pipelines(sdev, false);
0a2dea1f 222
758f24d4 223 /* suspend DMA trace */
1dedbe4f 224 sof_fw_trace_suspend(sdev, pm_state);
fb9a8119 225
1069967a
PU
226 /* Notify clients not managed by pm framework about core suspend */
227 sof_suspend_clients(sdev, pm_state);
228
8920153c
LG
229#if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE)
230 /* cache debugfs contents during runtime suspend */
231 if (runtime_suspend)
232 sof_cache_debugfs(sdev);
233#endif
234 /* notify DSP of upcoming power down */
657774ac
RS
235 if (pm_ops && pm_ops->ctx_save) {
236 ret = pm_ops->ctx_save(sdev);
237 if (ret == -EBUSY || ret == -EAGAIN) {
238 /*
239 * runtime PM has logic to handle -EBUSY/-EAGAIN so
240 * pass these errors up
241 */
242 dev_err(sdev->dev, "ctx_save IPC error during suspend: %d\n", ret);
243 return ret;
244 } else if (ret < 0) {
245 /* FW in unexpected state, continue to power down */
246 dev_warn(sdev->dev, "ctx_save IPC error: %d, proceeding with suspend\n",
247 ret);
248 }
8920153c
LG
249 }
250
fb9a8119 251suspend:
6ca5cecb
RS
252
253 /* return if the DSP was not probed successfully */
254 if (sdev->fw_state == SOF_FW_BOOT_NOT_STARTED)
255 return 0;
256
fb9a8119 257 /* platform-specific suspend */
8920153c 258 if (runtime_suspend)
1c38c922 259 ret = snd_sof_dsp_runtime_suspend(sdev);
8920153c 260 else
61e285ca 261 ret = snd_sof_dsp_suspend(sdev, target_state);
8920153c
LG
262 if (ret < 0)
263 dev_err(sdev->dev,
264 "error: failed to power down DSP during suspend %d\n",
265 ret);
266
61e285ca
RS
267 /* Do not reset FW state if DSP is in D0 */
268 if (target_state == SOF_DSP_PM_D0)
fb9a8119
RS
269 return ret;
270
6ca5cecb 271 /* reset FW state */
58a5c9a4 272 sof_set_fw_state(sdev, SOF_FW_BOOT_NOT_STARTED);
b640e8a4 273 sdev->enabled_cores_mask = 0;
6ca5cecb 274
8920153c
LG
275 return ret;
276}
277
3541aef1
MR
278int snd_sof_dsp_power_down_notify(struct snd_sof_dev *sdev)
279{
657774ac
RS
280 const struct sof_ipc_pm_ops *pm_ops = sdev->ipc->ops->pm;
281
3541aef1 282 /* Notify DSP of upcoming power down */
657774ac
RS
283 if (sof_ops(sdev)->remove && pm_ops && pm_ops->ctx_save)
284 return pm_ops->ctx_save(sdev);
3541aef1
MR
285
286 return 0;
287}
288
8920153c
LG
289int snd_sof_runtime_suspend(struct device *dev)
290{
291 return sof_suspend(dev, true);
292}
293EXPORT_SYMBOL(snd_sof_runtime_suspend);
294
62fde977
KV
295int snd_sof_runtime_idle(struct device *dev)
296{
297 struct snd_sof_dev *sdev = dev_get_drvdata(dev);
298
299 return snd_sof_dsp_runtime_idle(sdev);
300}
301EXPORT_SYMBOL(snd_sof_runtime_idle);
302
8920153c
LG
303int snd_sof_runtime_resume(struct device *dev)
304{
305 return sof_resume(dev, true);
306}
307EXPORT_SYMBOL(snd_sof_runtime_resume);
308
309int snd_sof_resume(struct device *dev)
310{
311 return sof_resume(dev, false);
312}
313EXPORT_SYMBOL(snd_sof_resume);
314
315int snd_sof_suspend(struct device *dev)
316{
317 return sof_suspend(dev, false);
318}
319EXPORT_SYMBOL(snd_sof_suspend);
0b50b3b1
KJ
320
321int snd_sof_prepare(struct device *dev)
322{
323 struct snd_sof_dev *sdev = dev_get_drvdata(dev);
43437d04
DB
324 const struct sof_dev_desc *desc = sdev->pdata->desc;
325
326 /* will suspend to S3 by default */
327 sdev->system_suspend_target = SOF_SUSPEND_S3;
328
4e1f8648 329 /*
b54b3a4e
PU
330 * if the firmware is crashed or boot failed then we try to aim for S3
331 * to reboot the firmware
4e1f8648 332 */
b54b3a4e
PU
333 if (sdev->fw_state == SOF_FW_CRASHED ||
334 sdev->fw_state == SOF_FW_BOOT_FAILED)
4e1f8648
PU
335 return 0;
336
43437d04
DB
337 if (!desc->use_acpi_target_states)
338 return 0;
0b50b3b1
KJ
339
340#if defined(CONFIG_ACPI)
a9330845
PLB
341 switch (acpi_target_system_state()) {
342 case ACPI_STATE_S0:
043ae13b 343 sdev->system_suspend_target = SOF_SUSPEND_S0IX;
a9330845
PLB
344 break;
345 case ACPI_STATE_S1:
346 case ACPI_STATE_S2:
347 case ACPI_STATE_S3:
348 sdev->system_suspend_target = SOF_SUSPEND_S3;
349 break;
9d2d4627
PLB
350 case ACPI_STATE_S4:
351 sdev->system_suspend_target = SOF_SUSPEND_S4;
352 break;
353 case ACPI_STATE_S5:
354 sdev->system_suspend_target = SOF_SUSPEND_S5;
355 break;
a9330845
PLB
356 default:
357 break;
358 }
0b50b3b1
KJ
359#endif
360
361 return 0;
362}
363EXPORT_SYMBOL(snd_sof_prepare);
364
365void snd_sof_complete(struct device *dev)
366{
367 struct snd_sof_dev *sdev = dev_get_drvdata(dev);
368
043ae13b 369 sdev->system_suspend_target = SOF_SUSPEND_NONE;
0b50b3b1
KJ
370}
371EXPORT_SYMBOL(snd_sof_complete);