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