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 DEFAULT_ZPOS    -1
  38
  39 struct drm_device;
  40 struct exynos_drm_overlay;
  41 struct drm_connector;
  42
  43 /* this enumerates display type. */
  44 enum exynos_drm_output_type {
  45         EXYNOS_DISPLAY_TYPE_NONE,
  46         /* RGB or CPU Interface. */
  47         EXYNOS_DISPLAY_TYPE_LCD,
  48         /* HDMI Interface. */
  49         EXYNOS_DISPLAY_TYPE_HDMI,
  50 };
  51
  52 /*
  53  * Exynos drm overlay ops structure.
  54  *
  55  * @mode_set: copy drm overlay info to hw specific overlay info.
  56  * @commit: apply hardware specific overlay data to registers.
  57  * @disable: disable hardware specific overlay.
  58  */
  59 struct exynos_drm_overlay_ops {
  60         void (*mode_set)(struct device *subdrv_dev,
  61                          struct exynos_drm_overlay *overlay);
  62         void (*commit)(struct device *subdrv_dev, int zpos);
  63         void (*disable)(struct device *subdrv_dev, int zpos);
  64 };
  65
  66 /*
  67  * Exynos drm common overlay structure.
  68  *
  69  * @fb_x: offset x on a framebuffer to be displayed.
  70  *      - the unit is screen coordinates.
  71  * @fb_y: offset y on a framebuffer to be displayed.
  72  *      - the unit is screen coordinates.
  73  * @fb_width: width of a framebuffer.
  74  * @fb_height: height of a framebuffer.
  75  * @crtc_x: offset x on hardware screen.
  76  * @crtc_y: offset y on hardware screen.
  77  * @crtc_width: window width to be displayed (hardware screen).
  78  * @crtc_height: window height to be displayed (hardware screen).
  79  * @mode_width: width of screen mode.
  80  * @mode_height: height of screen mode.
  81  * @refresh: refresh rate.
  82  * @scan_flag: interlace or progressive way.
  83  *      (it could be DRM_MODE_FLAG_*)
  84  * @bpp: pixel size.(in bit)
  85  * @dma_addr: bus(accessed by dma) address to the memory region allocated
  86  *      for a overlay.
  87  * @vaddr: virtual memory addresss to this overlay.
  88  * @zpos: order of overlay layer(z position).
  89  * @default_win: a window to be enabled.
  90  * @color_key: color key on or off.
  91  * @index_color: if using color key feature then this value would be used
  92  *                      as index color.
  93  * @local_path: in case of lcd type, local path mode on or off.
  94  * @transparency: transparency on or off.
  95  * @activated: activated or not.
  96  *
  97  * this structure is common to exynos SoC and its contents would be copied
  98  * to hardware specific overlay info.
  99  */
 100 struct exynos_drm_overlay {
 101         unsigned int fb_x;
 102         unsigned int fb_y;
 103         unsigned int fb_width;
 104         unsigned int fb_height;
 105         unsigned int crtc_x;
 106         unsigned int crtc_y;
 107         unsigned int crtc_width;
 108         unsigned int crtc_height;
 109         unsigned int mode_width;
 110         unsigned int mode_height;
 111         unsigned int refresh;
 112         unsigned int scan_flag;
 113         unsigned int bpp;
 114         unsigned int pitch;
 115         dma_addr_t dma_addr;
 116         void __iomem *vaddr;
 117         int zpos;
 118
 119         bool default_win;
 120         bool color_key;
 121         unsigned int index_color;
 122         bool local_path;
 123         bool transparency;
 124         bool activated;
 125 };
 126
 127 /*
 128  * Exynos DRM Display Structure.
 129  *      - this structure is common to analog tv, digital tv and lcd panel.
 130  *
 131  * @type: one of EXYNOS_DISPLAY_TYPE_LCD and HDMI.
 132  * @is_connected: check for that display is connected or not.
 133  * @get_edid: get edid modes from display driver.
 134  * @get_timing: get timing object from display driver.
 135  * @check_timing: check if timing is valid or not.
 136  * @power_on: display device on or off.
 137  */
 138 struct exynos_drm_display_ops {
 139         enum exynos_drm_output_type type;
 140         bool (*is_connected)(struct device *dev);
 141         int (*get_edid)(struct device *dev, struct drm_connector *connector,
 142                                 u8 *edid, int len);
 143         void *(*get_timing)(struct device *dev);
 144         int (*check_timing)(struct device *dev, void *timing);
 145         int (*power_on)(struct device *dev, int mode);
 146 };
 147
 148 /*
 149  * Exynos drm manager ops
 150  *
 151  * @dpms: control device power.
 152  * @apply: set timing, vblank and overlay data to registers.
 153  * @mode_set: convert drm_display_mode to hw specific display mode and
 154  *            would be called by encoder->mode_set().
 155  * @commit: set current hw specific display mode to hw.
 156  * @enable_vblank: specific driver callback for enabling vblank interrupt.
 157  * @disable_vblank: specific driver callback for disabling vblank interrupt.
 158  */
 159 struct exynos_drm_manager_ops {
 160         void (*dpms)(struct device *subdrv_dev, int mode);
 161         void (*apply)(struct device *subdrv_dev);
 162         void (*mode_set)(struct device *subdrv_dev, void *mode);
 163         void (*commit)(struct device *subdrv_dev);
 164         int (*enable_vblank)(struct device *subdrv_dev);
 165         void (*disable_vblank)(struct device *subdrv_dev);
 166 };
 167
 168 /*
 169  * Exynos drm common manager structure.
 170  *
 171  * @dev: pointer to device object for subdrv device driver.
 172  *      sub drivers such as display controller or hdmi driver,
 173  *      have their own device object.
 174  * @ops: pointer to callbacks for exynos drm specific framebuffer.
 175  *      these callbacks should be set by specific drivers such fimd
 176  *      or hdmi driver and are used to control hardware global registers.
 177  * @overlay_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 overlay reigsters.
 180  * @display: 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 display devices such as
 183  *      analog tv, digital tv and lcd panel and also get timing data for them.
 184  */
 185 struct exynos_drm_manager {
 186         struct device *dev;
 187         int pipe;
 188         struct exynos_drm_manager_ops *ops;
 189         struct exynos_drm_overlay_ops *overlay_ops;
 190         struct exynos_drm_display_ops *display_ops;
 191 };
 192
 193 /*
 194  * Exynos drm private structure.
 195  */
 196 struct exynos_drm_private {
 197         struct drm_fb_helper *fb_helper;
 198
 199         /* list head for new event to be added. */
 200         struct list_head pageflip_event_list;
 201
 202         /*
 203          * created crtc object would be contained at this array and
 204          * this array is used to be aware of which crtc did it request vblank.
 205          */
 206         struct drm_crtc *crtc[MAX_CRTC];
 207 };
 208
 209 /*
 210  * Exynos drm sub driver structure.
 211  *
 212  * @list: sub driver has its own list object to register to exynos drm driver.
 213  * @drm_dev: pointer to drm_device and this pointer would be set
 214  *      when sub driver calls exynos_drm_subdrv_register().
 215  * @probe: this callback would be called by exynos drm driver after
 216  *      subdrv is registered to it.
 217  * @remove: this callback is used to release resources created
 218  *      by probe callback.
 219  * @manager: subdrv has its own manager to control a hardware appropriately
 220  *      and we can access a hardware drawing on this manager.
 221  * @encoder: encoder object owned by this sub driver.
 222  * @connector: connector object owned by this sub driver.
 223  */
 224 struct exynos_drm_subdrv {
 225         struct list_head list;
 226         struct drm_device *drm_dev;
 227
 228         int (*probe)(struct drm_device *drm_dev, struct device *dev);
 229         void (*remove)(struct drm_device *dev);
 230
 231         struct exynos_drm_manager manager;
 232         struct drm_encoder *encoder;
 233         struct drm_connector *connector;
 234 };
 235
 236 /*
 237  * this function calls a probe callback registered to sub driver list and
 238  * create its own encoder and connector and then set drm_device object
 239  * to global one.
 240  */
 241 int exynos_drm_device_register(struct drm_device *dev);
 242 /*
 243  * this function calls a remove callback registered to sub driver list and
 244  * destroy its own encoder and connetor.
 245  */
 246 int exynos_drm_device_unregister(struct drm_device *dev);
 247
 248 /*
 249  * this function would be called by sub drivers such as display controller
 250  * or hdmi driver to register this sub driver object to exynos drm driver
 251  * and when a sub driver is registered to exynos drm driver a probe callback
 252  * of the sub driver is called and creates its own encoder and connector
 253  * and then fb helper and drm mode group would be re-initialized.
 254  */
 255 int exynos_drm_subdrv_register(struct exynos_drm_subdrv *drm_subdrv);
 256
 257 /*
 258  * this function removes subdrv list from exynos drm driver and fb helper
 259  * and drm mode group would be re-initialized.
 260  */
 261 int exynos_drm_subdrv_unregister(struct exynos_drm_subdrv *drm_subdrv);
 262
 263 #endif