1 /* SPDX-License-Identifier: GPL-2.0-only */ 2 /* 3 * Copyright(c) 2021-2022 Intel Corporation 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 dsp_interrupt)(struct avs_dev *); 50 void (* const int_control)(struct avs_dev *, bool); 51 int (* const load_basefw)(struct avs_dev *, struct firmware *); 52 int (* const load_lib)(struct avs_dev *, struct firmware *, u32); 53 int (* const transfer_mods)(struct avs_dev *, bool, struct avs_module_entry *, u32); 54 int (* const config_basefw)(struct avs_dev *); 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 avs_skl_dsp_ops; 68 extern const struct avs_dsp_ops avs_apl_dsp_ops; 69 extern const struct avs_dsp_ops avs_cnl_dsp_ops; 70 extern const struct avs_dsp_ops avs_icl_dsp_ops; 71 extern const struct avs_dsp_ops avs_tgl_dsp_ops; 72 73 #define AVS_PLATATTR_CLDMA BIT_ULL(0) 74 #define AVS_PLATATTR_IMR BIT_ULL(1) 75 76 #define avs_platattr_test(adev, attr) \ 77 ((adev)->spec->attributes & AVS_PLATATTR_##attr) 78 79 struct avs_sram_spec { 80 const u32 base_offset; 81 const u32 window_size; 82 const u32 rom_status_offset; 83 }; 84 85 struct avs_hipc_spec { 86 const u32 req_offset; 87 const u32 req_ext_offset; 88 const u32 req_busy_mask; 89 const u32 ack_offset; 90 const u32 ack_done_mask; 91 const u32 rsp_offset; 92 const u32 rsp_busy_mask; 93 const u32 ctl_offset; 94 }; 95 96 /* Platform specific descriptor */ 97 struct avs_spec { 98 const char *name; 99 100 const struct avs_dsp_ops *const dsp_ops; 101 struct avs_fw_version min_fw_version; /* anything below is rejected */ 102 103 const u32 core_init_mask; /* used during DSP boot */ 104 const u64 attributes; /* bitmask of AVS_PLATATTR_* */ 105 const struct avs_sram_spec *sram; 106 const struct avs_hipc_spec *hipc; 107 }; 108 109 struct avs_fw_entry { 110 const char *name; 111 const struct firmware *fw; 112 113 struct list_head node; 114 }; 115 116 /* 117 * struct avs_dev - Intel HD-Audio driver data 118 * 119 * @dev: PCI device 120 * @dsp_ba: DSP bar address 121 * @spec: platform-specific descriptor 122 * @fw_cfg: Firmware configuration, obtained through FW_CONFIG message 123 * @hw_cfg: Hardware configuration, obtained through HW_CONFIG message 124 * @mods_info: Available module-types, obtained through MODULES_INFO message 125 * @mod_idas: Module instance ID pool, one per module-type 126 * @modres_mutex: For synchronizing any @mods_info updates 127 * @ppl_ida: Pipeline instance ID pool 128 * @fw_list: List of libraries loaded, including base firmware 129 */ 130 struct avs_dev { 131 struct hda_bus base; 132 struct device *dev; 133 134 void __iomem *dsp_ba; 135 const struct avs_spec *spec; 136 struct avs_ipc *ipc; 137 138 struct avs_fw_cfg fw_cfg; 139 struct avs_hw_cfg hw_cfg; 140 struct avs_mods_info *mods_info; 141 struct ida **mod_idas; 142 struct mutex modres_mutex; 143 void *modcfg_buf; /* module configuration buffer */ 144 struct ida ppl_ida; 145 struct list_head fw_list; 146 int *core_refs; /* reference count per core */ 147 char **lib_names; 148 int num_lp_paths; 149 atomic_t l1sen_counter; /* controls whether L1SEN should be disabled */ 150 151 struct completion fw_ready; 152 struct work_struct probe_work; 153 154 struct list_head comp_list; 155 struct mutex comp_list_mutex; 156 struct list_head path_list; 157 spinlock_t path_list_lock; 158 struct mutex path_mutex; 159 160 spinlock_t trace_lock; /* serialize debug window I/O between each LOG_BUFFER_STATUS */ 161 #ifdef CONFIG_DEBUG_FS 162 struct kfifo trace_fifo; 163 wait_queue_head_t trace_waitq; 164 u32 aging_timer_period; 165 u32 fifo_full_timer_period; 166 u32 logged_resources; /* context dependent: core or library */ 167 struct dentry *debugfs_root; 168 /* probes */ 169 struct hdac_ext_stream *extractor; 170 unsigned int num_probe_streams; 171 #endif 172 }; 173 174 /* from hda_bus to avs_dev */ 175 #define hda_to_avs(hda) container_of(hda, struct avs_dev, base) 176 /* from hdac_bus to avs_dev */ 177 #define hdac_to_avs(hdac) hda_to_avs(to_hda_bus(hdac)) 178 /* from device to avs_dev */ 179 #define to_avs_dev(dev) \ 180 ({ \ 181 struct hdac_bus *__bus = dev_get_drvdata(dev); \ 182 hdac_to_avs(__bus); \ 183 }) 184 185 int avs_dsp_core_power(struct avs_dev *adev, u32 core_mask, bool power); 186 int avs_dsp_core_reset(struct avs_dev *adev, u32 core_mask, bool reset); 187 int avs_dsp_core_stall(struct avs_dev *adev, u32 core_mask, bool stall); 188 int avs_dsp_core_enable(struct avs_dev *adev, u32 core_mask); 189 int avs_dsp_core_disable(struct avs_dev *adev, u32 core_mask); 190 191 /* Inter Process Communication */ 192 193 struct avs_ipc_msg { 194 union { 195 u64 header; 196 union avs_global_msg glb; 197 union avs_reply_msg rsp; 198 }; 199 void *data; 200 size_t size; 201 }; 202 203 /* 204 * struct avs_ipc - DSP IPC context 205 * 206 * @dev: PCI device 207 * @rx: Reply message cache 208 * @default_timeout_ms: default message timeout in MS 209 * @ready: whether firmware is ready and communication is open 210 * @rx_completed: whether RX for previously sent TX has been received 211 * @rx_lock: for serializing manipulation of rx_* fields 212 * @msg_lock: for synchronizing request handling 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 215 */ 216 struct avs_ipc { 217 struct device *dev; 218 219 struct avs_ipc_msg rx; 220 u32 default_timeout_ms; 221 bool ready; 222 atomic_t recovering; 223 224 bool rx_completed; 225 spinlock_t rx_lock; 226 struct mutex msg_mutex; 227 struct completion done_completion; 228 struct completion busy_completion; 229 230 struct work_struct recovery_work; 231 struct delayed_work d0ix_work; 232 atomic_t d0ix_disable_depth; 233 bool in_d0ix; 234 }; 235 236 #define AVS_EIPC EREMOTEIO 237 /* 238 * IPC handlers may return positive value (firmware error code) what denotes 239 * successful HOST <-> DSP communication yet failure to process specific request. 240 * 241 * Below macro converts returned value to linux kernel error code. 242 * All IPC callers MUST use it as soon as firmware error code is consumed. 243 */ 244 #define AVS_IPC_RET(ret) \ 245 (((ret) <= 0) ? (ret) : -AVS_EIPC) 246 247 void avs_dsp_process_response(struct avs_dev *adev, u64 header); 248 int avs_dsp_send_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, 249 struct avs_ipc_msg *reply, int timeout, const char *name); 250 int avs_dsp_send_msg(struct avs_dev *adev, struct avs_ipc_msg *request, 251 struct avs_ipc_msg *reply, const char *name); 252 /* Two variants below are for messages that control DSP power states. */ 253 int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, 254 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0, 255 const char *name); 256 int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request, 257 struct avs_ipc_msg *reply, bool wake_d0i0, const char *name); 258 int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, int timeout, 259 const char *name); 260 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request, const char *name); 261 void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable); 262 int avs_ipc_init(struct avs_ipc *ipc, struct device *dev); 263 void avs_ipc_block(struct avs_ipc *ipc); 264 265 int avs_dsp_disable_d0ix(struct avs_dev *adev); 266 int avs_dsp_enable_d0ix(struct avs_dev *adev); 267 268 void avs_skl_ipc_interrupt(struct avs_dev *adev); 269 irqreturn_t avs_cnl_dsp_interrupt(struct avs_dev *adev); 270 int avs_apl_enable_logs(struct avs_dev *adev, enum avs_log_enable enable, u32 aging_period, 271 u32 fifo_full_period, unsigned long resource_mask, u32 *priorities); 272 int avs_icl_enable_logs(struct avs_dev *adev, enum avs_log_enable enable, u32 aging_period, 273 u32 fifo_full_period, unsigned long resource_mask, u32 *priorities); 274 int avs_skl_log_buffer_offset(struct avs_dev *adev, u32 core); 275 int avs_icl_log_buffer_offset(struct avs_dev *adev, u32 core); 276 int avs_apl_log_buffer_status(struct avs_dev *adev, union avs_notify_msg *msg); 277 int avs_apl_coredump(struct avs_dev *adev, union avs_notify_msg *msg); 278 bool avs_apl_d0ix_toggle(struct avs_dev *adev, struct avs_ipc_msg *tx, bool wake); 279 bool avs_icl_d0ix_toggle(struct avs_dev *adev, struct avs_ipc_msg *tx, bool wake); 280 int avs_apl_set_d0ix(struct avs_dev *adev, bool enable); 281 int avs_icl_set_d0ix(struct avs_dev *adev, bool enable); 282 283 /* Firmware resources management */ 284 285 int avs_get_module_entry(struct avs_dev *adev, const guid_t *uuid, struct avs_module_entry *entry); 286 int avs_get_module_id_entry(struct avs_dev *adev, u32 module_id, struct avs_module_entry *entry); 287 int avs_get_module_id(struct avs_dev *adev, const guid_t *uuid); 288 bool avs_is_module_ida_empty(struct avs_dev *adev, u32 module_id); 289 290 int avs_module_info_init(struct avs_dev *adev, bool purge); 291 void avs_module_info_free(struct avs_dev *adev); 292 int avs_module_id_alloc(struct avs_dev *adev, u16 module_id); 293 void avs_module_id_free(struct avs_dev *adev, u16 module_id, u8 instance_id); 294 int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name); 295 void avs_release_last_firmware(struct avs_dev *adev); 296 void avs_release_firmwares(struct avs_dev *adev); 297 298 int avs_dsp_init_module(struct avs_dev *adev, u16 module_id, u8 ppl_instance_id, 299 u8 core_id, u8 domain, void *param, u32 param_size, 300 u8 *instance_id); 301 void avs_dsp_delete_module(struct avs_dev *adev, u16 module_id, u8 instance_id, 302 u8 ppl_instance_id, u8 core_id); 303 int avs_dsp_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority, 304 bool lp, u16 attributes, u8 *instance_id); 305 int avs_dsp_delete_pipeline(struct avs_dev *adev, u8 instance_id); 306 307 /* Firmware loading */ 308 309 void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable); 310 void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable); 311 void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable); 312 313 int avs_dsp_load_libraries(struct avs_dev *adev, struct avs_tplg_library *libs, u32 num_libs); 314 int avs_dsp_boot_firmware(struct avs_dev *adev, bool purge); 315 int avs_dsp_first_boot_firmware(struct avs_dev *adev); 316 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); 319 int avs_cldma_transfer_modules(struct avs_dev *adev, bool load, 320 struct avs_module_entry *mods, u32 num_mods); 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); 323 int avs_hda_transfer_modules(struct avs_dev *adev, bool load, 324 struct avs_module_entry *mods, u32 num_mods); 325 326 int avs_icl_load_basefw(struct avs_dev *adev, struct firmware *fw); 327 328 /* Soc component members */ 329 330 struct avs_soc_component { 331 struct snd_soc_component base; 332 struct avs_tplg *tplg; 333 334 struct list_head node; 335 }; 336 337 #define to_avs_soc_component(comp) \ 338 container_of(comp, struct avs_soc_component, base) 339 340 extern const struct snd_soc_dai_ops avs_dai_fe_ops; 341 342 int avs_soc_component_register(struct device *dev, const char *name, 343 const struct snd_soc_component_driver *drv, 344 struct snd_soc_dai_driver *cpu_dais, int num_cpu_dais); 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, 347 unsigned long *tdms); 348 int avs_hda_platform_register(struct avs_dev *adev, const char *name); 349 350 int avs_register_all_boards(struct avs_dev *adev); 351 void avs_unregister_all_boards(struct avs_dev *adev); 352 353 /* Firmware tracing helpers */ 354 355 #define avs_log_buffer_size(adev) \ 356 ((adev)->fw_cfg.trace_log_bytes / (adev)->hw_cfg.dsp_cores) 357 358 #define avs_log_buffer_addr(adev, core) \ 359 ({ \ 360 s32 __offset = avs_dsp_op(adev, log_buffer_offset, core); \ 361 (__offset < 0) ? NULL : \ 362 (avs_sram_addr(adev, AVS_DEBUG_WINDOW) + __offset); \ 363 }) 364 365 static inline int avs_log_buffer_status_locked(struct avs_dev *adev, union avs_notify_msg *msg) 366 { 367 unsigned long flags; 368 int ret; 369 370 spin_lock_irqsave(&adev->trace_lock, flags); 371 ret = avs_dsp_op(adev, log_buffer_status, msg); 372 spin_unlock_irqrestore(&adev->trace_lock, flags); 373 374 return ret; 375 } 376 377 struct avs_apl_log_buffer_layout { 378 u32 read_ptr; 379 u32 write_ptr; 380 u8 buffer[]; 381 } __packed; 382 static_assert(sizeof(struct avs_apl_log_buffer_layout) == 8); 383 384 #define avs_apl_log_payload_size(adev) \ 385 (avs_log_buffer_size(adev) - sizeof(struct avs_apl_log_buffer_layout)) 386 387 #define avs_apl_log_payload_addr(addr) \ 388 (addr + sizeof(struct avs_apl_log_buffer_layout)) 389 390 #ifdef CONFIG_DEBUG_FS 391 #define AVS_SET_ENABLE_LOGS_OP(name) \ 392 .enable_logs = avs_##name##_enable_logs 393 394 bool avs_logging_fw(struct avs_dev *adev); 395 void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len); 396 void avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len); 397 398 int avs_probe_platform_register(struct avs_dev *adev, const char *name); 399 400 void avs_debugfs_init(struct avs_dev *adev); 401 void avs_debugfs_exit(struct avs_dev *adev); 402 #else 403 #define AVS_SET_ENABLE_LOGS_OP(name) 404 405 static inline bool avs_logging_fw(struct avs_dev *adev) 406 { 407 return false; 408 } 409 410 static inline void avs_dump_fw_log(struct avs_dev *adev, const void __iomem *src, unsigned int len) 411 { 412 } 413 414 static inline void 415 avs_dump_fw_log_wakeup(struct avs_dev *adev, const void __iomem *src, unsigned int len) 416 { 417 } 418 419 static inline int avs_probe_platform_register(struct avs_dev *adev, const char *name) 420 { 421 return 0; 422 } 423 424 static inline void avs_debugfs_init(struct avs_dev *adev) { } 425 static inline void avs_debugfs_exit(struct avs_dev *adev) { } 426 #endif 427 428 /* Filesystems integration */ 429 430 extern const struct attribute_group *avs_attr_groups[]; 431 432 #endif /* __SOUND_SOC_INTEL_AVS_H */ 433