/* SPDX-License-Identifier: GPL-2.0-only */ /* * Copyright(c) 2021-2022 Intel Corporation * * Authors: Cezary Rojewski <[email protected]> * Amadeusz Slawinski <[email protected]> */ #ifndef __SOUND_SOC_INTEL_AVS_H #define __SOUND_SOC_INTEL_AVS_H #include <linux/debugfs.h> #include <linux/device.h> #include <linux/firmware.h> #include <linux/kfifo.h> #include <sound/hda_codec.h> #include <sound/hda_register.h> #include <sound/soc-component.h> #include "messages.h" #include "registers.h" struct avs_dev; struct avs_tplg; struct avs_tplg_library; struct avs_soc_component; struct avs_ipc_msg; #ifdef CONFIG_ACPI #define AVS_S0IX_SUPPORTED … #else #define AVS_S0IX_SUPPORTED … #endif /* * struct avs_dsp_ops - Platform-specific DSP operations * * @power: Power on or off DSP cores * @reset: Enter or exit reset state on DSP cores * @stall: Stall or run DSP cores * @irq_handler: Top half of IPC servicing * @irq_thread: Bottom half of IPC servicing * @int_control: Enable or disable IPC interrupts */ struct avs_dsp_ops { … }; #define avs_dsp_op(adev, op, ...) … extern const struct avs_dsp_ops avs_skl_dsp_ops; extern const struct avs_dsp_ops avs_apl_dsp_ops; extern const struct avs_dsp_ops avs_cnl_dsp_ops; extern const struct avs_dsp_ops avs_icl_dsp_ops; extern const struct avs_dsp_ops avs_tgl_dsp_ops; #define AVS_PLATATTR_CLDMA … #define AVS_PLATATTR_IMR … #define avs_platattr_test(adev, attr) … struct avs_sram_spec { … }; struct avs_hipc_spec { … }; /* Platform specific descriptor */ struct avs_spec { … }; struct avs_fw_entry { … }; /* * struct avs_dev - Intel HD-Audio driver data * * @dev: PCI device * @dsp_ba: DSP bar address * @spec: platform-specific descriptor * @fw_cfg: Firmware configuration, obtained through FW_CONFIG message * @hw_cfg: Hardware configuration, obtained through HW_CONFIG message * @mods_info: Available module-types, obtained through MODULES_INFO message * @mod_idas: Module instance ID pool, one per module-type * @modres_mutex: For synchronizing any @mods_info updates * @ppl_ida: Pipeline instance ID pool * @fw_list: List of libraries loaded, including base firmware */ struct avs_dev { … }; /* from hda_bus to avs_dev */ #define hda_to_avs(hda) … /* from hdac_bus to avs_dev */ #define hdac_to_avs(hdac) … /* from device to avs_dev */ #define to_avs_dev(dev) … int avs_dsp_core_power(struct avs_dev *adev, u32 core_mask, bool power); int avs_dsp_core_reset(struct avs_dev *adev, u32 core_mask, bool reset); int avs_dsp_core_stall(struct avs_dev *adev, u32 core_mask, bool stall); int avs_dsp_core_enable(struct avs_dev *adev, u32 core_mask); int avs_dsp_core_disable(struct avs_dev *adev, u32 core_mask); /* Inter Process Communication */ struct avs_ipc_msg { … }; /* * struct avs_ipc - DSP IPC context * * @dev: PCI device * @rx: Reply message cache * @default_timeout_ms: default message timeout in MS * @ready: whether firmware is ready and communication is open * @rx_completed: whether RX for previously sent TX has been received * @rx_lock: for serializing manipulation of rx_* fields * @msg_lock: for synchronizing request handling * @done_completion: DONE-part of IPC i.e. ROM and ACKs from FW * @busy_completion: BUSY-part of IPC i.e. receiving responses from FW */ struct avs_ipc { … }; #define AVS_EIPC … /* * IPC handlers may return positive value (firmware error code) what denotes * successful HOST <-> DSP communication yet failure to process specific request. * * Below macro converts returned value to linux kernel error code. * All IPC callers MUST use it as soon as firmware error code is consumed. */ #define AVS_IPC_RET(ret) … void avs_dsp_process_response(struct avs_dev *adev, u64 header); int avs_dsp_send_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, struct avs_ipc_msg *reply, int timeout, const char *name); int avs_dsp_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request, struct avs_ipc_msg *reply, const char *name); /* Two variants below are for messages that control DSP power states. */ int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, struct avs_ipc_msg *reply, int timeout, bool wake_d0i0, const char *name); int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request, struct avs_ipc_msg *reply, bool wake_d0i0, const char *name); int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout, const char *name); int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, const char *name); void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable); int avs_ipc_init(struct avs_ipc *ipc, struct device *dev); void avs_ipc_block(struct avs_ipc *ipc); int avs_dsp_disable_d0ix(struct avs_dev *adev); int avs_dsp_enable_d0ix(struct avs_dev *adev); void avs_skl_ipc_interrupt(struct avs_dev *adev); irqreturn_t avs_cnl_dsp_interrupt(struct avs_dev *adev); int avs_apl_enable_logs(struct avs_dev *adev, enum avs_log_enable enable, u32 aging_period, u32 fifo_full_period, unsigned long resource_mask, u32 *priorities); int avs_icl_enable_logs(struct avs_dev *adev, enum avs_log_enable enable, u32 aging_period, u32 fifo_full_period, unsigned long resource_mask, u32 *priorities); int avs_skl_log_buffer_offset(struct avs_dev *adev, u32 core); int avs_icl_log_buffer_offset(struct avs_dev *adev, u32 core); int avs_apl_log_buffer_status(struct avs_dev *adev, union avs_notify_msg *msg); int avs_apl_coredump(struct avs_dev *adev, union avs_notify_msg *msg); bool avs_apl_d0ix_toggle(struct avs_dev *adev, struct avs_ipc_msg *tx, bool wake); bool avs_icl_d0ix_toggle(struct avs_dev *adev, struct avs_ipc_msg *tx, bool wake); int avs_apl_set_d0ix(struct avs_dev *adev, bool enable); int avs_icl_set_d0ix(struct avs_dev *adev, bool enable); /* Firmware resources management */ int avs_get_module_entry(struct avs_dev *adev, const guid_t *uuid, struct avs_module_entry *entry); int avs_get_module_id_entry(struct avs_dev *adev, u32 module_id, struct avs_module_entry *entry); int avs_get_module_id(struct avs_dev *adev, const guid_t *uuid); bool avs_is_module_ida_empty(struct avs_dev *adev, u32 module_id); int avs_module_info_init(struct avs_dev *adev, bool purge); void avs_module_info_free(struct avs_dev *adev); int avs_module_id_alloc(struct avs_dev *adev, u16 module_id); void avs_module_id_free(struct avs_dev *adev, u16 module_id, u8 instance_id); int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name); void avs_release_last_firmware(struct avs_dev *adev); void avs_release_firmwares(struct avs_dev *adev); int avs_dsp_init_module(struct avs_dev *adev, u16 module_id, u8 ppl_instance_id, u8 core_id, u8 domain, void *param, u32 param_size, u8 *instance_id); void avs_dsp_delete_module(struct avs_dev *adev, u16 module_id, u8 instance_id, u8 ppl_instance_id, u8 core_id); int avs_dsp_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority, bool lp, u16 attributes, u8 *instance_id); int avs_dsp_delete_pipeline(struct avs_dev *adev, u8 instance_id); /* Firmware loading */ void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable); void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable); void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable); int avs_dsp_load_libraries(struct avs_dev *adev, struct avs_tplg_library *libs, u32 num_libs); int avs_dsp_boot_firmware(struct avs_dev *adev, bool purge); int avs_dsp_first_boot_firmware(struct avs_dev *adev); int avs_cldma_load_basefw(struct avs_dev *adev, struct firmware *fw); int avs_cldma_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); int avs_cldma_transfer_modules(struct avs_dev *adev, bool load, struct avs_module_entry *mods, u32 num_mods); int avs_hda_load_basefw(struct avs_dev *adev, struct firmware *fw); int avs_hda_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); int avs_hda_transfer_modules(struct avs_dev *adev, bool load, struct avs_module_entry *mods, u32 num_mods); int avs_icl_load_basefw(struct avs_dev *adev, struct firmware *fw); /* Soc component members */ struct avs_soc_component { … }; #define to_avs_soc_component(comp) … extern const struct snd_soc_dai_ops avs_dai_fe_ops; int avs_soc_component_register(struct device *dev, const char *name, const struct snd_soc_component_driver *drv, struct snd_soc_dai_driver *cpu_dais, int num_cpu_dais); int avs_dmic_platform_register(struct avs_dev *adev, const char *name); int avs_i2s_platform_register(struct avs_dev *adev, const char *name, unsigned long port_mask, unsigned long *tdms); int avs_hda_platform_register(struct avs_dev *adev, const char *name); int avs_register_all_boards(struct avs_dev *adev); void avs_unregister_all_boards(struct avs_dev *adev); /* Firmware tracing helpers */ #define avs_log_buffer_size(adev) … #define avs_log_buffer_addr(adev, core) … static inline int avs_log_buffer_status_locked(struct avs_dev *adev, union avs_notify_msg *msg) { … } struct avs_apl_log_buffer_layout { … } __packed; static_assert(…); #define avs_apl_log_payload_size(adev) … #define avs_apl_log_payload_addr(addr) … #ifdef CONFIG_DEBUG_FS #define AVS_SET_ENABLE_LOGS_OP(name) … bool avs_logging_fw(struct avs_dev *adev); void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len); void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len); int avs_probe_platform_register(struct avs_dev *adev, const char *name); void avs_debugfs_init(struct avs_dev *adev); void avs_debugfs_exit(struct avs_dev *adev); #else #define AVS_SET_ENABLE_LOGS_OP … static inline bool avs_logging_fw(struct avs_dev *adev) { return false; } static inline void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len) { } static inline void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len) { } static inline int avs_probe_platform_register(struct avs_dev *adev, const char *name) { return 0; } static inline void avs_debugfs_init(struct avs_dev *adev) { } static inline void avs_debugfs_exit(struct avs_dev *adev) { } #endif /* Filesystems integration */ extern const struct attribute_group *avs_attr_groups[]; #endif /* __SOUND_SOC_INTEL_AVS_H */
Codebase Browser
linux