LXR linux/include/drm/drm

   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
  29#include <linux/compiler.h>
  30#include <linux/printk.h>
  31#include <linux/seq_file.h>
  32#include <linux/device.h>
  33#include <linux/debugfs.h>
  34
  35#include <drm/drm.h>
  36
  37/* Do *not* use outside of drm_print.[ch]! */
  38extern unsigned int __drm_debug;
  39
  40/**
  41 * DOC: print
  42 *
  43 * A simple wrapper for dev_printk(), seq_printf(), etc.  Allows same
  44 * debug code to be used for both debugfs and printk logging.
  45 *
  46 * For example::
  47 *
  48 *     void log_some_info(struct drm_printer *p)
  49 *     {
  50 *             drm_printf(p, "foo=%d\n", foo);
  51 *             drm_printf(p, "bar=%d\n", bar);
  52 *     }
  53 *
  54 *     #ifdef CONFIG_DEBUG_FS
  55 *     void debugfs_show(struct seq_file *f)
  56 *     {
  57 *             struct drm_printer p = drm_seq_file_printer(f);
  58 *             log_some_info(&p);
  59 *     }
  60 *     #endif
  61 *
  62 *     void some_other_function(...)
  63 *     {
  64 *             struct drm_printer p = drm_info_printer(drm->dev);
  65 *             log_some_info(&p);
  66 *     }
  67 */
  68
  69/**
  70 * struct drm_printer - drm output "stream"
  71 *
  72 * Do not use struct members directly.  Use drm_printer_seq_file(),
  73 * drm_printer_info(), etc to initialize.  And drm_printf() for output.
  74 */
  75struct drm_printer {
  76        /* private: */
  77        void (*printfn)(struct drm_printer *p, struct va_format *vaf);
  78        void (*puts)(struct drm_printer *p, const char *str);
  79        void *arg;
  80        const char *prefix;
  81};
  82
  83void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
  84void __drm_puts_coredump(struct drm_printer *p, const char *str);
  85void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
  86void __drm_puts_seq_file(struct drm_printer *p, const char *str);
  87void __drm_printfn_info(struct drm_printer *p, struct va_format *vaf);
  88void __drm_printfn_debug(struct drm_printer *p, struct va_format *vaf);
  89void __drm_printfn_err(struct drm_printer *p, struct va_format *vaf);
  90
  91__printf(2, 3)
  92void drm_printf(struct drm_printer *p, const char *f, ...);
  93void drm_puts(struct drm_printer *p, const char *str);
  94void drm_print_regset32(struct drm_printer *p, struct debugfs_regset32 *regset);
  95void drm_print_bits(struct drm_printer *p, unsigned long value,
  96                    const char * const bits[], unsigned int nbits);
  97
  98__printf(2, 0)
  99/**
 100 * drm_vprintf - print to a &drm_printer stream
 101 * @p: the &drm_printer
 102 * @fmt: format string
 103 * @va: the va_list
 104 */
 105static inline void
 106drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
 107{
 108        struct va_format vaf = { .fmt = fmt, .va = va };
 109
 110        p->printfn(p, &vaf);
 111}
 112
 113/**
 114 * drm_printf_indent - Print to a &drm_printer stream with indentation
 115 * @printer: DRM printer
 116 * @indent: Tab indentation level (max 5)
 117 * @fmt: Format string
 118 */
 119#define drm_printf_indent(printer, indent, fmt, ...) \
 120        drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
 121
 122/**
 123 * struct drm_print_iterator - local struct used with drm_printer_coredump
 124 * @data: Pointer to the devcoredump output buffer
 125 * @start: The offset within the buffer to start writing
 126 * @remain: The number of bytes to write for this iteration
 127 */
 128struct drm_print_iterator {
 129        void *data;
 130        ssize_t start;
 131        ssize_t remain;
 132        /* private: */
 133        ssize_t offset;
 134};
 135
 136/**
 137 * drm_coredump_printer - construct a &drm_printer that can output to a buffer
 138 * from the read function for devcoredump
 139 * @iter: A pointer to a struct drm_print_iterator for the read instance
 140 *
 141 * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
 142 * function. The passed in drm_print_iterator struct contains the buffer
 143 * pointer, size and offset as passed in from devcoredump.
 144 *
 145 * For example::
 146 *
 147 *      void coredump_read(char *buffer, loff_t offset, size_t count,
 148 *              void *data, size_t datalen)
 149 *      {
 150 *              struct drm_print_iterator iter;
 151 *              struct drm_printer p;
 152 *
 153 *              iter.data = buffer;
 154 *              iter.start = offset;
 155 *              iter.remain = count;
 156 *
 157 *              p = drm_coredump_printer(&iter);
 158 *
 159 *              drm_printf(p, "foo=%d\n", foo);
 160 *      }
 161 *
 162 *      void makecoredump(...)
 163 *      {
 164 *              ...
 165 *              dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
 166 *                      coredump_read, ...)
 167 *      }
 168 *
 169 * RETURNS:
 170 * The &drm_printer object
 171 */
 172static inline struct drm_printer
 173drm_coredump_printer(struct drm_print_iterator *iter)
 174{
 175        struct drm_printer p = {
 176                .printfn = __drm_printfn_coredump,
 177                .puts = __drm_puts_coredump,
 178                .arg = iter,
 179        };
 180
 181        /* Set the internal offset of the iterator to zero */
 182        iter->offset = 0;
 183
 184        return p;
 185}
 186
 187/**
 188 * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
 189 * @f:  the &struct seq_file to output to
 190 *
 191 * RETURNS:
 192 * The &drm_printer object
 193 */
 194static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
 195{
 196        struct drm_printer p = {
 197                .printfn = __drm_printfn_seq_file,
 198                .puts = __drm_puts_seq_file,
 199                .arg = f,
 200        };
 201        return p;
 202}
 203
 204/**
 205 * drm_info_printer - construct a &drm_printer that outputs to dev_printk()
 206 * @dev: the &struct device pointer
 207 *
 208 * RETURNS:
 209 * The &drm_printer object
 210 */
 211static inline struct drm_printer drm_info_printer(struct device *dev)
 212{
 213        struct drm_printer p = {
 214                .printfn = __drm_printfn_info,
 215                .arg = dev,
 216        };
 217        return p;
 218}
 219
 220/**
 221 * drm_debug_printer - construct a &drm_printer that outputs to pr_debug()
 222 * @prefix: debug output prefix
 223 *
 224 * RETURNS:
 225 * The &drm_printer object
 226 */
 227static inline struct drm_printer drm_debug_printer(const char *prefix)
 228{
 229        struct drm_printer p = {
 230                .printfn = __drm_printfn_debug,
 231                .prefix = prefix
 232        };
 233        return p;
 234}
 235
 236/**
 237 * drm_err_printer - construct a &drm_printer that outputs to pr_err()
 238 * @prefix: debug output prefix
 239 *
 240 * RETURNS:
 241 * The &drm_printer object
 242 */
 243static inline struct drm_printer drm_err_printer(const char *prefix)
 244{
 245        struct drm_printer p = {
 246                .printfn = __drm_printfn_err,
 247                .prefix = prefix
 248        };
 249        return p;
 250}
 251
 252/**
 253 * enum drm_debug_category - The DRM debug categories
 254 *
 255 * Each of the DRM debug logging macros use a specific category, and the logging
 256 * is filtered by the drm.debug module parameter. This enum specifies the values
 257 * for the interface.
 258 *
 259 * Each DRM_DEBUG_<CATEGORY> macro logs to DRM_UT_<CATEGORY> category, except
 260 * DRM_DEBUG() logs to DRM_UT_CORE.
 261 *
 262 * Enabling verbose debug messages is done through the drm.debug parameter, each
 263 * category being enabled by a bit:
 264 *
 265 *  - drm.debug=0x1 will enable CORE messages
 266 *  - drm.debug=0x2 will enable DRIVER messages
 267 *  - drm.debug=0x3 will enable CORE and DRIVER messages
 268 *  - ...
 269 *  - drm.debug=0x1ff will enable all messages
 270 *
 271 * An interesting feature is that it's possible to enable verbose logging at
 272 * run-time by echoing the debug value in its sysfs node::
 273 *
 274 *   # echo 0xf > /sys/module/drm/parameters/debug
 275 *
 276 */
 277enum drm_debug_category {
 278        /**
 279         * @DRM_UT_CORE: Used in the generic drm code: drm_ioctl.c, drm_mm.c,
 280         * drm_memory.c, ...
 281         */
 282        DRM_UT_CORE             = 0x01,
 283        /**
 284         * @DRM_UT_DRIVER: Used in the vendor specific part of the driver: i915,
 285         * radeon, ... macro.
 286         */
 287        DRM_UT_DRIVER           = 0x02,
 288        /**
 289         * @DRM_UT_KMS: Used in the modesetting code.
 290         */
 291        DRM_UT_KMS              = 0x04,
 292        /**
 293         * @DRM_UT_PRIME: Used in the prime code.
 294         */
 295        DRM_UT_PRIME            = 0x08,
 296        /**
 297         * @DRM_UT_ATOMIC: Used in the atomic code.
 298         */
 299        DRM_UT_ATOMIC           = 0x10,
 300        /**
 301         * @DRM_UT_VBL: Used for verbose debug message in the vblank code.
 302         */
 303        DRM_UT_VBL              = 0x20,
 304        /**
 305         * @DRM_UT_STATE: Used for verbose atomic state debugging.
 306         */
 307        DRM_UT_STATE            = 0x40,
 308        /**
 309         * @DRM_UT_LEASE: Used in the lease code.
 310         */
 311        DRM_UT_LEASE            = 0x80,
 312        /**
 313         * @DRM_UT_DP: Used in the DP code.
 314         */
 315        DRM_UT_DP               = 0x100,
 316        /**
 317         * @DRM_UT_DRMRES: Used in the drm managed resources code.
 318         */
 319        DRM_UT_DRMRES           = 0x200,
 320};
 321
 322static inline bool drm_debug_enabled(enum drm_debug_category category)
 323{
 324        return unlikely(__drm_debug & category);
 325}
 326
 327/*
 328 * struct device based logging
 329 *
 330 * Prefer drm_device based logging over device or prink based logging.
 331 */
 332
 333__printf(3, 4)
 334void drm_dev_printk(const struct device *dev, const char *level,
 335                    const char *format, ...);
 336__printf(3, 4)
 337void drm_dev_dbg(const struct device *dev, enum drm_debug_category category,
 338                 const char *format, ...);
 339
 340/**
 341 * Error output.
 342 *
 343 * @dev: device pointer
 344 * @fmt: printf() like format string.
 345 */
 346#define DRM_DEV_ERROR(dev, fmt, ...)                                    \
 347        drm_dev_printk(dev, KERN_ERR, "*ERROR* " fmt, ##__VA_ARGS__)
 348
 349/**
 350 * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 351 *
 352 * @dev: device pointer
 353 * @fmt: printf() like format string.
 354 */
 355#define DRM_DEV_ERROR_RATELIMITED(dev, fmt, ...)                        \
 356({                                                                      \
 357        static DEFINE_RATELIMIT_STATE(_rs,                              \
 358                                      DEFAULT_RATELIMIT_INTERVAL,       \
 359                                      DEFAULT_RATELIMIT_BURST);         \
 360                                                                        \
 361        if (__ratelimit(&_rs))                                          \
 362                DRM_DEV_ERROR(dev, fmt, ##__VA_ARGS__);                 \
 363})
 364
 365#define DRM_DEV_INFO(dev, fmt, ...)                             \
 366        drm_dev_printk(dev, KERN_INFO, fmt, ##__VA_ARGS__)
 367
 368#define DRM_DEV_INFO_ONCE(dev, fmt, ...)                                \
 369({                                                                      \
 370        static bool __print_once __read_mostly;                         \
 371        if (!__print_once) {                                            \
 372                __print_once = true;                                    \
 373                DRM_DEV_INFO(dev, fmt, ##__VA_ARGS__);                  \
 374        }                                                               \
 375})
 376
 377/**
 378 * Debug output.
 379 *
 380 * @dev: device pointer
 381 * @fmt: printf() like format string.
 382 */
 383#define DRM_DEV_DEBUG(dev, fmt, ...)                                    \
 384        drm_dev_dbg(dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
 385#define DRM_DEV_DEBUG_DRIVER(dev, fmt, ...)                             \
 386        drm_dev_dbg(dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
 387#define DRM_DEV_DEBUG_KMS(dev, fmt, ...)                                \
 388        drm_dev_dbg(dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
 389
 390/*
 391 * struct drm_device based logging
 392 *
 393 * Prefer drm_device based logging over device or prink based logging.
 394 */
 395
 396/* Helper for struct drm_device based logging. */
 397#define __drm_printk(drm, level, type, fmt, ...)                        \
 398        dev_##level##type((drm)->dev, "[drm] " fmt, ##__VA_ARGS__)
 399
 400
 401#define drm_info(drm, fmt, ...)                                 \
 402        __drm_printk((drm), info,, fmt, ##__VA_ARGS__)
 403
 404#define drm_notice(drm, fmt, ...)                               \
 405        __drm_printk((drm), notice,, fmt, ##__VA_ARGS__)
 406
 407#define drm_warn(drm, fmt, ...)                                 \
 408        __drm_printk((drm), warn,, fmt, ##__VA_ARGS__)
 409
 410#define drm_err(drm, fmt, ...)                                  \
 411        __drm_printk((drm), err,, "*ERROR* " fmt, ##__VA_ARGS__)
 412
 413
 414#define drm_info_once(drm, fmt, ...)                            \
 415        __drm_printk((drm), info, _once, fmt, ##__VA_ARGS__)
 416
 417#define drm_notice_once(drm, fmt, ...)                          \
 418        __drm_printk((drm), notice, _once, fmt, ##__VA_ARGS__)
 419
 420#define drm_warn_once(drm, fmt, ...)                            \
 421        __drm_printk((drm), warn, _once, fmt, ##__VA_ARGS__)
 422
 423#define drm_err_once(drm, fmt, ...)                             \
 424        __drm_printk((drm), err, _once, "*ERROR* " fmt, ##__VA_ARGS__)
 425
 426
 427#define drm_err_ratelimited(drm, fmt, ...)                              \
 428        __drm_printk((drm), err, _ratelimited, "*ERROR* " fmt, ##__VA_ARGS__)
 429
 430
 431#define drm_dbg_core(drm, fmt, ...)                                     \
 432        drm_dev_dbg((drm)->dev, DRM_UT_CORE, fmt, ##__VA_ARGS__)
 433#define drm_dbg(drm, fmt, ...)                                          \
 434        drm_dev_dbg((drm)->dev, DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
 435#define drm_dbg_kms(drm, fmt, ...)                                      \
 436        drm_dev_dbg((drm)->dev, DRM_UT_KMS, fmt, ##__VA_ARGS__)
 437#define drm_dbg_prime(drm, fmt, ...)                                    \
 438        drm_dev_dbg((drm)->dev, DRM_UT_PRIME, fmt, ##__VA_ARGS__)
 439#define drm_dbg_atomic(drm, fmt, ...)                                   \
 440        drm_dev_dbg((drm)->dev, DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
 441#define drm_dbg_vbl(drm, fmt, ...)                                      \
 442        drm_dev_dbg((drm)->dev, DRM_UT_VBL, fmt, ##__VA_ARGS__)
 443#define drm_dbg_state(drm, fmt, ...)                                    \
 444        drm_dev_dbg((drm)->dev, DRM_UT_STATE, fmt, ##__VA_ARGS__)
 445#define drm_dbg_lease(drm, fmt, ...)                                    \
 446        drm_dev_dbg((drm)->dev, DRM_UT_LEASE, fmt, ##__VA_ARGS__)
 447#define drm_dbg_dp(drm, fmt, ...)                                       \
 448        drm_dev_dbg((drm)->dev, DRM_UT_DP, fmt, ##__VA_ARGS__)
 449#define drm_dbg_drmres(drm, fmt, ...)                                   \
 450        drm_dev_dbg((drm)->dev, DRM_UT_DRMRES, fmt, ##__VA_ARGS__)
 451
 452
 453/*
 454 * printk based logging
 455 *
 456 * Prefer drm_device based logging over device or prink based logging.
 457 */
 458
 459__printf(2, 3)
 460void __drm_dbg(enum drm_debug_category category, const char *format, ...);
 461__printf(1, 2)
 462void __drm_err(const char *format, ...);
 463
 464/* Macros to make printk easier */
 465
 466#define _DRM_PRINTK(once, level, fmt, ...)                              \
 467        printk##once(KERN_##level "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 468
 469#define DRM_INFO(fmt, ...)                                              \
 470        _DRM_PRINTK(, INFO, fmt, ##__VA_ARGS__)
 471#define DRM_NOTE(fmt, ...)                                              \
 472        _DRM_PRINTK(, NOTICE, fmt, ##__VA_ARGS__)
 473#define DRM_WARN(fmt, ...)                                              \
 474        _DRM_PRINTK(, WARNING, fmt, ##__VA_ARGS__)
 475
 476#define DRM_INFO_ONCE(fmt, ...)                                         \
 477        _DRM_PRINTK(_once, INFO, fmt, ##__VA_ARGS__)
 478#define DRM_NOTE_ONCE(fmt, ...)                                         \
 479        _DRM_PRINTK(_once, NOTICE, fmt, ##__VA_ARGS__)
 480#define DRM_WARN_ONCE(fmt, ...)                                         \
 481        _DRM_PRINTK(_once, WARNING, fmt, ##__VA_ARGS__)
 482
 483#define DRM_ERROR(fmt, ...)                                             \
 484        __drm_err(fmt, ##__VA_ARGS__)
 485
 486#define DRM_ERROR_RATELIMITED(fmt, ...)                                 \
 487        DRM_DEV_ERROR_RATELIMITED(NULL, fmt, ##__VA_ARGS__)
 488
 489#define DRM_DEBUG(fmt, ...)                                             \
 490        __drm_dbg(DRM_UT_CORE, fmt, ##__VA_ARGS__)
 491
 492#define DRM_DEBUG_DRIVER(fmt, ...)                                      \
 493        __drm_dbg(DRM_UT_DRIVER, fmt, ##__VA_ARGS__)
 494
 495#define DRM_DEBUG_KMS(fmt, ...)                                         \
 496        __drm_dbg(DRM_UT_KMS, fmt, ##__VA_ARGS__)
 497
 498#define DRM_DEBUG_PRIME(fmt, ...)                                       \
 499        __drm_dbg(DRM_UT_PRIME, fmt, ##__VA_ARGS__)
 500
 501#define DRM_DEBUG_ATOMIC(fmt, ...)                                      \
 502        __drm_dbg(DRM_UT_ATOMIC, fmt, ##__VA_ARGS__)
 503
 504#define DRM_DEBUG_VBL(fmt, ...)                                         \
 505        __drm_dbg(DRM_UT_VBL, fmt, ##__VA_ARGS__)
 506
 507#define DRM_DEBUG_LEASE(fmt, ...)                                       \
 508        __drm_dbg(DRM_UT_LEASE, fmt, ##__VA_ARGS__)
 509
 510#define DRM_DEBUG_DP(fmt, ...)                                          \
 511        __drm_dbg(DRM_UT_DP, fmt, ## __VA_ARGS__)
 512
 513
 514#define DRM_DEBUG_KMS_RATELIMITED(fmt, ...)                             \
 515({                                                                      \
 516        static DEFINE_RATELIMIT_STATE(_rs,                              \
 517                                      DEFAULT_RATELIMIT_INTERVAL,       \
 518                                      DEFAULT_RATELIMIT_BURST);         \
 519        if (__ratelimit(&_rs))                                          \
 520                drm_dev_dbg(NULL, DRM_UT_KMS, fmt, ##__VA_ARGS__);      \
 521})
 522
 523/*
 524 * struct drm_device based WARNs
 525 *
 526 * drm_WARN*() acts like WARN*(), but with the key difference of
 527 * using device specific information so that we know from which device
 528 * warning is originating from.
 529 *
 530 * Prefer drm_device based drm_WARN* over regular WARN*
 531 */
 532
 533/* Helper for struct drm_device based WARNs */
 534#define drm_WARN(drm, condition, format, arg...)                        \
 535        WARN(condition, "%s %s: " format,                               \
 536                        dev_driver_string((drm)->dev),                  \
 537                        dev_name((drm)->dev), ## arg)
 538
 539#define drm_WARN_ONCE(drm, condition, format, arg...)                   \
 540        WARN_ONCE(condition, "%s %s: " format,                          \
 541                        dev_driver_string((drm)->dev),                  \
 542                        dev_name((drm)->dev), ## arg)
 543
 544#define drm_WARN_ON(drm, x)                                             \
 545        drm_WARN((drm), (x), "%s",                                      \
 546                 "drm_WARN_ON(" __stringify(x) ")")
 547
 548#define drm_WARN_ON_ONCE(drm, x)                                        \
 549        drm_WARN_ONCE((drm), (x), "%s",                                 \
 550                      "drm_WARN_ON_ONCE(" __stringify(x) ")")
 551
 552#endif /* DRM_PRINT_H_ */
 553