xref: /openbsd-src/sys/dev/pci/drm/amd/amdgpu/amdgpu_fru_eeprom.c (revision 4e1ee0786f11cc571bd0be17d38e46f635c719fc)
1 /*
2  * Copyright 2019 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 #include <linux/pci.h>
24 
25 #include "amdgpu.h"
26 #include "amdgpu_i2c.h"
27 #include "smu_v11_0_i2c.h"
28 #include "atom.h"
29 #include "amdgpu_fru_eeprom.h"
30 
31 #define I2C_PRODUCT_INFO_ADDR		0xAC
32 #define I2C_PRODUCT_INFO_ADDR_SIZE	0x2
33 #define I2C_PRODUCT_INFO_OFFSET		0xC0
34 
35 static bool is_fru_eeprom_supported(struct amdgpu_device *adev)
36 {
37 	/* Only server cards have the FRU EEPROM
38 	 * TODO: See if we can figure this out dynamically instead of
39 	 * having to parse VBIOS versions.
40 	 */
41 	struct atom_context *atom_ctx = adev->mode_info.atom_context;
42 
43 	/* VBIOS is of the format ###-DXXXYY-##. For SKU identification,
44 	 * we can use just the "DXXX" portion. If there were more models, we
45 	 * could convert the 3 characters to a hex integer and use a switch
46 	 * for ease/speed/readability. For now, 2 string comparisons are
47 	 * reasonable and not too expensive
48 	 */
49 	switch (adev->asic_type) {
50 	case CHIP_VEGA20:
51 #ifdef notyet
52 		/* D161 and D163 are the VG20 server SKUs */
53 		if (strnstr(atom_ctx->vbios_version, "D161",
54 			    sizeof(atom_ctx->vbios_version)) ||
55 		    strnstr(atom_ctx->vbios_version, "D163",
56 			    sizeof(atom_ctx->vbios_version)))
57 			return true;
58 		else
59 #endif
60 			return false;
61 	default:
62 		return false;
63 	}
64 }
65 
66 static int amdgpu_fru_read_eeprom(struct amdgpu_device *adev, uint32_t addrptr,
67 			   unsigned char *buff)
68 {
69 	int ret, size;
70 	struct i2c_msg msg = {
71 			.addr   = I2C_PRODUCT_INFO_ADDR,
72 			.flags  = I2C_M_RD,
73 			.buf    = buff,
74 	};
75 	buff[0] = 0;
76 	buff[1] = addrptr;
77 	msg.len = I2C_PRODUCT_INFO_ADDR_SIZE + 1;
78 	ret = i2c_transfer(&adev->pm.smu_i2c, &msg, 1);
79 
80 	if (ret < 1) {
81 		DRM_WARN("FRU: Failed to get size field");
82 		return ret;
83 	}
84 
85 	/* The size returned by the i2c requires subtraction of 0xC0 since the
86 	 * size apparently always reports as 0xC0+actual size.
87 	 */
88 	size = buff[2] - I2C_PRODUCT_INFO_OFFSET;
89 	/* Add 1 since address field was 1 byte */
90 	buff[1] = addrptr + 1;
91 
92 	msg.len = I2C_PRODUCT_INFO_ADDR_SIZE + size;
93 	ret = i2c_transfer(&adev->pm.smu_i2c, &msg, 1);
94 
95 	if (ret < 1) {
96 		DRM_WARN("FRU: Failed to get data field");
97 		return ret;
98 	}
99 
100 	return size;
101 }
102 
103 int amdgpu_fru_get_product_info(struct amdgpu_device *adev)
104 {
105 	unsigned char buff[34];
106 	int addrptr, size;
107 	int len;
108 
109 	if (!is_fru_eeprom_supported(adev))
110 		return 0;
111 
112 	/* If algo exists, it means that the i2c_adapter's initialized */
113 	if (!adev->pm.smu_i2c.algo) {
114 		DRM_WARN("Cannot access FRU, EEPROM accessor not initialized");
115 		return -ENODEV;
116 	}
117 
118 	/* There's a lot of repetition here. This is due to the FRU having
119 	 * variable-length fields. To get the information, we have to find the
120 	 * size of each field, and then keep reading along and reading along
121 	 * until we get all of the data that we want. We use addrptr to track
122 	 * the address as we go
123 	 */
124 
125 	/* The first fields are all of size 1-byte, from 0-7 are offsets that
126 	 * contain information that isn't useful to us.
127 	 * Bytes 8-a are all 1-byte and refer to the size of the entire struct,
128 	 * and the language field, so just start from 0xb, manufacturer size
129 	 */
130 	addrptr = 0xb;
131 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
132 	if (size < 1) {
133 		DRM_ERROR("Failed to read FRU Manufacturer, ret:%d", size);
134 		return -EINVAL;
135 	}
136 
137 	/* Increment the addrptr by the size of the field, and 1 due to the
138 	 * size field being 1 byte. This pattern continues below.
139 	 */
140 	addrptr += size + 1;
141 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
142 	if (size < 1) {
143 		DRM_ERROR("Failed to read FRU product name, ret:%d", size);
144 		return -EINVAL;
145 	}
146 
147 	len = size;
148 	/* Product name should only be 32 characters. Any more,
149 	 * and something could be wrong. Cap it at 32 to be safe
150 	 */
151 	if (len >= sizeof(adev->product_name)) {
152 		DRM_WARN("FRU Product Number is larger than 32 characters. This is likely a mistake");
153 		len = sizeof(adev->product_name) - 1;
154 	}
155 	/* Start at 2 due to buff using fields 0 and 1 for the address */
156 	memcpy(adev->product_name, &buff[2], len);
157 	adev->product_name[len] = '\0';
158 
159 	addrptr += size + 1;
160 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
161 	if (size < 1) {
162 		DRM_ERROR("Failed to read FRU product number, ret:%d", size);
163 		return -EINVAL;
164 	}
165 
166 	len = size;
167 	/* Product number should only be 16 characters. Any more,
168 	 * and something could be wrong. Cap it at 16 to be safe
169 	 */
170 	if (len >= sizeof(adev->product_number)) {
171 		DRM_WARN("FRU Product Number is larger than 16 characters. This is likely a mistake");
172 		len = sizeof(adev->product_number) - 1;
173 	}
174 	memcpy(adev->product_number, &buff[2], len);
175 	adev->product_number[len] = '\0';
176 
177 	addrptr += size + 1;
178 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
179 
180 	if (size < 1) {
181 		DRM_ERROR("Failed to read FRU product version, ret:%d", size);
182 		return -EINVAL;
183 	}
184 
185 	addrptr += size + 1;
186 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
187 
188 	if (size < 1) {
189 		DRM_ERROR("Failed to read FRU serial number, ret:%d", size);
190 		return -EINVAL;
191 	}
192 
193 	len = size;
194 	/* Serial number should only be 16 characters. Any more,
195 	 * and something could be wrong. Cap it at 16 to be safe
196 	 */
197 	if (len >= sizeof(adev->serial)) {
198 		DRM_WARN("FRU Serial Number is larger than 16 characters. This is likely a mistake");
199 		len = sizeof(adev->serial) - 1;
200 	}
201 	memcpy(adev->serial, &buff[2], len);
202 	adev->serial[len] = '\0';
203 
204 	return 0;
205 }
206