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 39 struct drm_device; 40 struct exynos_drm_overlay; 41 struct drm_connector; 42 43 extern unsigned int drm_vblank_offdelay; 44 45 /* this enumerates display type. */ 46 enum exynos_drm_output_type { 47 EXYNOS_DISPLAY_TYPE_NONE, 48 /* RGB or CPU Interface. */ 49 EXYNOS_DISPLAY_TYPE_LCD, 50 /* HDMI Interface. */ 51 EXYNOS_DISPLAY_TYPE_HDMI, 52 /* Virtual Display Interface. */ 53 EXYNOS_DISPLAY_TYPE_VIDI, 54 }; 55 56 /* 57 * Exynos drm common overlay structure. 58 * 59 * @fb_x: offset x on a framebuffer to be displayed. 60 * - the unit is screen coordinates. 61 * @fb_y: offset y on a framebuffer to be displayed. 62 * - the unit is screen coordinates. 63 * @fb_width: width of a framebuffer. 64 * @fb_height: height of a framebuffer. 65 * @src_width: width of a partial image to be displayed from framebuffer. 66 * @src_height: height of a partial image to be displayed from framebuffer. 67 * @crtc_x: offset x on hardware screen. 68 * @crtc_y: offset y on hardware screen. 69 * @crtc_width: window width to be displayed (hardware screen). 70 * @crtc_height: window height to be displayed (hardware screen). 71 * @mode_width: width of screen mode. 72 * @mode_height: height of screen mode. 73 * @refresh: refresh rate. 74 * @scan_flag: interlace or progressive way. 75 * (it could be DRM_MODE_FLAG_*) 76 * @bpp: pixel size.(in bit) 77 * @pixel_format: fourcc pixel format of this overlay 78 * @dma_addr: array of bus(accessed by dma) address to the memory region 79 * allocated for a overlay. 80 * @zpos: order of overlay layer(z position). 81 * @default_win: a window to be enabled. 82 * @color_key: color key on or off. 83 * @index_color: if using color key feature then this value would be used 84 * as index color. 85 * @local_path: in case of lcd type, local path mode on or off. 86 * @transparency: transparency on or off. 87 * @activated: activated or not. 88 * 89 * this structure is common to exynos SoC and its contents would be copied 90 * to hardware specific overlay info. 91 */ 92 struct exynos_drm_overlay { 93 unsigned int fb_x; 94 unsigned int fb_y; 95 unsigned int fb_width; 96 unsigned int fb_height; 97 unsigned int src_width; 98 unsigned int src_height; 99 unsigned int crtc_x; 100 unsigned int crtc_y; 101 unsigned int crtc_width; 102 unsigned int crtc_height; 103 unsigned int mode_width; 104 unsigned int mode_height; 105 unsigned int refresh; 106 unsigned int scan_flag; 107 unsigned int bpp; 108 unsigned int pitch; 109 uint32_t pixel_format; 110 dma_addr_t dma_addr[MAX_FB_BUFFER]; 111 int zpos; 112 113 bool default_win; 114 bool color_key; 115 unsigned int index_color; 116 bool local_path; 117 bool transparency; 118 bool activated; 119 }; 120 121 /* 122 * Exynos DRM Display Structure. 123 * - this structure is common to analog tv, digital tv and lcd panel. 124 * 125 * @initialize: initializes the display with drm_dev 126 * @remove: cleans up the display for removal 127 * @mode_fixup: fix mode data comparing to hw specific display mode. 128 * @mode_set: convert drm_display_mode to hw specific display mode and 129 * would be called by encoder->mode_set(). 130 * @check_mode: check if mode is valid or not. 131 * @dpms: display device on or off. 132 * @commit: apply changes to hw 133 */ 134 struct exynos_drm_display; 135 struct exynos_drm_display_ops { 136 int (*initialize)(struct exynos_drm_display *display, 137 struct drm_device *drm_dev); 138 int (*create_connector)(struct exynos_drm_display *display, 139 struct drm_encoder *encoder); 140 void (*remove)(struct exynos_drm_display *display); 141 void (*mode_fixup)(struct exynos_drm_display *display, 142 struct drm_connector *connector, 143 const struct drm_display_mode *mode, 144 struct drm_display_mode *adjusted_mode); 145 void (*mode_set)(struct exynos_drm_display *display, 146 struct drm_display_mode *mode); 147 int (*check_mode)(struct exynos_drm_display *display, 148 struct drm_display_mode *mode); 149 void (*dpms)(struct exynos_drm_display *display, int mode); 150 void (*commit)(struct exynos_drm_display *display); 151 }; 152 153 /* 154 * Exynos drm display structure, maps 1:1 with an encoder/connector 155 * 156 * @list: the list entry for this manager 157 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 158 * @encoder: encoder object this display maps to 159 * @connector: connector object this display maps to 160 * @ops: pointer to callbacks for exynos drm specific functionality 161 * @ctx: A pointer to the display's implementation specific context 162 */ 163 struct exynos_drm_display { 164 struct list_head list; 165 enum exynos_drm_output_type type; 166 struct drm_encoder *encoder; 167 struct drm_connector *connector; 168 struct exynos_drm_display_ops *ops; 169 void *ctx; 170 }; 171 172 /* 173 * Exynos drm manager ops 174 * 175 * @initialize: initializes the manager with drm_dev 176 * @remove: cleans up the manager for removal 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 */ 190 struct exynos_drm_manager; 191 struct exynos_drm_manager_ops { 192 int (*initialize)(struct exynos_drm_manager *mgr, 193 struct drm_device *drm_dev, int pipe); 194 void (*remove)(struct exynos_drm_manager *mgr); 195 void (*dpms)(struct exynos_drm_manager *mgr, int mode); 196 bool (*mode_fixup)(struct exynos_drm_manager *mgr, 197 const struct drm_display_mode *mode, 198 struct drm_display_mode *adjusted_mode); 199 void (*mode_set)(struct exynos_drm_manager *mgr, 200 const struct drm_display_mode *mode); 201 void (*commit)(struct exynos_drm_manager *mgr); 202 int (*enable_vblank)(struct exynos_drm_manager *mgr); 203 void (*disable_vblank)(struct exynos_drm_manager *mgr); 204 void (*wait_for_vblank)(struct exynos_drm_manager *mgr); 205 void (*win_mode_set)(struct exynos_drm_manager *mgr, 206 struct exynos_drm_overlay *overlay); 207 void (*win_commit)(struct exynos_drm_manager *mgr, int zpos); 208 void (*win_enable)(struct exynos_drm_manager *mgr, int zpos); 209 void (*win_disable)(struct exynos_drm_manager *mgr, int zpos); 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 * @pipe: the pipe number for this crtc/manager 219 * @ops: pointer to callbacks for exynos drm specific functionality 220 * @ctx: A pointer to the manager's implementation specific context 221 */ 222 struct exynos_drm_manager { 223 struct list_head list; 224 enum exynos_drm_output_type type; 225 struct drm_device *drm_dev; 226 int pipe; 227 struct exynos_drm_manager_ops *ops; 228 void *ctx; 229 }; 230 231 struct exynos_drm_g2d_private { 232 struct device *dev; 233 struct list_head inuse_cmdlist; 234 struct list_head event_list; 235 struct list_head userptr_list; 236 }; 237 238 struct exynos_drm_ipp_private { 239 struct device *dev; 240 struct list_head event_list; 241 }; 242 243 struct drm_exynos_file_private { 244 struct exynos_drm_g2d_private *g2d_priv; 245 struct exynos_drm_ipp_private *ipp_priv; 246 struct file *anon_filp; 247 }; 248 249 /* 250 * Exynos drm private structure. 251 * 252 * @da_start: start address to device address space. 253 * with iommu, device address space starts from this address 254 * otherwise default one. 255 * @da_space_size: size of device address space. 256 * if 0 then default value is used for it. 257 */ 258 struct exynos_drm_private { 259 struct drm_fb_helper *fb_helper; 260 261 /* list head for new event to be added. */ 262 struct list_head pageflip_event_list; 263 264 /* 265 * created crtc object would be contained at this array and 266 * this array is used to be aware of which crtc did it request vblank. 267 */ 268 struct drm_crtc *crtc[MAX_CRTC]; 269 struct drm_property *plane_zpos_property; 270 struct drm_property *crtc_mode_property; 271 272 unsigned long da_start; 273 unsigned long da_space_size; 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 */ 292 struct 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 /* 306 * this function calls a probe callback registered to sub driver list and 307 * create its own encoder and connector and then set drm_device object 308 * to global one. 309 */ 310 int exynos_drm_device_register(struct drm_device *dev); 311 /* 312 * this function calls a remove callback registered to sub driver list and 313 * destroy its own encoder and connetor. 314 */ 315 int exynos_drm_device_unregister(struct drm_device *dev); 316 317 int exynos_drm_initialize_managers(struct drm_device *dev); 318 void exynos_drm_remove_managers(struct drm_device *dev); 319 int exynos_drm_initialize_displays(struct drm_device *dev); 320 void exynos_drm_remove_displays(struct drm_device *dev); 321 322 int exynos_drm_manager_register(struct exynos_drm_manager *manager); 323 int exynos_drm_manager_unregister(struct exynos_drm_manager *manager); 324 int exynos_drm_display_register(struct exynos_drm_display *display); 325 int exynos_drm_display_unregister(struct exynos_drm_display *display); 326 327 /* 328 * this function would be called by sub drivers such as display controller 329 * or hdmi driver to register this sub driver object to exynos drm driver 330 * and when a sub driver is registered to exynos drm driver a probe callback 331 * of the sub driver is called and creates its own encoder and connector. 332 */ 333 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 334 335 /* this function removes subdrv list from exynos drm driver */ 336 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 337 338 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 339 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 340 341 /* 342 * this function registers exynos drm hdmi platform device. It ensures only one 343 * instance of the device is created. 344 */ 345 int exynos_platform_device_hdmi_register(void); 346 347 /* 348 * this function unregisters exynos drm hdmi platform device if it exists. 349 */ 350 void exynos_platform_device_hdmi_unregister(void); 351 352 /* 353 * this function registers exynos drm ipp platform device. 354 */ 355 int exynos_platform_device_ipp_register(void); 356 357 /* 358 * this function unregisters exynos drm ipp platform device if it exists. 359 */ 360 void exynos_platform_device_ipp_unregister(void); 361 362 #ifdef CONFIG_DRM_EXYNOS_DPI 363 int exynos_dpi_probe(struct device *dev); 364 int exynos_dpi_remove(struct device *dev); 365 #else 366 static inline int exynos_dpi_probe(struct device *dev) { return 0; } 367 static inline int exynos_dpi_remove(struct device *dev) { return 0; } 368 #endif 369 370 extern struct platform_driver dp_driver; 371 extern struct platform_driver dsi_driver; 372 extern struct platform_driver fimd_driver; 373 extern struct platform_driver hdmi_driver; 374 extern struct platform_driver mixer_driver; 375 extern struct platform_driver exynos_drm_common_hdmi_driver; 376 extern struct platform_driver vidi_driver; 377 extern struct platform_driver g2d_driver; 378 extern struct platform_driver fimc_driver; 379 extern struct platform_driver rotator_driver; 380 extern struct platform_driver gsc_driver; 381 extern struct platform_driver ipp_driver; 382 #endif 383