1 // SPDX-License-Identifier: MIT
2 /*
3  * Copyright © 2014-2019 Intel Corporation
4  */
5 
6 #include <linux/debugfs.h>
7 #include <linux/string_helpers.h>
8 
9 #include "gt/intel_gt.h"
10 #include "i915_drv.h"
11 #include "i915_irq.h"
12 #include "i915_memcpy.h"
13 #include "intel_guc_log.h"
14 
15 static void guc_log_capture_logs(struct intel_guc_log *log);
16 
17 /**
18  * DOC: GuC firmware log
19  *
20  * Firmware log is enabled by setting i915.guc_log_level to the positive level.
21  * Log data is printed out via reading debugfs i915_guc_log_dump. Reading from
22  * i915_guc_load_status will print out firmware loading status and scratch
23  * registers value.
24  */
25 
26 static int guc_action_flush_log_complete(struct intel_guc *guc)
27 {
28 	u32 action[] = {
29 		INTEL_GUC_ACTION_LOG_BUFFER_FILE_FLUSH_COMPLETE
30 	};
31 
32 	return intel_guc_send(guc, action, ARRAY_SIZE(action));
33 }
34 
35 static int guc_action_flush_log(struct intel_guc *guc)
36 {
37 	u32 action[] = {
38 		INTEL_GUC_ACTION_FORCE_LOG_BUFFER_FLUSH,
39 		0
40 	};
41 
42 	return intel_guc_send(guc, action, ARRAY_SIZE(action));
43 }
44 
45 static int guc_action_control_log(struct intel_guc *guc, bool enable,
46 				  bool default_logging, u32 verbosity)
47 {
48 	u32 action[] = {
49 		INTEL_GUC_ACTION_UK_LOG_ENABLE_LOGGING,
50 		(enable ? GUC_LOG_CONTROL_LOGGING_ENABLED : 0) |
51 		(verbosity << GUC_LOG_CONTROL_VERBOSITY_SHIFT) |
52 		(default_logging ? GUC_LOG_CONTROL_DEFAULT_LOGGING : 0)
53 	};
54 
55 	GEM_BUG_ON(verbosity > GUC_LOG_VERBOSITY_MAX);
56 
57 	return intel_guc_send(guc, action, ARRAY_SIZE(action));
58 }
59 
60 /*
61  * Sub buffer switch callback. Called whenever relay has to switch to a new
62  * sub buffer, relay stays on the same sub buffer if 0 is returned.
63  */
64 static int subbuf_start_callback(struct rchan_buf *buf,
65 				 void *subbuf,
66 				 void *prev_subbuf,
67 				 size_t prev_padding)
68 {
69 	/*
70 	 * Use no-overwrite mode by default, where relay will stop accepting
71 	 * new data if there are no empty sub buffers left.
72 	 * There is no strict synchronization enforced by relay between Consumer
73 	 * and Producer. In overwrite mode, there is a possibility of getting
74 	 * inconsistent/garbled data, the producer could be writing on to the
75 	 * same sub buffer from which Consumer is reading. This can't be avoided
76 	 * unless Consumer is fast enough and can always run in tandem with
77 	 * Producer.
78 	 */
79 	if (relay_buf_full(buf))
80 		return 0;
81 
82 	return 1;
83 }
84 
85 /*
86  * file_create() callback. Creates relay file in debugfs.
87  */
88 static struct dentry *create_buf_file_callback(const char *filename,
89 					       struct dentry *parent,
90 					       umode_t mode,
91 					       struct rchan_buf *buf,
92 					       int *is_global)
93 {
94 	struct dentry *buf_file;
95 
96 	/*
97 	 * This to enable the use of a single buffer for the relay channel and
98 	 * correspondingly have a single file exposed to User, through which
99 	 * it can collect the logs in order without any post-processing.
100 	 * Need to set 'is_global' even if parent is NULL for early logging.
101 	 */
102 	*is_global = 1;
103 
104 	if (!parent)
105 		return NULL;
106 
107 	buf_file = debugfs_create_file(filename, mode,
108 				       parent, buf, &relay_file_operations);
109 	if (IS_ERR(buf_file))
110 		return NULL;
111 
112 	return buf_file;
113 }
114 
115 /*
116  * file_remove() default callback. Removes relay file in debugfs.
117  */
118 static int remove_buf_file_callback(struct dentry *dentry)
119 {
120 	debugfs_remove(dentry);
121 	return 0;
122 }
123 
124 /* relay channel callbacks */
125 static const struct rchan_callbacks relay_callbacks = {
126 	.subbuf_start = subbuf_start_callback,
127 	.create_buf_file = create_buf_file_callback,
128 	.remove_buf_file = remove_buf_file_callback,
129 };
130 
131 static void guc_move_to_next_buf(struct intel_guc_log *log)
132 {
133 	/*
134 	 * Make sure the updates made in the sub buffer are visible when
135 	 * Consumer sees the following update to offset inside the sub buffer.
136 	 */
137 	smp_wmb();
138 
139 	/* All data has been written, so now move the offset of sub buffer. */
140 	relay_reserve(log->relay.channel, log->vma->obj->base.size);
141 
142 	/* Switch to the next sub buffer */
143 	relay_flush(log->relay.channel);
144 }
145 
146 static void *guc_get_write_buffer(struct intel_guc_log *log)
147 {
148 	/*
149 	 * Just get the base address of a new sub buffer and copy data into it
150 	 * ourselves. NULL will be returned in no-overwrite mode, if all sub
151 	 * buffers are full. Could have used the relay_write() to indirectly
152 	 * copy the data, but that would have been bit convoluted, as we need to
153 	 * write to only certain locations inside a sub buffer which cannot be
154 	 * done without using relay_reserve() along with relay_write(). So its
155 	 * better to use relay_reserve() alone.
156 	 */
157 	return relay_reserve(log->relay.channel, 0);
158 }
159 
160 static bool guc_check_log_buf_overflow(struct intel_guc_log *log,
161 				       enum guc_log_buffer_type type,
162 				       unsigned int full_cnt)
163 {
164 	unsigned int prev_full_cnt = log->stats[type].sampled_overflow;
165 	bool overflow = false;
166 
167 	if (full_cnt != prev_full_cnt) {
168 		overflow = true;
169 
170 		log->stats[type].overflow = full_cnt;
171 		log->stats[type].sampled_overflow += full_cnt - prev_full_cnt;
172 
173 		if (full_cnt < prev_full_cnt) {
174 			/* buffer_full_cnt is a 4 bit counter */
175 			log->stats[type].sampled_overflow += 16;
176 		}
177 
178 		dev_notice_ratelimited(guc_to_gt(log_to_guc(log))->i915->drm.dev,
179 				       "GuC log buffer overflow\n");
180 	}
181 
182 	return overflow;
183 }
184 
185 static unsigned int guc_get_log_buffer_size(enum guc_log_buffer_type type)
186 {
187 	switch (type) {
188 	case GUC_DEBUG_LOG_BUFFER:
189 		return DEBUG_BUFFER_SIZE;
190 	case GUC_CRASH_DUMP_LOG_BUFFER:
191 		return CRASH_BUFFER_SIZE;
192 	case GUC_CAPTURE_LOG_BUFFER:
193 		return CAPTURE_BUFFER_SIZE;
194 	default:
195 		MISSING_CASE(type);
196 	}
197 
198 	return 0;
199 }
200 
201 static void guc_read_update_log_buffer(struct intel_guc_log *log)
202 {
203 	unsigned int buffer_size, read_offset, write_offset, bytes_to_copy, full_cnt;
204 	struct guc_log_buffer_state *log_buf_state, *log_buf_snapshot_state;
205 	struct guc_log_buffer_state log_buf_state_local;
206 	enum guc_log_buffer_type type;
207 	void *src_data, *dst_data;
208 	bool new_overflow;
209 
210 	mutex_lock(&log->relay.lock);
211 
212 	if (WARN_ON(!intel_guc_log_relay_created(log)))
213 		goto out_unlock;
214 
215 	/* Get the pointer to shared GuC log buffer */
216 	log_buf_state = src_data = log->relay.buf_addr;
217 
218 	/* Get the pointer to local buffer to store the logs */
219 	log_buf_snapshot_state = dst_data = guc_get_write_buffer(log);
220 
221 	if (unlikely(!log_buf_snapshot_state)) {
222 		/*
223 		 * Used rate limited to avoid deluge of messages, logs might be
224 		 * getting consumed by User at a slow rate.
225 		 */
226 		DRM_ERROR_RATELIMITED("no sub-buffer to capture logs\n");
227 		log->relay.full_count++;
228 
229 		goto out_unlock;
230 	}
231 
232 	/* Actual logs are present from the 2nd page */
233 	src_data += PAGE_SIZE;
234 	dst_data += PAGE_SIZE;
235 
236 	for (type = GUC_DEBUG_LOG_BUFFER; type < GUC_MAX_LOG_BUFFER; type++) {
237 		/*
238 		 * Make a copy of the state structure, inside GuC log buffer
239 		 * (which is uncached mapped), on the stack to avoid reading
240 		 * from it multiple times.
241 		 */
242 		memcpy(&log_buf_state_local, log_buf_state,
243 		       sizeof(struct guc_log_buffer_state));
244 		buffer_size = guc_get_log_buffer_size(type);
245 		read_offset = log_buf_state_local.read_ptr;
246 		write_offset = log_buf_state_local.sampled_write_ptr;
247 		full_cnt = log_buf_state_local.buffer_full_cnt;
248 
249 		/* Bookkeeping stuff */
250 		log->stats[type].flush += log_buf_state_local.flush_to_file;
251 		new_overflow = guc_check_log_buf_overflow(log, type, full_cnt);
252 
253 		/* Update the state of shared log buffer */
254 		log_buf_state->read_ptr = write_offset;
255 		log_buf_state->flush_to_file = 0;
256 		log_buf_state++;
257 
258 		/* First copy the state structure in snapshot buffer */
259 		memcpy(log_buf_snapshot_state, &log_buf_state_local,
260 		       sizeof(struct guc_log_buffer_state));
261 
262 		/*
263 		 * The write pointer could have been updated by GuC firmware,
264 		 * after sending the flush interrupt to Host, for consistency
265 		 * set write pointer value to same value of sampled_write_ptr
266 		 * in the snapshot buffer.
267 		 */
268 		log_buf_snapshot_state->write_ptr = write_offset;
269 		log_buf_snapshot_state++;
270 
271 		/* Now copy the actual logs. */
272 		if (unlikely(new_overflow)) {
273 			/* copy the whole buffer in case of overflow */
274 			read_offset = 0;
275 			write_offset = buffer_size;
276 		} else if (unlikely((read_offset > buffer_size) ||
277 				    (write_offset > buffer_size))) {
278 			DRM_ERROR("invalid log buffer state\n");
279 			/* copy whole buffer as offsets are unreliable */
280 			read_offset = 0;
281 			write_offset = buffer_size;
282 		}
283 
284 		/* Just copy the newly written data */
285 		if (read_offset > write_offset) {
286 			i915_memcpy_from_wc(dst_data, src_data, write_offset);
287 			bytes_to_copy = buffer_size - read_offset;
288 		} else {
289 			bytes_to_copy = write_offset - read_offset;
290 		}
291 		i915_memcpy_from_wc(dst_data + read_offset,
292 				    src_data + read_offset, bytes_to_copy);
293 
294 		src_data += buffer_size;
295 		dst_data += buffer_size;
296 	}
297 
298 	guc_move_to_next_buf(log);
299 
300 out_unlock:
301 	mutex_unlock(&log->relay.lock);
302 }
303 
304 static void capture_logs_work(struct work_struct *work)
305 {
306 	struct intel_guc_log *log =
307 		container_of(work, struct intel_guc_log, relay.flush_work);
308 
309 	guc_log_capture_logs(log);
310 }
311 
312 static int guc_log_map(struct intel_guc_log *log)
313 {
314 	void *vaddr;
315 
316 	lockdep_assert_held(&log->relay.lock);
317 
318 	if (!log->vma)
319 		return -ENODEV;
320 
321 	/*
322 	 * Create a WC (Uncached for read) vmalloc mapping of log
323 	 * buffer pages, so that we can directly get the data
324 	 * (up-to-date) from memory.
325 	 */
326 	vaddr = i915_gem_object_pin_map_unlocked(log->vma->obj, I915_MAP_WC);
327 	if (IS_ERR(vaddr))
328 		return PTR_ERR(vaddr);
329 
330 	log->relay.buf_addr = vaddr;
331 
332 	return 0;
333 }
334 
335 static void guc_log_unmap(struct intel_guc_log *log)
336 {
337 	lockdep_assert_held(&log->relay.lock);
338 
339 	i915_gem_object_unpin_map(log->vma->obj);
340 	log->relay.buf_addr = NULL;
341 }
342 
343 void intel_guc_log_init_early(struct intel_guc_log *log)
344 {
345 	mutex_init(&log->relay.lock);
346 	INIT_WORK(&log->relay.flush_work, capture_logs_work);
347 	log->relay.started = false;
348 }
349 
350 static int guc_log_relay_create(struct intel_guc_log *log)
351 {
352 	struct intel_guc *guc = log_to_guc(log);
353 	struct drm_i915_private *dev_priv = guc_to_gt(guc)->i915;
354 	struct rchan *guc_log_relay_chan;
355 	size_t n_subbufs, subbuf_size;
356 	int ret;
357 
358 	lockdep_assert_held(&log->relay.lock);
359 	GEM_BUG_ON(!log->vma);
360 
361 	 /* Keep the size of sub buffers same as shared log buffer */
362 	subbuf_size = log->vma->size;
363 
364 	/*
365 	 * Store up to 8 snapshots, which is large enough to buffer sufficient
366 	 * boot time logs and provides enough leeway to User, in terms of
367 	 * latency, for consuming the logs from relay. Also doesn't take
368 	 * up too much memory.
369 	 */
370 	n_subbufs = 8;
371 
372 	guc_log_relay_chan = relay_open("guc_log",
373 					dev_priv->drm.primary->debugfs_root,
374 					subbuf_size, n_subbufs,
375 					&relay_callbacks, dev_priv);
376 	if (!guc_log_relay_chan) {
377 		DRM_ERROR("Couldn't create relay chan for GuC logging\n");
378 
379 		ret = -ENOMEM;
380 		return ret;
381 	}
382 
383 	GEM_BUG_ON(guc_log_relay_chan->subbuf_size < subbuf_size);
384 	log->relay.channel = guc_log_relay_chan;
385 
386 	return 0;
387 }
388 
389 static void guc_log_relay_destroy(struct intel_guc_log *log)
390 {
391 	lockdep_assert_held(&log->relay.lock);
392 
393 	relay_close(log->relay.channel);
394 	log->relay.channel = NULL;
395 }
396 
397 static void guc_log_capture_logs(struct intel_guc_log *log)
398 {
399 	struct intel_guc *guc = log_to_guc(log);
400 	struct drm_i915_private *dev_priv = guc_to_gt(guc)->i915;
401 	intel_wakeref_t wakeref;
402 
403 	guc_read_update_log_buffer(log);
404 
405 	/*
406 	 * Generally device is expected to be active only at this
407 	 * time, so get/put should be really quick.
408 	 */
409 	with_intel_runtime_pm(&dev_priv->runtime_pm, wakeref)
410 		guc_action_flush_log_complete(guc);
411 }
412 
413 static u32 __get_default_log_level(struct intel_guc_log *log)
414 {
415 	struct intel_guc *guc = log_to_guc(log);
416 	struct drm_i915_private *i915 = guc_to_gt(guc)->i915;
417 
418 	/* A negative value means "use platform/config default" */
419 	if (i915->params.guc_log_level < 0) {
420 		return (IS_ENABLED(CONFIG_DRM_I915_DEBUG) ||
421 			IS_ENABLED(CONFIG_DRM_I915_DEBUG_GEM)) ?
422 			GUC_LOG_LEVEL_MAX : GUC_LOG_LEVEL_NON_VERBOSE;
423 	}
424 
425 	if (i915->params.guc_log_level > GUC_LOG_LEVEL_MAX) {
426 		DRM_WARN("Incompatible option detected: %s=%d, %s!\n",
427 			 "guc_log_level", i915->params.guc_log_level,
428 			 "verbosity too high");
429 		return (IS_ENABLED(CONFIG_DRM_I915_DEBUG) ||
430 			IS_ENABLED(CONFIG_DRM_I915_DEBUG_GEM)) ?
431 			GUC_LOG_LEVEL_MAX : GUC_LOG_LEVEL_DISABLED;
432 	}
433 
434 	GEM_BUG_ON(i915->params.guc_log_level < GUC_LOG_LEVEL_DISABLED);
435 	GEM_BUG_ON(i915->params.guc_log_level > GUC_LOG_LEVEL_MAX);
436 	return i915->params.guc_log_level;
437 }
438 
439 int intel_guc_log_create(struct intel_guc_log *log)
440 {
441 	struct intel_guc *guc = log_to_guc(log);
442 	struct i915_vma *vma;
443 	u32 guc_log_size;
444 	int ret;
445 
446 	GEM_BUG_ON(log->vma);
447 
448 	/*
449 	 *  GuC Log buffer Layout
450 	 *
451 	 *  +===============================+ 00B
452 	 *  |    Crash dump state header    |
453 	 *  +-------------------------------+ 32B
454 	 *  |      Debug state header       |
455 	 *  +-------------------------------+ 64B
456 	 *  |     Capture state header      |
457 	 *  +-------------------------------+ 96B
458 	 *  |                               |
459 	 *  +===============================+ PAGE_SIZE (4KB)
460 	 *  |        Crash Dump logs        |
461 	 *  +===============================+ + CRASH_SIZE
462 	 *  |          Debug logs           |
463 	 *  +===============================+ + DEBUG_SIZE
464 	 *  |         Capture logs          |
465 	 *  +===============================+ + CAPTURE_SIZE
466 	 */
467 	guc_log_size = PAGE_SIZE + CRASH_BUFFER_SIZE + DEBUG_BUFFER_SIZE +
468 		       CAPTURE_BUFFER_SIZE;
469 
470 	vma = intel_guc_allocate_vma(guc, guc_log_size);
471 	if (IS_ERR(vma)) {
472 		ret = PTR_ERR(vma);
473 		goto err;
474 	}
475 
476 	log->vma = vma;
477 
478 	log->level = __get_default_log_level(log);
479 	DRM_DEBUG_DRIVER("guc_log_level=%d (%s, verbose:%s, verbosity:%d)\n",
480 			 log->level, str_enabled_disabled(log->level),
481 			 str_yes_no(GUC_LOG_LEVEL_IS_VERBOSE(log->level)),
482 			 GUC_LOG_LEVEL_TO_VERBOSITY(log->level));
483 
484 	return 0;
485 
486 err:
487 	DRM_ERROR("Failed to allocate GuC log buffer. %d\n", ret);
488 	return ret;
489 }
490 
491 void intel_guc_log_destroy(struct intel_guc_log *log)
492 {
493 	i915_vma_unpin_and_release(&log->vma, 0);
494 }
495 
496 int intel_guc_log_set_level(struct intel_guc_log *log, u32 level)
497 {
498 	struct intel_guc *guc = log_to_guc(log);
499 	struct drm_i915_private *dev_priv = guc_to_gt(guc)->i915;
500 	intel_wakeref_t wakeref;
501 	int ret = 0;
502 
503 	BUILD_BUG_ON(GUC_LOG_VERBOSITY_MIN != 0);
504 	GEM_BUG_ON(!log->vma);
505 
506 	/*
507 	 * GuC is recognizing log levels starting from 0 to max, we're using 0
508 	 * as indication that logging should be disabled.
509 	 */
510 	if (level < GUC_LOG_LEVEL_DISABLED || level > GUC_LOG_LEVEL_MAX)
511 		return -EINVAL;
512 
513 	mutex_lock(&dev_priv->drm.struct_mutex);
514 
515 	if (log->level == level)
516 		goto out_unlock;
517 
518 	with_intel_runtime_pm(&dev_priv->runtime_pm, wakeref)
519 		ret = guc_action_control_log(guc,
520 					     GUC_LOG_LEVEL_IS_VERBOSE(level),
521 					     GUC_LOG_LEVEL_IS_ENABLED(level),
522 					     GUC_LOG_LEVEL_TO_VERBOSITY(level));
523 	if (ret) {
524 		DRM_DEBUG_DRIVER("guc_log_control action failed %d\n", ret);
525 		goto out_unlock;
526 	}
527 
528 	log->level = level;
529 
530 out_unlock:
531 	mutex_unlock(&dev_priv->drm.struct_mutex);
532 
533 	return ret;
534 }
535 
536 bool intel_guc_log_relay_created(const struct intel_guc_log *log)
537 {
538 	return log->relay.buf_addr;
539 }
540 
541 int intel_guc_log_relay_open(struct intel_guc_log *log)
542 {
543 	int ret;
544 
545 	if (!log->vma)
546 		return -ENODEV;
547 
548 	mutex_lock(&log->relay.lock);
549 
550 	if (intel_guc_log_relay_created(log)) {
551 		ret = -EEXIST;
552 		goto out_unlock;
553 	}
554 
555 	/*
556 	 * We require SSE 4.1 for fast reads from the GuC log buffer and
557 	 * it should be present on the chipsets supporting GuC based
558 	 * submisssions.
559 	 */
560 	if (!i915_has_memcpy_from_wc()) {
561 		ret = -ENXIO;
562 		goto out_unlock;
563 	}
564 
565 	ret = guc_log_relay_create(log);
566 	if (ret)
567 		goto out_unlock;
568 
569 	ret = guc_log_map(log);
570 	if (ret)
571 		goto out_relay;
572 
573 	mutex_unlock(&log->relay.lock);
574 
575 	return 0;
576 
577 out_relay:
578 	guc_log_relay_destroy(log);
579 out_unlock:
580 	mutex_unlock(&log->relay.lock);
581 
582 	return ret;
583 }
584 
585 int intel_guc_log_relay_start(struct intel_guc_log *log)
586 {
587 	if (log->relay.started)
588 		return -EEXIST;
589 
590 	/*
591 	 * When GuC is logging without us relaying to userspace, we're ignoring
592 	 * the flush notification. This means that we need to unconditionally
593 	 * flush on relay enabling, since GuC only notifies us once.
594 	 */
595 	queue_work(system_highpri_wq, &log->relay.flush_work);
596 
597 	log->relay.started = true;
598 
599 	return 0;
600 }
601 
602 void intel_guc_log_relay_flush(struct intel_guc_log *log)
603 {
604 	struct intel_guc *guc = log_to_guc(log);
605 	intel_wakeref_t wakeref;
606 
607 	if (!log->relay.started)
608 		return;
609 
610 	/*
611 	 * Before initiating the forceful flush, wait for any pending/ongoing
612 	 * flush to complete otherwise forceful flush may not actually happen.
613 	 */
614 	flush_work(&log->relay.flush_work);
615 
616 	with_intel_runtime_pm(guc_to_gt(guc)->uncore->rpm, wakeref)
617 		guc_action_flush_log(guc);
618 
619 	/* GuC would have updated log buffer by now, so capture it */
620 	guc_log_capture_logs(log);
621 }
622 
623 /*
624  * Stops the relay log. Called from intel_guc_log_relay_close(), so no
625  * possibility of race with start/flush since relay_write cannot race
626  * relay_close.
627  */
628 static void guc_log_relay_stop(struct intel_guc_log *log)
629 {
630 	struct intel_guc *guc = log_to_guc(log);
631 	struct drm_i915_private *i915 = guc_to_gt(guc)->i915;
632 
633 	if (!log->relay.started)
634 		return;
635 
636 	intel_synchronize_irq(i915);
637 
638 	flush_work(&log->relay.flush_work);
639 
640 	log->relay.started = false;
641 }
642 
643 void intel_guc_log_relay_close(struct intel_guc_log *log)
644 {
645 	guc_log_relay_stop(log);
646 
647 	mutex_lock(&log->relay.lock);
648 	GEM_BUG_ON(!intel_guc_log_relay_created(log));
649 	guc_log_unmap(log);
650 	guc_log_relay_destroy(log);
651 	mutex_unlock(&log->relay.lock);
652 }
653 
654 void intel_guc_log_handle_flush_event(struct intel_guc_log *log)
655 {
656 	if (log->relay.started)
657 		queue_work(system_highpri_wq, &log->relay.flush_work);
658 }
659 
660 static const char *
661 stringify_guc_log_type(enum guc_log_buffer_type type)
662 {
663 	switch (type) {
664 	case GUC_DEBUG_LOG_BUFFER:
665 		return "DEBUG";
666 	case GUC_CRASH_DUMP_LOG_BUFFER:
667 		return "CRASH";
668 	case GUC_CAPTURE_LOG_BUFFER:
669 		return "CAPTURE";
670 	default:
671 		MISSING_CASE(type);
672 	}
673 
674 	return "";
675 }
676 
677 /**
678  * intel_guc_log_info - dump information about GuC log relay
679  * @log: the GuC log
680  * @p: the &drm_printer
681  *
682  * Pretty printer for GuC log info
683  */
684 void intel_guc_log_info(struct intel_guc_log *log, struct drm_printer *p)
685 {
686 	enum guc_log_buffer_type type;
687 
688 	if (!intel_guc_log_relay_created(log)) {
689 		drm_puts(p, "GuC log relay not created\n");
690 		return;
691 	}
692 
693 	drm_puts(p, "GuC logging stats:\n");
694 
695 	drm_printf(p, "\tRelay full count: %u\n", log->relay.full_count);
696 
697 	for (type = GUC_DEBUG_LOG_BUFFER; type < GUC_MAX_LOG_BUFFER; type++) {
698 		drm_printf(p, "\t%s:\tflush count %10u, overflow count %10u\n",
699 			   stringify_guc_log_type(type),
700 			   log->stats[type].flush,
701 			   log->stats[type].sampled_overflow);
702 	}
703 }
704 
705 /**
706  * intel_guc_log_dump - dump the contents of the GuC log
707  * @log: the GuC log
708  * @p: the &drm_printer
709  * @dump_load_err: dump the log saved on GuC load error
710  *
711  * Pretty printer for the GuC log
712  */
713 int intel_guc_log_dump(struct intel_guc_log *log, struct drm_printer *p,
714 		       bool dump_load_err)
715 {
716 	struct intel_guc *guc = log_to_guc(log);
717 	struct intel_uc *uc = container_of(guc, struct intel_uc, guc);
718 	struct drm_i915_gem_object *obj = NULL;
719 	u32 *map;
720 	int i = 0;
721 
722 	if (!intel_guc_is_supported(guc))
723 		return -ENODEV;
724 
725 	if (dump_load_err)
726 		obj = uc->load_err_log;
727 	else if (guc->log.vma)
728 		obj = guc->log.vma->obj;
729 
730 	if (!obj)
731 		return 0;
732 
733 	map = i915_gem_object_pin_map_unlocked(obj, I915_MAP_WC);
734 	if (IS_ERR(map)) {
735 		DRM_DEBUG("Failed to pin object\n");
736 		drm_puts(p, "(log data unaccessible)\n");
737 		return PTR_ERR(map);
738 	}
739 
740 	for (i = 0; i < obj->base.size / sizeof(u32); i += 4)
741 		drm_printf(p, "0x%08x 0x%08x 0x%08x 0x%08x\n",
742 			   *(map + i), *(map + i + 1),
743 			   *(map + i + 2), *(map + i + 3));
744 
745 	drm_puts(p, "\n");
746 
747 	i915_gem_object_unpin_map(obj);
748 
749 	return 0;
750 }
751