1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright(c) 2021-2022 Intel Corporation. All rights reserved. 4 * 5 * Authors: Cezary Rojewski <cezary.rojewski@intel.com> 6 * Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com> 7 */ 8 9 #ifndef __SOUND_SOC_INTEL_AVS_H 10 #define __SOUND_SOC_INTEL_AVS_H 11 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> 19 #include "messages.h" 20 #include "registers.h" 21 22 struct avs_dev; 23 struct avs_tplg; 24 struct avs_tplg_library; 25 struct avs_soc_component; 26 struct avs_ipc_msg; 27 28 #ifdef CONFIG_ACPI 29 #define AVS_S0IX_SUPPORTED \ 30 (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0) 31 #else 32 #define AVS_S0IX_SUPPORTED false 33 #endif 34 35 /* 36 * struct avs_dsp_ops - Platform-specific DSP operations 37 * 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 44 */ 45 struct avs_dsp_ops { 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, 56 u32 *); 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); 62 }; 63 64 #define avs_dsp_op(adev, op, ...) \ 65 ((adev)->spec->dsp_ops->op(adev, ## __VA_ARGS__)) 66 67 extern const struct avs_dsp_ops skl_dsp_ops; 68 extern const struct avs_dsp_ops apl_dsp_ops; 69 70 #define AVS_PLATATTR_CLDMA BIT_ULL(0) 71 #define AVS_PLATATTR_IMR BIT_ULL(1) 72 73 #define avs_platattr_test(adev, attr) \ 74 ((adev)->spec->attributes & AVS_PLATATTR_##attr) 75 76 /* Platform specific descriptor */ 77 struct avs_spec { 78 const char *name; 79 80 const struct avs_dsp_ops *const dsp_ops; 81 struct avs_fw_version min_fw_version; /* anything below is rejected */ 82 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; 87 const u32 rom_status; 88 }; 89 90 struct avs_fw_entry { 91 char *name; 92 const struct firmware *fw; 93 94 struct list_head node; 95 }; 96 97 /* 98 * struct avs_dev - Intel HD-Audio driver data 99 * 100 * @dev: PCI device 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 110 */ 111 struct avs_dev { 112 struct hda_bus base; 113 struct device *dev; 114 115 void __iomem *dsp_ba; 116 const struct avs_spec *spec; 117 struct avs_ipc *ipc; 118 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 */ 125 struct ida ppl_ida; 126 struct list_head fw_list; 127 int *core_refs; /* reference count per core */ 128 char **lib_names; 129 int num_lp_paths; 130 131 struct completion fw_ready; 132 struct work_struct probe_work; 133 134 struct nhlt_acpi_table *nhlt; 135 struct list_head comp_list; 136 struct mutex comp_list_mutex; 137 struct list_head path_list; 138 spinlock_t path_list_lock; 139 struct mutex path_mutex; 140 141 spinlock_t trace_lock; /* serialize debug window I/O between each LOG_BUFFER_STATUS */ 142 #ifdef CONFIG_DEBUG_FS 143 struct kfifo trace_fifo; 144 wait_queue_head_t trace_waitq; 145 u32 aging_timer_period; 146 u32 fifo_full_timer_period; 147 u32 logged_resources; /* context dependent: core or library */ 148 struct dentry *debugfs_root; 149 /* probes */ 150 struct hdac_ext_stream *extractor; 151 unsigned int num_probe_streams; 152 #endif 153 }; 154 155 /* from hda_bus to avs_dev */ 156 #define hda_to_avs(hda) container_of(hda, struct avs_dev, base) 157 /* from hdac_bus to avs_dev */ 158 #define hdac_to_avs(hdac) hda_to_avs(to_hda_bus(hdac)) 159 /* from device to avs_dev */ 160 #define to_avs_dev(dev) \ 161 ({ \ 162 struct hdac_bus *__bus = dev_get_drvdata(dev); \ 163 hdac_to_avs(__bus); \ 164 }) 165 166 int avs_dsp_core_power(struct avs_dev *adev, u32 core_mask, bool power); 167 int avs_dsp_core_reset(struct avs_dev *adev, u32 core_mask, bool reset); 168 int avs_dsp_core_stall(struct avs_dev *adev, u32 core_mask, bool stall); 169 int avs_dsp_core_enable(struct avs_dev *adev, u32 core_mask); 170 int avs_dsp_core_disable(struct avs_dev *adev, u32 core_mask); 171 172 /* Inter Process Communication */ 173 174 struct avs_ipc_msg { 175 union { 176 u64 header; 177 union avs_global_msg glb; 178 union avs_reply_msg rsp; 179 }; 180 void *data; 181 size_t size; 182 }; 183 184 /* 185 * struct avs_ipc - DSP IPC context 186 * 187 * @dev: PCI device 188 * @rx: Reply message cache 189 * @default_timeout_ms: default message timeout in MS 190 * @ready: whether firmware is ready and communication is open 191 * @rx_completed: whether RX for previously sent TX has been received 192 * @rx_lock: for serializing manipulation of rx_* fields 193 * @msg_lock: for synchronizing request handling 194 * @done_completion: DONE-part of IPC i.e. ROM and ACKs from FW 195 * @busy_completion: BUSY-part of IPC i.e. receiving responses from FW 196 */ 197 struct avs_ipc { 198 struct device *dev; 199 200 struct avs_ipc_msg rx; 201 u32 default_timeout_ms; 202 bool ready; 203 atomic_t recovering; 204 205 bool rx_completed; 206 spinlock_t rx_lock; 207 struct mutex msg_mutex; 208 struct completion done_completion; 209 struct completion busy_completion; 210 211 struct work_struct recovery_work; 212 struct delayed_work d0ix_work; 213 atomic_t d0ix_disable_depth; 214 bool in_d0ix; 215 }; 216 217 #define AVS_EIPC EREMOTEIO 218 /* 219 * IPC handlers may return positive value (firmware error code) what denotes 220 * successful HOST <-> DSP communication yet failure to process specific request. 221 * 222 * Below macro converts returned value to linux kernel error code. 223 * All IPC callers MUST use it as soon as firmware error code is consumed. 224 */ 225 #define AVS_IPC_RET(ret) \ 226 (((ret) <= 0) ? (ret) : -AVS_EIPC) 227 228 irqreturn_t avs_dsp_irq_handler(int irq, void *dev_id); 229 irqreturn_t avs_dsp_irq_thread(int irq, void *dev_id); 230 void avs_dsp_process_response(struct avs_dev *adev, u64 header); 231 int avs_dsp_send_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, 232 struct avs_ipc_msg *reply, int timeout, const char *name); 233 int avs_dsp_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request, 234 struct avs_ipc_msg *reply, const char *name); 235 /* Two variants below are for messages that control DSP power states. */ 236 int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, 237 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0, 238 const char *name); 239 int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request, 240 struct avs_ipc_msg *reply, bool wake_d0i0, const char *name); 241 int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout, 242 const char *name); 243 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, const char *name); 244 void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable); 245 int avs_ipc_init(struct avs_ipc *ipc, struct device *dev); 246 void avs_ipc_block(struct avs_ipc *ipc); 247 248 int avs_dsp_disable_d0ix(struct avs_dev *adev); 249 int avs_dsp_enable_d0ix(struct avs_dev *adev); 250 251 int skl_log_buffer_offset(struct avs_dev *adev, u32 core); 252 253 /* Firmware resources management */ 254 255 int avs_get_module_entry(struct avs_dev *adev, const guid_t *uuid, struct avs_module_entry *entry); 256 int avs_get_module_id_entry(struct avs_dev *adev, u32 module_id, struct avs_module_entry *entry); 257 int avs_get_module_id(struct avs_dev *adev, const guid_t *uuid); 258 bool avs_is_module_ida_empty(struct avs_dev *adev, u32 module_id); 259 260 int avs_module_info_init(struct avs_dev *adev, bool purge); 261 void avs_module_info_free(struct avs_dev *adev); 262 int avs_module_id_alloc(struct avs_dev *adev, u16 module_id); 263 void avs_module_id_free(struct avs_dev *adev, u16 module_id, u8 instance_id); 264 int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name); 265 void avs_release_last_firmware(struct avs_dev *adev); 266 void avs_release_firmwares(struct avs_dev *adev); 267 268 int avs_dsp_init_module(struct avs_dev *adev, u16 module_id, u8 ppl_instance_id, 269 u8 core_id, u8 domain, void *param, u32 param_size, 270 u8 *instance_id); 271 void avs_dsp_delete_module(struct avs_dev *adev, u16 module_id, u8 instance_id, 272 u8 ppl_instance_id, u8 core_id); 273 int avs_dsp_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority, 274 bool lp, u16 attributes, u8 *instance_id); 275 int avs_dsp_delete_pipeline(struct avs_dev *adev, u8 instance_id); 276 277 /* Firmware loading */ 278 279 void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable); 280 void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable); 281 void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable); 282 283 int avs_dsp_load_libraries(struct avs_dev *adev, struct avs_tplg_library *libs, u32 num_libs); 284 int avs_dsp_boot_firmware(struct avs_dev *adev, bool purge); 285 int avs_dsp_first_boot_firmware(struct avs_dev *adev); 286 287 int avs_cldma_load_basefw(struct avs_dev *adev, struct firmware *fw); 288 int avs_cldma_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); 289 int avs_cldma_transfer_modules(struct avs_dev *adev, bool load, 290 struct avs_module_entry *mods, u32 num_mods); 291 int avs_hda_load_basefw(struct avs_dev *adev, struct firmware *fw); 292 int avs_hda_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); 293 int avs_hda_transfer_modules(struct avs_dev *adev, bool load, 294 struct avs_module_entry *mods, u32 num_mods); 295 296 /* Soc component members */ 297 298 struct avs_soc_component { 299 struct snd_soc_component base; 300 struct avs_tplg *tplg; 301 302 struct list_head node; 303 }; 304 305 #define to_avs_soc_component(comp) \ 306 container_of(comp, struct avs_soc_component, base) 307 308 extern const struct snd_soc_dai_ops avs_dai_fe_ops; 309 310 int avs_soc_component_register(struct device *dev, const char *name, 311 const struct snd_soc_component_driver *drv, 312 struct snd_soc_dai_driver *cpu_dais, int num_cpu_dais); 313 int avs_dmic_platform_register(struct avs_dev *adev, const char *name); 314 int avs_i2s_platform_register(struct avs_dev *adev, const char *name, unsigned long port_mask, 315 unsigned long *tdms); 316 int avs_hda_platform_register(struct avs_dev *adev, const char *name); 317 318 int avs_register_all_boards(struct avs_dev *adev); 319 void avs_unregister_all_boards(struct avs_dev *adev); 320 321 /* Firmware tracing helpers */ 322 323 #define avs_log_buffer_size(adev) \ 324 ((adev)->fw_cfg.trace_log_bytes / (adev)->hw_cfg.dsp_cores) 325 326 #define avs_log_buffer_addr(adev, core) \ 327 ({ \ 328 s32 __offset = avs_dsp_op(adev, log_buffer_offset, core); \ 329 (__offset < 0) ? NULL : \ 330 (avs_sram_addr(adev, AVS_DEBUG_WINDOW) + __offset); \ 331 }) 332 333 static inline int avs_log_buffer_status_locked(struct avs_dev *adev, union avs_notify_msg *msg) 334 { 335 unsigned long flags; 336 int ret; 337 338 spin_lock_irqsave(&adev->trace_lock, flags); 339 ret = avs_dsp_op(adev, log_buffer_status, msg); 340 spin_unlock_irqrestore(&adev->trace_lock, flags); 341 342 return ret; 343 } 344 345 struct apl_log_buffer_layout { 346 u32 read_ptr; 347 u32 write_ptr; 348 u8 buffer[]; 349 } __packed; 350 351 #define apl_log_payload_size(adev) \ 352 (avs_log_buffer_size(adev) - sizeof(struct apl_log_buffer_layout)) 353 354 #define apl_log_payload_addr(addr) \ 355 (addr + sizeof(struct apl_log_buffer_layout)) 356 357 #ifdef CONFIG_DEBUG_FS 358 #define AVS_SET_ENABLE_LOGS_OP(name) \ 359 .enable_logs = name##_enable_logs 360 361 bool avs_logging_fw(struct avs_dev *adev); 362 void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len); 363 void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len); 364 365 int avs_probe_platform_register(struct avs_dev *adev, const char *name); 366 367 void avs_debugfs_init(struct avs_dev *adev); 368 void avs_debugfs_exit(struct avs_dev *adev); 369 #else 370 #define AVS_SET_ENABLE_LOGS_OP(name) 371 372 static inline bool avs_logging_fw(struct avs_dev *adev) 373 { 374 return false; 375 } 376 377 static inline void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len) 378 { 379 } 380 381 static inline void 382 avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len) 383 { 384 } 385 386 static inline int avs_probe_platform_register(struct avs_dev *adev, const char *name) 387 { 388 return 0; 389 } 390 391 static inline void avs_debugfs_init(struct avs_dev *adev) { } 392 static inline void avs_debugfs_exit(struct avs_dev *adev) { } 393 #endif 394 395 #endif /* __SOUND_SOC_INTEL_AVS_H */ 396