Commit | Line | Data |
---|---|---|
a16b4313 MW |
1 | /* |
2 | * Copyright © 2014-2017 Intel Corporation | |
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 (including the next | |
12 | * paragraph) shall be included in all copies or substantial portions of the | |
13 | * Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
18 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
20 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | |
21 | * IN THE SOFTWARE. | |
22 | * | |
23 | */ | |
24 | ||
25 | #ifndef _INTEL_UC_FW_H_ | |
26 | #define _INTEL_UC_FW_H_ | |
27 | ||
56ffc742 | 28 | struct drm_printer; |
a16b4313 | 29 | struct drm_i915_private; |
4502e9ec | 30 | struct i915_vma; |
a16b4313 | 31 | |
f1e86cec | 32 | /* Home of GuC, HuC and DMC firmwares */ |
1e913d27 MW |
33 | #define INTEL_UC_FIRMWARE_URL "https://01.org/linuxgraphics/downloads/firmware" |
34 | ||
a16b4313 MW |
35 | enum intel_uc_fw_status { |
36 | INTEL_UC_FIRMWARE_FAIL = -1, | |
37 | INTEL_UC_FIRMWARE_NONE = 0, | |
38 | INTEL_UC_FIRMWARE_PENDING, | |
39 | INTEL_UC_FIRMWARE_SUCCESS | |
40 | }; | |
41 | ||
42 | enum intel_uc_fw_type { | |
43 | INTEL_UC_FW_TYPE_GUC, | |
44 | INTEL_UC_FW_TYPE_HUC | |
45 | }; | |
46 | ||
47 | /* | |
48 | * This structure encapsulates all the data needed during the process | |
49 | * of fetching, caching, and loading the firmware image into the uC. | |
50 | */ | |
51 | struct intel_uc_fw { | |
52 | const char *path; | |
53 | size_t size; | |
54 | struct drm_i915_gem_object *obj; | |
55 | enum intel_uc_fw_status fetch_status; | |
56 | enum intel_uc_fw_status load_status; | |
57 | ||
d9e2e014 MW |
58 | /* |
59 | * The firmware build process will generate a version header file with major and | |
60 | * minor version defined. The versions are built into CSS header of firmware. | |
61 | * i915 kernel driver set the minimal firmware version required per platform. | |
62 | */ | |
faf65486 JL |
63 | u16 major_ver_wanted; |
64 | u16 minor_ver_wanted; | |
65 | u16 major_ver_found; | |
66 | u16 minor_ver_found; | |
a16b4313 MW |
67 | |
68 | enum intel_uc_fw_type type; | |
faf65486 JL |
69 | u32 header_size; |
70 | u32 header_offset; | |
71 | u32 rsa_size; | |
72 | u32 rsa_offset; | |
73 | u32 ucode_size; | |
74 | u32 ucode_offset; | |
a16b4313 MW |
75 | }; |
76 | ||
77 | static inline | |
78 | const char *intel_uc_fw_status_repr(enum intel_uc_fw_status status) | |
79 | { | |
80 | switch (status) { | |
81 | case INTEL_UC_FIRMWARE_FAIL: | |
82 | return "FAIL"; | |
83 | case INTEL_UC_FIRMWARE_NONE: | |
84 | return "NONE"; | |
85 | case INTEL_UC_FIRMWARE_PENDING: | |
86 | return "PENDING"; | |
87 | case INTEL_UC_FIRMWARE_SUCCESS: | |
88 | return "SUCCESS"; | |
89 | } | |
90 | return "<invalid>"; | |
91 | } | |
92 | ||
93 | static inline const char *intel_uc_fw_type_repr(enum intel_uc_fw_type type) | |
94 | { | |
95 | switch (type) { | |
96 | case INTEL_UC_FW_TYPE_GUC: | |
97 | return "GuC"; | |
98 | case INTEL_UC_FW_TYPE_HUC: | |
99 | return "HuC"; | |
100 | } | |
101 | return "uC"; | |
102 | } | |
103 | ||
959a3b6f MW |
104 | static inline |
105 | void intel_uc_fw_init(struct intel_uc_fw *uc_fw, enum intel_uc_fw_type type) | |
106 | { | |
107 | uc_fw->path = NULL; | |
108 | uc_fw->fetch_status = INTEL_UC_FIRMWARE_NONE; | |
109 | uc_fw->load_status = INTEL_UC_FIRMWARE_NONE; | |
110 | uc_fw->type = type; | |
111 | } | |
112 | ||
a16b4313 MW |
113 | void intel_uc_fw_fetch(struct drm_i915_private *dev_priv, |
114 | struct intel_uc_fw *uc_fw); | |
4502e9ec MW |
115 | int intel_uc_fw_upload(struct intel_uc_fw *uc_fw, |
116 | int (*xfer)(struct intel_uc_fw *uc_fw, | |
117 | struct i915_vma *vma)); | |
a16b4313 | 118 | void intel_uc_fw_fini(struct intel_uc_fw *uc_fw); |
56ffc742 | 119 | void intel_uc_fw_dump(struct intel_uc_fw *uc_fw, struct drm_printer *p); |
a16b4313 MW |
120 | |
121 | #endif |