1/* exynos_drm_drv.h 2 * 3 * Copyright (c) 2011 Samsung Electronics Co., Ltd. 4 * Authors: 5 * Inki Dae <inki.dae@samsung.com> 6 * Joonyoung Shim <jy0922.shim@samsung.com> 7 * Seung-Woo Kim <sw0312.kim@samsung.com> 8 * 9 * This program is free software; you can redistribute it and/or modify it 10 * under the terms of the GNU General Public License as published by the 11 * Free Software Foundation; either version 2 of the License, or (at your 12 * option) any later version. 13 */ 14 15#ifndef _EXYNOS_DRM_DRV_H_ 16#define _EXYNOS_DRM_DRV_H_ 17 18#include <drm/drmP.h> 19#include <linux/module.h> 20 21#define MAX_CRTC 3 22#define MAX_PLANE 5 23#define MAX_FB_BUFFER 4 24 25#define to_exynos_crtc(x) container_of(x, struct exynos_drm_crtc, base) 26#define to_exynos_plane(x) container_of(x, struct exynos_drm_plane, base) 27 28/* This enumerates device type. */ 29enum exynos_drm_device_type { 30 EXYNOS_DEVICE_TYPE_NONE, 31 EXYNOS_DEVICE_TYPE_CRTC, 32 EXYNOS_DEVICE_TYPE_CONNECTOR, 33}; 34 35/* this enumerates display type. */ 36enum exynos_drm_output_type { 37 EXYNOS_DISPLAY_TYPE_NONE, 38 /* RGB or CPU Interface. */ 39 EXYNOS_DISPLAY_TYPE_LCD, 40 /* HDMI Interface. */ 41 EXYNOS_DISPLAY_TYPE_HDMI, 42 /* Virtual Display Interface. */ 43 EXYNOS_DISPLAY_TYPE_VIDI, 44}; 45 46/* 47 * Exynos drm common overlay structure. 48 * 49 * @base: plane object 50 * @src_x: offset x on a framebuffer to be displayed. 51 * - the unit is screen coordinates. 52 * @src_y: offset y on a framebuffer to be displayed. 53 * - the unit is screen coordinates. 54 * @src_width: width of a partial image to be displayed from framebuffer. 55 * @src_height: height of a partial image to be displayed from framebuffer. 56 * @fb_width: width of a framebuffer. 57 * @fb_height: height of a framebuffer. 58 * @crtc_x: offset x on hardware screen. 59 * @crtc_y: offset y on hardware screen. 60 * @crtc_width: window width to be displayed (hardware screen). 61 * @crtc_height: window height to be displayed (hardware screen). 62 * @mode_width: width of screen mode. 63 * @mode_height: height of screen mode. 64 * @h_ratio: horizontal scaling ratio, 16.16 fixed point 65 * @v_ratio: vertical scaling ratio, 16.16 fixed point 66 * @refresh: refresh rate. 67 * @scan_flag: interlace or progressive way. 68 * (it could be DRM_MODE_FLAG_*) 69 * @bpp: pixel size.(in bit) 70 * @pixel_format: fourcc pixel format of this overlay 71 * @dma_addr: array of bus(accessed by dma) address to the memory region 72 * allocated for a overlay. 73 * @zpos: order of overlay layer(z position). 74 * @enabled: enabled or not. 75 * @resume: to resume or not. 76 * 77 * this structure is common to exynos SoC and its contents would be copied 78 * to hardware specific overlay info. 79 */ 80 81struct exynos_drm_plane { 82 struct drm_plane base; 83 unsigned int src_x; 84 unsigned int src_y; 85 unsigned int src_width; 86 unsigned int src_height; 87 unsigned int fb_width; 88 unsigned int fb_height; 89 unsigned int crtc_x; 90 unsigned int crtc_y; 91 unsigned int crtc_width; 92 unsigned int crtc_height; 93 unsigned int mode_width; 94 unsigned int mode_height; 95 unsigned int h_ratio; 96 unsigned int v_ratio; 97 unsigned int refresh; 98 unsigned int scan_flag; 99 unsigned int bpp; 100 unsigned int pitch; 101 uint32_t pixel_format; 102 dma_addr_t dma_addr[MAX_FB_BUFFER]; 103 unsigned int zpos; 104 105 bool enabled:1; 106 bool resume:1; 107}; 108 109/* 110 * Exynos DRM Display Structure. 111 * - this structure is common to analog tv, digital tv and lcd panel. 112 * 113 * @create_connector: initialize and register a new connector 114 * @remove: cleans up the display for removal 115 * @mode_fixup: fix mode data comparing to hw specific display mode. 116 * @mode_set: convert drm_display_mode to hw specific display mode and 117 * would be called by encoder->mode_set(). 118 * @check_mode: check if mode is valid or not. 119 * @dpms: display device on or off. 120 * @commit: apply changes to hw 121 */ 122struct exynos_drm_display; 123struct exynos_drm_display_ops { 124 int (*create_connector)(struct exynos_drm_display *display, 125 struct drm_encoder *encoder); 126 void (*remove)(struct exynos_drm_display *display); 127 void (*mode_fixup)(struct exynos_drm_display *display, 128 struct drm_connector *connector, 129 const struct drm_display_mode *mode, 130 struct drm_display_mode *adjusted_mode); 131 void (*mode_set)(struct exynos_drm_display *display, 132 struct drm_display_mode *mode); 133 int (*check_mode)(struct exynos_drm_display *display, 134 struct drm_display_mode *mode); 135 void (*dpms)(struct exynos_drm_display *display, int mode); 136 void (*commit)(struct exynos_drm_display *display); 137}; 138 139/* 140 * Exynos drm display structure, maps 1:1 with an encoder/connector 141 * 142 * @list: the list entry for this manager 143 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 144 * @encoder: encoder object this display maps to 145 * @connector: connector object this display maps to 146 * @ops: pointer to callbacks for exynos drm specific functionality 147 * @ctx: A pointer to the display's implementation specific context 148 */ 149struct exynos_drm_display { 150 struct list_head list; 151 enum exynos_drm_output_type type; 152 struct drm_encoder *encoder; 153 struct drm_connector *connector; 154 struct exynos_drm_display_ops *ops; 155}; 156 157/* 158 * Exynos drm crtc ops 159 * 160 * @dpms: control device power. 161 * @mode_fixup: fix mode data before applying it 162 * @commit: set current hw specific display mode to hw. 163 * @enable_vblank: specific driver callback for enabling vblank interrupt. 164 * @disable_vblank: specific driver callback for disabling vblank interrupt. 165 * @wait_for_vblank: wait for vblank interrupt to make sure that 166 * hardware overlay is updated. 167 * @win_commit: apply hardware specific overlay data to registers. 168 * @win_disable: disable hardware specific overlay. 169 * @te_handler: trigger to transfer video image at the tearing effect 170 * synchronization signal if there is a page flip request. 171 * @clock_enable: optional function enabling/disabling display domain clock, 172 * called from exynos-dp driver before powering up (with 173 * 'enable' argument as true) and after powering down (with 174 * 'enable' as false). 175 */ 176struct exynos_drm_crtc; 177struct exynos_drm_crtc_ops { 178 void (*dpms)(struct exynos_drm_crtc *crtc, int mode); 179 bool (*mode_fixup)(struct exynos_drm_crtc *crtc, 180 const struct drm_display_mode *mode, 181 struct drm_display_mode *adjusted_mode); 182 void (*commit)(struct exynos_drm_crtc *crtc); 183 int (*enable_vblank)(struct exynos_drm_crtc *crtc); 184 void (*disable_vblank)(struct exynos_drm_crtc *crtc); 185 void (*wait_for_vblank)(struct exynos_drm_crtc *crtc); 186 void (*win_commit)(struct exynos_drm_crtc *crtc, unsigned int zpos); 187 void (*win_disable)(struct exynos_drm_crtc *crtc, unsigned int zpos); 188 void (*te_handler)(struct exynos_drm_crtc *crtc); 189 void (*clock_enable)(struct exynos_drm_crtc *crtc, bool enable); 190}; 191 192/* 193 * Exynos specific crtc structure. 194 * 195 * @base: crtc object. 196 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 197 * @pipe: a crtc index created at load() with a new crtc object creation 198 * and the crtc object would be set to private->crtc array 199 * to get a crtc object corresponding to this pipe from private->crtc 200 * array when irq interrupt occurred. the reason of using this pipe is that 201 * drm framework doesn't support multiple irq yet. 202 * we can refer to the crtc to current hardware interrupt occurred through 203 * this pipe value. 204 * @dpms: store the crtc dpms value 205 * @event: vblank event that is currently queued for flip 206 * @ops: pointer to callbacks for exynos drm specific functionality 207 * @ctx: A pointer to the crtc's implementation specific context 208 */ 209struct exynos_drm_crtc { 210 struct drm_crtc base; 211 enum exynos_drm_output_type type; 212 unsigned int pipe; 213 unsigned int dpms; 214 wait_queue_head_t pending_flip_queue; 215 struct drm_pending_vblank_event *event; 216 const struct exynos_drm_crtc_ops *ops; 217 void *ctx; 218}; 219 220struct exynos_drm_g2d_private { 221 struct device *dev; 222 struct list_head inuse_cmdlist; 223 struct list_head event_list; 224 struct list_head userptr_list; 225}; 226 227struct drm_exynos_file_private { 228 struct exynos_drm_g2d_private *g2d_priv; 229 struct device *ipp_dev; 230}; 231 232/* 233 * Exynos drm private structure. 234 * 235 * @da_start: start address to device address space. 236 * with iommu, device address space starts from this address 237 * otherwise default one. 238 * @da_space_size: size of device address space. 239 * if 0 then default value is used for it. 240 * @pipe: the pipe number for this crtc/manager. 241 */ 242struct exynos_drm_private { 243 struct drm_fb_helper *fb_helper; 244 245 /* 246 * created crtc object would be contained at this array and 247 * this array is used to be aware of which crtc did it request vblank. 248 */ 249 struct drm_crtc *crtc[MAX_CRTC]; 250 struct drm_property *plane_zpos_property; 251 252 unsigned long da_start; 253 unsigned long da_space_size; 254 255 unsigned int pipe; 256}; 257 258/* 259 * Exynos drm sub driver structure. 260 * 261 * @list: sub driver has its own list object to register to exynos drm driver. 262 * @dev: pointer to device object for subdrv device driver. 263 * @drm_dev: pointer to drm_device and this pointer would be set 264 * when sub driver calls exynos_drm_subdrv_register(). 265 * @probe: this callback would be called by exynos drm driver after 266 * subdrv is registered to it. 267 * @remove: this callback is used to release resources created 268 * by probe callback. 269 * @open: this would be called with drm device file open. 270 * @close: this would be called with drm device file close. 271 */ 272struct exynos_drm_subdrv { 273 struct list_head list; 274 struct device *dev; 275 struct drm_device *drm_dev; 276 277 int (*probe)(struct drm_device *drm_dev, struct device *dev); 278 void (*remove)(struct drm_device *drm_dev, struct device *dev); 279 int (*open)(struct drm_device *drm_dev, struct device *dev, 280 struct drm_file *file); 281 void (*close)(struct drm_device *drm_dev, struct device *dev, 282 struct drm_file *file); 283}; 284 285 /* This function would be called by non kms drivers such as g2d and ipp. */ 286int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 287 288/* this function removes subdrv list from exynos drm driver */ 289int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 290 291int exynos_drm_device_subdrv_probe(struct drm_device *dev); 292int exynos_drm_device_subdrv_remove(struct drm_device *dev); 293int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 294void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 295 296#ifdef CONFIG_DRM_EXYNOS_IPP 297int exynos_platform_device_ipp_register(void); 298void exynos_platform_device_ipp_unregister(void); 299#else 300static inline int exynos_platform_device_ipp_register(void) { return 0; } 301static inline void exynos_platform_device_ipp_unregister(void) {} 302#endif 303 304 305#ifdef CONFIG_DRM_EXYNOS_DPI 306struct exynos_drm_display * exynos_dpi_probe(struct device *dev); 307int exynos_dpi_remove(struct exynos_drm_display *display); 308#else 309static inline struct exynos_drm_display * 310exynos_dpi_probe(struct device *dev) { return NULL; } 311static inline int exynos_dpi_remove(struct exynos_drm_display *display) 312{ 313 return 0; 314} 315#endif 316 317#ifdef CONFIG_DRM_EXYNOS_VIDI 318int exynos_drm_probe_vidi(void); 319void exynos_drm_remove_vidi(void); 320#else 321static inline int exynos_drm_probe_vidi(void) { return 0; } 322static inline void exynos_drm_remove_vidi(void) {} 323#endif 324 325/* This function creates a encoder and a connector, and initializes them. */ 326int exynos_drm_create_enc_conn(struct drm_device *dev, 327 struct exynos_drm_display *display); 328 329int exynos_drm_component_add(struct device *dev, 330 enum exynos_drm_device_type dev_type, 331 enum exynos_drm_output_type out_type); 332 333void exynos_drm_component_del(struct device *dev, 334 enum exynos_drm_device_type dev_type); 335 336extern struct platform_driver fimd_driver; 337extern struct platform_driver decon_driver; 338extern struct platform_driver dp_driver; 339extern struct platform_driver dsi_driver; 340extern struct platform_driver mixer_driver; 341extern struct platform_driver hdmi_driver; 342extern struct platform_driver exynos_drm_common_hdmi_driver; 343extern struct platform_driver vidi_driver; 344extern struct platform_driver g2d_driver; 345extern struct platform_driver fimc_driver; 346extern struct platform_driver rotator_driver; 347extern struct platform_driver gsc_driver; 348extern struct platform_driver ipp_driver; 349#endif 350