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