1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/*
* Copyright (C) 2016 Red Hat
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
* THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
* OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
* ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
* OTHER DEALINGS IN THE SOFTWARE.
*
* Authors:
* Rob Clark <robdclark@gmail.com>
*/
#ifndef DRM_PRINT_H_
#define DRM_PRINT_H_
#include <linux/compiler.h>
#include <linux/printk.h>
#include <linux/seq_file.h>
#include <linux/device.h>
/**
* DOC: print
*
* A simple wrapper for dev_printk(), seq_printf(), etc. Allows same
* debug code to be used for both debugfs and printk logging.
*
* For example::
*
* void log_some_info(struct drm_printer *p)
* {
* drm_printf(p, "foo=%d\n", foo);
* drm_printf(p, "bar=%d\n", bar);
* }
*
* #ifdef CONFIG_DEBUG_FS
* void debugfs_show(struct seq_file *f)
* {
* struct drm_printer p = drm_seq_file_printer(f);
* log_some_info(&p);
* }
* #endif
*
* void some_other_function(...)
* {
* struct drm_printer p = drm_info_printer(drm->dev);
* log_some_info(&p);
* }
*/
/**
* struct drm_printer - drm output "stream"
*
* Do not use struct members directly. Use drm_printer_seq_file(),
* drm_printer_info(), etc to initialize. And drm_printf() for output.
*/
struct drm_printer {
/* private: */
void (*printfn)(struct drm_printer *p, struct va_format *vaf);
void *arg;
const char *prefix;
};
void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);
__printf(2, 3)
void drm_printf(struct drm_printer *p, const char *f, ...);
/**
* drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
* @f: the &struct seq_file to output to
*
* RETURNS:
* The &drm_printer object
*/
static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
{
struct drm_printer p = {
.printfn = __drm_printfn_seq_file,
.arg = f,
};
return p;
}
/**
* drm_info_printer - construct a &drm_printer that outputs to dev_printk()
* @dev: the &struct device pointer
*
* RETURNS:
* The &drm_printer object
*/
static inline struct drm_printer drm_info_printer(struct device *dev)
{
struct drm_printer p = {
.printfn = __drm_printfn_info,
.arg = dev,
};
return p;
}
/**
* drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
* @prefix: debug output prefix
*
* RETURNS:
* The &drm_printer object
*/
static inline struct drm_printer drm_debug_printer(const char *prefix)
{
struct drm_printer p = {
.printfn = __drm_printfn_debug,
.prefix = prefix
};
return p;
}
#endif /* DRM_PRINT_H_ */
|
