xref: /openbmc/linux/include/drm/drm_debugfs_crc.h (revision 3eb66e91a25497065c5322b1268cbc3953642227)
19edbf1faSTomeu Vizoso /*
29edbf1faSTomeu Vizoso  * Copyright © 2016 Collabora Ltd.
39edbf1faSTomeu Vizoso  *
49edbf1faSTomeu Vizoso  * Permission is hereby granted, free of charge, to any person obtaining a
59edbf1faSTomeu Vizoso  * copy of this software and associated documentation files (the "Software"),
69edbf1faSTomeu Vizoso  * to deal in the Software without restriction, including without limitation
79edbf1faSTomeu Vizoso  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
89edbf1faSTomeu Vizoso  * and/or sell copies of the Software, and to permit persons to whom the
99edbf1faSTomeu Vizoso  * Software is furnished to do so, subject to the following conditions:
109edbf1faSTomeu Vizoso  *
119edbf1faSTomeu Vizoso  * The above copyright notice and this permission notice shall be included in
129edbf1faSTomeu Vizoso  * all copies or substantial portions of the Software.
139edbf1faSTomeu Vizoso  *
149edbf1faSTomeu Vizoso  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
159edbf1faSTomeu Vizoso  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
169edbf1faSTomeu Vizoso  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
179edbf1faSTomeu Vizoso  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
189edbf1faSTomeu Vizoso  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
199edbf1faSTomeu Vizoso  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
209edbf1faSTomeu Vizoso  * OTHER DEALINGS IN THE SOFTWARE.
219edbf1faSTomeu Vizoso  */
229edbf1faSTomeu Vizoso #ifndef __DRM_DEBUGFS_CRC_H__
239edbf1faSTomeu Vizoso #define __DRM_DEBUGFS_CRC_H__
249edbf1faSTomeu Vizoso 
259edbf1faSTomeu Vizoso #define DRM_MAX_CRC_NR		10
269edbf1faSTomeu Vizoso 
279edbf1faSTomeu Vizoso /**
289edbf1faSTomeu Vizoso  * struct drm_crtc_crc_entry - entry describing a frame's content
299edbf1faSTomeu Vizoso  * @has_frame_counter: whether the source was able to provide a frame number
309edbf1faSTomeu Vizoso  * @frame: number of the frame this CRC is about, if @has_frame_counter is true
319edbf1faSTomeu Vizoso  * @crc: array of values that characterize the frame
329edbf1faSTomeu Vizoso  */
339edbf1faSTomeu Vizoso struct drm_crtc_crc_entry {
349edbf1faSTomeu Vizoso 	bool has_frame_counter;
359edbf1faSTomeu Vizoso 	uint32_t frame;
369edbf1faSTomeu Vizoso 	uint32_t crcs[DRM_MAX_CRC_NR];
379edbf1faSTomeu Vizoso };
389edbf1faSTomeu Vizoso 
399edbf1faSTomeu Vizoso #define DRM_CRC_ENTRIES_NR	128
409edbf1faSTomeu Vizoso 
419edbf1faSTomeu Vizoso /**
429edbf1faSTomeu Vizoso  * struct drm_crtc_crc - data supporting CRC capture on a given CRTC
439edbf1faSTomeu Vizoso  * @lock: protects the fields in this struct
449edbf1faSTomeu Vizoso  * @source: name of the currently configured source of CRCs
459edbf1faSTomeu Vizoso  * @opened: whether userspace has opened the data file for reading
46*a0120245SMaarten Lankhorst  * @overflow: whether an overflow occured.
479edbf1faSTomeu Vizoso  * @entries: array of entries, with size of %DRM_CRC_ENTRIES_NR
489edbf1faSTomeu Vizoso  * @head: head of circular queue
499edbf1faSTomeu Vizoso  * @tail: tail of circular queue
509edbf1faSTomeu Vizoso  * @values_cnt: number of CRC values per entry, up to %DRM_MAX_CRC_NR
519edbf1faSTomeu Vizoso  * @wq: workqueue used to synchronize reading and writing
529edbf1faSTomeu Vizoso  */
539edbf1faSTomeu Vizoso struct drm_crtc_crc {
549edbf1faSTomeu Vizoso 	spinlock_t lock;
559edbf1faSTomeu Vizoso 	const char *source;
56*a0120245SMaarten Lankhorst 	bool opened, overflow;
579edbf1faSTomeu Vizoso 	struct drm_crtc_crc_entry *entries;
589edbf1faSTomeu Vizoso 	int head, tail;
599edbf1faSTomeu Vizoso 	size_t values_cnt;
609edbf1faSTomeu Vizoso 	wait_queue_head_t wq;
619edbf1faSTomeu Vizoso };
629edbf1faSTomeu Vizoso 
639edbf1faSTomeu Vizoso #if defined(CONFIG_DEBUG_FS)
649edbf1faSTomeu Vizoso int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
659edbf1faSTomeu Vizoso 			   uint32_t frame, uint32_t *crcs);
669edbf1faSTomeu Vizoso #else
drm_crtc_add_crc_entry(struct drm_crtc * crtc,bool has_frame,uint32_t frame,uint32_t * crcs)679edbf1faSTomeu Vizoso static inline int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
689edbf1faSTomeu Vizoso 					 uint32_t frame, uint32_t *crcs)
699edbf1faSTomeu Vizoso {
709edbf1faSTomeu Vizoso 	return -EINVAL;
719edbf1faSTomeu Vizoso }
729edbf1faSTomeu Vizoso #endif /* defined(CONFIG_DEBUG_FS) */
739edbf1faSTomeu Vizoso 
749edbf1faSTomeu Vizoso #endif /* __DRM_DEBUGFS_CRC_H__ */
75