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 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 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 */ 64 struct 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 * @vaddr: array of virtual memory addresss to this overlay. 97 * @zpos: order of overlay layer(z position). 98 * @default_win: a window to be enabled. 99 * @color_key: color key on or off. 100 * @index_color: if using color key feature then this value would be used 101 * as index color. 102 * @local_path: in case of lcd type, local path mode on or off. 103 * @transparency: transparency on or off. 104 * @activated: activated or not. 105 * 106 * this structure is common to exynos SoC and its contents would be copied 107 * to hardware specific overlay info. 108 */ 109 struct exynos_drm_overlay { 110 unsigned int fb_x; 111 unsigned int fb_y; 112 unsigned int fb_width; 113 unsigned int fb_height; 114 unsigned int src_width; 115 unsigned int src_height; 116 unsigned int crtc_x; 117 unsigned int crtc_y; 118 unsigned int crtc_width; 119 unsigned int crtc_height; 120 unsigned int mode_width; 121 unsigned int mode_height; 122 unsigned int refresh; 123 unsigned int scan_flag; 124 unsigned int bpp; 125 unsigned int pitch; 126 uint32_t pixel_format; 127 dma_addr_t dma_addr[MAX_FB_BUFFER]; 128 void __iomem *vaddr[MAX_FB_BUFFER]; 129 int zpos; 130 131 bool default_win; 132 bool color_key; 133 unsigned int index_color; 134 bool local_path; 135 bool transparency; 136 bool activated; 137 }; 138 139 /* 140 * Exynos DRM Display Structure. 141 * - this structure is common to analog tv, digital tv and lcd panel. 142 * 143 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 144 * @is_connected: check for that display is connected or not. 145 * @get_edid: get edid modes from display driver. 146 * @get_panel: get panel object from display driver. 147 * @check_timing: check if timing is valid or not. 148 * @power_on: display device on or off. 149 */ 150 struct exynos_drm_display_ops { 151 enum exynos_drm_output_type type; 152 bool (*is_connected)(struct device *dev); 153 int (*get_edid)(struct device *dev, struct drm_connector *connector, 154 u8 *edid, int len); 155 void *(*get_panel)(struct device *dev); 156 int (*check_timing)(struct device *dev, void *timing); 157 int (*power_on)(struct device *dev, int mode); 158 }; 159 160 /* 161 * Exynos drm manager ops 162 * 163 * @dpms: control device power. 164 * @apply: set timing, vblank and overlay data to registers. 165 * @mode_fixup: fix mode data comparing to hw specific display mode. 166 * @mode_set: convert drm_display_mode to hw specific display mode and 167 * would be called by encoder->mode_set(). 168 * @get_max_resol: get maximum resolution to specific hardware. 169 * @commit: set current hw specific display mode to hw. 170 * @enable_vblank: specific driver callback for enabling vblank interrupt. 171 * @disable_vblank: specific driver callback for disabling vblank interrupt. 172 */ 173 struct 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 }; 187 188 /* 189 * Exynos drm common manager structure. 190 * 191 * @dev: pointer to device object for subdrv device driver. 192 * sub drivers such as display controller or hdmi driver, 193 * have their own device object. 194 * @ops: pointer to callbacks for exynos drm specific framebuffer. 195 * these callbacks should be set by specific drivers such fimd 196 * or hdmi driver and are used to control hardware global registers. 197 * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer. 198 * these callbacks should be set by specific drivers such fimd 199 * or hdmi driver and are used to control hardware overlay reigsters. 200 * @display: pointer to callbacks for exynos drm specific framebuffer. 201 * these callbacks should be set by specific drivers such fimd 202 * or hdmi driver and are used to control display devices such as 203 * analog tv, digital tv and lcd panel and also get timing data for them. 204 */ 205 struct exynos_drm_manager { 206 struct device *dev; 207 int pipe; 208 struct exynos_drm_manager_ops *ops; 209 struct exynos_drm_overlay_ops *overlay_ops; 210 struct exynos_drm_display_ops *display_ops; 211 }; 212 213 struct exynos_drm_g2d_private { 214 struct device *dev; 215 struct list_head inuse_cmdlist; 216 struct list_head event_list; 217 struct list_head gem_list; 218 unsigned int gem_nr; 219 }; 220 221 struct drm_exynos_file_private { 222 struct exynos_drm_g2d_private *g2d_priv; 223 }; 224 225 /* 226 * Exynos drm private structure. 227 */ 228 struct exynos_drm_private { 229 struct drm_fb_helper *fb_helper; 230 231 /* list head for new event to be added. */ 232 struct list_head pageflip_event_list; 233 234 /* 235 * created crtc object would be contained at this array and 236 * this array is used to be aware of which crtc did it request vblank. 237 */ 238 struct drm_crtc *crtc[MAX_CRTC]; 239 struct drm_property *plane_zpos_property; 240 struct drm_property *crtc_mode_property; 241 }; 242 243 /* 244 * Exynos drm sub driver structure. 245 * 246 * @list: sub driver has its own list object to register to exynos drm driver. 247 * @dev: pointer to device object for subdrv device driver. 248 * @drm_dev: pointer to drm_device and this pointer would be set 249 * when sub driver calls exynos_drm_subdrv_register(). 250 * @manager: subdrv has its own manager to control a hardware appropriately 251 * and we can access a hardware drawing on this manager. 252 * @probe: this callback would be called by exynos drm driver after 253 * subdrv is registered to it. 254 * @remove: this callback is used to release resources created 255 * by probe callback. 256 * @open: this would be called with drm device file open. 257 * @close: this would be called with drm device file close. 258 * @encoder: encoder object owned by this sub driver. 259 * @connector: connector object owned by this sub driver. 260 */ 261 struct exynos_drm_subdrv { 262 struct list_head list; 263 struct device *dev; 264 struct drm_device *drm_dev; 265 struct exynos_drm_manager *manager; 266 267 int (*probe)(struct drm_device *drm_dev, struct device *dev); 268 void (*remove)(struct drm_device *dev); 269 int (*open)(struct drm_device *drm_dev, struct device *dev, 270 struct drm_file *file); 271 void (*close)(struct drm_device *drm_dev, struct device *dev, 272 struct drm_file *file); 273 274 struct drm_encoder *encoder; 275 struct drm_connector *connector; 276 }; 277 278 /* 279 * this function calls a probe callback registered to sub driver list and 280 * create its own encoder and connector and then set drm_device object 281 * to global one. 282 */ 283 int exynos_drm_device_register(struct drm_device *dev); 284 /* 285 * this function calls a remove callback registered to sub driver list and 286 * destroy its own encoder and connetor. 287 */ 288 int exynos_drm_device_unregister(struct drm_device *dev); 289 290 /* 291 * this function would be called by sub drivers such as display controller 292 * or hdmi driver to register this sub driver object to exynos drm driver 293 * and when a sub driver is registered to exynos drm driver a probe callback 294 * of the sub driver is called and creates its own encoder and connector. 295 */ 296 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 297 298 /* this function removes subdrv list from exynos drm driver */ 299 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 300 301 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file); 302 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file); 303 304 extern struct platform_driver fimd_driver; 305 extern struct platform_driver hdmi_driver; 306 extern struct platform_driver mixer_driver; 307 extern struct platform_driver exynos_drm_common_hdmi_driver; 308 extern struct platform_driver vidi_driver; 309 extern struct platform_driver g2d_driver; 310 #endif 311