drivers/gpu/drm/rockchip/rockchip_drm_drv.h

   1 /*
   2  * Copyright (C) ROCKCHIP, Inc.
   3  * Author:yzq<yzq@rock-chips.com>
   4  * This software is licensed under the terms of the GNU General Public
   5  * License version 2, as published by the Free Software Foundation, and
   6  * may be copied, distributed, and modified under those terms.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  11  * GNU General Public License for more details.
  12  */
  13 #ifndef _ROCKCHIP_DRM_DRV_H_
  14 #define _ROCKCHIP_DRM_DRV_H_
  15
  16 #include <linux/module.h>
  17
  18 #define MAX_CRTC        3
  19 #define MAX_PLANE       5
  20 #define MAX_FB_BUFFER   4
  21 #define DEFAULT_ZPOS    -1
  22
  23 #define _wait_for(COND, MS) ({ \
  24         unsigned long timeout__ = jiffies + msecs_to_jiffies(MS);       \
  25         int ret__ = 0;                                                  \
  26         while (!(COND)) {                                               \
  27                 if (time_after(jiffies, timeout__)) {                   \
  28                         ret__ = -ETIMEDOUT;                             \
  29                         break;                                          \
  30                 }                                                       \
  31         }                                                               \
  32         ret__;                                                          \
  33 })
  34
  35 #define wait_for(COND, MS) _wait_for(COND, MS)
  36
  37 struct drm_device;
  38 struct rockchip_drm_overlay;
  39 struct drm_connector;
  40
  41 extern unsigned int drm_vblank_offdelay;
  42
  43 /* this enumerates display type. */
  44 enum rockchip_drm_output_type {
  45         ROCKCHIP_DISPLAY_TYPE_NONE,
  46         /* RGB or CPU Interface. */
  47         ROCKCHIP_DISPLAY_TYPE_LCD,
  48         /* HDMI Interface. */
  49         ROCKCHIP_DISPLAY_TYPE_HDMI,
  50         /* Virtual Display Interface. */
  51         ROCKCHIP_DISPLAY_TYPE_VIDI,
  52 };
  53
  54 /*
  55  * Exynos drm overlay ops structure.
  56  *
  57  * @mode_set: copy drm overlay info to hw specific overlay info.
  58  * @commit: apply hardware specific overlay data to registers.
  59  * @enable: enable hardware specific overlay.
  60  * @disable: disable hardware specific overlay.
  61  */
  62 struct rockchip_drm_overlay_ops {
  63         void (*mode_set)(struct device *subdrv_dev,
  64                          struct rockchip_drm_overlay *overlay);
  65         void (*commit)(struct device *subdrv_dev, int zpos);
  66         void (*enable)(struct device *subdrv_dev, int zpos);
  67         void (*disable)(struct device *subdrv_dev, int zpos);
  68 };
  69
  70 /*
  71  * Exynos drm common overlay structure.
  72  *
  73  * @fb_x: offset x on a framebuffer to be displayed.
  74  *      - the unit is screen coordinates.
  75  * @fb_y: offset y on a framebuffer to be displayed.
  76  *      - the unit is screen coordinates.
  77  * @fb_width: width of a framebuffer.
  78  * @fb_height: height of a framebuffer.
  79  * @src_width: width of a partial image to be displayed from framebuffer.
  80  * @src_height: height of a partial image to be displayed from framebuffer.
  81  * @crtc_x: offset x on hardware screen.
  82  * @crtc_y: offset y on hardware screen.
  83  * @crtc_width: window width to be displayed (hardware screen).
  84  * @crtc_height: window height to be displayed (hardware screen).
  85  * @mode_width: width of screen mode.
  86  * @mode_height: height of screen mode.
  87  * @refresh: refresh rate.
  88  * @scan_flag: interlace or progressive way.
  89  *      (it could be DRM_MODE_FLAG_*)
  90  * @bpp: pixel size.(in bit)
  91  * @pixel_format: fourcc pixel format of this overlay
  92  * @dma_addr: array of bus(accessed by dma) address to the memory region
  93  *            allocated for a overlay.
  94  * @zpos: order of overlay layer(z position).
  95  * @default_win: a window to be enabled.
  96  * @color_key: color key on or off.
  97  * @index_color: if using color key feature then this value would be used
  98  *                      as index color.
  99  * @local_path: in case of lcd type, local path mode on or off.
 100  * @transparency: transparency on or off.
 101  * @activated: activated or not.
 102  *
 103  * this structure is common to rockchip SoC and its contents would be copied
 104  * to hardware specific overlay info.
 105  */
 106 struct rockchip_drm_overlay {
 107         unsigned int fb_x;
 108         unsigned int fb_y;
 109         unsigned int fb_width;
 110         unsigned int fb_height;
 111         unsigned int src_width;
 112         unsigned int src_height;
 113         unsigned int crtc_x;
 114         unsigned int crtc_y;
 115         unsigned int crtc_width;
 116         unsigned int crtc_height;
 117         unsigned int mode_width;
 118         unsigned int mode_height;
 119         unsigned int refresh;
 120         unsigned int pixclock;
 121         unsigned int scan_flag;
 122         unsigned int bpp;
 123         unsigned int pitch;
 124         uint32_t pixel_format;
 125         dma_addr_t dma_addr[MAX_FB_BUFFER];
 126         int zpos;
 127
 128         bool default_win;
 129         bool color_key;
 130         unsigned int index_color;
 131         bool local_path;
 132         bool transparency;
 133         bool activated;
 134 };
 135
 136 /*
 137  * Exynos DRM Display Structure.
 138  *      - this structure is common to analog tv, digital tv and lcd panel.
 139  *
 140  * @type: one of ROCKCHIP_DISPLAY_TYPE_LCD and HDMI.
 141  * @is_connected: check for that display is connected or not.
 142  * @get_edid: get edid modes from display driver.
 143  * @get_panel: get panel object from display driver.
 144  * @check_timing: check if timing is valid or not.
 145  * @power_on: display device on or off.
 146  */
 147 struct rockchip_drm_display_ops {
 148         enum rockchip_drm_output_type type;
 149         bool (*is_connected)(struct device *dev);
 150         struct edid *(*get_edid)(struct device *dev,
 151                         struct drm_connector *connector);
 152         void *(*get_panel)(struct device *dev);
 153         void *(*get_modelist)(struct device *dev);
 154         int (*check_timing)(struct device *dev, void *timing);
 155         int (*power_on)(struct device *dev, int mode);
 156 };
 157
 158 /*
 159  * Exynos drm manager ops
 160  *
 161  * @dpms: control device power.
 162  * @apply: set timing, vblank and overlay data to registers.
 163  * @mode_fixup: fix mode data comparing to hw specific display mode.
 164  * @mode_set: convert drm_display_mode to hw specific display mode and
 165  *            would be called by encoder->mode_set().
 166  * @get_max_resol: get maximum resolution to specific hardware.
 167  * @commit: set current hw specific display mode to hw.
 168  * @enable_vblank: specific driver callback for enabling vblank interrupt.
 169  * @disable_vblank: specific driver callback for disabling vblank interrupt.
 170  * @wait_for_vblank: wait for vblank interrupt to make sure that
 171  *      hardware overlay is updated.
 172  */
 173 struct rockchip_drm_manager_ops {
 174         void (*dpms)(struct device *subdrv_dev, int mode);
 175         void (*apply)(struct device *subdrv_dev);
 176         void (*mode_fixup)(struct device *subdrv_dev,
 177                                 struct drm_connector *connector,
 178                                 const struct drm_display_mode *mode,
 179                                 struct drm_display_mode *adjusted_mode);
 180         void (*mode_set)(struct device *subdrv_dev, void *mode);
 181         void (*get_max_resol)(struct device *subdrv_dev, unsigned int *width,
 182                                 unsigned int *height);
 183         void (*commit)(struct device *subdrv_dev);
 184         int (*enable_vblank)(struct device *subdrv_dev);
 185         void (*disable_vblank)(struct device *subdrv_dev);
 186         void (*wait_for_vblank)(struct device *subdrv_dev);
 187 };
 188
 189 /*
 190  * Exynos drm common manager structure.
 191  *
 192  * @dev: pointer to device object for subdrv device driver.
 193  *      sub drivers such as display controller or hdmi driver,
 194  *      have their own device object.
 195  * @ops: pointer to callbacks for rockchip drm specific framebuffer.
 196  *      these callbacks should be set by specific drivers such fimd
 197  *      or hdmi driver and are used to control hardware global registers.
 198  * @overlay_ops: pointer to callbacks for rockchip drm specific framebuffer.
 199  *      these callbacks should be set by specific drivers such fimd
 200  *      or hdmi driver and are used to control hardware overlay reigsters.
 201  * @display: pointer to callbacks for rockchip drm specific framebuffer.
 202  *      these callbacks should be set by specific drivers such fimd
 203  *      or hdmi driver and are used to control display devices such as
 204  *      analog tv, digital tv and lcd panel and also get timing data for them.
 205  */
 206 struct rockchip_drm_manager {
 207         struct device *dev;
 208         int pipe;
 209         struct rockchip_drm_manager_ops *ops;
 210         struct rockchip_drm_overlay_ops *overlay_ops;
 211         struct rockchip_drm_display_ops *display_ops;
 212 };
 213
 214 struct rockchip_drm_g2d_private {
 215         struct device           *dev;
 216         struct list_head        inuse_cmdlist;
 217         struct list_head        event_list;
 218         struct list_head        userptr_list;
 219 };
 220
 221 struct rockchip_drm_ipp_private {
 222         struct device   *dev;
 223         struct list_head        event_list;
 224 };
 225
 226 struct drm_rockchip_file_private {
 227         struct rockchip_drm_g2d_private *g2d_priv;
 228         struct rockchip_drm_ipp_private *ipp_priv;
 229 };
 230
 231 /*
 232  * Exynos drm private structure.
 233  *
 234  * @da_start: start address to device address space.
 235  *      with iommu, device address space starts from this address
 236  *      otherwise default one.
 237  * @da_space_size: size of device address space.
 238  *      if 0 then default value is used for it.
 239  * @da_space_order: order to device address space.
 240  */
 241 struct rockchip_drm_private {
 242         struct drm_fb_helper *fb_helper;
 243
 244         /* list head for new event to be added. */
 245         struct list_head pageflip_event_list;
 246
 247         /*
 248          * created crtc object would be contained at this array and
 249          * this array is used to be aware of which crtc did it request vblank.
 250          */
 251         struct drm_crtc *crtc[MAX_CRTC];
 252         struct drm_property *plane_zpos_property;
 253         struct drm_property *crtc_mode_property;
 254
 255         unsigned long da_start;
 256         unsigned long da_space_size;
 257         unsigned long da_space_order;
 258 };
 259
 260 /*
 261  * Exynos drm sub driver structure.
 262  *
 263  * @list: sub driver has its own list object to register to rockchip drm driver.
 264  * @dev: pointer to device object for subdrv device driver.
 265  * @drm_dev: pointer to drm_device and this pointer would be set
 266  *      when sub driver calls rockchip_drm_subdrv_register().
 267  * @manager: subdrv has its own manager to control a hardware appropriately
 268  *      and we can access a hardware drawing on this manager.
 269  * @probe: this callback would be called by rockchip drm driver after
 270  *      subdrv is registered to it.
 271  * @remove: this callback is used to release resources created
 272  *      by probe callback.
 273  * @open: this would be called with drm device file open.
 274  * @close: this would be called with drm device file close.
 275  * @encoder: encoder object owned by this sub driver.
 276  * @connector: connector object owned by this sub driver.
 277  */
 278 struct rockchip_drm_subdrv {
 279         struct list_head list;
 280         struct device *dev;
 281         struct drm_device *drm_dev;
 282         struct rockchip_drm_manager *manager;
 283
 284         int (*probe)(struct drm_device *drm_dev, struct device *dev);
 285         void (*remove)(struct drm_device *drm_dev, struct device *dev);
 286         int (*open)(struct drm_device *drm_dev, struct device *dev,
 287                         struct drm_file *file);
 288         void (*close)(struct drm_device *drm_dev, struct device *dev,
 289                         struct drm_file *file);
 290
 291         struct drm_encoder *encoder;
 292         struct drm_connector *connector;
 293 };
 294
 295 /*
 296  * this function calls a probe callback registered to sub driver list and
 297  * create its own encoder and connector and then set drm_device object
 298  * to global one.
 299  */
 300 int rockchip_drm_device_register(struct drm_device *dev);
 301 /*
 302  * this function calls a remove callback registered to sub driver list and
 303  * destroy its own encoder and connetor.
 304  */
 305 int rockchip_drm_device_unregister(struct drm_device *dev);
 306
 307 /*
 308  * this function would be called by sub drivers such as display controller
 309  * or hdmi driver to register this sub driver object to rockchip drm driver
 310  * and when a sub driver is registered to rockchip drm driver a probe callback
 311  * of the sub driver is called and creates its own encoder and connector.
 312  */
 313 int rockchip_drm_subdrv_register(struct rockchip_drm_subdrv *drm_subdrv);
 314
 315 /* this function removes subdrv list from rockchip drm driver */
 316 int rockchip_drm_subdrv_unregister(struct rockchip_drm_subdrv *drm_subdrv);
 317
 318 int rockchip_drm_subdrv_open(struct drm_device *dev, struct drm_file *file);
 319 void rockchip_drm_subdrv_close(struct drm_device *dev, struct drm_file *file);
 320
 321 /*
 322  * this function registers rockchip drm hdmi platform device. It ensures only one
 323  * instance of the device is created.
 324  */
 325 int rockchip_platform_device_hdmi_register(void);
 326
 327 /*
 328  * this function unregisters rockchip drm hdmi platform device if it exists.
 329  */
 330 void rockchip_platform_device_hdmi_unregister(void);
 331
 332 /*
 333  * this function registers rockchip drm ipp platform device.
 334  */
 335 int rockchip_platform_device_ipp_register(void);
 336
 337 /*
 338  * this function unregisters rockchip drm ipp platform device if it exists.
 339  */
 340 void rockchip_platform_device_ipp_unregister(void);
 341
 342 extern struct platform_driver primary_platform_driver;
 343 extern struct platform_driver extend_platform_driver;
 344 extern struct platform_driver hdmi_driver;
 345 extern struct platform_driver mixer_driver;
 346 extern struct platform_driver rockchip_drm_common_hdmi_driver;
 347 extern struct platform_driver vidi_driver;
 348 extern struct platform_driver g2d_driver;
 349 extern struct platform_driver fimc_driver;
 350 extern struct platform_driver rotator_driver;
 351 extern struct platform_driver gsc_driver;
 352 extern struct platform_driver ipp_driver;
 353 #endif