xref: /openbsd-src/sys/dev/pci/drm/amd/amdgpu/amdgpu_fru_eeprom.c (revision c1a45aed656e7d5627c30c92421893a76f370ccb)
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 #include "amdgpu_eeprom.h"
31 
32 #define FRU_EEPROM_MADDR        0x60000
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 
71 	ret = amdgpu_eeprom_read(&adev->pm.smu_i2c, addrptr, buff, 1);
72 	if (ret < 1) {
73 		DRM_WARN("FRU: Failed to get size field");
74 		return ret;
75 	}
76 
77 	/* The size returned by the i2c requires subtraction of 0xC0 since the
78 	 * size apparently always reports as 0xC0+actual size.
79 	 */
80 	size = buff[0] - I2C_PRODUCT_INFO_OFFSET;
81 
82 	ret = amdgpu_eeprom_read(&adev->pm.smu_i2c, addrptr + 1, buff, size);
83 	if (ret < 1) {
84 		DRM_WARN("FRU: Failed to get data field");
85 		return ret;
86 	}
87 
88 	return size;
89 }
90 
91 int amdgpu_fru_get_product_info(struct amdgpu_device *adev)
92 {
93 	unsigned char buff[34];
94 	u32 addrptr;
95 	int size, len;
96 
97 	if (!is_fru_eeprom_supported(adev))
98 		return 0;
99 
100 	/* If algo exists, it means that the i2c_adapter's initialized */
101 	if (!adev->pm.smu_i2c.algo) {
102 		DRM_WARN("Cannot access FRU, EEPROM accessor not initialized");
103 		return -ENODEV;
104 	}
105 
106 	/* There's a lot of repetition here. This is due to the FRU having
107 	 * variable-length fields. To get the information, we have to find the
108 	 * size of each field, and then keep reading along and reading along
109 	 * until we get all of the data that we want. We use addrptr to track
110 	 * the address as we go
111 	 */
112 
113 	/* The first fields are all of size 1-byte, from 0-7 are offsets that
114 	 * contain information that isn't useful to us.
115 	 * Bytes 8-a are all 1-byte and refer to the size of the entire struct,
116 	 * and the language field, so just start from 0xb, manufacturer size
117 	 */
118 	addrptr = FRU_EEPROM_MADDR + 0xb;
119 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
120 	if (size < 1) {
121 		DRM_ERROR("Failed to read FRU Manufacturer, ret:%d", size);
122 		return -EINVAL;
123 	}
124 
125 	/* Increment the addrptr by the size of the field, and 1 due to the
126 	 * size field being 1 byte. This pattern continues below.
127 	 */
128 	addrptr += size + 1;
129 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
130 	if (size < 1) {
131 		DRM_ERROR("Failed to read FRU product name, ret:%d", size);
132 		return -EINVAL;
133 	}
134 
135 	len = size;
136 	/* Product name should only be 32 characters. Any more,
137 	 * and something could be wrong. Cap it at 32 to be safe
138 	 */
139 	if (len >= sizeof(adev->product_name)) {
140 		DRM_WARN("FRU Product Number is larger than 32 characters. This is likely a mistake");
141 		len = sizeof(adev->product_name) - 1;
142 	}
143 	/* Start at 2 due to buff using fields 0 and 1 for the address */
144 	memcpy(adev->product_name, &buff[2], len);
145 	adev->product_name[len] = '\0';
146 
147 	addrptr += size + 1;
148 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
149 	if (size < 1) {
150 		DRM_ERROR("Failed to read FRU product number, ret:%d", size);
151 		return -EINVAL;
152 	}
153 
154 	len = size;
155 	/* Product number should only be 16 characters. Any more,
156 	 * and something could be wrong. Cap it at 16 to be safe
157 	 */
158 	if (len >= sizeof(adev->product_number)) {
159 		DRM_WARN("FRU Product Number is larger than 16 characters. This is likely a mistake");
160 		len = sizeof(adev->product_number) - 1;
161 	}
162 	memcpy(adev->product_number, &buff[2], len);
163 	adev->product_number[len] = '\0';
164 
165 	addrptr += size + 1;
166 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
167 
168 	if (size < 1) {
169 		DRM_ERROR("Failed to read FRU product version, ret:%d", size);
170 		return -EINVAL;
171 	}
172 
173 	addrptr += size + 1;
174 	size = amdgpu_fru_read_eeprom(adev, addrptr, buff);
175 
176 	if (size < 1) {
177 		DRM_ERROR("Failed to read FRU serial number, ret:%d", size);
178 		return -EINVAL;
179 	}
180 
181 	len = size;
182 	/* Serial number should only be 16 characters. Any more,
183 	 * and something could be wrong. Cap it at 16 to be safe
184 	 */
185 	if (len >= sizeof(adev->serial)) {
186 		DRM_WARN("FRU Serial Number is larger than 16 characters. This is likely a mistake");
187 		len = sizeof(adev->serial) - 1;
188 	}
189 	memcpy(adev->serial, &buff[2], len);
190 	adev->serial[len] = '\0';
191 
192 	return 0;
193 }
194