intel/avs/avs.h

1 /* SPDX-License-Identifier: GPL-2.0-only */
3  * Copyright(c) 2021-2022 Intel Corporation
14 #include <linux/firmware.h>
18 #include <sound/soc-component.h>
36  * struct avs_dsp_ops - Platform-specific DSP operations
51 	int (* const load_basefw)(struct avs_dev *, struct firmware *);
52 	int (* const load_lib)(struct avs_dev *, struct firmware *, u32);
65 	((adev)->spec->dsp_ops->op(adev, ## __VA_ARGS__))
77 	((adev)->spec->attributes & AVS_PLATATTR_##attr)
98 	const char *name;  member
110 	const char *name;  member
111 	const struct firmware *fw;
117  * struct avs_dev - Intel HD-Audio driver data
121  * @spec: platform-specific descriptor
122  * @fw_cfg: Firmware configuration, obtained through FW_CONFIG message
124  * @mods_info: Available module-types, obtained through MODULES_INFO message
125  * @mod_idas: Module instance ID pool, one per module-type
128  * @fw_list: List of libraries loaded, including base firmware
204  * struct avs_ipc - DSP IPC context
209  * @ready: whether firmware is ready and communication is open
213  * @done_completion: DONE-part of IPC i.e. ROM and ACKs from FW
214  * @busy_completion: BUSY-part of IPC i.e. receiving responses from FW
238  * IPC handlers may return positive value (firmware error code) what denotes
239  * successful HOST <-> DSP communication yet failure to process specific request.
242  * All IPC callers MUST use it as soon as firmware error code is consumed.
245 	(((ret) <= 0) ? (ret) : -AVS_EIPC)
249 			     struct avs_ipc_msg *reply, int timeout, const char *name);
251 		     struct avs_ipc_msg *reply, const char *name);
255 				const char *name);
257 			struct avs_ipc_msg *reply, bool wake_d0i0, const char *name);
259 				 const char *name);
260 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, const char *name);
283 /* Firmware resources management */
294 int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name);
307 /* Firmware loading */
317 int avs_cldma_load_basefw(struct avs_dev *adev, struct firmware *fw);
318 int avs_cldma_load_library(struct avs_dev *adev, struct firmware *lib, u32 id);
321 int avs_hda_load_basefw(struct avs_dev *adev, struct firmware *fw);
322 int avs_hda_load_library(struct avs_dev *adev, struct firmware *lib, u32 id);
326 int avs_icl_load_basefw(struct avs_dev *adev, struct firmware *fw);
342 int avs_soc_component_register(struct device *dev, const char *name,
345 int avs_dmic_platform_register(struct avs_dev *adev, const char *name);
346 int avs_i2s_platform_register(struct avs_dev *adev, const char *name, unsigned long port_mask,
348 int avs_hda_platform_register(struct avs_dev *adev, const char *name);
353 /* Firmware tracing helpers */
356 	((adev)->fw_cfg.trace_log_bytes / (adev)->hw_cfg.dsp_cores)
370 	spin_lock_irqsave(&adev->trace_lock, flags);  in avs_log_buffer_status_locked()
372 	spin_unlock_irqrestore(&adev->trace_lock, flags);  in avs_log_buffer_status_locked()
385 	(avs_log_buffer_size(adev) - sizeof(struct avs_apl_log_buffer_layout))
391 #define AVS_SET_ENABLE_LOGS_OP(name) \  argument
392 	.enable_logs = avs_##name##_enable_logs
398 int avs_probe_platform_register(struct avs_dev *adev, const char *name);
403 #define AVS_SET_ENABLE_LOGS_OP(name)  argument
419 static inline int avs_probe_platform_register(struct avs_dev *adev, const char *name)  in avs_probe_platform_register()  argument