1 /* SPDX-License-Identifier: (GPL-2.0 OR BSD-3-Clause) */
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.
6 * Copyright(c) 2018 Intel Corporation. All rights reserved.
8 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
11 #ifndef __SOUND_SOC_SOF_IO_H
12 #define __SOUND_SOC_SOF_IO_H
14 #include <linux/device.h>
15 #include <linux/interrupt.h>
16 #include <linux/kernel.h>
17 #include <linux/types.h>
18 #include <sound/pcm.h>
21 #define sof_ops(sdev) \
22 ((sdev)->pdata->desc->ops)
24 /* Mandatory operations are verified during probing */
27 static inline int snd_sof_probe(struct snd_sof_dev *sdev)
29 return sof_ops(sdev)->probe(sdev);
32 static inline int snd_sof_remove(struct snd_sof_dev *sdev)
34 if (sof_ops(sdev)->remove)
35 return sof_ops(sdev)->remove(sdev);
43 * snd_sof_dsp_run returns the core mask of the cores that are available
44 * after successful fw boot
46 static inline int snd_sof_dsp_run(struct snd_sof_dev *sdev)
48 return sof_ops(sdev)->run(sdev);
51 static inline int snd_sof_dsp_stall(struct snd_sof_dev *sdev)
53 if (sof_ops(sdev)->stall)
54 return sof_ops(sdev)->stall(sdev);
59 static inline int snd_sof_dsp_reset(struct snd_sof_dev *sdev)
61 if (sof_ops(sdev)->reset)
62 return sof_ops(sdev)->reset(sdev);
67 /* dsp core power up/power down */
68 static inline int snd_sof_dsp_core_power_up(struct snd_sof_dev *sdev,
69 unsigned int core_mask)
71 if (sof_ops(sdev)->core_power_up)
72 return sof_ops(sdev)->core_power_up(sdev, core_mask);
77 static inline int snd_sof_dsp_core_power_down(struct snd_sof_dev *sdev,
78 unsigned int core_mask)
80 if (sof_ops(sdev)->core_power_down)
81 return sof_ops(sdev)->core_power_down(sdev, core_mask);
86 /* pre/post fw load */
87 static inline int snd_sof_dsp_pre_fw_run(struct snd_sof_dev *sdev)
89 if (sof_ops(sdev)->pre_fw_run)
90 return sof_ops(sdev)->pre_fw_run(sdev);
95 static inline int snd_sof_dsp_post_fw_run(struct snd_sof_dev *sdev)
97 if (sof_ops(sdev)->post_fw_run)
98 return sof_ops(sdev)->post_fw_run(sdev);
106 * snd_sof_dsp_get_bar_index - Maps a section type with a BAR index
109 * @type: section type as described by snd_sof_fw_blk_type
111 * Returns the corresponding BAR index (a positive integer) or -EINVAL
112 * in case there is no mapping
114 static inline int snd_sof_dsp_get_bar_index(struct snd_sof_dev *sdev, u32 type)
116 if (sof_ops(sdev)->get_bar_index)
117 return sof_ops(sdev)->get_bar_index(sdev, type);
119 return sdev->mmio_bar;
122 static inline int snd_sof_dsp_get_mailbox_offset(struct snd_sof_dev *sdev)
124 if (sof_ops(sdev)->get_mailbox_offset)
125 return sof_ops(sdev)->get_mailbox_offset(sdev);
127 dev_err(sdev->dev, "error: %s not defined\n", __func__);
131 static inline int snd_sof_dsp_get_window_offset(struct snd_sof_dev *sdev,
134 if (sof_ops(sdev)->get_window_offset)
135 return sof_ops(sdev)->get_window_offset(sdev, id);
137 dev_err(sdev->dev, "error: %s not defined\n", __func__);
140 /* power management */
141 static inline int snd_sof_dsp_resume(struct snd_sof_dev *sdev)
143 if (sof_ops(sdev)->resume)
144 return sof_ops(sdev)->resume(sdev);
149 static inline int snd_sof_dsp_suspend(struct snd_sof_dev *sdev)
151 if (sof_ops(sdev)->suspend)
152 return sof_ops(sdev)->suspend(sdev);
157 static inline int snd_sof_dsp_runtime_resume(struct snd_sof_dev *sdev)
159 if (sof_ops(sdev)->runtime_resume)
160 return sof_ops(sdev)->runtime_resume(sdev);
165 static inline int snd_sof_dsp_runtime_suspend(struct snd_sof_dev *sdev)
167 if (sof_ops(sdev)->runtime_suspend)
168 return sof_ops(sdev)->runtime_suspend(sdev);
173 static inline int snd_sof_dsp_runtime_idle(struct snd_sof_dev *sdev)
175 if (sof_ops(sdev)->runtime_idle)
176 return sof_ops(sdev)->runtime_idle(sdev);
181 static inline int snd_sof_dsp_hw_params_upon_resume(struct snd_sof_dev *sdev)
183 if (sof_ops(sdev)->set_hw_params_upon_resume)
184 return sof_ops(sdev)->set_hw_params_upon_resume(sdev);
188 static inline int snd_sof_dsp_set_clk(struct snd_sof_dev *sdev, u32 freq)
190 if (sof_ops(sdev)->set_clk)
191 return sof_ops(sdev)->set_clk(sdev, freq);
196 static inline int snd_sof_dsp_set_power_state(struct snd_sof_dev *sdev,
197 enum sof_d0_substate substate)
199 if (sof_ops(sdev)->set_power_state)
200 return sof_ops(sdev)->set_power_state(sdev, substate);
202 /* D0 substate is not supported */
207 static inline void snd_sof_dsp_dbg_dump(struct snd_sof_dev *sdev, u32 flags)
209 if (sof_ops(sdev)->dbg_dump)
210 return sof_ops(sdev)->dbg_dump(sdev, flags);
213 static inline void snd_sof_ipc_dump(struct snd_sof_dev *sdev)
215 if (sof_ops(sdev)->ipc_dump)
216 return sof_ops(sdev)->ipc_dump(sdev);
220 static inline void snd_sof_dsp_write(struct snd_sof_dev *sdev, u32 bar,
221 u32 offset, u32 value)
223 if (sof_ops(sdev)->write) {
224 sof_ops(sdev)->write(sdev, sdev->bar[bar] + offset, value);
228 dev_err_ratelimited(sdev->dev, "error: %s not defined\n", __func__);
231 static inline void snd_sof_dsp_write64(struct snd_sof_dev *sdev, u32 bar,
232 u32 offset, u64 value)
234 if (sof_ops(sdev)->write64) {
235 sof_ops(sdev)->write64(sdev, sdev->bar[bar] + offset, value);
239 dev_err_ratelimited(sdev->dev, "error: %s not defined\n", __func__);
242 static inline u32 snd_sof_dsp_read(struct snd_sof_dev *sdev, u32 bar,
245 if (sof_ops(sdev)->read)
246 return sof_ops(sdev)->read(sdev, sdev->bar[bar] + offset);
248 dev_err(sdev->dev, "error: %s not defined\n", __func__);
252 static inline u64 snd_sof_dsp_read64(struct snd_sof_dev *sdev, u32 bar,
255 if (sof_ops(sdev)->read64)
256 return sof_ops(sdev)->read64(sdev, sdev->bar[bar] + offset);
258 dev_err(sdev->dev, "error: %s not defined\n", __func__);
263 static inline void snd_sof_dsp_block_read(struct snd_sof_dev *sdev, u32 bar,
264 u32 offset, void *dest, size_t bytes)
266 sof_ops(sdev)->block_read(sdev, bar, offset, dest, bytes);
269 static inline void snd_sof_dsp_block_write(struct snd_sof_dev *sdev, u32 bar,
270 u32 offset, void *src, size_t bytes)
272 sof_ops(sdev)->block_write(sdev, bar, offset, src, bytes);
276 static inline int snd_sof_dsp_send_msg(struct snd_sof_dev *sdev,
277 struct snd_sof_ipc_msg *msg)
279 return sof_ops(sdev)->send_msg(sdev, msg);
283 static inline int snd_sof_dma_trace_init(struct snd_sof_dev *sdev,
286 if (sof_ops(sdev)->trace_init)
287 return sof_ops(sdev)->trace_init(sdev, stream_tag);
292 static inline int snd_sof_dma_trace_release(struct snd_sof_dev *sdev)
294 if (sof_ops(sdev)->trace_release)
295 return sof_ops(sdev)->trace_release(sdev);
300 static inline int snd_sof_dma_trace_trigger(struct snd_sof_dev *sdev, int cmd)
302 if (sof_ops(sdev)->trace_trigger)
303 return sof_ops(sdev)->trace_trigger(sdev, cmd);
310 snd_sof_pcm_platform_open(struct snd_sof_dev *sdev,
311 struct snd_pcm_substream *substream)
313 if (sof_ops(sdev) && sof_ops(sdev)->pcm_open)
314 return sof_ops(sdev)->pcm_open(sdev, substream);
319 /* disconnect pcm substream to a host stream */
321 snd_sof_pcm_platform_close(struct snd_sof_dev *sdev,
322 struct snd_pcm_substream *substream)
324 if (sof_ops(sdev) && sof_ops(sdev)->pcm_close)
325 return sof_ops(sdev)->pcm_close(sdev, substream);
330 /* host stream hw params */
332 snd_sof_pcm_platform_hw_params(struct snd_sof_dev *sdev,
333 struct snd_pcm_substream *substream,
334 struct snd_pcm_hw_params *params,
335 struct sof_ipc_stream_params *ipc_params)
337 if (sof_ops(sdev) && sof_ops(sdev)->pcm_hw_params)
338 return sof_ops(sdev)->pcm_hw_params(sdev, substream,
344 /* host stream hw free */
346 snd_sof_pcm_platform_hw_free(struct snd_sof_dev *sdev,
347 struct snd_pcm_substream *substream)
349 if (sof_ops(sdev) && sof_ops(sdev)->pcm_hw_free)
350 return sof_ops(sdev)->pcm_hw_free(sdev, substream);
355 /* host stream trigger */
357 snd_sof_pcm_platform_trigger(struct snd_sof_dev *sdev,
358 struct snd_pcm_substream *substream, int cmd)
360 if (sof_ops(sdev) && sof_ops(sdev)->pcm_trigger)
361 return sof_ops(sdev)->pcm_trigger(sdev, substream, cmd);
366 /* host DSP message data */
367 static inline void snd_sof_ipc_msg_data(struct snd_sof_dev *sdev,
368 struct snd_pcm_substream *substream,
371 sof_ops(sdev)->ipc_msg_data(sdev, substream, p, sz);
374 /* host configure DSP HW parameters */
376 snd_sof_ipc_pcm_params(struct snd_sof_dev *sdev,
377 struct snd_pcm_substream *substream,
378 const struct sof_ipc_pcm_params_reply *reply)
380 return sof_ops(sdev)->ipc_pcm_params(sdev, substream, reply);
383 /* host stream pointer */
384 static inline snd_pcm_uframes_t
385 snd_sof_pcm_platform_pointer(struct snd_sof_dev *sdev,
386 struct snd_pcm_substream *substream)
388 if (sof_ops(sdev) && sof_ops(sdev)->pcm_pointer)
389 return sof_ops(sdev)->pcm_pointer(sdev, substream);
394 static inline const struct snd_sof_dsp_ops
395 *sof_get_ops(const struct sof_dev_desc *d,
396 const struct sof_ops_table mach_ops[], int asize)
400 for (i = 0; i < asize; i++) {
401 if (d == mach_ops[i].desc)
402 return mach_ops[i].ops;
410 * snd_sof_dsp_register_poll_timeout - Periodically poll an address
411 * until a condition is met or a timeout occurs
412 * @op: accessor function (takes @addr as its only argument)
413 * @addr: Address to poll
414 * @val: Variable to read the value into
415 * @cond: Break condition (usually involving @val)
416 * @sleep_us: Maximum time to sleep between reads in us (0
417 * tight-loops). Should be less than ~20ms since usleep_range
418 * is used (see Documentation/timers/timers-howto.rst).
419 * @timeout_us: Timeout in us, 0 means never timeout
421 * Returns 0 on success and -ETIMEDOUT upon a timeout. In either
422 * case, the last read value at @addr is stored in @val. Must not
423 * be called from atomic context if sleep_us or timeout_us are used.
425 * This is modelled after the readx_poll_timeout macros in linux/iopoll.h.
427 #define snd_sof_dsp_read_poll_timeout(sdev, bar, offset, val, cond, sleep_us, timeout_us) \
429 u64 __timeout_us = (timeout_us); \
430 unsigned long __sleep_us = (sleep_us); \
431 ktime_t __timeout = ktime_add_us(ktime_get(), __timeout_us); \
432 might_sleep_if((__sleep_us) != 0); \
434 (val) = snd_sof_dsp_read(sdev, bar, offset); \
437 "FW Poll Status: reg=%#x successful\n", (val)); \
440 if (__timeout_us && \
441 ktime_compare(ktime_get(), __timeout) > 0) { \
442 (val) = snd_sof_dsp_read(sdev, bar, offset); \
444 "FW Poll Status: reg=%#x timedout\n", (val)); \
448 usleep_range((__sleep_us >> 2) + 1, __sleep_us); \
450 (cond) ? 0 : -ETIMEDOUT; \
453 /* This is for registers bits with attribute RWC */
454 bool snd_sof_pci_update_bits(struct snd_sof_dev *sdev, u32 offset,
455 u32 mask, u32 value);
457 bool snd_sof_dsp_update_bits_unlocked(struct snd_sof_dev *sdev, u32 bar,
458 u32 offset, u32 mask, u32 value);
460 bool snd_sof_dsp_update_bits64_unlocked(struct snd_sof_dev *sdev, u32 bar,
461 u32 offset, u64 mask, u64 value);
463 bool snd_sof_dsp_update_bits(struct snd_sof_dev *sdev, u32 bar, u32 offset,
464 u32 mask, u32 value);
466 bool snd_sof_dsp_update_bits64(struct snd_sof_dev *sdev, u32 bar,
467 u32 offset, u64 mask, u64 value);
469 void snd_sof_dsp_update_bits_forced(struct snd_sof_dev *sdev, u32 bar,
470 u32 offset, u32 mask, u32 value);
472 int snd_sof_dsp_register_poll(struct snd_sof_dev *sdev, u32 bar, u32 offset,
473 u32 mask, u32 target, u32 timeout_ms,
476 void snd_sof_dsp_panic(struct snd_sof_dev *sdev, u32 offset);