xref: /openbmc/linux/sound/soc/sof/intel/shim.h (revision c900529f3d9161bfde5cca0754f83b4d3c3e0220)
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_SHIM_H
12  #define __SOF_INTEL_SHIM_H
13  
14  enum sof_intel_hw_ip_version {
15  	SOF_INTEL_TANGIER,
16  	SOF_INTEL_BAYTRAIL,
17  	SOF_INTEL_BROADWELL,
18  	SOF_INTEL_CAVS_1_5,	/* SkyLake, KabyLake, AmberLake */
19  	SOF_INTEL_CAVS_1_5_PLUS,/* ApolloLake, GeminiLake */
20  	SOF_INTEL_CAVS_1_8,	/* CannonLake, CometLake, CoffeeLake */
21  	SOF_INTEL_CAVS_2_0,	/* IceLake, JasperLake */
22  	SOF_INTEL_CAVS_2_5,	/* TigerLake, AlderLake */
23  	SOF_INTEL_ACE_1_0,	/* MeteorLake */
24  	SOF_INTEL_ACE_2_0,	/* LunarLake */
25  };
26  
27  /*
28   * SHIM registers for BYT, BSW, CHT, BDW
29   */
30  
31  #define SHIM_CSR		(SHIM_OFFSET + 0x00)
32  #define SHIM_PISR		(SHIM_OFFSET + 0x08)
33  #define SHIM_PIMR		(SHIM_OFFSET + 0x10)
34  #define SHIM_ISRX		(SHIM_OFFSET + 0x18)
35  #define SHIM_ISRD		(SHIM_OFFSET + 0x20)
36  #define SHIM_IMRX		(SHIM_OFFSET + 0x28)
37  #define SHIM_IMRD		(SHIM_OFFSET + 0x30)
38  #define SHIM_IPCX		(SHIM_OFFSET + 0x38)
39  #define SHIM_IPCD		(SHIM_OFFSET + 0x40)
40  #define SHIM_ISRSC		(SHIM_OFFSET + 0x48)
41  #define SHIM_ISRLPESC		(SHIM_OFFSET + 0x50)
42  #define SHIM_IMRSC		(SHIM_OFFSET + 0x58)
43  #define SHIM_IMRLPESC		(SHIM_OFFSET + 0x60)
44  #define SHIM_IPCSC		(SHIM_OFFSET + 0x68)
45  #define SHIM_IPCLPESC		(SHIM_OFFSET + 0x70)
46  #define SHIM_CLKCTL		(SHIM_OFFSET + 0x78)
47  #define SHIM_CSR2		(SHIM_OFFSET + 0x80)
48  #define SHIM_LTRC		(SHIM_OFFSET + 0xE0)
49  #define SHIM_HMDC		(SHIM_OFFSET + 0xE8)
50  
51  #define SHIM_PWMCTRL		0x1000
52  
53  /*
54   * SST SHIM register bits for BYT, BSW, CHT, BDW
55   * Register bit naming and functionaility can differ between devices.
56   */
57  
58  /* CSR / CS */
59  #define SHIM_CSR_RST		BIT(1)
60  #define SHIM_CSR_SBCS0		BIT(2)
61  #define SHIM_CSR_SBCS1		BIT(3)
62  #define SHIM_CSR_DCS(x)		((x) << 4)
63  #define SHIM_CSR_DCS_MASK	(0x7 << 4)
64  #define SHIM_CSR_STALL		BIT(10)
65  #define SHIM_CSR_S0IOCS		BIT(21)
66  #define SHIM_CSR_S1IOCS		BIT(23)
67  #define SHIM_CSR_LPCS		BIT(31)
68  #define SHIM_CSR_24MHZ_LPCS \
69  	(SHIM_CSR_SBCS0 | SHIM_CSR_SBCS1 | SHIM_CSR_LPCS)
70  #define SHIM_CSR_24MHZ_NO_LPCS	(SHIM_CSR_SBCS0 | SHIM_CSR_SBCS1)
71  #define SHIM_BYT_CSR_RST	BIT(0)
72  #define SHIM_BYT_CSR_VECTOR_SEL	BIT(1)
73  #define SHIM_BYT_CSR_STALL	BIT(2)
74  #define SHIM_BYT_CSR_PWAITMODE	BIT(3)
75  
76  /*  ISRX / ISC */
77  #define SHIM_ISRX_BUSY		BIT(1)
78  #define SHIM_ISRX_DONE		BIT(0)
79  #define SHIM_BYT_ISRX_REQUEST	BIT(1)
80  
81  /*  ISRD / ISD */
82  #define SHIM_ISRD_BUSY		BIT(1)
83  #define SHIM_ISRD_DONE		BIT(0)
84  
85  /* IMRX / IMC */
86  #define SHIM_IMRX_BUSY		BIT(1)
87  #define SHIM_IMRX_DONE		BIT(0)
88  #define SHIM_BYT_IMRX_REQUEST	BIT(1)
89  
90  /* IMRD / IMD */
91  #define SHIM_IMRD_DONE		BIT(0)
92  #define SHIM_IMRD_BUSY		BIT(1)
93  #define SHIM_IMRD_SSP0		BIT(16)
94  #define SHIM_IMRD_DMAC0		BIT(21)
95  #define SHIM_IMRD_DMAC1		BIT(22)
96  #define SHIM_IMRD_DMAC		(SHIM_IMRD_DMAC0 | SHIM_IMRD_DMAC1)
97  
98  /*  IPCX / IPCC */
99  #define	SHIM_IPCX_DONE		BIT(30)
100  #define	SHIM_IPCX_BUSY		BIT(31)
101  #define SHIM_BYT_IPCX_DONE	BIT_ULL(62)
102  #define SHIM_BYT_IPCX_BUSY	BIT_ULL(63)
103  
104  /*  IPCD */
105  #define	SHIM_IPCD_DONE		BIT(30)
106  #define	SHIM_IPCD_BUSY		BIT(31)
107  #define SHIM_BYT_IPCD_DONE	BIT_ULL(62)
108  #define SHIM_BYT_IPCD_BUSY	BIT_ULL(63)
109  
110  /* CLKCTL */
111  #define SHIM_CLKCTL_SMOS(x)	((x) << 24)
112  #define SHIM_CLKCTL_MASK	(3 << 24)
113  #define SHIM_CLKCTL_DCPLCG	BIT(18)
114  #define SHIM_CLKCTL_SCOE1	BIT(17)
115  #define SHIM_CLKCTL_SCOE0	BIT(16)
116  
117  /* CSR2 / CS2 */
118  #define SHIM_CSR2_SDFD_SSP0	BIT(1)
119  #define SHIM_CSR2_SDFD_SSP1	BIT(2)
120  
121  /* LTRC */
122  #define SHIM_LTRC_VAL(x)	((x) << 0)
123  
124  /* HMDC */
125  #define SHIM_HMDC_HDDA0(x)	((x) << 0)
126  #define SHIM_HMDC_HDDA1(x)	((x) << 7)
127  #define SHIM_HMDC_HDDA_E0_CH0	1
128  #define SHIM_HMDC_HDDA_E0_CH1	2
129  #define SHIM_HMDC_HDDA_E0_CH2	4
130  #define SHIM_HMDC_HDDA_E0_CH3	8
131  #define SHIM_HMDC_HDDA_E1_CH0	SHIM_HMDC_HDDA1(SHIM_HMDC_HDDA_E0_CH0)
132  #define SHIM_HMDC_HDDA_E1_CH1	SHIM_HMDC_HDDA1(SHIM_HMDC_HDDA_E0_CH1)
133  #define SHIM_HMDC_HDDA_E1_CH2	SHIM_HMDC_HDDA1(SHIM_HMDC_HDDA_E0_CH2)
134  #define SHIM_HMDC_HDDA_E1_CH3	SHIM_HMDC_HDDA1(SHIM_HMDC_HDDA_E0_CH3)
135  #define SHIM_HMDC_HDDA_E0_ALLCH	\
136  	(SHIM_HMDC_HDDA_E0_CH0 | SHIM_HMDC_HDDA_E0_CH1 | \
137  	 SHIM_HMDC_HDDA_E0_CH2 | SHIM_HMDC_HDDA_E0_CH3)
138  #define SHIM_HMDC_HDDA_E1_ALLCH	\
139  	(SHIM_HMDC_HDDA_E1_CH0 | SHIM_HMDC_HDDA_E1_CH1 | \
140  	 SHIM_HMDC_HDDA_E1_CH2 | SHIM_HMDC_HDDA_E1_CH3)
141  
142  /* Audio DSP PCI registers */
143  #define PCI_VDRTCTL0		0xa0
144  #define PCI_VDRTCTL1		0xa4
145  #define PCI_VDRTCTL2		0xa8
146  #define PCI_VDRTCTL3		0xaC
147  
148  /* VDRTCTL0 */
149  #define PCI_VDRTCL0_D3PGD		BIT(0)
150  #define PCI_VDRTCL0_D3SRAMPGD		BIT(1)
151  #define PCI_VDRTCL0_DSRAMPGE_SHIFT	12
152  #define PCI_VDRTCL0_DSRAMPGE_MASK	GENMASK(PCI_VDRTCL0_DSRAMPGE_SHIFT + 19,\
153  						PCI_VDRTCL0_DSRAMPGE_SHIFT)
154  #define PCI_VDRTCL0_ISRAMPGE_SHIFT	2
155  #define PCI_VDRTCL0_ISRAMPGE_MASK	GENMASK(PCI_VDRTCL0_ISRAMPGE_SHIFT + 9,\
156  						PCI_VDRTCL0_ISRAMPGE_SHIFT)
157  
158  /* VDRTCTL2 */
159  #define PCI_VDRTCL2_DCLCGE		BIT(1)
160  #define PCI_VDRTCL2_DTCGE		BIT(10)
161  #define PCI_VDRTCL2_APLLSE_MASK		BIT(31)
162  
163  /* PMCS */
164  #define PCI_PMCS		0x84
165  #define PCI_PMCS_PS_MASK	0x3
166  
167  /* Intel quirks */
168  #define SOF_INTEL_PROCEN_FMT_QUIRK BIT(0)
169  
170  /* DSP hardware descriptor */
171  struct sof_intel_dsp_desc {
172  	int cores_num;
173  	int host_managed_cores_mask;
174  	int init_core_mask; /* cores available after fw boot */
175  	int ipc_req;
176  	int ipc_req_mask;
177  	int ipc_ack;
178  	int ipc_ack_mask;
179  	int ipc_ctl;
180  	int rom_status_reg;
181  	int rom_init_timeout;
182  	int ssp_count;			/* ssp count of the platform */
183  	int ssp_base_offset;		/* base address of the SSPs */
184  	u32 sdw_shim_base;
185  	u32 sdw_alh_base;
186  	u32 d0i3_offset;
187  	u32 quirks;
188  	enum sof_intel_hw_ip_version hw_ip_version;
189  	int (*read_sdw_lcount)(struct snd_sof_dev *sdev);
190  	void (*enable_sdw_irq)(struct snd_sof_dev *sdev, bool enable);
191  	bool (*check_sdw_irq)(struct snd_sof_dev *sdev);
192  	bool (*check_sdw_wakeen_irq)(struct snd_sof_dev *sdev);
193  	bool (*check_ipc_irq)(struct snd_sof_dev *sdev);
194  	int (*power_down_dsp)(struct snd_sof_dev *sdev);
195  	int (*disable_interrupts)(struct snd_sof_dev *sdev);
196  	int (*cl_init)(struct snd_sof_dev *sdev, int stream_tag, bool imr_boot);
197  };
198  
199  extern struct snd_sof_dsp_ops sof_tng_ops;
200  
201  extern const struct sof_intel_dsp_desc tng_chip_info;
202  
203  struct sof_intel_stream {
204  	size_t posn_offset;
205  };
206  
get_chip_info(struct snd_sof_pdata * pdata)207  static inline const struct sof_intel_dsp_desc *get_chip_info(struct snd_sof_pdata *pdata)
208  {
209  	const struct sof_dev_desc *desc = pdata->desc;
210  
211  	return desc->chip_info;
212  }
213  
214  #endif
215