xref: /openbmc/linux/sound/soc/sof/sof-priv.h (revision fe4d0d5d) 
1 /* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
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 #ifndef __SOUND_SOC_SOF_PRIV_H
12 #define __SOUND_SOC_SOF_PRIV_H
13 
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>
22 
23 /* Flag definitions used in sof_core_debug (sof_debug module parameter) */
24 #define SOF_DBG_ENABLE_TRACE	BIT(0)
25 #define SOF_DBG_RETAIN_CTX	BIT(1)	/* prevent DSP D3 on FW exception */
26 #define SOF_DBG_VERIFY_TPLG	BIT(2) /* verify topology during load */
27 #define SOF_DBG_DYNAMIC_PIPELINES_OVERRIDE	BIT(3) /* 0: use topology token
28 							* 1: override topology
29 							*/
30 #define SOF_DBG_DYNAMIC_PIPELINES_ENABLE	BIT(4) /* 0: use static pipelines
31 							* 1: use dynamic pipelines
32 							*/
33 #define SOF_DBG_DISABLE_MULTICORE		BIT(5) /* schedule all pipelines/widgets
34 							* on primary core
35 							*/
36 #define SOF_DBG_PRINT_ALL_DUMPS		BIT(6) /* Print all ipc and dsp dumps */
37 #define SOF_DBG_IGNORE_D3_PERSISTENT		BIT(7) /* ignore the DSP D3 persistent capability
38 							* and always download firmware upon D3 exit
39 							*/
40 
41 /* Flag definitions used for controlling the DSP dump behavior */
42 #define SOF_DBG_DUMP_REGS		BIT(0)
43 #define SOF_DBG_DUMP_MBOX		BIT(1)
44 #define SOF_DBG_DUMP_TEXT		BIT(2)
45 #define SOF_DBG_DUMP_PCI		BIT(3)
46 /* Output this dump (at the DEBUG level) only when SOF_DBG_PRINT_ALL_DUMPS is set */
47 #define SOF_DBG_DUMP_OPTIONAL		BIT(4)
48 
49 /* global debug state set by SOF_DBG_ flags */
50 bool sof_debug_check_flag(int mask);
51 
52 /* max BARs mmaped devices can use */
53 #define SND_SOF_BARS	8
54 
55 /* time in ms for runtime suspend delay */
56 #define SND_SOF_SUSPEND_DELAY_MS	2000
57 
58 /* DMA buffer size for trace */
59 #define DMA_BUF_SIZE_FOR_TRACE (PAGE_SIZE * 16)
60 
61 #define SOF_IPC_DSP_REPLY		0
62 #define SOF_IPC_HOST_REPLY		1
63 
64 /* convenience constructor for DAI driver streams */
65 #define SOF_DAI_STREAM(sname, scmin, scmax, srates, sfmt) \
66 	{.stream_name = sname, .channels_min = scmin, .channels_max = scmax, \
67 	 .rates = srates, .formats = sfmt}
68 
69 #define SOF_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S24_LE | \
70 	SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_FLOAT)
71 
72 /* So far the primary core on all DSPs has ID 0 */
73 #define SOF_DSP_PRIMARY_CORE 0
74 
75 /* max number of DSP cores */
76 #define SOF_MAX_DSP_NUM_CORES 8
77 
78 struct sof_dsp_power_state {
79 	u32 state;
80 	u32 substate; /* platform-specific */
81 };
82 
83 /* System suspend target state */
84 enum sof_system_suspend_state {
85 	SOF_SUSPEND_NONE = 0,
86 	SOF_SUSPEND_S0IX,
87 	SOF_SUSPEND_S3,
88 };
89 
90 enum sof_dfsentry_type {
91 	SOF_DFSENTRY_TYPE_IOMEM = 0,
92 	SOF_DFSENTRY_TYPE_BUF,
93 };
94 
95 enum sof_debugfs_access_type {
96 	SOF_DEBUGFS_ACCESS_ALWAYS = 0,
97 	SOF_DEBUGFS_ACCESS_D0_ONLY,
98 };
99 
100 struct snd_sof_dev;
101 struct snd_sof_ipc_msg;
102 struct snd_sof_ipc;
103 struct snd_sof_debugfs_map;
104 struct snd_soc_tplg_ops;
105 struct snd_soc_component;
106 struct snd_sof_pdata;
107 
108 /**
109  * struct snd_sof_platform_stream_params - platform dependent stream parameters
110  * @stream_tag:		Stream tag to use
111  * @use_phy_addr:	Use the provided @phy_addr for configuration
112  * @phy_addr:		Platform dependent address to be used, if  @use_phy_addr
113  *			is true
114  * @no_ipc_position:	Disable position update IPC from firmware
115  */
116 struct snd_sof_platform_stream_params {
117 	u16 stream_tag;
118 	bool use_phy_address;
119 	u32 phy_addr;
120 	bool no_ipc_position;
121 };
122 
123 /*
124  * SOF DSP HW abstraction operations.
125  * Used to abstract DSP HW architecture and any IO busses between host CPU
126  * and DSP device(s).
127  */
128 struct snd_sof_dsp_ops {
129 
130 	/* probe/remove/shutdown */
131 	int (*probe)(struct snd_sof_dev *sof_dev); /* mandatory */
132 	int (*remove)(struct snd_sof_dev *sof_dev); /* optional */
133 	int (*shutdown)(struct snd_sof_dev *sof_dev); /* optional */
134 
135 	/* DSP core boot / reset */
136 	int (*run)(struct snd_sof_dev *sof_dev); /* mandatory */
137 	int (*stall)(struct snd_sof_dev *sof_dev, unsigned int core_mask); /* optional */
138 	int (*reset)(struct snd_sof_dev *sof_dev); /* optional */
139 	int (*core_get)(struct snd_sof_dev *sof_dev, int core); /* optional */
140 	int (*core_put)(struct snd_sof_dev *sof_dev, int core); /* optional */
141 
142 	/*
143 	 * Register IO: only used by respective drivers themselves,
144 	 * TODO: consider removing these operations and calling respective
145 	 * implementations directly
146 	 */
147 	void (*write)(struct snd_sof_dev *sof_dev, void __iomem *addr,
148 		      u32 value); /* optional */
149 	u32 (*read)(struct snd_sof_dev *sof_dev,
150 		    void __iomem *addr); /* optional */
151 	void (*write64)(struct snd_sof_dev *sof_dev, void __iomem *addr,
152 			u64 value); /* optional */
153 	u64 (*read64)(struct snd_sof_dev *sof_dev,
154 		      void __iomem *addr); /* optional */
155 
156 	/* memcpy IO */
157 	int (*block_read)(struct snd_sof_dev *sof_dev,
158 			  enum snd_sof_fw_blk_type type, u32 offset,
159 			  void *dest, size_t size); /* mandatory */
160 	int (*block_write)(struct snd_sof_dev *sof_dev,
161 			   enum snd_sof_fw_blk_type type, u32 offset,
162 			   void *src, size_t size); /* mandatory */
163 
164 	/* Mailbox IO */
165 	void (*mailbox_read)(struct snd_sof_dev *sof_dev,
166 			     u32 offset, void *dest,
167 			     size_t size); /* optional */
168 	void (*mailbox_write)(struct snd_sof_dev *sof_dev,
169 			      u32 offset, void *src,
170 			      size_t size); /* optional */
171 
172 	/* doorbell */
173 	irqreturn_t (*irq_handler)(int irq, void *context); /* optional */
174 	irqreturn_t (*irq_thread)(int irq, void *context); /* optional */
175 
176 	/* ipc */
177 	int (*send_msg)(struct snd_sof_dev *sof_dev,
178 			struct snd_sof_ipc_msg *msg); /* mandatory */
179 
180 	/* FW loading */
181 	int (*load_firmware)(struct snd_sof_dev *sof_dev); /* mandatory */
182 	int (*load_module)(struct snd_sof_dev *sof_dev,
183 			   struct snd_sof_mod_hdr *hdr); /* optional */
184 	/*
185 	 * FW ready checks for ABI compatibility and creates
186 	 * memory windows at first boot
187 	 */
188 	int (*fw_ready)(struct snd_sof_dev *sdev, u32 msg_id); /* mandatory */
189 
190 	/* connect pcm substream to a host stream */
191 	int (*pcm_open)(struct snd_sof_dev *sdev,
192 			struct snd_pcm_substream *substream); /* optional */
193 	/* disconnect pcm substream to a host stream */
194 	int (*pcm_close)(struct snd_sof_dev *sdev,
195 			 struct snd_pcm_substream *substream); /* optional */
196 
197 	/* host stream hw params */
198 	int (*pcm_hw_params)(struct snd_sof_dev *sdev,
199 			     struct snd_pcm_substream *substream,
200 			     struct snd_pcm_hw_params *params,
201 			     struct snd_sof_platform_stream_params *platform_params); /* optional */
202 
203 	/* host stream hw_free */
204 	int (*pcm_hw_free)(struct snd_sof_dev *sdev,
205 			   struct snd_pcm_substream *substream); /* optional */
206 
207 	/* host stream trigger */
208 	int (*pcm_trigger)(struct snd_sof_dev *sdev,
209 			   struct snd_pcm_substream *substream,
210 			   int cmd); /* optional */
211 
212 	/* host stream pointer */
213 	snd_pcm_uframes_t (*pcm_pointer)(struct snd_sof_dev *sdev,
214 					 struct snd_pcm_substream *substream); /* optional */
215 
216 	/* pcm ack */
217 	int (*pcm_ack)(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream); /* optional */
218 
219 	/* host read DSP stream data */
220 	int (*ipc_msg_data)(struct snd_sof_dev *sdev,
221 			    struct snd_pcm_substream *substream,
222 			    void *p, size_t sz); /* mandatory */
223 
224 	/* host side configuration of the stream's data offset in stream mailbox area */
225 	int (*set_stream_data_offset)(struct snd_sof_dev *sdev,
226 				      struct snd_pcm_substream *substream,
227 				      size_t posn_offset); /* optional */
228 
229 	/* pre/post firmware run */
230 	int (*pre_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
231 	int (*post_fw_run)(struct snd_sof_dev *sof_dev); /* optional */
232 
233 	/* parse platform specific extended manifest, optional */
234 	int (*parse_platform_ext_manifest)(struct snd_sof_dev *sof_dev,
235 					   const struct sof_ext_man_elem_header *hdr);
236 
237 	/* DSP PM */
238 	int (*suspend)(struct snd_sof_dev *sof_dev,
239 		       u32 target_state); /* optional */
240 	int (*resume)(struct snd_sof_dev *sof_dev); /* optional */
241 	int (*runtime_suspend)(struct snd_sof_dev *sof_dev); /* optional */
242 	int (*runtime_resume)(struct snd_sof_dev *sof_dev); /* optional */
243 	int (*runtime_idle)(struct snd_sof_dev *sof_dev); /* optional */
244 	int (*set_hw_params_upon_resume)(struct snd_sof_dev *sdev); /* optional */
245 	int (*set_power_state)(struct snd_sof_dev *sdev,
246 			       const struct sof_dsp_power_state *target_state); /* optional */
247 
248 	/* DSP clocking */
249 	int (*set_clk)(struct snd_sof_dev *sof_dev, u32 freq); /* optional */
250 
251 	/* debug */
252 	const struct snd_sof_debugfs_map *debug_map; /* optional */
253 	int debug_map_count; /* optional */
254 	void (*dbg_dump)(struct snd_sof_dev *sof_dev,
255 			 u32 flags); /* optional */
256 	void (*ipc_dump)(struct snd_sof_dev *sof_dev); /* optional */
257 	int (*debugfs_add_region_item)(struct snd_sof_dev *sdev,
258 				       enum snd_sof_fw_blk_type blk_type, u32 offset,
259 				       size_t size, const char *name,
260 				       enum sof_debugfs_access_type access_type); /* optional */
261 
262 	/* host DMA trace initialization */
263 	int (*trace_init)(struct snd_sof_dev *sdev,
264 			  struct sof_ipc_dma_trace_params_ext *dtrace_params); /* optional */
265 	int (*trace_release)(struct snd_sof_dev *sdev); /* optional */
266 	int (*trace_trigger)(struct snd_sof_dev *sdev,
267 			     int cmd); /* optional */
268 
269 	/* misc */
270 	int (*get_bar_index)(struct snd_sof_dev *sdev,
271 			     u32 type); /* optional */
272 	int (*get_mailbox_offset)(struct snd_sof_dev *sdev);/* mandatory for common loader code */
273 	int (*get_window_offset)(struct snd_sof_dev *sdev,
274 				 u32 id);/* mandatory for common loader code */
275 
276 	/* machine driver ops */
277 	int (*machine_register)(struct snd_sof_dev *sdev,
278 				void *pdata); /* optional */
279 	void (*machine_unregister)(struct snd_sof_dev *sdev,
280 				   void *pdata); /* optional */
281 	struct snd_soc_acpi_mach * (*machine_select)(struct snd_sof_dev *sdev); /* optional */
282 	void (*set_mach_params)(struct snd_soc_acpi_mach *mach,
283 				struct snd_sof_dev *sdev); /* optional */
284 
285 	/* IPC client ops */
286 	int (*register_ipc_clients)(struct snd_sof_dev *sdev); /* optional */
287 	void (*unregister_ipc_clients)(struct snd_sof_dev *sdev); /* optional */
288 
289 	/* DAI ops */
290 	struct snd_soc_dai_driver *drv;
291 	int num_drv;
292 
293 	/* ALSA HW info flags, will be stored in snd_pcm_runtime.hw.info */
294 	u32 hw_info;
295 
296 	const struct dsp_arch_ops *dsp_arch_ops;
297 };
298 
299 /* DSP architecture specific callbacks for oops and stack dumps */
300 struct dsp_arch_ops {
301 	void (*dsp_oops)(struct snd_sof_dev *sdev, const char *level, void *oops);
302 	void (*dsp_stack)(struct snd_sof_dev *sdev, const char *level, void *oops,
303 			  u32 *stack, u32 stack_words);
304 };
305 
306 #define sof_dsp_arch_ops(sdev) ((sdev)->pdata->desc->ops->dsp_arch_ops)
307 
308 /* FS entry for debug files that can expose DSP memories, registers */
309 struct snd_sof_dfsentry {
310 	size_t size;
311 	size_t buf_data_size;  /* length of buffered data for file read operation */
312 	enum sof_dfsentry_type type;
313 	/*
314 	 * access_type specifies if the
315 	 * memory -> DSP resource (memory, register etc) is always accessible
316 	 * or if it is accessible only when the DSP is in D0.
317 	 */
318 	enum sof_debugfs_access_type access_type;
319 #if IS_ENABLED(CONFIG_SND_SOC_SOF_DEBUG_ENABLE_DEBUGFS_CACHE)
320 	char *cache_buf; /* buffer to cache the contents of debugfs memory */
321 #endif
322 	struct snd_sof_dev *sdev;
323 	struct list_head list;  /* list in sdev dfsentry list */
324 	union {
325 		void __iomem *io_mem;
326 		void *buf;
327 	};
328 };
329 
330 /* Debug mapping for any DSP memory or registers that can used for debug */
331 struct snd_sof_debugfs_map {
332 	const char *name;
333 	u32 bar;
334 	u32 offset;
335 	u32 size;
336 	/*
337 	 * access_type specifies if the memory is always accessible
338 	 * or if it is accessible only when the DSP is in D0.
339 	 */
340 	enum sof_debugfs_access_type access_type;
341 };
342 
343 /* mailbox descriptor, used for host <-> DSP IPC */
344 struct snd_sof_mailbox {
345 	u32 offset;
346 	size_t size;
347 };
348 
349 /* IPC message descriptor for host <-> DSP IO */
350 struct snd_sof_ipc_msg {
351 	/* message data */
352 	u32 header;
353 	void *msg_data;
354 	void *reply_data;
355 	size_t msg_size;
356 	size_t reply_size;
357 	int reply_error;
358 
359 	wait_queue_head_t waitq;
360 	bool ipc_complete;
361 };
362 
363 /**
364  * struct sof_ipc_pm_ops - IPC-specific PM ops
365  * @ctx_save:		Function pointer for context save
366  * @ctx_restore:	Function pointer for context restore
367  */
368 struct sof_ipc_pm_ops {
369 	int (*ctx_save)(struct snd_sof_dev *sdev);
370 	int (*ctx_restore)(struct snd_sof_dev *sdev);
371 };
372 
373 struct sof_ipc_tplg_ops;
374 struct sof_ipc_pcm_ops;
375 
376 /**
377  * struct sof_ipc_ops - IPC-specific ops
378  * @tplg:	Pointer to IPC-specific topology ops
379  * @pm:		Pointer to PM ops
380  * @pcm:	Pointer to PCM ops
381  */
382 struct sof_ipc_ops {
383 	const struct sof_ipc_tplg_ops *tplg;
384 	const struct sof_ipc_pm_ops *pm;
385 	const struct sof_ipc_pcm_ops *pcm;
386 };
387 
388 /* SOF generic IPC data */
389 struct snd_sof_ipc {
390 	struct snd_sof_dev *sdev;
391 
392 	/* protects messages and the disable flag */
393 	struct mutex tx_mutex;
394 	/* disables further sending of ipc's */
395 	bool disable_ipc_tx;
396 
397 	struct snd_sof_ipc_msg msg;
398 
399 	/* IPC ops based on version */
400 	const struct sof_ipc_ops *ops;
401 };
402 
403 /*
404  * SOF Device Level.
405  */
406 struct snd_sof_dev {
407 	struct device *dev;
408 	spinlock_t ipc_lock;	/* lock for IPC users */
409 	spinlock_t hw_lock;	/* lock for HW IO access */
410 
411 	/*
412 	 * ASoC components. plat_drv fields are set dynamically so
413 	 * can't use const
414 	 */
415 	struct snd_soc_component_driver plat_drv;
416 
417 	/* current DSP power state */
418 	struct sof_dsp_power_state dsp_power_state;
419 	/* mutex to protect the dsp_power_state access */
420 	struct mutex power_state_access;
421 
422 	/* Intended power target of system suspend */
423 	enum sof_system_suspend_state system_suspend_target;
424 
425 	/* DSP firmware boot */
426 	wait_queue_head_t boot_wait;
427 	enum sof_fw_state fw_state;
428 	bool first_boot;
429 
430 	/* work queue in case the probe is implemented in two steps */
431 	struct work_struct probe_work;
432 	bool probe_completed;
433 
434 	/* DSP HW differentiation */
435 	struct snd_sof_pdata *pdata;
436 
437 	/* IPC */
438 	struct snd_sof_ipc *ipc;
439 	struct snd_sof_mailbox dsp_box;		/* DSP initiated IPC */
440 	struct snd_sof_mailbox host_box;	/* Host initiated IPC */
441 	struct snd_sof_mailbox stream_box;	/* Stream position update */
442 	struct snd_sof_mailbox debug_box;	/* Debug info updates */
443 	struct snd_sof_ipc_msg *msg;
444 	int ipc_irq;
445 	u32 next_comp_id; /* monotonic - reset during S3 */
446 
447 	/* memory bases for mmaped DSPs - set by dsp_init() */
448 	void __iomem *bar[SND_SOF_BARS];	/* DSP base address */
449 	int mmio_bar;
450 	int mailbox_bar;
451 	size_t dsp_oops_offset;
452 
453 	/* debug */
454 	struct dentry *debugfs_root;
455 	struct list_head dfsentry_list;
456 	bool dbg_dump_printed;
457 	bool ipc_dump_printed;
458 
459 	/* firmware loader */
460 	struct snd_dma_buffer dmab;
461 	struct snd_dma_buffer dmab_bdl;
462 	struct sof_ipc_fw_ready fw_ready;
463 	struct sof_ipc_fw_version fw_version;
464 	struct sof_ipc_cc_version *cc_version;
465 
466 	/* topology */
467 	struct snd_soc_tplg_ops *tplg_ops;
468 	struct list_head pcm_list;
469 	struct list_head kcontrol_list;
470 	struct list_head widget_list;
471 	struct list_head dai_list;
472 	struct list_head dai_link_list;
473 	struct list_head route_list;
474 	struct snd_soc_component *component;
475 	u32 enabled_cores_mask; /* keep track of enabled cores */
476 
477 	/* FW configuration */
478 	struct sof_ipc_window *info_window;
479 
480 	/* IPC timeouts in ms */
481 	int ipc_timeout;
482 	int boot_timeout;
483 
484 	/* DMA for Trace */
485 	struct snd_dma_buffer dmatb;
486 	struct snd_dma_buffer dmatp;
487 	int dma_trace_pages;
488 	wait_queue_head_t trace_sleep;
489 	u32 host_offset;
490 	bool dtrace_is_supported; /* set with Kconfig or module parameter */
491 	bool dtrace_is_enabled;
492 	bool dtrace_error;
493 	bool dtrace_draining;
494 
495 	bool msi_enabled;
496 
497 	/* DSP core context */
498 	u32 num_cores;
499 
500 	/*
501 	 * ref count per core that will be modified during system suspend/resume and during pcm
502 	 * hw_params/hw_free. This doesn't need to be protected with a mutex because pcm
503 	 * hw_params/hw_free are already protected by the PCM mutex in the ALSA framework in
504 	 * sound/core/ when streams are active and during system suspend/resume, streams are
505 	 * already suspended.
506 	 */
507 	int dsp_core_ref_count[SOF_MAX_DSP_NUM_CORES];
508 
509 	/*
510 	 * Used to keep track of registered IPC client devices so that they can
511 	 * be removed when the parent SOF module is removed.
512 	 */
513 	struct list_head ipc_client_list;
514 
515 	/* mutex to protect client list */
516 	struct mutex ipc_client_mutex;
517 
518 	/*
519 	 * Used for tracking the IPC client's RX registration for DSP initiated
520 	 * message handling.
521 	 */
522 	struct list_head ipc_rx_handler_list;
523 
524 	/*
525 	 * Used for tracking the IPC client's registration for DSP state change
526 	 * notification
527 	 */
528 	struct list_head fw_state_handler_list;
529 
530 	/* to protect the ipc_rx_handler_list  and  dsp_state_handler_list list */
531 	struct mutex client_event_handler_mutex;
532 
533 	void *private;			/* core does not touch this */
534 };
535 
536 /*
537  * Device Level.
538  */
539 
540 int snd_sof_device_probe(struct device *dev, struct snd_sof_pdata *plat_data);
541 int snd_sof_device_remove(struct device *dev);
542 int snd_sof_device_shutdown(struct device *dev);
543 bool snd_sof_device_probe_completed(struct device *dev);
544 
545 int snd_sof_runtime_suspend(struct device *dev);
546 int snd_sof_runtime_resume(struct device *dev);
547 int snd_sof_runtime_idle(struct device *dev);
548 int snd_sof_resume(struct device *dev);
549 int snd_sof_suspend(struct device *dev);
550 int snd_sof_dsp_power_down_notify(struct snd_sof_dev *sdev);
551 int snd_sof_prepare(struct device *dev);
552 void snd_sof_complete(struct device *dev);
553 
554 void snd_sof_new_platform_drv(struct snd_sof_dev *sdev);
555 
556 /*
557  * Compress support
558  */
559 extern struct snd_compress_ops sof_compressed_ops;
560 
561 /*
562  * Firmware loading.
563  */
564 int snd_sof_load_firmware_raw(struct snd_sof_dev *sdev);
565 int snd_sof_load_firmware_memcpy(struct snd_sof_dev *sdev);
566 int snd_sof_run_firmware(struct snd_sof_dev *sdev);
567 int snd_sof_parse_module_memcpy(struct snd_sof_dev *sdev,
568 				struct snd_sof_mod_hdr *module);
569 void snd_sof_fw_unload(struct snd_sof_dev *sdev);
570 
571 /*
572  * IPC low level APIs.
573  */
574 struct snd_sof_ipc *snd_sof_ipc_init(struct snd_sof_dev *sdev);
575 void snd_sof_ipc_free(struct snd_sof_dev *sdev);
576 void snd_sof_ipc_get_reply(struct snd_sof_dev *sdev);
577 void snd_sof_ipc_reply(struct snd_sof_dev *sdev, u32 msg_id);
578 void snd_sof_ipc_msgs_rx(struct snd_sof_dev *sdev);
579 int snd_sof_ipc_valid(struct snd_sof_dev *sdev);
580 int sof_ipc_tx_message(struct snd_sof_ipc *ipc, u32 header,
581 		       void *msg_data, size_t msg_bytes, void *reply_data,
582 		       size_t reply_bytes);
583 int sof_ipc_tx_message_no_pm(struct snd_sof_ipc *ipc, u32 header,
584 			     void *msg_data, size_t msg_bytes,
585 			     void *reply_data, size_t reply_bytes);
586 int sof_ipc_init_msg_memory(struct snd_sof_dev *sdev);
587 static inline void snd_sof_ipc_process_reply(struct snd_sof_dev *sdev, u32 msg_id)
588 {
589 	snd_sof_ipc_get_reply(sdev);
590 	snd_sof_ipc_reply(sdev, msg_id);
591 }
592 
593 /*
594  * Trace/debug
595  */
596 int snd_sof_init_trace(struct snd_sof_dev *sdev);
597 void snd_sof_release_trace(struct snd_sof_dev *sdev);
598 void snd_sof_free_trace(struct snd_sof_dev *sdev);
599 int snd_sof_dbg_init(struct snd_sof_dev *sdev);
600 void snd_sof_free_debug(struct snd_sof_dev *sdev);
601 int snd_sof_debugfs_buf_item(struct snd_sof_dev *sdev,
602 			     void *base, size_t size,
603 			     const char *name, mode_t mode);
604 int snd_sof_trace_update_pos(struct snd_sof_dev *sdev,
605 			     struct sof_ipc_dma_trace_posn *posn);
606 void snd_sof_trace_notify_for_error(struct snd_sof_dev *sdev);
607 void sof_print_oops_and_stack(struct snd_sof_dev *sdev, const char *level,
608 			      u32 panic_code, u32 tracep_code, void *oops,
609 			      struct sof_ipc_panic_info *panic_info,
610 			      void *stack, size_t stack_words);
611 int snd_sof_init_trace_ipc(struct snd_sof_dev *sdev);
612 void snd_sof_handle_fw_exception(struct snd_sof_dev *sdev);
613 int snd_sof_dbg_memory_info_init(struct snd_sof_dev *sdev);
614 int snd_sof_debugfs_add_region_item_iomem(struct snd_sof_dev *sdev,
615 		enum snd_sof_fw_blk_type blk_type, u32 offset, size_t size,
616 		const char *name, enum sof_debugfs_access_type access_type);
617 
618 /*
619  * DSP Architectures.
620  */
621 static inline void sof_stack(struct snd_sof_dev *sdev, const char *level,
622 			     void *oops, u32 *stack, u32 stack_words)
623 {
624 		sof_dsp_arch_ops(sdev)->dsp_stack(sdev, level,  oops, stack,
625 						  stack_words);
626 }
627 
628 static inline void sof_oops(struct snd_sof_dev *sdev, const char *level, void *oops)
629 {
630 	if (sof_dsp_arch_ops(sdev)->dsp_oops)
631 		sof_dsp_arch_ops(sdev)->dsp_oops(sdev, level, oops);
632 }
633 
634 extern const struct dsp_arch_ops sof_xtensa_arch_ops;
635 
636 /*
637  * Firmware state tracking
638  */
639 void sof_set_fw_state(struct snd_sof_dev *sdev, enum sof_fw_state new_state);
640 
641 /*
642  * Utilities
643  */
644 void sof_io_write(struct snd_sof_dev *sdev, void __iomem *addr, u32 value);
645 void sof_io_write64(struct snd_sof_dev *sdev, void __iomem *addr, u64 value);
646 u32 sof_io_read(struct snd_sof_dev *sdev, void __iomem *addr);
647 u64 sof_io_read64(struct snd_sof_dev *sdev, void __iomem *addr);
648 void sof_mailbox_write(struct snd_sof_dev *sdev, u32 offset,
649 		       void *message, size_t bytes);
650 void sof_mailbox_read(struct snd_sof_dev *sdev, u32 offset,
651 		      void *message, size_t bytes);
652 int sof_block_write(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
653 		    u32 offset, void *src, size_t size);
654 int sof_block_read(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
655 		   u32 offset, void *dest, size_t size);
656 
657 int sof_fw_ready(struct snd_sof_dev *sdev, u32 msg_id);
658 
659 int sof_ipc_msg_data(struct snd_sof_dev *sdev,
660 		     struct snd_pcm_substream *substream,
661 		     void *p, size_t sz);
662 int sof_set_stream_data_offset(struct snd_sof_dev *sdev,
663 			       struct snd_pcm_substream *substream,
664 			       size_t posn_offset);
665 
666 int sof_stream_pcm_open(struct snd_sof_dev *sdev,
667 			struct snd_pcm_substream *substream);
668 int sof_stream_pcm_close(struct snd_sof_dev *sdev,
669 			 struct snd_pcm_substream *substream);
670 
671 int sof_machine_check(struct snd_sof_dev *sdev);
672 
673 /* SOF client support */
674 #if IS_ENABLED(CONFIG_SND_SOC_SOF_CLIENT)
675 int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name, u32 id,
676 			    const void *data, size_t size);
677 void sof_client_dev_unregister(struct snd_sof_dev *sdev, const char *name, u32 id);
678 int sof_register_clients(struct snd_sof_dev *sdev);
679 void sof_unregister_clients(struct snd_sof_dev *sdev);
680 void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf);
681 void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev);
682 int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state);
683 int sof_resume_clients(struct snd_sof_dev *sdev);
684 #else /* CONFIG_SND_SOC_SOF_CLIENT */
685 static inline int sof_client_dev_register(struct snd_sof_dev *sdev, const char *name,
686 					  u32 id, const void *data, size_t size)
687 {
688 	return 0;
689 }
690 
691 static inline void sof_client_dev_unregister(struct snd_sof_dev *sdev,
692 					     const char *name, u32 id)
693 {
694 }
695 
696 static inline int sof_register_clients(struct snd_sof_dev *sdev)
697 {
698 	return 0;
699 }
700 
701 static inline  void sof_unregister_clients(struct snd_sof_dev *sdev)
702 {
703 }
704 
705 static inline void sof_client_ipc_rx_dispatcher(struct snd_sof_dev *sdev, void *msg_buf)
706 {
707 }
708 
709 static inline void sof_client_fw_state_dispatcher(struct snd_sof_dev *sdev)
710 {
711 }
712 
713 static inline int sof_suspend_clients(struct snd_sof_dev *sdev, pm_message_t state)
714 {
715 	return 0;
716 }
717 
718 static inline int sof_resume_clients(struct snd_sof_dev *sdev)
719 {
720 	return 0;
721 }
722 #endif /* CONFIG_SND_SOC_SOF_CLIENT */
723 
724 #endif
725