1 /* SPDX-License-Identifier: MIT */
2 /*
3  * Copyright © 2014-2019 Intel Corporation
4  */
5 
6 #ifndef _INTEL_GUC_LOG_H_
7 #define _INTEL_GUC_LOG_H_
8 
9 #include <linux/mutex.h>
10 #include <linux/relay.h>
11 #include <linux/workqueue.h>
12 
13 #include "intel_guc_fwif.h"
14 #include "i915_gem.h"
15 
16 struct intel_guc;
17 
18 #ifdef CONFIG_DRM_I915_DEBUG_GUC
19 #define CRASH_BUFFER_SIZE	SZ_2M
20 #define DEBUG_BUFFER_SIZE	SZ_16M
21 #else
22 #define CRASH_BUFFER_SIZE	SZ_8K
23 #define DEBUG_BUFFER_SIZE	SZ_64K
24 #endif
25 
26 /*
27  * While we're using plain log level in i915, GuC controls are much more...
28  * "elaborate"? We have a couple of bits for verbosity, separate bit for actual
29  * log enabling, and separate bit for default logging - which "conveniently"
30  * ignores the enable bit.
31  */
32 #define GUC_LOG_LEVEL_DISABLED		0
33 #define GUC_LOG_LEVEL_NON_VERBOSE	1
34 #define GUC_LOG_LEVEL_IS_ENABLED(x)	((x) > GUC_LOG_LEVEL_DISABLED)
35 #define GUC_LOG_LEVEL_IS_VERBOSE(x)	((x) > GUC_LOG_LEVEL_NON_VERBOSE)
36 #define GUC_LOG_LEVEL_TO_VERBOSITY(x) ({		\
37 	typeof(x) _x = (x);				\
38 	GUC_LOG_LEVEL_IS_VERBOSE(_x) ? _x - 2 : 0;	\
39 })
40 #define GUC_VERBOSITY_TO_LOG_LEVEL(x)	((x) + 2)
41 #define GUC_LOG_LEVEL_MAX GUC_VERBOSITY_TO_LOG_LEVEL(GUC_LOG_VERBOSITY_MAX)
42 
43 struct intel_guc_log {
44 	u32 level;
45 	struct i915_vma *vma;
46 	struct {
47 		void *buf_addr;
48 		bool started;
49 		struct work_struct flush_work;
50 		struct rchan *channel;
51 		struct mutex lock;
52 		u32 full_count;
53 	} relay;
54 	/* logging related stats */
55 	struct {
56 		u32 sampled_overflow;
57 		u32 overflow;
58 		u32 flush;
59 	} stats[GUC_MAX_LOG_BUFFER];
60 };
61 
62 void intel_guc_log_init_early(struct intel_guc_log *log);
63 int intel_guc_log_create(struct intel_guc_log *log);
64 void intel_guc_log_destroy(struct intel_guc_log *log);
65 
66 int intel_guc_log_set_level(struct intel_guc_log *log, u32 level);
67 bool intel_guc_log_relay_created(const struct intel_guc_log *log);
68 int intel_guc_log_relay_open(struct intel_guc_log *log);
69 int intel_guc_log_relay_start(struct intel_guc_log *log);
70 void intel_guc_log_relay_flush(struct intel_guc_log *log);
71 void intel_guc_log_relay_close(struct intel_guc_log *log);
72 
73 void intel_guc_log_handle_flush_event(struct intel_guc_log *log);
74 
75 static inline u32 intel_guc_log_get_level(struct intel_guc_log *log)
76 {
77 	return log->level;
78 }
79 
80 void intel_guc_log_info(struct intel_guc_log *log, struct drm_printer *p);
81 int intel_guc_log_dump(struct intel_guc_log *log, struct drm_printer *p,
82 		       bool dump_load_err);
83 
84 #endif
85