1 /*
2  * Copyright 2016 Advanced Micro Devices, Inc.
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice shall be included in
12  * all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
17  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20  * OTHER DEALINGS IN THE SOFTWARE.
21  *
22  * Author: Huang Rui
23  *
24  */
25 #ifndef __AMDGPU_PSP_H__
26 #define __AMDGPU_PSP_H__
27 
28 #include "amdgpu.h"
29 #include "psp_gfx_if.h"
30 
31 #define PSP_FENCE_BUFFER_SIZE	0x1000
32 #define PSP_CMD_BUFFER_SIZE	0x1000
33 #define PSP_ASD_SHARED_MEM_SIZE	0x4000
34 #define PSP_1_MEG		0x100000
35 
36 enum psp_ring_type
37 {
38 	PSP_RING_TYPE__INVALID = 0,
39 	/*
40 	 * These values map to the way the PSP kernel identifies the
41 	 * rings.
42 	 */
43 	PSP_RING_TYPE__UM = 1, /* User mode ring (formerly called RBI) */
44 	PSP_RING_TYPE__KM = 2  /* Kernel mode ring (formerly called GPCOM) */
45 };
46 
47 struct psp_ring
48 {
49 	enum psp_ring_type		ring_type;
50 	struct psp_gfx_rb_frame		*ring_mem;
51 	uint64_t			ring_mem_mc_addr;
52 	void				*ring_mem_handle;
53 	uint32_t			ring_size;
54 };
55 
56 struct psp_context
57 {
58 	struct amdgpu_device            *adev;
59 	struct psp_ring                 km_ring;
60 	struct psp_gfx_cmd_resp		*cmd;
61 
62 	int (*init_microcode)(struct psp_context *psp);
63 	int (*bootloader_load_sysdrv)(struct psp_context *psp);
64 	int (*bootloader_load_sos)(struct psp_context *psp);
65 	int (*prep_cmd_buf)(struct amdgpu_firmware_info *ucode,
66 			    struct psp_gfx_cmd_resp *cmd);
67 	int (*ring_init)(struct psp_context *psp, enum psp_ring_type ring_type);
68 	int (*ring_create)(struct psp_context *psp, enum psp_ring_type ring_type);
69 	int (*ring_destroy)(struct psp_context *psp,
70 			    enum psp_ring_type ring_type);
71 	int (*cmd_submit)(struct psp_context *psp, struct amdgpu_firmware_info *ucode,
72 			  uint64_t cmd_buf_mc_addr, uint64_t fence_mc_addr, int index);
73 	bool (*compare_sram_data)(struct psp_context *psp,
74 				  struct amdgpu_firmware_info *ucode,
75 				  enum AMDGPU_UCODE_ID ucode_type);
76 	bool (*smu_reload_quirk)(struct psp_context *psp);
77 
78 	/* fence buffer */
79 	struct amdgpu_bo 		*fw_pri_bo;
80 	uint64_t 			fw_pri_mc_addr;
81 	void				*fw_pri_buf;
82 
83 	/* sos firmware */
84 	const struct firmware		*sos_fw;
85 	uint32_t			sos_fw_version;
86 	uint32_t			sos_feature_version;
87 	uint32_t			sys_bin_size;
88 	uint32_t			sos_bin_size;
89 	uint8_t				*sys_start_addr;
90 	uint8_t				*sos_start_addr;
91 
92 	/* tmr buffer */
93 	struct amdgpu_bo 		*tmr_bo;
94 	uint64_t 			tmr_mc_addr;
95 	void				*tmr_buf;
96 
97 	/* asd firmware and buffer */
98 	const struct firmware		*asd_fw;
99 	uint32_t			asd_fw_version;
100 	uint32_t			asd_feature_version;
101 	uint32_t			asd_ucode_size;
102 	uint8_t				*asd_start_addr;
103 	struct amdgpu_bo 		*asd_shared_bo;
104 	uint64_t 			asd_shared_mc_addr;
105 	void				*asd_shared_buf;
106 
107 	/* fence buffer */
108 	struct amdgpu_bo 		*fence_buf_bo;
109 	uint64_t 			fence_buf_mc_addr;
110 	void				*fence_buf;
111 
112 	/* cmd buffer */
113 	struct amdgpu_bo		*cmd_buf_bo;
114 	uint64_t			cmd_buf_mc_addr;
115 	struct psp_gfx_cmd_resp		*cmd_buf_mem;
116 };
117 
118 struct amdgpu_psp_funcs {
119 	bool (*check_fw_loading_status)(struct amdgpu_device *adev,
120 					enum AMDGPU_UCODE_ID);
121 };
122 
123 #define psp_prep_cmd_buf(ucode, type) (psp)->prep_cmd_buf((ucode), (type))
124 #define psp_ring_init(psp, type) (psp)->ring_init((psp), (type))
125 #define psp_ring_create(psp, type) (psp)->ring_create((psp), (type))
126 #define psp_ring_destroy(psp, type) ((psp)->ring_destroy((psp), (type)))
127 #define psp_cmd_submit(psp, ucode, cmd_mc, fence_mc, index) \
128 		(psp)->cmd_submit((psp), (ucode), (cmd_mc), (fence_mc), (index))
129 #define psp_compare_sram_data(psp, ucode, type) \
130 		(psp)->compare_sram_data((psp), (ucode), (type))
131 #define psp_init_microcode(psp) \
132 		((psp)->init_microcode ? (psp)->init_microcode((psp)) : 0)
133 #define psp_bootloader_load_sysdrv(psp) \
134 		((psp)->bootloader_load_sysdrv ? (psp)->bootloader_load_sysdrv((psp)) : 0)
135 #define psp_bootloader_load_sos(psp) \
136 		((psp)->bootloader_load_sos ? (psp)->bootloader_load_sos((psp)) : 0)
137 #define psp_smu_reload_quirk(psp) \
138 		((psp)->smu_reload_quirk ? (psp)->smu_reload_quirk((psp)) : false)
139 
140 extern const struct amd_ip_funcs psp_ip_funcs;
141 
142 extern const struct amdgpu_ip_block_version psp_v3_1_ip_block;
143 extern int psp_wait_for(struct psp_context *psp, uint32_t reg_index,
144 			uint32_t field_val, uint32_t mask, bool check_changed);
145 
146 extern const struct amdgpu_ip_block_version psp_v10_0_ip_block;
147 
148 #endif
149