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  * Permission is hereby granted, free of charge, to any person obtaining a
  10  * copy of this software and associated documentation files (the "Software"),
  11  * to deal in the Software without restriction, including without limitation
  12  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  13  * and/or sell copies of the Software, and to permit persons to whom the
  14  * Software is furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice (including the next
  17  * paragraph) shall be included in all copies or substantial portions of the
  18  * Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  23  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  24  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  25  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  26  * OTHER DEALINGS IN THE SOFTWARE.
  27  */
  28
  29 #ifndef _EXYNOS_DRM_DRV_H_
  30 #define _EXYNOS_DRM_DRV_H_
  31
  32 #include <linux/module.h>
  33 #include "drm.h"
  34
  35 #define MAX_CRTC        2
  36 #define MAX_PLANE       5
  37 #define MAX_FB_BUFFER   3
  38 #define DEFAULT_ZPOS    -1
  39
  40 struct drm_device;
  41 struct exynos_drm_overlay;
  42 struct drm_connector;
  43
  44 /* this enumerates display type. */
  45 enum exynos_drm_output_type {
  46         EXYNOS_DISPLAY_TYPE_NONE,
  47         /* RGB or CPU Interface. */
  48         EXYNOS_DISPLAY_TYPE_LCD,
  49         /* HDMI Interface. */
  50         EXYNOS_DISPLAY_TYPE_HDMI,
  51 };
  52
  53 /*
  54  * Exynos drm overlay ops structure.
  55  *
  56  * @mode_set: copy drm overlay info to hw specific overlay info.
  57  * @commit: apply hardware specific overlay data to registers.
  58  * @disable: disable hardware specific overlay.
  59  */
  60 struct exynos_drm_overlay_ops {
  61         void (*mode_set)(struct device *subdrv_dev,
  62                          struct exynos_drm_overlay *overlay);
  63         void (*commit)(struct device *subdrv_dev, int zpos);
  64         void (*disable)(struct device *subdrv_dev, int zpos);
  65 };
  66
  67 /*
  68  * Exynos drm common overlay structure.
  69  *
  70  * @fb_x: offset x on a framebuffer to be displayed.
  71  *      - the unit is screen coordinates.
  72  * @fb_y: offset y on a framebuffer to be displayed.
  73  *      - the unit is screen coordinates.
  74  * @fb_width: width of a framebuffer.
  75  * @fb_height: height of a framebuffer.
  76  * @crtc_x: offset x on hardware screen.
  77  * @crtc_y: offset y on hardware screen.
  78  * @crtc_width: window width to be displayed (hardware screen).
  79  * @crtc_height: window height to be displayed (hardware screen).
  80  * @mode_width: width of screen mode.
  81  * @mode_height: height of screen mode.
  82  * @refresh: refresh rate.
  83  * @scan_flag: interlace or progressive way.
  84  *      (it could be DRM_MODE_FLAG_*)
  85  * @bpp: pixel size.(in bit)
  86  * @pixel_format: fourcc pixel format of this overlay
  87  * @dma_addr: array of bus(accessed by dma) address to the memory region
  88  *            allocated for a overlay.
  89  * @vaddr: array of virtual memory addresss to this overlay.
  90  * @zpos: order of overlay layer(z position).
  91  * @default_win: a window to be enabled.
  92  * @color_key: color key on or off.
  93  * @index_color: if using color key feature then this value would be used
  94  *                      as index color.
  95  * @local_path: in case of lcd type, local path mode on or off.
  96  * @transparency: transparency on or off.
  97  * @activated: activated or not.
  98  *
  99  * this structure is common to exynos SoC and its contents would be copied
 100  * to hardware specific overlay info.
 101  */
 102 struct exynos_drm_overlay {
 103         unsigned int fb_x;
 104         unsigned int fb_y;
 105         unsigned int fb_width;
 106         unsigned int fb_height;
 107         unsigned int crtc_x;
 108         unsigned int crtc_y;
 109         unsigned int crtc_width;
 110         unsigned int crtc_height;
 111         unsigned int mode_width;
 112         unsigned int mode_height;
 113         unsigned int refresh;
 114         unsigned int scan_flag;
 115         unsigned int bpp;
 116         unsigned int pitch;
 117         uint32_t pixel_format;
 118         dma_addr_t dma_addr[MAX_FB_BUFFER];
 119         void __iomem *vaddr[MAX_FB_BUFFER];
 120         int zpos;
 121
 122         bool default_win;
 123         bool color_key;
 124         unsigned int index_color;
 125         bool local_path;
 126         bool transparency;
 127         bool activated;
 128 };
 129
 130 /*
 131  * Exynos DRM Display Structure.
 132  *      - this structure is common to analog tv, digital tv and lcd panel.
 133  *
 134  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
 135  * @is_connected: check for that display is connected or not.
 136  * @get_edid: get edid modes from display driver.
 137  * @get_timing: get timing object from display driver.
 138  * @check_timing: check if timing is valid or not.
 139  * @power_on: display device on or off.
 140  */
 141 struct exynos_drm_display_ops {
 142         enum exynos_drm_output_type type;
 143         bool (*is_connected)(struct device *dev);
 144         int (*get_edid)(struct device *dev, struct drm_connector *connector,
 145                                 u8 *edid, int len);
 146         void *(*get_timing)(struct device *dev);
 147         int (*check_timing)(struct device *dev, void *timing);
 148         int (*power_on)(struct device *dev, int mode);
 149 };
 150
 151 /*
 152  * Exynos drm manager ops
 153  *
 154  * @dpms: control device power.
 155  * @apply: set timing, vblank and overlay data to registers.
 156  * @mode_set: convert drm_display_mode to hw specific display mode and
 157  *            would be called by encoder->mode_set().
 158  * @commit: set current hw specific display mode to hw.
 159  * @enable_vblank: specific driver callback for enabling vblank interrupt.
 160  * @disable_vblank: specific driver callback for disabling vblank interrupt.
 161  */
 162 struct exynos_drm_manager_ops {
 163         void (*dpms)(struct device *subdrv_dev, int mode);
 164         void (*apply)(struct device *subdrv_dev);
 165         void (*mode_set)(struct device *subdrv_dev, void *mode);
 166         void (*commit)(struct device *subdrv_dev);
 167         int (*enable_vblank)(struct device *subdrv_dev);
 168         void (*disable_vblank)(struct device *subdrv_dev);
 169 };
 170
 171 /*
 172  * Exynos drm common manager structure.
 173  *
 174  * @dev: pointer to device object for subdrv device driver.
 175  *      sub drivers such as display controller or hdmi driver,
 176  *      have their own device object.
 177  * @ops: pointer to callbacks for exynos drm specific framebuffer.
 178  *      these callbacks should be set by specific drivers such fimd
 179  *      or hdmi driver and are used to control hardware global registers.
 180  * @overlay_ops: pointer to callbacks for exynos drm specific framebuffer.
 181  *      these callbacks should be set by specific drivers such fimd
 182  *      or hdmi driver and are used to control hardware overlay reigsters.
 183  * @display: pointer to callbacks for exynos drm specific framebuffer.
 184  *      these callbacks should be set by specific drivers such fimd
 185  *      or hdmi driver and are used to control display devices such as
 186  *      analog tv, digital tv and lcd panel and also get timing data for them.
 187  */
 188 struct exynos_drm_manager {
 189         struct device *dev;
 190         int pipe;
 191         struct exynos_drm_manager_ops *ops;
 192         struct exynos_drm_overlay_ops *overlay_ops;
 193         struct exynos_drm_display_ops *display_ops;
 194 };
 195
 196 /*
 197  * Exynos drm private structure.
 198  */
 199 struct exynos_drm_private {
 200         struct drm_fb_helper *fb_helper;
 201
 202         /* list head for new event to be added. */
 203         struct list_head pageflip_event_list;
 204
 205         /*
 206          * created crtc object would be contained at this array and
 207          * this array is used to be aware of which crtc did it request vblank.
 208          */
 209         struct drm_crtc *crtc[MAX_CRTC];
 210 };
 211
 212 /*
 213  * Exynos drm sub driver structure.
 214  *
 215  * @list: sub driver has its own list object to register to exynos drm driver.
 216  * @drm_dev: pointer to drm_device and this pointer would be set
 217  *      when sub driver calls exynos_drm_subdrv_register().
 218  * @probe: this callback would be called by exynos drm driver after
 219  *      subdrv is registered to it.
 220  * @remove: this callback is used to release resources created
 221  *      by probe callback.
 222  * @manager: subdrv has its own manager to control a hardware appropriately
 223  *      and we can access a hardware drawing on this manager.
 224  * @encoder: encoder object owned by this sub driver.
 225  * @connector: connector object owned by this sub driver.
 226  */
 227 struct exynos_drm_subdrv {
 228         struct list_head list;
 229         struct drm_device *drm_dev;
 230
 231         int (*probe)(struct drm_device *drm_dev, struct device *dev);
 232         void (*remove)(struct drm_device *dev);
 233
 234         struct exynos_drm_manager manager;
 235         struct drm_encoder *encoder;
 236         struct drm_connector *connector;
 237 };
 238
 239 /*
 240  * this function calls a probe callback registered to sub driver list and
 241  * create its own encoder and connector and then set drm_device object
 242  * to global one.
 243  */
 244 int exynos_drm_device_register(struct drm_device *dev);
 245 /*
 246  * this function calls a remove callback registered to sub driver list and
 247  * destroy its own encoder and connetor.
 248  */
 249 int exynos_drm_device_unregister(struct drm_device *dev);
 250
 251 /*
 252  * this function would be called by sub drivers such as display controller
 253  * or hdmi driver to register this sub driver object to exynos drm driver
 254  * and when a sub driver is registered to exynos drm driver a probe callback
 255  * of the sub driver is called and creates its own encoder and connector
 256  * and then fb helper and drm mode group would be re-initialized.
 257  */
 258 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
 259
 260 /*
 261  * this function removes subdrv list from exynos drm driver and fb helper
 262  * and drm mode group would be re-initialized.
 263  */
 264 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
 265
 266 #endif