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