1 /*
2  * rcar_du_drv.h  --  R-Car Display Unit DRM driver
3  *
4  * Copyright (C) 2013-2015 Renesas Electronics Corporation
5  *
6  * Contact: Laurent Pinchart (laurent.pinchart@ideasonboard.com)
7  *
8  * This program is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  */
13 
14 #ifndef __RCAR_DU_DRV_H__
15 #define __RCAR_DU_DRV_H__
16 
17 #include <linux/kernel.h>
18 #include <linux/wait.h>
19 
20 #include "rcar_du_crtc.h"
21 #include "rcar_du_group.h"
22 #include "rcar_du_vsp.h"
23 
24 struct clk;
25 struct device;
26 struct drm_device;
27 struct drm_fbdev_cma;
28 struct rcar_du_device;
29 
30 #define RCAR_DU_FEATURE_CRTC_IRQ_CLOCK	(1 << 0)	/* Per-CRTC IRQ and clock */
31 #define RCAR_DU_FEATURE_EXT_CTRL_REGS	(1 << 1)	/* Has extended control registers */
32 #define RCAR_DU_FEATURE_VSP1_SOURCE	(1 << 2)	/* Has inputs from VSP1 */
33 
34 #define RCAR_DU_QUIRK_ALIGN_128B	(1 << 0)	/* Align pitches to 128 bytes */
35 
36 /*
37  * struct rcar_du_output_routing - Output routing specification
38  * @possible_crtcs: bitmask of possible CRTCs for the output
39  * @port: device tree port number corresponding to this output route
40  *
41  * The DU has 5 possible outputs (DPAD0/1, LVDS0/1, TCON). Output routing data
42  * specify the valid SoC outputs, which CRTCs can drive the output, and the type
43  * of in-SoC encoder for the output.
44  */
45 struct rcar_du_output_routing {
46 	unsigned int possible_crtcs;
47 	unsigned int port;
48 };
49 
50 /*
51  * struct rcar_du_device_info - DU model-specific information
52  * @gen: device generation (2 or 3)
53  * @features: device features (RCAR_DU_FEATURE_*)
54  * @quirks: device quirks (RCAR_DU_QUIRK_*)
55  * @channels_mask: bit mask of available DU channels
56  * @routes: array of CRTC to output routes, indexed by output (RCAR_DU_OUTPUT_*)
57  * @num_lvds: number of internal LVDS encoders
58  */
59 struct rcar_du_device_info {
60 	unsigned int gen;
61 	unsigned int features;
62 	unsigned int quirks;
63 	unsigned int channels_mask;
64 	struct rcar_du_output_routing routes[RCAR_DU_OUTPUT_MAX];
65 	unsigned int num_lvds;
66 	unsigned int dpll_ch;
67 };
68 
69 #define RCAR_DU_MAX_CRTCS		4
70 #define RCAR_DU_MAX_GROUPS		DIV_ROUND_UP(RCAR_DU_MAX_CRTCS, 2)
71 #define RCAR_DU_MAX_VSPS		4
72 
73 struct rcar_du_device {
74 	struct device *dev;
75 	const struct rcar_du_device_info *info;
76 
77 	void __iomem *mmio;
78 
79 	struct drm_device *ddev;
80 	struct drm_fbdev_cma *fbdev;
81 	struct drm_atomic_state *suspend_state;
82 
83 	struct rcar_du_crtc crtcs[RCAR_DU_MAX_CRTCS];
84 	unsigned int num_crtcs;
85 
86 	struct rcar_du_group groups[RCAR_DU_MAX_GROUPS];
87 	struct rcar_du_vsp vsps[RCAR_DU_MAX_VSPS];
88 
89 	struct {
90 		struct drm_property *colorkey;
91 	} props;
92 
93 	unsigned int dpad0_source;
94 	unsigned int vspd1_sink;
95 };
96 
rcar_du_has(struct rcar_du_device * rcdu,unsigned int feature)97 static inline bool rcar_du_has(struct rcar_du_device *rcdu,
98 			       unsigned int feature)
99 {
100 	return rcdu->info->features & feature;
101 }
102 
rcar_du_needs(struct rcar_du_device * rcdu,unsigned int quirk)103 static inline bool rcar_du_needs(struct rcar_du_device *rcdu,
104 				 unsigned int quirk)
105 {
106 	return rcdu->info->quirks & quirk;
107 }
108 
rcar_du_read(struct rcar_du_device * rcdu,u32 reg)109 static inline u32 rcar_du_read(struct rcar_du_device *rcdu, u32 reg)
110 {
111 	return ioread32(rcdu->mmio + reg);
112 }
113 
rcar_du_write(struct rcar_du_device * rcdu,u32 reg,u32 data)114 static inline void rcar_du_write(struct rcar_du_device *rcdu, u32 reg, u32 data)
115 {
116 	iowrite32(data, rcdu->mmio + reg);
117 }
118 
119 #endif /* __RCAR_DU_DRV_H__ */
120