drivers/gpu/drm/rockchip/rockchip_drm_drv.h

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