Home | History | Annotate | Line # | Download | only in drm 
      1 /*	$NetBSD: drm_debugfs_crc.h,v 1.3 2021/12/19 00:46:00 riastradh Exp $	*/
      2 
      3 /*
      4  * Copyright  2016 Collabora Ltd.
      5  *
      6  * Permission is hereby granted, free of charge, to any person obtaining a
      7  * copy of this software and associated documentation files (the "Software"),
      8  * to deal in the Software without restriction, including without limitation
      9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
     10  * and/or sell copies of the Software, and to permit persons to whom the
     11  * Software is furnished to do so, subject to the following conditions:
     12  *
     13  * The above copyright notice and this permission notice shall be included in
     14  * all copies or substantial portions of the Software.
     15  *
     16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
     17  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
     18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
     19  * THE COPYRIGHT HOLDER(S) OR AUTHOR(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR
     20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
     21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
     22  * OTHER DEALINGS IN THE SOFTWARE.
     23  */
     24 #ifndef __DRM_DEBUGFS_CRC_H__
     25 #define __DRM_DEBUGFS_CRC_H__
     26 
     27 #include <linux/spinlock.h>
     28 
     29 struct drm_crtc;
     30 
     31 #define DRM_MAX_CRC_NR		10
     32 
     33 /**
     34  * struct drm_crtc_crc_entry - entry describing a frame's content
     35  * @has_frame_counter: whether the source was able to provide a frame number
     36  * @frame: number of the frame this CRC is about, if @has_frame_counter is true
     37  * @crc: array of values that characterize the frame
     38  */
     39 struct drm_crtc_crc_entry {
     40 	bool has_frame_counter;
     41 	uint32_t frame;
     42 	uint32_t crcs[DRM_MAX_CRC_NR];
     43 };
     44 
     45 #define DRM_CRC_ENTRIES_NR	128
     46 
     47 /**
     48  * struct drm_crtc_crc - data supporting CRC capture on a given CRTC
     49  * @lock: protects the fields in this struct
     50  * @source: name of the currently configured source of CRCs
     51  * @opened: whether userspace has opened the data file for reading
     52  * @overflow: whether an overflow occured.
     53  * @entries: array of entries, with size of %DRM_CRC_ENTRIES_NR
     54  * @head: head of circular queue
     55  * @tail: tail of circular queue
     56  * @values_cnt: number of CRC values per entry, up to %DRM_MAX_CRC_NR
     57  * @wq: workqueue used to synchronize reading and writing
     58  */
     59 struct drm_crtc_crc {
     60 	spinlock_t lock;
     61 	const char *source;
     62 	bool opened, overflow;
     63 	struct drm_crtc_crc_entry *entries;
     64 	int head, tail;
     65 	size_t values_cnt;
     66 #ifndef __NetBSD__
     67 	wait_queue_head_t wq;
     68 #endif
     69 };
     70 
     71 #if defined(CONFIG_DEBUG_FS)
     72 int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
     73 			   uint32_t frame, uint32_t *crcs);
     74 #else
     75 static inline int drm_crtc_add_crc_entry(struct drm_crtc *crtc, bool has_frame,
     76 					 uint32_t frame, uint32_t *crcs)
     77 {
     78 	return -EINVAL;
     79 }
     80 #endif /* defined(CONFIG_DEBUG_FS) */
     81 
     82 #endif /* __DRM_DEBUGFS_CRC_H__ */
     83