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 DEFAULT_WIN     0
  26
  27 #define to_exynos_crtc(x)       container_of(x, struct exynos_drm_crtc, base)
  28 #define to_exynos_plane(x)      container_of(x, struct exynos_drm_plane, base)
  29
  30 /* this enumerates display type. */
  31 enum exynos_drm_output_type {
  32         EXYNOS_DISPLAY_TYPE_NONE,
  33         /* RGB or CPU Interface. */
  34         EXYNOS_DISPLAY_TYPE_LCD,
  35         /* HDMI Interface. */
  36         EXYNOS_DISPLAY_TYPE_HDMI,
  37         /* Virtual Display Interface. */
  38         EXYNOS_DISPLAY_TYPE_VIDI,
  39 };
  40
  41 struct exynos_drm_rect {
  42         unsigned int x, y;
  43         unsigned int w, h;
  44 };
  45
  46 /*
  47  * Exynos drm plane state structure.
  48  *
  49  * @base: plane_state object (contains drm_framebuffer pointer)
  50  * @src: rectangle of the source image data to be displayed (clipped to
  51  *       visible part).
  52  * @crtc: rectangle of the target image position on hardware screen
  53  *       (clipped to visible part).
  54  * @h_ratio: horizontal scaling ratio, 16.16 fixed point
  55  * @v_ratio: vertical scaling ratio, 16.16 fixed point
  56  *
  57  * this structure consists plane state data that will be applied to hardware
  58  * specific overlay info.
  59  */
  60
  61 struct exynos_drm_plane_state {
  62         struct drm_plane_state base;
  63         struct exynos_drm_rect crtc;
  64         struct exynos_drm_rect src;
  65         unsigned int h_ratio;
  66         unsigned int v_ratio;
  67         unsigned int zpos;
  68 };
  69
  70 static inline struct exynos_drm_plane_state *
  71 to_exynos_plane_state(struct drm_plane_state *state)
  72 {
  73         return container_of(state, struct exynos_drm_plane_state, base);
  74 }
  75
  76 /*
  77  * Exynos drm common overlay structure.
  78  *
  79  * @base: plane object
  80  * @index: hardware index of the overlay layer
  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         const struct exynos_drm_plane_config *config;
  89         unsigned int index;
  90         struct drm_framebuffer *pending_fb;
  91 };
  92
  93 #define EXYNOS_DRM_PLANE_CAP_DOUBLE     (1 << 0)
  94 #define EXYNOS_DRM_PLANE_CAP_SCALE      (1 << 1)
  95 #define EXYNOS_DRM_PLANE_CAP_ZPOS       (1 << 2)
  96
  97 /*
  98  * Exynos DRM plane configuration structure.
  99  *
 100  * @zpos: initial z-position of the plane.
 101  * @type: type of the plane (primary, cursor or overlay).
 102  * @pixel_formats: supported pixel formats.
 103  * @num_pixel_formats: number of elements in 'pixel_formats'.
 104  * @capabilities: supported features (see EXYNOS_DRM_PLANE_CAP_*)
 105  */
 106
 107 struct exynos_drm_plane_config {
 108         unsigned int zpos;
 109         enum drm_plane_type type;
 110         const uint32_t *pixel_formats;
 111         unsigned int num_pixel_formats;
 112         unsigned int capabilities;
 113 };
 114
 115 /*
 116  * Exynos drm crtc ops
 117  *
 118  * @enable: enable the device
 119  * @disable: disable the device
 120  * @commit: set current hw specific display mode to hw.
 121  * @enable_vblank: specific driver callback for enabling vblank interrupt.
 122  * @disable_vblank: specific driver callback for disabling vblank interrupt.
 123  * @atomic_check: validate state
 124  * @atomic_begin: prepare device to receive an update
 125  * @atomic_flush: mark the end of device update
 126  * @update_plane: apply hardware specific overlay data to registers.
 127  * @disable_plane: disable hardware specific overlay.
 128  * @te_handler: trigger to transfer video image at the tearing effect
 129  *      synchronization signal if there is a page flip request.
 130  */
 131 struct exynos_drm_crtc;
 132 struct exynos_drm_crtc_ops {
 133         void (*enable)(struct exynos_drm_crtc *crtc);
 134         void (*disable)(struct exynos_drm_crtc *crtc);
 135         void (*commit)(struct exynos_drm_crtc *crtc);
 136         int (*enable_vblank)(struct exynos_drm_crtc *crtc);
 137         void (*disable_vblank)(struct exynos_drm_crtc *crtc);
 138         int (*atomic_check)(struct exynos_drm_crtc *crtc,
 139                             struct drm_crtc_state *state);
 140         void (*atomic_begin)(struct exynos_drm_crtc *crtc);
 141         void (*update_plane)(struct exynos_drm_crtc *crtc,
 142                              struct exynos_drm_plane *plane);
 143         void (*disable_plane)(struct exynos_drm_crtc *crtc,
 144                               struct exynos_drm_plane *plane);
 145         void (*atomic_flush)(struct exynos_drm_crtc *crtc);
 146         void (*te_handler)(struct exynos_drm_crtc *crtc);
 147 };
 148
 149 struct exynos_drm_clk {
 150         void (*enable)(struct exynos_drm_clk *clk, bool enable);
 151 };
 152
 153 /*
 154  * Exynos specific crtc structure.
 155  *
 156  * @base: crtc object.
 157  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
 158  * @pipe: a crtc index created at load() with a new crtc object creation
 159  *      and the crtc object would be set to private->crtc array
 160  *      to get a crtc object corresponding to this pipe from private->crtc
 161  *      array when irq interrupt occurred. the reason of using this pipe is that
 162  *      drm framework doesn't support multiple irq yet.
 163  *      we can refer to the crtc to current hardware interrupt occurred through
 164  *      this pipe value.
 165  * @enabled: if the crtc is enabled or not
 166  * @event: vblank event that is currently queued for flip
 167  * @wait_update: wait all pending planes updates to finish
 168  * @pending_update: number of pending plane updates in this crtc
 169  * @ops: pointer to callbacks for exynos drm specific functionality
 170  * @ctx: A pointer to the crtc's implementation specific context
 171  */
 172 struct exynos_drm_crtc {
 173         struct drm_crtc                 base;
 174         enum exynos_drm_output_type     type;
 175         unsigned int                    pipe;
 176         struct drm_pending_vblank_event *event;
 177         wait_queue_head_t               wait_update;
 178         atomic_t                        pending_update;
 179         const struct exynos_drm_crtc_ops        *ops;
 180         void                            *ctx;
 181         struct exynos_drm_clk           *pipe_clk;
 182 };
 183
 184 static inline void exynos_drm_pipe_clk_enable(struct exynos_drm_crtc *crtc,
 185                                               bool enable)
 186 {
 187         if (crtc->pipe_clk)
 188                 crtc->pipe_clk->enable(crtc->pipe_clk, enable);
 189 }
 190
 191 struct exynos_drm_g2d_private {
 192         struct device           *dev;
 193         struct list_head        inuse_cmdlist;
 194         struct list_head        event_list;
 195         struct list_head        userptr_list;
 196 };
 197
 198 struct drm_exynos_file_private {
 199         struct exynos_drm_g2d_private   *g2d_priv;
 200         struct device                   *ipp_dev;
 201 };
 202
 203 /*
 204  * Exynos drm private structure.
 205  *
 206  * @da_start: start address to device address space.
 207  *      with iommu, device address space starts from this address
 208  *      otherwise default one.
 209  * @da_space_size: size of device address space.
 210  *      if 0 then default value is used for it.
 211  * @pipe: the pipe number for this crtc/manager.
 212  * @pending: the crtcs that have pending updates to finish
 213  * @lock: protect access to @pending
 214  * @wait: wait an atomic commit to finish
 215  */
 216 struct exynos_drm_private {
 217         struct drm_fb_helper *fb_helper;
 218
 219         /*
 220          * created crtc object would be contained at this array and
 221          * this array is used to be aware of which crtc did it request vblank.
 222          */
 223         struct drm_crtc *crtc[MAX_CRTC];
 224         struct drm_property *plane_zpos_property;
 225
 226         struct device *dma_dev;
 227         unsigned long da_start;
 228         unsigned long da_space_size;
 229         void *mapping;
 230
 231         unsigned int pipe;
 232
 233         /* for atomic commit */
 234         u32                     pending;
 235         spinlock_t              lock;
 236         wait_queue_head_t       wait;
 237 };
 238
 239 static inline struct exynos_drm_crtc *
 240 exynos_drm_crtc_from_pipe(struct drm_device *dev, int pipe)
 241 {
 242         struct exynos_drm_private *private = dev->dev_private;
 243
 244         return to_exynos_crtc(private->crtc[pipe]);
 245 }
 246
 247 static inline struct device *to_dma_dev(struct drm_device *dev)
 248 {
 249         struct exynos_drm_private *priv = dev->dev_private;
 250
 251         return priv->dma_dev;
 252 }
 253
 254 /*
 255  * Exynos drm sub driver structure.
 256  *
 257  * @list: sub driver has its own list object to register to exynos drm driver.
 258  * @dev: pointer to device object for subdrv device driver.
 259  * @drm_dev: pointer to drm_device and this pointer would be set
 260  *      when sub driver calls exynos_drm_subdrv_register().
 261  * @probe: this callback would be called by exynos drm driver after
 262  *     subdrv is registered to it.
 263  * @remove: this callback is used to release resources created
 264  *     by probe callback.
 265  * @open: this would be called with drm device file open.
 266  * @close: this would be called with drm device file close.
 267  */
 268 struct exynos_drm_subdrv {
 269         struct list_head list;
 270         struct device *dev;
 271         struct drm_device *drm_dev;
 272
 273         int (*probe)(struct drm_device *drm_dev, struct device *dev);
 274         void (*remove)(struct drm_device *drm_dev, struct device *dev);
 275         int (*open)(struct drm_device *drm_dev, struct device *dev,
 276                         struct drm_file *file);
 277         void (*close)(struct drm_device *drm_dev, struct device *dev,
 278                         struct drm_file *file);
 279 };
 280
 281  /* This function would be called by non kms drivers such as g2d and ipp. */
 282 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
 283
 284 /* this function removes subdrv list from exynos drm driver */
 285 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
 286
 287 int exynos_drm_device_subdrv_probe(struct drm_device *dev);
 288 int exynos_drm_device_subdrv_remove(struct drm_device *dev);
 289 int exynos_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
 290 void exynos_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
 291
 292 #ifdef CONFIG_DRM_EXYNOS_DPI
 293 struct drm_encoder *exynos_dpi_probe(struct device *dev);
 294 int exynos_dpi_remove(struct drm_encoder *encoder);
 295 int exynos_dpi_bind(struct drm_device *dev, struct drm_encoder *encoder);
 296 #else
 297 static inline struct drm_encoder *
 298 exynos_dpi_probe(struct device *dev) { return NULL; }
 299 static inline int exynos_dpi_remove(struct drm_encoder *encoder)
 300 {
 301         return 0;
 302 }
 303 static inline int exynos_dpi_bind(struct drm_device *dev,
 304                                   struct drm_encoder *encoder)
 305 {
 306         return 0;
 307 }
 308 #endif
 309
 310 int exynos_atomic_commit(struct drm_device *dev, struct drm_atomic_state *state,
 311                          bool nonblock);
 312
 313
 314 extern struct platform_driver fimd_driver;
 315 extern struct platform_driver exynos5433_decon_driver;
 316 extern struct platform_driver decon_driver;
 317 extern struct platform_driver dp_driver;
 318 extern struct platform_driver dsi_driver;
 319 extern struct platform_driver mixer_driver;
 320 extern struct platform_driver hdmi_driver;
 321 extern struct platform_driver vidi_driver;
 322 extern struct platform_driver g2d_driver;
 323 extern struct platform_driver fimc_driver;
 324 extern struct platform_driver rotator_driver;
 325 extern struct platform_driver gsc_driver;
 326 extern struct platform_driver ipp_driver;
 327 extern struct platform_driver mic_driver;
 328 #endif