xref: /openbmc/linux/include/drm/drm_debugfs_crc.h (revision feac8c8b)
1 /*
2  * Copyright © 2016 Collabora Ltd.
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 #ifndef __DRM_DEBUGFS_CRC_H__
23 #define __DRM_DEBUGFS_CRC_H__
24 
25 #define DRM_MAX_CRC_NR		10
26 
27 /**
28  * struct drm_crtc_crc_entry - entry describing a frame's content
29  * @has_frame_counter: whether the source was able to provide a frame number
30  * @frame: number of the frame this CRC is about, if @has_frame_counter is true
31  * @crc: array of values that characterize the frame
32  */
33 struct drm_crtc_crc_entry {
34 	bool has_frame_counter;
35 	uint32_t frame;
36 	uint32_t crcs[DRM_MAX_CRC_NR];
37 };
38 
39 #define DRM_CRC_ENTRIES_NR	128
40 
41 /**
42  * struct drm_crtc_crc - data supporting CRC capture on a given CRTC
43  * @lock: protects the fields in this struct
44  * @source: name of the currently configured source of CRCs
45  * @opened: whether userspace has opened the data file for reading
46  * @entries: array of entries, with size of %DRM_CRC_ENTRIES_NR
47  * @head: head of circular queue
48  * @tail: tail of circular queue
49  * @values_cnt: number of CRC values per entry, up to %DRM_MAX_CRC_NR
50  * @wq: workqueue used to synchronize reading and writing
51  */
52 struct drm_crtc_crc {
53 	spinlock_t lock;
54 	const char *source;
55 	bool opened;
56 	struct drm_crtc_crc_entry *entries;
57 	int head, tail;
58 	size_t values_cnt;
59 	wait_queue_head_t wq;
60 };
61 
62 #if defined(CONFIG_DEBUG_FS)
63 int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
64 			   uint32_t frame, uint32_t *crcs);
65 #else
66 static inline int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
67 					 uint32_t frame, uint32_t *crcs)
68 {
69 	return -EINVAL;
70 }
71 #endif /* defined(CONFIG_DEBUG_FS) */
72 
73 #endif /* __DRM_DEBUGFS_CRC_H__ */
74