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