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