1/*
2 * rcar_du_drv.h  --  R-Car Display Unit DRM driver
3 *
4 * Copyright (C) 2013-2014 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
23struct clk;
24struct device;
25struct drm_device;
26struct drm_fbdev_cma;
27struct rcar_du_device;
28struct rcar_du_lvdsenc;
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
33#define RCAR_DU_QUIRK_ALIGN_128B	(1 << 0)	/* Align pitches to 128 bytes */
34#define RCAR_DU_QUIRK_LVDS_LANES	(1 << 1)	/* LVDS lanes 1 and 3 inverted */
35
36/*
37 * struct rcar_du_output_routing - Output routing specification
38 * @possible_crtcs: bitmask of possible CRTCs for the output
39 * @encoder_type: DRM type of the internal encoder associated with the output
40 * @port: device tree port number corresponding to this output route
41 *
42 * The DU has 5 possible outputs (DPAD0/1, LVDS0/1, TCON). Output routing data
43 * specify the valid SoC outputs, which CRTCs can drive the output, and the type
44 * of in-SoC encoder for the output.
45 */
46struct rcar_du_output_routing {
47	unsigned int possible_crtcs;
48	unsigned int encoder_type;
49	unsigned int port;
50};
51
52/*
53 * struct rcar_du_device_info - DU model-specific information
54 * @features: device features (RCAR_DU_FEATURE_*)
55 * @quirks: device quirks (RCAR_DU_QUIRK_*)
56 * @num_crtcs: total number of CRTCs
57 * @routes: array of CRTC to output routes, indexed by output (RCAR_DU_OUTPUT_*)
58 * @num_lvds: number of internal LVDS encoders
59 */
60struct rcar_du_device_info {
61	unsigned int features;
62	unsigned int quirks;
63	unsigned int num_crtcs;
64	struct rcar_du_output_routing routes[RCAR_DU_OUTPUT_MAX];
65	unsigned int num_lvds;
66};
67
68#define RCAR_DU_MAX_CRTCS		3
69#define RCAR_DU_MAX_GROUPS		DIV_ROUND_UP(RCAR_DU_MAX_CRTCS, 2)
70#define RCAR_DU_MAX_LVDS		2
71
72struct rcar_du_device {
73	struct device *dev;
74	const struct rcar_du_device_info *info;
75
76	void __iomem *mmio;
77
78	struct drm_device *ddev;
79	struct drm_fbdev_cma *fbdev;
80
81	struct rcar_du_crtc crtcs[RCAR_DU_MAX_CRTCS];
82	unsigned int num_crtcs;
83
84	struct rcar_du_group groups[RCAR_DU_MAX_GROUPS];
85
86	unsigned int dpad0_source;
87	struct rcar_du_lvdsenc *lvds[RCAR_DU_MAX_LVDS];
88
89	struct {
90		wait_queue_head_t wait;
91		u32 pending;
92	} commit;
93};
94
95static inline bool rcar_du_has(struct rcar_du_device *rcdu,
96			       unsigned int feature)
97{
98	return rcdu->info->features & feature;
99}
100
101static inline bool rcar_du_needs(struct rcar_du_device *rcdu,
102				 unsigned int quirk)
103{
104	return rcdu->info->quirks & quirk;
105}
106
107static inline u32 rcar_du_read(struct rcar_du_device *rcdu, u32 reg)
108{
109	return ioread32(rcdu->mmio + reg);
110}
111
112static inline void rcar_du_write(struct rcar_du_device *rcdu, u32 reg, u32 data)
113{
114	iowrite32(data, rcdu->mmio + reg);
115}
116
117#endif /* __RCAR_DU_DRV_H__ */
118