Merge drm/drm-next into drm-misc-next

[linux-block.git] / include / drm / drm_print.h

diff --git a/include/drm/drm_print.h b/include/drm/drm_print.h
index fc08584a51019c5ef6fcecf50325c9c09508dae1..afbc3beef089a38f3ada870c9002c3e730a8f296 100644 (file)
--- a/include/drm/drm_print.h
+++ b/include/drm/drm_print.h
@@ -69,16 +69,21 @@
 struct drm_printer {
        /* private: */
        void (*printfn)(struct drm_printer *p, struct va_format *vaf);
+       void (*puts)(struct drm_printer *p, const char *str);
        void *arg;
        const char *prefix;
 };
 
+void __drm_printfn_coredump(struct drm_printer *p, struct va_format *vaf);
+void __drm_puts_coredump(struct drm_printer *p, const char *str);
 void __drm_printfn_seq_file(struct drm_printer *p, struct va_format *vaf);
+void __drm_puts_seq_file(struct drm_printer *p, const char *str);
 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, ...);
+void drm_puts(struct drm_printer *p, const char *str);
 
 __printf(2, 0)
 /**
@@ -104,6 +109,71 @@ drm_vprintf(struct drm_printer *p, const char *fmt, va_list *va)
 #define drm_printf_indent(printer, indent, fmt, ...) \
        drm_printf((printer), "%.*s" fmt, (indent), "\t\t\t\t\tX", ##__VA_ARGS__)
 
+/**
+ * struct drm_print_iterator - local struct used with drm_printer_coredump
+ * @data: Pointer to the devcoredump output buffer
+ * @start: The offset within the buffer to start writing
+ * @remain: The number of bytes to write for this iteration
+ */
+struct drm_print_iterator {
+       void *data;
+       ssize_t start;
+       ssize_t remain;
+       /* private: */
+       ssize_t offset;
+};
+
+/**
+ * drm_coredump_printer - construct a &drm_printer that can output to a buffer
+ * from the read function for devcoredump
+ * @iter: A pointer to a struct drm_print_iterator for the read instance
+ *
+ * This wrapper extends drm_printf() to work with a dev_coredumpm() callback
+ * function. The passed in drm_print_iterator struct contains the buffer
+ * pointer, size and offset as passed in from devcoredump.
+ *
+ * For example::
+ *
+ *     void coredump_read(char *buffer, loff_t offset, size_t count,
+ *             void *data, size_t datalen)
+ *     {
+ *             struct drm_print_iterator iter;
+ *             struct drm_printer p;
+ *
+ *             iter.data = buffer;
+ *             iter.start = offset;
+ *             iter.remain = count;
+ *
+ *             p = drm_coredump_printer(&iter);
+ *
+ *             drm_printf(p, "foo=%d\n", foo);
+ *     }
+ *
+ *     void makecoredump(...)
+ *     {
+ *             ...
+ *             dev_coredumpm(dev, THIS_MODULE, data, 0, GFP_KERNEL,
+ *                     coredump_read, ...)
+ *     }
+ *
+ * RETURNS:
+ * The &drm_printer object
+ */
+static inline struct drm_printer
+drm_coredump_printer(struct drm_print_iterator *iter)
+{
+       struct drm_printer p = {
+               .printfn = __drm_printfn_coredump,
+               .puts = __drm_puts_coredump,
+               .arg = iter,
+       };
+
+       /* Set the internal offset of the iterator to zero */
+       iter->offset = 0;
+
+       return p;
+}
+
 /**
  * drm_seq_file_printer - construct a &drm_printer that outputs to &seq_file
  * @f:  the &struct seq_file to output to
@@ -115,6 +185,7 @@ static inline struct drm_printer drm_seq_file_printer(struct seq_file *f)
 {
        struct drm_printer p = {
                .printfn = __drm_printfn_seq_file,
+               .puts = __drm_puts_seq_file,
                .arg = f,
        };
        return p;