xref: /openbsd-src/sys/dev/pci/drm/radeon/radeon_ucode.c (revision 99fd087599a8791921855f21bd7e36130f39aadc)
1 /*
2  * Copyright 2014 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 #include <linux/firmware.h>
25 #include <linux/slab.h>
26 #include <linux/module.h>
27 #include <drm/drmP.h>
28 #include "radeon.h"
29 #include "radeon_ucode.h"
30 
31 static void radeon_ucode_print_common_hdr(const struct common_firmware_header *hdr)
32 {
33 	DRM_DEBUG("size_bytes: %u\n", le32_to_cpu(hdr->size_bytes));
34 	DRM_DEBUG("header_size_bytes: %u\n", le32_to_cpu(hdr->header_size_bytes));
35 	DRM_DEBUG("header_version_major: %u\n", le16_to_cpu(hdr->header_version_major));
36 	DRM_DEBUG("header_version_minor: %u\n", le16_to_cpu(hdr->header_version_minor));
37 	DRM_DEBUG("ip_version_major: %u\n", le16_to_cpu(hdr->ip_version_major));
38 	DRM_DEBUG("ip_version_minor: %u\n", le16_to_cpu(hdr->ip_version_minor));
39 	DRM_DEBUG("ucode_version: 0x%08x\n", le32_to_cpu(hdr->ucode_version));
40 	DRM_DEBUG("ucode_size_bytes: %u\n", le32_to_cpu(hdr->ucode_size_bytes));
41 	DRM_DEBUG("ucode_array_offset_bytes: %u\n",
42 		  le32_to_cpu(hdr->ucode_array_offset_bytes));
43 	DRM_DEBUG("crc32: 0x%08x\n", le32_to_cpu(hdr->crc32));
44 }
45 
46 void radeon_ucode_print_mc_hdr(const struct common_firmware_header *hdr)
47 {
48 	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
49 	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
50 
51 	DRM_DEBUG("MC\n");
52 	radeon_ucode_print_common_hdr(hdr);
53 
54 	if (version_major == 1) {
55 #ifdef DRMDEBUG
56 		const struct mc_firmware_header_v1_0 *mc_hdr =
57 			container_of(hdr, struct mc_firmware_header_v1_0, header);
58 #endif
59 
60 		DRM_DEBUG("io_debug_size_bytes: %u\n",
61 			  le32_to_cpu(mc_hdr->io_debug_size_bytes));
62 		DRM_DEBUG("io_debug_array_offset_bytes: %u\n",
63 			  le32_to_cpu(mc_hdr->io_debug_array_offset_bytes));
64 	} else {
65 		DRM_ERROR("Unknown MC ucode version: %u.%u\n", version_major, version_minor);
66 	}
67 }
68 
69 void radeon_ucode_print_smc_hdr(const struct common_firmware_header *hdr)
70 {
71 	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
72 	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
73 
74 	DRM_DEBUG("SMC\n");
75 	radeon_ucode_print_common_hdr(hdr);
76 
77 	if (version_major == 1) {
78 #ifdef DRMDEBUG
79 		const struct smc_firmware_header_v1_0 *smc_hdr =
80 			container_of(hdr, struct smc_firmware_header_v1_0, header);
81 #endif
82 
83 		DRM_DEBUG("ucode_start_addr: %u\n", le32_to_cpu(smc_hdr->ucode_start_addr));
84 	} else {
85 		DRM_ERROR("Unknown SMC ucode version: %u.%u\n", version_major, version_minor);
86 	}
87 }
88 
89 void radeon_ucode_print_gfx_hdr(const struct common_firmware_header *hdr)
90 {
91 	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
92 	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
93 
94 	DRM_DEBUG("GFX\n");
95 	radeon_ucode_print_common_hdr(hdr);
96 
97 	if (version_major == 1) {
98 #ifdef DRMDEBUG
99 		const struct gfx_firmware_header_v1_0 *gfx_hdr =
100 			container_of(hdr, struct gfx_firmware_header_v1_0, header);
101 #endif
102 
103 		DRM_DEBUG("ucode_feature_version: %u\n",
104 			  le32_to_cpu(gfx_hdr->ucode_feature_version));
105 		DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(gfx_hdr->jt_offset));
106 		DRM_DEBUG("jt_size: %u\n", le32_to_cpu(gfx_hdr->jt_size));
107 	} else {
108 		DRM_ERROR("Unknown GFX ucode version: %u.%u\n", version_major, version_minor);
109 	}
110 }
111 
112 void radeon_ucode_print_rlc_hdr(const struct common_firmware_header *hdr)
113 {
114 	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
115 	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
116 
117 	DRM_DEBUG("RLC\n");
118 	radeon_ucode_print_common_hdr(hdr);
119 
120 	if (version_major == 1) {
121 #ifdef DRMDEBUG
122 		const struct rlc_firmware_header_v1_0 *rlc_hdr =
123 			container_of(hdr, struct rlc_firmware_header_v1_0, header);
124 #endif
125 
126 		DRM_DEBUG("ucode_feature_version: %u\n",
127 			  le32_to_cpu(rlc_hdr->ucode_feature_version));
128 		DRM_DEBUG("save_and_restore_offset: %u\n",
129 			  le32_to_cpu(rlc_hdr->save_and_restore_offset));
130 		DRM_DEBUG("clear_state_descriptor_offset: %u\n",
131 			  le32_to_cpu(rlc_hdr->clear_state_descriptor_offset));
132 		DRM_DEBUG("avail_scratch_ram_locations: %u\n",
133 			  le32_to_cpu(rlc_hdr->avail_scratch_ram_locations));
134 		DRM_DEBUG("master_pkt_description_offset: %u\n",
135 			  le32_to_cpu(rlc_hdr->master_pkt_description_offset));
136 	} else {
137 		DRM_ERROR("Unknown RLC ucode version: %u.%u\n", version_major, version_minor);
138 	}
139 }
140 
141 void radeon_ucode_print_sdma_hdr(const struct common_firmware_header *hdr)
142 {
143 	uint16_t version_major = le16_to_cpu(hdr->header_version_major);
144 	uint16_t version_minor = le16_to_cpu(hdr->header_version_minor);
145 
146 	DRM_DEBUG("SDMA\n");
147 	radeon_ucode_print_common_hdr(hdr);
148 
149 	if (version_major == 1) {
150 #ifdef DRMDEBUG
151 		const struct sdma_firmware_header_v1_0 *sdma_hdr =
152 			container_of(hdr, struct sdma_firmware_header_v1_0, header);
153 #endif
154 
155 		DRM_DEBUG("ucode_feature_version: %u\n",
156 			  le32_to_cpu(sdma_hdr->ucode_feature_version));
157 		DRM_DEBUG("ucode_change_version: %u\n",
158 			  le32_to_cpu(sdma_hdr->ucode_change_version));
159 		DRM_DEBUG("jt_offset: %u\n", le32_to_cpu(sdma_hdr->jt_offset));
160 		DRM_DEBUG("jt_size: %u\n", le32_to_cpu(sdma_hdr->jt_size));
161 	} else {
162 		DRM_ERROR("Unknown SDMA ucode version: %u.%u\n",
163 			  version_major, version_minor);
164 	}
165 }
166 
167 int radeon_ucode_validate(const struct firmware *fw)
168 {
169 	const struct common_firmware_header *hdr =
170 		(const struct common_firmware_header *)fw->data;
171 
172 	if (fw->size == le32_to_cpu(hdr->size_bytes))
173 		return 0;
174 
175 	return -EINVAL;
176 }
177 
178