include/drm/drmP.h

   1 /**
   2  * \file drmP.h
   3  * Private header for Direct Rendering Manager
   4  *
   5  * \author Rickard E. (Rik) Faith <faith@valinux.com>
   6  * \author Gareth Hughes <gareth@valinux.com>
   7  */
   8
   9 /*
  10  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
  11  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
  12  * Copyright (c) 2009-2010, Code Aurora Forum.
  13  * All rights reserved.
  14  *
  15  * Permission is hereby granted, free of charge, to any person obtaining a
  16  * copy of this software and associated documentation files (the "Software"),
  17  * to deal in the Software without restriction, including without limitation
  18  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  19  * and/or sell copies of the Software, and to permit persons to whom the
  20  * Software is furnished to do so, subject to the following conditions:
  21  *
  22  * The above copyright notice and this permission notice (including the next
  23  * paragraph) shall be included in all copies or substantial portions of the
  24  * Software.
  25  *
  26  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  27  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  28  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  29  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  30  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  31  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  32  * OTHER DEALINGS IN THE SOFTWARE.
  33  */
  34
  35 #ifndef _DRM_P_H_
  36 #define _DRM_P_H_
  37
  38 #ifdef __KERNEL__
  39 #ifdef __alpha__
  40 /* add include of current.h so that "current" is defined
  41  * before static inline funcs in wait.h. Doing this so we
  42  * can build the DRM (part of PI DRI). 4/21/2000 S + B */
  43 #include <asm/current.h>
  44 #endif                          /* __alpha__ */
  45 #include <linux/kernel.h>
  46 #include <linux/kref.h>
  47 #include <linux/miscdevice.h>
  48 #include <linux/fs.h>
  49 #include <linux/init.h>
  50 #include <linux/file.h>
  51 #include <linux/platform_device.h>
  52 #include <linux/pci.h>
  53 #include <linux/jiffies.h>
  54 #include <linux/dma-mapping.h>
  55 #include <linux/mm.h>
  56 #include <linux/cdev.h>
  57 #include <linux/mutex.h>
  58 #include <linux/io.h>
  59 #include <linux/slab.h>
  60 #include <linux/ratelimit.h>
  61 #if defined(__alpha__) || defined(__powerpc__)
  62 #include <asm/pgtable.h>        /* For pte_wrprotect */
  63 #endif
  64 #include <asm/mman.h>
  65 #include <asm/uaccess.h>
  66 #include <linux/types.h>
  67 #include <linux/agp_backend.h>
  68 #include <linux/workqueue.h>
  69 #include <linux/poll.h>
  70 #include <asm/pgalloc.h>
  71 #include <drm/drm.h>
  72 #include <drm/drm_sarea.h>
  73 #include <drm/drm_vma_manager.h>
  74
  75 #include <linux/idr.h>
  76
  77 #define __OS_HAS_AGP (defined(CONFIG_AGP) || (defined(CONFIG_AGP_MODULE) && defined(MODULE)))
  78
  79 struct module;
  80
  81 struct drm_file;
  82 struct drm_device;
  83
  84 struct device_node;
  85 struct videomode;
  86
  87 #include <drm/drm_os_linux.h>
  88 #include <drm/drm_hashtab.h>
  89 #include <drm/drm_mm.h>
  90
  91 #define DRM_UT_CORE             0x01
  92 #define DRM_UT_DRIVER           0x02
  93 #define DRM_UT_KMS              0x04
  94 #define DRM_UT_PRIME            0x08
  95 /*
  96  * Three debug levels are defined.
  97  * drm_core, drm_driver, drm_kms
  98  * drm_core level can be used in the generic drm code. For example:
  99  *      drm_ioctl, drm_mm, drm_memory
 100  * The macro definition of DRM_DEBUG is used.
 101  *      DRM_DEBUG(fmt, args...)
 102  *      The debug info by using the DRM_DEBUG can be obtained by adding
 103  *      the boot option of "drm.debug=1".
 104  *
 105  * drm_driver level can be used in the specific drm driver. It is used
 106  * to add the debug info related with the drm driver. For example:
 107  * i915_drv, i915_dma, i915_gem, radeon_drv,
 108  *      The macro definition of DRM_DEBUG_DRIVER can be used.
 109  *      DRM_DEBUG_DRIVER(fmt, args...)
 110  *      The debug info by using the DRM_DEBUG_DRIVER can be obtained by
 111  *      adding the boot option of "drm.debug=0x02"
 112  *
 113  * drm_kms level can be used in the KMS code related with specific drm driver.
 114  * It is used to add the debug info related with KMS mode. For example:
 115  * the connector/crtc ,
 116  *      The macro definition of DRM_DEBUG_KMS can be used.
 117  *      DRM_DEBUG_KMS(fmt, args...)
 118  *      The debug info by using the DRM_DEBUG_KMS can be obtained by
 119  *      adding the boot option of "drm.debug=0x04"
 120  *
 121  * If we add the boot option of "drm.debug=0x06", we can get the debug info by
 122  * using the DRM_DEBUG_KMS and DRM_DEBUG_DRIVER.
 123  * If we add the boot option of "drm.debug=0x05", we can get the debug info by
 124  * using the DRM_DEBUG_KMS and DRM_DEBUG.
 125  */
 126
 127 extern __printf(4, 5)
 128 void drm_ut_debug_printk(unsigned int request_level,
 129                          const char *prefix,
 130                          const char *function_name,
 131                          const char *format, ...);
 132 extern __printf(2, 3)
 133 int drm_err(const char *func, const char *format, ...);
 134
 135 /***********************************************************************/
 136 /** \name DRM template customization defaults */
 137 /*@{*/
 138
 139 /* driver capabilities and requirements mask */
 140 #define DRIVER_USE_AGP     0x1
 141 #define DRIVER_PCI_DMA     0x8
 142 #define DRIVER_SG          0x10
 143 #define DRIVER_HAVE_DMA    0x20
 144 #define DRIVER_HAVE_IRQ    0x40
 145 #define DRIVER_IRQ_SHARED  0x80
 146 #define DRIVER_GEM         0x1000
 147 #define DRIVER_MODESET     0x2000
 148 #define DRIVER_PRIME       0x4000
 149 #define DRIVER_RENDER      0x8000
 150
 151 #define DRIVER_BUS_PCI 0x1
 152 #define DRIVER_BUS_PLATFORM 0x2
 153 #define DRIVER_BUS_USB 0x3
 154 #define DRIVER_BUS_HOST1X 0x4
 155
 156 /***********************************************************************/
 157 /** \name Begin the DRM... */
 158 /*@{*/
 159
 160 #define DRM_DEBUG_CODE 2          /**< Include debugging code if > 1, then
 161                                      also include looping detection. */
 162
 163 #define DRM_MAGIC_HASH_ORDER  4  /**< Size of key hash table. Must be power of 2. */
 164 #define DRM_KERNEL_CONTEXT    0  /**< Change drm_resctx if changed */
 165 #define DRM_RESERVED_CONTEXTS 1  /**< Change drm_resctx if changed */
 166
 167 #define DRM_MAP_HASH_OFFSET 0x10000000
 168
 169 /*@}*/
 170
 171 /***********************************************************************/
 172 /** \name Macros to make printk easier */
 173 /*@{*/
 174
 175 /**
 176  * Error output.
 177  *
 178  * \param fmt printf() like format string.
 179  * \param arg arguments
 180  */
 181 #define DRM_ERROR(fmt, ...)                             \
 182         drm_err(__func__, fmt, ##__VA_ARGS__)
 183
 184 /**
 185  * Rate limited error output.  Like DRM_ERROR() but won't flood the log.
 186  *
 187  * \param fmt printf() like format string.
 188  * \param arg arguments
 189  */
 190 #define DRM_ERROR_RATELIMITED(fmt, ...)                         \
 191 ({                                                                      \
 192         static DEFINE_RATELIMIT_STATE(_rs,                              \
 193                                       DEFAULT_RATELIMIT_INTERVAL,       \
 194                                       DEFAULT_RATELIMIT_BURST);         \
 195                                                                         \
 196         if (__ratelimit(&_rs))                                          \
 197                 drm_err(__func__, fmt, ##__VA_ARGS__);                  \
 198 })
 199
 200 #define DRM_INFO(fmt, ...)                              \
 201         printk(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 202
 203 #define DRM_INFO_ONCE(fmt, ...)                         \
 204         printk_once(KERN_INFO "[" DRM_NAME "] " fmt, ##__VA_ARGS__)
 205
 206 /**
 207  * Debug output.
 208  *
 209  * \param fmt printf() like format string.
 210  * \param arg arguments
 211  */
 212 #if DRM_DEBUG_CODE
 213 #define DRM_DEBUG(fmt, args...)                                         \
 214         do {                                                            \
 215                 drm_ut_debug_printk(DRM_UT_CORE, DRM_NAME,              \
 216                                         __func__, fmt, ##args);         \
 217         } while (0)
 218
 219 #define DRM_DEBUG_DRIVER(fmt, args...)                                  \
 220         do {                                                            \
 221                 drm_ut_debug_printk(DRM_UT_DRIVER, DRM_NAME,            \
 222                                         __func__, fmt, ##args);         \
 223         } while (0)
 224 #define DRM_DEBUG_KMS(fmt, args...)                             \
 225         do {                                                            \
 226                 drm_ut_debug_printk(DRM_UT_KMS, DRM_NAME,               \
 227                                          __func__, fmt, ##args);        \
 228         } while (0)
 229 #define DRM_DEBUG_PRIME(fmt, args...)                                   \
 230         do {                                                            \
 231                 drm_ut_debug_printk(DRM_UT_PRIME, DRM_NAME,             \
 232                                         __func__, fmt, ##args);         \
 233         } while (0)
 234 #define DRM_LOG(fmt, args...)                                           \
 235         do {                                                            \
 236                 drm_ut_debug_printk(DRM_UT_CORE, NULL,                  \
 237                                         NULL, fmt, ##args);             \
 238         } while (0)
 239 #define DRM_LOG_KMS(fmt, args...)                                       \
 240         do {                                                            \
 241                 drm_ut_debug_printk(DRM_UT_KMS, NULL,                   \
 242                                         NULL, fmt, ##args);             \
 243         } while (0)
 244 #define DRM_LOG_MODE(fmt, args...)                                      \
 245         do {                                                            \
 246                 drm_ut_debug_printk(DRM_UT_MODE, NULL,                  \
 247                                         NULL, fmt, ##args);             \
 248         } while (0)
 249 #define DRM_LOG_DRIVER(fmt, args...)                                    \
 250         do {                                                            \
 251                 drm_ut_debug_printk(DRM_UT_DRIVER, NULL,                \
 252                                         NULL, fmt, ##args);             \
 253         } while (0)
 254 #else
 255 #define DRM_DEBUG_DRIVER(fmt, args...) do { } while (0)
 256 #define DRM_DEBUG_KMS(fmt, args...)     do { } while (0)
 257 #define DRM_DEBUG_PRIME(fmt, args...)   do { } while (0)
 258 #define DRM_DEBUG(fmt, arg...)           do { } while (0)
 259 #define DRM_LOG(fmt, arg...)            do { } while (0)
 260 #define DRM_LOG_KMS(fmt, args...) do { } while (0)
 261 #define DRM_LOG_MODE(fmt, arg...) do { } while (0)
 262 #define DRM_LOG_DRIVER(fmt, arg...) do { } while (0)
 263
 264 #endif
 265
 266 /*@}*/
 267
 268 /***********************************************************************/
 269 /** \name Internal types and structures */
 270 /*@{*/
 271
 272 #define DRM_ARRAY_SIZE(x) ARRAY_SIZE(x)
 273
 274 #define DRM_IF_VERSION(maj, min) (maj << 16 | min)
 275
 276 /**
 277  * Test that the hardware lock is held by the caller, returning otherwise.
 278  *
 279  * \param dev DRM device.
 280  * \param filp file pointer of the caller.
 281  */
 282 #define LOCK_TEST_WITH_RETURN( dev, _file_priv )                                \
 283 do {                                                                            \
 284         if (!_DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock) ||       \
 285             _file_priv->master->lock.file_priv != _file_priv)   {               \
 286                 DRM_ERROR( "%s called without lock held, held  %d owner %p %p\n",\
 287                            __func__, _DRM_LOCK_IS_HELD(_file_priv->master->lock.hw_lock->lock),\
 288                            _file_priv->master->lock.file_priv, _file_priv);     \
 289                 return -EINVAL;                                                 \
 290         }                                                                       \
 291 } while (0)
 292
 293 /**
 294  * Ioctl function type.
 295  *
 296  * \param inode device inode.
 297  * \param file_priv DRM file private pointer.
 298  * \param cmd command.
 299  * \param arg argument.
 300  */
 301 typedef int drm_ioctl_t(struct drm_device *dev, void *data,
 302                         struct drm_file *file_priv);
 303
 304 typedef int drm_ioctl_compat_t(struct file *filp, unsigned int cmd,
 305                                unsigned long arg);
 306
 307 #define DRM_IOCTL_NR(n)                _IOC_NR(n)
 308 #define DRM_MAJOR       226
 309
 310 #define DRM_AUTH        0x1
 311 #define DRM_MASTER      0x2
 312 #define DRM_ROOT_ONLY   0x4
 313 #define DRM_CONTROL_ALLOW 0x8
 314 #define DRM_UNLOCKED    0x10
 315 #define DRM_RENDER_ALLOW 0x20
 316
 317 struct drm_ioctl_desc {
 318         unsigned int cmd;
 319         int flags;
 320         drm_ioctl_t *func;
 321         unsigned int cmd_drv;
 322         const char *name;
 323 };
 324
 325 /**
 326  * Creates a driver or general drm_ioctl_desc array entry for the given
 327  * ioctl, for use by drm_ioctl().
 328  */
 329
 330 #define DRM_IOCTL_DEF_DRV(ioctl, _func, _flags)                 \
 331         [DRM_IOCTL_NR(DRM_##ioctl)] = {.cmd = DRM_##ioctl, .func = _func, .flags = _flags, .cmd_drv = DRM_IOCTL_##ioctl, .name = #ioctl}
 332
 333 struct drm_magic_entry {
 334         struct list_head head;
 335         struct drm_hash_item hash_item;
 336         struct drm_file *priv;
 337 };
 338
 339 struct drm_vma_entry {
 340         struct list_head head;
 341         struct vm_area_struct *vma;
 342         pid_t pid;
 343 };
 344
 345 /**
 346  * DMA buffer.
 347  */
 348 struct drm_buf {
 349         int idx;                       /**< Index into master buflist */
 350         int total;                     /**< Buffer size */
 351         int order;                     /**< log-base-2(total) */
 352         int used;                      /**< Amount of buffer in use (for DMA) */
 353         unsigned long offset;          /**< Byte offset (used internally) */
 354         void *address;                 /**< Address of buffer */
 355         unsigned long bus_address;     /**< Bus address of buffer */
 356         struct drm_buf *next;          /**< Kernel-only: used for free list */
 357         __volatile__ int waiting;      /**< On kernel DMA queue */
 358         __volatile__ int pending;      /**< On hardware DMA queue */
 359         struct drm_file *file_priv;    /**< Private of holding file descr */
 360         int context;                   /**< Kernel queue for this buffer */
 361         int while_locked;              /**< Dispatch this buffer while locked */
 362         enum {
 363                 DRM_LIST_NONE = 0,
 364                 DRM_LIST_FREE = 1,
 365                 DRM_LIST_WAIT = 2,
 366                 DRM_LIST_PEND = 3,
 367                 DRM_LIST_PRIO = 4,
 368                 DRM_LIST_RECLAIM = 5
 369         } list;                        /**< Which list we're on */
 370
 371         int dev_priv_size;               /**< Size of buffer private storage */
 372         void *dev_private;               /**< Per-buffer private storage */
 373 };
 374
 375 /** bufs is one longer than it has to be */
 376 struct drm_waitlist {
 377         int count;                      /**< Number of possible buffers */
 378         struct drm_buf **bufs;          /**< List of pointers to buffers */
 379         struct drm_buf **rp;                    /**< Read pointer */
 380         struct drm_buf **wp;                    /**< Write pointer */
 381         struct drm_buf **end;           /**< End pointer */
 382         spinlock_t read_lock;
 383         spinlock_t write_lock;
 384 };
 385
 386 struct drm_freelist {
 387         int initialized;               /**< Freelist in use */
 388         atomic_t count;                /**< Number of free buffers */
 389         struct drm_buf *next;          /**< End pointer */
 390
 391         wait_queue_head_t waiting;     /**< Processes waiting on free bufs */
 392         int low_mark;                  /**< Low water mark */
 393         int high_mark;                 /**< High water mark */
 394         atomic_t wfh;                  /**< If waiting for high mark */
 395         spinlock_t lock;
 396 };
 397
 398 typedef struct drm_dma_handle {
 399         dma_addr_t busaddr;
 400         void *vaddr;
 401         size_t size;
 402 } drm_dma_handle_t;
 403
 404 /**
 405  * Buffer entry.  There is one of this for each buffer size order.
 406  */
 407 struct drm_buf_entry {
 408         int buf_size;                   /**< size */
 409         int buf_count;                  /**< number of buffers */
 410         struct drm_buf *buflist;                /**< buffer list */
 411         int seg_count;
 412         int page_order;
 413         struct drm_dma_handle **seglist;
 414
 415         struct drm_freelist freelist;
 416 };
 417
 418 /* Event queued up for userspace to read */
 419 struct drm_pending_event {
 420         struct drm_event *event;
 421         struct list_head link;
 422         struct drm_file *file_priv;
 423         pid_t pid; /* pid of requester, no guarantee it's valid by the time
 424                       we deliver the event, for tracing only */
 425         void (*destroy)(struct drm_pending_event *event);
 426 };
 427
 428 /* initial implementaton using a linked list - todo hashtab */
 429 struct drm_prime_file_private {
 430         struct list_head head;
 431         struct mutex lock;
 432 };
 433
 434 /** File private data */
 435 struct drm_file {
 436         unsigned always_authenticated :1;
 437         unsigned authenticated :1;
 438         /* Whether we're master for a minor. Protected by master_mutex */
 439         unsigned is_master :1;
 440         /* true when the client has asked us to expose stereo 3D mode flags */
 441         unsigned stereo_allowed :1;
 442
 443         struct pid *pid;
 444         kuid_t uid;
 445         drm_magic_t magic;
 446         struct list_head lhead;
 447         struct drm_minor *minor;
 448         unsigned long lock_count;
 449
 450         /** Mapping of mm object handles to object pointers. */
 451         struct idr object_idr;
 452         /** Lock for synchronization of access to object_idr. */
 453         spinlock_t table_lock;
 454
 455         struct file *filp;
 456         void *driver_priv;
 457
 458         struct drm_master *master; /* master this node is currently associated with
 459                                       N.B. not always minor->master */
 460         /**
 461          * fbs - List of framebuffers associated with this file.
 462          *
 463          * Protected by fbs_lock. Note that the fbs list holds a reference on
 464          * the fb object to prevent it from untimely disappearing.
 465          */
 466         struct list_head fbs;
 467         struct mutex fbs_lock;
 468
 469         wait_queue_head_t event_wait;
 470         struct list_head event_list;
 471         int event_space;
 472
 473         struct drm_prime_file_private prime;
 474 };
 475
 476 /** Wait queue */
 477 struct drm_queue {
 478         atomic_t use_count;             /**< Outstanding uses (+1) */
 479         atomic_t finalization;          /**< Finalization in progress */
 480         atomic_t block_count;           /**< Count of processes waiting */
 481         atomic_t block_read;            /**< Queue blocked for reads */
 482         wait_queue_head_t read_queue;   /**< Processes waiting on block_read */
 483         atomic_t block_write;           /**< Queue blocked for writes */
 484         wait_queue_head_t write_queue;  /**< Processes waiting on block_write */
 485         atomic_t total_queued;          /**< Total queued statistic */
 486         atomic_t total_flushed;         /**< Total flushes statistic */
 487         atomic_t total_locks;           /**< Total locks statistics */
 488         enum drm_ctx_flags flags;       /**< Context preserving and 2D-only */
 489         struct drm_waitlist waitlist;   /**< Pending buffers */
 490         wait_queue_head_t flush_queue;  /**< Processes waiting until flush */
 491 };
 492
 493 /**
 494  * Lock data.
 495  */
 496 struct drm_lock_data {
 497         struct drm_hw_lock *hw_lock;    /**< Hardware lock */
 498         /** Private of lock holder's file (NULL=kernel) */
 499         struct drm_file *file_priv;
 500         wait_queue_head_t lock_queue;   /**< Queue of blocked processes */
 501         unsigned long lock_time;        /**< Time of last lock in jiffies */
 502         spinlock_t spinlock;
 503         uint32_t kernel_waiters;
 504         uint32_t user_waiters;
 505         int idle_has_lock;
 506 };
 507
 508 /**
 509  * DMA data.
 510  */
 511 struct drm_device_dma {
 512
 513         struct drm_buf_entry bufs[DRM_MAX_ORDER + 1];   /**< buffers, grouped by their size order */
 514         int buf_count;                  /**< total number of buffers */
 515         struct drm_buf **buflist;               /**< Vector of pointers into drm_device_dma::bufs */
 516         int seg_count;
 517         int page_count;                 /**< number of pages */
 518         unsigned long *pagelist;        /**< page list */
 519         unsigned long byte_count;
 520         enum {
 521                 _DRM_DMA_USE_AGP = 0x01,
 522                 _DRM_DMA_USE_SG = 0x02,
 523                 _DRM_DMA_USE_FB = 0x04,
 524                 _DRM_DMA_USE_PCI_RO = 0x08
 525         } flags;
 526
 527 };
 528
 529 /**
 530  * AGP memory entry.  Stored as a doubly linked list.
 531  */
 532 struct drm_agp_mem {
 533         unsigned long handle;           /**< handle */
 534         struct agp_memory *memory;
 535         unsigned long bound;            /**< address */
 536         int pages;
 537         struct list_head head;
 538 };
 539
 540 /**
 541  * AGP data.
 542  *
 543  * \sa drm_agp_init() and drm_device::agp.
 544  */
 545 struct drm_agp_head {
 546         struct agp_kern_info agp_info;          /**< AGP device information */
 547         struct list_head memory;
 548         unsigned long mode;             /**< AGP mode */
 549         struct agp_bridge_data *bridge;
 550         int enabled;                    /**< whether the AGP bus as been enabled */
 551         int acquired;                   /**< whether the AGP device has been acquired */
 552         unsigned long base;
 553         int agp_mtrr;
 554         int cant_use_aperture;
 555         unsigned long page_mask;
 556 };
 557
 558 /**
 559  * Scatter-gather memory.
 560  */
 561 struct drm_sg_mem {
 562         unsigned long handle;
 563         void *virtual;
 564         int pages;
 565         struct page **pagelist;
 566         dma_addr_t *busaddr;
 567 };
 568
 569 struct drm_sigdata {
 570         int context;
 571         struct drm_hw_lock *lock;
 572 };
 573
 574
 575 /**
 576  * Kernel side of a mapping
 577  */
 578 struct drm_local_map {
 579         resource_size_t offset;  /**< Requested physical address (0 for SAREA)*/
 580         unsigned long size;      /**< Requested physical size (bytes) */
 581         enum drm_map_type type;  /**< Type of memory to map */
 582         enum drm_map_flags flags;        /**< Flags */
 583         void *handle;            /**< User-space: "Handle" to pass to mmap() */
 584                                  /**< Kernel-space: kernel-virtual address */
 585         int mtrr;                /**< MTRR slot used */
 586 };
 587
 588 typedef struct drm_local_map drm_local_map_t;
 589
 590 /**
 591  * Mappings list
 592  */
 593 struct drm_map_list {
 594         struct list_head head;          /**< list head */
 595         struct drm_hash_item hash;
 596         struct drm_local_map *map;      /**< mapping */
 597         uint64_t user_token;
 598         struct drm_master *master;
 599 };
 600
 601 /**
 602  * Context handle list
 603  */
 604 struct drm_ctx_list {
 605         struct list_head head;          /**< list head */
 606         drm_context_t handle;           /**< context handle */
 607         struct drm_file *tag;           /**< associated fd private data */
 608 };
 609
 610 /* location of GART table */
 611 #define DRM_ATI_GART_MAIN 1
 612 #define DRM_ATI_GART_FB   2
 613
 614 #define DRM_ATI_GART_PCI 1
 615 #define DRM_ATI_GART_PCIE 2
 616 #define DRM_ATI_GART_IGP 3
 617
 618 struct drm_ati_pcigart_info {
 619         int gart_table_location;
 620         int gart_reg_if;
 621         void *addr;
 622         dma_addr_t bus_addr;
 623         dma_addr_t table_mask;
 624         struct drm_dma_handle *table_handle;
 625         struct drm_local_map mapping;
 626         int table_size;
 627 };
 628
 629 /**
 630  * This structure defines the drm_mm memory object, which will be used by the
 631  * DRM for its buffer objects.
 632  */
 633 struct drm_gem_object {
 634         /** Reference count of this object */
 635         struct kref refcount;
 636
 637         /**
 638          * handle_count - gem file_priv handle count of this object
 639          *
 640          * Each handle also holds a reference. Note that when the handle_count
 641          * drops to 0 any global names (e.g. the id in the flink namespace) will
 642          * be cleared.
 643          *
 644          * Protected by dev->object_name_lock.
 645          * */
 646         unsigned handle_count;
 647
 648         /** Related drm device */
 649         struct drm_device *dev;
 650
 651         /** File representing the shmem storage */
 652         struct file *filp;
 653
 654         /* Mapping info for this object */
 655         struct drm_vma_offset_node vma_node;
 656
 657         /**
 658          * Size of the object, in bytes.  Immutable over the object's
 659          * lifetime.
 660          */
 661         size_t size;
 662
 663         /**
 664          * Global name for this object, starts at 1. 0 means unnamed.
 665          * Access is covered by the object_name_lock in the related drm_device
 666          */
 667         int name;
 668
 669         /**
 670          * Memory domains. These monitor which caches contain read/write data
 671          * related to the object. When transitioning from one set of domains
 672          * to another, the driver is called to ensure that caches are suitably
 673          * flushed and invalidated
 674          */
 675         uint32_t read_domains;
 676         uint32_t write_domain;
 677
 678         /**
 679          * While validating an exec operation, the
 680          * new read/write domain values are computed here.
 681          * They will be transferred to the above values
 682          * at the point that any cache flushing occurs
 683          */
 684         uint32_t pending_read_domains;
 685         uint32_t pending_write_domain;
 686
 687         /**
 688          * dma_buf - dma buf associated with this GEM object
 689          *
 690          * Pointer to the dma-buf associated with this gem object (either
 691          * through importing or exporting). We break the resulting reference
 692          * loop when the last gem handle for this object is released.
 693          *
 694          * Protected by obj->object_name_lock
 695          */
 696         struct dma_buf *dma_buf;
 697
 698         /**
 699          * import_attach - dma buf attachment backing this object
 700          *
 701          * Any foreign dma_buf imported as a gem object has this set to the
 702          * attachment point for the device. This is invariant over the lifetime
 703          * of a gem object.
 704          *
 705          * The driver's ->gem_free_object callback is responsible for cleaning
 706          * up the dma_buf attachment and references acquired at import time.
 707          *
 708          * Note that the drm gem/prime core does not depend upon drivers setting
 709          * this field any more. So for drivers where this doesn't make sense
 710          * (e.g. virtual devices or a displaylink behind an usb bus) they can
 711          * simply leave it as NULL.
 712          */
 713         struct dma_buf_attachment *import_attach;
 714 };
 715
 716 #include <drm/drm_crtc.h>
 717
 718 /**
 719  * struct drm_master - drm master structure
 720  *
 721  * @refcount: Refcount for this master object.
 722  * @minor: Link back to minor char device we are master for. Immutable.
 723  * @unique: Unique identifier: e.g. busid. Protected by drm_global_mutex.
 724  * @unique_len: Length of unique field. Protected by drm_global_mutex.
 725  * @unique_size: Amount allocated. Protected by drm_global_mutex.
 726  * @magiclist: Hash of used authentication tokens. Protected by struct_mutex.
 727  * @magicfree: List of used authentication tokens. Protected by struct_mutex.
 728  * @lock: DRI lock information.
 729  * @driver_priv: Pointer to driver-private information.
 730  */
 731 struct drm_master {
 732         struct kref refcount;
 733         struct drm_minor *minor;
 734         char *unique;
 735         int unique_len;
 736         int unique_size;
 737         struct drm_open_hash magiclist;
 738         struct list_head magicfree;
 739         struct drm_lock_data lock;
 740         void *driver_priv;
 741 };
 742
 743 /* Size of ringbuffer for vblank timestamps. Just double-buffer
 744  * in initial implementation.
 745  */
 746 #define DRM_VBLANKTIME_RBSIZE 2
 747
 748 /* Flags and return codes for get_vblank_timestamp() driver function. */
 749 #define DRM_CALLED_FROM_VBLIRQ 1
 750 #define DRM_VBLANKTIME_SCANOUTPOS_METHOD (1 << 0)
 751 #define DRM_VBLANKTIME_INVBL             (1 << 1)
 752
 753 /* get_scanout_position() return flags */
 754 #define DRM_SCANOUTPOS_VALID        (1 << 0)
 755 #define DRM_SCANOUTPOS_INVBL        (1 << 1)
 756 #define DRM_SCANOUTPOS_ACCURATE     (1 << 2)
 757
 758 struct drm_bus {
 759         int bus_type;
 760         int (*get_irq)(struct drm_device *dev);
 761         const char *(*get_name)(struct drm_device *dev);
 762         int (*set_busid)(struct drm_device *dev, struct drm_master *master);
 763         int (*set_unique)(struct drm_device *dev, struct drm_master *master,
 764                           struct drm_unique *unique);
 765         int (*irq_by_busid)(struct drm_device *dev, struct drm_irq_busid *p);
 766 };
 767
 768 /**
 769  * DRM driver structure. This structure represent the common code for
 770  * a family of cards. There will one drm_device for each card present
 771  * in this family
 772  */
 773 struct drm_driver {
 774         int (*load) (struct drm_device *, unsigned long flags);
 775         int (*firstopen) (struct drm_device *);
 776         int (*open) (struct drm_device *, struct drm_file *);
 777         void (*preclose) (struct drm_device *, struct drm_file *file_priv);
 778         void (*postclose) (struct drm_device *, struct drm_file *);
 779         void (*lastclose) (struct drm_device *);
 780         int (*unload) (struct drm_device *);
 781         int (*suspend) (struct drm_device *, pm_message_t state);
 782         int (*resume) (struct drm_device *);
 783         int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
 784         int (*dma_quiescent) (struct drm_device *);
 785         int (*context_dtor) (struct drm_device *dev, int context);
 786
 787         /**
 788          * get_vblank_counter - get raw hardware vblank counter
 789          * @dev: DRM device
 790          * @crtc: counter to fetch
 791          *
 792          * Driver callback for fetching a raw hardware vblank counter for @crtc.
 793          * If a device doesn't have a hardware counter, the driver can simply
 794          * return the value of drm_vblank_count. The DRM core will account for
 795          * missed vblank events while interrupts where disabled based on system
 796          * timestamps.
 797          *
 798          * Wraparound handling and loss of events due to modesetting is dealt
 799          * with in the DRM core code.
 800          *
 801          * RETURNS
 802          * Raw vblank counter value.
 803          */
 804         u32 (*get_vblank_counter) (struct drm_device *dev, int crtc);
 805
 806         /**
 807          * enable_vblank - enable vblank interrupt events
 808          * @dev: DRM device
 809          * @crtc: which irq to enable
 810          *
 811          * Enable vblank interrupts for @crtc.  If the device doesn't have
 812          * a hardware vblank counter, this routine should be a no-op, since
 813          * interrupts will have to stay on to keep the count accurate.
 814          *
 815          * RETURNS
 816          * Zero on success, appropriate errno if the given @crtc's vblank
 817          * interrupt cannot be enabled.
 818          */
 819         int (*enable_vblank) (struct drm_device *dev, int crtc);
 820
 821         /**
 822          * disable_vblank - disable vblank interrupt events
 823          * @dev: DRM device
 824          * @crtc: which irq to enable
 825          *
 826          * Disable vblank interrupts for @crtc.  If the device doesn't have
 827          * a hardware vblank counter, this routine should be a no-op, since
 828          * interrupts will have to stay on to keep the count accurate.
 829          */
 830         void (*disable_vblank) (struct drm_device *dev, int crtc);
 831
 832         /**
 833          * Called by \c drm_device_is_agp.  Typically used to determine if a
 834          * card is really attached to AGP or not.
 835          *
 836          * \param dev  DRM device handle
 837          *
 838          * \returns
 839          * One of three values is returned depending on whether or not the
 840          * card is absolutely \b not AGP (return of 0), absolutely \b is AGP
 841          * (return of 1), or may or may not be AGP (return of 2).
 842          */
 843         int (*device_is_agp) (struct drm_device *dev);
 844
 845         /**
 846          * Called by vblank timestamping code.
 847          *
 848          * Return the current display scanout position from a crtc, and an
 849          * optional accurate ktime_get timestamp of when position was measured.
 850          *
 851          * \param dev  DRM device.
 852          * \param crtc Id of the crtc to query.
 853          * \param flags Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
 854          * \param *vpos Target location for current vertical scanout position.
 855          * \param *hpos Target location for current horizontal scanout position.
 856          * \param *stime Target location for timestamp taken immediately before
 857          *               scanout position query. Can be NULL to skip timestamp.
 858          * \param *etime Target location for timestamp taken immediately after
 859          *               scanout position query. Can be NULL to skip timestamp.
 860          *
 861          * Returns vpos as a positive number while in active scanout area.
 862          * Returns vpos as a negative number inside vblank, counting the number
 863          * of scanlines to go until end of vblank, e.g., -1 means "one scanline
 864          * until start of active scanout / end of vblank."
 865          *
 866          * \return Flags, or'ed together as follows:
 867          *
 868          * DRM_SCANOUTPOS_VALID = Query successful.
 869          * DRM_SCANOUTPOS_INVBL = Inside vblank.
 870          * DRM_SCANOUTPOS_ACCURATE = Returned position is accurate. A lack of
 871          * this flag means that returned position may be offset by a constant
 872          * but unknown small number of scanlines wrt. real scanout position.
 873          *
 874          */
 875         int (*get_scanout_position) (struct drm_device *dev, int crtc,
 876                                      unsigned int flags,
 877                                      int *vpos, int *hpos, ktime_t *stime,
 878                                      ktime_t *etime);
 879
 880         /**
 881          * Called by \c drm_get_last_vbltimestamp. Should return a precise
 882          * timestamp when the most recent VBLANK interval ended or will end.
 883          *
 884          * Specifically, the timestamp in @vblank_time should correspond as
 885          * closely as possible to the time when the first video scanline of
 886          * the video frame after the end of VBLANK will start scanning out,
 887          * the time immediately after end of the VBLANK interval. If the
 888          * @crtc is currently inside VBLANK, this will be a time in the future.
 889          * If the @crtc is currently scanning out a frame, this will be the
 890          * past start time of the current scanout. This is meant to adhere
 891          * to the OpenML OML_sync_control extension specification.
 892          *
 893          * \param dev dev DRM device handle.
 894          * \param crtc crtc for which timestamp should be returned.
 895          * \param *max_error Maximum allowable timestamp error in nanoseconds.
 896          *                   Implementation should strive to provide timestamp
 897          *                   with an error of at most *max_error nanoseconds.
 898          *                   Returns true upper bound on error for timestamp.
 899          * \param *vblank_time Target location for returned vblank timestamp.
 900          * \param flags 0 = Defaults, no special treatment needed.
 901          * \param       DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
 902          *              irq handler. Some drivers need to apply some workarounds
 903          *              for gpu-specific vblank irq quirks if flag is set.
 904          *
 905          * \returns
 906          * Zero if timestamping isn't supported in current display mode or a
 907          * negative number on failure. A positive status code on success,
 908          * which describes how the vblank_time timestamp was computed.
 909          */
 910         int (*get_vblank_timestamp) (struct drm_device *dev, int crtc,
 911                                      int *max_error,
 912                                      struct timeval *vblank_time,
 913                                      unsigned flags);
 914
 915         /* these have to be filled in */
 916
 917         irqreturn_t(*irq_handler) (int irq, void *arg);
 918         void (*irq_preinstall) (struct drm_device *dev);
 919         int (*irq_postinstall) (struct drm_device *dev);
 920         void (*irq_uninstall) (struct drm_device *dev);
 921
 922         /* Master routines */
 923         int (*master_create)(struct drm_device *dev, struct drm_master *master);
 924         void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
 925         /**
 926          * master_set is called whenever the minor master is set.
 927          * master_drop is called whenever the minor master is dropped.
 928          */
 929
 930         int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
 931                           bool from_open);
 932         void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv,
 933                             bool from_release);
 934
 935         int (*debugfs_init)(struct drm_minor *minor);
 936         void (*debugfs_cleanup)(struct drm_minor *minor);
 937
 938         /**
 939          * Driver-specific constructor for drm_gem_objects, to set up
 940          * obj->driver_private.
 941          *
 942          * Returns 0 on success.
 943          */
 944         void (*gem_free_object) (struct drm_gem_object *obj);
 945         int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
 946         void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
 947
 948         /* prime: */
 949         /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
 950         int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
 951                                 uint32_t handle, uint32_t flags, int *prime_fd);
 952         /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
 953         int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
 954                                 int prime_fd, uint32_t *handle);
 955         /* export GEM -> dmabuf */
 956         struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
 957                                 struct drm_gem_object *obj, int flags);
 958         /* import dmabuf -> GEM */
 959         struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
 960                                 struct dma_buf *dma_buf);
 961         /* low-level interface used by drm_gem_prime_{import,export} */
 962         int (*gem_prime_pin)(struct drm_gem_object *obj);
 963         void (*gem_prime_unpin)(struct drm_gem_object *obj);
 964         struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
 965         struct drm_gem_object *(*gem_prime_import_sg_table)(
 966                                 struct drm_device *dev, size_t size,
 967                                 struct sg_table *sgt);
 968         void *(*gem_prime_vmap)(struct drm_gem_object *obj);
 969         void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
 970         int (*gem_prime_mmap)(struct drm_gem_object *obj,
 971                                 struct vm_area_struct *vma);
 972
 973         /* vga arb irq handler */
 974         void (*vgaarb_irq)(struct drm_device *dev, bool state);
 975
 976         /* dumb alloc support */
 977         int (*dumb_create)(struct drm_file *file_priv,
 978                            struct drm_device *dev,
 979                            struct drm_mode_create_dumb *args);
 980         int (*dumb_map_offset)(struct drm_file *file_priv,
 981                                struct drm_device *dev, uint32_t handle,
 982                                uint64_t *offset);
 983         int (*dumb_destroy)(struct drm_file *file_priv,
 984                             struct drm_device *dev,
 985                             uint32_t handle);
 986
 987         /* Driver private ops for this object */
 988         const struct vm_operations_struct *gem_vm_ops;
 989
 990         int major;
 991         int minor;
 992         int patchlevel;
 993         char *name;
 994         char *desc;
 995         char *date;
 996
 997         u32 driver_features;
 998         int dev_priv_size;
 999         const struct drm_ioctl_desc *ioctls;
1000         int num_ioctls;
1001         const struct file_operations *fops;
1002         union {
1003                 struct pci_driver *pci;
1004                 struct platform_device *platform_device;
1005                 struct usb_driver *usb;
1006         } kdriver;
1007         struct drm_bus *bus;
1008
1009         /* List of devices hanging off this driver with stealth attach. */
1010         struct list_head legacy_dev_list;
1011 };
1012
1013 #define DRM_MINOR_UNASSIGNED 0
1014 #define DRM_MINOR_LEGACY 1
1015 #define DRM_MINOR_CONTROL 2
1016 #define DRM_MINOR_RENDER 3
1017
1018 /**
1019  * Info file list entry. This structure represents a debugfs or proc file to
1020  * be created by the drm core
1021  */
1022 struct drm_info_list {
1023         const char *name; /** file name */
1024         int (*show)(struct seq_file*, void*); /** show callback */
1025         u32 driver_features; /**< Required driver features for this entry */
1026         void *data;
1027 };
1028
1029 /**
1030  * debugfs node structure. This structure represents a debugfs file.
1031  */
1032 struct drm_info_node {
1033         struct list_head list;
1034         struct drm_minor *minor;
1035         const struct drm_info_list *info_ent;
1036         struct dentry *dent;
1037 };
1038
1039 /**
1040  * DRM minor structure. This structure represents a drm minor number.
1041  */
1042 struct drm_minor {
1043         int index;                      /**< Minor device number */
1044         int type;                       /**< Control or render */
1045         dev_t device;                   /**< Device number for mknod */
1046         struct device *kdev;            /**< Linux device */
1047         struct drm_device *dev;
1048
1049         struct dentry *debugfs_root;
1050
1051         struct list_head debugfs_list;
1052         struct mutex debugfs_lock; /* Protects debugfs_list. */
1053
1054         /* currently active master for this node. Protected by master_mutex */
1055         struct drm_master *master;
1056         struct drm_mode_group mode_group;
1057 };
1058
1059 /* mode specified on the command line */
1060 struct drm_cmdline_mode {
1061         bool specified;
1062         bool refresh_specified;
1063         bool bpp_specified;
1064         int xres, yres;
1065         int bpp;
1066         int refresh;
1067         bool rb;
1068         bool interlace;
1069         bool cvt;
1070         bool margins;
1071         enum drm_connector_force force;
1072 };
1073
1074
1075 struct drm_pending_vblank_event {
1076         struct drm_pending_event base;
1077         int pipe;
1078         struct drm_event_vblank event;
1079 };
1080
1081 struct drm_vblank_crtc {
1082         wait_queue_head_t queue;        /**< VBLANK wait queue */
1083         struct timeval time[DRM_VBLANKTIME_RBSIZE];     /**< timestamp of current count */
1084         atomic_t count;                 /**< number of VBLANK interrupts */
1085         atomic_t refcount;              /* number of users of vblank interruptsper crtc */
1086         u32 last;                       /* protected by dev->vbl_lock, used */
1087                                         /* for wraparound handling */
1088         u32 last_wait;                  /* Last vblank seqno waited per CRTC */
1089         unsigned int inmodeset;         /* Display driver is setting mode */
1090         bool enabled;                   /* so we don't call enable more than
1091                                            once per disable */
1092 };
1093
1094 /**
1095  * DRM device structure. This structure represent a complete card that
1096  * may contain multiple heads.
1097  */
1098 struct drm_device {
1099         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
1100         int if_version;                 /**< Highest interface version set */
1101
1102         /** \name Lifetime Management */
1103         /*@{ */
1104         struct kref ref;                /**< Object ref-count */
1105         struct device *dev;             /**< Device structure of bus-device */
1106         struct drm_driver *driver;      /**< DRM driver managing the device */
1107         void *dev_private;              /**< DRM driver private data */
1108         struct drm_minor *control;      /**< Control node */
1109         struct drm_minor *primary;      /**< Primary node */
1110         struct drm_minor *render;               /**< Render node */
1111         atomic_t unplugged;                     /**< Flag whether dev is dead */
1112         struct inode *anon_inode;               /**< inode for private address-space */
1113         char *unique;                           /**< unique name of the device */
1114         /*@} */
1115
1116         /** \name Locks */
1117         /*@{ */
1118         spinlock_t count_lock;          /**< For inuse, drm_device::open_count, drm_device::buf_use */
1119         struct mutex struct_mutex;      /**< For others */
1120         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
1121         /*@} */
1122
1123         /** \name Usage Counters */
1124         /*@{ */
1125         int open_count;                 /**< Outstanding files open */
1126         int buf_use;                    /**< Buffers in use -- cannot alloc */
1127         atomic_t buf_alloc;             /**< Buffer allocation in progress */
1128         /*@} */
1129
1130         struct list_head filelist;
1131
1132         /** \name Memory management */
1133         /*@{ */
1134         struct list_head maplist;       /**< Linked list of regions */
1135         struct drm_open_hash map_hash;  /**< User token hash table for maps */
1136
1137         /** \name Context handle management */
1138         /*@{ */
1139         struct list_head ctxlist;       /**< Linked list of context handles */
1140         struct mutex ctxlist_mutex;     /**< For ctxlist */
1141
1142         struct idr ctx_idr;
1143
1144         struct list_head vmalist;       /**< List of vmas (for debugging) */
1145
1146         /*@} */
1147
1148         /** \name DMA support */
1149         /*@{ */
1150         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
1151         /*@} */
1152
1153         /** \name Context support */
1154         /*@{ */
1155         bool irq_enabled;               /**< True if irq handler is enabled */
1156         int irq;
1157
1158         __volatile__ long context_flag; /**< Context swapping flag */
1159         int last_context;               /**< Last current context */
1160         /*@} */
1161
1162         /** \name VBLANK IRQ support */
1163         /*@{ */
1164
1165         /*
1166          * At load time, disabling the vblank interrupt won't be allowed since
1167          * old clients may not call the modeset ioctl and therefore misbehave.
1168          * Once the modeset ioctl *has* been called though, we can safely
1169          * disable them when unused.
1170          */
1171         bool vblank_disable_allowed;
1172
1173         /* array of size num_crtcs */
1174         struct drm_vblank_crtc *vblank;
1175
1176         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
1177         spinlock_t vbl_lock;
1178         struct timer_list vblank_disable_timer;
1179
1180         u32 max_vblank_count;           /**< size of vblank counter register */
1181
1182         /**
1183          * List of events
1184          */
1185         struct list_head vblank_event_list;
1186         spinlock_t event_lock;
1187
1188         /*@} */
1189
1190         struct drm_agp_head *agp;       /**< AGP data */
1191
1192         struct pci_dev *pdev;           /**< PCI device structure */
1193 #ifdef __alpha__
1194         struct pci_controller *hose;
1195 #endif
1196
1197         struct platform_device *platformdev; /**< Platform device struture */
1198         struct usb_device *usbdev;
1199
1200         struct drm_sg_mem *sg;  /**< Scatter gather memory */
1201         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
1202         struct drm_sigdata sigdata;        /**< For block_all_signals */
1203         sigset_t sigmask;
1204
1205         struct drm_local_map *agp_buffer_map;
1206         unsigned int agp_buffer_token;
1207
1208         struct drm_mode_config mode_config;     /**< Current mode config */
1209
1210         /** \name GEM information */
1211         /*@{ */
1212         struct mutex object_name_lock;
1213         struct idr object_name_idr;
1214         struct drm_vma_offset_manager *vma_offset_manager;
1215         /*@} */
1216         int switch_power_state;
1217 };
1218
1219 #define DRM_SWITCH_POWER_ON 0
1220 #define DRM_SWITCH_POWER_OFF 1
1221 #define DRM_SWITCH_POWER_CHANGING 2
1222 #define DRM_SWITCH_POWER_DYNAMIC_OFF 3
1223
1224 static __inline__ int drm_core_check_feature(struct drm_device *dev,
1225                                              int feature)
1226 {
1227         return ((dev->driver->driver_features & feature) ? 1 : 0);
1228 }
1229
1230 static inline int drm_dev_to_irq(struct drm_device *dev)
1231 {
1232         return dev->driver->bus->get_irq(dev);
1233 }
1234
1235 static inline void drm_device_set_unplugged(struct drm_device *dev)
1236 {
1237         smp_wmb();
1238         atomic_set(&dev->unplugged, 1);
1239 }
1240
1241 static inline int drm_device_is_unplugged(struct drm_device *dev)
1242 {
1243         int ret = atomic_read(&dev->unplugged);
1244         smp_rmb();
1245         return ret;
1246 }
1247
1248 static inline bool drm_modeset_is_locked(struct drm_device *dev)
1249 {
1250         return mutex_is_locked(&dev->mode_config.mutex);
1251 }
1252
1253 static inline bool drm_is_render_client(const struct drm_file *file_priv)
1254 {
1255         return file_priv->minor->type == DRM_MINOR_RENDER;
1256 }
1257
1258 static inline bool drm_is_control_client(const struct drm_file *file_priv)
1259 {
1260         return file_priv->minor->type == DRM_MINOR_CONTROL;
1261 }
1262
1263 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
1264 {
1265         return file_priv->minor->type == DRM_MINOR_LEGACY;
1266 }
1267
1268 /******************************************************************/
1269 /** \name Internal function definitions */
1270 /*@{*/
1271
1272                                 /* Driver support (drm_drv.h) */
1273 extern long drm_ioctl(struct file *filp,
1274                       unsigned int cmd, unsigned long arg);
1275 extern long drm_compat_ioctl(struct file *filp,
1276                              unsigned int cmd, unsigned long arg);
1277 extern int drm_lastclose(struct drm_device *dev);
1278
1279                                 /* Device support (drm_fops.h) */
1280 extern struct mutex drm_global_mutex;
1281 extern int drm_open(struct inode *inode, struct file *filp);
1282 extern int drm_stub_open(struct inode *inode, struct file *filp);
1283 extern ssize_t drm_read(struct file *filp, char __user *buffer,
1284                         size_t count, loff_t *offset);
1285 extern int drm_release(struct inode *inode, struct file *filp);
1286
1287                                 /* Mapping support (drm_vm.h) */
1288 extern int drm_mmap(struct file *filp, struct vm_area_struct *vma);
1289 extern int drm_mmap_locked(struct file *filp, struct vm_area_struct *vma);
1290 extern void drm_vm_open_locked(struct drm_device *dev, struct vm_area_struct *vma);
1291 extern void drm_vm_close_locked(struct drm_device *dev, struct vm_area_struct *vma);
1292 extern unsigned int drm_poll(struct file *filp, struct poll_table_struct *wait);
1293
1294                                 /* Memory management support (drm_memory.h) */
1295 #include <drm/drm_memory.h>
1296
1297
1298                                 /* Misc. IOCTL support (drm_ioctl.h) */
1299 extern int drm_irq_by_busid(struct drm_device *dev, void *data,
1300                             struct drm_file *file_priv);
1301 extern int drm_getunique(struct drm_device *dev, void *data,
1302                          struct drm_file *file_priv);
1303 extern int drm_setunique(struct drm_device *dev, void *data,
1304                          struct drm_file *file_priv);
1305 extern int drm_getmap(struct drm_device *dev, void *data,
1306                       struct drm_file *file_priv);
1307 extern int drm_getclient(struct drm_device *dev, void *data,
1308                          struct drm_file *file_priv);
1309 extern int drm_getstats(struct drm_device *dev, void *data,
1310                         struct drm_file *file_priv);
1311 extern int drm_getcap(struct drm_device *dev, void *data,
1312                       struct drm_file *file_priv);
1313 extern int drm_setclientcap(struct drm_device *dev, void *data,
1314                             struct drm_file *file_priv);
1315 extern int drm_setversion(struct drm_device *dev, void *data,
1316                           struct drm_file *file_priv);
1317 extern int drm_noop(struct drm_device *dev, void *data,
1318                     struct drm_file *file_priv);
1319
1320                                 /* Context IOCTL support (drm_context.h) */
1321 extern int drm_resctx(struct drm_device *dev, void *data,
1322                       struct drm_file *file_priv);
1323 extern int drm_addctx(struct drm_device *dev, void *data,
1324                       struct drm_file *file_priv);
1325 extern int drm_getctx(struct drm_device *dev, void *data,
1326                       struct drm_file *file_priv);
1327 extern int drm_switchctx(struct drm_device *dev, void *data,
1328                          struct drm_file *file_priv);
1329 extern int drm_newctx(struct drm_device *dev, void *data,
1330                       struct drm_file *file_priv);
1331 extern int drm_rmctx(struct drm_device *dev, void *data,
1332                      struct drm_file *file_priv);
1333
1334 extern int drm_ctxbitmap_init(struct drm_device *dev);
1335 extern void drm_ctxbitmap_cleanup(struct drm_device *dev);
1336 extern void drm_ctxbitmap_free(struct drm_device *dev, int ctx_handle);
1337
1338 extern int drm_setsareactx(struct drm_device *dev, void *data,
1339                            struct drm_file *file_priv);
1340 extern int drm_getsareactx(struct drm_device *dev, void *data,
1341                            struct drm_file *file_priv);
1342
1343                                 /* Authentication IOCTL support (drm_auth.h) */
1344 extern int drm_getmagic(struct drm_device *dev, void *data,
1345                         struct drm_file *file_priv);
1346 extern int drm_authmagic(struct drm_device *dev, void *data,
1347                          struct drm_file *file_priv);
1348 extern int drm_remove_magic(struct drm_master *master, drm_magic_t magic);
1349
1350 /* Cache management (drm_cache.c) */
1351 void drm_clflush_pages(struct page *pages[], unsigned long num_pages);
1352 void drm_clflush_sg(struct sg_table *st);
1353 void drm_clflush_virt_range(char *addr, unsigned long length);
1354
1355                                 /* Locking IOCTL support (drm_lock.h) */
1356 extern int drm_lock(struct drm_device *dev, void *data,
1357                     struct drm_file *file_priv);
1358 extern int drm_unlock(struct drm_device *dev, void *data,
1359                       struct drm_file *file_priv);
1360 extern int drm_lock_free(struct drm_lock_data *lock_data, unsigned int context);
1361 extern void drm_idlelock_take(struct drm_lock_data *lock_data);
1362 extern void drm_idlelock_release(struct drm_lock_data *lock_data);
1363
1364 /*
1365  * These are exported to drivers so that they can implement fencing using
1366  * DMA quiscent + idle. DMA quiescent usually requires the hardware lock.
1367  */
1368
1369 extern int drm_i_have_hw_lock(struct drm_device *dev, struct drm_file *file_priv);
1370
1371                                 /* Buffer management support (drm_bufs.h) */
1372 extern int drm_addbufs_agp(struct drm_device *dev, struct drm_buf_desc * request);
1373 extern int drm_addbufs_pci(struct drm_device *dev, struct drm_buf_desc * request);
1374 extern int drm_addmap(struct drm_device *dev, resource_size_t offset,
1375                       unsigned int size, enum drm_map_type type,
1376                       enum drm_map_flags flags, struct drm_local_map **map_ptr);
1377 extern int drm_addmap_ioctl(struct drm_device *dev, void *data,
1378                             struct drm_file *file_priv);
1379 extern int drm_rmmap(struct drm_device *dev, struct drm_local_map *map);
1380 extern int drm_rmmap_locked(struct drm_device *dev, struct drm_local_map *map);
1381 extern int drm_rmmap_ioctl(struct drm_device *dev, void *data,
1382                            struct drm_file *file_priv);
1383 extern int drm_addbufs(struct drm_device *dev, void *data,
1384                        struct drm_file *file_priv);
1385 extern int drm_infobufs(struct drm_device *dev, void *data,
1386                         struct drm_file *file_priv);
1387 extern int drm_markbufs(struct drm_device *dev, void *data,
1388                         struct drm_file *file_priv);
1389 extern int drm_freebufs(struct drm_device *dev, void *data,
1390                         struct drm_file *file_priv);
1391 extern int drm_mapbufs(struct drm_device *dev, void *data,
1392                        struct drm_file *file_priv);
1393 extern int drm_dma_ioctl(struct drm_device *dev, void *data,
1394                          struct drm_file *file_priv);
1395
1396                                 /* DMA support (drm_dma.h) */
1397 extern int drm_legacy_dma_setup(struct drm_device *dev);
1398 extern void drm_legacy_dma_takedown(struct drm_device *dev);
1399 extern void drm_free_buffer(struct drm_device *dev, struct drm_buf * buf);
1400 extern void drm_core_reclaim_buffers(struct drm_device *dev,
1401                                      struct drm_file *filp);
1402
1403                                 /* IRQ support (drm_irq.h) */
1404 extern int drm_control(struct drm_device *dev, void *data,
1405                        struct drm_file *file_priv);
1406 extern int drm_irq_install(struct drm_device *dev);
1407 extern int drm_irq_uninstall(struct drm_device *dev);
1408
1409 extern int drm_vblank_init(struct drm_device *dev, int num_crtcs);
1410 extern int drm_wait_vblank(struct drm_device *dev, void *data,
1411                            struct drm_file *filp);
1412 extern u32 drm_vblank_count(struct drm_device *dev, int crtc);
1413 extern u32 drm_vblank_count_and_time(struct drm_device *dev, int crtc,
1414                                      struct timeval *vblanktime);
1415 extern void drm_send_vblank_event(struct drm_device *dev, int crtc,
1416                                      struct drm_pending_vblank_event *e);
1417 extern bool drm_handle_vblank(struct drm_device *dev, int crtc);
1418 extern int drm_vblank_get(struct drm_device *dev, int crtc);
1419 extern void drm_vblank_put(struct drm_device *dev, int crtc);
1420 extern void drm_vblank_off(struct drm_device *dev, int crtc);
1421 extern void drm_vblank_cleanup(struct drm_device *dev);
1422 extern u32 drm_get_last_vbltimestamp(struct drm_device *dev, int crtc,
1423                                      struct timeval *tvblank, unsigned flags);
1424 extern int drm_calc_vbltimestamp_from_scanoutpos(struct drm_device *dev,
1425                                                  int crtc, int *max_error,
1426                                                  struct timeval *vblank_time,
1427                                                  unsigned flags,
1428                                                  const struct drm_crtc *refcrtc,
1429                                                  const struct drm_display_mode *mode);
1430 extern void drm_calc_timestamping_constants(struct drm_crtc *crtc,
1431                                             const struct drm_display_mode *mode);
1432
1433 extern bool
1434 drm_mode_parse_command_line_for_connector(const char *mode_option,
1435                                           struct drm_connector *connector,
1436                                           struct drm_cmdline_mode *mode);
1437
1438 extern struct drm_display_mode *
1439 drm_mode_create_from_cmdline_mode(struct drm_device *dev,
1440                                   struct drm_cmdline_mode *cmd);
1441
1442 extern int drm_display_mode_from_videomode(const struct videomode *vm,
1443                                            struct drm_display_mode *dmode);
1444 extern int of_get_drm_display_mode(struct device_node *np,
1445                                    struct drm_display_mode *dmode,
1446                                    int index);
1447
1448 /* Modesetting support */
1449 extern void drm_vblank_pre_modeset(struct drm_device *dev, int crtc);
1450 extern void drm_vblank_post_modeset(struct drm_device *dev, int crtc);
1451 extern int drm_modeset_ctl(struct drm_device *dev, void *data,
1452                            struct drm_file *file_priv);
1453
1454                                 /* AGP/GART support (drm_agpsupport.h) */
1455
1456 #include <drm/drm_agpsupport.h>
1457
1458                                 /* Stub support (drm_stub.h) */
1459 extern int drm_setmaster_ioctl(struct drm_device *dev, void *data,
1460                                struct drm_file *file_priv);
1461 extern int drm_dropmaster_ioctl(struct drm_device *dev, void *data,
1462                                 struct drm_file *file_priv);
1463 struct drm_master *drm_master_create(struct drm_minor *minor);
1464 extern struct drm_master *drm_master_get(struct drm_master *master);
1465 extern void drm_master_put(struct drm_master **master);
1466
1467 extern void drm_put_dev(struct drm_device *dev);
1468 extern void drm_unplug_dev(struct drm_device *dev);
1469 extern unsigned int drm_debug;
1470 extern unsigned int drm_rnodes;
1471
1472 extern unsigned int drm_vblank_offdelay;
1473 extern unsigned int drm_timestamp_precision;
1474 extern unsigned int drm_timestamp_monotonic;
1475
1476 extern struct class *drm_class;
1477 extern struct dentry *drm_debugfs_root;
1478
1479 extern struct idr drm_minors_idr;
1480
1481 extern struct drm_local_map *drm_getsarea(struct drm_device *dev);
1482
1483                                 /* Debugfs support */
1484 #if defined(CONFIG_DEBUG_FS)
1485 extern int drm_debugfs_init(struct drm_minor *minor, int minor_id,
1486                             struct dentry *root);
1487 extern int drm_debugfs_create_files(const struct drm_info_list *files,
1488                                     int count, struct dentry *root,
1489                                     struct drm_minor *minor);
1490 extern int drm_debugfs_remove_files(const struct drm_info_list *files,
1491                                     int count, struct drm_minor *minor);
1492 extern int drm_debugfs_cleanup(struct drm_minor *minor);
1493 #else
1494 static inline int drm_debugfs_init(struct drm_minor *minor, int minor_id,
1495                                    struct dentry *root)
1496 {
1497         return 0;
1498 }
1499
1500 static inline int drm_debugfs_create_files(const struct drm_info_list *files,
1501                                            int count, struct dentry *root,
1502                                            struct drm_minor *minor)
1503 {
1504         return 0;
1505 }
1506
1507 static inline int drm_debugfs_remove_files(const struct drm_info_list *files,
1508                                            int count, struct drm_minor *minor)
1509 {
1510         return 0;
1511 }
1512
1513 static inline int drm_debugfs_cleanup(struct drm_minor *minor)
1514 {
1515         return 0;
1516 }
1517 #endif
1518
1519                                 /* Info file support */
1520 extern int drm_name_info(struct seq_file *m, void *data);
1521 extern int drm_vm_info(struct seq_file *m, void *data);
1522 extern int drm_bufs_info(struct seq_file *m, void *data);
1523 extern int drm_vblank_info(struct seq_file *m, void *data);
1524 extern int drm_clients_info(struct seq_file *m, void* data);
1525 extern int drm_gem_name_info(struct seq_file *m, void *data);
1526
1527
1528 extern struct dma_buf *drm_gem_prime_export(struct drm_device *dev,
1529                 struct drm_gem_object *obj, int flags);
1530 extern int drm_gem_prime_handle_to_fd(struct drm_device *dev,
1531                 struct drm_file *file_priv, uint32_t handle, uint32_t flags,
1532                 int *prime_fd);
1533 extern struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev,
1534                 struct dma_buf *dma_buf);
1535 extern int drm_gem_prime_fd_to_handle(struct drm_device *dev,
1536                 struct drm_file *file_priv, int prime_fd, uint32_t *handle);
1537 extern void drm_gem_dmabuf_release(struct dma_buf *dma_buf);
1538
1539 extern int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data,
1540                                         struct drm_file *file_priv);
1541 extern int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data,
1542                                         struct drm_file *file_priv);
1543
1544 extern int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages,
1545                                             dma_addr_t *addrs, int max_pages);
1546 extern struct sg_table *drm_prime_pages_to_sg(struct page **pages, int nr_pages);
1547 extern void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg);
1548
1549 int drm_gem_dumb_destroy(struct drm_file *file,
1550                          struct drm_device *dev,
1551                          uint32_t handle);
1552
1553 void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv);
1554 void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv);
1555 void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv, struct dma_buf *dma_buf);
1556
1557 #if DRM_DEBUG_CODE
1558 extern int drm_vma_info(struct seq_file *m, void *data);
1559 #endif
1560
1561                                 /* Scatter Gather Support (drm_scatter.h) */
1562 extern void drm_legacy_sg_cleanup(struct drm_device *dev);
1563 extern int drm_sg_alloc(struct drm_device *dev, void *data,
1564                         struct drm_file *file_priv);
1565 extern int drm_sg_free(struct drm_device *dev, void *data,
1566                        struct drm_file *file_priv);
1567
1568                                /* ATI PCIGART support (ati_pcigart.h) */
1569 extern int drm_ati_pcigart_init(struct drm_device *dev,
1570                                 struct drm_ati_pcigart_info * gart_info);
1571 extern int drm_ati_pcigart_cleanup(struct drm_device *dev,
1572                                    struct drm_ati_pcigart_info * gart_info);
1573
1574 extern drm_dma_handle_t *drm_pci_alloc(struct drm_device *dev, size_t size,
1575                                        size_t align);
1576 extern void __drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1577 extern void drm_pci_free(struct drm_device *dev, drm_dma_handle_t * dmah);
1578
1579                                /* sysfs support (drm_sysfs.c) */
1580 struct drm_sysfs_class;
1581 extern struct class *drm_sysfs_create(struct module *owner, char *name);
1582 extern void drm_sysfs_destroy(void);
1583 extern int drm_sysfs_device_add(struct drm_minor *minor);
1584 extern void drm_sysfs_hotplug_event(struct drm_device *dev);
1585 extern void drm_sysfs_device_remove(struct drm_minor *minor);
1586 extern int drm_sysfs_connector_add(struct drm_connector *connector);
1587 extern void drm_sysfs_connector_remove(struct drm_connector *connector);
1588
1589 /* Graphics Execution Manager library functions (drm_gem.c) */
1590 int drm_gem_init(struct drm_device *dev);
1591 void drm_gem_destroy(struct drm_device *dev);
1592 void drm_gem_object_release(struct drm_gem_object *obj);
1593 void drm_gem_object_free(struct kref *kref);
1594 int drm_gem_object_init(struct drm_device *dev,
1595                         struct drm_gem_object *obj, size_t size);
1596 void drm_gem_private_object_init(struct drm_device *dev,
1597                                  struct drm_gem_object *obj, size_t size);
1598 void drm_gem_vm_open(struct vm_area_struct *vma);
1599 void drm_gem_vm_close(struct vm_area_struct *vma);
1600 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
1601                      struct vm_area_struct *vma);
1602 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma);
1603
1604 #include <drm/drm_global.h>
1605
1606 static inline void
1607 drm_gem_object_reference(struct drm_gem_object *obj)
1608 {
1609         kref_get(&obj->refcount);
1610 }
1611
1612 static inline void
1613 drm_gem_object_unreference(struct drm_gem_object *obj)
1614 {
1615         if (obj != NULL)
1616                 kref_put(&obj->refcount, drm_gem_object_free);
1617 }
1618
1619 static inline void
1620 drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
1621 {
1622         if (obj && !atomic_add_unless(&obj->refcount.refcount, -1, 1)) {
1623                 struct drm_device *dev = obj->dev;
1624
1625                 mutex_lock(&dev->struct_mutex);
1626                 if (likely(atomic_dec_and_test(&obj->refcount.refcount)))
1627                         drm_gem_object_free(&obj->refcount);
1628                 mutex_unlock(&dev->struct_mutex);
1629         }
1630 }
1631
1632 int drm_gem_handle_create_tail(struct drm_file *file_priv,
1633                                struct drm_gem_object *obj,
1634                                u32 *handlep);
1635 int drm_gem_handle_create(struct drm_file *file_priv,
1636                           struct drm_gem_object *obj,
1637                           u32 *handlep);
1638 int drm_gem_handle_delete(struct drm_file *filp, u32 handle);
1639
1640
1641 void drm_gem_free_mmap_offset(struct drm_gem_object *obj);
1642 int drm_gem_create_mmap_offset(struct drm_gem_object *obj);
1643 int drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size);
1644
1645 struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask);
1646 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
1647                 bool dirty, bool accessed);
1648
1649 struct drm_gem_object *drm_gem_object_lookup(struct drm_device *dev,
1650                                              struct drm_file *filp,
1651                                              u32 handle);
1652 int drm_gem_close_ioctl(struct drm_device *dev, void *data,
1653                         struct drm_file *file_priv);
1654 int drm_gem_flink_ioctl(struct drm_device *dev, void *data,
1655                         struct drm_file *file_priv);
1656 int drm_gem_open_ioctl(struct drm_device *dev, void *data,
1657                        struct drm_file *file_priv);
1658 void drm_gem_open(struct drm_device *dev, struct drm_file *file_private);
1659 void drm_gem_release(struct drm_device *dev, struct drm_file *file_private);
1660
1661 extern void drm_core_ioremap(struct drm_local_map *map, struct drm_device *dev);
1662 extern void drm_core_ioremap_wc(struct drm_local_map *map, struct drm_device *dev);
1663 extern void drm_core_ioremapfree(struct drm_local_map *map, struct drm_device *dev);
1664
1665 static __inline__ struct drm_local_map *drm_core_findmap(struct drm_device *dev,
1666                                                          unsigned int token)
1667 {
1668         struct drm_map_list *_entry;
1669         list_for_each_entry(_entry, &dev->maplist, head)
1670             if (_entry->user_token == token)
1671                 return _entry->map;
1672         return NULL;
1673 }
1674
1675 static __inline__ void drm_core_dropmap(struct drm_local_map *map)
1676 {
1677 }
1678
1679 #include <drm/drm_mem_util.h>
1680
1681 struct drm_device *drm_dev_alloc(struct drm_driver *driver,
1682                                  struct device *parent);
1683 void drm_dev_ref(struct drm_device *dev);
1684 void drm_dev_unref(struct drm_device *dev);
1685 int drm_dev_register(struct drm_device *dev, unsigned long flags);
1686 void drm_dev_unregister(struct drm_device *dev);
1687 int drm_dev_set_unique(struct drm_device *dev, const char *fmt, ...);
1688
1689 struct drm_minor *drm_minor_acquire(unsigned int minor_id);
1690 void drm_minor_release(struct drm_minor *minor);
1691
1692 /*@}*/
1693
1694 /* PCI section */
1695 static __inline__ int drm_pci_device_is_agp(struct drm_device *dev)
1696 {
1697         if (dev->driver->device_is_agp != NULL) {
1698                 int err = (*dev->driver->device_is_agp) (dev);
1699
1700                 if (err != 2) {
1701                         return err;
1702                 }
1703         }
1704
1705         return pci_find_capability(dev->pdev, PCI_CAP_ID_AGP);
1706 }
1707 void drm_pci_agp_destroy(struct drm_device *dev);
1708
1709 extern int drm_pci_init(struct drm_driver *driver, struct pci_driver *pdriver);
1710 extern void drm_pci_exit(struct drm_driver *driver, struct pci_driver *pdriver);
1711 extern int drm_get_pci_dev(struct pci_dev *pdev,
1712                            const struct pci_device_id *ent,
1713                            struct drm_driver *driver);
1714
1715 #define DRM_PCIE_SPEED_25 1
1716 #define DRM_PCIE_SPEED_50 2
1717 #define DRM_PCIE_SPEED_80 4
1718
1719 extern int drm_pcie_get_speed_cap_mask(struct drm_device *dev, u32 *speed_mask);
1720
1721 /* platform section */
1722 extern int drm_platform_init(struct drm_driver *driver, struct platform_device *platform_device);
1723
1724 /* returns true if currently okay to sleep */
1725 static __inline__ bool drm_can_sleep(void)
1726 {
1727         if (in_atomic() || in_dbg_master() || irqs_disabled())
1728                 return false;
1729         return true;
1730 }
1731
1732 #endif                          /* __KERNEL__ */
1733 #endif