xref: /linux/drivers/gpu/drm/amd/amdgpu/amdgpu_ip.h (revision 37a93dd5c49b5fda807fd204edf2547c3493319c)
1 /*
2  * Copyright 2025 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  */
23 
24 #ifndef __AMDGPU_IP_H__
25 #define __AMDGPU_IP_H__
26 
27 #include "amd_shared.h"
28 
29 struct amdgpu_device;
30 
31 /* Define the HW IP blocks will be used in driver , add more if necessary */
32 enum amd_hw_ip_block_type {
33 	GC_HWIP = 1,
34 	HDP_HWIP,
35 	SDMA0_HWIP,
36 	SDMA1_HWIP,
37 	SDMA2_HWIP,
38 	SDMA3_HWIP,
39 	SDMA4_HWIP,
40 	SDMA5_HWIP,
41 	SDMA6_HWIP,
42 	SDMA7_HWIP,
43 	LSDMA_HWIP,
44 	MMHUB_HWIP,
45 	ATHUB_HWIP,
46 	NBIO_HWIP,
47 	MP0_HWIP,
48 	MP1_HWIP,
49 	UVD_HWIP,
50 	VCN_HWIP = UVD_HWIP,
51 	JPEG_HWIP = VCN_HWIP,
52 	VCN1_HWIP,
53 	VCE_HWIP,
54 	VPE_HWIP,
55 	DF_HWIP,
56 	DCE_HWIP,
57 	OSSSYS_HWIP,
58 	SMUIO_HWIP,
59 	PWR_HWIP,
60 	NBIF_HWIP,
61 	THM_HWIP,
62 	CLK_HWIP,
63 	UMC_HWIP,
64 	RSMU_HWIP,
65 	XGMI_HWIP,
66 	DCI_HWIP,
67 	PCIE_HWIP,
68 	ISP_HWIP,
69 	ATU_HWIP,
70 	AIGC_HWIP,
71 	MAX_HWIP
72 };
73 
74 #define HWIP_MAX_INSTANCE 48
75 
76 #define HW_ID_MAX 300
77 #define IP_VERSION_FULL(mj, mn, rv, var, srev) \
78 	(((mj) << 24) | ((mn) << 16) | ((rv) << 8) | ((var) << 4) | (srev))
79 #define IP_VERSION(mj, mn, rv) IP_VERSION_FULL(mj, mn, rv, 0, 0)
80 #define IP_VERSION_MAJ(ver) ((ver) >> 24)
81 #define IP_VERSION_MIN(ver) (((ver) >> 16) & 0xFF)
82 #define IP_VERSION_REV(ver) (((ver) >> 8) & 0xFF)
83 #define IP_VERSION_VARIANT(ver) (((ver) >> 4) & 0xF)
84 #define IP_VERSION_SUBREV(ver) ((ver) & 0xF)
85 #define IP_VERSION_MAJ_MIN_REV(ver) ((ver) >> 8)
86 
87 struct amdgpu_ip_map_info {
88 	/* Map of logical to actual dev instances/mask */
89 	uint32_t dev_inst[MAX_HWIP][HWIP_MAX_INSTANCE];
90 	int8_t (*logical_to_dev_inst)(struct amdgpu_device *adev,
91 				      enum amd_hw_ip_block_type block,
92 				      int8_t inst);
93 	uint32_t (*logical_to_dev_mask)(struct amdgpu_device *adev,
94 					enum amd_hw_ip_block_type block,
95 					uint32_t mask);
96 };
97 
98 #define AMDGPU_MAX_IP_NUM AMD_IP_BLOCK_TYPE_NUM
99 
100 struct amdgpu_ip_block_status {
101 	bool valid;
102 	bool sw;
103 	bool hw;
104 	bool late_initialized;
105 	bool hang;
106 };
107 
108 struct amdgpu_ip_block_version {
109 	const enum amd_ip_block_type type;
110 	const u32 major;
111 	const u32 minor;
112 	const u32 rev;
113 	const struct amd_ip_funcs *funcs;
114 };
115 
116 struct amdgpu_ip_block {
117 	struct amdgpu_ip_block_status status;
118 	const struct amdgpu_ip_block_version *version;
119 	struct amdgpu_device *adev;
120 };
121 
122 void amdgpu_ip_map_init(struct amdgpu_device *adev);
123 
124 int amdgpu_ip_block_suspend(struct amdgpu_ip_block *ip_block);
125 int amdgpu_ip_block_resume(struct amdgpu_ip_block *ip_block);
126 
127 struct amdgpu_ip_block *
128 amdgpu_device_ip_get_ip_block(struct amdgpu_device *adev,
129 			      enum amd_ip_block_type type);
130 
131 int amdgpu_device_ip_block_version_cmp(struct amdgpu_device *adev,
132 				       enum amd_ip_block_type type, u32 major,
133 				       u32 minor);
134 
135 int amdgpu_device_ip_block_add(
136 	struct amdgpu_device *adev,
137 	const struct amdgpu_ip_block_version *ip_block_version);
138 
139 int amdgpu_device_ip_set_clockgating_state(struct amdgpu_device *adev,
140 					   enum amd_ip_block_type block_type,
141 					   enum amd_clockgating_state state);
142 int amdgpu_device_ip_set_powergating_state(struct amdgpu_device *adev,
143 					   enum amd_ip_block_type block_type,
144 					   enum amd_powergating_state state);
145 void amdgpu_device_ip_get_clockgating_state(struct amdgpu_device *adev,
146 					    u64 *flags);
147 int amdgpu_device_ip_wait_for_idle(struct amdgpu_device *adev,
148 				   enum amd_ip_block_type block_type);
149 bool amdgpu_device_ip_is_hw(struct amdgpu_device *adev,
150 			    enum amd_ip_block_type block_type);
151 bool amdgpu_device_ip_is_valid(struct amdgpu_device *adev,
152 			       enum amd_ip_block_type block_type);
153 
154 #endif /* __AMDGPU_IP_H__ */
155