include/drm/drm_file.h

   1 /*
   2  * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
   3  * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
   4  * Copyright (c) 2009-2010, Code Aurora Forum.
   5  * All rights reserved.
   6  *
   7  * Author: Rickard E. (Rik) Faith <faith@valinux.com>
   8  * Author: Gareth Hughes <gareth@valinux.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a
  11  * copy of this software and associated documentation files (the "Software"),
  12  * to deal in the Software without restriction, including without limitation
  13  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  14  * and/or sell copies of the Software, and to permit persons to whom the
  15  * Software is furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice (including the next
  18  * paragraph) shall be included in all copies or substantial portions of the
  19  * Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  24  * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  25  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  26  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  27  * OTHER DEALINGS IN THE SOFTWARE.
  28  */
  29
  30 #ifndef _DRM_FILE_H_
  31 #define _DRM_FILE_H_
  32
  33 #include <linux/types.h>
  34 #include <linux/completion.h>
  35 #include <linux/idr.h>
  36
  37 #include <uapi/drm/drm.h>
  38
  39 #include <drm/drm_prime.h>
  40
  41 struct dma_fence;
  42 struct drm_file;
  43 struct drm_device;
  44 struct device;
  45
  46 /*
  47  * FIXME: Not sure we want to have drm_minor here in the end, but to avoid
  48  * header include loops we need it here for now.
  49  */
  50
  51 /* Note that the order of this enum is ABI (it determines
  52  * /dev/dri/renderD* numbers).
  53  */
  54 enum drm_minor_type {
  55         DRM_MINOR_PRIMARY,
  56         DRM_MINOR_CONTROL,
  57         DRM_MINOR_RENDER,
  58 };
  59
  60 /**
  61  * struct drm_minor - DRM device minor structure
  62  *
  63  * This structure represents a DRM minor number for device nodes in /dev.
  64  * Entirely opaque to drivers and should never be inspected directly by drivers.
  65  * Drivers instead should only interact with &struct drm_file and of course
  66  * &struct drm_device, which is also where driver-private data and resources can
  67  * be attached to.
  68  */
  69 struct drm_minor {
  70         /* private: */
  71         int index;                      /* Minor device number */
  72         int type;                       /* Control or render */
  73         struct device *kdev;            /* Linux device */
  74         struct drm_device *dev;
  75
  76         struct dentry *debugfs_root;
  77
  78         struct list_head debugfs_list;
  79         struct mutex debugfs_lock; /* Protects debugfs_list. */
  80 };
  81
  82 /**
  83  * struct drm_pending_event - Event queued up for userspace to read
  84  *
  85  * This represents a DRM event. Drivers can use this as a generic completion
  86  * mechanism, which supports kernel-internal &struct completion, &struct dma_fence
  87  * and also the DRM-specific &struct drm_event delivery mechanism.
  88  */
  89 struct drm_pending_event {
  90         /**
  91          * @completion:
  92          *
  93          * Optional pointer to a kernel internal completion signalled when
  94          * drm_send_event() is called, useful to internally synchronize with
  95          * nonblocking operations.
  96          */
  97         struct completion *completion;
  98
  99         /**
 100          * @completion_release:
 101          *
 102          * Optional callback currently only used by the atomic modeset helpers
 103          * to clean up the reference count for the structure @completion is
 104          * stored in.
 105          */
 106         void (*completion_release)(struct completion *completion);
 107
 108         /**
 109          * @event:
 110          *
 111          * Pointer to the actual event that should be sent to userspace to be
 112          * read using drm_read(). Can be optional, since nowadays events are
 113          * also used to signal kernel internal threads with @completion or DMA
 114          * transactions using @fence.
 115          */
 116         struct drm_event *event;
 117
 118         /**
 119          * @fence:
 120          *
 121          * Optional DMA fence to unblock other hardware transactions which
 122          * depend upon the nonblocking DRM operation this event represents.
 123          */
 124         struct dma_fence *fence;
 125
 126         /**
 127          * @file_priv:
 128          *
 129          * &struct drm_file where @event should be delivered to. Only set when
 130          * @event is set.
 131          */
 132         struct drm_file *file_priv;
 133
 134         /**
 135          * @link:
 136          *
 137          * Double-linked list to keep track of this event. Can be used by the
 138          * driver up to the point when it calls drm_send_event(), after that
 139          * this list entry is owned by the core for its own book-keeping.
 140          */
 141         struct list_head link;
 142
 143         /**
 144          * @pending_link:
 145          *
 146          * Entry on &drm_file.pending_event_list, to keep track of all pending
 147          * events for @file_priv, to allow correct unwinding of them when
 148          * userspace closes the file before the event is delivered.
 149          */
 150         struct list_head pending_link;
 151 };
 152
 153 /**
 154  * struct drm_file - DRM file private data
 155  *
 156  * This structure tracks DRM state per open file descriptor.
 157  */
 158 struct drm_file {
 159         /**
 160          * @authenticated:
 161          *
 162          * Whether the client is allowed to submit rendering, which for legacy
 163          * nodes means it must be authenticated.
 164          *
 165          * See also the :ref:`section on primary nodes and authentication
 166          * <drm_primary_node>`.
 167          */
 168         bool authenticated;
 169
 170         /**
 171          * @stereo_allowed:
 172          *
 173          * True when the client has asked us to expose stereo 3D mode flags.
 174          */
 175         bool stereo_allowed;
 176
 177         /**
 178          * @universal_planes:
 179          *
 180          * True if client understands CRTC primary planes and cursor planes
 181          * in the plane list. Automatically set when @atomic is set.
 182          */
 183         bool universal_planes;
 184
 185         /** @atomic: True if client understands atomic properties. */
 186         bool atomic;
 187
 188         /**
 189          * @aspect_ratio_allowed:
 190          *
 191          * True, if client can handle picture aspect ratios, and has requested
 192          * to pass this information along with the mode.
 193          */
 194         bool aspect_ratio_allowed;
 195
 196         /**
 197          * @writeback_connectors:
 198          *
 199          * True if client understands writeback connectors
 200          */
 201         bool writeback_connectors;
 202
 203         /**
 204          * @is_master:
 205          *
 206          * This client is the creator of @master. Protected by struct
 207          * &drm_device.master_mutex.
 208          *
 209          * See also the :ref:`section on primary nodes and authentication
 210          * <drm_primary_node>`.
 211          */
 212         bool is_master;
 213
 214         /**
 215          * @master:
 216          *
 217          * Master this node is currently associated with. Only relevant if
 218          * drm_is_primary_client() returns true. Note that this only
 219          * matches &drm_device.master if the master is the currently active one.
 220          *
 221          * See also @authentication and @is_master and the :ref:`section on
 222          * primary nodes and authentication <drm_primary_node>`.
 223          */
 224         struct drm_master *master;
 225
 226         /** @pid: Process that opened this file. */
 227         struct pid *pid;
 228
 229         /** @magic: Authentication magic, see @authenticated. */
 230         drm_magic_t magic;
 231
 232         /**
 233          * @lhead:
 234          *
 235          * List of all open files of a DRM device, linked into
 236          * &drm_device.filelist. Protected by &drm_device.filelist_mutex.
 237          */
 238         struct list_head lhead;
 239
 240         /** @minor: &struct drm_minor for this file. */
 241         struct drm_minor *minor;
 242
 243         /**
 244          * @object_idr:
 245          *
 246          * Mapping of mm object handles to object pointers. Used by the GEM
 247          * subsystem. Protected by @table_lock.
 248          */
 249         struct idr object_idr;
 250
 251         /** @table_lock: Protects @object_idr. */
 252         spinlock_t table_lock;
 253
 254         /** @syncobj_idr: Mapping of sync object handles to object pointers. */
 255         struct idr syncobj_idr;
 256         /** @syncobj_table_lock: Protects @syncobj_idr. */
 257         spinlock_t syncobj_table_lock;
 258
 259         /** @filp: Pointer to the core file structure. */
 260         struct file *filp;
 261
 262         /**
 263          * @driver_priv:
 264          *
 265          * Optional pointer for driver private data. Can be allocated in
 266          * &drm_driver.open and should be freed in &drm_driver.postclose.
 267          */
 268         void *driver_priv;
 269
 270         /**
 271          * @fbs:
 272          *
 273          * List of &struct drm_framebuffer associated with this file, using the
 274          * &drm_framebuffer.filp_head entry.
 275          *
 276          * Protected by @fbs_lock. Note that the @fbs list holds a reference on
 277          * the framebuffer object to prevent it from untimely disappearing.
 278          */
 279         struct list_head fbs;
 280
 281         /** @fbs_lock: Protects @fbs. */
 282         struct mutex fbs_lock;
 283
 284         /**
 285          * @blobs:
 286          *
 287          * User-created blob properties; this retains a reference on the
 288          * property.
 289          *
 290          * Protected by @drm_mode_config.blob_lock;
 291          */
 292         struct list_head blobs;
 293
 294         /** @event_wait: Waitqueue for new events added to @event_list. */
 295         wait_queue_head_t event_wait;
 296
 297         /**
 298          * @pending_event_list:
 299          *
 300          * List of pending &struct drm_pending_event, used to clean up pending
 301          * events in case this file gets closed before the event is signalled.
 302          * Uses the &drm_pending_event.pending_link entry.
 303          *
 304          * Protect by &drm_device.event_lock.
 305          */
 306         struct list_head pending_event_list;
 307
 308         /**
 309          * @event_list:
 310          *
 311          * List of &struct drm_pending_event, ready for delivery to userspace
 312          * through drm_read(). Uses the &drm_pending_event.link entry.
 313          *
 314          * Protect by &drm_device.event_lock.
 315          */
 316         struct list_head event_list;
 317
 318         /**
 319          * @event_space:
 320          *
 321          * Available event space to prevent userspace from
 322          * exhausting kernel memory. Currently limited to the fairly arbitrary
 323          * value of 4KB.
 324          */
 325         int event_space;
 326
 327         /** @event_read_lock: Serializes drm_read(). */
 328         struct mutex event_read_lock;
 329
 330         /**
 331          * @prime:
 332          *
 333          * Per-file buffer caches used by the PRIME buffer sharing code.
 334          */
 335         struct drm_prime_file_private prime;
 336
 337         /* private: */
 338         unsigned long lock_count; /* DRI1 legacy lock count */
 339 };
 340
 341 /**
 342  * drm_is_primary_client - is this an open file of the primary node
 343  * @file_priv: DRM file
 344  *
 345  * Returns true if this is an open file of the primary node, i.e.
 346  * &drm_file.minor of @file_priv is a primary minor.
 347  *
 348  * See also the :ref:`section on primary nodes and authentication
 349  * <drm_primary_node>`.
 350  */
 351 static inline bool drm_is_primary_client(const struct drm_file *file_priv)
 352 {
 353         return file_priv->minor->type == DRM_MINOR_PRIMARY;
 354 }
 355
 356 /**
 357  * drm_is_render_client - is this an open file of the render node
 358  * @file_priv: DRM file
 359  *
 360  * Returns true if this is an open file of the render node, i.e.
 361  * &drm_file.minor of @file_priv is a render minor.
 362  *
 363  * See also the :ref:`section on render nodes <drm_render_node>`.
 364  */
 365 static inline bool drm_is_render_client(const struct drm_file *file_priv)
 366 {
 367         return file_priv->minor->type == DRM_MINOR_RENDER;
 368 }
 369
 370 int drm_open(struct inode *inode, struct file *filp);
 371 ssize_t drm_read(struct file *filp, char __user *buffer,
 372                  size_t count, loff_t *offset);
 373 int drm_release(struct inode *inode, struct file *filp);
 374 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait);
 375 int drm_event_reserve_init_locked(struct drm_device *dev,
 376                                   struct drm_file *file_priv,
 377                                   struct drm_pending_event *p,
 378                                   struct drm_event *e);
 379 int drm_event_reserve_init(struct drm_device *dev,
 380                            struct drm_file *file_priv,
 381                            struct drm_pending_event *p,
 382                            struct drm_event *e);
 383 void drm_event_cancel_free(struct drm_device *dev,
 384                            struct drm_pending_event *p);
 385 void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
 386 void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
 387
 388 #endif /* _DRM_FILE_H_ */