xref: /openbmc/linux/sound/soc/sof/amd/acp.h (revision 4cd81356)
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) 2021 Advanced Micro Devices, Inc. All rights reserved.
7  *
8  * Author: Ajit Kumar Pandey <AjitKumar.Pandey@amd.com>
9  */
10 
11 #ifndef __SOF_AMD_ACP_H
12 #define __SOF_AMD_ACP_H
13 
14 #include "../sof-priv.h"
15 
16 #define ACP_MAX_STREAM	8
17 
18 #define ACP_DSP_BAR	0
19 
20 #define ACP_HW_SEM_RETRY_COUNT			10000
21 #define ACP_REG_POLL_INTERVAL                   500
22 #define ACP_REG_POLL_TIMEOUT_US                 2000
23 #define ACP_DMA_COMPLETE_TIMEOUT_US		5000
24 
25 #define ACP_PGFSM_CNTL_POWER_ON_MASK		0x01
26 #define ACP_PGFSM_STATUS_MASK			0x03
27 #define ACP_POWERED_ON				0x00
28 #define ACP_ASSERT_RESET			0x01
29 #define ACP_RELEASE_RESET			0x00
30 #define ACP_SOFT_RESET_DONE_MASK		0x00010001
31 
32 #define ACP_DSP_INTR_EN_MASK			0x00000001
33 #define ACP3X_SRAM_PTE_OFFSET			0x02050000
34 #define ACP6X_SRAM_PTE_OFFSET			0x03800000
35 #define PAGE_SIZE_4K_ENABLE			0x2
36 #define ACP_PAGE_SIZE				0x1000
37 #define ACP_DMA_CH_RUN				0x02
38 #define ACP_MAX_DESC_CNT			0x02
39 #define DSP_FW_RUN_ENABLE			0x01
40 #define ACP_SHA_RUN				0x01
41 #define ACP_SHA_RESET				0x02
42 #define ACP_DMA_CH_RST				0x01
43 #define ACP_DMA_CH_GRACEFUL_RST_EN		0x10
44 #define ACP_ATU_CACHE_INVALID			0x01
45 #define ACP_MAX_DESC				128
46 #define ACPBUS_REG_BASE_OFFSET			ACP_DMA_CNTL_0
47 
48 #define ACP_DEFAULT_DRAM_LENGTH			0x00080000
49 #define ACP3X_SCRATCH_MEMORY_ADDRESS		0x02050000
50 #define ACP_SYSTEM_MEMORY_WINDOW		0x4000000
51 #define ACP_IRAM_BASE_ADDRESS			0x000000
52 #define ACP_DATA_RAM_BASE_ADDRESS		0x01000000
53 #define ACP_DRAM_PAGE_COUNT			128
54 
55 #define ACP_DSP_TO_HOST_IRQ			0x04
56 
57 #define HOST_BRIDGE_CZN				0x1630
58 #define HOST_BRIDGE_RMB				0x14B5
59 #define ACP_SHA_STAT				0x8000
60 #define ACP_PSP_TIMEOUT_COUNTER			5
61 #define ACP_EXT_INTR_ERROR_STAT			0x20000000
62 #define MP0_C2PMSG_114_REG			0x3810AC8
63 #define MP0_C2PMSG_73_REG			0x3810A24
64 #define MBOX_ACP_SHA_DMA_COMMAND		0x70000
65 #define MBOX_DELAY				1000
66 #define MBOX_READY_MASK				0x80000000
67 #define MBOX_STATUS_MASK			0xFFFF
68 
69 #define BOX_SIZE_512				0x200
70 #define BOX_SIZE_1024				0x400
71 
72 #define EXCEPT_MAX_HDR_SIZE			0x400
73 #define AMD_STACK_DUMP_SIZE			32
74 
75 enum clock_source {
76 	ACP_CLOCK_96M = 0,
77 	ACP_CLOCK_48M,
78 	ACP_CLOCK_24M,
79 	ACP_CLOCK_ACLK,
80 	ACP_CLOCK_MCLK,
81 };
82 
83 struct  acp_atu_grp_pte {
84 	u32 low;
85 	u32 high;
86 };
87 
88 union dma_tx_cnt {
89 	struct {
90 		unsigned int count : 19;
91 		unsigned int reserved : 12;
92 		unsigned ioc : 1;
93 	} bitfields, bits;
94 	unsigned int u32_all;
95 	signed int i32_all;
96 };
97 
98 struct dma_descriptor {
99 	unsigned int src_addr;
100 	unsigned int dest_addr;
101 	union dma_tx_cnt tx_cnt;
102 	unsigned int reserved;
103 };
104 
105 /* Scratch memory structure for communication b/w host and dsp */
106 struct  scratch_ipc_conf {
107 	/* Debug memory */
108 	u8 sof_debug_box[1024];
109 	/* Exception memory*/
110 	u8 sof_except_box[1024];
111 	/* Stream buffer */
112 	u8 sof_stream_box[1024];
113 	/* Trace buffer */
114 	u8 sof_trace_box[1024];
115 	/* Host msg flag */
116 	u32 sof_host_msg_write;
117 	/* Host ack flag*/
118 	u32 sof_host_ack_write;
119 	/* DSP msg flag */
120 	u32 sof_dsp_msg_write;
121 	/* Dsp ack flag */
122 	u32 sof_dsp_ack_write;
123 };
124 
125 struct  scratch_reg_conf {
126 	struct scratch_ipc_conf info;
127 	struct acp_atu_grp_pte grp1_pte[16];
128 	struct acp_atu_grp_pte grp2_pte[16];
129 	struct acp_atu_grp_pte grp3_pte[16];
130 	struct acp_atu_grp_pte grp4_pte[16];
131 	struct acp_atu_grp_pte grp5_pte[16];
132 	struct acp_atu_grp_pte grp6_pte[16];
133 	struct acp_atu_grp_pte grp7_pte[16];
134 	struct acp_atu_grp_pte grp8_pte[16];
135 	struct dma_descriptor dma_desc[64];
136 	unsigned int reg_offset[8];
137 	unsigned int buf_size[8];
138 	u8 acp_tx_fifo_buf[256];
139 	u8 acp_rx_fifo_buf[256];
140 	unsigned int    reserve[];
141 };
142 
143 struct acp_dsp_stream {
144 	struct list_head list;
145 	struct snd_sof_dev *sdev;
146 	struct snd_pcm_substream *substream;
147 	struct snd_dma_buffer *dmab;
148 	int num_pages;
149 	int stream_tag;
150 	int active;
151 	unsigned int reg_offset;
152 	size_t posn_offset;
153 };
154 
155 struct sof_amd_acp_desc {
156 	unsigned int rev;
157 	unsigned int host_bridge_id;
158 	unsigned int i2s_mode;
159 	u32 pgfsm_base;
160 	u32 ext_intr_stat;
161 	u32 dsp_intr_base;
162 	u32 sram_pte_offset;
163 	u32 i2s_pin_config_offset;
164 	u32 hw_semaphore_offset;
165 	u32 acp_clkmux_sel;
166 	u32 fusion_dsp_offset;
167 };
168 
169 /* Common device data struct for ACP devices */
170 struct acp_dev_data {
171 	struct snd_sof_dev  *dev;
172 	unsigned int fw_bin_size;
173 	unsigned int fw_data_bin_size;
174 	u32 fw_bin_page_count;
175 	dma_addr_t sha_dma_addr;
176 	u8 *bin_buf;
177 	dma_addr_t dma_addr;
178 	u8 *data_buf;
179 	struct dma_descriptor dscr_info[ACP_MAX_DESC];
180 	struct acp_dsp_stream stream_buf[ACP_MAX_STREAM];
181 	struct acp_dsp_stream *dtrace_stream;
182 	struct pci_dev *smn_dev;
183 };
184 
185 void memcpy_to_scratch(struct snd_sof_dev *sdev, u32 offset, unsigned int *src, size_t bytes);
186 void memcpy_from_scratch(struct snd_sof_dev *sdev, u32 offset, unsigned int *dst, size_t bytes);
187 
188 int acp_dma_status(struct acp_dev_data *adata, unsigned char ch);
189 int configure_and_run_dma(struct acp_dev_data *adata, unsigned int src_addr,
190 			  unsigned int dest_addr, int dsp_data_size);
191 int configure_and_run_sha_dma(struct acp_dev_data *adata, void *image_addr,
192 			      unsigned int start_addr, unsigned int dest_addr,
193 			      unsigned int image_length);
194 
195 /* ACP device probe/remove */
196 int amd_sof_acp_probe(struct snd_sof_dev *sdev);
197 int amd_sof_acp_remove(struct snd_sof_dev *sdev);
198 
199 /* DSP Loader callbacks */
200 int acp_sof_dsp_run(struct snd_sof_dev *sdev);
201 int acp_dsp_pre_fw_run(struct snd_sof_dev *sdev);
202 int acp_get_bar_index(struct snd_sof_dev *sdev, u32 type);
203 
204 /* Block IO callbacks */
205 int acp_dsp_block_write(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
206 			u32 offset, void *src, size_t size);
207 int acp_dsp_block_read(struct snd_sof_dev *sdev, enum snd_sof_fw_blk_type blk_type,
208 		       u32 offset, void *dest, size_t size);
209 
210 /* IPC callbacks */
211 irqreturn_t acp_sof_ipc_irq_thread(int irq, void *context);
212 int acp_sof_ipc_msg_data(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream,
213 			 void *p, size_t sz);
214 int acp_set_stream_data_offset(struct snd_sof_dev *sdev,
215 			       struct snd_pcm_substream *substream,
216 			       size_t posn_offset);
217 int acp_sof_ipc_send_msg(struct snd_sof_dev *sdev,
218 			 struct snd_sof_ipc_msg *msg);
219 int acp_sof_ipc_get_mailbox_offset(struct snd_sof_dev *sdev);
220 int acp_sof_ipc_get_window_offset(struct snd_sof_dev *sdev, u32 id);
221 void acp_mailbox_write(struct snd_sof_dev *sdev, u32 offset, void *message, size_t bytes);
222 void acp_mailbox_read(struct snd_sof_dev *sdev, u32 offset, void *message, size_t bytes);
223 
224 /* ACP - DSP  stream callbacks */
225 int acp_dsp_stream_config(struct snd_sof_dev *sdev, struct acp_dsp_stream *stream);
226 int acp_dsp_stream_init(struct snd_sof_dev *sdev);
227 struct acp_dsp_stream *acp_dsp_stream_get(struct snd_sof_dev *sdev, int tag);
228 int acp_dsp_stream_put(struct snd_sof_dev *sdev, struct acp_dsp_stream *acp_stream);
229 
230 /*
231  * DSP PCM Operations.
232  */
233 int acp_pcm_open(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream);
234 int acp_pcm_close(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream);
235 int acp_pcm_hw_params(struct snd_sof_dev *sdev, struct snd_pcm_substream *substream,
236 		      struct snd_pcm_hw_params *params,
237 		      struct snd_sof_platform_stream_params *platform_params);
238 
239 extern struct snd_sof_dsp_ops sof_acp_common_ops;
240 
241 extern struct snd_sof_dsp_ops sof_renoir_ops;
242 int sof_renoir_ops_init(struct snd_sof_dev *sdev);
243 extern struct snd_sof_dsp_ops sof_rembrandt_ops;
244 int sof_rembrandt_ops_init(struct snd_sof_dev *sdev);
245 
246 int acp_dai_probe(struct snd_soc_dai *dai);
247 struct snd_soc_acpi_mach *amd_sof_machine_select(struct snd_sof_dev *sdev);
248 /* Machine configuration */
249 int snd_amd_acp_find_config(struct pci_dev *pci);
250 
251 /* Trace */
252 int acp_sof_trace_init(struct snd_sof_dev *sdev, struct snd_dma_buffer *dmab,
253 		       struct sof_ipc_dma_trace_params_ext *dtrace_params);
254 int acp_sof_trace_release(struct snd_sof_dev *sdev);
255 
256 /* PM Callbacks */
257 int amd_sof_acp_suspend(struct snd_sof_dev *sdev, u32 target_state);
258 int amd_sof_acp_resume(struct snd_sof_dev *sdev);
259 
260 void amd_sof_ipc_dump(struct snd_sof_dev *sdev);
261 void amd_sof_dump(struct snd_sof_dev *sdev, u32 flags);
262 
263 static inline const struct sof_amd_acp_desc *get_chip_info(struct snd_sof_pdata *pdata)
264 {
265 	const struct sof_dev_desc *desc = pdata->desc;
266 
267 	return desc->chip_info;
268 }
269 #endif
270