1 /* SPDX-License-Identifier: (GPL-2.0-only 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_PRIV_H
12 #define __SOUND_SOC_SOF_PRIV_H
14 #include <linux/device.h>
15 #include <sound/hdaudio.h>
16 #include <sound/sof.h>
17 #include <sound/sof/info.h>
18 #include <sound/sof/pm.h>
19 #include <sound/sof/trace.h>
20 #include <uapi/sound/sof/fw.h>
21 #include <sound/sof/ext_manifest.h>
23 struct snd_sof_pcm_stream;
25 /* Flag definitions used in sof_core_debug (sof_debug module parameter) */
26 #define SOF_DBG_ENABLE_TRACE BIT(0)
27 #define SOF_DBG_RETAIN_CTX BIT(1) /* prevent DSP D3 on FW exception */
28 #define SOF_DBG_VERIFY_TPLG BIT(2) /* verify topology during load */
29 #define SOF_DBG_DYNAMIC_PIPELINES_OVERRIDE BIT(3) /* 0: use topology token
30 * 1: override topology
32 #define SOF_DBG_DYNAMIC_PIPELINES_ENABLE BIT(4) /* 0: use static pipelines
33 * 1: use dynamic pipelines
35 #define SOF_DBG_DISABLE_MULTICORE BIT(5) /* schedule all pipelines/widgets
38 #define SOF_DBG_PRINT_ALL_DUMPS BIT(6) /* Print all ipc and dsp dumps */
39 #define SOF_DBG_IGNORE_D3_PERSISTENT BIT(7) /* ignore the DSP D3 persistent capability
40 * and always download firmware upon D3 exit
42 #define SOF_DBG_PRINT_DMA_POSITION_UPDATE_LOGS BIT(8) /* print DMA position updates
45 #define SOF_DBG_PRINT_IPC_SUCCESS_LOGS BIT(9) /* print IPC success
48 #define SOF_DBG_FORCE_NOCODEC BIT(10) /* ignore all codec-related
51 #define SOF_DBG_DUMP_IPC_MESSAGE_PAYLOAD BIT(11) /* On top of the IPC message header
52 * dump the message payload also
54 #define SOF_DBG_DSPLESS_MODE BIT(15) /* Do not initialize and use the DSP */
56 /* Flag definitions used for controlling the DSP dump behavior */
57 #define SOF_DBG_DUMP_REGS BIT(0)
58 #define SOF_DBG_DUMP_MBOX BIT(1)
59 #define SOF_DBG_DUMP_TEXT BIT(2)
60 #define SOF_DBG_DUMP_PCI BIT(3)
61 /* Output this dump (at the DEBUG level) only when SOF_DBG_PRINT_ALL_DUMPS is set */
62 #define SOF_DBG_DUMP_OPTIONAL BIT(4)
64 /* global debug state set by SOF_DBG_ flags */
65 bool sof_debug_check_flag(int mask);
67 /* max BARs mmaped devices can use */
68 #define SND_SOF_BARS 8
70 /* time in ms for runtime suspend delay */
71 #define SND_SOF_SUSPEND_DELAY_MS 2000
73 /* DMA buffer size for trace */
74 #define DMA_BUF_SIZE_FOR_TRACE (PAGE_SIZE * 16)
76 #define SOF_IPC_DSP_REPLY 0
77 #define SOF_IPC_HOST_REPLY 1
79 /* convenience constructor for DAI driver streams */
80 #define SOF_DAI_STREAM(sname, scmin, scmax, srates, sfmt) \
81 {.stream_name = sname, .channels_min = scmin, .channels_max = scmax, \
82 .rates = srates, .formats = sfmt}
84 #define SOF_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE | \
85 SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_FLOAT)
87 /* So far the primary core on all DSPs has ID 0 */
88 #define SOF_DSP_PRIMARY_CORE 0
90 /* max number of DSP cores */
91 #define SOF_MAX_DSP_NUM_CORES 8
93 struct sof_dsp_power_state {
95 u32 substate; /* platform-specific */
98 /* System suspend target state */
99 enum sof_system_suspend_state {
100 SOF_SUSPEND_NONE = 0,
107 enum sof_dfsentry_type {
108 SOF_DFSENTRY_TYPE_IOMEM = 0,
109 SOF_DFSENTRY_TYPE_BUF,
112 enum sof_debugfs_access_type {
113 SOF_DEBUGFS_ACCESS_ALWAYS = 0,
114 SOF_DEBUGFS_ACCESS_D0_ONLY,
117 struct sof_compr_stream {
121 u16 sample_container_bytes;
126 struct snd_sof_ipc_msg;
128 struct snd_sof_debugfs_map;
129 struct snd_soc_tplg_ops;
130 struct snd_soc_component;
131 struct snd_sof_pdata;
134 * struct snd_sof_platform_stream_params - platform dependent stream parameters
135 * @stream_tag: Stream tag to use
136 * @use_phy_addr: Use the provided @phy_addr for configuration
137 * @phy_addr: Platform dependent address to be used, if @use_phy_addr
139 * @no_ipc_position: Disable position update IPC from firmware
141 struct snd_sof_platform_stream_params {
143 bool use_phy_address;
145 bool no_ipc_position;
146 bool cont_update_posn;
150 * struct sof_firmware - Container struct for SOF firmware
151 * @fw: Pointer to the firmware
152 * @payload_offset: Offset of the data within the loaded firmware image to be
153 * loaded to the DSP (skipping for example ext_manifest section)
155 struct sof_firmware {
156 const struct firmware *fw;
160 enum sof_dai_access {
161 SOF_DAI_DSP_ACCESS, /* access from DSP only */
162 SOF_DAI_HOST_ACCESS, /* access from host only */
168 * SOF DSP HW abstraction operations.
169 * Used to abstract DSP HW architecture and any IO busses between host CPU
172 struct snd_sof_dsp_ops {
174 /* probe/remove/shutdown */
175 int (*probe_early)(struct snd_sof_dev *sof_dev); /* optional */
176 int (*probe)(struct snd_sof_dev *sof_dev); /* mandatory */
177 void (*remove)(struct snd_sof_dev *sof_dev); /* optional */
178 void (*remove_late)(struct snd_sof_dev *sof_dev); /* optional */
179 int (*shutdown)(struct snd_sof_dev *sof_dev); /* optional */
181 /* DSP core boot / reset */
182 int (*run)(struct snd_sof_dev *sof_dev); /* mandatory */
183 int (*stall)(struct snd_sof_dev *sof_dev, unsigned int core_mask); /* optional */
184 int (*reset)(struct snd_sof_dev *sof_dev); /* optional */
185 int (*core_get)(struct snd_sof_dev *sof_dev, int core); /* optional */
186 int (*core_put)(struct snd_sof_dev *sof_dev, int core); /* optional */
189 * Register IO: only used by respective drivers themselves,
190 * TODO: consider removing these operations and calling respective
191 * implementations directly
193 void (*write8)(struct snd_sof_dev *sof_dev, void __iomem *addr,
194 u8 value); /* optional */
195 u8 (*read8)(struct snd_sof_dev *sof_dev,
196 void __iomem *addr); /* optional */
197 void (*write)(struct snd_sof_dev *sof_dev, void __iomem *addr,
198 u32 value); /* optional */
199 u32 (*read)(struct snd_sof_dev *sof_dev,
200 void __iomem *addr); /* optional */
201 void (*write64)(struct snd_sof_dev *sof_dev, void __iomem *addr,
202 u64 value); /* optional */
203 u64 (*read64)(struct snd_sof_dev *sof_dev,
204 void __iomem *addr); /* optional */
207 int (*block_read)(struct snd_sof_dev *sof_dev,
208 enum snd_sof_fw_blk_type type, u32 offset,
209 void *dest, size_t size); /* mandatory */
210 int (*block_write)(struct snd_sof_dev *sof_dev,
211 enum snd_sof_fw_blk_type type, u32 offset,
212 void *src, size_t size); /* mandatory */
215 void (*mailbox_read)(struct snd_sof_dev *sof_dev,
216 u32 offset, void *dest,
217 size_t size); /* optional */
218 void (*mailbox_write)(struct snd_sof_dev *sof_dev,
219 u32 offset, void *src,
220 size_t size); /* optional */
223 irqreturn_t (*irq_handler)(int irq, void *context); /* optional */
224 irqreturn_t (*irq_thread)(int irq, void *context); /* optional */
227 int (*send_msg)(struct snd_sof_dev *sof_dev,
228 struct snd_sof_ipc_msg *msg); /* mandatory */
231 int (*load_firmware)(struct snd_sof_dev *sof_dev); /* mandatory */
232 int (*load_module)(struct snd_sof_dev *sof_dev,
233 struct snd_sof_mod_hdr *hdr); /* optional */
235 /* connect pcm substream to a host stream */
236 int (*pcm_open)(struct snd_sof_dev *sdev,
237 struct snd_pcm_substream *substream); /* optional */
238 /* disconnect pcm substream to a host stream */
239 int (*pcm_close)(struct snd_sof_dev *sdev,
240 struct snd_pcm_substream *substream); /* optional */
242 /* host stream hw params */
243 int (*pcm_hw_params)(struct snd_sof_dev *sdev,
244 struct snd_pcm_substream *substream,
245 struct snd_pcm_hw_params *params,
246 struct snd_sof_platform_stream_params *platform_params); /* optional */
248 /* host stream hw_free */
249 int (*pcm_hw_free)(struct snd_sof_dev *sdev,
250 struct snd_pcm_substream *substream); /* optional */
252 /* host stream trigger */
253 int (*pcm_trigger)(struct snd_sof_dev *sdev,
254 struct snd_pcm_substream *substream,
255 int cmd); /* optional */
257 /* host stream pointer */
258 snd_pcm_uframes_t (*pcm_pointer)(struct snd_sof_dev *sdev,
259 struct snd_pcm_substream *substream); /* optional */
262 int (*pcm_ack)(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream); /* optional */
265 * optional callback to retrieve the link DMA position for the substream
266 * when the position is not reported in the shared SRAM windows but
267 * instead from a host-accessible hardware counter.
269 u64 (*get_stream_position)(struct snd_sof_dev *sdev,
270 struct snd_soc_component *component,
271 struct snd_pcm_substream *substream); /* optional */
273 /* host read DSP stream data */
274 int (*ipc_msg_data)(struct snd_sof_dev *sdev,
275 struct snd_sof_pcm_stream *sps,
276 void *p, size_t sz); /* mandatory */
278 /* host side configuration of the stream's data offset in stream mailbox area */
279 int (*set_stream_data_offset)(struct snd_sof_dev *sdev,
280 struct snd_sof_pcm_stream *sps,
281 size_t posn_offset); /* optional */
283 /* pre/post firmware run */
284 int (*pre_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
285 int (*post_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
287 /* parse platform specific extended manifest, optional */
288 int (*parse_platform_ext_manifest)(struct snd_sof_dev *sof_dev,
289 const struct sof_ext_man_elem_header *hdr);
292 int (*suspend)(struct snd_sof_dev *sof_dev,
293 u32 target_state); /* optional */
294 int (*resume)(struct snd_sof_dev *sof_dev); /* optional */
295 int (*runtime_suspend)(struct snd_sof_dev *sof_dev); /* optional */
296 int (*runtime_resume)(struct snd_sof_dev *sof_dev); /* optional */
297 int (*runtime_idle)(struct snd_sof_dev *sof_dev); /* optional */
298 int (*set_hw_params_upon_resume)(struct snd_sof_dev *sdev); /* optional */
299 int (*set_power_state)(struct snd_sof_dev *sdev,
300 const struct sof_dsp_power_state *target_state); /* optional */
303 int (*set_clk)(struct snd_sof_dev *sof_dev, u32 freq); /* optional */
306 const struct snd_sof_debugfs_map *debug_map; /* optional */
307 int debug_map_count; /* optional */
308 void (*dbg_dump)(struct snd_sof_dev *sof_dev,
309 u32 flags); /* optional */
310 void (*ipc_dump)(struct snd_sof_dev *sof_dev); /* optional */
311 int (*debugfs_add_region_item)(struct snd_sof_dev *sdev,
312 enum snd_sof_fw_blk_type blk_type, u32 offset,
313 size_t size, const char *name,
314 enum sof_debugfs_access_type access_type); /* optional */
316 /* host DMA trace (IPC3) */
317 int (*trace_init)(struct snd_sof_dev *sdev,
318 struct snd_dma_buffer *dmatb,
319 struct sof_ipc_dma_trace_params_ext *dtrace_params); /* optional */
320 int (*trace_release)(struct snd_sof_dev *sdev); /* optional */
321 int (*trace_trigger)(struct snd_sof_dev *sdev,
322 int cmd); /* optional */
325 int (*get_bar_index)(struct snd_sof_dev *sdev,
326 u32 type); /* optional */
327 int (*get_mailbox_offset)(struct snd_sof_dev *sdev);/* mandatory for common loader code */
328 int (*get_window_offset)(struct snd_sof_dev *sdev,
329 u32 id);/* mandatory for common loader code */
331 /* machine driver ops */
332 int (*machine_register)(struct snd_sof_dev *sdev,
333 void *pdata); /* optional */
334 void (*machine_unregister)(struct snd_sof_dev *sdev,
335 void *pdata); /* optional */
336 struct snd_soc_acpi_mach * (*machine_select)(struct snd_sof_dev *sdev); /* optional */
337 void (*set_mach_params)(struct snd_soc_acpi_mach *mach,
338 struct snd_sof_dev *sdev); /* optional */
341 int (*register_ipc_clients)(struct snd_sof_dev *sdev); /* optional */
342 void (*unregister_ipc_clients)(struct snd_sof_dev *sdev); /* optional */
345 struct snd_soc_dai_driver *drv;
348 bool (*is_chain_dma_supported)(struct snd_sof_dev *sdev, u32 dai_type); /* optional */
350 /* ALSA HW info flags, will be stored in snd_pcm_runtime.hw.info */
353 const struct dsp_arch_ops *dsp_arch_ops;
356 /* DSP architecture specific callbacks for oops and stack dumps */
357 struct dsp_arch_ops {
358 void (*dsp_oops)(struct snd_sof_dev *sdev, const char *level, void *oops);
359 void (*dsp_stack)(struct snd_sof_dev *sdev, const char *level, void *oops,
360 u32 *stack, u32 stack_words);
363 #define sof_dsp_arch_ops(sdev) ((sdev)->pdata->desc->ops->dsp_arch_ops)
365 /* FS entry for debug files that can expose DSP memories, registers */
366 struct snd_sof_dfsentry {
368 size_t buf_data_size; /* length of buffered data for file read operation */
369 enum sof_dfsentry_type type;
371 * access_type specifies if the
372 * memory -> DSP resource (memory, register etc) is always accessible
373 * or if it is accessible only when the DSP is in D0.
375 enum sof_debugfs_access_type access_type;
376 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE)
377 char *cache_buf; /* buffer to cache the contents of debugfs memory */
379 struct snd_sof_dev *sdev;
380 struct list_head list; /* list in sdev dfsentry list */
382 void __iomem *io_mem;
387 /* Debug mapping for any DSP memory or registers that can used for debug */
388 struct snd_sof_debugfs_map {
394 * access_type specifies if the memory is always accessible
395 * or if it is accessible only when the DSP is in D0.
397 enum sof_debugfs_access_type access_type;
400 /* mailbox descriptor, used for host <-> DSP IPC */
401 struct snd_sof_mailbox {
406 /* IPC message descriptor for host <-> DSP IO */
407 struct snd_sof_ipc_msg {
415 /* notification, firmware initiated messages */
418 wait_queue_head_t waitq;
423 * struct sof_ipc_fw_tracing_ops - IPC-specific firmware tracing ops
424 * @init: Function pointer for initialization of the tracing
425 * @free: Optional function pointer for freeing of the tracing
426 * @fw_crashed: Optional function pointer to notify the tracing of a firmware crash
427 * @suspend: Function pointer for system/runtime suspend
428 * @resume: Function pointer for system/runtime resume
430 struct sof_ipc_fw_tracing_ops {
431 int (*init)(struct snd_sof_dev *sdev);
432 void (*free)(struct snd_sof_dev *sdev);
433 void (*fw_crashed)(struct snd_sof_dev *sdev);
434 void (*suspend)(struct snd_sof_dev *sdev, pm_message_t pm_state);
435 int (*resume)(struct snd_sof_dev *sdev);
439 * struct sof_ipc_pm_ops - IPC-specific PM ops
440 * @ctx_save: Optional function pointer for context save
441 * @ctx_restore: Optional function pointer for context restore
442 * @set_core_state: Optional function pointer for turning on/off a DSP core
443 * @set_pm_gate: Optional function pointer for pm gate settings
445 struct sof_ipc_pm_ops {
446 int (*ctx_save)(struct snd_sof_dev *sdev);
447 int (*ctx_restore)(struct snd_sof_dev *sdev);
448 int (*set_core_state)(struct snd_sof_dev *sdev, int core_idx, bool on);
449 int (*set_pm_gate)(struct snd_sof_dev *sdev, u32 flags);
453 * struct sof_ipc_fw_loader_ops - IPC/FW-specific loader ops
454 * @validate: Function pointer for validating the firmware image
455 * @parse_ext_manifest: Function pointer for parsing the manifest of the firmware
456 * @load_fw_to_dsp: Optional function pointer for loading the firmware to the
458 * The function implements generic, hardware independent way
459 * of loading the initial firmware and its modules (if any).
461 struct sof_ipc_fw_loader_ops {
462 int (*validate)(struct snd_sof_dev *sdev);
463 size_t (*parse_ext_manifest)(struct snd_sof_dev *sdev);
464 int (*load_fw_to_dsp)(struct snd_sof_dev *sdev);
467 struct sof_ipc_tplg_ops;
468 struct sof_ipc_pcm_ops;
471 * struct sof_ipc_ops - IPC-specific ops
472 * @tplg: Pointer to IPC-specific topology ops
473 * @pm: Pointer to PM ops
474 * @pcm: Pointer to PCM ops
475 * @fw_loader: Pointer to Firmware Loader ops
476 * @fw_tracing: Optional pointer to Firmware tracing ops
478 * @init: Optional pointer for IPC related initialization
479 * @exit: Optional pointer for IPC related cleanup
480 * @post_fw_boot: Optional pointer to execute IPC related tasks after firmware
483 * @tx_msg: Function pointer for sending a 'short' IPC message
484 * @set_get_data: Function pointer for set/get data ('large' IPC message). This
485 * function may split up the 'large' message and use the @tx_msg
486 * path to transfer individual chunks, or use other means to transfer
488 * @get_reply: Function pointer for fetching the reply to
489 * sdev->ipc->msg.reply_data
490 * @rx_msg: Function pointer for handling a received message
492 * Note: both @tx_msg and @set_get_data considered as TX functions and they are
493 * serialized for the duration of the instructed transfer. A large message sent
494 * via @set_get_data is a single transfer even if at the hardware level it is
495 * handled with multiple chunks.
498 const struct sof_ipc_tplg_ops *tplg;
499 const struct sof_ipc_pm_ops *pm;
500 const struct sof_ipc_pcm_ops *pcm;
501 const struct sof_ipc_fw_loader_ops *fw_loader;
502 const struct sof_ipc_fw_tracing_ops *fw_tracing;
504 int (*init)(struct snd_sof_dev *sdev);
505 void (*exit)(struct snd_sof_dev *sdev);
506 int (*post_fw_boot)(struct snd_sof_dev *sdev);
508 int (*tx_msg)(struct snd_sof_dev *sdev, void *msg_data, size_t msg_bytes,
509 void *reply_data, size_t reply_bytes, bool no_pm);
510 int (*set_get_data)(struct snd_sof_dev *sdev, void *data, size_t data_bytes,
512 int (*get_reply)(struct snd_sof_dev *sdev);
513 void (*rx_msg)(struct snd_sof_dev *sdev);
516 /* SOF generic IPC data */
518 struct snd_sof_dev *sdev;
520 /* protects messages and the disable flag */
521 struct mutex tx_mutex;
522 /* disables further sending of ipc's */
525 /* Maximum allowed size of a single IPC message/reply */
526 size_t max_payload_size;
528 struct snd_sof_ipc_msg msg;
530 /* IPC ops based on version */
531 const struct sof_ipc_ops *ops;
534 /* Helper to retrieve the IPC ops */
535 #define sof_ipc_get_ops(sdev, ops_name) \
536 (((sdev)->ipc && (sdev)->ipc->ops) ? (sdev)->ipc->ops->ops_name : NULL)
543 spinlock_t ipc_lock; /* lock for IPC users */
544 spinlock_t hw_lock; /* lock for HW IO access */
547 * When true the DSP is not used.
548 * It is set under the following condition:
549 * User sets the SOF_DBG_DSPLESS_MODE flag in sof_debug module parameter
551 * the platform advertises that it can support such mode
552 * pdata->desc->dspless_mode_supported is true.
554 bool dspless_mode_selected;
556 /* Main, Base firmware image */
557 struct sof_firmware basefw;
560 * ASoC components. plat_drv fields are set dynamically so
563 struct snd_soc_component_driver plat_drv;
565 /* current DSP power state */
566 struct sof_dsp_power_state dsp_power_state;
567 /* mutex to protect the dsp_power_state access */
568 struct mutex power_state_access;
570 /* Intended power target of system suspend */
571 enum sof_system_suspend_state system_suspend_target;
573 /* DSP firmware boot */
574 wait_queue_head_t boot_wait;
575 enum sof_fw_state fw_state;
578 /* work queue in case the probe is implemented in two steps */
579 struct work_struct probe_work;
580 bool probe_completed;
582 /* DSP HW differentiation */
583 struct snd_sof_pdata *pdata;
586 struct snd_sof_ipc *ipc;
587 struct snd_sof_mailbox fw_info_box; /* FW shared memory */
588 struct snd_sof_mailbox dsp_box; /* DSP initiated IPC */
589 struct snd_sof_mailbox host_box; /* Host initiated IPC */
590 struct snd_sof_mailbox stream_box; /* Stream position update */
591 struct snd_sof_mailbox debug_box; /* Debug info updates */
592 struct snd_sof_ipc_msg *msg;
594 u32 next_comp_id; /* monotonic - reset during S3 */
596 /* memory bases for mmaped DSPs - set by dsp_init() */
597 void __iomem *bar[SND_SOF_BARS]; /* DSP base address */
600 size_t dsp_oops_offset;
603 struct dentry *debugfs_root;
604 struct list_head dfsentry_list;
605 bool dbg_dump_printed;
606 bool ipc_dump_printed;
607 bool d3_prevented; /* runtime pm use count incremented to prevent context lost */
609 /* firmware loader */
610 struct sof_ipc_fw_ready fw_ready;
611 struct sof_ipc_fw_version fw_version;
612 struct sof_ipc_cc_version *cc_version;
615 struct snd_soc_tplg_ops *tplg_ops;
616 struct list_head pcm_list;
617 struct list_head kcontrol_list;
618 struct list_head widget_list;
619 struct list_head pipeline_list;
620 struct list_head dai_list;
621 struct list_head dai_link_list;
622 struct list_head route_list;
623 struct snd_soc_component *component;
624 u32 enabled_cores_mask; /* keep track of enabled cores */
627 /* FW configuration */
628 struct sof_ipc_window *info_window;
630 /* IPC timeouts in ms */
634 /* firmwre tracing */
635 bool fw_trace_is_supported; /* set with Kconfig or module parameter */
636 void *fw_trace_data; /* private data used by firmware tracing implementation */
640 /* DSP core context */
644 * ref count per core that will be modified during system suspend/resume and during pcm
645 * hw_params/hw_free. This doesn't need to be protected with a mutex because pcm
646 * hw_params/hw_free are already protected by the PCM mutex in the ALSA framework in
647 * sound/core/ when streams are active and during system suspend/resume, streams are
650 int dsp_core_ref_count[SOF_MAX_DSP_NUM_CORES];
653 * Used to keep track of registered IPC client devices so that they can
654 * be removed when the parent SOF module is removed.
656 struct list_head ipc_client_list;
658 /* mutex to protect client list */
659 struct mutex ipc_client_mutex;
662 * Used for tracking the IPC client's RX registration for DSP initiated
665 struct list_head ipc_rx_handler_list;
668 * Used for tracking the IPC client's registration for DSP state change
671 struct list_head fw_state_handler_list;
673 /* to protect the ipc_rx_handler_list and dsp_state_handler_list list */
674 struct mutex client_event_handler_mutex;
676 /* quirks to override topology values */
677 bool mclk_id_override;
678 u16 mclk_id_quirk; /* same size as in IPC3 definitions */
680 void *private; /* core does not touch this */
687 int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data);
688 int snd_sof_device_remove(struct device *dev);
689 int snd_sof_device_shutdown(struct device *dev);
690 bool snd_sof_device_probe_completed(struct device *dev);
692 int snd_sof_runtime_suspend(struct device *dev);
693 int snd_sof_runtime_resume(struct device *dev);
694 int snd_sof_runtime_idle(struct device *dev);
695 int snd_sof_resume(struct device *dev);
696 int snd_sof_suspend(struct device *dev);
697 int snd_sof_dsp_power_down_notify(struct snd_sof_dev *sdev);
698 int snd_sof_prepare(struct device *dev);
699 void snd_sof_complete(struct device *dev);
701 void snd_sof_new_platform_drv(struct snd_sof_dev *sdev);
706 extern struct snd_compress_ops sof_compressed_ops;
709 * Firmware (firmware, libraries, topologies) file location
711 int sof_create_ipc_file_profile(struct snd_sof_dev *sdev,
712 struct sof_loadable_file_profile *base_profile,
713 struct sof_loadable_file_profile *out_profile);
718 int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev);
719 int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev);
720 int snd_sof_run_firmware(struct snd_sof_dev *sdev);
721 void snd_sof_fw_unload(struct snd_sof_dev *sdev);
724 * IPC low level APIs.
726 struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev);
727 void snd_sof_ipc_free(struct snd_sof_dev *sdev);
728 void snd_sof_ipc_get_reply(struct snd_sof_dev *sdev);
729 void snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id);
730 static inline void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev)
732 sdev->ipc->ops->rx_msg(sdev);
734 int sof_ipc_tx_message(struct snd_sof_ipc *ipc, void *msg_data, size_t msg_bytes,
735 void *reply_data, size_t reply_bytes);
736 static inline int sof_ipc_tx_message_no_reply(struct snd_sof_ipc *ipc, void *msg_data,
739 return sof_ipc_tx_message(ipc, msg_data, msg_bytes, NULL, 0);
741 int sof_ipc_set_get_data(struct snd_sof_ipc *ipc, void *msg_data,
742 size_t msg_bytes, bool set);
743 int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, void *msg_data, size_t msg_bytes,
744 void *reply_data, size_t reply_bytes);
745 static inline int sof_ipc_tx_message_no_pm_no_reply(struct snd_sof_ipc *ipc, void *msg_data,
748 return sof_ipc_tx_message_no_pm(ipc, msg_data, msg_bytes, NULL, 0);
750 int sof_ipc_send_msg(struct snd_sof_dev *sdev, void *msg_data, size_t msg_bytes,
753 static inline void snd_sof_ipc_process_reply(struct snd_sof_dev *sdev, u32 msg_id)
755 snd_sof_ipc_get_reply(sdev);
756 snd_sof_ipc_reply(sdev, msg_id);
762 int snd_sof_dbg_init(struct snd_sof_dev *sdev);
763 void snd_sof_free_debug(struct snd_sof_dev *sdev);
764 int snd_sof_debugfs_buf_item(struct snd_sof_dev *sdev,
765 void *base, size_t size,
766 const char *name, mode_t mode);
767 void sof_print_oops_and_stack(struct snd_sof_dev *sdev, const char *level,
768 u32 panic_code, u32 tracep_code, void *oops,
769 struct sof_ipc_panic_info *panic_info,
770 void *stack, size_t stack_words);
771 void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev, const char *msg);
772 int snd_sof_dbg_memory_info_init(struct snd_sof_dev *sdev);
773 int snd_sof_debugfs_add_region_item_iomem(struct snd_sof_dev *sdev,
774 enum snd_sof_fw_blk_type blk_type, u32 offset, size_t size,
775 const char *name, enum sof_debugfs_access_type access_type);
776 /* Firmware tracing */
777 int sof_fw_trace_init(struct snd_sof_dev *sdev);
778 void sof_fw_trace_free(struct snd_sof_dev *sdev);
779 void sof_fw_trace_fw_crashed(struct snd_sof_dev *sdev);
780 void sof_fw_trace_suspend(struct snd_sof_dev *sdev, pm_message_t pm_state);
781 int sof_fw_trace_resume(struct snd_sof_dev *sdev);
786 static inline void sof_stack(struct snd_sof_dev *sdev, const char *level,
787 void *oops, u32 *stack, u32 stack_words)
789 sof_dsp_arch_ops(sdev)->dsp_stack(sdev, level, oops, stack,
793 static inline void sof_oops(struct snd_sof_dev *sdev, const char *level, void *oops)
795 if (sof_dsp_arch_ops(sdev)->dsp_oops)
796 sof_dsp_arch_ops(sdev)->dsp_oops(sdev, level, oops);
799 extern const struct dsp_arch_ops sof_xtensa_arch_ops;
802 * Firmware state tracking
804 void sof_set_fw_state(struct snd_sof_dev *sdev, enum sof_fw_state new_state);
809 void sof_io_write(struct snd_sof_dev *sdev, void __iomem *addr, u32 value);
810 void sof_io_write64(struct snd_sof_dev *sdev, void __iomem *addr, u64 value);
811 u32 sof_io_read(struct snd_sof_dev *sdev, void __iomem *addr);
812 u64 sof_io_read64(struct snd_sof_dev *sdev, void __iomem *addr);
813 void sof_mailbox_write(struct snd_sof_dev *sdev, u32 offset,
814 void *message, size_t bytes);
815 void sof_mailbox_read(struct snd_sof_dev *sdev, u32 offset,
816 void *message, size_t bytes);
817 int sof_block_write(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
818 u32 offset, void *src, size_t size);
819 int sof_block_read(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
820 u32 offset, void *dest, size_t size);
822 int sof_ipc_msg_data(struct snd_sof_dev *sdev,
823 struct snd_sof_pcm_stream *sps,
825 int sof_set_stream_data_offset(struct snd_sof_dev *sdev,
826 struct snd_sof_pcm_stream *sps,
829 int sof_stream_pcm_open(struct snd_sof_dev *sdev,
830 struct snd_pcm_substream *substream);
831 int sof_stream_pcm_close(struct snd_sof_dev *sdev,
832 struct snd_pcm_substream *substream);
834 /* SOF client support */
835 #if IS_ENABLED(CONFIG_SND_SOC_SOF_CLIENT)
836 int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name, u32 id,
837 const void *data, size_t size);
838 void sof_client_dev_unregister(struct snd_sof_dev *sdev, const char *name, u32 id);
839 int sof_register_clients(struct snd_sof_dev *sdev);
840 void sof_unregister_clients(struct snd_sof_dev *sdev);
841 void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf);
842 void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev);
843 int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state);
844 int sof_resume_clients(struct snd_sof_dev *sdev);
845 #else /* CONFIG_SND_SOC_SOF_CLIENT */
846 static inline int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name,
847 u32 id, const void *data, size_t size)
852 static inline void sof_client_dev_unregister(struct snd_sof_dev *sdev,
853 const char *name, u32 id)
857 static inline int sof_register_clients(struct snd_sof_dev *sdev)
862 static inline void sof_unregister_clients(struct snd_sof_dev *sdev)
866 static inline void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf)
870 static inline void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev)
874 static inline int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state)
879 static inline int sof_resume_clients(struct snd_sof_dev *sdev)
883 #endif /* CONFIG_SND_SOC_SOF_CLIENT */
885 /* Main ops for IPC implementations */
886 extern const struct sof_ipc_ops ipc3_ops;
887 extern const struct sof_ipc_ops ipc4_ops;