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 * Permission is hereby granted, free of charge, to any person obtaining a 10 * copy of this software and associated documentation files (the "Software"), 11 * to deal in the Software without restriction, including without limitation 12 * the rights to use, copy, modify, merge, publish, distribute, sublicense, 13 * and/or sell copies of the Software, and to permit persons to whom the 14 * Software is furnished to do so, subject to the following conditions: 15 * 16 * The above copyright notice and this permission notice (including the next 17 * paragraph) shall be included in all copies or substantial portions of the 18 * Software. 19 * 20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL 23 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR 24 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, 25 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR 26 * OTHER DEALINGS IN THE SOFTWARE. 27 */ 28 29 #ifndef _EXYNOS_DRM_DRV_H_ 30 #define _EXYNOS_DRM_DRV_H_ 31 32 #include <linux/module.h> 33 34 #define MAX_CRTC 3 35 #define MAX_PLANE 5 36 #define MAX_FB_BUFFER 4 37 #define DEFAULT_ZPOS -1 38 39 #define _wait_for(COND, MS) ({ \ 40 unsigned long timeout__ = jiffies + msecs_to_jiffies(MS); \ 41 int ret__ = 0; \ 42 while (!(COND)) { \ 43 if (time_after(jiffies, timeout__)) { \ 44 ret__ = -ETIMEDOUT; \ 45 break; \ 46 } \ 47 } \ 48 ret__; \ 49 }) 50 51 #define wait_for(COND, MS) _wait_for(COND, MS) 52 53 struct drm_device; 54 struct exynos_drm_overlay; 55 struct drm_connector; 56 57 extern unsigned int drm_vblank_offdelay; 58 59 /* this enumerates display type. */ 60 enum exynos_drm_output_type { 61 EXYNOS_DISPLAY_TYPE_NONE, 62 /* RGB or CPU Interface. */ 63 EXYNOS_DISPLAY_TYPE_LCD, 64 /* HDMI Interface. */ 65 EXYNOS_DISPLAY_TYPE_HDMI, 66 /* Virtual Display Interface. */ 67 EXYNOS_DISPLAY_TYPE_VIDI, 68 }; 69 70 /* 71 * Exynos drm overlay ops structure. 72 * 73 * @mode_set: copy drm overlay info to hw specific overlay info. 74 * @commit: apply hardware specific overlay data to registers. 75 * @enable: enable hardware specific overlay. 76 * @disable: disable hardware specific overlay. 77 * @wait_for_vblank: wait for vblank interrupt to make sure that 78 * hardware overlay is disabled. 79 */ 80 struct exynos_drm_overlay_ops { 81 void (*mode_set)(struct device *subdrv_dev, 82 struct exynos_drm_overlay *overlay); 83 void (*commit)(struct device *subdrv_dev, int zpos); 84 void (*enable)(struct device *subdrv_dev, int zpos); 85 void (*disable)(struct device *subdrv_dev, int zpos); 86 void (*wait_for_vblank)(struct device *subdrv_dev); 87 }; 88 89 /* 90 * Exynos drm common overlay structure. 91 * 92 * @fb_x: offset x on a framebuffer to be displayed. 93 * - the unit is screen coordinates. 94 * @fb_y: offset y on a framebuffer to be displayed. 95 * - the unit is screen coordinates. 96 * @fb_width: width of a framebuffer. 97 * @fb_height: height of a framebuffer. 98 * @src_width: width of a partial image to be displayed from framebuffer. 99 * @src_height: height of a partial image to be displayed from framebuffer. 100 * @crtc_x: offset x on hardware screen. 101 * @crtc_y: offset y on hardware screen. 102 * @crtc_width: window width to be displayed (hardware screen). 103 * @crtc_height: window height to be displayed (hardware screen). 104 * @mode_width: width of screen mode. 105 * @mode_height: height of screen mode. 106 * @refresh: refresh rate. 107 * @scan_flag: interlace or progressive way. 108 * (it could be DRM_MODE_FLAG_*) 109 * @bpp: pixel size.(in bit) 110 * @pixel_format: fourcc pixel format of this overlay 111 * @dma_addr: array of bus(accessed by dma) address to the memory region 112 * allocated for a overlay. 113 * @vaddr: array of virtual memory addresss to this overlay. 114 * @zpos: order of overlay layer(z position). 115 * @default_win: a window to be enabled. 116 * @color_key: color key on or off. 117 * @index_color: if using color key feature then this value would be used 118 * as index color. 119 * @local_path: in case of lcd type, local path mode on or off. 120 * @transparency: transparency on or off. 121 * @activated: activated or not. 122 * 123 * this structure is common to exynos SoC and its contents would be copied 124 * to hardware specific overlay info. 125 */ 126 struct exynos_drm_overlay { 127 unsigned int fb_x; 128 unsigned int fb_y; 129 unsigned int fb_width; 130 unsigned int fb_height; 131 unsigned int src_width; 132 unsigned int src_height; 133 unsigned int crtc_x; 134 unsigned int crtc_y; 135 unsigned int crtc_width; 136 unsigned int crtc_height; 137 unsigned int mode_width; 138 unsigned int mode_height; 139 unsigned int refresh; 140 unsigned int scan_flag; 141 unsigned int bpp; 142 unsigned int pitch; 143 uint32_t pixel_format; 144 dma_addr_t dma_addr[MAX_FB_BUFFER]; 145 void __iomem *vaddr[MAX_FB_BUFFER]; 146 int zpos; 147 148 bool default_win; 149 bool color_key; 150 unsigned int index_color; 151 bool local_path; 152 bool transparency; 153 bool activated; 154 }; 155 156 /* 157 * Exynos DRM Display Structure. 158 * - this structure is common to analog tv, digital tv and lcd panel. 159 * 160 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 161 * @is_connected: check for that display is connected or not. 162 * @get_edid: get edid modes from display driver. 163 * @get_panel: get panel object from display driver. 164 * @check_timing: check if timing is valid or not. 165 * @power_on: display device on or off. 166 */ 167 struct exynos_drm_display_ops { 168 enum exynos_drm_output_type type; 169 bool (*is_connected)(struct device *dev); 170 int (*get_edid)(struct device *dev, struct drm_connector *connector, 171 u8 *edid, int len); 172 void *(*get_panel)(struct device *dev); 173 int (*check_timing)(struct device *dev, void *timing); 174 int (*power_on)(struct device *dev, int mode); 175 }; 176 177 /* 178 * Exynos drm manager ops 179 * 180 * @dpms: control device power. 181 * @apply: set timing, vblank and overlay data to registers. 182 * @mode_fixup: fix mode data comparing to hw specific display mode. 183 * @mode_set: convert drm_display_mode to hw specific display mode and 184 * would be called by encoder->mode_set(). 185 * @get_max_resol: get maximum resolution to specific hardware. 186 * @commit: set current hw specific display mode to hw. 187 * @enable_vblank: specific driver callback for enabling vblank interrupt. 188 * @disable_vblank: specific driver callback for disabling vblank interrupt. 189 */ 190 struct exynos_drm_manager_ops { 191 void (*dpms)(struct device *subdrv_dev, int mode); 192 void (*apply)(struct device *subdrv_dev); 193 void (*mode_fixup)(struct device *subdrv_dev, 194 struct drm_connector *connector, 195 const struct drm_display_mode *mode, 196 struct drm_display_mode *adjusted_mode); 197 void (*mode_set)(struct device *subdrv_dev, void *mode); 198 void (*get_max_resol)(struct device *subdrv_dev, unsigned int *width, 199 unsigned int *height); 200 void (*commit)(struct device *subdrv_dev); 201 int (*enable_vblank)(struct device *subdrv_dev); 202 void (*disable_vblank)(struct device *subdrv_dev); 203 }; 204 205 /* 206 * Exynos drm common manager structure. 207 * 208 * @dev: pointer to device object for subdrv device driver. 209 * sub drivers such as display controller or hdmi driver, 210 * have their own device object. 211 * @ops: pointer to callbacks for exynos drm specific framebuffer. 212 * these callbacks should be set by specific drivers such fimd 213 * or hdmi driver and are used to control hardware global registers. 214 * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer. 215 * these callbacks should be set by specific drivers such fimd 216 * or hdmi driver and are used to control hardware overlay reigsters. 217 * @display: pointer to callbacks for exynos drm specific framebuffer. 218 * these callbacks should be set by specific drivers such fimd 219 * or hdmi driver and are used to control display devices such as 220 * analog tv, digital tv and lcd panel and also get timing data for them. 221 */ 222 struct exynos_drm_manager { 223 struct device *dev; 224 int pipe; 225 struct exynos_drm_manager_ops *ops; 226 struct exynos_drm_overlay_ops *overlay_ops; 227 struct exynos_drm_display_ops *display_ops; 228 }; 229 230 struct exynos_drm_g2d_private { 231 struct device *dev; 232 struct list_head inuse_cmdlist; 233 struct list_head event_list; 234 struct list_head gem_list; 235 unsigned int gem_nr; 236 }; 237 238 struct drm_exynos_file_private { 239 struct exynos_drm_g2d_private *g2d_priv; 240 }; 241 242 /* 243 * Exynos drm private structure. 244 */ 245 struct exynos_drm_private { 246 struct drm_fb_helper *fb_helper; 247 248 /* list head for new event to be added. */ 249 struct list_head pageflip_event_list; 250 251 /* 252 * created crtc object would be contained at this array and 253 * this array is used to be aware of which crtc did it request vblank. 254 */ 255 struct drm_crtc *crtc[MAX_CRTC]; 256 struct drm_property *plane_zpos_property; 257 struct drm_property *crtc_mode_property; 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 */ 278 struct 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 */ 300 int 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 */ 305 int 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 */ 313 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 314 315 /* this function removes subdrv list from exynos drm driver */ 316 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 317 318 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 319 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 320 321 extern struct platform_driver fimd_driver; 322 extern struct platform_driver hdmi_driver; 323 extern struct platform_driver mixer_driver; 324 extern struct platform_driver exynos_drm_common_hdmi_driver; 325 extern struct platform_driver vidi_driver; 326 extern struct platform_driver g2d_driver; 327 #endif 328