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