include/drm/drm_device.h

   1 #ifndef _DRM_DEVICE_H_
   2 #define _DRM_DEVICE_H_
   3
   4 #include <linux/list.h>
   5 #include <linux/kref.h>
   6 #include <linux/mutex.h>
   7 #include <linux/idr.h>
   8
   9 #include <drm/drm_hashtab.h>
  10 #include <drm/drm_mode_config.h>
  11
  12 struct drm_driver;
  13 struct drm_minor;
  14 struct drm_master;
  15 struct drm_device_dma;
  16 struct drm_vblank_crtc;
  17 struct drm_sg_mem;
  18 struct drm_local_map;
  19 struct drm_vma_offset_manager;
  20 struct drm_fb_helper;
  21
  22 struct inode;
  23
  24 struct pci_dev;
  25 struct pci_controller;
  26
  27 /**
  28  * DRM device structure. This structure represent a complete card that
  29  * may contain multiple heads.
  30  */
  31 struct drm_device {
  32         struct list_head legacy_dev_list;/**< list of devices per driver for stealth attach cleanup */
  33         int if_version;                 /**< Highest interface version set */
  34
  35         /** \name Lifetime Management */
  36         /*@{ */
  37         struct kref ref;                /**< Object ref-count */
  38         struct device *dev;             /**< Device structure of bus-device */
  39         struct drm_driver *driver;      /**< DRM driver managing the device */
  40         void *dev_private;              /**< DRM driver private data */
  41         struct drm_minor *primary;              /**< Primary node */
  42         struct drm_minor *render;               /**< Render node */
  43         bool registered;
  44
  45         /* currently active master for this device. Protected by master_mutex */
  46         struct drm_master *master;
  47
  48         /**
  49          * @unplugged:
  50          *
  51          * Flag to tell if the device has been unplugged.
  52          * See drm_dev_enter() and drm_dev_is_unplugged().
  53          */
  54         bool unplugged;
  55
  56         struct inode *anon_inode;               /**< inode for private address-space */
  57         char *unique;                           /**< unique name of the device */
  58         /*@} */
  59
  60         /** \name Locks */
  61         /*@{ */
  62         struct mutex struct_mutex;      /**< For others */
  63         struct mutex master_mutex;      /**< For drm_minor::master and drm_file::is_master */
  64         /*@} */
  65
  66         /** \name Usage Counters */
  67         /*@{ */
  68         int open_count;                 /**< Outstanding files open, protected by drm_global_mutex. */
  69         spinlock_t buf_lock;            /**< For drm_device::buf_use and a few other things. */
  70         int buf_use;                    /**< Buffers in use -- cannot alloc */
  71         atomic_t buf_alloc;             /**< Buffer allocation in progress */
  72         /*@} */
  73
  74         struct mutex filelist_mutex;
  75         struct list_head filelist;
  76
  77         /**
  78          * @filelist_internal:
  79          *
  80          * List of open DRM files for in-kernel clients. Protected by @filelist_mutex.
  81          */
  82         struct list_head filelist_internal;
  83
  84         /**
  85          * @clientlist_mutex:
  86          *
  87          * Protects @clientlist access.
  88          */
  89         struct mutex clientlist_mutex;
  90
  91         /**
  92          * @clientlist:
  93          *
  94          * List of in-kernel clients. Protected by @clientlist_mutex.
  95          */
  96         struct list_head clientlist;
  97
  98         /** \name Memory management */
  99         /*@{ */
 100         struct list_head maplist;       /**< Linked list of regions */
 101         struct drm_open_hash map_hash;  /**< User token hash table for maps */
 102
 103         /** \name Context handle management */
 104         /*@{ */
 105         struct list_head ctxlist;       /**< Linked list of context handles */
 106         struct mutex ctxlist_mutex;     /**< For ctxlist */
 107
 108         struct idr ctx_idr;
 109
 110         struct list_head vmalist;       /**< List of vmas (for debugging) */
 111
 112         /*@} */
 113
 114         /** \name DMA support */
 115         /*@{ */
 116         struct drm_device_dma *dma;             /**< Optional pointer for DMA support */
 117         /*@} */
 118
 119         /** \name Context support */
 120         /*@{ */
 121
 122         __volatile__ long context_flag; /**< Context swapping flag */
 123         int last_context;               /**< Last current context */
 124         /*@} */
 125
 126         /**
 127          * @irq_enabled:
 128          *
 129          * Indicates that interrupt handling is enabled, specifically vblank
 130          * handling. Drivers which don't use drm_irq_install() need to set this
 131          * to true manually.
 132          */
 133         bool irq_enabled;
 134         int irq;
 135
 136         /**
 137          * @vblank_disable_immediate:
 138          *
 139          * If true, vblank interrupt will be disabled immediately when the
 140          * refcount drops to zero, as opposed to via the vblank disable
 141          * timer.
 142          *
 143          * This can be set to true it the hardware has a working vblank counter
 144          * with high-precision timestamping (otherwise there are races) and the
 145          * driver uses drm_crtc_vblank_on() and drm_crtc_vblank_off()
 146          * appropriately. See also @max_vblank_count and
 147          * &drm_crtc_funcs.get_vblank_counter.
 148          */
 149         bool vblank_disable_immediate;
 150
 151         /**
 152          * @vblank:
 153          *
 154          * Array of vblank tracking structures, one per &struct drm_crtc. For
 155          * historical reasons (vblank support predates kernel modesetting) this
 156          * is free-standing and not part of &struct drm_crtc itself. It must be
 157          * initialized explicitly by calling drm_vblank_init().
 158          */
 159         struct drm_vblank_crtc *vblank;
 160
 161         spinlock_t vblank_time_lock;    /**< Protects vblank count and time updates during vblank enable/disable */
 162         spinlock_t vbl_lock;
 163
 164         /**
 165          * @max_vblank_count:
 166          *
 167          * Maximum value of the vblank registers. This value +1 will result in a
 168          * wrap-around of the vblank register. It is used by the vblank core to
 169          * handle wrap-arounds.
 170          *
 171          * If set to zero the vblank core will try to guess the elapsed vblanks
 172          * between times when the vblank interrupt is disabled through
 173          * high-precision timestamps. That approach is suffering from small
 174          * races and imprecision over longer time periods, hence exposing a
 175          * hardware vblank counter is always recommended.
 176          *
 177          * This is the statically configured device wide maximum. The driver
 178          * can instead choose to use a runtime configurable per-crtc value
 179          * &drm_vblank_crtc.max_vblank_count, in which case @max_vblank_count
 180          * must be left at zero. See drm_crtc_set_max_vblank_count() on how
 181          * to use the per-crtc value.
 182          *
 183          * If non-zero, &drm_crtc_funcs.get_vblank_counter must be set.
 184          */
 185         u32 max_vblank_count;           /**< size of vblank counter register */
 186
 187         /**
 188          * List of events
 189          */
 190         struct list_head vblank_event_list;
 191         spinlock_t event_lock;
 192
 193         /*@} */
 194
 195         struct drm_agp_head *agp;       /**< AGP data */
 196
 197         struct pci_dev *pdev;           /**< PCI device structure */
 198 #ifdef __alpha__
 199         struct pci_controller *hose;
 200 #endif
 201
 202         struct drm_sg_mem *sg;  /**< Scatter gather memory */
 203         unsigned int num_crtcs;                  /**< Number of CRTCs on this device */
 204
 205         struct {
 206                 int context;
 207                 struct drm_hw_lock *lock;
 208         } sigdata;
 209
 210         struct drm_local_map *agp_buffer_map;
 211         unsigned int agp_buffer_token;
 212
 213         struct drm_mode_config mode_config;     /**< Current mode config */
 214
 215         /** \name GEM information */
 216         /*@{ */
 217         struct mutex object_name_lock;
 218         struct idr object_name_idr;
 219         struct drm_vma_offset_manager *vma_offset_manager;
 220         /*@} */
 221         int switch_power_state;
 222
 223         /**
 224          * @fb_helper:
 225          *
 226          * Pointer to the fbdev emulation structure.
 227          * Set by drm_fb_helper_init() and cleared by drm_fb_helper_fini().
 228          */
 229         struct drm_fb_helper *fb_helper;
 230 };
 231
 232 #endif