Loading...
1/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2/*
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 *
8 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
9 */
10
11#ifndef __SOF_INTEL_HDA_H
12#define __SOF_INTEL_HDA_H
13
14#include <linux/soundwire/sdw.h>
15#include <linux/soundwire/sdw_intel.h>
16#include <sound/compress_driver.h>
17#include <sound/hda_codec.h>
18#include <sound/hdaudio_ext.h>
19#include "../sof-client-probes.h"
20#include "../sof-audio.h"
21#include "shim.h"
22
23/* PCI registers */
24#define PCI_TCSEL 0x44
25#define PCI_PGCTL PCI_TCSEL
26#define PCI_CGCTL 0x48
27
28/* PCI_PGCTL bits */
29#define PCI_PGCTL_ADSPPGD BIT(2)
30#define PCI_PGCTL_LSRMD_MASK BIT(4)
31
32/* PCI_CGCTL bits */
33#define PCI_CGCTL_MISCBDCGE_MASK BIT(6)
34#define PCI_CGCTL_ADSPDCGE BIT(1)
35
36/* Legacy HDA registers and bits used - widths are variable */
37#define SOF_HDA_GCAP 0x0
38#define SOF_HDA_GCTL 0x8
39/* accept unsol. response enable */
40#define SOF_HDA_GCTL_UNSOL BIT(8)
41#define SOF_HDA_LLCH 0x14
42#define SOF_HDA_INTCTL 0x20
43#define SOF_HDA_INTSTS 0x24
44#define SOF_HDA_WAKESTS 0x0E
45#define SOF_HDA_WAKESTS_INT_MASK ((1 << 8) - 1)
46#define SOF_HDA_RIRBSTS 0x5d
47
48/* SOF_HDA_GCTL register bist */
49#define SOF_HDA_GCTL_RESET BIT(0)
50
51/* SOF_HDA_INCTL regs */
52#define SOF_HDA_INT_GLOBAL_EN BIT(31)
53#define SOF_HDA_INT_CTRL_EN BIT(30)
54#define SOF_HDA_INT_ALL_STREAM 0xff
55
56/* SOF_HDA_INTSTS regs */
57#define SOF_HDA_INTSTS_GIS BIT(31)
58
59#define SOF_HDA_MAX_CAPS 10
60#define SOF_HDA_CAP_ID_OFF 16
61#define SOF_HDA_CAP_ID_MASK GENMASK(SOF_HDA_CAP_ID_OFF + 11,\
62 SOF_HDA_CAP_ID_OFF)
63#define SOF_HDA_CAP_NEXT_MASK 0xFFFF
64
65#define SOF_HDA_GTS_CAP_ID 0x1
66#define SOF_HDA_ML_CAP_ID 0x2
67
68#define SOF_HDA_PP_CAP_ID 0x3
69#define SOF_HDA_REG_PP_PPCH 0x10
70#define SOF_HDA_REG_PP_PPCTL 0x04
71#define SOF_HDA_REG_PP_PPSTS 0x08
72#define SOF_HDA_PPCTL_PIE BIT(31)
73#define SOF_HDA_PPCTL_GPROCEN BIT(30)
74
75/*Vendor Specific Registers*/
76#define SOF_HDA_VS_D0I3C 0x104A
77
78/* D0I3C Register fields */
79#define SOF_HDA_VS_D0I3C_CIP BIT(0) /* Command-In-Progress */
80#define SOF_HDA_VS_D0I3C_I3 BIT(2) /* D0i3 enable bit */
81
82/* DPIB entry size: 8 Bytes = 2 DWords */
83#define SOF_HDA_DPIB_ENTRY_SIZE 0x8
84
85#define SOF_HDA_SPIB_CAP_ID 0x4
86#define SOF_HDA_DRSM_CAP_ID 0x5
87
88#define SOF_HDA_SPIB_BASE 0x08
89#define SOF_HDA_SPIB_INTERVAL 0x08
90#define SOF_HDA_SPIB_SPIB 0x00
91#define SOF_HDA_SPIB_MAXFIFO 0x04
92
93#define SOF_HDA_PPHC_BASE 0x10
94#define SOF_HDA_PPHC_INTERVAL 0x10
95
96#define SOF_HDA_PPLC_BASE 0x10
97#define SOF_HDA_PPLC_MULTI 0x10
98#define SOF_HDA_PPLC_INTERVAL 0x10
99
100#define SOF_HDA_DRSM_BASE 0x08
101#define SOF_HDA_DRSM_INTERVAL 0x08
102
103/* Descriptor error interrupt */
104#define SOF_HDA_CL_DMA_SD_INT_DESC_ERR 0x10
105
106/* FIFO error interrupt */
107#define SOF_HDA_CL_DMA_SD_INT_FIFO_ERR 0x08
108
109/* Buffer completion interrupt */
110#define SOF_HDA_CL_DMA_SD_INT_COMPLETE 0x04
111
112#define SOF_HDA_CL_DMA_SD_INT_MASK \
113 (SOF_HDA_CL_DMA_SD_INT_DESC_ERR | \
114 SOF_HDA_CL_DMA_SD_INT_FIFO_ERR | \
115 SOF_HDA_CL_DMA_SD_INT_COMPLETE)
116#define SOF_HDA_SD_CTL_DMA_START 0x02 /* Stream DMA start bit */
117
118/* Intel HD Audio Code Loader DMA Registers */
119#define SOF_HDA_ADSP_LOADER_BASE 0x80
120#define SOF_HDA_ADSP_DPLBASE 0x70
121#define SOF_HDA_ADSP_DPUBASE 0x74
122#define SOF_HDA_ADSP_DPLBASE_ENABLE 0x01
123
124/* Stream Registers */
125#define SOF_HDA_ADSP_REG_SD_CTL 0x00
126#define SOF_HDA_ADSP_REG_SD_STS 0x03
127#define SOF_HDA_ADSP_REG_SD_LPIB 0x04
128#define SOF_HDA_ADSP_REG_SD_CBL 0x08
129#define SOF_HDA_ADSP_REG_SD_LVI 0x0C
130#define SOF_HDA_ADSP_REG_SD_FIFOW 0x0E
131#define SOF_HDA_ADSP_REG_SD_FIFOSIZE 0x10
132#define SOF_HDA_ADSP_REG_SD_FORMAT 0x12
133#define SOF_HDA_ADSP_REG_SD_FIFOL 0x14
134#define SOF_HDA_ADSP_REG_SD_BDLPL 0x18
135#define SOF_HDA_ADSP_REG_SD_BDLPU 0x1C
136#define SOF_HDA_ADSP_SD_ENTRY_SIZE 0x20
137
138/* SDxFIFOS FIFOS */
139#define SOF_HDA_SD_FIFOSIZE_FIFOS_MASK GENMASK(15, 0)
140
141/* CL: Software Position Based FIFO Capability Registers */
142#define SOF_DSP_REG_CL_SPBFIFO \
143 (SOF_HDA_ADSP_LOADER_BASE + 0x20)
144#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPBFCH 0x0
145#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPBFCCTL 0x4
146#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPIB 0x8
147#define SOF_HDA_ADSP_REG_CL_SPBFIFO_MAXFIFOS 0xc
148
149/* Stream Number */
150#define SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT 20
151#define SOF_HDA_CL_SD_CTL_STREAM_TAG_MASK \
152 GENMASK(SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT + 3,\
153 SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT)
154
155#define HDA_DSP_HDA_BAR 0
156#define HDA_DSP_PP_BAR 1
157#define HDA_DSP_SPIB_BAR 2
158#define HDA_DSP_DRSM_BAR 3
159#define HDA_DSP_BAR 4
160
161#define SRAM_WINDOW_OFFSET(x) (0x80000 + (x) * 0x20000)
162
163#define HDA_DSP_MBOX_OFFSET SRAM_WINDOW_OFFSET(0)
164
165#define HDA_DSP_PANIC_OFFSET(x) \
166 (((x) & 0xFFFFFF) + HDA_DSP_MBOX_OFFSET)
167
168/* SRAM window 0 FW "registers" */
169#define HDA_DSP_SRAM_REG_ROM_STATUS (HDA_DSP_MBOX_OFFSET + 0x0)
170#define HDA_DSP_SRAM_REG_ROM_ERROR (HDA_DSP_MBOX_OFFSET + 0x4)
171/* FW and ROM share offset 4 */
172#define HDA_DSP_SRAM_REG_FW_STATUS (HDA_DSP_MBOX_OFFSET + 0x4)
173#define HDA_DSP_SRAM_REG_FW_TRACEP (HDA_DSP_MBOX_OFFSET + 0x8)
174#define HDA_DSP_SRAM_REG_FW_END (HDA_DSP_MBOX_OFFSET + 0xc)
175
176#define HDA_DSP_MBOX_UPLINK_OFFSET 0x81000
177
178#define HDA_DSP_STREAM_RESET_TIMEOUT 300
179/*
180 * Timeout in us, for setting the stream RUN bit, during
181 * start/stop the stream. The timeout expires if new RUN bit
182 * value cannot be read back within the specified time.
183 */
184#define HDA_DSP_STREAM_RUN_TIMEOUT 300
185
186#define HDA_DSP_SPIB_ENABLE 1
187#define HDA_DSP_SPIB_DISABLE 0
188
189#define SOF_HDA_MAX_BUFFER_SIZE (32 * PAGE_SIZE)
190
191#define HDA_DSP_STACK_DUMP_SIZE 32
192
193/* ROM/FW status register */
194#define FSR_STATE_MASK GENMASK(23, 0)
195#define FSR_WAIT_STATE_MASK GENMASK(27, 24)
196#define FSR_MODULE_MASK GENMASK(30, 28)
197#define FSR_HALTED BIT(31)
198#define FSR_TO_STATE_CODE(x) ((x) & FSR_STATE_MASK)
199#define FSR_TO_WAIT_STATE_CODE(x) (((x) & FSR_WAIT_STATE_MASK) >> 24)
200#define FSR_TO_MODULE_CODE(x) (((x) & FSR_MODULE_MASK) >> 28)
201
202/* Wait states */
203#define FSR_WAIT_FOR_IPC_BUSY 0x1
204#define FSR_WAIT_FOR_IPC_DONE 0x2
205#define FSR_WAIT_FOR_CACHE_INVALIDATION 0x3
206#define FSR_WAIT_FOR_LP_SRAM_OFF 0x4
207#define FSR_WAIT_FOR_DMA_BUFFER_FULL 0x5
208#define FSR_WAIT_FOR_CSE_CSR 0x6
209
210/* Module codes */
211#define FSR_MOD_ROM 0x0
212#define FSR_MOD_ROM_BYP 0x1
213#define FSR_MOD_BASE_FW 0x2
214#define FSR_MOD_LP_BOOT 0x3
215#define FSR_MOD_BRNGUP 0x4
216#define FSR_MOD_ROM_EXT 0x5
217
218/* State codes (module dependent) */
219/* Module independent states */
220#define FSR_STATE_INIT 0x0
221#define FSR_STATE_INIT_DONE 0x1
222#define FSR_STATE_FW_ENTERED 0x5
223
224/* ROM states */
225#define FSR_STATE_ROM_INIT FSR_STATE_INIT
226#define FSR_STATE_ROM_INIT_DONE FSR_STATE_INIT_DONE
227#define FSR_STATE_ROM_CSE_MANIFEST_LOADED 0x2
228#define FSR_STATE_ROM_FW_MANIFEST_LOADED 0x3
229#define FSR_STATE_ROM_FW_FW_LOADED 0x4
230#define FSR_STATE_ROM_FW_ENTERED FSR_STATE_FW_ENTERED
231#define FSR_STATE_ROM_VERIFY_FEATURE_MASK 0x6
232#define FSR_STATE_ROM_GET_LOAD_OFFSET 0x7
233#define FSR_STATE_ROM_FETCH_ROM_EXT 0x8
234#define FSR_STATE_ROM_FETCH_ROM_EXT_DONE 0x9
235#define FSR_STATE_ROM_BASEFW_ENTERED 0xf /* SKL */
236
237/* (ROM) CSE states */
238#define FSR_STATE_ROM_CSE_IMR_REQUEST 0x10
239#define FSR_STATE_ROM_CSE_IMR_GRANTED 0x11
240#define FSR_STATE_ROM_CSE_VALIDATE_IMAGE_REQUEST 0x12
241#define FSR_STATE_ROM_CSE_IMAGE_VALIDATED 0x13
242
243#define FSR_STATE_ROM_CSE_IPC_IFACE_INIT 0x20
244#define FSR_STATE_ROM_CSE_IPC_RESET_PHASE_1 0x21
245#define FSR_STATE_ROM_CSE_IPC_OPERATIONAL_ENTRY 0x22
246#define FSR_STATE_ROM_CSE_IPC_OPERATIONAL 0x23
247#define FSR_STATE_ROM_CSE_IPC_DOWN 0x24
248
249/* BRINGUP (or BRNGUP) states */
250#define FSR_STATE_BRINGUP_INIT FSR_STATE_INIT
251#define FSR_STATE_BRINGUP_INIT_DONE FSR_STATE_INIT_DONE
252#define FSR_STATE_BRINGUP_HPSRAM_LOAD 0x2
253#define FSR_STATE_BRINGUP_UNPACK_START 0X3
254#define FSR_STATE_BRINGUP_IMR_RESTORE 0x4
255#define FSR_STATE_BRINGUP_FW_ENTERED FSR_STATE_FW_ENTERED
256
257/* ROM status/error values */
258#define HDA_DSP_ROM_CSE_ERROR 40
259#define HDA_DSP_ROM_CSE_WRONG_RESPONSE 41
260#define HDA_DSP_ROM_IMR_TO_SMALL 42
261#define HDA_DSP_ROM_BASE_FW_NOT_FOUND 43
262#define HDA_DSP_ROM_CSE_VALIDATION_FAILED 44
263#define HDA_DSP_ROM_IPC_FATAL_ERROR 45
264#define HDA_DSP_ROM_L2_CACHE_ERROR 46
265#define HDA_DSP_ROM_LOAD_OFFSET_TO_SMALL 47
266#define HDA_DSP_ROM_API_PTR_INVALID 50
267#define HDA_DSP_ROM_BASEFW_INCOMPAT 51
268#define HDA_DSP_ROM_UNHANDLED_INTERRUPT 0xBEE00000
269#define HDA_DSP_ROM_MEMORY_HOLE_ECC 0xECC00000
270#define HDA_DSP_ROM_KERNEL_EXCEPTION 0xCAFE0000
271#define HDA_DSP_ROM_USER_EXCEPTION 0xBEEF0000
272#define HDA_DSP_ROM_UNEXPECTED_RESET 0xDECAF000
273#define HDA_DSP_ROM_NULL_FW_ENTRY 0x4c4c4e55
274
275#define HDA_DSP_ROM_IPC_CONTROL 0x01000000
276#define HDA_DSP_ROM_IPC_PURGE_FW 0x00004000
277
278/* various timeout values */
279#define HDA_DSP_PU_TIMEOUT 50
280#define HDA_DSP_PD_TIMEOUT 50
281#define HDA_DSP_RESET_TIMEOUT_US 50000
282#define HDA_DSP_BASEFW_TIMEOUT_US 3000000
283#define HDA_DSP_INIT_TIMEOUT_US 500000
284#define HDA_DSP_CTRL_RESET_TIMEOUT 100
285#define HDA_DSP_WAIT_TIMEOUT 500 /* 500 msec */
286#define HDA_DSP_REG_POLL_INTERVAL_US 500 /* 0.5 msec */
287#define HDA_DSP_REG_POLL_RETRY_COUNT 50
288
289#define HDA_DSP_ADSPIC_IPC BIT(0)
290#define HDA_DSP_ADSPIS_IPC BIT(0)
291
292/* Intel HD Audio General DSP Registers */
293#define HDA_DSP_GEN_BASE 0x0
294#define HDA_DSP_REG_ADSPCS (HDA_DSP_GEN_BASE + 0x04)
295#define HDA_DSP_REG_ADSPIC (HDA_DSP_GEN_BASE + 0x08)
296#define HDA_DSP_REG_ADSPIS (HDA_DSP_GEN_BASE + 0x0C)
297#define HDA_DSP_REG_ADSPIC2 (HDA_DSP_GEN_BASE + 0x10)
298#define HDA_DSP_REG_ADSPIS2 (HDA_DSP_GEN_BASE + 0x14)
299
300#define HDA_DSP_REG_ADSPIC2_SNDW BIT(5)
301#define HDA_DSP_REG_ADSPIS2_SNDW BIT(5)
302
303/* Intel HD Audio Inter-Processor Communication Registers */
304#define HDA_DSP_IPC_BASE 0x40
305#define HDA_DSP_REG_HIPCT (HDA_DSP_IPC_BASE + 0x00)
306#define HDA_DSP_REG_HIPCTE (HDA_DSP_IPC_BASE + 0x04)
307#define HDA_DSP_REG_HIPCI (HDA_DSP_IPC_BASE + 0x08)
308#define HDA_DSP_REG_HIPCIE (HDA_DSP_IPC_BASE + 0x0C)
309#define HDA_DSP_REG_HIPCCTL (HDA_DSP_IPC_BASE + 0x10)
310
311/* Intel Vendor Specific Registers */
312#define HDA_VS_INTEL_EM2 0x1030
313#define HDA_VS_INTEL_EM2_L1SEN BIT(13)
314#define HDA_VS_INTEL_LTRP 0x1048
315#define HDA_VS_INTEL_LTRP_GB_MASK 0x3F
316
317/* HIPCI */
318#define HDA_DSP_REG_HIPCI_BUSY BIT(31)
319#define HDA_DSP_REG_HIPCI_MSG_MASK 0x7FFFFFFF
320
321/* HIPCIE */
322#define HDA_DSP_REG_HIPCIE_DONE BIT(30)
323#define HDA_DSP_REG_HIPCIE_MSG_MASK 0x3FFFFFFF
324
325/* HIPCCTL */
326#define HDA_DSP_REG_HIPCCTL_DONE BIT(1)
327#define HDA_DSP_REG_HIPCCTL_BUSY BIT(0)
328
329/* HIPCT */
330#define HDA_DSP_REG_HIPCT_BUSY BIT(31)
331#define HDA_DSP_REG_HIPCT_MSG_MASK 0x7FFFFFFF
332
333/* HIPCTE */
334#define HDA_DSP_REG_HIPCTE_MSG_MASK 0x3FFFFFFF
335
336#define HDA_DSP_ADSPIC_CL_DMA BIT(1)
337#define HDA_DSP_ADSPIS_CL_DMA BIT(1)
338
339/* Delay before scheduling D0i3 entry */
340#define BXT_D0I3_DELAY 5000
341
342#define FW_CL_STREAM_NUMBER 0x1
343#define HDA_FW_BOOT_ATTEMPTS 3
344
345/* ADSPCS - Audio DSP Control & Status */
346
347/*
348 * Core Reset - asserted high
349 * CRST Mask for a given core mask pattern, cm
350 */
351#define HDA_DSP_ADSPCS_CRST_SHIFT 0
352#define HDA_DSP_ADSPCS_CRST_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CRST_SHIFT)
353
354/*
355 * Core run/stall - when set to '1' core is stalled
356 * CSTALL Mask for a given core mask pattern, cm
357 */
358#define HDA_DSP_ADSPCS_CSTALL_SHIFT 8
359#define HDA_DSP_ADSPCS_CSTALL_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CSTALL_SHIFT)
360
361/*
362 * Set Power Active - when set to '1' turn cores on
363 * SPA Mask for a given core mask pattern, cm
364 */
365#define HDA_DSP_ADSPCS_SPA_SHIFT 16
366#define HDA_DSP_ADSPCS_SPA_MASK(cm) ((cm) << HDA_DSP_ADSPCS_SPA_SHIFT)
367
368/*
369 * Current Power Active - power status of cores, set by hardware
370 * CPA Mask for a given core mask pattern, cm
371 */
372#define HDA_DSP_ADSPCS_CPA_SHIFT 24
373#define HDA_DSP_ADSPCS_CPA_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CPA_SHIFT)
374
375/*
376 * Mask for a given number of cores
377 * nc = number of supported cores
378 */
379#define SOF_DSP_CORES_MASK(nc) GENMASK(((nc) - 1), 0)
380
381/* Intel HD Audio Inter-Processor Communication Registers for Cannonlake*/
382#define CNL_DSP_IPC_BASE 0xc0
383#define CNL_DSP_REG_HIPCTDR (CNL_DSP_IPC_BASE + 0x00)
384#define CNL_DSP_REG_HIPCTDA (CNL_DSP_IPC_BASE + 0x04)
385#define CNL_DSP_REG_HIPCTDD (CNL_DSP_IPC_BASE + 0x08)
386#define CNL_DSP_REG_HIPCIDR (CNL_DSP_IPC_BASE + 0x10)
387#define CNL_DSP_REG_HIPCIDA (CNL_DSP_IPC_BASE + 0x14)
388#define CNL_DSP_REG_HIPCIDD (CNL_DSP_IPC_BASE + 0x18)
389#define CNL_DSP_REG_HIPCCTL (CNL_DSP_IPC_BASE + 0x28)
390
391/* HIPCI */
392#define CNL_DSP_REG_HIPCIDR_BUSY BIT(31)
393#define CNL_DSP_REG_HIPCIDR_MSG_MASK 0x7FFFFFFF
394
395/* HIPCIE */
396#define CNL_DSP_REG_HIPCIDA_DONE BIT(31)
397#define CNL_DSP_REG_HIPCIDA_MSG_MASK 0x7FFFFFFF
398
399/* HIPCCTL */
400#define CNL_DSP_REG_HIPCCTL_DONE BIT(1)
401#define CNL_DSP_REG_HIPCCTL_BUSY BIT(0)
402
403/* HIPCT */
404#define CNL_DSP_REG_HIPCTDR_BUSY BIT(31)
405#define CNL_DSP_REG_HIPCTDR_MSG_MASK 0x7FFFFFFF
406
407/* HIPCTDA */
408#define CNL_DSP_REG_HIPCTDA_DONE BIT(31)
409#define CNL_DSP_REG_HIPCTDA_MSG_MASK 0x7FFFFFFF
410
411/* HIPCTDD */
412#define CNL_DSP_REG_HIPCTDD_MSG_MASK 0x7FFFFFFF
413
414/* BDL */
415#define HDA_DSP_BDL_SIZE 4096
416#define HDA_DSP_MAX_BDL_ENTRIES \
417 (HDA_DSP_BDL_SIZE / sizeof(struct sof_intel_dsp_bdl))
418
419/* Number of DAIs */
420#define SOF_SKL_NUM_DAIS_NOCODEC 8
421
422#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
423#define SOF_SKL_NUM_DAIS 15
424#else
425#define SOF_SKL_NUM_DAIS SOF_SKL_NUM_DAIS_NOCODEC
426#endif
427
428/* Intel HD Audio SRAM Window 0*/
429#define HDA_DSP_SRAM_REG_ROM_STATUS_SKL 0x8000
430#define HDA_ADSP_SRAM0_BASE_SKL 0x8000
431
432/* Firmware status window */
433#define HDA_ADSP_FW_STATUS_SKL HDA_ADSP_SRAM0_BASE_SKL
434#define HDA_ADSP_ERROR_CODE_SKL (HDA_ADSP_FW_STATUS_SKL + 0x4)
435
436/* Host Device Memory Space */
437#define APL_SSP_BASE_OFFSET 0x2000
438#define CNL_SSP_BASE_OFFSET 0x10000
439
440/* Host Device Memory Size of a Single SSP */
441#define SSP_DEV_MEM_SIZE 0x1000
442
443/* SSP Count of the Platform */
444#define APL_SSP_COUNT 6
445#define CNL_SSP_COUNT 3
446#define ICL_SSP_COUNT 6
447#define TGL_SSP_COUNT 3
448#define MTL_SSP_COUNT 3
449
450/* SSP Registers */
451#define SSP_SSC1_OFFSET 0x4
452#define SSP_SET_SCLK_CONSUMER BIT(25)
453#define SSP_SET_SFRM_CONSUMER BIT(24)
454#define SSP_SET_CBP_CFP (SSP_SET_SCLK_CONSUMER | SSP_SET_SFRM_CONSUMER)
455
456#define HDA_IDISP_ADDR 2
457#define HDA_IDISP_CODEC(x) ((x) & BIT(HDA_IDISP_ADDR))
458
459struct sof_intel_dsp_bdl {
460 __le32 addr_l;
461 __le32 addr_h;
462 __le32 size;
463 __le32 ioc;
464} __attribute((packed));
465
466#define SOF_HDA_PLAYBACK_STREAMS 16
467#define SOF_HDA_CAPTURE_STREAMS 16
468#define SOF_HDA_PLAYBACK 0
469#define SOF_HDA_CAPTURE 1
470
471/* stream flags */
472#define SOF_HDA_STREAM_DMI_L1_COMPATIBLE 1
473
474/*
475 * Time in ms for opportunistic D0I3 entry delay.
476 * This has been deliberately chosen to be long to avoid race conditions.
477 * Could be optimized in future.
478 */
479#define SOF_HDA_D0I3_WORK_DELAY_MS 5000
480
481/* HDA DSP D0 substate */
482enum sof_hda_D0_substate {
483 SOF_HDA_DSP_PM_D0I0, /* default D0 substate */
484 SOF_HDA_DSP_PM_D0I3, /* low power D0 substate */
485};
486
487/* represents DSP HDA controller frontend - i.e. host facing control */
488struct sof_intel_hda_dev {
489 bool imrboot_supported;
490 bool skip_imr_boot;
491 bool booted_from_imr;
492
493 int boot_iteration;
494
495 struct hda_bus hbus;
496
497 /* hw config */
498 const struct sof_intel_dsp_desc *desc;
499
500 /* trace */
501 struct hdac_ext_stream *dtrace_stream;
502
503 /* if position update IPC needed */
504 u32 no_ipc_position;
505
506 /* the maximum number of streams (playback + capture) supported */
507 u32 stream_max;
508
509 /* PM related */
510 bool l1_disabled;/* is DMI link L1 disabled? */
511
512 /* DMIC device */
513 struct platform_device *dmic_dev;
514
515 /* delayed work to enter D0I3 opportunistically */
516 struct delayed_work d0i3_work;
517
518 /* ACPI information stored between scan and probe steps */
519 struct sdw_intel_acpi_info info;
520
521 /* sdw context allocated by SoundWire driver */
522 struct sdw_intel_ctx *sdw;
523
524 /* FW clock config, 0:HPRO, 1:LPRO */
525 bool clk_config_lpro;
526
527 wait_queue_head_t waitq;
528 bool code_loading;
529
530 /* Intel NHLT information */
531 struct nhlt_acpi_table *nhlt;
532
533 /*
534 * Pointing to the IPC message if immediate sending was not possible
535 * because the downlink communication channel was BUSY at the time.
536 * The message will be re-tried when the channel becomes free (the ACK
537 * is received from the DSP for the previous message)
538 */
539 struct snd_sof_ipc_msg *delayed_ipc_tx_msg;
540};
541
542static inline struct hdac_bus *sof_to_bus(struct snd_sof_dev *s)
543{
544 struct sof_intel_hda_dev *hda = s->pdata->hw_pdata;
545
546 return &hda->hbus.core;
547}
548
549static inline struct hda_bus *sof_to_hbus(struct snd_sof_dev *s)
550{
551 struct sof_intel_hda_dev *hda = s->pdata->hw_pdata;
552
553 return &hda->hbus;
554}
555
556struct sof_intel_hda_stream {
557 struct snd_sof_dev *sdev;
558 struct hdac_ext_stream hext_stream;
559 struct sof_intel_stream sof_intel_stream;
560 int host_reserved; /* reserve host DMA channel */
561 u32 flags;
562};
563
564#define hstream_to_sof_hda_stream(hstream) \
565 container_of(hstream, struct sof_intel_hda_stream, hext_stream)
566
567#define bus_to_sof_hda(bus) \
568 container_of(bus, struct sof_intel_hda_dev, hbus.core)
569
570#define SOF_STREAM_SD_OFFSET(s) \
571 (SOF_HDA_ADSP_SD_ENTRY_SIZE * ((s)->index) \
572 + SOF_HDA_ADSP_LOADER_BASE)
573
574#define SOF_STREAM_SD_OFFSET_CRST 0x1
575
576/*
577 * DSP Core services.
578 */
579int hda_dsp_probe_early(struct snd_sof_dev *sdev);
580int hda_dsp_probe(struct snd_sof_dev *sdev);
581void hda_dsp_remove(struct snd_sof_dev *sdev);
582void hda_dsp_remove_late(struct snd_sof_dev *sdev);
583int hda_dsp_core_power_up(struct snd_sof_dev *sdev, unsigned int core_mask);
584int hda_dsp_core_run(struct snd_sof_dev *sdev, unsigned int core_mask);
585int hda_dsp_enable_core(struct snd_sof_dev *sdev, unsigned int core_mask);
586int hda_dsp_core_reset_power_down(struct snd_sof_dev *sdev,
587 unsigned int core_mask);
588int hda_power_down_dsp(struct snd_sof_dev *sdev);
589int hda_dsp_core_get(struct snd_sof_dev *sdev, int core);
590void hda_dsp_ipc_int_enable(struct snd_sof_dev *sdev);
591void hda_dsp_ipc_int_disable(struct snd_sof_dev *sdev);
592bool hda_dsp_core_is_enabled(struct snd_sof_dev *sdev, unsigned int core_mask);
593
594int hda_dsp_set_power_state_ipc3(struct snd_sof_dev *sdev,
595 const struct sof_dsp_power_state *target_state);
596int hda_dsp_set_power_state_ipc4(struct snd_sof_dev *sdev,
597 const struct sof_dsp_power_state *target_state);
598
599int hda_dsp_suspend(struct snd_sof_dev *sdev, u32 target_state);
600int hda_dsp_resume(struct snd_sof_dev *sdev);
601int hda_dsp_runtime_suspend(struct snd_sof_dev *sdev);
602int hda_dsp_runtime_resume(struct snd_sof_dev *sdev);
603int hda_dsp_runtime_idle(struct snd_sof_dev *sdev);
604int hda_dsp_shutdown_dma_flush(struct snd_sof_dev *sdev);
605int hda_dsp_shutdown(struct snd_sof_dev *sdev);
606int hda_dsp_set_hw_params_upon_resume(struct snd_sof_dev *sdev);
607void hda_dsp_dump(struct snd_sof_dev *sdev, u32 flags);
608void hda_ipc4_dsp_dump(struct snd_sof_dev *sdev, u32 flags);
609void hda_ipc_dump(struct snd_sof_dev *sdev);
610void hda_ipc_irq_dump(struct snd_sof_dev *sdev);
611void hda_dsp_d0i3_work(struct work_struct *work);
612int hda_dsp_disable_interrupts(struct snd_sof_dev *sdev);
613
614/*
615 * DSP PCM Operations.
616 */
617u32 hda_dsp_get_mult_div(struct snd_sof_dev *sdev, int rate);
618u32 hda_dsp_get_bits(struct snd_sof_dev *sdev, int sample_bits);
619int hda_dsp_pcm_open(struct snd_sof_dev *sdev,
620 struct snd_pcm_substream *substream);
621int hda_dsp_pcm_close(struct snd_sof_dev *sdev,
622 struct snd_pcm_substream *substream);
623int hda_dsp_pcm_hw_params(struct snd_sof_dev *sdev,
624 struct snd_pcm_substream *substream,
625 struct snd_pcm_hw_params *params,
626 struct snd_sof_platform_stream_params *platform_params);
627int hda_dsp_stream_hw_free(struct snd_sof_dev *sdev,
628 struct snd_pcm_substream *substream);
629int hda_dsp_pcm_trigger(struct snd_sof_dev *sdev,
630 struct snd_pcm_substream *substream, int cmd);
631snd_pcm_uframes_t hda_dsp_pcm_pointer(struct snd_sof_dev *sdev,
632 struct snd_pcm_substream *substream);
633int hda_dsp_pcm_ack(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream);
634
635/*
636 * DSP Stream Operations.
637 */
638
639int hda_dsp_stream_init(struct snd_sof_dev *sdev);
640void hda_dsp_stream_free(struct snd_sof_dev *sdev);
641int hda_dsp_stream_hw_params(struct snd_sof_dev *sdev,
642 struct hdac_ext_stream *hext_stream,
643 struct snd_dma_buffer *dmab,
644 struct snd_pcm_hw_params *params);
645int hda_dsp_iccmax_stream_hw_params(struct snd_sof_dev *sdev,
646 struct hdac_ext_stream *hext_stream,
647 struct snd_dma_buffer *dmab,
648 struct snd_pcm_hw_params *params);
649int hda_dsp_stream_trigger(struct snd_sof_dev *sdev,
650 struct hdac_ext_stream *hext_stream, int cmd);
651irqreturn_t hda_dsp_stream_threaded_handler(int irq, void *context);
652int hda_dsp_stream_setup_bdl(struct snd_sof_dev *sdev,
653 struct snd_dma_buffer *dmab,
654 struct hdac_stream *hstream);
655bool hda_dsp_check_ipc_irq(struct snd_sof_dev *sdev);
656bool hda_dsp_check_stream_irq(struct snd_sof_dev *sdev);
657
658snd_pcm_uframes_t hda_dsp_stream_get_position(struct hdac_stream *hstream,
659 int direction, bool can_sleep);
660
661struct hdac_ext_stream *
662 hda_dsp_stream_get(struct snd_sof_dev *sdev, int direction, u32 flags);
663int hda_dsp_stream_put(struct snd_sof_dev *sdev, int direction, int stream_tag);
664int hda_dsp_stream_spib_config(struct snd_sof_dev *sdev,
665 struct hdac_ext_stream *hext_stream,
666 int enable, u32 size);
667
668int hda_ipc_msg_data(struct snd_sof_dev *sdev,
669 struct snd_sof_pcm_stream *sps,
670 void *p, size_t sz);
671int hda_set_stream_data_offset(struct snd_sof_dev *sdev,
672 struct snd_sof_pcm_stream *sps,
673 size_t posn_offset);
674
675/*
676 * DSP IPC Operations.
677 */
678int hda_dsp_ipc_send_msg(struct snd_sof_dev *sdev,
679 struct snd_sof_ipc_msg *msg);
680void hda_dsp_ipc_get_reply(struct snd_sof_dev *sdev);
681int hda_dsp_ipc_get_mailbox_offset(struct snd_sof_dev *sdev);
682int hda_dsp_ipc_get_window_offset(struct snd_sof_dev *sdev, u32 id);
683
684irqreturn_t hda_dsp_ipc_irq_thread(int irq, void *context);
685int hda_dsp_ipc_cmd_done(struct snd_sof_dev *sdev, int dir);
686
687/*
688 * DSP Code loader.
689 */
690int hda_dsp_cl_boot_firmware(struct snd_sof_dev *sdev);
691int hda_dsp_cl_boot_firmware_iccmax(struct snd_sof_dev *sdev);
692int hda_cl_copy_fw(struct snd_sof_dev *sdev, struct hdac_ext_stream *hext_stream);
693struct hdac_ext_stream *hda_cl_stream_prepare(struct snd_sof_dev *sdev, unsigned int format,
694 unsigned int size, struct snd_dma_buffer *dmab,
695 int direction);
696int hda_cl_cleanup(struct snd_sof_dev *sdev, struct snd_dma_buffer *dmab,
697 struct hdac_ext_stream *hext_stream);
698int cl_dsp_init(struct snd_sof_dev *sdev, int stream_tag, bool imr_boot);
699#define HDA_CL_STREAM_FORMAT 0x40
700
701/* pre and post fw run ops */
702int hda_dsp_pre_fw_run(struct snd_sof_dev *sdev);
703int hda_dsp_post_fw_run(struct snd_sof_dev *sdev);
704
705/* parse platform specific ext manifest ops */
706int hda_dsp_ext_man_get_cavs_config_data(struct snd_sof_dev *sdev,
707 const struct sof_ext_man_elem_header *hdr);
708
709/*
710 * HDA Controller Operations.
711 */
712int hda_dsp_ctrl_get_caps(struct snd_sof_dev *sdev);
713void hda_dsp_ctrl_ppcap_enable(struct snd_sof_dev *sdev, bool enable);
714void hda_dsp_ctrl_ppcap_int_enable(struct snd_sof_dev *sdev, bool enable);
715int hda_dsp_ctrl_link_reset(struct snd_sof_dev *sdev, bool reset);
716void hda_dsp_ctrl_misc_clock_gating(struct snd_sof_dev *sdev, bool enable);
717int hda_dsp_ctrl_clock_power_gating(struct snd_sof_dev *sdev, bool enable);
718int hda_dsp_ctrl_init_chip(struct snd_sof_dev *sdev);
719void hda_dsp_ctrl_stop_chip(struct snd_sof_dev *sdev);
720/*
721 * HDA bus operations.
722 */
723void sof_hda_bus_init(struct snd_sof_dev *sdev, struct device *dev);
724void sof_hda_bus_exit(struct snd_sof_dev *sdev);
725
726#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC)
727/*
728 * HDA Codec operations.
729 */
730void hda_codec_probe_bus(struct snd_sof_dev *sdev);
731void hda_codec_jack_wake_enable(struct snd_sof_dev *sdev, bool enable);
732void hda_codec_jack_check(struct snd_sof_dev *sdev);
733void hda_codec_check_for_state_change(struct snd_sof_dev *sdev);
734void hda_codec_init_cmd_io(struct snd_sof_dev *sdev);
735void hda_codec_resume_cmd_io(struct snd_sof_dev *sdev);
736void hda_codec_stop_cmd_io(struct snd_sof_dev *sdev);
737void hda_codec_suspend_cmd_io(struct snd_sof_dev *sdev);
738void hda_codec_detect_mask(struct snd_sof_dev *sdev);
739void hda_codec_rirb_status_clear(struct snd_sof_dev *sdev);
740bool hda_codec_check_rirb_status(struct snd_sof_dev *sdev);
741void hda_codec_set_codec_wakeup(struct snd_sof_dev *sdev, bool status);
742void hda_codec_device_remove(struct snd_sof_dev *sdev);
743
744#else
745
746static inline void hda_codec_probe_bus(struct snd_sof_dev *sdev) { }
747static inline void hda_codec_jack_wake_enable(struct snd_sof_dev *sdev, bool enable) { }
748static inline void hda_codec_jack_check(struct snd_sof_dev *sdev) { }
749static inline void hda_codec_check_for_state_change(struct snd_sof_dev *sdev) { }
750static inline void hda_codec_init_cmd_io(struct snd_sof_dev *sdev) { }
751static inline void hda_codec_resume_cmd_io(struct snd_sof_dev *sdev) { }
752static inline void hda_codec_stop_cmd_io(struct snd_sof_dev *sdev) { }
753static inline void hda_codec_suspend_cmd_io(struct snd_sof_dev *sdev) { }
754static inline void hda_codec_detect_mask(struct snd_sof_dev *sdev) { }
755static inline void hda_codec_rirb_status_clear(struct snd_sof_dev *sdev) { }
756static inline bool hda_codec_check_rirb_status(struct snd_sof_dev *sdev) { return false; }
757static inline void hda_codec_set_codec_wakeup(struct snd_sof_dev *sdev, bool status) { }
758static inline void hda_codec_device_remove(struct snd_sof_dev *sdev) { }
759
760#endif /* CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC */
761
762#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_AUDIO_CODEC) && IS_ENABLED(CONFIG_SND_HDA_CODEC_HDMI)
763
764void hda_codec_i915_display_power(struct snd_sof_dev *sdev, bool enable);
765int hda_codec_i915_init(struct snd_sof_dev *sdev);
766int hda_codec_i915_exit(struct snd_sof_dev *sdev);
767
768#else
769
770static inline void hda_codec_i915_display_power(struct snd_sof_dev *sdev, bool enable) { }
771static inline int hda_codec_i915_init(struct snd_sof_dev *sdev) { return 0; }
772static inline int hda_codec_i915_exit(struct snd_sof_dev *sdev) { return 0; }
773
774#endif
775
776/*
777 * Trace Control.
778 */
779int hda_dsp_trace_init(struct snd_sof_dev *sdev, struct snd_dma_buffer *dmab,
780 struct sof_ipc_dma_trace_params_ext *dtrace_params);
781int hda_dsp_trace_release(struct snd_sof_dev *sdev);
782int hda_dsp_trace_trigger(struct snd_sof_dev *sdev, int cmd);
783
784/*
785 * SoundWire support
786 */
787#if IS_ENABLED(CONFIG_SND_SOC_SOF_INTEL_SOUNDWIRE)
788
789int hda_sdw_check_lcount_common(struct snd_sof_dev *sdev);
790int hda_sdw_check_lcount_ext(struct snd_sof_dev *sdev);
791int hda_sdw_startup(struct snd_sof_dev *sdev);
792void hda_common_enable_sdw_irq(struct snd_sof_dev *sdev, bool enable);
793void hda_sdw_int_enable(struct snd_sof_dev *sdev, bool enable);
794bool hda_sdw_check_wakeen_irq_common(struct snd_sof_dev *sdev);
795void hda_sdw_process_wakeen(struct snd_sof_dev *sdev);
796bool hda_common_check_sdw_irq(struct snd_sof_dev *sdev);
797
798#else
799
800static inline int hda_sdw_check_lcount_common(struct snd_sof_dev *sdev)
801{
802 return 0;
803}
804
805static inline int hda_sdw_check_lcount_ext(struct snd_sof_dev *sdev)
806{
807 return 0;
808}
809
810static inline int hda_sdw_startup(struct snd_sof_dev *sdev)
811{
812 return 0;
813}
814
815static inline void hda_common_enable_sdw_irq(struct snd_sof_dev *sdev, bool enable)
816{
817}
818
819static inline void hda_sdw_int_enable(struct snd_sof_dev *sdev, bool enable)
820{
821}
822
823static inline bool hda_sdw_check_wakeen_irq_common(struct snd_sof_dev *sdev)
824{
825 return false;
826}
827
828static inline void hda_sdw_process_wakeen(struct snd_sof_dev *sdev)
829{
830}
831
832static inline bool hda_common_check_sdw_irq(struct snd_sof_dev *sdev)
833{
834 return false;
835}
836
837#endif
838
839int sdw_hda_dai_hw_params(struct snd_pcm_substream *substream,
840 struct snd_pcm_hw_params *params,
841 struct snd_soc_dai *cpu_dai,
842 int link_id);
843
844int sdw_hda_dai_hw_free(struct snd_pcm_substream *substream,
845 struct snd_soc_dai *cpu_dai,
846 int link_id);
847
848int sdw_hda_dai_trigger(struct snd_pcm_substream *substream, int cmd,
849 struct snd_soc_dai *cpu_dai);
850
851/* common dai driver */
852extern struct snd_soc_dai_driver skl_dai[];
853int hda_dsp_dais_suspend(struct snd_sof_dev *sdev);
854
855/*
856 * Platform Specific HW abstraction Ops.
857 */
858extern struct snd_sof_dsp_ops sof_hda_common_ops;
859
860extern struct snd_sof_dsp_ops sof_skl_ops;
861int sof_skl_ops_init(struct snd_sof_dev *sdev);
862extern struct snd_sof_dsp_ops sof_apl_ops;
863int sof_apl_ops_init(struct snd_sof_dev *sdev);
864extern struct snd_sof_dsp_ops sof_cnl_ops;
865int sof_cnl_ops_init(struct snd_sof_dev *sdev);
866extern struct snd_sof_dsp_ops sof_tgl_ops;
867int sof_tgl_ops_init(struct snd_sof_dev *sdev);
868extern struct snd_sof_dsp_ops sof_icl_ops;
869int sof_icl_ops_init(struct snd_sof_dev *sdev);
870extern struct snd_sof_dsp_ops sof_mtl_ops;
871int sof_mtl_ops_init(struct snd_sof_dev *sdev);
872extern struct snd_sof_dsp_ops sof_lnl_ops;
873int sof_lnl_ops_init(struct snd_sof_dev *sdev);
874
875extern const struct sof_intel_dsp_desc skl_chip_info;
876extern const struct sof_intel_dsp_desc apl_chip_info;
877extern const struct sof_intel_dsp_desc cnl_chip_info;
878extern const struct sof_intel_dsp_desc icl_chip_info;
879extern const struct sof_intel_dsp_desc tgl_chip_info;
880extern const struct sof_intel_dsp_desc tglh_chip_info;
881extern const struct sof_intel_dsp_desc ehl_chip_info;
882extern const struct sof_intel_dsp_desc jsl_chip_info;
883extern const struct sof_intel_dsp_desc adls_chip_info;
884extern const struct sof_intel_dsp_desc mtl_chip_info;
885extern const struct sof_intel_dsp_desc arl_s_chip_info;
886extern const struct sof_intel_dsp_desc lnl_chip_info;
887
888/* Probes support */
889#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_PROBES)
890int hda_probes_register(struct snd_sof_dev *sdev);
891void hda_probes_unregister(struct snd_sof_dev *sdev);
892#else
893static inline int hda_probes_register(struct snd_sof_dev *sdev)
894{
895 return 0;
896}
897
898static inline void hda_probes_unregister(struct snd_sof_dev *sdev)
899{
900}
901#endif /* CONFIG_SND_SOC_SOF_HDA_PROBES */
902
903/* SOF client registration for HDA platforms */
904int hda_register_clients(struct snd_sof_dev *sdev);
905void hda_unregister_clients(struct snd_sof_dev *sdev);
906
907/* machine driver select */
908struct snd_soc_acpi_mach *hda_machine_select(struct snd_sof_dev *sdev);
909void hda_set_mach_params(struct snd_soc_acpi_mach *mach,
910 struct snd_sof_dev *sdev);
911
912/* PCI driver selection and probe */
913int hda_pci_intel_probe(struct pci_dev *pci, const struct pci_device_id *pci_id);
914
915struct snd_sof_dai;
916struct sof_ipc_dai_config;
917
918#define SOF_HDA_POSITION_QUIRK_USE_SKYLAKE_LEGACY (0) /* previous implementation */
919#define SOF_HDA_POSITION_QUIRK_USE_DPIB_REGISTERS (1) /* recommended if VC0 only */
920#define SOF_HDA_POSITION_QUIRK_USE_DPIB_DDR_UPDATE (2) /* recommended with VC0 or VC1 */
921
922extern int sof_hda_position_quirk;
923
924void hda_set_dai_drv_ops(struct snd_sof_dev *sdev, struct snd_sof_dsp_ops *ops);
925void hda_ops_free(struct snd_sof_dev *sdev);
926
927/* SKL/KBL */
928int hda_dsp_cl_boot_firmware_skl(struct snd_sof_dev *sdev);
929int hda_dsp_core_stall_reset(struct snd_sof_dev *sdev, unsigned int core_mask);
930
931/* IPC4 */
932irqreturn_t cnl_ipc4_irq_thread(int irq, void *context);
933int cnl_ipc4_send_msg(struct snd_sof_dev *sdev, struct snd_sof_ipc_msg *msg);
934irqreturn_t hda_dsp_ipc4_irq_thread(int irq, void *context);
935bool hda_ipc4_tx_is_busy(struct snd_sof_dev *sdev);
936void hda_dsp_ipc4_schedule_d0i3_work(struct sof_intel_hda_dev *hdev,
937 struct snd_sof_ipc_msg *msg);
938int hda_dsp_ipc4_send_msg(struct snd_sof_dev *sdev, struct snd_sof_ipc_msg *msg);
939void hda_ipc4_dump(struct snd_sof_dev *sdev);
940extern struct sdw_intel_ops sdw_callback;
941
942struct sof_ipc4_fw_library;
943int hda_dsp_ipc4_load_library(struct snd_sof_dev *sdev,
944 struct sof_ipc4_fw_library *fw_lib, bool reload);
945
946/**
947 * struct hda_dai_widget_dma_ops - DAI DMA ops optional by default unless specified otherwise
948 * @get_hext_stream: Mandatory function pointer to get the saved pointer to struct hdac_ext_stream
949 * @assign_hext_stream: Function pointer to assign a hdac_ext_stream
950 * @release_hext_stream: Function pointer to release the hdac_ext_stream
951 * @setup_hext_stream: Function pointer for hdac_ext_stream setup
952 * @reset_hext_stream: Function pointer for hdac_ext_stream reset
953 * @pre_trigger: Function pointer for DAI DMA pre-trigger actions
954 * @trigger: Function pointer for DAI DMA trigger actions
955 * @post_trigger: Function pointer for DAI DMA post-trigger actions
956 * @codec_dai_set_stream: Function pointer to set codec-side stream information
957 * @calc_stream_format: Function pointer to determine stream format from hw_params and
958 * for HDaudio codec DAI from the .sig bits
959 * @get_hlink: Mandatory function pointer to retrieve hlink, mainly to program LOSIDV
960 * for legacy HDaudio links or program HDaudio Extended Link registers.
961 */
962struct hda_dai_widget_dma_ops {
963 struct hdac_ext_stream *(*get_hext_stream)(struct snd_sof_dev *sdev,
964 struct snd_soc_dai *cpu_dai,
965 struct snd_pcm_substream *substream);
966 struct hdac_ext_stream *(*assign_hext_stream)(struct snd_sof_dev *sdev,
967 struct snd_soc_dai *cpu_dai,
968 struct snd_pcm_substream *substream);
969 void (*release_hext_stream)(struct snd_sof_dev *sdev, struct snd_soc_dai *cpu_dai,
970 struct snd_pcm_substream *substream);
971 void (*setup_hext_stream)(struct snd_sof_dev *sdev, struct hdac_ext_stream *hext_stream,
972 unsigned int format_val);
973 void (*reset_hext_stream)(struct snd_sof_dev *sdev, struct hdac_ext_stream *hext_sream);
974 int (*pre_trigger)(struct snd_sof_dev *sdev, struct snd_soc_dai *cpu_dai,
975 struct snd_pcm_substream *substream, int cmd);
976 int (*trigger)(struct snd_sof_dev *sdev, struct snd_soc_dai *cpu_dai,
977 struct snd_pcm_substream *substream, int cmd);
978 int (*post_trigger)(struct snd_sof_dev *sdev, struct snd_soc_dai *cpu_dai,
979 struct snd_pcm_substream *substream, int cmd);
980 void (*codec_dai_set_stream)(struct snd_sof_dev *sdev,
981 struct snd_pcm_substream *substream,
982 struct hdac_stream *hstream);
983 unsigned int (*calc_stream_format)(struct snd_sof_dev *sdev,
984 struct snd_pcm_substream *substream,
985 struct snd_pcm_hw_params *params);
986 struct hdac_ext_link * (*get_hlink)(struct snd_sof_dev *sdev,
987 struct snd_pcm_substream *substream);
988};
989
990const struct hda_dai_widget_dma_ops *
991hda_select_dai_widget_ops(struct snd_sof_dev *sdev, struct snd_sof_widget *swidget);
992int hda_dai_config(struct snd_soc_dapm_widget *w, unsigned int flags,
993 struct snd_sof_dai_config_data *data);
994int hda_link_dma_cleanup(struct snd_pcm_substream *substream, struct hdac_ext_stream *hext_stream,
995 struct snd_soc_dai *cpu_dai);
996
997#endif
1/* SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause) */
2/*
3 * This file is provided under a dual BSD/GPLv2 license. When using or
4 * redistributing this file, you may do so under either license.
5 *
6 * Copyright(c) 2017 Intel Corporation. All rights reserved.
7 *
8 * Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
9 */
10
11#ifndef __SOF_INTEL_HDA_H
12#define __SOF_INTEL_HDA_H
13
14#include <linux/soundwire/sdw.h>
15#include <linux/soundwire/sdw_intel.h>
16#include <sound/compress_driver.h>
17#include <sound/hda_codec.h>
18#include <sound/hdaudio_ext.h>
19#include "shim.h"
20
21/* PCI registers */
22#define PCI_TCSEL 0x44
23#define PCI_PGCTL PCI_TCSEL
24#define PCI_CGCTL 0x48
25
26/* PCI_PGCTL bits */
27#define PCI_PGCTL_ADSPPGD BIT(2)
28#define PCI_PGCTL_LSRMD_MASK BIT(4)
29
30/* PCI_CGCTL bits */
31#define PCI_CGCTL_MISCBDCGE_MASK BIT(6)
32#define PCI_CGCTL_ADSPDCGE BIT(1)
33
34/* Legacy HDA registers and bits used - widths are variable */
35#define SOF_HDA_GCAP 0x0
36#define SOF_HDA_GCTL 0x8
37/* accept unsol. response enable */
38#define SOF_HDA_GCTL_UNSOL BIT(8)
39#define SOF_HDA_LLCH 0x14
40#define SOF_HDA_INTCTL 0x20
41#define SOF_HDA_INTSTS 0x24
42#define SOF_HDA_WAKESTS 0x0E
43#define SOF_HDA_WAKESTS_INT_MASK ((1 << 8) - 1)
44#define SOF_HDA_RIRBSTS 0x5d
45
46/* SOF_HDA_GCTL register bist */
47#define SOF_HDA_GCTL_RESET BIT(0)
48
49/* SOF_HDA_INCTL regs */
50#define SOF_HDA_INT_GLOBAL_EN BIT(31)
51#define SOF_HDA_INT_CTRL_EN BIT(30)
52#define SOF_HDA_INT_ALL_STREAM 0xff
53
54/* SOF_HDA_INTSTS regs */
55#define SOF_HDA_INTSTS_GIS BIT(31)
56
57#define SOF_HDA_MAX_CAPS 10
58#define SOF_HDA_CAP_ID_OFF 16
59#define SOF_HDA_CAP_ID_MASK GENMASK(SOF_HDA_CAP_ID_OFF + 11,\
60 SOF_HDA_CAP_ID_OFF)
61#define SOF_HDA_CAP_NEXT_MASK 0xFFFF
62
63#define SOF_HDA_GTS_CAP_ID 0x1
64#define SOF_HDA_ML_CAP_ID 0x2
65
66#define SOF_HDA_PP_CAP_ID 0x3
67#define SOF_HDA_REG_PP_PPCH 0x10
68#define SOF_HDA_REG_PP_PPCTL 0x04
69#define SOF_HDA_REG_PP_PPSTS 0x08
70#define SOF_HDA_PPCTL_PIE BIT(31)
71#define SOF_HDA_PPCTL_GPROCEN BIT(30)
72
73/*Vendor Specific Registers*/
74#define SOF_HDA_VS_D0I3C 0x104A
75
76/* D0I3C Register fields */
77#define SOF_HDA_VS_D0I3C_CIP BIT(0) /* Command-In-Progress */
78#define SOF_HDA_VS_D0I3C_I3 BIT(2) /* D0i3 enable bit */
79
80/* DPIB entry size: 8 Bytes = 2 DWords */
81#define SOF_HDA_DPIB_ENTRY_SIZE 0x8
82
83#define SOF_HDA_SPIB_CAP_ID 0x4
84#define SOF_HDA_DRSM_CAP_ID 0x5
85
86#define SOF_HDA_SPIB_BASE 0x08
87#define SOF_HDA_SPIB_INTERVAL 0x08
88#define SOF_HDA_SPIB_SPIB 0x00
89#define SOF_HDA_SPIB_MAXFIFO 0x04
90
91#define SOF_HDA_PPHC_BASE 0x10
92#define SOF_HDA_PPHC_INTERVAL 0x10
93
94#define SOF_HDA_PPLC_BASE 0x10
95#define SOF_HDA_PPLC_MULTI 0x10
96#define SOF_HDA_PPLC_INTERVAL 0x10
97
98#define SOF_HDA_DRSM_BASE 0x08
99#define SOF_HDA_DRSM_INTERVAL 0x08
100
101/* Descriptor error interrupt */
102#define SOF_HDA_CL_DMA_SD_INT_DESC_ERR 0x10
103
104/* FIFO error interrupt */
105#define SOF_HDA_CL_DMA_SD_INT_FIFO_ERR 0x08
106
107/* Buffer completion interrupt */
108#define SOF_HDA_CL_DMA_SD_INT_COMPLETE 0x04
109
110#define SOF_HDA_CL_DMA_SD_INT_MASK \
111 (SOF_HDA_CL_DMA_SD_INT_DESC_ERR | \
112 SOF_HDA_CL_DMA_SD_INT_FIFO_ERR | \
113 SOF_HDA_CL_DMA_SD_INT_COMPLETE)
114#define SOF_HDA_SD_CTL_DMA_START 0x02 /* Stream DMA start bit */
115
116/* Intel HD Audio Code Loader DMA Registers */
117#define SOF_HDA_ADSP_LOADER_BASE 0x80
118#define SOF_HDA_ADSP_DPLBASE 0x70
119#define SOF_HDA_ADSP_DPUBASE 0x74
120#define SOF_HDA_ADSP_DPLBASE_ENABLE 0x01
121
122/* Stream Registers */
123#define SOF_HDA_ADSP_REG_CL_SD_CTL 0x00
124#define SOF_HDA_ADSP_REG_CL_SD_STS 0x03
125#define SOF_HDA_ADSP_REG_CL_SD_LPIB 0x04
126#define SOF_HDA_ADSP_REG_CL_SD_CBL 0x08
127#define SOF_HDA_ADSP_REG_CL_SD_LVI 0x0C
128#define SOF_HDA_ADSP_REG_CL_SD_FIFOW 0x0E
129#define SOF_HDA_ADSP_REG_CL_SD_FIFOSIZE 0x10
130#define SOF_HDA_ADSP_REG_CL_SD_FORMAT 0x12
131#define SOF_HDA_ADSP_REG_CL_SD_FIFOL 0x14
132#define SOF_HDA_ADSP_REG_CL_SD_BDLPL 0x18
133#define SOF_HDA_ADSP_REG_CL_SD_BDLPU 0x1C
134#define SOF_HDA_ADSP_SD_ENTRY_SIZE 0x20
135
136/* CL: Software Position Based FIFO Capability Registers */
137#define SOF_DSP_REG_CL_SPBFIFO \
138 (SOF_HDA_ADSP_LOADER_BASE + 0x20)
139#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPBFCH 0x0
140#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPBFCCTL 0x4
141#define SOF_HDA_ADSP_REG_CL_SPBFIFO_SPIB 0x8
142#define SOF_HDA_ADSP_REG_CL_SPBFIFO_MAXFIFOS 0xc
143
144/* Stream Number */
145#define SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT 20
146#define SOF_HDA_CL_SD_CTL_STREAM_TAG_MASK \
147 GENMASK(SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT + 3,\
148 SOF_HDA_CL_SD_CTL_STREAM_TAG_SHIFT)
149
150#define HDA_DSP_HDA_BAR 0
151#define HDA_DSP_PP_BAR 1
152#define HDA_DSP_SPIB_BAR 2
153#define HDA_DSP_DRSM_BAR 3
154#define HDA_DSP_BAR 4
155
156#define SRAM_WINDOW_OFFSET(x) (0x80000 + (x) * 0x20000)
157
158#define HDA_DSP_MBOX_OFFSET SRAM_WINDOW_OFFSET(0)
159
160#define HDA_DSP_PANIC_OFFSET(x) \
161 (((x) & 0xFFFFFF) + HDA_DSP_MBOX_OFFSET)
162
163/* SRAM window 0 FW "registers" */
164#define HDA_DSP_SRAM_REG_ROM_STATUS (HDA_DSP_MBOX_OFFSET + 0x0)
165#define HDA_DSP_SRAM_REG_ROM_ERROR (HDA_DSP_MBOX_OFFSET + 0x4)
166/* FW and ROM share offset 4 */
167#define HDA_DSP_SRAM_REG_FW_STATUS (HDA_DSP_MBOX_OFFSET + 0x4)
168#define HDA_DSP_SRAM_REG_FW_TRACEP (HDA_DSP_MBOX_OFFSET + 0x8)
169#define HDA_DSP_SRAM_REG_FW_END (HDA_DSP_MBOX_OFFSET + 0xc)
170
171#define HDA_DSP_MBOX_UPLINK_OFFSET 0x81000
172
173#define HDA_DSP_STREAM_RESET_TIMEOUT 300
174/*
175 * Timeout in us, for setting the stream RUN bit, during
176 * start/stop the stream. The timeout expires if new RUN bit
177 * value cannot be read back within the specified time.
178 */
179#define HDA_DSP_STREAM_RUN_TIMEOUT 300
180
181#define HDA_DSP_SPIB_ENABLE 1
182#define HDA_DSP_SPIB_DISABLE 0
183
184#define SOF_HDA_MAX_BUFFER_SIZE (32 * PAGE_SIZE)
185
186#define HDA_DSP_STACK_DUMP_SIZE 32
187
188/* ROM status/error values */
189#define HDA_DSP_ROM_STS_MASK GENMASK(23, 0)
190#define HDA_DSP_ROM_INIT 0x1
191#define HDA_DSP_ROM_FW_MANIFEST_LOADED 0x3
192#define HDA_DSP_ROM_FW_FW_LOADED 0x4
193#define HDA_DSP_ROM_FW_ENTERED 0x5
194#define HDA_DSP_ROM_RFW_START 0xf
195#define HDA_DSP_ROM_CSE_ERROR 40
196#define HDA_DSP_ROM_CSE_WRONG_RESPONSE 41
197#define HDA_DSP_ROM_IMR_TO_SMALL 42
198#define HDA_DSP_ROM_BASE_FW_NOT_FOUND 43
199#define HDA_DSP_ROM_CSE_VALIDATION_FAILED 44
200#define HDA_DSP_ROM_IPC_FATAL_ERROR 45
201#define HDA_DSP_ROM_L2_CACHE_ERROR 46
202#define HDA_DSP_ROM_LOAD_OFFSET_TO_SMALL 47
203#define HDA_DSP_ROM_API_PTR_INVALID 50
204#define HDA_DSP_ROM_BASEFW_INCOMPAT 51
205#define HDA_DSP_ROM_UNHANDLED_INTERRUPT 0xBEE00000
206#define HDA_DSP_ROM_MEMORY_HOLE_ECC 0xECC00000
207#define HDA_DSP_ROM_KERNEL_EXCEPTION 0xCAFE0000
208#define HDA_DSP_ROM_USER_EXCEPTION 0xBEEF0000
209#define HDA_DSP_ROM_UNEXPECTED_RESET 0xDECAF000
210#define HDA_DSP_ROM_NULL_FW_ENTRY 0x4c4c4e55
211#define HDA_DSP_IPC_PURGE_FW 0x01004000
212
213/* various timeout values */
214#define HDA_DSP_PU_TIMEOUT 50
215#define HDA_DSP_PD_TIMEOUT 50
216#define HDA_DSP_RESET_TIMEOUT_US 50000
217#define HDA_DSP_BASEFW_TIMEOUT_US 3000000
218#define HDA_DSP_INIT_TIMEOUT_US 500000
219#define HDA_DSP_CTRL_RESET_TIMEOUT 100
220#define HDA_DSP_WAIT_TIMEOUT 500 /* 500 msec */
221#define HDA_DSP_REG_POLL_INTERVAL_US 500 /* 0.5 msec */
222#define HDA_DSP_REG_POLL_RETRY_COUNT 50
223
224#define HDA_DSP_ADSPIC_IPC 1
225#define HDA_DSP_ADSPIS_IPC 1
226
227/* Intel HD Audio General DSP Registers */
228#define HDA_DSP_GEN_BASE 0x0
229#define HDA_DSP_REG_ADSPCS (HDA_DSP_GEN_BASE + 0x04)
230#define HDA_DSP_REG_ADSPIC (HDA_DSP_GEN_BASE + 0x08)
231#define HDA_DSP_REG_ADSPIS (HDA_DSP_GEN_BASE + 0x0C)
232#define HDA_DSP_REG_ADSPIC2 (HDA_DSP_GEN_BASE + 0x10)
233#define HDA_DSP_REG_ADSPIS2 (HDA_DSP_GEN_BASE + 0x14)
234
235#define HDA_DSP_REG_ADSPIS2_SNDW BIT(5)
236#define HDA_DSP_REG_SNDW_WAKE_STS 0x2C192
237
238/* Intel HD Audio Inter-Processor Communication Registers */
239#define HDA_DSP_IPC_BASE 0x40
240#define HDA_DSP_REG_HIPCT (HDA_DSP_IPC_BASE + 0x00)
241#define HDA_DSP_REG_HIPCTE (HDA_DSP_IPC_BASE + 0x04)
242#define HDA_DSP_REG_HIPCI (HDA_DSP_IPC_BASE + 0x08)
243#define HDA_DSP_REG_HIPCIE (HDA_DSP_IPC_BASE + 0x0C)
244#define HDA_DSP_REG_HIPCCTL (HDA_DSP_IPC_BASE + 0x10)
245
246/* Intel Vendor Specific Registers */
247#define HDA_VS_INTEL_EM2 0x1030
248#define HDA_VS_INTEL_EM2_L1SEN BIT(13)
249#define HDA_VS_INTEL_LTRP_GB_MASK 0x3F
250
251/* HIPCI */
252#define HDA_DSP_REG_HIPCI_BUSY BIT(31)
253#define HDA_DSP_REG_HIPCI_MSG_MASK 0x7FFFFFFF
254
255/* HIPCIE */
256#define HDA_DSP_REG_HIPCIE_DONE BIT(30)
257#define HDA_DSP_REG_HIPCIE_MSG_MASK 0x3FFFFFFF
258
259/* HIPCCTL */
260#define HDA_DSP_REG_HIPCCTL_DONE BIT(1)
261#define HDA_DSP_REG_HIPCCTL_BUSY BIT(0)
262
263/* HIPCT */
264#define HDA_DSP_REG_HIPCT_BUSY BIT(31)
265#define HDA_DSP_REG_HIPCT_MSG_MASK 0x7FFFFFFF
266
267/* HIPCTE */
268#define HDA_DSP_REG_HIPCTE_MSG_MASK 0x3FFFFFFF
269
270#define HDA_DSP_ADSPIC_CL_DMA 0x2
271#define HDA_DSP_ADSPIS_CL_DMA 0x2
272
273/* Delay before scheduling D0i3 entry */
274#define BXT_D0I3_DELAY 5000
275
276#define FW_CL_STREAM_NUMBER 0x1
277#define HDA_FW_BOOT_ATTEMPTS 3
278
279/* ADSPCS - Audio DSP Control & Status */
280
281/*
282 * Core Reset - asserted high
283 * CRST Mask for a given core mask pattern, cm
284 */
285#define HDA_DSP_ADSPCS_CRST_SHIFT 0
286#define HDA_DSP_ADSPCS_CRST_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CRST_SHIFT)
287
288/*
289 * Core run/stall - when set to '1' core is stalled
290 * CSTALL Mask for a given core mask pattern, cm
291 */
292#define HDA_DSP_ADSPCS_CSTALL_SHIFT 8
293#define HDA_DSP_ADSPCS_CSTALL_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CSTALL_SHIFT)
294
295/*
296 * Set Power Active - when set to '1' turn cores on
297 * SPA Mask for a given core mask pattern, cm
298 */
299#define HDA_DSP_ADSPCS_SPA_SHIFT 16
300#define HDA_DSP_ADSPCS_SPA_MASK(cm) ((cm) << HDA_DSP_ADSPCS_SPA_SHIFT)
301
302/*
303 * Current Power Active - power status of cores, set by hardware
304 * CPA Mask for a given core mask pattern, cm
305 */
306#define HDA_DSP_ADSPCS_CPA_SHIFT 24
307#define HDA_DSP_ADSPCS_CPA_MASK(cm) ((cm) << HDA_DSP_ADSPCS_CPA_SHIFT)
308
309/*
310 * Mask for a given number of cores
311 * nc = number of supported cores
312 */
313#define SOF_DSP_CORES_MASK(nc) GENMASK(((nc) - 1), 0)
314
315/* Intel HD Audio Inter-Processor Communication Registers for Cannonlake*/
316#define CNL_DSP_IPC_BASE 0xc0
317#define CNL_DSP_REG_HIPCTDR (CNL_DSP_IPC_BASE + 0x00)
318#define CNL_DSP_REG_HIPCTDA (CNL_DSP_IPC_BASE + 0x04)
319#define CNL_DSP_REG_HIPCTDD (CNL_DSP_IPC_BASE + 0x08)
320#define CNL_DSP_REG_HIPCIDR (CNL_DSP_IPC_BASE + 0x10)
321#define CNL_DSP_REG_HIPCIDA (CNL_DSP_IPC_BASE + 0x14)
322#define CNL_DSP_REG_HIPCIDD (CNL_DSP_IPC_BASE + 0x18)
323#define CNL_DSP_REG_HIPCCTL (CNL_DSP_IPC_BASE + 0x28)
324
325/* HIPCI */
326#define CNL_DSP_REG_HIPCIDR_BUSY BIT(31)
327#define CNL_DSP_REG_HIPCIDR_MSG_MASK 0x7FFFFFFF
328
329/* HIPCIE */
330#define CNL_DSP_REG_HIPCIDA_DONE BIT(31)
331#define CNL_DSP_REG_HIPCIDA_MSG_MASK 0x7FFFFFFF
332
333/* HIPCCTL */
334#define CNL_DSP_REG_HIPCCTL_DONE BIT(1)
335#define CNL_DSP_REG_HIPCCTL_BUSY BIT(0)
336
337/* HIPCT */
338#define CNL_DSP_REG_HIPCTDR_BUSY BIT(31)
339#define CNL_DSP_REG_HIPCTDR_MSG_MASK 0x7FFFFFFF
340
341/* HIPCTDA */
342#define CNL_DSP_REG_HIPCTDA_DONE BIT(31)
343#define CNL_DSP_REG_HIPCTDA_MSG_MASK 0x7FFFFFFF
344
345/* HIPCTDD */
346#define CNL_DSP_REG_HIPCTDD_MSG_MASK 0x7FFFFFFF
347
348/* BDL */
349#define HDA_DSP_BDL_SIZE 4096
350#define HDA_DSP_MAX_BDL_ENTRIES \
351 (HDA_DSP_BDL_SIZE / sizeof(struct sof_intel_dsp_bdl))
352
353/* Number of DAIs */
354#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
355
356#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_PROBES)
357#define SOF_SKL_NUM_DAIS 16
358#else
359#define SOF_SKL_NUM_DAIS 15
360#endif
361
362#else
363#define SOF_SKL_NUM_DAIS 8
364#endif
365
366/* Intel HD Audio SRAM Window 0*/
367#define HDA_ADSP_SRAM0_BASE_SKL 0x8000
368
369/* Firmware status window */
370#define HDA_ADSP_FW_STATUS_SKL HDA_ADSP_SRAM0_BASE_SKL
371#define HDA_ADSP_ERROR_CODE_SKL (HDA_ADSP_FW_STATUS_SKL + 0x4)
372
373/* Host Device Memory Space */
374#define APL_SSP_BASE_OFFSET 0x2000
375#define CNL_SSP_BASE_OFFSET 0x10000
376
377/* Host Device Memory Size of a Single SSP */
378#define SSP_DEV_MEM_SIZE 0x1000
379
380/* SSP Count of the Platform */
381#define APL_SSP_COUNT 6
382#define CNL_SSP_COUNT 3
383#define ICL_SSP_COUNT 6
384
385/* SSP Registers */
386#define SSP_SSC1_OFFSET 0x4
387#define SSP_SET_SCLK_SLAVE BIT(25)
388#define SSP_SET_SFRM_SLAVE BIT(24)
389#define SSP_SET_SLAVE (SSP_SET_SCLK_SLAVE | SSP_SET_SFRM_SLAVE)
390
391#define HDA_IDISP_ADDR 2
392#define HDA_IDISP_CODEC(x) ((x) & BIT(HDA_IDISP_ADDR))
393
394struct sof_intel_dsp_bdl {
395 __le32 addr_l;
396 __le32 addr_h;
397 __le32 size;
398 __le32 ioc;
399} __attribute((packed));
400
401#define SOF_HDA_PLAYBACK_STREAMS 16
402#define SOF_HDA_CAPTURE_STREAMS 16
403#define SOF_HDA_PLAYBACK 0
404#define SOF_HDA_CAPTURE 1
405
406/* stream flags */
407#define SOF_HDA_STREAM_DMI_L1_COMPATIBLE 1
408
409/*
410 * Time in ms for opportunistic D0I3 entry delay.
411 * This has been deliberately chosen to be long to avoid race conditions.
412 * Could be optimized in future.
413 */
414#define SOF_HDA_D0I3_WORK_DELAY_MS 5000
415
416/* HDA DSP D0 substate */
417enum sof_hda_D0_substate {
418 SOF_HDA_DSP_PM_D0I0, /* default D0 substate */
419 SOF_HDA_DSP_PM_D0I3, /* low power D0 substate */
420};
421
422/* represents DSP HDA controller frontend - i.e. host facing control */
423struct sof_intel_hda_dev {
424 int boot_iteration;
425
426 struct hda_bus hbus;
427
428 /* hw config */
429 const struct sof_intel_dsp_desc *desc;
430
431 /* trace */
432 struct hdac_ext_stream *dtrace_stream;
433
434 /* if position update IPC needed */
435 u32 no_ipc_position;
436
437 /* the maximum number of streams (playback + capture) supported */
438 u32 stream_max;
439
440 /* PM related */
441 bool l1_support_changed;/* during suspend, is L1SEN changed or not */
442
443 /* DMIC device */
444 struct platform_device *dmic_dev;
445
446 /* delayed work to enter D0I3 opportunistically */
447 struct delayed_work d0i3_work;
448
449 /* ACPI information stored between scan and probe steps */
450 struct sdw_intel_acpi_info info;
451
452 /* sdw context allocated by SoundWire driver */
453 struct sdw_intel_ctx *sdw;
454
455 /* FW clock config, 0:HPRO, 1:LPRO */
456 bool clk_config_lpro;
457};
458
459static inline struct hdac_bus *sof_to_bus(struct snd_sof_dev *s)
460{
461 struct sof_intel_hda_dev *hda = s->pdata->hw_pdata;
462
463 return &hda->hbus.core;
464}
465
466static inline struct hda_bus *sof_to_hbus(struct snd_sof_dev *s)
467{
468 struct sof_intel_hda_dev *hda = s->pdata->hw_pdata;
469
470 return &hda->hbus;
471}
472
473struct sof_intel_hda_stream {
474 struct snd_sof_dev *sdev;
475 struct hdac_ext_stream hda_stream;
476 struct sof_intel_stream stream;
477 int host_reserved; /* reserve host DMA channel */
478 u32 flags;
479};
480
481#define hstream_to_sof_hda_stream(hstream) \
482 container_of(hstream, struct sof_intel_hda_stream, hda_stream)
483
484#define bus_to_sof_hda(bus) \
485 container_of(bus, struct sof_intel_hda_dev, hbus.core)
486
487#define SOF_STREAM_SD_OFFSET(s) \
488 (SOF_HDA_ADSP_SD_ENTRY_SIZE * ((s)->index) \
489 + SOF_HDA_ADSP_LOADER_BASE)
490
491/*
492 * DSP Core services.
493 */
494int hda_dsp_probe(struct snd_sof_dev *sdev);
495int hda_dsp_remove(struct snd_sof_dev *sdev);
496int hda_dsp_core_reset_enter(struct snd_sof_dev *sdev,
497 unsigned int core_mask);
498int hda_dsp_core_reset_leave(struct snd_sof_dev *sdev,
499 unsigned int core_mask);
500int hda_dsp_core_stall_reset(struct snd_sof_dev *sdev, unsigned int core_mask);
501int hda_dsp_core_run(struct snd_sof_dev *sdev, unsigned int core_mask);
502int hda_dsp_core_power_up(struct snd_sof_dev *sdev, unsigned int core_mask);
503int hda_dsp_enable_core(struct snd_sof_dev *sdev, unsigned int core_mask);
504int hda_dsp_core_power_down(struct snd_sof_dev *sdev, unsigned int core_mask);
505bool hda_dsp_core_is_enabled(struct snd_sof_dev *sdev,
506 unsigned int core_mask);
507int hda_dsp_core_reset_power_down(struct snd_sof_dev *sdev,
508 unsigned int core_mask);
509void hda_dsp_ipc_int_enable(struct snd_sof_dev *sdev);
510void hda_dsp_ipc_int_disable(struct snd_sof_dev *sdev);
511
512int hda_dsp_set_power_state(struct snd_sof_dev *sdev,
513 const struct sof_dsp_power_state *target_state);
514
515int hda_dsp_suspend(struct snd_sof_dev *sdev, u32 target_state);
516int hda_dsp_resume(struct snd_sof_dev *sdev);
517int hda_dsp_runtime_suspend(struct snd_sof_dev *sdev);
518int hda_dsp_runtime_resume(struct snd_sof_dev *sdev);
519int hda_dsp_runtime_idle(struct snd_sof_dev *sdev);
520int hda_dsp_shutdown(struct snd_sof_dev *sdev);
521int hda_dsp_set_hw_params_upon_resume(struct snd_sof_dev *sdev);
522void hda_dsp_dump(struct snd_sof_dev *sdev, u32 flags);
523void hda_ipc_dump(struct snd_sof_dev *sdev);
524void hda_ipc_irq_dump(struct snd_sof_dev *sdev);
525void hda_dsp_d0i3_work(struct work_struct *work);
526
527/*
528 * DSP PCM Operations.
529 */
530u32 hda_dsp_get_mult_div(struct snd_sof_dev *sdev, int rate);
531u32 hda_dsp_get_bits(struct snd_sof_dev *sdev, int sample_bits);
532int hda_dsp_pcm_open(struct snd_sof_dev *sdev,
533 struct snd_pcm_substream *substream);
534int hda_dsp_pcm_close(struct snd_sof_dev *sdev,
535 struct snd_pcm_substream *substream);
536int hda_dsp_pcm_hw_params(struct snd_sof_dev *sdev,
537 struct snd_pcm_substream *substream,
538 struct snd_pcm_hw_params *params,
539 struct sof_ipc_stream_params *ipc_params);
540int hda_dsp_stream_hw_free(struct snd_sof_dev *sdev,
541 struct snd_pcm_substream *substream);
542int hda_dsp_pcm_trigger(struct snd_sof_dev *sdev,
543 struct snd_pcm_substream *substream, int cmd);
544snd_pcm_uframes_t hda_dsp_pcm_pointer(struct snd_sof_dev *sdev,
545 struct snd_pcm_substream *substream);
546
547/*
548 * DSP Stream Operations.
549 */
550
551int hda_dsp_stream_init(struct snd_sof_dev *sdev);
552void hda_dsp_stream_free(struct snd_sof_dev *sdev);
553int hda_dsp_stream_hw_params(struct snd_sof_dev *sdev,
554 struct hdac_ext_stream *stream,
555 struct snd_dma_buffer *dmab,
556 struct snd_pcm_hw_params *params);
557int hda_dsp_iccmax_stream_hw_params(struct snd_sof_dev *sdev, struct hdac_ext_stream *stream,
558 struct snd_dma_buffer *dmab,
559 struct snd_pcm_hw_params *params);
560int hda_dsp_stream_trigger(struct snd_sof_dev *sdev,
561 struct hdac_ext_stream *stream, int cmd);
562irqreturn_t hda_dsp_stream_threaded_handler(int irq, void *context);
563int hda_dsp_stream_setup_bdl(struct snd_sof_dev *sdev,
564 struct snd_dma_buffer *dmab,
565 struct hdac_stream *stream);
566bool hda_dsp_check_ipc_irq(struct snd_sof_dev *sdev);
567bool hda_dsp_check_stream_irq(struct snd_sof_dev *sdev);
568
569struct hdac_ext_stream *
570 hda_dsp_stream_get(struct snd_sof_dev *sdev, int direction, u32 flags);
571int hda_dsp_stream_put(struct snd_sof_dev *sdev, int direction, int stream_tag);
572int hda_dsp_stream_spib_config(struct snd_sof_dev *sdev,
573 struct hdac_ext_stream *stream,
574 int enable, u32 size);
575
576void hda_ipc_msg_data(struct snd_sof_dev *sdev,
577 struct snd_pcm_substream *substream,
578 void *p, size_t sz);
579int hda_ipc_pcm_params(struct snd_sof_dev *sdev,
580 struct snd_pcm_substream *substream,
581 const struct sof_ipc_pcm_params_reply *reply);
582
583#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA_PROBES)
584/*
585 * Probe Compress Operations.
586 */
587int hda_probe_compr_assign(struct snd_sof_dev *sdev,
588 struct snd_compr_stream *cstream,
589 struct snd_soc_dai *dai);
590int hda_probe_compr_free(struct snd_sof_dev *sdev,
591 struct snd_compr_stream *cstream,
592 struct snd_soc_dai *dai);
593int hda_probe_compr_set_params(struct snd_sof_dev *sdev,
594 struct snd_compr_stream *cstream,
595 struct snd_compr_params *params,
596 struct snd_soc_dai *dai);
597int hda_probe_compr_trigger(struct snd_sof_dev *sdev,
598 struct snd_compr_stream *cstream, int cmd,
599 struct snd_soc_dai *dai);
600int hda_probe_compr_pointer(struct snd_sof_dev *sdev,
601 struct snd_compr_stream *cstream,
602 struct snd_compr_tstamp *tstamp,
603 struct snd_soc_dai *dai);
604#endif
605
606/*
607 * DSP IPC Operations.
608 */
609int hda_dsp_ipc_send_msg(struct snd_sof_dev *sdev,
610 struct snd_sof_ipc_msg *msg);
611void hda_dsp_ipc_get_reply(struct snd_sof_dev *sdev);
612int hda_dsp_ipc_get_mailbox_offset(struct snd_sof_dev *sdev);
613int hda_dsp_ipc_get_window_offset(struct snd_sof_dev *sdev, u32 id);
614
615irqreturn_t hda_dsp_ipc_irq_thread(int irq, void *context);
616int hda_dsp_ipc_cmd_done(struct snd_sof_dev *sdev, int dir);
617
618/*
619 * DSP Code loader.
620 */
621int hda_dsp_cl_boot_firmware(struct snd_sof_dev *sdev);
622int hda_dsp_cl_boot_firmware_iccmax(struct snd_sof_dev *sdev);
623int hda_dsp_cl_boot_firmware_iccmax_icl(struct snd_sof_dev *sdev);
624int hda_dsp_cl_boot_firmware_skl(struct snd_sof_dev *sdev);
625
626/* pre and post fw run ops */
627int hda_dsp_pre_fw_run(struct snd_sof_dev *sdev);
628int hda_dsp_post_fw_run(struct snd_sof_dev *sdev);
629int hda_dsp_post_fw_run_icl(struct snd_sof_dev *sdev);
630int hda_dsp_core_stall_icl(struct snd_sof_dev *sdev, unsigned int core_mask);
631
632/* parse platform specific ext manifest ops */
633int hda_dsp_ext_man_get_cavs_config_data(struct snd_sof_dev *sdev,
634 const struct sof_ext_man_elem_header *hdr);
635
636/*
637 * HDA Controller Operations.
638 */
639int hda_dsp_ctrl_get_caps(struct snd_sof_dev *sdev);
640void hda_dsp_ctrl_ppcap_enable(struct snd_sof_dev *sdev, bool enable);
641void hda_dsp_ctrl_ppcap_int_enable(struct snd_sof_dev *sdev, bool enable);
642int hda_dsp_ctrl_link_reset(struct snd_sof_dev *sdev, bool reset);
643void hda_dsp_ctrl_misc_clock_gating(struct snd_sof_dev *sdev, bool enable);
644int hda_dsp_ctrl_clock_power_gating(struct snd_sof_dev *sdev, bool enable);
645int hda_dsp_ctrl_init_chip(struct snd_sof_dev *sdev, bool full_reset);
646void hda_dsp_ctrl_stop_chip(struct snd_sof_dev *sdev);
647/*
648 * HDA bus operations.
649 */
650void sof_hda_bus_init(struct hdac_bus *bus, struct device *dev);
651
652#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA)
653/*
654 * HDA Codec operations.
655 */
656void hda_codec_probe_bus(struct snd_sof_dev *sdev,
657 bool hda_codec_use_common_hdmi);
658void hda_codec_jack_wake_enable(struct snd_sof_dev *sdev, bool enable);
659void hda_codec_jack_check(struct snd_sof_dev *sdev);
660
661#endif /* CONFIG_SND_SOC_SOF_HDA */
662
663#if IS_ENABLED(CONFIG_SND_SOC_SOF_HDA) && \
664 (IS_ENABLED(CONFIG_SND_HDA_CODEC_HDMI) || \
665 IS_ENABLED(CONFIG_SND_SOC_HDAC_HDMI))
666
667void hda_codec_i915_display_power(struct snd_sof_dev *sdev, bool enable);
668int hda_codec_i915_init(struct snd_sof_dev *sdev);
669int hda_codec_i915_exit(struct snd_sof_dev *sdev);
670
671#else
672
673static inline void hda_codec_i915_display_power(struct snd_sof_dev *sdev,
674 bool enable) { }
675static inline int hda_codec_i915_init(struct snd_sof_dev *sdev) { return 0; }
676static inline int hda_codec_i915_exit(struct snd_sof_dev *sdev) { return 0; }
677
678#endif
679
680/*
681 * Trace Control.
682 */
683int hda_dsp_trace_init(struct snd_sof_dev *sdev, u32 *stream_tag);
684int hda_dsp_trace_release(struct snd_sof_dev *sdev);
685int hda_dsp_trace_trigger(struct snd_sof_dev *sdev, int cmd);
686
687/*
688 * SoundWire support
689 */
690#if IS_ENABLED(CONFIG_SND_SOC_SOF_INTEL_SOUNDWIRE)
691
692int hda_sdw_startup(struct snd_sof_dev *sdev);
693void hda_sdw_int_enable(struct snd_sof_dev *sdev, bool enable);
694void hda_sdw_process_wakeen(struct snd_sof_dev *sdev);
695
696#else
697
698static inline int hda_sdw_acpi_scan(struct snd_sof_dev *sdev)
699{
700 return 0;
701}
702
703static inline int hda_sdw_probe(struct snd_sof_dev *sdev)
704{
705 return 0;
706}
707
708static inline int hda_sdw_startup(struct snd_sof_dev *sdev)
709{
710 return 0;
711}
712
713static inline int hda_sdw_exit(struct snd_sof_dev *sdev)
714{
715 return 0;
716}
717
718static inline void hda_sdw_int_enable(struct snd_sof_dev *sdev, bool enable)
719{
720}
721
722static inline bool hda_dsp_check_sdw_irq(struct snd_sof_dev *sdev)
723{
724 return false;
725}
726
727static inline irqreturn_t hda_dsp_sdw_thread(int irq, void *context)
728{
729 return IRQ_HANDLED;
730}
731
732static inline bool hda_sdw_check_wakeen_irq(struct snd_sof_dev *sdev)
733{
734 return false;
735}
736
737static inline void hda_sdw_process_wakeen(struct snd_sof_dev *sdev)
738{
739}
740#endif
741
742/* common dai driver */
743extern struct snd_soc_dai_driver skl_dai[];
744
745/*
746 * Platform Specific HW abstraction Ops.
747 */
748extern const struct snd_sof_dsp_ops sof_apl_ops;
749extern const struct snd_sof_dsp_ops sof_cnl_ops;
750extern const struct snd_sof_dsp_ops sof_tgl_ops;
751extern const struct snd_sof_dsp_ops sof_icl_ops;
752
753extern const struct sof_intel_dsp_desc apl_chip_info;
754extern const struct sof_intel_dsp_desc cnl_chip_info;
755extern const struct sof_intel_dsp_desc skl_chip_info;
756extern const struct sof_intel_dsp_desc icl_chip_info;
757extern const struct sof_intel_dsp_desc tgl_chip_info;
758extern const struct sof_intel_dsp_desc tglh_chip_info;
759extern const struct sof_intel_dsp_desc ehl_chip_info;
760extern const struct sof_intel_dsp_desc jsl_chip_info;
761extern const struct sof_intel_dsp_desc adls_chip_info;
762
763/* machine driver select */
764void hda_machine_select(struct snd_sof_dev *sdev);
765void hda_set_mach_params(const struct snd_soc_acpi_mach *mach,
766 struct snd_sof_dev *sdev);
767
768/* PCI driver selection and probe */
769int hda_pci_intel_probe(struct pci_dev *pci, const struct pci_device_id *pci_id);
770
771#endif