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/device.h> 13 #include <linux/firmware.h> 14 #include <linux/kfifo.h> 15 #include <sound/hda_codec.h> 16 #include <sound/hda_register.h> 17 #include <sound/soc-component.h> 18 #include "messages.h" 19 #include "registers.h" 20 21 struct avs_dev; 22 struct avs_tplg; 23 struct avs_tplg_library; 24 struct avs_soc_component; 25 struct avs_ipc_msg; 26 27 #ifdef CONFIG_ACPI 28 #define AVS_S0IX_SUPPORTED \ 29 (acpi_gbl_FADT.flags & ACPI_FADT_LOW_POWER_S0) 30 #else 31 #define AVS_S0IX_SUPPORTED false 32 #endif 33 34 /* 35 * struct avs_dsp_ops - Platform-specific DSP operations 36 * 37 * @power: Power on or off DSP cores 38 * @reset: Enter or exit reset state on DSP cores 39 * @stall: Stall or run DSP cores 40 * @irq_handler: Top half of IPC servicing 41 * @irq_thread: Bottom half of IPC servicing 42 * @int_control: Enable or disable IPC interrupts 43 */ 44 struct avs_dsp_ops { 45 int (* const power)(struct avs_dev *, u32, bool); 46 int (* const reset)(struct avs_dev *, u32, bool); 47 int (* const stall)(struct avs_dev *, u32, bool); 48 irqreturn_t (* const irq_handler)(int, void *); 49 irqreturn_t (* const irq_thread)(int, void *); 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 enable_logs)(struct avs_dev *, enum avs_log_enable, u32, u32, unsigned long, 55 u32 *); 56 int (* const log_buffer_offset)(struct avs_dev *, u32); 57 int (* const log_buffer_status)(struct avs_dev *, union avs_notify_msg *); 58 int (* const coredump)(struct avs_dev *, union avs_notify_msg *); 59 bool (* const d0ix_toggle)(struct avs_dev *, struct avs_ipc_msg *, bool); 60 int (* const set_d0ix)(struct avs_dev *, bool); 61 }; 62 63 #define avs_dsp_op(adev, op, ...) \ 64 ((adev)->spec->dsp_ops->op(adev, ## __VA_ARGS__)) 65 66 extern const struct avs_dsp_ops skl_dsp_ops; 67 extern const struct avs_dsp_ops apl_dsp_ops; 68 69 #define AVS_PLATATTR_CLDMA BIT_ULL(0) 70 #define AVS_PLATATTR_IMR BIT_ULL(1) 71 72 #define avs_platattr_test(adev, attr) \ 73 ((adev)->spec->attributes & AVS_PLATATTR_##attr) 74 75 /* Platform specific descriptor */ 76 struct avs_spec { 77 const char *name; 78 79 const struct avs_dsp_ops *const dsp_ops; 80 struct avs_fw_version min_fw_version; /* anything below is rejected */ 81 82 const u32 core_init_mask; /* used during DSP boot */ 83 const u64 attributes; /* bitmask of AVS_PLATATTR_* */ 84 const u32 sram_base_offset; 85 const u32 sram_window_size; 86 const u32 rom_status; 87 }; 88 89 struct avs_fw_entry { 90 char *name; 91 const struct firmware *fw; 92 93 struct list_head node; 94 }; 95 96 struct avs_debug { 97 struct kfifo trace_fifo; 98 spinlock_t fifo_lock; /* serialize I/O for trace_fifo */ 99 spinlock_t trace_lock; /* serialize debug window I/O between each LOG_BUFFER_STATUS */ 100 wait_queue_head_t trace_waitq; 101 u32 aging_timer_period; 102 u32 fifo_full_timer_period; 103 u32 logged_resources; /* context dependent: core or library */ 104 }; 105 106 /* 107 * struct avs_dev - Intel HD-Audio driver data 108 * 109 * @dev: PCI device 110 * @dsp_ba: DSP bar address 111 * @spec: platform-specific descriptor 112 * @fw_cfg: Firmware configuration, obtained through FW_CONFIG message 113 * @hw_cfg: Hardware configuration, obtained through HW_CONFIG message 114 * @mods_info: Available module-types, obtained through MODULES_INFO message 115 * @mod_idas: Module instance ID pool, one per module-type 116 * @modres_mutex: For synchronizing any @mods_info updates 117 * @ppl_ida: Pipeline instance ID pool 118 * @fw_list: List of libraries loaded, including base firmware 119 */ 120 struct avs_dev { 121 struct hda_bus base; 122 struct device *dev; 123 124 void __iomem *dsp_ba; 125 const struct avs_spec *spec; 126 struct avs_ipc *ipc; 127 128 struct avs_fw_cfg fw_cfg; 129 struct avs_hw_cfg hw_cfg; 130 struct avs_mods_info *mods_info; 131 struct ida **mod_idas; 132 struct mutex modres_mutex; 133 struct ida ppl_ida; 134 struct list_head fw_list; 135 int *core_refs; /* reference count per core */ 136 char **lib_names; 137 int num_lp_paths; 138 139 struct completion fw_ready; 140 struct work_struct probe_work; 141 142 struct nhlt_acpi_table *nhlt; 143 struct list_head comp_list; 144 struct mutex comp_list_mutex; 145 struct list_head path_list; 146 spinlock_t path_list_lock; 147 struct mutex path_mutex; 148 149 struct avs_debug dbg; 150 }; 151 152 /* from hda_bus to avs_dev */ 153 #define hda_to_avs(hda) container_of(hda, struct avs_dev, base) 154 /* from hdac_bus to avs_dev */ 155 #define hdac_to_avs(hdac) hda_to_avs(to_hda_bus(hdac)) 156 /* from device to avs_dev */ 157 #define to_avs_dev(dev) \ 158 ({ \ 159 struct hdac_bus *__bus = dev_get_drvdata(dev); \ 160 hdac_to_avs(__bus); \ 161 }) 162 163 int avs_dsp_core_power(struct avs_dev *adev, u32 core_mask, bool power); 164 int avs_dsp_core_reset(struct avs_dev *adev, u32 core_mask, bool reset); 165 int avs_dsp_core_stall(struct avs_dev *adev, u32 core_mask, bool stall); 166 int avs_dsp_core_enable(struct avs_dev *adev, u32 core_mask); 167 int avs_dsp_core_disable(struct avs_dev *adev, u32 core_mask); 168 169 /* Inter Process Communication */ 170 171 struct avs_ipc_msg { 172 union { 173 u64 header; 174 union avs_global_msg glb; 175 union avs_reply_msg rsp; 176 }; 177 void *data; 178 size_t size; 179 }; 180 181 /* 182 * struct avs_ipc - DSP IPC context 183 * 184 * @dev: PCI device 185 * @rx: Reply message cache 186 * @default_timeout_ms: default message timeout in MS 187 * @ready: whether firmware is ready and communication is open 188 * @rx_completed: whether RX for previously sent TX has been received 189 * @rx_lock: for serializing manipulation of rx_* fields 190 * @msg_lock: for synchronizing request handling 191 * @done_completion: DONE-part of IPC i.e. ROM and ACKs from FW 192 * @busy_completion: BUSY-part of IPC i.e. receiving responses from FW 193 */ 194 struct avs_ipc { 195 struct device *dev; 196 197 struct avs_ipc_msg rx; 198 u32 default_timeout_ms; 199 bool ready; 200 atomic_t recovering; 201 202 bool rx_completed; 203 spinlock_t rx_lock; 204 struct mutex msg_mutex; 205 struct completion done_completion; 206 struct completion busy_completion; 207 208 struct work_struct recovery_work; 209 struct delayed_work d0ix_work; 210 atomic_t d0ix_disable_depth; 211 bool in_d0ix; 212 }; 213 214 #define AVS_EIPC EREMOTEIO 215 /* 216 * IPC handlers may return positive value (firmware error code) what denotes 217 * successful HOST <-> DSP communication yet failure to process specific request. 218 * 219 * Below macro converts returned value to linux kernel error code. 220 * All IPC callers MUST use it as soon as firmware error code is consumed. 221 */ 222 #define AVS_IPC_RET(ret) \ 223 (((ret) <= 0) ? (ret) : -AVS_EIPC) 224 225 static inline void avs_ipc_err(struct avs_dev *adev, struct avs_ipc_msg *tx, 226 const char *name, int error) 227 { 228 /* 229 * If IPC channel is blocked e.g.: due to ongoing recovery, 230 * -EPERM error code is expected and thus it's not an actual error. 231 * 232 * Unsupported IPCs are of no harm either. 233 */ 234 if (error == -EPERM || error == AVS_IPC_NOT_SUPPORTED) 235 dev_dbg(adev->dev, "%s 0x%08x 0x%08x failed: %d\n", name, 236 tx->glb.primary, tx->glb.ext.val, error); 237 else 238 dev_err(adev->dev, "%s 0x%08x 0x%08x failed: %d\n", name, 239 tx->glb.primary, tx->glb.ext.val, error); 240 } 241 242 irqreturn_t avs_dsp_irq_handler(int irq, void *dev_id); 243 irqreturn_t avs_dsp_irq_thread(int irq, void *dev_id); 244 void avs_dsp_process_response(struct avs_dev *adev, u64 header); 245 int avs_dsp_send_msg_timeout(struct avs_dev *adev, 246 struct avs_ipc_msg *request, 247 struct avs_ipc_msg *reply, int timeout); 248 int avs_dsp_send_msg(struct avs_dev *adev, 249 struct avs_ipc_msg *request, struct avs_ipc_msg *reply); 250 /* Two variants below are for messages that control DSP power states. */ 251 int avs_dsp_send_pm_msg_timeout(struct avs_dev *adev, struct avs_ipc_msg *request, 252 struct avs_ipc_msg *reply, int timeout, bool wake_d0i0); 253 int avs_dsp_send_pm_msg(struct avs_dev *adev, struct avs_ipc_msg *request, 254 struct avs_ipc_msg *reply, bool wake_d0i0); 255 int avs_dsp_send_rom_msg_timeout(struct avs_dev *adev, 256 struct avs_ipc_msg *request, int timeout); 257 int avs_dsp_send_rom_msg(struct avs_dev *adev, struct avs_ipc_msg *request); 258 void avs_dsp_interrupt_control(struct avs_dev *adev, bool enable); 259 int avs_ipc_init(struct avs_ipc *ipc, struct device *dev); 260 void avs_ipc_block(struct avs_ipc *ipc); 261 262 int avs_dsp_disable_d0ix(struct avs_dev *adev); 263 int avs_dsp_enable_d0ix(struct avs_dev *adev); 264 265 int skl_log_buffer_offset(struct avs_dev *adev, u32 core); 266 267 /* Firmware resources management */ 268 269 int avs_get_module_entry(struct avs_dev *adev, const guid_t *uuid, struct avs_module_entry *entry); 270 int avs_get_module_id_entry(struct avs_dev *adev, u32 module_id, struct avs_module_entry *entry); 271 int avs_get_module_id(struct avs_dev *adev, const guid_t *uuid); 272 bool avs_is_module_ida_empty(struct avs_dev *adev, u32 module_id); 273 274 int avs_module_info_init(struct avs_dev *adev, bool purge); 275 void avs_module_info_free(struct avs_dev *adev); 276 int avs_module_id_alloc(struct avs_dev *adev, u16 module_id); 277 void avs_module_id_free(struct avs_dev *adev, u16 module_id, u8 instance_id); 278 int avs_request_firmware(struct avs_dev *adev, const struct firmware **fw_p, const char *name); 279 void avs_release_last_firmware(struct avs_dev *adev); 280 void avs_release_firmwares(struct avs_dev *adev); 281 282 int avs_dsp_init_module(struct avs_dev *adev, u16 module_id, u8 ppl_instance_id, 283 u8 core_id, u8 domain, void *param, u32 param_size, 284 u16 *instance_id); 285 void avs_dsp_delete_module(struct avs_dev *adev, u16 module_id, u16 instance_id, 286 u8 ppl_instance_id, u8 core_id); 287 int avs_dsp_create_pipeline(struct avs_dev *adev, u16 req_size, u8 priority, 288 bool lp, u16 attributes, u8 *instance_id); 289 int avs_dsp_delete_pipeline(struct avs_dev *adev, u8 instance_id); 290 291 /* Firmware loading */ 292 293 void avs_hda_clock_gating_enable(struct avs_dev *adev, bool enable); 294 void avs_hda_power_gating_enable(struct avs_dev *adev, bool enable); 295 void avs_hda_l1sen_enable(struct avs_dev *adev, bool enable); 296 297 int avs_dsp_load_libraries(struct avs_dev *adev, struct avs_tplg_library *libs, u32 num_libs); 298 int avs_dsp_boot_firmware(struct avs_dev *adev, bool purge); 299 int avs_dsp_first_boot_firmware(struct avs_dev *adev); 300 301 int avs_cldma_load_basefw(struct avs_dev *adev, struct firmware *fw); 302 int avs_cldma_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); 303 int avs_cldma_transfer_modules(struct avs_dev *adev, bool load, 304 struct avs_module_entry *mods, u32 num_mods); 305 int avs_hda_load_basefw(struct avs_dev *adev, struct firmware *fw); 306 int avs_hda_load_library(struct avs_dev *adev, struct firmware *lib, u32 id); 307 int avs_hda_transfer_modules(struct avs_dev *adev, bool load, 308 struct avs_module_entry *mods, u32 num_mods); 309 310 /* Soc component members */ 311 312 struct avs_soc_component { 313 struct snd_soc_component base; 314 struct avs_tplg *tplg; 315 316 struct list_head node; 317 }; 318 319 #define to_avs_soc_component(comp) \ 320 container_of(comp, struct avs_soc_component, base) 321 322 extern const struct snd_soc_dai_ops avs_dai_fe_ops; 323 324 int avs_dmic_platform_register(struct avs_dev *adev, const char *name); 325 int avs_i2s_platform_register(struct avs_dev *adev, const char *name, unsigned long port_mask, 326 unsigned long *tdms); 327 int avs_hda_platform_register(struct avs_dev *adev, const char *name); 328 329 int avs_register_all_boards(struct avs_dev *adev); 330 void avs_unregister_all_boards(struct avs_dev *adev); 331 332 /* Firmware tracing helpers */ 333 334 unsigned int __kfifo_fromio_locked(struct kfifo *fifo, const void __iomem *src, unsigned int len, 335 spinlock_t *lock); 336 337 #define avs_log_buffer_size(adev) \ 338 ((adev)->fw_cfg.trace_log_bytes / (adev)->hw_cfg.dsp_cores) 339 340 #define avs_log_buffer_addr(adev, core) \ 341 ({ \ 342 s32 __offset = avs_dsp_op(adev, log_buffer_offset, core); \ 343 (__offset < 0) ? NULL : \ 344 (avs_sram_addr(adev, AVS_DEBUG_WINDOW) + __offset); \ 345 }) 346 347 struct apl_log_buffer_layout { 348 u32 read_ptr; 349 u32 write_ptr; 350 u8 buffer[]; 351 } __packed; 352 353 #define apl_log_payload_size(adev) \ 354 (avs_log_buffer_size(adev) - sizeof(struct apl_log_buffer_layout)) 355 356 #define apl_log_payload_addr(addr) \ 357 (addr + sizeof(struct apl_log_buffer_layout)) 358 359 #endif /* __SOUND_SOC_INTEL_AVS_H */ 360