include/drm/drm_debugfs_crc.h

0001 /*
0002  * Copyright © 2016 Collabora Ltd.
0003  *
0004  * Permission is hereby granted, free of charge, to any person obtaining a
0005  * copy of this software and associated documentation files (the "Software"),
0006  * to deal in the Software without restriction, including without limitation
0007  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
0008  * and/or sell copies of the Software, and to permit persons to whom the
0009  * Software is furnished to do so, subject to the following conditions:
0010  *
0011  * The above copyright notice and this permission notice shall be included in
0012  * all copies or substantial portions of the Software.
0013  *
0014  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
0015  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
0016  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
0017  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
0018  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
0019  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
0020  * OTHER DEALINGS IN THE SOFTWARE.
0021  */
0022 #ifndef __DRM_DEBUGFS_CRC_H__
0023 #define __DRM_DEBUGFS_CRC_H__
0024
0025 #define DRM_MAX_CRC_NR      10
0026
0027 /**
0028  * struct drm_crtc_crc_entry - entry describing a frame's content
0029  * @has_frame_counter: whether the source was able to provide a frame number
0030  * @frame: number of the frame this CRC is about, if @has_frame_counter is true
0031  * @crc: array of values that characterize the frame
0032  */
0033 struct drm_crtc_crc_entry {
0034     bool has_frame_counter;
0035     uint32_t frame;
0036     uint32_t crcs[DRM_MAX_CRC_NR];
0037 };
0038
0039 #define DRM_CRC_ENTRIES_NR  128
0040
0041 /**
0042  * struct drm_crtc_crc - data supporting CRC capture on a given CRTC
0043  * @lock: protects the fields in this struct
0044  * @source: name of the currently configured source of CRCs
0045  * @opened: whether userspace has opened the data file for reading
0046  * @overflow: whether an overflow occured.
0047  * @entries: array of entries, with size of %DRM_CRC_ENTRIES_NR
0048  * @head: head of circular queue
0049  * @tail: tail of circular queue
0050  * @values_cnt: number of CRC values per entry, up to %DRM_MAX_CRC_NR
0051  * @wq: workqueue used to synchronize reading and writing
0052  */
0053 struct drm_crtc_crc {
0054     spinlock_t lock;
0055     const char *source;
0056     bool opened, overflow;
0057     struct drm_crtc_crc_entry *entries;
0058     int head, tail;
0059     size_t values_cnt;
0060     wait_queue_head_t wq;
0061 };
0062
0063 #if defined(CONFIG_DEBUG_FS)
0064 int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
0065                uint32_t frame, uint32_t *crcs);
0066 #else
0067 static inline int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
0068                      uint32_t frame, uint32_t *crcs)
0069 {
0070     return -EINVAL;
0071 }
0072 #endif /* defined(CONFIG_DEBUG_FS) */
0073
0074 #endif /* __DRM_DEBUGFS_CRC_H__ */