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