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 43extern unsigned int drm_vblank_offdelay; 44 45/* this enumerates display type. */ 46enum 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 overlay ops structure. 58 * 59 * @mode_set: copy drm overlay info to hw specific overlay info. 60 * @commit: apply hardware specific overlay data to registers. 61 * @enable: enable hardware specific overlay. 62 * @disable: disable hardware specific overlay. 63 */ 64struct exynos_drm_overlay_ops { 65 void (*mode_set)(struct device *subdrv_dev, 66 struct exynos_drm_overlay *overlay); 67 void (*commit)(struct device *subdrv_dev, int zpos); 68 void (*enable)(struct device *subdrv_dev, int zpos); 69 void (*disable)(struct device *subdrv_dev, int zpos); 70}; 71 72/* 73 * Exynos drm common overlay structure. 74 * 75 * @fb_x: offset x on a framebuffer to be displayed. 76 * - the unit is screen coordinates. 77 * @fb_y: offset y on a framebuffer to be displayed. 78 * - the unit is screen coordinates. 79 * @fb_width: width of a framebuffer. 80 * @fb_height: height of a framebuffer. 81 * @src_width: width of a partial image to be displayed from framebuffer. 82 * @src_height: height of a partial image to be displayed from framebuffer. 83 * @crtc_x: offset x on hardware screen. 84 * @crtc_y: offset y on hardware screen. 85 * @crtc_width: window width to be displayed (hardware screen). 86 * @crtc_height: window height to be displayed (hardware screen). 87 * @mode_width: width of screen mode. 88 * @mode_height: height of screen mode. 89 * @refresh: refresh rate. 90 * @scan_flag: interlace or progressive way. 91 * (it could be DRM_MODE_FLAG_*) 92 * @bpp: pixel size.(in bit) 93 * @pixel_format: fourcc pixel format of this overlay 94 * @dma_addr: array of bus(accessed by dma) address to the memory region 95 * allocated for a overlay. 96 * @zpos: order of overlay layer(z position). 97 * @default_win: a window to be enabled. 98 * @color_key: color key on or off. 99 * @index_color: if using color key feature then this value would be used 100 * as index color. 101 * @local_path: in case of lcd type, local path mode on or off. 102 * @transparency: transparency on or off. 103 * @activated: activated or not. 104 * 105 * this structure is common to exynos SoC and its contents would be copied 106 * to hardware specific overlay info. 107 */ 108struct exynos_drm_overlay { 109 unsigned int fb_x; 110 unsigned int fb_y; 111 unsigned int fb_width; 112 unsigned int fb_height; 113 unsigned int src_width; 114 unsigned int src_height; 115 unsigned int crtc_x; 116 unsigned int crtc_y; 117 unsigned int crtc_width; 118 unsigned int crtc_height; 119 unsigned int mode_width; 120 unsigned int mode_height; 121 unsigned int refresh; 122 unsigned int scan_flag; 123 unsigned int bpp; 124 unsigned int pitch; 125 uint32_t pixel_format; 126 dma_addr_t dma_addr[MAX_FB_BUFFER]; 127 int zpos; 128 129 bool default_win; 130 bool color_key; 131 unsigned int index_color; 132 bool local_path; 133 bool transparency; 134 bool activated; 135}; 136 137/* 138 * Exynos DRM Display Structure. 139 * - this structure is common to analog tv, digital tv and lcd panel. 140 * 141 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 142 * @is_connected: check for that display is connected or not. 143 * @get_edid: get edid modes from display driver. 144 * @get_panel: get panel object from display driver. 145 * @check_timing: check if timing is valid or not. 146 * @power_on: display device on or off. 147 */ 148struct exynos_drm_display_ops { 149 enum exynos_drm_output_type type; 150 bool (*is_connected)(struct device *dev); 151 struct edid *(*get_edid)(struct device *dev, 152 struct drm_connector *connector); 153 void *(*get_panel)(struct device *dev); 154 int (*check_timing)(struct device *dev, void *timing); 155 int (*power_on)(struct device *dev, int mode); 156}; 157 158/* 159 * Exynos drm manager ops 160 * 161 * @dpms: control device power. 162 * @apply: set timing, vblank and overlay data to registers. 163 * @mode_fixup: fix mode data comparing to hw specific display mode. 164 * @mode_set: convert drm_display_mode to hw specific display mode and 165 * would be called by encoder->mode_set(). 166 * @get_max_resol: get maximum resolution to specific hardware. 167 * @commit: set current hw specific display mode to hw. 168 * @enable_vblank: specific driver callback for enabling vblank interrupt. 169 * @disable_vblank: specific driver callback for disabling vblank interrupt. 170 * @wait_for_vblank: wait for vblank interrupt to make sure that 171 * hardware overlay is updated. 172 */ 173struct exynos_drm_manager_ops { 174 void (*dpms)(struct device *subdrv_dev, int mode); 175 void (*apply)(struct device *subdrv_dev); 176 void (*mode_fixup)(struct device *subdrv_dev, 177 struct drm_connector *connector, 178 const struct drm_display_mode *mode, 179 struct drm_display_mode *adjusted_mode); 180 void (*mode_set)(struct device *subdrv_dev, void *mode); 181 void (*get_max_resol)(struct device *subdrv_dev, unsigned int *width, 182 unsigned int *height); 183 void (*commit)(struct device *subdrv_dev); 184 int (*enable_vblank)(struct device *subdrv_dev); 185 void (*disable_vblank)(struct device *subdrv_dev); 186 void (*wait_for_vblank)(struct device *subdrv_dev); 187}; 188 189/* 190 * Exynos drm common manager structure. 191 * 192 * @dev: pointer to device object for subdrv device driver. 193 * sub drivers such as display controller or hdmi driver, 194 * have their own device object. 195 * @ops: pointer to callbacks for exynos drm specific framebuffer. 196 * these callbacks should be set by specific drivers such fimd 197 * or hdmi driver and are used to control hardware global registers. 198 * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer. 199 * these callbacks should be set by specific drivers such fimd 200 * or hdmi driver and are used to control hardware overlay reigsters. 201 * @display: pointer to callbacks for exynos drm specific framebuffer. 202 * these callbacks should be set by specific drivers such fimd 203 * or hdmi driver and are used to control display devices such as 204 * analog tv, digital tv and lcd panel and also get timing data for them. 205 */ 206struct exynos_drm_manager { 207 struct device *dev; 208 int pipe; 209 struct exynos_drm_manager_ops *ops; 210 struct exynos_drm_overlay_ops *overlay_ops; 211 struct exynos_drm_display_ops *display_ops; 212}; 213 214struct exynos_drm_g2d_private { 215 struct device *dev; 216 struct list_head inuse_cmdlist; 217 struct list_head event_list; 218 struct list_head userptr_list; 219}; 220 221struct exynos_drm_ipp_private { 222 struct device *dev; 223 struct list_head event_list; 224}; 225 226struct drm_exynos_file_private { 227 struct exynos_drm_g2d_private *g2d_priv; 228 struct exynos_drm_ipp_private *ipp_priv; 229}; 230 231/* 232 * Exynos drm private structure. 233 * 234 * @da_start: start address to device address space. 235 * with iommu, device address space starts from this address 236 * otherwise default one. 237 * @da_space_size: size of device address space. 238 * if 0 then default value is used for it. 239 * @da_space_order: order to device address space. 240 */ 241struct exynos_drm_private { 242 struct drm_fb_helper *fb_helper; 243 244 /* list head for new event to be added. */ 245 struct list_head pageflip_event_list; 246 247 /* 248 * created crtc object would be contained at this array and 249 * this array is used to be aware of which crtc did it request vblank. 250 */ 251 struct drm_crtc *crtc[MAX_CRTC]; 252 struct drm_property *plane_zpos_property; 253 struct drm_property *crtc_mode_property; 254 255 unsigned long da_start; 256 unsigned long da_space_size; 257 unsigned long da_space_order; 258}; 259 260/* 261 * Exynos drm sub driver structure. 262 * 263 * @list: sub driver has its own list object to register to exynos drm driver. 264 * @dev: pointer to device object for subdrv device driver. 265 * @drm_dev: pointer to drm_device and this pointer would be set 266 * when sub driver calls exynos_drm_subdrv_register(). 267 * @manager: subdrv has its own manager to control a hardware appropriately 268 * and we can access a hardware drawing on this manager. 269 * @probe: this callback would be called by exynos drm driver after 270 * subdrv is registered to it. 271 * @remove: this callback is used to release resources created 272 * by probe callback. 273 * @open: this would be called with drm device file open. 274 * @close: this would be called with drm device file close. 275 * @encoder: encoder object owned by this sub driver. 276 * @connector: connector object owned by this sub driver. 277 */ 278struct exynos_drm_subdrv { 279 struct list_head list; 280 struct device *dev; 281 struct drm_device *drm_dev; 282 struct exynos_drm_manager *manager; 283 284 int (*probe)(struct drm_device *drm_dev, struct device *dev); 285 void (*remove)(struct drm_device *drm_dev, struct device *dev); 286 int (*open)(struct drm_device *drm_dev, struct device *dev, 287 struct drm_file *file); 288 void (*close)(struct drm_device *drm_dev, struct device *dev, 289 struct drm_file *file); 290 291 struct drm_encoder *encoder; 292 struct drm_connector *connector; 293}; 294 295/* 296 * this function calls a probe callback registered to sub driver list and 297 * create its own encoder and connector and then set drm_device object 298 * to global one. 299 */ 300int exynos_drm_device_register(struct drm_device *dev); 301/* 302 * this function calls a remove callback registered to sub driver list and 303 * destroy its own encoder and connetor. 304 */ 305int exynos_drm_device_unregister(struct drm_device *dev); 306 307/* 308 * this function would be called by sub drivers such as display controller 309 * or hdmi driver to register this sub driver object to exynos drm driver 310 * and when a sub driver is registered to exynos drm driver a probe callback 311 * of the sub driver is called and creates its own encoder and connector. 312 */ 313int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 314 315/* this function removes subdrv list from exynos drm driver */ 316int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 317 318int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 319void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 320 321/* 322 * this function registers exynos drm hdmi platform device. It ensures only one 323 * instance of the device is created. 324 */ 325int exynos_platform_device_hdmi_register(void); 326 327/* 328 * this function unregisters exynos drm hdmi platform device if it exists. 329 */ 330void exynos_platform_device_hdmi_unregister(void); 331 332/* 333 * this function registers exynos drm ipp platform device. 334 */ 335int exynos_platform_device_ipp_register(void); 336 337/* 338 * this function unregisters exynos drm ipp platform device if it exists. 339 */ 340void exynos_platform_device_ipp_unregister(void); 341 342extern struct platform_driver fimd_driver; 343extern struct platform_driver hdmi_driver; 344extern struct platform_driver mixer_driver; 345extern struct platform_driver exynos_drm_common_hdmi_driver; 346extern struct platform_driver vidi_driver; 347extern struct platform_driver g2d_driver; 348extern struct platform_driver fimc_driver; 349extern struct platform_driver rotator_driver; 350extern struct platform_driver gsc_driver; 351extern struct platform_driver ipp_driver; 352#endif 353