]> asedeno.scripts.mit.edu Git - linux.git/blob - drivers/gpu/drm/rcar-du/rcar_du_crtc.h
drm: rcar-du: Fix rcar_du_crtc structure documentation
[linux.git] / drivers / gpu / drm / rcar-du / rcar_du_crtc.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * rcar_du_crtc.h  --  R-Car Display Unit CRTCs
4  *
5  * Copyright (C) 2013-2015 Renesas Electronics Corporation
6  *
7  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
8  */
9
10 #ifndef __RCAR_DU_CRTC_H__
11 #define __RCAR_DU_CRTC_H__
12
13 #include <linux/mutex.h>
14 #include <linux/spinlock.h>
15 #include <linux/wait.h>
16
17 #include <drm/drm_crtc.h>
18
19 #include <media/vsp1.h>
20
21 struct rcar_du_group;
22 struct rcar_du_vsp;
23
24 /**
25  * struct rcar_du_crtc - the CRTC, representing a DU superposition processor
26  * @crtc: base DRM CRTC
27  * @clock: the CRTC functional clock
28  * @extclock: external pixel dot clock (optional)
29  * @mmio_offset: offset of the CRTC registers in the DU MMIO block
30  * @index: CRTC hardware index
31  * @initialized: whether the CRTC has been initialized and clocks enabled
32  * @dsysr: cached value of the DSYSR register
33  * @vblank_enable: whether vblank events are enabled on this CRTC
34  * @event: event to post when the pending page flip completes
35  * @flip_wait: wait queue used to signal page flip completion
36  * @vblank_lock: protects vblank_wait and vblank_count
37  * @vblank_wait: wait queue used to signal vertical blanking
38  * @vblank_count: number of vertical blanking interrupts to wait for
39  * @group: CRTC group this CRTC belongs to
40  * @vsp: VSP feeding video to this CRTC
41  * @vsp_pipe: index of the VSP pipeline feeding video to this CRTC
42  */
43 struct rcar_du_crtc {
44         struct drm_crtc crtc;
45
46         struct clk *clock;
47         struct clk *extclock;
48         unsigned int mmio_offset;
49         unsigned int index;
50         bool initialized;
51
52         u32 dsysr;
53
54         bool vblank_enable;
55         struct drm_pending_vblank_event *event;
56         wait_queue_head_t flip_wait;
57
58         spinlock_t vblank_lock;
59         wait_queue_head_t vblank_wait;
60         unsigned int vblank_count;
61
62         struct rcar_du_group *group;
63         struct rcar_du_vsp *vsp;
64         unsigned int vsp_pipe;
65
66         const char *const *sources;
67         unsigned int sources_count;
68 };
69
70 #define to_rcar_crtc(c) container_of(c, struct rcar_du_crtc, crtc)
71
72 /**
73  * struct rcar_du_crtc_state - Driver-specific CRTC state
74  * @state: base DRM CRTC state
75  * @crc: CRC computation configuration
76  * @outputs: bitmask of the outputs (enum rcar_du_output) driven by this CRTC
77  */
78 struct rcar_du_crtc_state {
79         struct drm_crtc_state state;
80
81         struct vsp1_du_crc_config crc;
82         unsigned int outputs;
83 };
84
85 #define to_rcar_crtc_state(s) container_of(s, struct rcar_du_crtc_state, state)
86
87 enum rcar_du_output {
88         RCAR_DU_OUTPUT_DPAD0,
89         RCAR_DU_OUTPUT_DPAD1,
90         RCAR_DU_OUTPUT_LVDS0,
91         RCAR_DU_OUTPUT_LVDS1,
92         RCAR_DU_OUTPUT_HDMI0,
93         RCAR_DU_OUTPUT_HDMI1,
94         RCAR_DU_OUTPUT_TCON,
95         RCAR_DU_OUTPUT_MAX,
96 };
97
98 int rcar_du_crtc_create(struct rcar_du_group *rgrp, unsigned int swindex,
99                         unsigned int hwindex);
100 void rcar_du_crtc_suspend(struct rcar_du_crtc *rcrtc);
101 void rcar_du_crtc_resume(struct rcar_du_crtc *rcrtc);
102
103 void rcar_du_crtc_finish_page_flip(struct rcar_du_crtc *rcrtc);
104
105 void rcar_du_crtc_dsysr_clr_set(struct rcar_du_crtc *rcrtc, u32 clr, u32 set);
106
107 #endif /* __RCAR_DU_CRTC_H__ */