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