exynos_drm_drv.h revision 5c76c5b146b0f25ee55af190c6213faf63da0cd9
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 <linux/module.h> 19 20#define MAX_CRTC 3 21#define MAX_PLANE 5 22#define MAX_FB_BUFFER 4 23#define DEFAULT_ZPOS -1 24 25#define _wait_for(COND, MS) ({ \ 26 unsigned long timeout__ = jiffies + msecs_to_jiffies(MS); \ 27 int ret__ = 0; \ 28 while (!(COND)) { \ 29 if (time_after(jiffies, timeout__)) { \ 30 ret__ = -ETIMEDOUT; \ 31 break; \ 32 } \ 33 } \ 34 ret__; \ 35}) 36 37#define wait_for(COND, MS) _wait_for(COND, MS) 38 39struct drm_device; 40struct exynos_drm_overlay; 41struct drm_connector; 42 43/* This enumerates device type. */ 44enum exynos_drm_device_type { 45 EXYNOS_DEVICE_TYPE_NONE, 46 EXYNOS_DEVICE_TYPE_CRTC, 47 EXYNOS_DEVICE_TYPE_CONNECTOR, 48}; 49 50/* this enumerates display type. */ 51enum exynos_drm_output_type { 52 EXYNOS_DISPLAY_TYPE_NONE, 53 /* RGB or CPU Interface. */ 54 EXYNOS_DISPLAY_TYPE_LCD, 55 /* HDMI Interface. */ 56 EXYNOS_DISPLAY_TYPE_HDMI, 57 /* Virtual Display Interface. */ 58 EXYNOS_DISPLAY_TYPE_VIDI, 59}; 60 61/* 62 * Exynos drm common overlay structure. 63 * 64 * @fb_x: offset x on a framebuffer to be displayed. 65 * - the unit is screen coordinates. 66 * @fb_y: offset y on a framebuffer to be displayed. 67 * - the unit is screen coordinates. 68 * @fb_width: width of a framebuffer. 69 * @fb_height: height of a framebuffer. 70 * @src_width: width of a partial image to be displayed from framebuffer. 71 * @src_height: height of a partial image to be displayed from framebuffer. 72 * @crtc_x: offset x on hardware screen. 73 * @crtc_y: offset y on hardware screen. 74 * @crtc_width: window width to be displayed (hardware screen). 75 * @crtc_height: window height to be displayed (hardware screen). 76 * @mode_width: width of screen mode. 77 * @mode_height: height of screen mode. 78 * @refresh: refresh rate. 79 * @scan_flag: interlace or progressive way. 80 * (it could be DRM_MODE_FLAG_*) 81 * @bpp: pixel size.(in bit) 82 * @pixel_format: fourcc pixel format of this overlay 83 * @dma_addr: array of bus(accessed by dma) address to the memory region 84 * allocated for a overlay. 85 * @zpos: order of overlay layer(z position). 86 * @default_win: a window to be enabled. 87 * @color_key: color key on or off. 88 * @index_color: if using color key feature then this value would be used 89 * as index color. 90 * @local_path: in case of lcd type, local path mode on or off. 91 * @transparency: transparency on or off. 92 * @activated: activated or not. 93 * 94 * this structure is common to exynos SoC and its contents would be copied 95 * to hardware specific overlay info. 96 */ 97struct exynos_drm_overlay { 98 unsigned int fb_x; 99 unsigned int fb_y; 100 unsigned int fb_width; 101 unsigned int fb_height; 102 unsigned int src_width; 103 unsigned int src_height; 104 unsigned int crtc_x; 105 unsigned int crtc_y; 106 unsigned int crtc_width; 107 unsigned int crtc_height; 108 unsigned int mode_width; 109 unsigned int mode_height; 110 unsigned int refresh; 111 unsigned int scan_flag; 112 unsigned int bpp; 113 unsigned int pitch; 114 uint32_t pixel_format; 115 dma_addr_t dma_addr[MAX_FB_BUFFER]; 116 int zpos; 117 118 bool default_win; 119 bool color_key; 120 unsigned int index_color; 121 bool local_path; 122 bool transparency; 123 bool activated; 124}; 125 126/* 127 * Exynos DRM Display Structure. 128 * - this structure is common to analog tv, digital tv and lcd panel. 129 * 130 * @remove: cleans up the display for removal 131 * @mode_fixup: fix mode data comparing to hw specific display mode. 132 * @mode_set: convert drm_display_mode to hw specific display mode and 133 * would be called by encoder->mode_set(). 134 * @check_mode: check if mode is valid or not. 135 * @dpms: display device on or off. 136 * @commit: apply changes to hw 137 */ 138struct exynos_drm_display; 139struct exynos_drm_display_ops { 140 int (*create_connector)(struct exynos_drm_display *display, 141 struct drm_encoder *encoder); 142 void (*remove)(struct exynos_drm_display *display); 143 void (*mode_fixup)(struct exynos_drm_display *display, 144 struct drm_connector *connector, 145 const struct drm_display_mode *mode, 146 struct drm_display_mode *adjusted_mode); 147 void (*mode_set)(struct exynos_drm_display *display, 148 struct drm_display_mode *mode); 149 int (*check_mode)(struct exynos_drm_display *display, 150 struct drm_display_mode *mode); 151 void (*dpms)(struct exynos_drm_display *display, int mode); 152 void (*commit)(struct exynos_drm_display *display); 153}; 154 155/* 156 * Exynos drm display structure, maps 1:1 with an encoder/connector 157 * 158 * @list: the list entry for this manager 159 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 160 * @encoder: encoder object this display maps to 161 * @connector: connector object this display maps to 162 * @ops: pointer to callbacks for exynos drm specific functionality 163 * @ctx: A pointer to the display's implementation specific context 164 */ 165struct exynos_drm_display { 166 struct list_head list; 167 enum exynos_drm_output_type type; 168 struct drm_encoder *encoder; 169 struct drm_connector *connector; 170 struct exynos_drm_display_ops *ops; 171 void *ctx; 172}; 173 174/* 175 * Exynos drm manager ops 176 * 177 * @dpms: control device power. 178 * @mode_fixup: fix mode data before applying it 179 * @mode_set: set the given mode to the manager 180 * @commit: set current hw specific display mode to hw. 181 * @enable_vblank: specific driver callback for enabling vblank interrupt. 182 * @disable_vblank: specific driver callback for disabling vblank interrupt. 183 * @wait_for_vblank: wait for vblank interrupt to make sure that 184 * hardware overlay is updated. 185 * @win_mode_set: copy drm overlay info to hw specific overlay info. 186 * @win_commit: apply hardware specific overlay data to registers. 187 * @win_enable: enable hardware specific overlay. 188 * @win_disable: disable hardware specific overlay. 189 * @te_handler: trigger to transfer video image at the tearing effect 190 * synchronization signal if there is a page flip request. 191 */ 192struct exynos_drm_manager; 193struct exynos_drm_manager_ops { 194 void (*dpms)(struct exynos_drm_manager *mgr, int mode); 195 bool (*mode_fixup)(struct exynos_drm_manager *mgr, 196 const struct drm_display_mode *mode, 197 struct drm_display_mode *adjusted_mode); 198 void (*mode_set)(struct exynos_drm_manager *mgr, 199 const struct drm_display_mode *mode); 200 void (*commit)(struct exynos_drm_manager *mgr); 201 int (*enable_vblank)(struct exynos_drm_manager *mgr); 202 void (*disable_vblank)(struct exynos_drm_manager *mgr); 203 void (*wait_for_vblank)(struct exynos_drm_manager *mgr); 204 void (*win_mode_set)(struct exynos_drm_manager *mgr, 205 struct exynos_drm_overlay *overlay); 206 void (*win_commit)(struct exynos_drm_manager *mgr, int zpos); 207 void (*win_enable)(struct exynos_drm_manager *mgr, int zpos); 208 void (*win_disable)(struct exynos_drm_manager *mgr, int zpos); 209 void (*te_handler)(struct exynos_drm_manager *mgr); 210}; 211 212/* 213 * Exynos drm common manager structure, maps 1:1 with a crtc 214 * 215 * @list: the list entry for this manager 216 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 217 * @drm_dev: pointer to the drm device 218 * @crtc: crtc object. 219 * @pipe: the pipe number for this crtc/manager 220 * @ops: pointer to callbacks for exynos drm specific functionality 221 * @ctx: A pointer to the manager's implementation specific context 222 */ 223struct exynos_drm_manager { 224 struct list_head list; 225 enum exynos_drm_output_type type; 226 struct drm_device *drm_dev; 227 struct drm_crtc *crtc; 228 int pipe; 229 struct exynos_drm_manager_ops *ops; 230 void *ctx; 231}; 232 233struct exynos_drm_g2d_private { 234 struct device *dev; 235 struct list_head inuse_cmdlist; 236 struct list_head event_list; 237 struct list_head userptr_list; 238}; 239 240struct drm_exynos_file_private { 241 struct exynos_drm_g2d_private *g2d_priv; 242 struct device *ipp_dev; 243 struct file *anon_filp; 244}; 245 246/* 247 * Exynos drm private structure. 248 * 249 * @da_start: start address to device address space. 250 * with iommu, device address space starts from this address 251 * otherwise default one. 252 * @da_space_size: size of device address space. 253 * if 0 then default value is used for it. 254 * @pipe: the pipe number for this crtc/manager. 255 */ 256struct exynos_drm_private { 257 struct drm_fb_helper *fb_helper; 258 259 /* list head for new event to be added. */ 260 struct list_head pageflip_event_list; 261 262 /* 263 * created crtc object would be contained at this array and 264 * this array is used to be aware of which crtc did it request vblank. 265 */ 266 struct drm_crtc *crtc[MAX_CRTC]; 267 struct drm_property *plane_zpos_property; 268 struct drm_property *crtc_mode_property; 269 270 unsigned long da_start; 271 unsigned long da_space_size; 272 273 unsigned int pipe; 274}; 275 276/* 277 * Exynos drm sub driver structure. 278 * 279 * @list: sub driver has its own list object to register to exynos drm driver. 280 * @dev: pointer to device object for subdrv device driver. 281 * @drm_dev: pointer to drm_device and this pointer would be set 282 * when sub driver calls exynos_drm_subdrv_register(). 283 * @manager: subdrv has its own manager to control a hardware appropriately 284 * and we can access a hardware drawing on this manager. 285 * @probe: this callback would be called by exynos drm driver after 286 * subdrv is registered to it. 287 * @remove: this callback is used to release resources created 288 * by probe callback. 289 * @open: this would be called with drm device file open. 290 * @close: this would be called with drm device file close. 291 */ 292struct exynos_drm_subdrv { 293 struct list_head list; 294 struct device *dev; 295 struct drm_device *drm_dev; 296 297 int (*probe)(struct drm_device *drm_dev, struct device *dev); 298 void (*remove)(struct drm_device *drm_dev, struct device *dev); 299 int (*open)(struct drm_device *drm_dev, struct device *dev, 300 struct drm_file *file); 301 void (*close)(struct drm_device *drm_dev, struct device *dev, 302 struct drm_file *file); 303}; 304 305 /* This function would be called by non kms drivers such as g2d and ipp. */ 306int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 307 308/* this function removes subdrv list from exynos drm driver */ 309int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 310 311int exynos_drm_device_subdrv_probe(struct drm_device *dev); 312int exynos_drm_device_subdrv_remove(struct drm_device *dev); 313int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 314void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 315 316/* 317 * this function registers exynos drm hdmi platform device. It ensures only one 318 * instance of the device is created. 319 */ 320int exynos_platform_device_hdmi_register(void); 321 322/* 323 * this function unregisters exynos drm hdmi platform device if it exists. 324 */ 325void exynos_platform_device_hdmi_unregister(void); 326 327/* 328 * this function registers exynos drm ipp platform device. 329 */ 330int exynos_platform_device_ipp_register(void); 331 332/* 333 * this function unregisters exynos drm ipp platform device if it exists. 334 */ 335void exynos_platform_device_ipp_unregister(void); 336 337#ifdef CONFIG_DRM_EXYNOS_DPI 338struct exynos_drm_display * exynos_dpi_probe(struct device *dev); 339int exynos_dpi_remove(struct device *dev); 340#else 341static inline struct exynos_drm_display * 342exynos_dpi_probe(struct device *dev) { return NULL; } 343static inline int exynos_dpi_remove(struct device *dev) { return 0; } 344#endif 345 346/* 347 * this function registers exynos drm vidi platform device/driver. 348 */ 349int exynos_drm_probe_vidi(void); 350 351/* 352 * this function unregister exynos drm vidi platform device/driver. 353 */ 354void exynos_drm_remove_vidi(void); 355 356/* This function creates a encoder and a connector, and initializes them. */ 357int exynos_drm_create_enc_conn(struct drm_device *dev, 358 struct exynos_drm_display *display); 359 360int exynos_drm_component_add(struct device *dev, 361 enum exynos_drm_device_type dev_type, 362 enum exynos_drm_output_type out_type); 363 364void exynos_drm_component_del(struct device *dev, 365 enum exynos_drm_device_type dev_type); 366 367extern struct platform_driver fimd_driver; 368extern struct platform_driver dp_driver; 369extern struct platform_driver dsi_driver; 370extern struct platform_driver mixer_driver; 371extern struct platform_driver hdmi_driver; 372extern struct platform_driver exynos_drm_common_hdmi_driver; 373extern struct platform_driver vidi_driver; 374extern struct platform_driver g2d_driver; 375extern struct platform_driver fimc_driver; 376extern struct platform_driver rotator_driver; 377extern struct platform_driver gsc_driver; 378extern struct platform_driver ipp_driver; 379#endif 380