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
 24struct clk;
 25struct device;
 26struct drm_device;
 27struct drm_fbdev_cma;
 28struct 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 */
 45struct 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 * @num_crtcs: total number of CRTCs
 56 * @routes: array of CRTC to output routes, indexed by output (RCAR_DU_OUTPUT_*)
 57 * @num_lvds: number of internal LVDS encoders
 58 */
 59struct rcar_du_device_info {
 60	unsigned int gen;
 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	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
 73struct 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 *alpha;
 91		struct drm_property *colorkey;
 92	} props;
 93
 94	unsigned int dpad0_source;
 95	unsigned int vspd1_sink;
 96};
 97
 98static inline bool rcar_du_has(struct rcar_du_device *rcdu,
 99			       unsigned int feature)
100{
101	return rcdu->info->features & feature;
102}
103
104static inline bool rcar_du_needs(struct rcar_du_device *rcdu,
105				 unsigned int quirk)
106{
107	return rcdu->info->quirks & quirk;
108}
109
110static inline u32 rcar_du_read(struct rcar_du_device *rcdu, u32 reg)
111{
112	return ioread32(rcdu->mmio + reg);
113}
114
115static inline void rcar_du_write(struct rcar_du_device *rcdu, u32 reg, u32 data)
116{
117	iowrite32(data, rcdu->mmio + reg);
118}
119
120#endif /* __RCAR_DU_DRV_H__ */