]> git.proxmox.com Git - mirror_ubuntu-jammy-kernel.git/blame - include/drm/drm_print.h
drm/framebuffer: drm_framebuffer_read_refcount() constify argument
[mirror_ubuntu-jammy-kernel.git] / include / drm / drm_print.h
CommitLineData
d8187177
RC
1/*
2 * Copyright (C) 2016 Red Hat
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
17 * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
18 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
19 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
20 * OTHER DEALINGS IN THE SOFTWARE.
21 *
22 * Authors:
23 * Rob Clark <robdclark@gmail.com>
24 */
25
26#ifndef DRM_PRINT_H_
27#define DRM_PRINT_H_
28
3c6d6e0f
JP
29#include <linux/compiler.h>
30#include <linux/printk.h>
d8187177
RC
31#include <linux/seq_file.h>
32#include <linux/device.h>
33
34/**
35 * DOC: print
36 *
37 * A simple wrapper for dev_printk(), seq_printf(), etc. Allows same
38 * debug code to be used for both debugfs and printk logging.
39 *
40 * For example::
41 *
42 * void log_some_info(struct drm_printer *p)
43 * {
44 * drm_printf(p, "foo=%d\n", foo);
45 * drm_printf(p, "bar=%d\n", bar);
46 * }
47 *
48 * #ifdef CONFIG_DEBUG_FS
49 * void debugfs_show(struct seq_file *f)
50 * {
51 * struct drm_printer p = drm_seq_file_printer(f);
52 * log_some_info(&p);
53 * }
54 * #endif
55 *
56 * void some_other_function(...)
57 * {
58 * struct drm_printer p = drm_info_printer(drm->dev);
59 * log_some_info(&p);
60 * }
61 */
62
63/**
64 * struct drm_printer - drm output "stream"
d8187177
RC
65 *
66 * Do not use struct members directly. Use drm_printer_seq_file(),
67 * drm_printer_info(), etc to initialize. And drm_printf() for output.
68 */
69struct drm_printer {
3d387d92 70 /* private: */
d8187177
RC
71 void (*printfn)(struct drm_printer *p, struct va_format *vaf);
72 void *arg;
3d387d92 73 const char *prefix;
d8187177
RC
74};
75
76void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
77void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
3d387d92 78void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);
d8187177 79
3c6d6e0f 80__printf(2, 3)
d8187177
RC
81void drm_printf(struct drm_printer *p, const char *f, ...);
82
83
84/**
85 * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
ea0dd85a 86 * @f: the &struct seq_file to output to
d8187177
RC
87 *
88 * RETURNS:
89 * The &drm_printer object
90 */
91static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
92{
93 struct drm_printer p = {
94 .printfn = __drm_printfn_seq_file,
95 .arg = f,
96 };
97 return p;
98}
99
100/**
101 * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
ea0dd85a 102 * @dev: the &struct device pointer
d8187177
RC
103 *
104 * RETURNS:
105 * The &drm_printer object
106 */
107static inline struct drm_printer drm_info_printer(struct device *dev)
108{
109 struct drm_printer p = {
110 .printfn = __drm_printfn_info,
111 .arg = dev,
112 };
113 return p;
114}
115
3d387d92
DV
116/**
117 * drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
118 * @prefix: debug output prefix
119 *
120 * RETURNS:
121 * The &drm_printer object
122 */
123static inline struct drm_printer drm_debug_printer(const char *prefix)
124{
125 struct drm_printer p = {
126 .printfn = __drm_printfn_debug,
127 .prefix = prefix
128 };
129 return p;
130}
02c9656b
HM
131
132/*
133 * The following categories are defined:
134 *
135 * CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, drm_memory.c, ...
136 * This is the category used by the DRM_DEBUG() macro.
137 *
138 * DRIVER: Used in the vendor specific part of the driver: i915, radeon, ...
139 * This is the category used by the DRM_DEBUG_DRIVER() macro.
140 *
141 * KMS: used in the modesetting code.
142 * This is the category used by the DRM_DEBUG_KMS() macro.
143 *
144 * PRIME: used in the prime code.
145 * This is the category used by the DRM_DEBUG_PRIME() macro.
146 *
147 * ATOMIC: used in the atomic code.
148 * This is the category used by the DRM_DEBUG_ATOMIC() macro.
149 *
150 * VBL: used for verbose debug message in the vblank code
151 * This is the category used by the DRM_DEBUG_VBL() macro.
152 *
153 * Enabling verbose debug messages is done through the drm.debug parameter,
154 * each category being enabled by a bit.
155 *
156 * drm.debug=0x1 will enable CORE messages
157 * drm.debug=0x2 will enable DRIVER messages
158 * drm.debug=0x3 will enable CORE and DRIVER messages
159 * ...
160 * drm.debug=0x3f will enable all messages
161 *
162 * An interesting feature is that it's possible to enable verbose logging at
163 * run-time by echoing the debug value in its sysfs node:
164 * # echo 0xf > /sys/module/drm/parameters/debug
165 */
166#define DRM_UT_NONE 0x00
167#define DRM_UT_CORE 0x01
168#define DRM_UT_DRIVER 0x02
169#define DRM_UT_KMS 0x04
170#define DRM_UT_PRIME 0x08
171#define DRM_UT_ATOMIC 0x10
172#define DRM_UT_VBL 0x20
173#define DRM_UT_STATE 0x40
174
175__printf(6, 7)
176void drm_dev_printk(const struct device *dev, const char *level,
177 unsigned int category, const char *function_name,
178 const char *prefix, const char *format, ...);
179__printf(3, 4)
180void drm_printk(const char *level, unsigned int category,
181 const char *format, ...);
091756bb
HM
182
183/* Macros to make printk easier */
02c9656b
HM
184
185#define _DRM_PRINTK(once, level, fmt, ...) \
186 do { \
187 printk##once(KERN_##level "[" DRM_NAME "] " fmt, \
188 ##__VA_ARGS__); \
189 } while (0)
190
191#define DRM_INFO(fmt, ...) \
192 _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
193#define DRM_NOTE(fmt, ...) \
194 _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
195#define DRM_WARN(fmt, ...) \
196 _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
197
198#define DRM_INFO_ONCE(fmt, ...) \
199 _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
200#define DRM_NOTE_ONCE(fmt, ...) \
201 _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
202#define DRM_WARN_ONCE(fmt, ...) \
203 _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
204
205/**
206 * Error output.
207 *
091756bb
HM
208 * @dev: device pointer
209 * @fmt: printf() like format string.
02c9656b
HM
210 */
211#define DRM_DEV_ERROR(dev, fmt, ...) \
212 drm_dev_printk(dev, KERN_ERR, DRM_UT_NONE, __func__, " *ERROR*",\
213 fmt, ##__VA_ARGS__)
214#define DRM_ERROR(fmt, ...) \
215 drm_printk(KERN_ERR, DRM_UT_NONE, fmt, ##__VA_ARGS__)
216
217/**
218 * Rate limited error output. Like DRM_ERROR() but won't flood the log.
219 *
091756bb
HM
220 * @dev: device pointer
221 * @fmt: printf() like format string.
02c9656b
HM
222 */
223#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \
224({ \
225 static DEFINE_RATELIMIT_STATE(_rs, \
226 DEFAULT_RATELIMIT_INTERVAL, \
227 DEFAULT_RATELIMIT_BURST); \
228 \
229 if (__ratelimit(&_rs)) \
230 DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \
231})
232#define DRM_ERROR_RATELIMITED(fmt, ...) \
233 DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
234
235#define DRM_DEV_INFO(dev, fmt, ...) \
236 drm_dev_printk(dev, KERN_INFO, DRM_UT_NONE, __func__, "", fmt, \
237 ##__VA_ARGS__)
238
239#define DRM_DEV_INFO_ONCE(dev, fmt, ...) \
240({ \
241 static bool __print_once __read_mostly; \
242 if (!__print_once) { \
243 __print_once = true; \
244 DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \
245 } \
246})
247
248/**
249 * Debug output.
250 *
091756bb
HM
251 * @dev: device pointer
252 * @fmt: printf() like format string.
02c9656b
HM
253 */
254#define DRM_DEV_DEBUG(dev, fmt, args...) \
255 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_CORE, __func__, "", fmt, \
256 ##args)
257#define DRM_DEBUG(fmt, ...) \
258 drm_printk(KERN_DEBUG, DRM_UT_CORE, fmt, ##__VA_ARGS__)
259
260#define DRM_DEV_DEBUG_DRIVER(dev, fmt, args...) \
261 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_DRIVER, __func__, "", \
262 fmt, ##args)
263#define DRM_DEBUG_DRIVER(fmt, ...) \
264 drm_printk(KERN_DEBUG, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
265
266#define DRM_DEV_DEBUG_KMS(dev, fmt, args...) \
267 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_KMS, __func__, "", fmt, \
268 ##args)
269#define DRM_DEBUG_KMS(fmt, ...) \
270 drm_printk(KERN_DEBUG, DRM_UT_KMS, fmt, ##__VA_ARGS__)
271
272#define DRM_DEV_DEBUG_PRIME(dev, fmt, args...) \
273 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_PRIME, __func__, "", \
274 fmt, ##args)
275#define DRM_DEBUG_PRIME(fmt, ...) \
276 drm_printk(KERN_DEBUG, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
277
278#define DRM_DEV_DEBUG_ATOMIC(dev, fmt, args...) \
279 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ATOMIC, __func__, "", \
280 fmt, ##args)
281#define DRM_DEBUG_ATOMIC(fmt, ...) \
282 drm_printk(KERN_DEBUG, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
283
284#define DRM_DEV_DEBUG_VBL(dev, fmt, args...) \
285 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_VBL, __func__, "", fmt, \
286 ##args)
287#define DRM_DEBUG_VBL(fmt, ...) \
288 drm_printk(KERN_DEBUG, DRM_UT_VBL, fmt, ##__VA_ARGS__)
289
290#define _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, level, fmt, args...) \
291({ \
292 static DEFINE_RATELIMIT_STATE(_rs, \
293 DEFAULT_RATELIMIT_INTERVAL, \
294 DEFAULT_RATELIMIT_BURST); \
295 if (__ratelimit(&_rs)) \
296 drm_dev_printk(dev, KERN_DEBUG, DRM_UT_ ## level, \
297 __func__, "", fmt, ##args); \
298})
299
300/**
301 * Rate limited debug output. Like DRM_DEBUG() but won't flood the log.
302 *
091756bb
HM
303 * @dev: device pointer
304 * @fmt: printf() like format string.
02c9656b
HM
305 */
306#define DRM_DEV_DEBUG_RATELIMITED(dev, fmt, args...) \
307 DEV__DRM_DEFINE_DEBUG_RATELIMITED(dev, CORE, fmt, ##args)
308#define DRM_DEBUG_RATELIMITED(fmt, args...) \
309 DRM_DEV_DEBUG_RATELIMITED(NULL, fmt, ##args)
310#define DRM_DEV_DEBUG_DRIVER_RATELIMITED(dev, fmt, args...) \
311 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, DRIVER, fmt, ##args)
312#define DRM_DEBUG_DRIVER_RATELIMITED(fmt, args...) \
313 DRM_DEV_DEBUG_DRIVER_RATELIMITED(NULL, fmt, ##args)
314#define DRM_DEV_DEBUG_KMS_RATELIMITED(dev, fmt, args...) \
315 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, KMS, fmt, ##args)
316#define DRM_DEBUG_KMS_RATELIMITED(fmt, args...) \
317 DRM_DEV_DEBUG_KMS_RATELIMITED(NULL, fmt, ##args)
318#define DRM_DEV_DEBUG_PRIME_RATELIMITED(dev, fmt, args...) \
319 _DRM_DEV_DEFINE_DEBUG_RATELIMITED(dev, PRIME, fmt, ##args)
320#define DRM_DEBUG_PRIME_RATELIMITED(fmt, args...) \
321 DRM_DEV_DEBUG_PRIME_RATELIMITED(NULL, fmt, ##args)
322
d8187177 323#endif /* DRM_PRINT_H_ */