drivers/gpu/drm/exynos/exynos_drm_drv.h

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