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  * 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 <drm/drmP.h>
  19 #include <linux/module.h>
  20
  21 #define MAX_CRTC        3
  22 #define MAX_PLANE       5
  23 #define MAX_FB_BUFFER   4
  24
  25 #define to_exynos_crtc(x)       container_of(x, struct exynos_drm_crtc, base)
  26 #define to_exynos_plane(x)      container_of(x, struct exynos_drm_plane, base)
  27
  28 /* this enumerates display type. */
  29 enum exynos_drm_output_type {
  30         EXYNOS_DISPLAY_TYPE_NONE,
  31         /* RGB or CPU Interface. */
  32         EXYNOS_DISPLAY_TYPE_LCD,
  33         /* HDMI Interface. */
  34         EXYNOS_DISPLAY_TYPE_HDMI,
  35         /* Virtual Display Interface. */
  36         EXYNOS_DISPLAY_TYPE_VIDI,
  37 };
  38
  39 /*
  40  * Exynos drm common overlay structure.
  41  *
  42  * @base: plane object
  43  * @src_x: offset x on a framebuffer to be displayed.
  44  *      - the unit is screen coordinates.
  45  * @src_y: offset y on a framebuffer to be displayed.
  46  *      - the unit is screen coordinates.
  47  * @src_width: width of a partial image to be displayed from framebuffer.
  48  * @src_height: height of a partial image to be displayed from framebuffer.
  49  * @fb_width: width of a framebuffer.
  50  * @fb_height: height of a framebuffer.
  51  * @crtc_x: offset x on hardware screen.
  52  * @crtc_y: offset y on hardware screen.
  53  * @crtc_width: window width to be displayed (hardware screen).
  54  * @crtc_height: window height to be displayed (hardware screen).
  55  * @mode_width: width of screen mode.
  56  * @mode_height: height of screen mode.
  57  * @h_ratio: horizontal scaling ratio, 16.16 fixed point
  58  * @v_ratio: vertical scaling ratio, 16.16 fixed point
  59  * @refresh: refresh rate.
  60  * @scan_flag: interlace or progressive way.
  61  *      (it could be DRM_MODE_FLAG_*)
  62  * @bpp: pixel size.(in bit)
  63  * @pixel_format: fourcc pixel format of this overlay
  64  * @dma_addr: array of bus(accessed by dma) address to the memory region
  65  *            allocated for a overlay.
  66  * @zpos: order of overlay layer(z position).
  67  * @enabled: enabled or not.
  68  * @resume: to resume or not.
  69  *
  70  * this structure is common to exynos SoC and its contents would be copied
  71  * to hardware specific overlay info.
  72  */
  73
  74 struct exynos_drm_plane {
  75         struct drm_plane base;
  76         unsigned int src_x;
  77         unsigned int src_y;
  78         unsigned int src_width;
  79         unsigned int src_height;
  80         unsigned int fb_width;
  81         unsigned int fb_height;
  82         unsigned int crtc_x;
  83         unsigned int crtc_y;
  84         unsigned int crtc_width;
  85         unsigned int crtc_height;
  86         unsigned int mode_width;
  87         unsigned int mode_height;
  88         unsigned int h_ratio;
  89         unsigned int v_ratio;
  90         unsigned int refresh;
  91         unsigned int scan_flag;
  92         unsigned int bpp;
  93         unsigned int pitch;
  94         uint32_t pixel_format;
  95         dma_addr_t dma_addr[MAX_FB_BUFFER];
  96         unsigned int zpos;
  97
  98         bool enabled:1;
  99         bool resume:1;
 100 };
 101
 102 /*
 103  * Exynos DRM Display Structure.
 104  *      - this structure is common to analog tv, digital tv and lcd panel.
 105  *
 106  * @create_connector: initialize and register a new connector
 107  * @remove: cleans up the display for removal
 108  * @mode_fixup: fix mode data comparing to hw specific display mode.
 109  * @mode_set: convert drm_display_mode to hw specific display mode and
 110  *            would be called by encoder->mode_set().
 111  * @check_mode: check if mode is valid or not.
 112  * @dpms: display device on or off.
 113  * @commit: apply changes to hw
 114  */
 115 struct exynos_drm_display;
 116 struct exynos_drm_display_ops {
 117         int (*create_connector)(struct exynos_drm_display *display,
 118                                 struct drm_encoder *encoder);
 119         void (*remove)(struct exynos_drm_display *display);
 120         void (*mode_fixup)(struct exynos_drm_display *display,
 121                                 struct drm_connector *connector,
 122                                 const struct drm_display_mode *mode,
 123                                 struct drm_display_mode *adjusted_mode);
 124         void (*mode_set)(struct exynos_drm_display *display,
 125                                 struct drm_display_mode *mode);
 126         int (*check_mode)(struct exynos_drm_display *display,
 127                                 struct drm_display_mode *mode);
 128         void (*dpms)(struct exynos_drm_display *display, int mode);
 129         void (*commit)(struct exynos_drm_display *display);
 130 };
 131
 132 /*
 133  * Exynos drm display structure, maps 1:1 with an encoder/connector
 134  *
 135  * @list: the list entry for this manager
 136  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
 137  * @encoder: encoder object this display maps to
 138  * @connector: connector object this display maps to
 139  * @ops: pointer to callbacks for exynos drm specific functionality
 140  * @ctx: A pointer to the display's implementation specific context
 141  */
 142 struct exynos_drm_display {
 143         struct list_head list;
 144         enum exynos_drm_output_type type;
 145         struct drm_encoder *encoder;
 146         struct drm_connector *connector;
 147         struct exynos_drm_display_ops *ops;
 148 };
 149
 150 /*
 151  * Exynos drm crtc ops
 152  *
 153  * @enable: enable the device
 154  * @disable: disable the device
 155  * @mode_fixup: fix mode data before applying it
 156  * @commit: set current hw specific display mode to hw.
 157  * @enable_vblank: specific driver callback for enabling vblank interrupt.
 158  * @disable_vblank: specific driver callback for disabling vblank interrupt.
 159  * @wait_for_vblank: wait for vblank interrupt to make sure that
 160  *      hardware overlay is updated.
 161  * @win_commit: apply hardware specific overlay data to registers.
 162  * @win_disable: disable hardware specific overlay.
 163  * @te_handler: trigger to transfer video image at the tearing effect
 164  *      synchronization signal if there is a page flip request.
 165  * @clock_enable: optional function enabling/disabling display domain clock,
 166  *      called from exynos-dp driver before powering up (with
 167  *      'enable' argument as true) and after powering down (with
 168  *      'enable' as false).
 169  */
 170 struct exynos_drm_crtc;
 171 struct exynos_drm_crtc_ops {
 172         void (*enable)(struct exynos_drm_crtc *crtc);
 173         void (*disable)(struct exynos_drm_crtc *crtc);
 174         bool (*mode_fixup)(struct exynos_drm_crtc *crtc,
 175                                 const struct drm_display_mode *mode,
 176                                 struct drm_display_mode *adjusted_mode);
 177         void (*commit)(struct exynos_drm_crtc *crtc);
 178         int (*enable_vblank)(struct exynos_drm_crtc *crtc);
 179         void (*disable_vblank)(struct exynos_drm_crtc *crtc);
 180         void (*wait_for_vblank)(struct exynos_drm_crtc *crtc);
 181         void (*win_commit)(struct exynos_drm_crtc *crtc, unsigned int zpos);
 182         void (*win_disable)(struct exynos_drm_crtc *crtc, unsigned int zpos);
 183         void (*te_handler)(struct exynos_drm_crtc *crtc);
 184         void (*clock_enable)(struct exynos_drm_crtc *crtc, bool enable);
 185 };
 186
 187 /*
 188  * Exynos specific crtc structure.
 189  *
 190  * @base: crtc object.
 191  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
 192  * @pipe: a crtc index created at load() with a new crtc object creation
 193  *      and the crtc object would be set to private->crtc array
 194  *      to get a crtc object corresponding to this pipe from private->crtc
 195  *      array when irq interrupt occurred. the reason of using this pipe is that
 196  *      drm framework doesn't support multiple irq yet.
 197  *      we can refer to the crtc to current hardware interrupt occurred through
 198  *      this pipe value.
 199  * @enabled: if the crtc is enabled or not
 200  * @event: vblank event that is currently queued for flip
 201  * @ops: pointer to callbacks for exynos drm specific functionality
 202  * @ctx: A pointer to the crtc's implementation specific context
 203  */
 204 struct exynos_drm_crtc {
 205         struct drm_crtc                 base;
 206         enum exynos_drm_output_type     type;
 207         unsigned int                    pipe;
 208         bool                            enabled;
 209         wait_queue_head_t               pending_flip_queue;
 210         struct drm_pending_vblank_event *event;
 211         const struct exynos_drm_crtc_ops        *ops;
 212         void                            *ctx;
 213 };
 214
 215 struct exynos_drm_g2d_private {
 216         struct device           *dev;
 217         struct list_head        inuse_cmdlist;
 218         struct list_head        event_list;
 219         struct list_head        userptr_list;
 220 };
 221
 222 struct drm_exynos_file_private {
 223         struct exynos_drm_g2d_private   *g2d_priv;
 224         struct device                   *ipp_dev;
 225 };
 226
 227 /*
 228  * Exynos drm private structure.
 229  *
 230  * @da_start: start address to device address space.
 231  *      with iommu, device address space starts from this address
 232  *      otherwise default one.
 233  * @da_space_size: size of device address space.
 234  *      if 0 then default value is used for it.
 235  * @pipe: the pipe number for this crtc/manager.
 236  */
 237 struct exynos_drm_private {
 238         struct drm_fb_helper *fb_helper;
 239
 240         /*
 241          * created crtc object would be contained at this array and
 242          * this array is used to be aware of which crtc did it request vblank.
 243          */
 244         struct drm_crtc *crtc[MAX_CRTC];
 245         struct drm_property *plane_zpos_property;
 246
 247         unsigned long da_start;
 248         unsigned long da_space_size;
 249
 250         unsigned int pipe;
 251 };
 252
 253 /*
 254  * Exynos drm sub driver structure.
 255  *
 256  * @list: sub driver has its own list object to register to exynos drm driver.
 257  * @dev: pointer to device object for subdrv device driver.
 258  * @drm_dev: pointer to drm_device and this pointer would be set
 259  *      when sub driver calls exynos_drm_subdrv_register().
 260  * @probe: this callback would be called by exynos drm driver after
 261  *     subdrv is registered to it.
 262  * @remove: this callback is used to release resources created
 263  *     by probe callback.
 264  * @open: this would be called with drm device file open.
 265  * @close: this would be called with drm device file close.
 266  */
 267 struct exynos_drm_subdrv {
 268         struct list_head list;
 269         struct device *dev;
 270         struct drm_device *drm_dev;
 271
 272         int (*probe)(struct drm_device *drm_dev, struct device *dev);
 273         void (*remove)(struct drm_device *drm_dev, struct device *dev);
 274         int (*open)(struct drm_device *drm_dev, struct device *dev,
 275                         struct drm_file *file);
 276         void (*close)(struct drm_device *drm_dev, struct device *dev,
 277                         struct drm_file *file);
 278 };
 279
 280  /* This function would be called by non kms drivers such as g2d and ipp. */
 281 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
 282
 283 /* this function removes subdrv list from exynos drm driver */
 284 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
 285
 286 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
 287 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
 288 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
 289 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
 290
 291 #ifdef CONFIG_DRM_EXYNOS_DPI
 292 struct exynos_drm_display * exynos_dpi_probe(struct device *dev);
 293 int exynos_dpi_remove(struct exynos_drm_display *display);
 294 #else
 295 static inline struct exynos_drm_display *
 296 exynos_dpi_probe(struct device *dev) { return NULL; }
 297 static inline int exynos_dpi_remove(struct exynos_drm_display *display)
 298 {
 299         return 0;
 300 }
 301 #endif
 302
 303 /* This function creates a encoder and a connector, and initializes them. */
 304 int exynos_drm_create_enc_conn(struct drm_device *dev,
 305                                 struct exynos_drm_display *display);
 306
 307 extern struct platform_driver fimd_driver;
 308 extern struct platform_driver decon_driver;
 309 extern struct platform_driver dp_driver;
 310 extern struct platform_driver dsi_driver;
 311 extern struct platform_driver mixer_driver;
 312 extern struct platform_driver hdmi_driver;
 313 extern struct platform_driver exynos_drm_common_hdmi_driver;
 314 extern struct platform_driver vidi_driver;
 315 extern struct platform_driver g2d_driver;
 316 extern struct platform_driver fimc_driver;
 317 extern struct platform_driver rotator_driver;
 318 extern struct platform_driver gsc_driver;
 319 extern struct platform_driver ipp_driver;
 320 #endif