xref: /openbsd/sys/dev/pci/drm/i915/pxp/intel_pxp_tee.c (revision f005ef32)
1 // SPDX-License-Identifier: MIT
2 /*
3  * Copyright(c) 2020 Intel Corporation.
4  */
5 
6 #include <linux/component.h>
7 
8 #include <drm/i915_pxp_tee_interface.h>
9 #include <drm/i915_component.h>
10 
11 #include "gem/i915_gem_lmem.h"
12 
13 #include "i915_drv.h"
14 #include "gt/intel_gt.h"
15 
16 #include "intel_pxp.h"
17 #include "intel_pxp_cmd_interface_42.h"
18 #include "intel_pxp_huc.h"
19 #include "intel_pxp_session.h"
20 #include "intel_pxp_tee.h"
21 #include "intel_pxp_types.h"
22 
23 static bool
is_fw_err_platform_config(u32 type)24 is_fw_err_platform_config(u32 type)
25 {
26 	switch (type) {
27 	case PXP_STATUS_ERROR_API_VERSION:
28 	case PXP_STATUS_PLATFCONFIG_KF1_NOVERIF:
29 	case PXP_STATUS_PLATFCONFIG_KF1_BAD:
30 		return true;
31 	default:
32 		break;
33 	}
34 	return false;
35 }
36 
37 static const char *
fw_err_to_string(u32 type)38 fw_err_to_string(u32 type)
39 {
40 	switch (type) {
41 	case PXP_STATUS_ERROR_API_VERSION:
42 		return "ERR_API_VERSION";
43 	case PXP_STATUS_NOT_READY:
44 		return "ERR_NOT_READY";
45 	case PXP_STATUS_PLATFCONFIG_KF1_NOVERIF:
46 	case PXP_STATUS_PLATFCONFIG_KF1_BAD:
47 		return "ERR_PLATFORM_CONFIG";
48 	default:
49 		break;
50 	}
51 	return NULL;
52 }
53 
intel_pxp_tee_io_message(struct intel_pxp * pxp,void * msg_in,u32 msg_in_size,void * msg_out,u32 msg_out_max_size,u32 * msg_out_rcv_size)54 static int intel_pxp_tee_io_message(struct intel_pxp *pxp,
55 				    void *msg_in, u32 msg_in_size,
56 				    void *msg_out, u32 msg_out_max_size,
57 				    u32 *msg_out_rcv_size)
58 {
59 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
60 	struct i915_pxp_component *pxp_component = pxp->pxp_component;
61 	int ret = 0;
62 
63 	mutex_lock(&pxp->tee_mutex);
64 
65 	/*
66 	 * The binding of the component is asynchronous from i915 probe, so we
67 	 * can't be sure it has happened.
68 	 */
69 	if (!pxp_component) {
70 		ret = -ENODEV;
71 		goto unlock;
72 	}
73 
74 	ret = pxp_component->ops->send(pxp_component->tee_dev, msg_in, msg_in_size);
75 	if (ret) {
76 		drm_err(&i915->drm, "Failed to send PXP TEE message\n");
77 		goto unlock;
78 	}
79 
80 	ret = pxp_component->ops->recv(pxp_component->tee_dev, msg_out, msg_out_max_size);
81 	if (ret < 0) {
82 		drm_err(&i915->drm, "Failed to receive PXP TEE message\n");
83 		goto unlock;
84 	}
85 
86 	if (ret > msg_out_max_size) {
87 		drm_err(&i915->drm,
88 			"Failed to receive PXP TEE message due to unexpected output size\n");
89 		ret = -ENOSPC;
90 		goto unlock;
91 	}
92 
93 	if (msg_out_rcv_size)
94 		*msg_out_rcv_size = ret;
95 
96 	ret = 0;
97 unlock:
98 	mutex_unlock(&pxp->tee_mutex);
99 	return ret;
100 }
101 
intel_pxp_tee_stream_message(struct intel_pxp * pxp,u8 client_id,u32 fence_id,void * msg_in,size_t msg_in_len,void * msg_out,size_t msg_out_len)102 int intel_pxp_tee_stream_message(struct intel_pxp *pxp,
103 				 u8 client_id, u32 fence_id,
104 				 void *msg_in, size_t msg_in_len,
105 				 void *msg_out, size_t msg_out_len)
106 {
107 	/* TODO: for bigger objects we need to use a sg of 4k pages */
108 	const size_t max_msg_size = PAGE_SIZE;
109 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
110 	struct i915_pxp_component *pxp_component = pxp->pxp_component;
111 	unsigned int offset = 0;
112 	struct scatterlist *sg;
113 	int ret;
114 
115 	if (msg_in_len > max_msg_size || msg_out_len > max_msg_size)
116 		return -ENOSPC;
117 
118 	mutex_lock(&pxp->tee_mutex);
119 
120 	if (unlikely(!pxp_component || !pxp_component->ops->gsc_command)) {
121 		ret = -ENODEV;
122 		goto unlock;
123 	}
124 
125 	GEM_BUG_ON(!pxp->stream_cmd.obj);
126 
127 	sg = i915_gem_object_get_sg_dma(pxp->stream_cmd.obj, 0, &offset);
128 
129 	memcpy(pxp->stream_cmd.vaddr, msg_in, msg_in_len);
130 
131 	ret = pxp_component->ops->gsc_command(pxp_component->tee_dev, client_id,
132 					      fence_id, sg, msg_in_len, sg);
133 	if (ret < 0)
134 		drm_err(&i915->drm, "Failed to send PXP TEE gsc command\n");
135 	else
136 		memcpy(msg_out, pxp->stream_cmd.vaddr, msg_out_len);
137 
138 unlock:
139 	mutex_unlock(&pxp->tee_mutex);
140 	return ret;
141 }
142 
143 /**
144  * i915_pxp_tee_component_bind - bind function to pass the function pointers to pxp_tee
145  * @i915_kdev: pointer to i915 kernel device
146  * @tee_kdev: pointer to tee kernel device
147  * @data: pointer to pxp_tee_master containing the function pointers
148  *
149  * This bind function is called during the system boot or resume from system sleep.
150  *
151  * Return: return 0 if successful.
152  */
i915_pxp_tee_component_bind(struct device * i915_kdev,struct device * tee_kdev,void * data)153 static int i915_pxp_tee_component_bind(struct device *i915_kdev,
154 				       struct device *tee_kdev, void *data)
155 {
156 	struct drm_i915_private *i915 = kdev_to_i915(i915_kdev);
157 	struct intel_pxp *pxp = i915->pxp;
158 	struct intel_uc *uc = &pxp->ctrl_gt->uc;
159 	intel_wakeref_t wakeref;
160 	int ret = 0;
161 
162 	if (!HAS_HECI_PXP(i915)) {
163 		STUB();
164 		pxp->dev_link = NULL;
165 #ifdef notyet
166 		pxp->dev_link = device_link_add(i915_kdev, tee_kdev, DL_FLAG_STATELESS);
167 		if (drm_WARN_ON(&i915->drm, !pxp->dev_link))
168 			return -ENODEV;
169 #endif
170 	}
171 
172 	mutex_lock(&pxp->tee_mutex);
173 	pxp->pxp_component = data;
174 	pxp->pxp_component->tee_dev = tee_kdev;
175 	mutex_unlock(&pxp->tee_mutex);
176 
177 	if (intel_uc_uses_huc(uc) && intel_huc_is_loaded_by_gsc(&uc->huc)) {
178 		with_intel_runtime_pm(&i915->runtime_pm, wakeref) {
179 			/* load huc via pxp */
180 			ret = intel_huc_fw_load_and_auth_via_gsc(&uc->huc);
181 			if (ret < 0)
182 				drm_err(&i915->drm, "failed to load huc via gsc %d\n", ret);
183 		}
184 	}
185 
186 	/* if we are suspended, the HW will be re-initialized on resume */
187 	wakeref = intel_runtime_pm_get_if_in_use(&i915->runtime_pm);
188 	if (!wakeref)
189 		return 0;
190 
191 	/* the component is required to fully start the PXP HW */
192 	if (intel_pxp_is_enabled(pxp))
193 		intel_pxp_init_hw(pxp);
194 
195 	intel_runtime_pm_put(&i915->runtime_pm, wakeref);
196 
197 	return ret;
198 }
199 
i915_pxp_tee_component_unbind(struct device * i915_kdev,struct device * tee_kdev,void * data)200 static void i915_pxp_tee_component_unbind(struct device *i915_kdev,
201 					  struct device *tee_kdev, void *data)
202 {
203 	struct drm_i915_private *i915 = kdev_to_i915(i915_kdev);
204 	struct intel_pxp *pxp = i915->pxp;
205 	intel_wakeref_t wakeref;
206 
207 	if (intel_pxp_is_enabled(pxp))
208 		with_intel_runtime_pm_if_in_use(&i915->runtime_pm, wakeref)
209 			intel_pxp_fini_hw(pxp);
210 
211 	mutex_lock(&pxp->tee_mutex);
212 	pxp->pxp_component = NULL;
213 	mutex_unlock(&pxp->tee_mutex);
214 
215 	if (pxp->dev_link) {
216 		STUB();
217 #ifdef notyet
218 		device_link_del(pxp->dev_link);
219 #endif
220 		pxp->dev_link = NULL;
221 	}
222 }
223 
224 static const struct component_ops i915_pxp_tee_component_ops = {
225 	.bind   = i915_pxp_tee_component_bind,
226 	.unbind = i915_pxp_tee_component_unbind,
227 };
228 
alloc_streaming_command(struct intel_pxp * pxp)229 static int alloc_streaming_command(struct intel_pxp *pxp)
230 {
231 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
232 	struct drm_i915_gem_object *obj = NULL;
233 	void *cmd;
234 	int err;
235 
236 	pxp->stream_cmd.obj = NULL;
237 	pxp->stream_cmd.vaddr = NULL;
238 
239 	if (!IS_DGFX(i915))
240 		return 0;
241 
242 	/* allocate lmem object of one page for PXP command memory and store it */
243 	obj = i915_gem_object_create_lmem(i915, PAGE_SIZE, I915_BO_ALLOC_CONTIGUOUS);
244 	if (IS_ERR(obj)) {
245 		drm_err(&i915->drm, "Failed to allocate pxp streaming command!\n");
246 		return PTR_ERR(obj);
247 	}
248 
249 	err = i915_gem_object_pin_pages_unlocked(obj);
250 	if (err) {
251 		drm_err(&i915->drm, "Failed to pin gsc message page!\n");
252 		goto out_put;
253 	}
254 
255 	/* map the lmem into the virtual memory pointer */
256 	cmd = i915_gem_object_pin_map_unlocked(obj,
257 					       intel_gt_coherent_map_type(pxp->ctrl_gt,
258 									  obj, true));
259 	if (IS_ERR(cmd)) {
260 		drm_err(&i915->drm, "Failed to map gsc message page!\n");
261 		err = PTR_ERR(cmd);
262 		goto out_unpin;
263 	}
264 
265 	memset(cmd, 0, obj->base.size);
266 
267 	pxp->stream_cmd.obj = obj;
268 	pxp->stream_cmd.vaddr = cmd;
269 
270 	return 0;
271 
272 out_unpin:
273 	i915_gem_object_unpin_pages(obj);
274 out_put:
275 	i915_gem_object_put(obj);
276 	return err;
277 }
278 
free_streaming_command(struct intel_pxp * pxp)279 static void free_streaming_command(struct intel_pxp *pxp)
280 {
281 	struct drm_i915_gem_object *obj = fetch_and_zero(&pxp->stream_cmd.obj);
282 
283 	if (!obj)
284 		return;
285 
286 	i915_gem_object_unpin_map(obj);
287 	i915_gem_object_unpin_pages(obj);
288 	i915_gem_object_put(obj);
289 }
290 
intel_pxp_tee_component_init(struct intel_pxp * pxp)291 int intel_pxp_tee_component_init(struct intel_pxp *pxp)
292 {
293 	int ret;
294 	struct intel_gt *gt = pxp->ctrl_gt;
295 	struct drm_i915_private *i915 = gt->i915;
296 
297 	ret = alloc_streaming_command(pxp);
298 	if (ret)
299 		return ret;
300 
301 	ret = component_add_typed(i915->drm.dev, &i915_pxp_tee_component_ops,
302 				  I915_COMPONENT_PXP);
303 	if (ret < 0) {
304 		drm_err(&i915->drm, "Failed to add PXP component (%d)\n", ret);
305 		goto out_free;
306 	}
307 
308 	pxp->pxp_component_added = true;
309 
310 	return 0;
311 
312 out_free:
313 	free_streaming_command(pxp);
314 	return ret;
315 }
316 
intel_pxp_tee_component_fini(struct intel_pxp * pxp)317 void intel_pxp_tee_component_fini(struct intel_pxp *pxp)
318 {
319 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
320 
321 	if (!pxp->pxp_component_added)
322 		return;
323 
324 	component_del(i915->drm.dev, &i915_pxp_tee_component_ops);
325 	pxp->pxp_component_added = false;
326 
327 	free_streaming_command(pxp);
328 }
329 
intel_pxp_tee_cmd_create_arb_session(struct intel_pxp * pxp,int arb_session_id)330 int intel_pxp_tee_cmd_create_arb_session(struct intel_pxp *pxp,
331 					 int arb_session_id)
332 {
333 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
334 	struct pxp42_create_arb_in msg_in = {0};
335 	struct pxp42_create_arb_out msg_out = {0};
336 	int ret;
337 
338 	msg_in.header.api_version = PXP_APIVER(4, 2);
339 	msg_in.header.command_id = PXP42_CMDID_INIT_SESSION;
340 	msg_in.header.buffer_len = sizeof(msg_in) - sizeof(msg_in.header);
341 	msg_in.protection_mode = PXP42_ARB_SESSION_MODE_HEAVY;
342 	msg_in.session_id = arb_session_id;
343 
344 	ret = intel_pxp_tee_io_message(pxp,
345 				       &msg_in, sizeof(msg_in),
346 				       &msg_out, sizeof(msg_out),
347 				       NULL);
348 
349 	if (ret) {
350 		drm_err(&i915->drm, "Failed to send tee msg init arb session, ret=[%d]\n", ret);
351 	} else if (msg_out.header.status != 0) {
352 		if (is_fw_err_platform_config(msg_out.header.status)) {
353 			drm_info_once(&i915->drm,
354 				      "PXP init-arb-session-%d failed due to BIOS/SOC:0x%08x:%s\n",
355 				      arb_session_id, msg_out.header.status,
356 				      fw_err_to_string(msg_out.header.status));
357 		} else {
358 			drm_dbg(&i915->drm, "PXP init-arb-session--%d failed 0x%08x:%st:\n",
359 				arb_session_id, msg_out.header.status,
360 				fw_err_to_string(msg_out.header.status));
361 			drm_dbg(&i915->drm, "     cmd-detail: ID=[0x%08x],API-Ver-[0x%08x]\n",
362 				msg_in.header.command_id, msg_in.header.api_version);
363 		}
364 	}
365 
366 	return ret;
367 }
368 
intel_pxp_tee_end_arb_fw_session(struct intel_pxp * pxp,u32 session_id)369 void intel_pxp_tee_end_arb_fw_session(struct intel_pxp *pxp, u32 session_id)
370 {
371 	struct drm_i915_private *i915 = pxp->ctrl_gt->i915;
372 	struct pxp42_inv_stream_key_in msg_in = {0};
373 	struct pxp42_inv_stream_key_out msg_out = {0};
374 	int ret, trials = 0;
375 
376 try_again:
377 	memset(&msg_in, 0, sizeof(msg_in));
378 	memset(&msg_out, 0, sizeof(msg_out));
379 	msg_in.header.api_version = PXP_APIVER(4, 2);
380 	msg_in.header.command_id = PXP42_CMDID_INVALIDATE_STREAM_KEY;
381 	msg_in.header.buffer_len = sizeof(msg_in) - sizeof(msg_in.header);
382 
383 	msg_in.header.stream_id = FIELD_PREP(PXP_CMDHDR_EXTDATA_SESSION_VALID, 1);
384 	msg_in.header.stream_id |= FIELD_PREP(PXP_CMDHDR_EXTDATA_APP_TYPE, 0);
385 	msg_in.header.stream_id |= FIELD_PREP(PXP_CMDHDR_EXTDATA_SESSION_ID, session_id);
386 
387 	ret = intel_pxp_tee_io_message(pxp,
388 				       &msg_in, sizeof(msg_in),
389 				       &msg_out, sizeof(msg_out),
390 				       NULL);
391 
392 	/* Cleanup coherency between GT and Firmware is critical, so try again if it fails */
393 	if ((ret || msg_out.header.status != 0x0) && ++trials < 3)
394 		goto try_again;
395 
396 	if (ret) {
397 		drm_err(&i915->drm, "Failed to send tee msg for inv-stream-key-%u, ret=[%d]\n",
398 			session_id, ret);
399 	} else if (msg_out.header.status != 0) {
400 		if (is_fw_err_platform_config(msg_out.header.status)) {
401 			drm_info_once(&i915->drm,
402 				      "PXP inv-stream-key-%u failed due to BIOS/SOC :0x%08x:%s\n",
403 				      session_id, msg_out.header.status,
404 				      fw_err_to_string(msg_out.header.status));
405 		} else {
406 			drm_dbg(&i915->drm, "PXP inv-stream-key-%u failed 0x%08x:%s:\n",
407 				session_id, msg_out.header.status,
408 				fw_err_to_string(msg_out.header.status));
409 			drm_dbg(&i915->drm, "     cmd-detail: ID=[0x%08x],API-Ver-[0x%08x]\n",
410 				msg_in.header.command_id, msg_in.header.api_version);
411 		}
412 	}
413 }
414