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