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