1d8187177SRob Clark /* 2d8187177SRob Clark * Copyright (C) 2016 Red Hat 3d8187177SRob Clark * 4d8187177SRob Clark * Permission is hereby granted, free of charge, to any person obtaining a 5d8187177SRob Clark * copy of this software and associated documentation files (the "Software"), 6d8187177SRob Clark * to deal in the Software without restriction, including without limitation 7d8187177SRob Clark * the rights to use, copy, modify, merge, publish, distribute, sublicense, 8d8187177SRob Clark * and/or sell copies of the Software, and to permit persons to whom the 9d8187177SRob Clark * Software is furnished to do so, subject to the following conditions: 10d8187177SRob Clark * 11d8187177SRob Clark * The above copyright notice and this permission notice shall be included in 12d8187177SRob Clark * all copies or substantial portions of the Software. 13d8187177SRob Clark * 14d8187177SRob Clark * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 15d8187177SRob Clark * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 16d8187177SRob Clark * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 17d8187177SRob Clark * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR 18d8187177SRob Clark * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 19d8187177SRob Clark * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 20d8187177SRob Clark * OTHER DEALINGS IN THE SOFTWARE. 21d8187177SRob Clark * 22d8187177SRob Clark * Authors: 23d8187177SRob Clark * Rob Clark <robdclark@gmail.com> 24d8187177SRob Clark */ 25d8187177SRob Clark 26d8187177SRob Clark #ifndef DRM_PRINT_H_ 27d8187177SRob Clark #define DRM_PRINT_H_ 28d8187177SRob Clark 293c6d6e0fSJoe Perches #include <linux/compiler.h> 303c6d6e0fSJoe Perches #include <linux/printk.h> 31d8187177SRob Clark #include <linux/seq_file.h> 32d8187177SRob Clark #include <linux/device.h> 335f513cc8SEric Anholt #include <linux/debugfs.h> 34d8187177SRob Clark 35656600efSSam Ravnborg #include <drm/drm.h> 36656600efSSam Ravnborg 379f0ac028SJani Nikula /* Do *not* use outside of drm_print.[ch]! */ 389f0ac028SJani Nikula extern unsigned int __drm_debug; 39959b077fSJani Nikula 40d8187177SRob Clark /** 41d8187177SRob Clark * DOC: print 42d8187177SRob Clark * 43d8187177SRob Clark * A simple wrapper for dev_printk(), seq_printf(), etc. Allows same 44d8187177SRob Clark * debug code to be used for both debugfs and printk logging. 45d8187177SRob Clark * 46d8187177SRob Clark * For example:: 47d8187177SRob Clark * 48d8187177SRob Clark * void log_some_info(struct drm_printer *p) 49d8187177SRob Clark * { 50d8187177SRob Clark * drm_printf(p, "foo=%d\n", foo); 51d8187177SRob Clark * drm_printf(p, "bar=%d\n", bar); 52d8187177SRob Clark * } 53d8187177SRob Clark * 54d8187177SRob Clark * #ifdef CONFIG_DEBUG_FS 55d8187177SRob Clark * void debugfs_show(struct seq_file *f) 56d8187177SRob Clark * { 57d8187177SRob Clark * struct drm_printer p = drm_seq_file_printer(f); 58d8187177SRob Clark * log_some_info(&p); 59d8187177SRob Clark * } 60d8187177SRob Clark * #endif 61d8187177SRob Clark * 62d8187177SRob Clark * void some_other_function(...) 63d8187177SRob Clark * { 64d8187177SRob Clark * struct drm_printer p = drm_info_printer(drm->dev); 65d8187177SRob Clark * log_some_info(&p); 66d8187177SRob Clark * } 67d8187177SRob Clark */ 68d8187177SRob Clark 69d8187177SRob Clark /** 70d8187177SRob Clark * struct drm_printer - drm output "stream" 71d8187177SRob Clark * 72d8187177SRob Clark * Do not use struct members directly. Use drm_printer_seq_file(), 73d8187177SRob Clark * drm_printer_info(), etc to initialize. And drm_printf() for output. 74d8187177SRob Clark */ 75d8187177SRob Clark struct drm_printer { 763d387d92SDaniel Vetter /* private: */ 77d8187177SRob Clark void (*printfn)(struct drm_printer *p, struct va_format *vaf); 7863f4cc01SJordan Crouse void (*puts)(struct drm_printer *p, const char *str); 79d8187177SRob Clark void *arg; 803d387d92SDaniel Vetter const char *prefix; 81d8187177SRob Clark }; 82d8187177SRob Clark 83cfc57a18SJordan Crouse void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf); 845dc634bdSJordan Crouse void __drm_puts_coredump(struct drm_printer *p, const char *str); 85d8187177SRob Clark void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf); 864538d732SJordan Crouse void __drm_puts_seq_file(struct drm_printer *p, const char *str); 87d8187177SRob Clark void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf); 883d387d92SDaniel Vetter void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf); 890de54fb2SLyude Paul void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf); 90d8187177SRob Clark 913c6d6e0fSJoe Perches __printf(2, 3) 92d8187177SRob Clark void drm_printf(struct drm_printer *p, const char *f, ...); 9363f4cc01SJordan Crouse void drm_puts(struct drm_printer *p, const char *str); 945f513cc8SEric Anholt void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset); 95141f6357SGerd Hoffmann void drm_print_bits(struct drm_printer *p, unsigned long value, 96141f6357SGerd Hoffmann const char * const bits[], unsigned int nbits); 97d8187177SRob Clark 9842f1b310SDaniel Vetter __printf(2, 0) 99bf6234a2SNoralf Trønnes /** 100e2b155e9SChris Wilson * drm_vprintf - print to a &drm_printer stream 101e2b155e9SChris Wilson * @p: the &drm_printer 102e2b155e9SChris Wilson * @fmt: format string 103e2b155e9SChris Wilson * @va: the va_list 104e2b155e9SChris Wilson */ 105e2b155e9SChris Wilson static inline void 106e2b155e9SChris Wilson drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va) 107e2b155e9SChris Wilson { 108e2b155e9SChris Wilson struct va_format vaf = { .fmt = fmt, .va = va }; 109e2b155e9SChris Wilson 110e2b155e9SChris Wilson p->printfn(p, &vaf); 111e2b155e9SChris Wilson } 112e2b155e9SChris Wilson 113e2b155e9SChris Wilson /** 114bf6234a2SNoralf Trønnes * drm_printf_indent - Print to a &drm_printer stream with indentation 115bf6234a2SNoralf Trønnes * @printer: DRM printer 116bf6234a2SNoralf Trønnes * @indent: Tab indentation level (max 5) 117bf6234a2SNoralf Trønnes * @fmt: Format string 118bf6234a2SNoralf Trønnes */ 119bf6234a2SNoralf Trønnes #define drm_printf_indent(printer, indent, fmt, ...) \ 120bf6234a2SNoralf Trønnes drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__) 121d8187177SRob Clark 122d8187177SRob Clark /** 123cfc57a18SJordan Crouse * struct drm_print_iterator - local struct used with drm_printer_coredump 124cfc57a18SJordan Crouse * @data: Pointer to the devcoredump output buffer 125cfc57a18SJordan Crouse * @start: The offset within the buffer to start writing 126cfc57a18SJordan Crouse * @remain: The number of bytes to write for this iteration 127cfc57a18SJordan Crouse */ 128cfc57a18SJordan Crouse struct drm_print_iterator { 129cfc57a18SJordan Crouse void *data; 130cfc57a18SJordan Crouse ssize_t start; 131cfc57a18SJordan Crouse ssize_t remain; 132cfc57a18SJordan Crouse /* private: */ 133cfc57a18SJordan Crouse ssize_t offset; 134cfc57a18SJordan Crouse }; 135cfc57a18SJordan Crouse 136cfc57a18SJordan Crouse /** 137cfc57a18SJordan Crouse * drm_coredump_printer - construct a &drm_printer that can output to a buffer 138cfc57a18SJordan Crouse * from the read function for devcoredump 139cfc57a18SJordan Crouse * @iter: A pointer to a struct drm_print_iterator for the read instance 140cfc57a18SJordan Crouse * 141cfc57a18SJordan Crouse * This wrapper extends drm_printf() to work with a dev_coredumpm() callback 142cfc57a18SJordan Crouse * function. The passed in drm_print_iterator struct contains the buffer 143cfc57a18SJordan Crouse * pointer, size and offset as passed in from devcoredump. 144cfc57a18SJordan Crouse * 145cfc57a18SJordan Crouse * For example:: 146cfc57a18SJordan Crouse * 147cfc57a18SJordan Crouse * void coredump_read(char *buffer, loff_t offset, size_t count, 148cfc57a18SJordan Crouse * void *data, size_t datalen) 149cfc57a18SJordan Crouse * { 150cfc57a18SJordan Crouse * struct drm_print_iterator iter; 151cfc57a18SJordan Crouse * struct drm_printer p; 152cfc57a18SJordan Crouse * 153cfc57a18SJordan Crouse * iter.data = buffer; 154cfc57a18SJordan Crouse * iter.start = offset; 155cfc57a18SJordan Crouse * iter.remain = count; 156cfc57a18SJordan Crouse * 157cfc57a18SJordan Crouse * p = drm_coredump_printer(&iter); 158cfc57a18SJordan Crouse * 159cfc57a18SJordan Crouse * drm_printf(p, "foo=%d\n", foo); 160cfc57a18SJordan Crouse * } 161cfc57a18SJordan Crouse * 162cfc57a18SJordan Crouse * void makecoredump(...) 163cfc57a18SJordan Crouse * { 164cfc57a18SJordan Crouse * ... 165cfc57a18SJordan Crouse * dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL, 166cfc57a18SJordan Crouse * coredump_read, ...) 167cfc57a18SJordan Crouse * } 168cfc57a18SJordan Crouse * 169cfc57a18SJordan Crouse * RETURNS: 170cfc57a18SJordan Crouse * The &drm_printer object 171cfc57a18SJordan Crouse */ 172cfc57a18SJordan Crouse static inline struct drm_printer 173cfc57a18SJordan Crouse drm_coredump_printer(struct drm_print_iterator *iter) 174cfc57a18SJordan Crouse { 175cfc57a18SJordan Crouse struct drm_printer p = { 176cfc57a18SJordan Crouse .printfn = __drm_printfn_coredump, 1775dc634bdSJordan Crouse .puts = __drm_puts_coredump, 178cfc57a18SJordan Crouse .arg = iter, 179cfc57a18SJordan Crouse }; 180cfc57a18SJordan Crouse 181cfc57a18SJordan Crouse /* Set the internal offset of the iterator to zero */ 182cfc57a18SJordan Crouse iter->offset = 0; 183cfc57a18SJordan Crouse 184cfc57a18SJordan Crouse return p; 185cfc57a18SJordan Crouse } 186cfc57a18SJordan Crouse 187cfc57a18SJordan Crouse /** 188d8187177SRob Clark * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file 189ea0dd85aSDaniel Vetter * @f: the &struct seq_file to output to 190d8187177SRob Clark * 191d8187177SRob Clark * RETURNS: 192d8187177SRob Clark * The &drm_printer object 193d8187177SRob Clark */ 194d8187177SRob Clark static inline struct drm_printer drm_seq_file_printer(struct seq_file *f) 195d8187177SRob Clark { 196d8187177SRob Clark struct drm_printer p = { 197d8187177SRob Clark .printfn = __drm_printfn_seq_file, 1984538d732SJordan Crouse .puts = __drm_puts_seq_file, 199d8187177SRob Clark .arg = f, 200d8187177SRob Clark }; 201d8187177SRob Clark return p; 202d8187177SRob Clark } 203d8187177SRob Clark 204d8187177SRob Clark /** 205d8187177SRob Clark * drm_info_printer - construct a &drm_printer that outputs to dev_printk() 206ea0dd85aSDaniel Vetter * @dev: the &struct device pointer 207d8187177SRob Clark * 208d8187177SRob Clark * RETURNS: 209d8187177SRob Clark * The &drm_printer object 210d8187177SRob Clark */ 211d8187177SRob Clark static inline struct drm_printer drm_info_printer(struct device *dev) 212d8187177SRob Clark { 213d8187177SRob Clark struct drm_printer p = { 214d8187177SRob Clark .printfn = __drm_printfn_info, 215d8187177SRob Clark .arg = dev, 216d8187177SRob Clark }; 217d8187177SRob Clark return p; 218d8187177SRob Clark } 219d8187177SRob Clark 2203d387d92SDaniel Vetter /** 2213d387d92SDaniel Vetter * drm_debug_printer - construct a &drm_printer that outputs to pr_debug() 2223d387d92SDaniel Vetter * @prefix: debug output prefix 2233d387d92SDaniel Vetter * 2243d387d92SDaniel Vetter * RETURNS: 2253d387d92SDaniel Vetter * The &drm_printer object 2263d387d92SDaniel Vetter */ 2273d387d92SDaniel Vetter static inline struct drm_printer drm_debug_printer(const char *prefix) 2283d387d92SDaniel Vetter { 2293d387d92SDaniel Vetter struct drm_printer p = { 2303d387d92SDaniel Vetter .printfn = __drm_printfn_debug, 2313d387d92SDaniel Vetter .prefix = prefix 2323d387d92SDaniel Vetter }; 2333d387d92SDaniel Vetter return p; 2343d387d92SDaniel Vetter } 23502c9656bSHaneen Mohammed 2360de54fb2SLyude Paul /** 2370de54fb2SLyude Paul * drm_err_printer - construct a &drm_printer that outputs to pr_err() 2380de54fb2SLyude Paul * @prefix: debug output prefix 2390de54fb2SLyude Paul * 2400de54fb2SLyude Paul * RETURNS: 2410de54fb2SLyude Paul * The &drm_printer object 2420de54fb2SLyude Paul */ 2430de54fb2SLyude Paul static inline struct drm_printer drm_err_printer(const char *prefix) 2440de54fb2SLyude Paul { 2450de54fb2SLyude Paul struct drm_printer p = { 2460de54fb2SLyude Paul .printfn = __drm_printfn_err, 2470de54fb2SLyude Paul .prefix = prefix 2480de54fb2SLyude Paul }; 2490de54fb2SLyude Paul return p; 2500de54fb2SLyude Paul } 2510de54fb2SLyude Paul 252876905b8SJani Nikula /** 253876905b8SJani Nikula * enum drm_debug_category - The DRM debug categories 25402c9656bSHaneen Mohammed * 255876905b8SJani Nikula * Each of the DRM debug logging macros use a specific category, and the logging 256876905b8SJani Nikula * is filtered by the drm.debug module parameter. This enum specifies the values 257876905b8SJani Nikula * for the interface. 25802c9656bSHaneen Mohammed * 259876905b8SJani Nikula * Each DRM_DEBUG_<CATEGORY> macro logs to DRM_UT_<CATEGORY> category, except 260876905b8SJani Nikula * DRM_DEBUG() logs to DRM_UT_CORE. 26102c9656bSHaneen Mohammed * 262876905b8SJani Nikula * Enabling verbose debug messages is done through the drm.debug parameter, each 263876905b8SJani Nikula * category being enabled by a bit: 26402c9656bSHaneen Mohammed * 265876905b8SJani Nikula * - drm.debug=0x1 will enable CORE messages 266876905b8SJani Nikula * - drm.debug=0x2 will enable DRIVER messages 267876905b8SJani Nikula * - drm.debug=0x3 will enable CORE and DRIVER messages 268876905b8SJani Nikula * - ... 269876905b8SJani Nikula * - drm.debug=0x1ff will enable all messages 27002c9656bSHaneen Mohammed * 27102c9656bSHaneen Mohammed * An interesting feature is that it's possible to enable verbose logging at 272876905b8SJani Nikula * run-time by echoing the debug value in its sysfs node:: 273876905b8SJani Nikula * 27402c9656bSHaneen Mohammed * # echo 0xf > /sys/module/drm/parameters/debug 275876905b8SJani Nikula * 27602c9656bSHaneen Mohammed */ 277876905b8SJani Nikula enum drm_debug_category { 278876905b8SJani Nikula /** 279876905b8SJani Nikula * @DRM_UT_CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c, 280876905b8SJani Nikula * drm_memory.c, ... 281876905b8SJani Nikula */ 282876905b8SJani Nikula DRM_UT_CORE = 0x01, 283876905b8SJani Nikula /** 284876905b8SJani Nikula * @DRM_UT_DRIVER: Used in the vendor specific part of the driver: i915, 285876905b8SJani Nikula * radeon, ... macro. 286876905b8SJani Nikula */ 287876905b8SJani Nikula DRM_UT_DRIVER = 0x02, 288876905b8SJani Nikula /** 289876905b8SJani Nikula * @DRM_UT_KMS: Used in the modesetting code. 290876905b8SJani Nikula */ 291876905b8SJani Nikula DRM_UT_KMS = 0x04, 292876905b8SJani Nikula /** 293876905b8SJani Nikula * @DRM_UT_PRIME: Used in the prime code. 294876905b8SJani Nikula */ 295876905b8SJani Nikula DRM_UT_PRIME = 0x08, 296876905b8SJani Nikula /** 297876905b8SJani Nikula * @DRM_UT_ATOMIC: Used in the atomic code. 298876905b8SJani Nikula */ 299876905b8SJani Nikula DRM_UT_ATOMIC = 0x10, 300876905b8SJani Nikula /** 301876905b8SJani Nikula * @DRM_UT_VBL: Used for verbose debug message in the vblank code. 302876905b8SJani Nikula */ 303876905b8SJani Nikula DRM_UT_VBL = 0x20, 304876905b8SJani Nikula /** 305876905b8SJani Nikula * @DRM_UT_STATE: Used for verbose atomic state debugging. 306876905b8SJani Nikula */ 307876905b8SJani Nikula DRM_UT_STATE = 0x40, 308876905b8SJani Nikula /** 309876905b8SJani Nikula * @DRM_UT_LEASE: Used in the lease code. 310876905b8SJani Nikula */ 311876905b8SJani Nikula DRM_UT_LEASE = 0x80, 312876905b8SJani Nikula /** 313876905b8SJani Nikula * @DRM_UT_DP: Used in the DP code. 314876905b8SJani Nikula */ 315876905b8SJani Nikula DRM_UT_DP = 0x100, 316c6603c74SDaniel Vetter /** 317c6603c74SDaniel Vetter * @DRM_UT_DRMRES: Used in the drm managed resources code. 318c6603c74SDaniel Vetter */ 319c6603c74SDaniel Vetter DRM_UT_DRMRES = 0x200, 320876905b8SJani Nikula }; 32102c9656bSHaneen Mohammed 322876905b8SJani Nikula static inline bool drm_debug_enabled(enum drm_debug_category category) 323f0a8f533SJani Nikula { 3249f0ac028SJani Nikula return unlikely(__drm_debug & category); 325f0a8f533SJani Nikula } 326f0a8f533SJani Nikula 3273bf149bdSJani Nikula /* 3283bf149bdSJani Nikula * struct device based logging 329fb6c7ab8SJani Nikula * 330*51fdf091SJim Cromie * Prefer drm_device based logging over device or printk based logging. 3313bf149bdSJani Nikula */ 3323bf149bdSJani Nikula 333db870864SJoe Perches __printf(3, 4) 33402c9656bSHaneen Mohammed void drm_dev_printk(const struct device *dev, const char *level, 335db870864SJoe Perches const char *format, ...); 336db870864SJoe Perches __printf(3, 4) 337876905b8SJani Nikula void drm_dev_dbg(const struct device *dev, enum drm_debug_category category, 338db870864SJoe Perches const char *format, ...); 339db870864SJoe Perches 3403bf149bdSJani Nikula /** 341b52817e9SMauro Carvalho Chehab * DRM_DEV_ERROR() - Error output. 3423bf149bdSJani Nikula * 3433bf149bdSJani Nikula * @dev: device pointer 3443bf149bdSJani Nikula * @fmt: printf() like format string. 3453bf149bdSJani Nikula */ 3463bf149bdSJani Nikula #define DRM_DEV_ERROR(dev, fmt, ...) \ 3473bf149bdSJani Nikula drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__) 3483bf149bdSJani Nikula 3493bf149bdSJani Nikula /** 350b52817e9SMauro Carvalho Chehab * DRM_DEV_ERROR_RATELIMITED() - Rate limited error output. 3513bf149bdSJani Nikula * 3523bf149bdSJani Nikula * @dev: device pointer 3533bf149bdSJani Nikula * @fmt: printf() like format string. 354b52817e9SMauro Carvalho Chehab * 355b52817e9SMauro Carvalho Chehab * Like DRM_ERROR() but won't flood the log. 3563bf149bdSJani Nikula */ 3573bf149bdSJani Nikula #define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...) \ 3583bf149bdSJani Nikula ({ \ 3593bf149bdSJani Nikula static DEFINE_RATELIMIT_STATE(_rs, \ 3603bf149bdSJani Nikula DEFAULT_RATELIMIT_INTERVAL, \ 3613bf149bdSJani Nikula DEFAULT_RATELIMIT_BURST); \ 3623bf149bdSJani Nikula \ 3633bf149bdSJani Nikula if (__ratelimit(&_rs)) \ 3643bf149bdSJani Nikula DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__); \ 3653bf149bdSJani Nikula }) 3663bf149bdSJani Nikula 3673bf149bdSJani Nikula #define DRM_DEV_INFO(dev, fmt, ...) \ 3683bf149bdSJani Nikula drm_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__) 3693bf149bdSJani Nikula 3703bf149bdSJani Nikula #define DRM_DEV_INFO_ONCE(dev, fmt, ...) \ 3713bf149bdSJani Nikula ({ \ 3723bf149bdSJani Nikula static bool __print_once __read_mostly; \ 3733bf149bdSJani Nikula if (!__print_once) { \ 3743bf149bdSJani Nikula __print_once = true; \ 3753bf149bdSJani Nikula DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__); \ 3763bf149bdSJani Nikula } \ 3773bf149bdSJani Nikula }) 3783bf149bdSJani Nikula 3793bf149bdSJani Nikula /** 380b52817e9SMauro Carvalho Chehab * DRM_DEV_DEBUG() - Debug output for generic drm code 3813bf149bdSJani Nikula * 3823bf149bdSJani Nikula * @dev: device pointer 3833bf149bdSJani Nikula * @fmt: printf() like format string. 3843bf149bdSJani Nikula */ 3853bf149bdSJani Nikula #define DRM_DEV_DEBUG(dev, fmt, ...) \ 3863bf149bdSJani Nikula drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__) 387b52817e9SMauro Carvalho Chehab /** 388b52817e9SMauro Carvalho Chehab * DRM_DEV_DEBUG_DRIVER() - Debug output for vendor specific part of the driver 389b52817e9SMauro Carvalho Chehab * 390b52817e9SMauro Carvalho Chehab * @dev: device pointer 391b52817e9SMauro Carvalho Chehab * @fmt: printf() like format string. 392b52817e9SMauro Carvalho Chehab */ 3933bf149bdSJani Nikula #define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...) \ 3943bf149bdSJani Nikula drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__) 395b52817e9SMauro Carvalho Chehab /** 396b52817e9SMauro Carvalho Chehab * DRM_DEV_DEBUG_KMS() - Debug output for modesetting code 397b52817e9SMauro Carvalho Chehab * 398b52817e9SMauro Carvalho Chehab * @dev: device pointer 399b52817e9SMauro Carvalho Chehab * @fmt: printf() like format string. 400b52817e9SMauro Carvalho Chehab */ 4013bf149bdSJani Nikula #define DRM_DEV_DEBUG_KMS(dev, fmt, ...) \ 4023bf149bdSJani Nikula drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__) 4033bf149bdSJani Nikula 4043bf149bdSJani Nikula /* 405fb6c7ab8SJani Nikula * struct drm_device based logging 406fb6c7ab8SJani Nikula * 407fb6c7ab8SJani Nikula * Prefer drm_device based logging over device or prink based logging. 408fb6c7ab8SJani Nikula */ 409fb6c7ab8SJani Nikula 410fb6c7ab8SJani Nikula /* Helper for struct drm_device based logging. */ 411fb6c7ab8SJani Nikula #define __drm_printk(drm, level, type, fmt, ...) \ 412fb6c7ab8SJani Nikula dev_##level##type((drm)->dev, "[drm] " fmt, ##__VA_ARGS__) 413fb6c7ab8SJani Nikula 414fb6c7ab8SJani Nikula 415fb6c7ab8SJani Nikula #define drm_info(drm, fmt, ...) \ 416fb6c7ab8SJani Nikula __drm_printk((drm), info,, fmt, ##__VA_ARGS__) 417fb6c7ab8SJani Nikula 418fb6c7ab8SJani Nikula #define drm_notice(drm, fmt, ...) \ 419fb6c7ab8SJani Nikula __drm_printk((drm), notice,, fmt, ##__VA_ARGS__) 420fb6c7ab8SJani Nikula 421fb6c7ab8SJani Nikula #define drm_warn(drm, fmt, ...) \ 422fb6c7ab8SJani Nikula __drm_printk((drm), warn,, fmt, ##__VA_ARGS__) 423fb6c7ab8SJani Nikula 424fb6c7ab8SJani Nikula #define drm_err(drm, fmt, ...) \ 425fb6c7ab8SJani Nikula __drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__) 426fb6c7ab8SJani Nikula 427fb6c7ab8SJani Nikula 428fb6c7ab8SJani Nikula #define drm_info_once(drm, fmt, ...) \ 429fb6c7ab8SJani Nikula __drm_printk((drm), info, _once, fmt, ##__VA_ARGS__) 430fb6c7ab8SJani Nikula 431fb6c7ab8SJani Nikula #define drm_notice_once(drm, fmt, ...) \ 432fb6c7ab8SJani Nikula __drm_printk((drm), notice, _once, fmt, ##__VA_ARGS__) 433fb6c7ab8SJani Nikula 434fb6c7ab8SJani Nikula #define drm_warn_once(drm, fmt, ...) \ 435fb6c7ab8SJani Nikula __drm_printk((drm), warn, _once, fmt, ##__VA_ARGS__) 436fb6c7ab8SJani Nikula 437fb6c7ab8SJani Nikula #define drm_err_once(drm, fmt, ...) \ 438fb6c7ab8SJani Nikula __drm_printk((drm), err, _once, "*ERROR* " fmt, ##__VA_ARGS__) 439fb6c7ab8SJani Nikula 440fb6c7ab8SJani Nikula 441fb6c7ab8SJani Nikula #define drm_err_ratelimited(drm, fmt, ...) \ 442fb6c7ab8SJani Nikula __drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__) 443fb6c7ab8SJani Nikula 444fb6c7ab8SJani Nikula 445fb6c7ab8SJani Nikula #define drm_dbg_core(drm, fmt, ...) \ 44679119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_CORE, fmt, ##__VA_ARGS__) 447fb6c7ab8SJani Nikula #define drm_dbg(drm, fmt, ...) \ 44879119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRIVER, fmt, ##__VA_ARGS__) 449fb6c7ab8SJani Nikula #define drm_dbg_kms(drm, fmt, ...) \ 45079119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__) 451fb6c7ab8SJani Nikula #define drm_dbg_prime(drm, fmt, ...) \ 45279119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_PRIME, fmt, ##__VA_ARGS__) 453fb6c7ab8SJani Nikula #define drm_dbg_atomic(drm, fmt, ...) \ 45479119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__) 455fb6c7ab8SJani Nikula #define drm_dbg_vbl(drm, fmt, ...) \ 45679119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_VBL, fmt, ##__VA_ARGS__) 457fb6c7ab8SJani Nikula #define drm_dbg_state(drm, fmt, ...) \ 45879119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_STATE, fmt, ##__VA_ARGS__) 459fb6c7ab8SJani Nikula #define drm_dbg_lease(drm, fmt, ...) \ 46079119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_LEASE, fmt, ##__VA_ARGS__) 461fb6c7ab8SJani Nikula #define drm_dbg_dp(drm, fmt, ...) \ 46279119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DP, fmt, ##__VA_ARGS__) 463c6603c74SDaniel Vetter #define drm_dbg_drmres(drm, fmt, ...) \ 46479119021SLyude Paul drm_dev_dbg((drm) ? (drm)->dev : NULL, DRM_UT_DRMRES, fmt, ##__VA_ARGS__) 465fb6c7ab8SJani Nikula 466fb6c7ab8SJani Nikula 467fb6c7ab8SJani Nikula /* 4683bf149bdSJani Nikula * printk based logging 469fb6c7ab8SJani Nikula * 470fb6c7ab8SJani Nikula * Prefer drm_device based logging over device or prink based logging. 4713bf149bdSJani Nikula */ 4723bf149bdSJani Nikula 47399a95487SJoe Perches __printf(2, 3) 474876905b8SJani Nikula void __drm_dbg(enum drm_debug_category category, const char *format, ...); 47599a95487SJoe Perches __printf(1, 2) 47699acf471SJani Nikula void __drm_err(const char *format, ...); 477091756bbSHaneen Mohammed 478091756bbSHaneen Mohammed /* Macros to make printk easier */ 47902c9656bSHaneen Mohammed 48002c9656bSHaneen Mohammed #define _DRM_PRINTK(once, level, fmt, ...) \ 481db870864SJoe Perches printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__) 48202c9656bSHaneen Mohammed 48302c9656bSHaneen Mohammed #define DRM_INFO(fmt, ...) \ 48402c9656bSHaneen Mohammed _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__) 48502c9656bSHaneen Mohammed #define DRM_NOTE(fmt, ...) \ 48602c9656bSHaneen Mohammed _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__) 48702c9656bSHaneen Mohammed #define DRM_WARN(fmt, ...) \ 48802c9656bSHaneen Mohammed _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__) 48902c9656bSHaneen Mohammed 49002c9656bSHaneen Mohammed #define DRM_INFO_ONCE(fmt, ...) \ 49102c9656bSHaneen Mohammed _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__) 49202c9656bSHaneen Mohammed #define DRM_NOTE_ONCE(fmt, ...) \ 49302c9656bSHaneen Mohammed _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__) 49402c9656bSHaneen Mohammed #define DRM_WARN_ONCE(fmt, ...) \ 49502c9656bSHaneen Mohammed _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__) 49602c9656bSHaneen Mohammed 49702c9656bSHaneen Mohammed #define DRM_ERROR(fmt, ...) \ 49899acf471SJani Nikula __drm_err(fmt, ##__VA_ARGS__) 49902c9656bSHaneen Mohammed 50002c9656bSHaneen Mohammed #define DRM_ERROR_RATELIMITED(fmt, ...) \ 50102c9656bSHaneen Mohammed DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__) 50202c9656bSHaneen Mohammed 50302c9656bSHaneen Mohammed #define DRM_DEBUG(fmt, ...) \ 50499acf471SJani Nikula __drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__) 50502c9656bSHaneen Mohammed 50602c9656bSHaneen Mohammed #define DRM_DEBUG_DRIVER(fmt, ...) \ 50799acf471SJani Nikula __drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__) 50802c9656bSHaneen Mohammed 50902c9656bSHaneen Mohammed #define DRM_DEBUG_KMS(fmt, ...) \ 51099acf471SJani Nikula __drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__) 51102c9656bSHaneen Mohammed 51202c9656bSHaneen Mohammed #define DRM_DEBUG_PRIME(fmt, ...) \ 51399acf471SJani Nikula __drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__) 51402c9656bSHaneen Mohammed 51502c9656bSHaneen Mohammed #define DRM_DEBUG_ATOMIC(fmt, ...) \ 51699acf471SJani Nikula __drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__) 51702c9656bSHaneen Mohammed 51802c9656bSHaneen Mohammed #define DRM_DEBUG_VBL(fmt, ...) \ 51999acf471SJani Nikula __drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__) 52002c9656bSHaneen Mohammed 52170c5f936SDaniel Vetter #define DRM_DEBUG_LEASE(fmt, ...) \ 52299acf471SJani Nikula __drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__) 52370c5f936SDaniel Vetter 524106b6c39SLyude Paul #define DRM_DEBUG_DP(fmt, ...) \ 52599acf471SJani Nikula __drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__) 526a18b2192SLyude Paul 527c5261e93SLyude Paul #define __DRM_DEFINE_DBG_RATELIMITED(category, drm, fmt, ...) \ 528acce61bfSSam Ravnborg ({ \ 529c5261e93SLyude Paul static DEFINE_RATELIMIT_STATE(rs_, DEFAULT_RATELIMIT_INTERVAL, DEFAULT_RATELIMIT_BURST);\ 530c5261e93SLyude Paul const struct drm_device *drm_ = (drm); \ 531c5261e93SLyude Paul \ 532c5261e93SLyude Paul if (drm_debug_enabled(DRM_UT_ ## category) && __ratelimit(&rs_)) \ 533c5261e93SLyude Paul drm_dev_printk(drm_ ? drm_->dev : NULL, KERN_DEBUG, fmt, ## __VA_ARGS__); \ 534acce61bfSSam Ravnborg }) 535db870864SJoe Perches 536c5261e93SLyude Paul #define drm_dbg_kms_ratelimited(drm, fmt, ...) \ 537c5261e93SLyude Paul __DRM_DEFINE_DBG_RATELIMITED(KMS, drm, fmt, ## __VA_ARGS__) 538c5261e93SLyude Paul 539c5261e93SLyude Paul #define DRM_DEBUG_KMS_RATELIMITED(fmt, ...) drm_dbg_kms_ratelimited(NULL, fmt, ## __VA_ARGS__) 540c5261e93SLyude Paul 541dc1a73e5SPankaj Bharadiya /* 542dc1a73e5SPankaj Bharadiya * struct drm_device based WARNs 543dc1a73e5SPankaj Bharadiya * 544dc1a73e5SPankaj Bharadiya * drm_WARN*() acts like WARN*(), but with the key difference of 545dc1a73e5SPankaj Bharadiya * using device specific information so that we know from which device 546dc1a73e5SPankaj Bharadiya * warning is originating from. 547dc1a73e5SPankaj Bharadiya * 548dc1a73e5SPankaj Bharadiya * Prefer drm_device based drm_WARN* over regular WARN* 549dc1a73e5SPankaj Bharadiya */ 550dc1a73e5SPankaj Bharadiya 551dc1a73e5SPankaj Bharadiya /* Helper for struct drm_device based WARNs */ 552dc1a73e5SPankaj Bharadiya #define drm_WARN(drm, condition, format, arg...) \ 553dc1a73e5SPankaj Bharadiya WARN(condition, "%s %s: " format, \ 554dc1a73e5SPankaj Bharadiya dev_driver_string((drm)->dev), \ 555dc1a73e5SPankaj Bharadiya dev_name((drm)->dev), ## arg) 556dc1a73e5SPankaj Bharadiya 557dc1a73e5SPankaj Bharadiya #define drm_WARN_ONCE(drm, condition, format, arg...) \ 558dc1a73e5SPankaj Bharadiya WARN_ONCE(condition, "%s %s: " format, \ 559dc1a73e5SPankaj Bharadiya dev_driver_string((drm)->dev), \ 560dc1a73e5SPankaj Bharadiya dev_name((drm)->dev), ## arg) 561dc1a73e5SPankaj Bharadiya 562dc1a73e5SPankaj Bharadiya #define drm_WARN_ON(drm, x) \ 563dc1a73e5SPankaj Bharadiya drm_WARN((drm), (x), "%s", \ 564dc1a73e5SPankaj Bharadiya "drm_WARN_ON(" __stringify(x) ")") 565dc1a73e5SPankaj Bharadiya 566dc1a73e5SPankaj Bharadiya #define drm_WARN_ON_ONCE(drm, x) \ 567dc1a73e5SPankaj Bharadiya drm_WARN_ONCE((drm), (x), "%s", \ 568dc1a73e5SPankaj Bharadiya "drm_WARN_ON_ONCE(" __stringify(x) ")") 569dc1a73e5SPankaj Bharadiya 570d8187177SRob Clark #endif /* DRM_PRINT_H_ */ 571