1 /* SPDX-License-Identifier: GPL-2.0-only */
3 * Copyright(c) 2021-2022 Intel Corporation. All rights reserved.
5 * Authors: Cezary Rojewski <cezary.rojewski@intel.com>
6 * Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
9 #ifndef __SOUND_SOC_INTEL_AVS_H
10 #define __SOUND_SOC_INTEL_AVS_H
12 #include <linux/debugfs.h>
13 #include <linux/device.h>
14 #include <linux/firmware.h>
15 #include <linux/kfifo.h>
16 #include <sound/hda_codec.h>
17 #include <sound/hda_register.h>
18 #include <sound/soc-component.h>
20 #include "registers.h"
24 struct avs_tplg_library;
25 struct avs_soc_component;
29 #define AVS_S0IX_SUPPORTED \
30 (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0)
32 #define AVS_S0IX_SUPPORTED false
36 * struct avs_dsp_ops - Platform-specific DSP operations
38 * @power: Power on or off DSP cores
39 * @reset: Enter or exit reset state on DSP cores
40 * @stall: Stall or run DSP cores
41 * @irq_handler: Top half of IPC servicing
42 * @irq_thread: Bottom half of IPC servicing
43 * @int_control: Enable or disable IPC interrupts
46 int (* const power)(struct avs_dev *, u32, bool);
47 int (* const reset)(struct avs_dev *, u32, bool);
48 int (* const stall)(struct avs_dev *, u32, bool);
49 irqreturn_t (* const irq_handler)(int, void *);
50 irqreturn_t (* const irq_thread)(int, void *);
51 void (* const int_control)(struct avs_dev *, bool);
52 int (* const load_basefw)(struct avs_dev *, struct firmware *);
53 int (* const load_lib)(struct avs_dev *, struct firmware *, u32);
54 int (* const transfer_mods)(struct avs_dev *, bool, struct avs_module_entry *, u32);
55 int (* const enable_logs)(struct avs_dev *, enum avs_log_enable, u32, u32, unsigned long,
57 int (* const log_buffer_offset)(struct avs_dev *, u32);
58 int (* const log_buffer_status)(struct avs_dev *, union avs_notify_msg *);
59 int (* const coredump)(struct avs_dev *, union avs_notify_msg *);
60 bool (* const d0ix_toggle)(struct avs_dev *, struct avs_ipc_msg *, bool);
61 int (* const set_d0ix)(struct avs_dev *, bool);
64 #define avs_dsp_op(adev, op, ...) \
65 ((adev)->spec->dsp_ops->op(adev, ## __VA_ARGS__))
67 extern const struct avs_dsp_ops skl_dsp_ops;
68 extern const struct avs_dsp_ops apl_dsp_ops;
70 #define AVS_PLATATTR_CLDMA BIT_ULL(0)
71 #define AVS_PLATATTR_IMR BIT_ULL(1)
73 #define avs_platattr_test(adev, attr) \
74 ((adev)->spec->attributes & AVS_PLATATTR_##attr)
76 /* Platform specific descriptor */
80 const struct avs_dsp_ops *const dsp_ops;
81 struct avs_fw_version min_fw_version; /* anything below is rejected */
83 const u32 core_init_mask; /* used during DSP boot */
84 const u64 attributes; /* bitmask of AVS_PLATATTR_* */
85 const u32 sram_base_offset;
86 const u32 sram_window_size;
92 const struct firmware *fw;
94 struct list_head node;
98 * struct avs_dev - Intel HD-Audio driver data
101 * @dsp_ba: DSP bar address
102 * @spec: platform-specific descriptor
103 * @fw_cfg: Firmware configuration, obtained through FW_CONFIG message
104 * @hw_cfg: Hardware configuration, obtained through HW_CONFIG message
105 * @mods_info: Available module-types, obtained through MODULES_INFO message
106 * @mod_idas: Module instance ID pool, one per module-type
107 * @modres_mutex: For synchronizing any @mods_info updates
108 * @ppl_ida: Pipeline instance ID pool
109 * @fw_list: List of libraries loaded, including base firmware
115 void __iomem *dsp_ba;
116 const struct avs_spec *spec;
119 struct avs_fw_cfg fw_cfg;
120 struct avs_hw_cfg hw_cfg;
121 struct avs_mods_info *mods_info;
122 struct ida **mod_idas;
123 struct mutex modres_mutex;
124 void *modcfg_buf; /* module configuration buffer */
126 struct list_head fw_list;
127 int *core_refs; /* reference count per core */
130 atomic_t l1sen_counter; /* controls whether L1SEN should be disabled */
132 struct completion fw_ready;
133 struct work_struct probe_work;
135 struct nhlt_acpi_table *nhlt;
136 struct list_head comp_list;
137 struct mutex comp_list_mutex;
138 struct list_head path_list;
139 spinlock_t path_list_lock;
140 struct mutex path_mutex;
142 spinlock_t trace_lock; /* serialize debug window I/O between each LOG_BUFFER_STATUS */
143 #ifdef CONFIG_DEBUG_FS
144 struct kfifo trace_fifo;
145 wait_queue_head_t trace_waitq;
146 u32 aging_timer_period;
147 u32 fifo_full_timer_period;
148 u32 logged_resources; /* context dependent: core or library */
149 struct dentry *debugfs_root;
151 struct hdac_ext_stream *extractor;
152 unsigned int num_probe_streams;
156 /* from hda_bus to avs_dev */
157 #define hda_to_avs(hda) container_of(hda, struct avs_dev, base)
158 /* from hdac_bus to avs_dev */
159 #define hdac_to_avs(hdac) hda_to_avs(to_hda_bus(hdac))
160 /* from device to avs_dev */
161 #define to_avs_dev(dev) \
163 struct hdac_bus *__bus = dev_get_drvdata(dev); \
164 hdac_to_avs(__bus); \
167 int avs_dsp_core_power(struct avs_dev *adev, u32 core_mask, bool power);
168 int avs_dsp_core_reset(struct avs_dev *adev, u32 core_mask, bool reset);
169 int avs_dsp_core_stall(struct avs_dev *adev, u32 core_mask, bool stall);
170 int avs_dsp_core_enable(struct avs_dev *adev, u32 core_mask);
171 int avs_dsp_core_disable(struct avs_dev *adev, u32 core_mask);
173 /* Inter Process Communication */
178 union avs_global_msg glb;
179 union avs_reply_msg rsp;
186 * struct avs_ipc - DSP IPC context
189 * @rx: Reply message cache
190 * @default_timeout_ms: default message timeout in MS
191 * @ready: whether firmware is ready and communication is open
192 * @rx_completed: whether RX for previously sent TX has been received
193 * @rx_lock: for serializing manipulation of rx_* fields
194 * @msg_lock: for synchronizing request handling
195 * @done_completion: DONE-part of IPC i.e. ROM and ACKs from FW
196 * @busy_completion: BUSY-part of IPC i.e. receiving responses from FW
201 struct avs_ipc_msg rx;
202 u32 default_timeout_ms;
208 struct mutex msg_mutex;
209 struct completion done_completion;
210 struct completion busy_completion;
212 struct work_struct recovery_work;
213 struct delayed_work d0ix_work;
214 atomic_t d0ix_disable_depth;
218 #define AVS_EIPC EREMOTEIO
220 * IPC handlers may return positive value (firmware error code) what denotes
221 * successful HOST <-> DSP communication yet failure to process specific request.
223 * Below macro converts returned value to linux kernel error code.
224 * All IPC callers MUST use it as soon as firmware error code is consumed.
226 #define AVS_IPC_RET(ret) \
227 (((ret) <= 0) ? (ret) : -AVS_EIPC)
229 irqreturn_t avs_dsp_irq_handler(int irq, void *dev_id);
230 irqreturn_t avs_dsp_irq_thread(int irq, void *dev_id);
231 void avs_dsp_process_response(struct avs_dev *adev, u64 header);
232 int avs_dsp_send_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request,
233 struct avs_ipc_msg *reply, int timeout, const char *name);
234 int avs_dsp_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request,
235 struct avs_ipc_msg *reply, const char *name);
236 /* Two variants below are for messages that control DSP power states. */
237 int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request,
238 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0,
240 int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request,
241 struct avs_ipc_msg *reply, bool wake_d0i0, const char *name);
242 int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout,
244 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, const char *name);
245 void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable);
246 int avs_ipc_init(struct avs_ipc *ipc, struct device *dev);
247 void avs_ipc_block(struct avs_ipc *ipc);
249 int avs_dsp_disable_d0ix(struct avs_dev *adev);
250 int avs_dsp_enable_d0ix(struct avs_dev *adev);
252 int skl_log_buffer_offset(struct avs_dev *adev, u32 core);
254 /* Firmware resources management */
256 int avs_get_module_entry(struct avs_dev *adev, const guid_t *uuid, struct avs_module_entry *entry);
257 int avs_get_module_id_entry(struct avs_dev *adev, u32 module_id, struct avs_module_entry *entry);
258 int avs_get_module_id(struct avs_dev *adev, const guid_t *uuid);
259 bool avs_is_module_ida_empty(struct avs_dev *adev, u32 module_id);
261 int avs_module_info_init(struct avs_dev *adev, bool purge);
262 void avs_module_info_free(struct avs_dev *adev);
263 int avs_module_id_alloc(struct avs_dev *adev, u16 module_id);
264 void avs_module_id_free(struct avs_dev *adev, u16 module_id, u8 instance_id);
265 int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name);
266 void avs_release_last_firmware(struct avs_dev *adev);
267 void avs_release_firmwares(struct avs_dev *adev);
269 int avs_dsp_init_module(struct avs_dev *adev, u16 module_id, u8 ppl_instance_id,
270 u8 core_id, u8 domain, void *param, u32 param_size,
272 void avs_dsp_delete_module(struct avs_dev *adev, u16 module_id, u8 instance_id,
273 u8 ppl_instance_id, u8 core_id);
274 int avs_dsp_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority,
275 bool lp, u16 attributes, u8 *instance_id);
276 int avs_dsp_delete_pipeline(struct avs_dev *adev, u8 instance_id);
278 /* Firmware loading */
280 void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable);
281 void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable);
282 void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable);
284 int avs_dsp_load_libraries(struct avs_dev *adev, struct avs_tplg_library *libs, u32 num_libs);
285 int avs_dsp_boot_firmware(struct avs_dev *adev, bool purge);
286 int avs_dsp_first_boot_firmware(struct avs_dev *adev);
288 int avs_cldma_load_basefw(struct avs_dev *adev, struct firmware *fw);
289 int avs_cldma_load_library(struct avs_dev *adev, struct firmware *lib, u32 id);
290 int avs_cldma_transfer_modules(struct avs_dev *adev, bool load,
291 struct avs_module_entry *mods, u32 num_mods);
292 int avs_hda_load_basefw(struct avs_dev *adev, struct firmware *fw);
293 int avs_hda_load_library(struct avs_dev *adev, struct firmware *lib, u32 id);
294 int avs_hda_transfer_modules(struct avs_dev *adev, bool load,
295 struct avs_module_entry *mods, u32 num_mods);
297 /* Soc component members */
299 struct avs_soc_component {
300 struct snd_soc_component base;
301 struct avs_tplg *tplg;
303 struct list_head node;
306 #define to_avs_soc_component(comp) \
307 container_of(comp, struct avs_soc_component, base)
309 extern const struct snd_soc_dai_ops avs_dai_fe_ops;
311 int avs_soc_component_register(struct device *dev, const char *name,
312 const struct snd_soc_component_driver *drv,
313 struct snd_soc_dai_driver *cpu_dais, int num_cpu_dais);
314 int avs_dmic_platform_register(struct avs_dev *adev, const char *name);
315 int avs_i2s_platform_register(struct avs_dev *adev, const char *name, unsigned long port_mask,
316 unsigned long *tdms);
317 int avs_hda_platform_register(struct avs_dev *adev, const char *name);
319 int avs_register_all_boards(struct avs_dev *adev);
320 void avs_unregister_all_boards(struct avs_dev *adev);
322 /* Firmware tracing helpers */
324 #define avs_log_buffer_size(adev) \
325 ((adev)->fw_cfg.trace_log_bytes / (adev)->hw_cfg.dsp_cores)
327 #define avs_log_buffer_addr(adev, core) \
329 s32 __offset = avs_dsp_op(adev, log_buffer_offset, core); \
330 (__offset < 0) ? NULL : \
331 (avs_sram_addr(adev, AVS_DEBUG_WINDOW) + __offset); \
334 static inline int avs_log_buffer_status_locked(struct avs_dev *adev, union avs_notify_msg *msg)
339 spin_lock_irqsave(&adev->trace_lock, flags);
340 ret = avs_dsp_op(adev, log_buffer_status, msg);
341 spin_unlock_irqrestore(&adev->trace_lock, flags);
346 struct apl_log_buffer_layout {
352 #define apl_log_payload_size(adev) \
353 (avs_log_buffer_size(adev) - sizeof(struct apl_log_buffer_layout))
355 #define apl_log_payload_addr(addr) \
356 (addr + sizeof(struct apl_log_buffer_layout))
358 #ifdef CONFIG_DEBUG_FS
359 #define AVS_SET_ENABLE_LOGS_OP(name) \
360 .enable_logs = name##_enable_logs
362 bool avs_logging_fw(struct avs_dev *adev);
363 void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len);
364 void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len);
366 int avs_probe_platform_register(struct avs_dev *adev, const char *name);
368 void avs_debugfs_init(struct avs_dev *adev);
369 void avs_debugfs_exit(struct avs_dev *adev);
371 #define AVS_SET_ENABLE_LOGS_OP(name)
373 static inline bool avs_logging_fw(struct avs_dev *adev)
378 static inline void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len)
383 avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len)
387 static inline int avs_probe_platform_register(struct avs_dev *adev, const char *name)
392 static inline void avs_debugfs_init(struct avs_dev *adev) { }
393 static inline void avs_debugfs_exit(struct avs_dev *adev) { }
396 #endif /* __SOUND_SOC_INTEL_AVS_H */