GNU Linux-libre 5.10.153-gnu1
[releases.git] / drivers / gpu / drm / rcar-du / rcar_du_drv.h
1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3  * rcar_du_drv.h  --  R-Car Display Unit DRM driver
4  *
5  * Copyright (C) 2013-2015 Renesas Electronics Corporation
6  *
7  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
8  */
9
10 #ifndef __RCAR_DU_DRV_H__
11 #define __RCAR_DU_DRV_H__
12
13 #include <linux/kernel.h>
14 #include <linux/wait.h>
15
16 #include "rcar_cmm.h"
17 #include "rcar_du_crtc.h"
18 #include "rcar_du_group.h"
19 #include "rcar_du_vsp.h"
20
21 struct clk;
22 struct device;
23 struct drm_bridge;
24 struct drm_device;
25 struct drm_property;
26 struct rcar_du_device;
27
28 #define RCAR_DU_FEATURE_CRTC_IRQ_CLOCK  BIT(0)  /* Per-CRTC IRQ and clock */
29 #define RCAR_DU_FEATURE_VSP1_SOURCE     BIT(1)  /* Has inputs from VSP1 */
30 #define RCAR_DU_FEATURE_INTERLACED      BIT(2)  /* HW supports interlaced */
31 #define RCAR_DU_FEATURE_TVM_SYNC        BIT(3)  /* Has TV switch/sync modes */
32
33 #define RCAR_DU_QUIRK_ALIGN_128B        BIT(0)  /* Align pitches to 128 bytes */
34
35 /*
36  * struct rcar_du_output_routing - Output routing specification
37  * @possible_crtcs: bitmask of possible CRTCs for the output
38  * @port: device tree port number corresponding to this output route
39  *
40  * The DU has 5 possible outputs (DPAD0/1, LVDS0/1, TCON). Output routing data
41  * specify the valid SoC outputs, which CRTCs can drive the output, and the type
42  * of in-SoC encoder for the output.
43  */
44 struct rcar_du_output_routing {
45         unsigned int possible_crtcs;
46         unsigned int port;
47 };
48
49 /*
50  * struct rcar_du_device_info - DU model-specific information
51  * @gen: device generation (2 or 3)
52  * @features: device features (RCAR_DU_FEATURE_*)
53  * @quirks: device quirks (RCAR_DU_QUIRK_*)
54  * @channels_mask: bit mask of available DU channels
55  * @routes: array of CRTC to output routes, indexed by output (RCAR_DU_OUTPUT_*)
56  * @num_lvds: number of internal LVDS encoders
57  * @dpll_mask: bit mask of DU channels equipped with a DPLL
58  * @lvds_clk_mask: bitmask of channels that can use the LVDS clock as dot clock
59  */
60 struct rcar_du_device_info {
61         unsigned int gen;
62         unsigned int features;
63         unsigned int quirks;
64         unsigned int channels_mask;
65         struct rcar_du_output_routing routes[RCAR_DU_OUTPUT_MAX];
66         unsigned int num_lvds;
67         unsigned int dpll_mask;
68         unsigned int lvds_clk_mask;
69 };
70
71 #define RCAR_DU_MAX_CRTCS               4
72 #define RCAR_DU_MAX_GROUPS              DIV_ROUND_UP(RCAR_DU_MAX_CRTCS, 2)
73 #define RCAR_DU_MAX_VSPS                4
74 #define RCAR_DU_MAX_LVDS                2
75
76 struct rcar_du_device {
77         struct device *dev;
78         const struct rcar_du_device_info *info;
79
80         void __iomem *mmio;
81
82         struct drm_device *ddev;
83
84         struct rcar_du_crtc crtcs[RCAR_DU_MAX_CRTCS];
85         unsigned int num_crtcs;
86
87         struct rcar_du_group groups[RCAR_DU_MAX_GROUPS];
88         struct platform_device *cmms[RCAR_DU_MAX_CRTCS];
89         struct rcar_du_vsp vsps[RCAR_DU_MAX_VSPS];
90         struct drm_bridge *lvds[RCAR_DU_MAX_LVDS];
91
92         struct {
93                 struct drm_property *colorkey;
94         } props;
95
96         unsigned int dpad0_source;
97         unsigned int dpad1_source;
98         unsigned int vspd1_sink;
99 };
100
101 static inline bool rcar_du_has(struct rcar_du_device *rcdu,
102                                unsigned int feature)
103 {
104         return rcdu->info->features & feature;
105 }
106
107 static inline bool rcar_du_needs(struct rcar_du_device *rcdu,
108                                  unsigned int quirk)
109 {
110         return rcdu->info->quirks & quirk;
111 }
112
113 static inline u32 rcar_du_read(struct rcar_du_device *rcdu, u32 reg)
114 {
115         return ioread32(rcdu->mmio + reg);
116 }
117
118 static inline void rcar_du_write(struct rcar_du_device *rcdu, u32 reg, u32 data)
119 {
120         iowrite32(data, rcdu->mmio + reg);
121 }
122
123 #endif /* __RCAR_DU_DRV_H__ */