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 #include "drm.h" 34 35 #define MAX_CRTC 2 36 #define MAX_PLANE 5 37 #define MAX_FB_BUFFER 3 38 #define DEFAULT_ZPOS -1 39 40 struct drm_device; 41 struct exynos_drm_overlay; 42 struct drm_connector; 43 44 extern unsigned int drm_vblank_offdelay; 45 46 /* this enumerates display type. */ 47 enum exynos_drm_output_type { 48 EXYNOS_DISPLAY_TYPE_NONE, 49 /* RGB or CPU Interface. */ 50 EXYNOS_DISPLAY_TYPE_LCD, 51 /* HDMI Interface. */ 52 EXYNOS_DISPLAY_TYPE_HDMI, 53 }; 54 55 /* 56 * Exynos drm overlay ops structure. 57 * 58 * @mode_set: copy drm overlay info to hw specific overlay info. 59 * @commit: apply hardware specific overlay data to registers. 60 * @disable: disable hardware specific overlay. 61 */ 62 struct exynos_drm_overlay_ops { 63 void (*mode_set)(struct device *subdrv_dev, 64 struct exynos_drm_overlay *overlay); 65 void (*commit)(struct device *subdrv_dev, int zpos); 66 void (*disable)(struct device *subdrv_dev, int zpos); 67 }; 68 69 /* 70 * Exynos drm common overlay structure. 71 * 72 * @fb_x: offset x on a framebuffer to be displayed. 73 * - the unit is screen coordinates. 74 * @fb_y: offset y on a framebuffer to be displayed. 75 * - the unit is screen coordinates. 76 * @fb_width: width of a framebuffer. 77 * @fb_height: height of a framebuffer. 78 * @crtc_x: offset x on hardware screen. 79 * @crtc_y: offset y on hardware screen. 80 * @crtc_width: window width to be displayed (hardware screen). 81 * @crtc_height: window height to be displayed (hardware screen). 82 * @mode_width: width of screen mode. 83 * @mode_height: height of screen mode. 84 * @refresh: refresh rate. 85 * @scan_flag: interlace or progressive way. 86 * (it could be DRM_MODE_FLAG_*) 87 * @bpp: pixel size.(in bit) 88 * @pixel_format: fourcc pixel format of this overlay 89 * @dma_addr: array of bus(accessed by dma) address to the memory region 90 * allocated for a overlay. 91 * @vaddr: array of virtual memory addresss to this overlay. 92 * @zpos: order of overlay layer(z position). 93 * @default_win: a window to be enabled. 94 * @color_key: color key on or off. 95 * @index_color: if using color key feature then this value would be used 96 * as index color. 97 * @local_path: in case of lcd type, local path mode on or off. 98 * @transparency: transparency on or off. 99 * @activated: activated or not. 100 * 101 * this structure is common to exynos SoC and its contents would be copied 102 * to hardware specific overlay info. 103 */ 104 struct exynos_drm_overlay { 105 unsigned int fb_x; 106 unsigned int fb_y; 107 unsigned int fb_width; 108 unsigned int fb_height; 109 unsigned int crtc_x; 110 unsigned int crtc_y; 111 unsigned int crtc_width; 112 unsigned int crtc_height; 113 unsigned int mode_width; 114 unsigned int mode_height; 115 unsigned int refresh; 116 unsigned int scan_flag; 117 unsigned int bpp; 118 unsigned int pitch; 119 uint32_t pixel_format; 120 dma_addr_t dma_addr[MAX_FB_BUFFER]; 121 void __iomem *vaddr[MAX_FB_BUFFER]; 122 int zpos; 123 124 bool default_win; 125 bool color_key; 126 unsigned int index_color; 127 bool local_path; 128 bool transparency; 129 bool activated; 130 }; 131 132 /* 133 * Exynos DRM Display Structure. 134 * - this structure is common to analog tv, digital tv and lcd panel. 135 * 136 * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI. 137 * @is_connected: check for that display is connected or not. 138 * @get_edid: get edid modes from display driver. 139 * @get_timing: get timing object from display driver. 140 * @check_timing: check if timing is valid or not. 141 * @power_on: display device on or off. 142 */ 143 struct exynos_drm_display_ops { 144 enum exynos_drm_output_type type; 145 bool (*is_connected)(struct device *dev); 146 int (*get_edid)(struct device *dev, struct drm_connector *connector, 147 u8 *edid, int len); 148 void *(*get_timing)(struct device *dev); 149 int (*check_timing)(struct device *dev, void *timing); 150 int (*power_on)(struct device *dev, int mode); 151 }; 152 153 /* 154 * Exynos drm manager ops 155 * 156 * @dpms: control device power. 157 * @apply: set timing, vblank and overlay data to registers. 158 * @mode_set: convert drm_display_mode to hw specific display mode and 159 * would be called by encoder->mode_set(). 160 * @commit: set current hw specific display mode to hw. 161 * @enable_vblank: specific driver callback for enabling vblank interrupt. 162 * @disable_vblank: specific driver callback for disabling vblank interrupt. 163 */ 164 struct exynos_drm_manager_ops { 165 void (*dpms)(struct device *subdrv_dev, int mode); 166 void (*apply)(struct device *subdrv_dev); 167 void (*mode_set)(struct device *subdrv_dev, void *mode); 168 void (*commit)(struct device *subdrv_dev); 169 int (*enable_vblank)(struct device *subdrv_dev); 170 void (*disable_vblank)(struct device *subdrv_dev); 171 }; 172 173 /* 174 * Exynos drm common manager structure. 175 * 176 * @dev: pointer to device object for subdrv device driver. 177 * sub drivers such as display controller or hdmi driver, 178 * have their own device object. 179 * @ops: pointer to callbacks for exynos drm specific framebuffer. 180 * these callbacks should be set by specific drivers such fimd 181 * or hdmi driver and are used to control hardware global registers. 182 * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer. 183 * these callbacks should be set by specific drivers such fimd 184 * or hdmi driver and are used to control hardware overlay reigsters. 185 * @display: pointer to callbacks for exynos drm specific framebuffer. 186 * these callbacks should be set by specific drivers such fimd 187 * or hdmi driver and are used to control display devices such as 188 * analog tv, digital tv and lcd panel and also get timing data for them. 189 */ 190 struct exynos_drm_manager { 191 struct device *dev; 192 int pipe; 193 struct exynos_drm_manager_ops *ops; 194 struct exynos_drm_overlay_ops *overlay_ops; 195 struct exynos_drm_display_ops *display_ops; 196 }; 197 198 /* 199 * Exynos drm private structure. 200 */ 201 struct exynos_drm_private { 202 struct drm_fb_helper *fb_helper; 203 204 /* list head for new event to be added. */ 205 struct list_head pageflip_event_list; 206 207 /* 208 * created crtc object would be contained at this array and 209 * this array is used to be aware of which crtc did it request vblank. 210 */ 211 struct drm_crtc *crtc[MAX_CRTC]; 212 }; 213 214 /* 215 * Exynos drm sub driver structure. 216 * 217 * @list: sub driver has its own list object to register to exynos drm driver. 218 * @drm_dev: pointer to drm_device and this pointer would be set 219 * when sub driver calls exynos_drm_subdrv_register(). 220 * @probe: this callback would be called by exynos drm driver after 221 * subdrv is registered to it. 222 * @remove: this callback is used to release resources created 223 * by probe callback. 224 * @manager: subdrv has its own manager to control a hardware appropriately 225 * and we can access a hardware drawing on this manager. 226 * @encoder: encoder object owned by this sub driver. 227 * @connector: connector object owned by this sub driver. 228 */ 229 struct exynos_drm_subdrv { 230 struct list_head list; 231 struct drm_device *drm_dev; 232 233 int (*probe)(struct drm_device *drm_dev, struct device *dev); 234 void (*remove)(struct drm_device *dev); 235 236 struct exynos_drm_manager manager; 237 struct drm_encoder *encoder; 238 struct drm_connector *connector; 239 }; 240 241 /* 242 * this function calls a probe callback registered to sub driver list and 243 * create its own encoder and connector and then set drm_device object 244 * to global one. 245 */ 246 int exynos_drm_device_register(struct drm_device *dev); 247 /* 248 * this function calls a remove callback registered to sub driver list and 249 * destroy its own encoder and connetor. 250 */ 251 int exynos_drm_device_unregister(struct drm_device *dev); 252 253 /* 254 * this function would be called by sub drivers such as display controller 255 * or hdmi driver to register this sub driver object to exynos drm driver 256 * and when a sub driver is registered to exynos drm driver a probe callback 257 * of the sub driver is called and creates its own encoder and connector 258 * and then fb helper and drm mode group would be re-initialized. 259 */ 260 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv); 261 262 /* 263 * this function removes subdrv list from exynos drm driver and fb helper 264 * and drm mode group would be re-initialized. 265 */ 266 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv); 267 268 #endif 269