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_vram_mm;
  21 struct drm_fb_helper;
  22
  23 struct inode;
  24
  25 struct pci_dev;
  26 struct pci_controller;
  27
  28
  29 /**
  30  * enum drm_switch_power - power state of drm device
  31  */
  32
  33 enum switch_power_state {
  34         /** @DRM_SWITCH_POWER_ON: Power state is ON */
  35         DRM_SWITCH_POWER_ON = 0,
  36
  37         /** @DRM_SWITCH_POWER_OFF: Power state is OFF */
  38         DRM_SWITCH_POWER_OFF = 1,
  39
  40         /** @DRM_SWITCH_POWER_CHANGING: Power state is changing */
  41         DRM_SWITCH_POWER_CHANGING = 2,
  42
  43         /** @DRM_SWITCH_POWER_DYNAMIC_OFF: Suspended */
  44         DRM_SWITCH_POWER_DYNAMIC_OFF = 3,
  45 };
  46
  47 /**
  48  * struct drm_device - DRM device structure
  49  *
  50  * This structure represent a complete card that
  51  * may contain multiple heads.
  52  */
  53 struct drm_device {
  54         /**
  55          * @legacy_dev_list:
  56          *
  57          * List of devices per driver for stealth attach cleanup
  58          */
  59         struct list_head legacy_dev_list;
  60
  61         /** @if_version: Highest interface version set */
  62         int if_version;
  63
  64         /** @ref: Object ref-count */
  65         struct kref ref;
  66
  67         /** @dev: Device structure of bus-device */
  68         struct device *dev;
  69
  70         /**
  71          * @managed:
  72          *
  73          * Managed resources linked to the lifetime of this &drm_device as
  74          * tracked by @ref.
  75          */
  76         struct {
  77                 /** @managed.resources: managed resources list */
  78                 struct list_head resources;
  79                 /** @managed.final_kfree: pointer for final kfree() call */
  80                 void *final_kfree;
  81                 /** @managed.lock: protects @managed.resources */
  82                 spinlock_t lock;
  83         } managed;
  84
  85         /** @driver: DRM driver managing the device */
  86         struct drm_driver *driver;
  87
  88         /**
  89          * @dev_private:
  90          *
  91          * DRM driver private data. This is deprecated and should be left set to
  92          * NULL.
  93          *
  94          * Instead of using this pointer it is recommended that drivers use
  95          * drm_dev_init() and embed struct &drm_device in their larger
  96          * per-device structure.
  97          */
  98         void *dev_private;
  99
 100         /** @primary: Primary node */
 101         struct drm_minor *primary;
 102
 103         /** @render: Render node */
 104         struct drm_minor *render;
 105
 106         /**
 107          * @registered:
 108          *
 109          * Internally used by drm_dev_register() and drm_connector_register().
 110          */
 111         bool registered;
 112
 113         /**
 114          * @master:
 115          *
 116          * Currently active master for this device.
 117          * Protected by &master_mutex
 118          */
 119         struct drm_master *master;
 120
 121         /**
 122          * @driver_features: per-device driver features
 123          *
 124          * Drivers can clear specific flags here to disallow
 125          * certain features on a per-device basis while still
 126          * sharing a single &struct drm_driver instance across
 127          * all devices.
 128          */
 129         u32 driver_features;
 130
 131         /**
 132          * @unplugged:
 133          *
 134          * Flag to tell if the device has been unplugged.
 135          * See drm_dev_enter() and drm_dev_is_unplugged().
 136          */
 137         bool unplugged;
 138
 139         /** @anon_inode: inode for private address-space */
 140         struct inode *anon_inode;
 141
 142         /** @unique: Unique name of the device */
 143         char *unique;
 144
 145         /**
 146          * @struct_mutex:
 147          *
 148          * Lock for others (not &drm_minor.master and &drm_file.is_master)
 149          *
 150          * WARNING:
 151          * Only drivers annotated with DRIVER_LEGACY should be using this.
 152          */
 153         struct mutex struct_mutex;
 154
 155         /**
 156          * @master_mutex:
 157          *
 158          * Lock for &drm_minor.master and &drm_file.is_master
 159          */
 160         struct mutex master_mutex;
 161
 162         /**
 163          * @open_count:
 164          *
 165          * Usage counter for outstanding files open,
 166          * protected by drm_global_mutex
 167          */
 168         atomic_t open_count;
 169
 170         /** @filelist_mutex: Protects @filelist. */
 171         struct mutex filelist_mutex;
 172         /**
 173          * @filelist:
 174          *
 175          * List of userspace clients, linked through &drm_file.lhead.
 176          */
 177         struct list_head filelist;
 178
 179         /**
 180          * @filelist_internal:
 181          *
 182          * List of open DRM files for in-kernel clients.
 183          * Protected by &filelist_mutex.
 184          */
 185         struct list_head filelist_internal;
 186
 187         /**
 188          * @clientlist_mutex:
 189          *
 190          * Protects &clientlist access.
 191          */
 192         struct mutex clientlist_mutex;
 193
 194         /**
 195          * @clientlist:
 196          *
 197          * List of in-kernel clients. Protected by &clientlist_mutex.
 198          */
 199         struct list_head clientlist;
 200
 201         /**
 202          * @irq_enabled:
 203          *
 204          * Indicates that interrupt handling is enabled, specifically vblank
 205          * handling. Drivers which don't use drm_irq_install() need to set this
 206          * to true manually.
 207          */
 208         bool irq_enabled;
 209
 210         /**
 211          * @irq: Used by the drm_irq_install() and drm_irq_unistall() helpers.
 212          */
 213         int irq;
 214
 215         /**
 216          * @vblank_disable_immediate:
 217          *
 218          * If true, vblank interrupt will be disabled immediately when the
 219          * refcount drops to zero, as opposed to via the vblank disable
 220          * timer.
 221          *
 222          * This can be set to true it the hardware has a working vblank counter
 223          * with high-precision timestamping (otherwise there are races) and the
 224          * driver uses drm_crtc_vblank_on() and drm_crtc_vblank_off()
 225          * appropriately. See also @max_vblank_count and
 226          * &drm_crtc_funcs.get_vblank_counter.
 227          */
 228         bool vblank_disable_immediate;
 229
 230         /**
 231          * @vblank:
 232          *
 233          * Array of vblank tracking structures, one per &struct drm_crtc. For
 234          * historical reasons (vblank support predates kernel modesetting) this
 235          * is free-standing and not part of &struct drm_crtc itself. It must be
 236          * initialized explicitly by calling drm_vblank_init().
 237          */
 238         struct drm_vblank_crtc *vblank;
 239
 240         /**
 241          * @vblank_time_lock:
 242          *
 243          *  Protects vblank count and time updates during vblank enable/disable
 244          */
 245         spinlock_t vblank_time_lock;
 246         /**
 247          * @vbl_lock: Top-level vblank references lock, wraps the low-level
 248          * @vblank_time_lock.
 249          */
 250         spinlock_t vbl_lock;
 251
 252         /**
 253          * @max_vblank_count:
 254          *
 255          * Maximum value of the vblank registers. This value +1 will result in a
 256          * wrap-around of the vblank register. It is used by the vblank core to
 257          * handle wrap-arounds.
 258          *
 259          * If set to zero the vblank core will try to guess the elapsed vblanks
 260          * between times when the vblank interrupt is disabled through
 261          * high-precision timestamps. That approach is suffering from small
 262          * races and imprecision over longer time periods, hence exposing a
 263          * hardware vblank counter is always recommended.
 264          *
 265          * This is the statically configured device wide maximum. The driver
 266          * can instead choose to use a runtime configurable per-crtc value
 267          * &drm_vblank_crtc.max_vblank_count, in which case @max_vblank_count
 268          * must be left at zero. See drm_crtc_set_max_vblank_count() on how
 269          * to use the per-crtc value.
 270          *
 271          * If non-zero, &drm_crtc_funcs.get_vblank_counter must be set.
 272          */
 273         u32 max_vblank_count;
 274
 275         /** @vblank_event_list: List of vblank events */
 276         struct list_head vblank_event_list;
 277
 278         /**
 279          * @event_lock:
 280          *
 281          * Protects @vblank_event_list and event delivery in
 282          * general. See drm_send_event() and drm_send_event_locked().
 283          */
 284         spinlock_t event_lock;
 285
 286         /** @agp: AGP data */
 287         struct drm_agp_head *agp;
 288
 289         /** @pdev: PCI device structure */
 290         struct pci_dev *pdev;
 291
 292 #ifdef __alpha__
 293         /** @hose: PCI hose, only used on ALPHA platforms. */
 294         struct pci_controller *hose;
 295 #endif
 296         /** @num_crtcs: Number of CRTCs on this device */
 297         unsigned int num_crtcs;
 298
 299         /** @mode_config: Current mode config */
 300         struct drm_mode_config mode_config;
 301
 302         /** @object_name_lock: GEM information */
 303         struct mutex object_name_lock;
 304
 305         /** @object_name_idr: GEM information */
 306         struct idr object_name_idr;
 307
 308         /** @vma_offset_manager: GEM information */
 309         struct drm_vma_offset_manager *vma_offset_manager;
 310
 311         /** @vram_mm: VRAM MM memory manager */
 312         struct drm_vram_mm *vram_mm;
 313
 314         /**
 315          * @switch_power_state:
 316          *
 317          * Power state of the client.
 318          * Used by drivers supporting the switcheroo driver.
 319          * The state is maintained in the
 320          * &vga_switcheroo_client_ops.set_gpu_state callback
 321          */
 322         enum switch_power_state switch_power_state;
 323
 324         /**
 325          * @fb_helper:
 326          *
 327          * Pointer to the fbdev emulation structure.
 328          * Set by drm_fb_helper_init() and cleared by drm_fb_helper_fini().
 329          */
 330         struct drm_fb_helper *fb_helper;
 331
 332         /* Everything below here is for legacy driver, never use! */
 333         /* private: */
 334 #if IS_ENABLED(CONFIG_DRM_LEGACY)
 335         /* Context handle management - linked list of context handles */
 336         struct list_head ctxlist;
 337
 338         /* Context handle management - mutex for &ctxlist */
 339         struct mutex ctxlist_mutex;
 340
 341         /* Context handle management */
 342         struct idr ctx_idr;
 343
 344         /* Memory management - linked list of regions */
 345         struct list_head maplist;
 346
 347         /* Memory management - user token hash table for maps */
 348         struct drm_open_hash map_hash;
 349
 350         /* Context handle management - list of vmas (for debugging) */
 351         struct list_head vmalist;
 352
 353         /* Optional pointer for DMA support */
 354         struct drm_device_dma *dma;
 355
 356         /* Context swapping flag */
 357         __volatile__ long context_flag;
 358
 359         /* Last current context */
 360         int last_context;
 361
 362         /* Lock for &buf_use and a few other things. */
 363         spinlock_t buf_lock;
 364
 365         /* Usage counter for buffers in use -- cannot alloc */
 366         int buf_use;
 367
 368         /* Buffer allocation in progress */
 369         atomic_t buf_alloc;
 370
 371         struct {
 372                 int context;
 373                 struct drm_hw_lock *lock;
 374         } sigdata;
 375
 376         struct drm_local_map *agp_buffer_map;
 377         unsigned int agp_buffer_token;
 378
 379         /* Scatter gather memory */
 380         struct drm_sg_mem *sg;
 381 #endif
 382 };
 383
 384 #endif