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