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