1a8f8b1d9SDaniel Vetter /*
2a8f8b1d9SDaniel Vetter * Copyright 1999 Precision Insight, Inc., Cedar Park, Texas.
3a8f8b1d9SDaniel Vetter * Copyright 2000 VA Linux Systems, Inc., Sunnyvale, California.
4a8f8b1d9SDaniel Vetter * Copyright (c) 2009-2010, Code Aurora Forum.
5a8f8b1d9SDaniel Vetter * All rights reserved.
6a8f8b1d9SDaniel Vetter *
7a8f8b1d9SDaniel Vetter * Author: Rickard E. (Rik) Faith <faith@valinux.com>
8a8f8b1d9SDaniel Vetter * Author: Gareth Hughes <gareth@valinux.com>
9a8f8b1d9SDaniel Vetter *
10a8f8b1d9SDaniel Vetter * Permission is hereby granted, free of charge, to any person obtaining a
11a8f8b1d9SDaniel Vetter * copy of this software and associated documentation files (the "Software"),
12a8f8b1d9SDaniel Vetter * to deal in the Software without restriction, including without limitation
13a8f8b1d9SDaniel Vetter * the rights to use, copy, modify, merge, publish, distribute, sublicense,
14a8f8b1d9SDaniel Vetter * and/or sell copies of the Software, and to permit persons to whom the
15a8f8b1d9SDaniel Vetter * Software is furnished to do so, subject to the following conditions:
16a8f8b1d9SDaniel Vetter *
17a8f8b1d9SDaniel Vetter * The above copyright notice and this permission notice (including the next
18a8f8b1d9SDaniel Vetter * paragraph) shall be included in all copies or substantial portions of the
19a8f8b1d9SDaniel Vetter * Software.
20a8f8b1d9SDaniel Vetter *
21a8f8b1d9SDaniel Vetter * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22a8f8b1d9SDaniel Vetter * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23a8f8b1d9SDaniel Vetter * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
24a8f8b1d9SDaniel Vetter * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
25a8f8b1d9SDaniel Vetter * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
26a8f8b1d9SDaniel Vetter * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
27a8f8b1d9SDaniel Vetter * OTHER DEALINGS IN THE SOFTWARE.
28a8f8b1d9SDaniel Vetter */
29a8f8b1d9SDaniel Vetter
30a8f8b1d9SDaniel Vetter #ifndef _DRM_FILE_H_
31a8f8b1d9SDaniel Vetter #define _DRM_FILE_H_
32a8f8b1d9SDaniel Vetter
33a8f8b1d9SDaniel Vetter #include <linux/types.h>
34a8f8b1d9SDaniel Vetter #include <linux/completion.h>
3539e23674SJani Nikula #include <linux/idr.h>
36a8f8b1d9SDaniel Vetter
37a8f8b1d9SDaniel Vetter #include <uapi/drm/drm.h>
38a8f8b1d9SDaniel Vetter
39a8f8b1d9SDaniel Vetter #include <drm/drm_prime.h>
40a8f8b1d9SDaniel Vetter
41a8f8b1d9SDaniel Vetter struct dma_fence;
42a8f8b1d9SDaniel Vetter struct drm_file;
43a8f8b1d9SDaniel Vetter struct drm_device;
44686b21b5SRob Clark struct drm_printer;
453ed4351aSDaniel Vetter struct device;
464748aa16SChris Wilson struct file;
47a8f8b1d9SDaniel Vetter
48a8f8b1d9SDaniel Vetter /*
49a8f8b1d9SDaniel Vetter * FIXME: Not sure we want to have drm_minor here in the end, but to avoid
50a8f8b1d9SDaniel Vetter * header include loops we need it here for now.
51a8f8b1d9SDaniel Vetter */
52b93658f8SDaniel Vetter
5303fad56aSSimon Ser /* Note that the values of this enum are ABI (it determines
54c9ac371dSEric Anholt * /dev/dri/renderD* numbers).
552c204f3dSOded Gabbay *
562c204f3dSOded Gabbay * Setting DRM_MINOR_ACCEL to 32 gives enough space for more drm minors to
572c204f3dSOded Gabbay * be implemented before we hit any future
58c9ac371dSEric Anholt */
59a8f8b1d9SDaniel Vetter enum drm_minor_type {
6003fad56aSSimon Ser DRM_MINOR_PRIMARY = 0,
6103fad56aSSimon Ser DRM_MINOR_CONTROL = 1,
6203fad56aSSimon Ser DRM_MINOR_RENDER = 2,
632c204f3dSOded Gabbay DRM_MINOR_ACCEL = 32,
64a8f8b1d9SDaniel Vetter };
65a8f8b1d9SDaniel Vetter
66a8f8b1d9SDaniel Vetter /**
67b93658f8SDaniel Vetter * struct drm_minor - DRM device minor structure
68b93658f8SDaniel Vetter *
69b93658f8SDaniel Vetter * This structure represents a DRM minor number for device nodes in /dev.
70b93658f8SDaniel Vetter * Entirely opaque to drivers and should never be inspected directly by drivers.
71b93658f8SDaniel Vetter * Drivers instead should only interact with &struct drm_file and of course
72b93658f8SDaniel Vetter * &struct drm_device, which is also where driver-private data and resources can
73b93658f8SDaniel Vetter * be attached to.
74a8f8b1d9SDaniel Vetter */
75a8f8b1d9SDaniel Vetter struct drm_minor {
76b93658f8SDaniel Vetter /* private: */
77b93658f8SDaniel Vetter int index; /* Minor device number */
782c204f3dSOded Gabbay int type; /* Control or render or accel */
79b93658f8SDaniel Vetter struct device *kdev; /* Linux device */
80a8f8b1d9SDaniel Vetter struct drm_device *dev;
81a8f8b1d9SDaniel Vetter
82a8f8b1d9SDaniel Vetter struct dentry *debugfs_root;
83a8f8b1d9SDaniel Vetter
84a8f8b1d9SDaniel Vetter struct list_head debugfs_list;
85a8f8b1d9SDaniel Vetter struct mutex debugfs_lock; /* Protects debugfs_list. */
86a8f8b1d9SDaniel Vetter };
87a8f8b1d9SDaniel Vetter
88b93658f8SDaniel Vetter /**
89b93658f8SDaniel Vetter * struct drm_pending_event - Event queued up for userspace to read
90b93658f8SDaniel Vetter *
91b93658f8SDaniel Vetter * This represents a DRM event. Drivers can use this as a generic completion
92b93658f8SDaniel Vetter * mechanism, which supports kernel-internal &struct completion, &struct dma_fence
93b93658f8SDaniel Vetter * and also the DRM-specific &struct drm_event delivery mechanism.
94b93658f8SDaniel Vetter */
95a8f8b1d9SDaniel Vetter struct drm_pending_event {
96b93658f8SDaniel Vetter /**
97b93658f8SDaniel Vetter * @completion:
98b93658f8SDaniel Vetter *
99b93658f8SDaniel Vetter * Optional pointer to a kernel internal completion signalled when
100b93658f8SDaniel Vetter * drm_send_event() is called, useful to internally synchronize with
101b93658f8SDaniel Vetter * nonblocking operations.
102b93658f8SDaniel Vetter */
103a8f8b1d9SDaniel Vetter struct completion *completion;
104b93658f8SDaniel Vetter
105b93658f8SDaniel Vetter /**
106b93658f8SDaniel Vetter * @completion_release:
107b93658f8SDaniel Vetter *
108b93658f8SDaniel Vetter * Optional callback currently only used by the atomic modeset helpers
109b93658f8SDaniel Vetter * to clean up the reference count for the structure @completion is
110b93658f8SDaniel Vetter * stored in.
111b93658f8SDaniel Vetter */
112a8f8b1d9SDaniel Vetter void (*completion_release)(struct completion *completion);
113b93658f8SDaniel Vetter
114b93658f8SDaniel Vetter /**
115b93658f8SDaniel Vetter * @event:
116b93658f8SDaniel Vetter *
117b93658f8SDaniel Vetter * Pointer to the actual event that should be sent to userspace to be
118b93658f8SDaniel Vetter * read using drm_read(). Can be optional, since nowadays events are
119b93658f8SDaniel Vetter * also used to signal kernel internal threads with @completion or DMA
120b93658f8SDaniel Vetter * transactions using @fence.
121b93658f8SDaniel Vetter */
122a8f8b1d9SDaniel Vetter struct drm_event *event;
123b93658f8SDaniel Vetter
124b93658f8SDaniel Vetter /**
125b93658f8SDaniel Vetter * @fence:
126b93658f8SDaniel Vetter *
127b93658f8SDaniel Vetter * Optional DMA fence to unblock other hardware transactions which
128b93658f8SDaniel Vetter * depend upon the nonblocking DRM operation this event represents.
129b93658f8SDaniel Vetter */
130a8f8b1d9SDaniel Vetter struct dma_fence *fence;
131b93658f8SDaniel Vetter
132b93658f8SDaniel Vetter /**
133b93658f8SDaniel Vetter * @file_priv:
134b93658f8SDaniel Vetter *
135b93658f8SDaniel Vetter * &struct drm_file where @event should be delivered to. Only set when
136b93658f8SDaniel Vetter * @event is set.
137b93658f8SDaniel Vetter */
138a8f8b1d9SDaniel Vetter struct drm_file *file_priv;
139b93658f8SDaniel Vetter
140b93658f8SDaniel Vetter /**
141b93658f8SDaniel Vetter * @link:
142b93658f8SDaniel Vetter *
143b93658f8SDaniel Vetter * Double-linked list to keep track of this event. Can be used by the
144b93658f8SDaniel Vetter * driver up to the point when it calls drm_send_event(), after that
145b93658f8SDaniel Vetter * this list entry is owned by the core for its own book-keeping.
146b93658f8SDaniel Vetter */
147b93658f8SDaniel Vetter struct list_head link;
148b93658f8SDaniel Vetter
149b93658f8SDaniel Vetter /**
150b93658f8SDaniel Vetter * @pending_link:
151b93658f8SDaniel Vetter *
152b93658f8SDaniel Vetter * Entry on &drm_file.pending_event_list, to keep track of all pending
153b93658f8SDaniel Vetter * events for @file_priv, to allow correct unwinding of them when
154b93658f8SDaniel Vetter * userspace closes the file before the event is delivered.
155b93658f8SDaniel Vetter */
156b93658f8SDaniel Vetter struct list_head pending_link;
157a8f8b1d9SDaniel Vetter };
158a8f8b1d9SDaniel Vetter
159b93658f8SDaniel Vetter /**
160b93658f8SDaniel Vetter * struct drm_file - DRM file private data
161b93658f8SDaniel Vetter *
162b93658f8SDaniel Vetter * This structure tracks DRM state per open file descriptor.
163b93658f8SDaniel Vetter */
164a8f8b1d9SDaniel Vetter struct drm_file {
165b93658f8SDaniel Vetter /**
166b93658f8SDaniel Vetter * @authenticated:
167b93658f8SDaniel Vetter *
168b93658f8SDaniel Vetter * Whether the client is allowed to submit rendering, which for legacy
169b93658f8SDaniel Vetter * nodes means it must be authenticated.
170b93658f8SDaniel Vetter *
171b93658f8SDaniel Vetter * See also the :ref:`section on primary nodes and authentication
172b93658f8SDaniel Vetter * <drm_primary_node>`.
173b93658f8SDaniel Vetter */
174078b7de4SDaniel Vetter bool authenticated;
175b93658f8SDaniel Vetter
176b93658f8SDaniel Vetter /**
177b93658f8SDaniel Vetter * @stereo_allowed:
178b93658f8SDaniel Vetter *
179b93658f8SDaniel Vetter * True when the client has asked us to expose stereo 3D mode flags.
180b93658f8SDaniel Vetter */
181078b7de4SDaniel Vetter bool stereo_allowed;
182b93658f8SDaniel Vetter
183b93658f8SDaniel Vetter /**
184b93658f8SDaniel Vetter * @universal_planes:
185b93658f8SDaniel Vetter *
186b93658f8SDaniel Vetter * True if client understands CRTC primary planes and cursor planes
187b93658f8SDaniel Vetter * in the plane list. Automatically set when @atomic is set.
188a8f8b1d9SDaniel Vetter */
189078b7de4SDaniel Vetter bool universal_planes;
190b93658f8SDaniel Vetter
191b93658f8SDaniel Vetter /** @atomic: True if client understands atomic properties. */
192078b7de4SDaniel Vetter bool atomic;
193b93658f8SDaniel Vetter
194b93658f8SDaniel Vetter /**
1957595bda2SAnkit Nautiyal * @aspect_ratio_allowed:
1967595bda2SAnkit Nautiyal *
1977595bda2SAnkit Nautiyal * True, if client can handle picture aspect ratios, and has requested
1987595bda2SAnkit Nautiyal * to pass this information along with the mode.
1997595bda2SAnkit Nautiyal */
200078b7de4SDaniel Vetter bool aspect_ratio_allowed;
2017595bda2SAnkit Nautiyal
2027595bda2SAnkit Nautiyal /**
203d67b6a20SLiviu Dudau * @writeback_connectors:
204d67b6a20SLiviu Dudau *
205d67b6a20SLiviu Dudau * True if client understands writeback connectors
206d67b6a20SLiviu Dudau */
207078b7de4SDaniel Vetter bool writeback_connectors;
208d67b6a20SLiviu Dudau
209d67b6a20SLiviu Dudau /**
21045bc3d26SEmil Velikov * @was_master:
21145bc3d26SEmil Velikov *
21245bc3d26SEmil Velikov * This client has or had, master capability. Protected by struct
21345bc3d26SEmil Velikov * &drm_device.master_mutex.
21445bc3d26SEmil Velikov *
21545bc3d26SEmil Velikov * This is used to ensure that CAP_SYS_ADMIN is not enforced, if the
21645bc3d26SEmil Velikov * client is or was master in the past.
21745bc3d26SEmil Velikov */
21845bc3d26SEmil Velikov bool was_master;
21945bc3d26SEmil Velikov
22045bc3d26SEmil Velikov /**
221b93658f8SDaniel Vetter * @is_master:
222b93658f8SDaniel Vetter *
223b93658f8SDaniel Vetter * This client is the creator of @master. Protected by struct
224b93658f8SDaniel Vetter * &drm_device.master_mutex.
225b93658f8SDaniel Vetter *
226b93658f8SDaniel Vetter * See also the :ref:`section on primary nodes and authentication
227b93658f8SDaniel Vetter * <drm_primary_node>`.
228a8f8b1d9SDaniel Vetter */
229078b7de4SDaniel Vetter bool is_master;
230a8f8b1d9SDaniel Vetter
231b93658f8SDaniel Vetter /**
232*87b3b45cSZack Rusin * @supports_virtualized_cursor_plane:
233*87b3b45cSZack Rusin *
234*87b3b45cSZack Rusin * This client is capable of handling the cursor plane with the
235*87b3b45cSZack Rusin * restrictions imposed on it by the virtualized drivers.
236*87b3b45cSZack Rusin *
237*87b3b45cSZack Rusin * This implies that the cursor plane has to behave like a cursor
238*87b3b45cSZack Rusin * i.e. track cursor movement. It also requires setting of the
239*87b3b45cSZack Rusin * hotspot properties by the client on the cursor plane.
240*87b3b45cSZack Rusin */
241*87b3b45cSZack Rusin bool supports_virtualized_cursor_plane;
242*87b3b45cSZack Rusin
243*87b3b45cSZack Rusin /**
244b93658f8SDaniel Vetter * @master:
245b93658f8SDaniel Vetter *
2460b0860a3SDesmond Cheong Zhi Xi * Master this node is currently associated with. Protected by struct
2470b0860a3SDesmond Cheong Zhi Xi * &drm_device.master_mutex, and serialized by @master_lookup_lock.
2480b0860a3SDesmond Cheong Zhi Xi *
2490b0860a3SDesmond Cheong Zhi Xi * Only relevant if drm_is_primary_client() returns true. Note that
2500b0860a3SDesmond Cheong Zhi Xi * this only matches &drm_device.master if the master is the currently
2510b0860a3SDesmond Cheong Zhi Xi * active one.
252b93658f8SDaniel Vetter *
253649839d7SDesmond Cheong Zhi Xi * To update @master, both &drm_device.master_mutex and
254649839d7SDesmond Cheong Zhi Xi * @master_lookup_lock need to be held, therefore holding either of
255649839d7SDesmond Cheong Zhi Xi * them is safe and enough for the read side.
256649839d7SDesmond Cheong Zhi Xi *
25756f0729aSDesmond Cheong Zhi Xi * When dereferencing this pointer, either hold struct
25856f0729aSDesmond Cheong Zhi Xi * &drm_device.master_mutex for the duration of the pointer's use, or
25956f0729aSDesmond Cheong Zhi Xi * use drm_file_get_master() if struct &drm_device.master_mutex is not
26056f0729aSDesmond Cheong Zhi Xi * currently held and there is no other need to hold it. This prevents
26156f0729aSDesmond Cheong Zhi Xi * @master from being freed during use.
26256f0729aSDesmond Cheong Zhi Xi *
263b93658f8SDaniel Vetter * See also @authentication and @is_master and the :ref:`section on
264b93658f8SDaniel Vetter * primary nodes and authentication <drm_primary_node>`.
265b93658f8SDaniel Vetter */
266b93658f8SDaniel Vetter struct drm_master *master;
267a8f8b1d9SDaniel Vetter
26835352081SRandy Dunlap /** @master_lookup_lock: Serializes @master. */
2690b0860a3SDesmond Cheong Zhi Xi spinlock_t master_lookup_lock;
2700b0860a3SDesmond Cheong Zhi Xi
271031ddd28STvrtko Ursulin /**
272031ddd28STvrtko Ursulin * @pid: Process that is using this file.
273031ddd28STvrtko Ursulin *
274031ddd28STvrtko Ursulin * Must only be dereferenced under a rcu_read_lock or equivalent.
275031ddd28STvrtko Ursulin *
276031ddd28STvrtko Ursulin * Updates are guarded with dev->filelist_mutex and reference must be
277031ddd28STvrtko Ursulin * dropped after a RCU grace period to accommodate lockless readers.
278031ddd28STvrtko Ursulin */
279031ddd28STvrtko Ursulin struct pid __rcu *pid;
280b93658f8SDaniel Vetter
2813f09a0cdSRob Clark /** @client_id: A unique id for fdinfo */
2823f09a0cdSRob Clark u64 client_id;
2833f09a0cdSRob Clark
284b93658f8SDaniel Vetter /** @magic: Authentication magic, see @authenticated. */
285b93658f8SDaniel Vetter drm_magic_t magic;
286b93658f8SDaniel Vetter
287b93658f8SDaniel Vetter /**
288b93658f8SDaniel Vetter * @lhead:
289b93658f8SDaniel Vetter *
290b93658f8SDaniel Vetter * List of all open files of a DRM device, linked into
291b93658f8SDaniel Vetter * &drm_device.filelist. Protected by &drm_device.filelist_mutex.
292b93658f8SDaniel Vetter */
293b93658f8SDaniel Vetter struct list_head lhead;
294b93658f8SDaniel Vetter
295b93658f8SDaniel Vetter /** @minor: &struct drm_minor for this file. */
296b93658f8SDaniel Vetter struct drm_minor *minor;
297b93658f8SDaniel Vetter
298b93658f8SDaniel Vetter /**
299b93658f8SDaniel Vetter * @object_idr:
300b93658f8SDaniel Vetter *
301b93658f8SDaniel Vetter * Mapping of mm object handles to object pointers. Used by the GEM
302b93658f8SDaniel Vetter * subsystem. Protected by @table_lock.
303b93658f8SDaniel Vetter */
304a8f8b1d9SDaniel Vetter struct idr object_idr;
305b93658f8SDaniel Vetter
306b93658f8SDaniel Vetter /** @table_lock: Protects @object_idr. */
307a8f8b1d9SDaniel Vetter spinlock_t table_lock;
308a8f8b1d9SDaniel Vetter
309e9083420SDave Airlie /** @syncobj_idr: Mapping of sync object handles to object pointers. */
310e9083420SDave Airlie struct idr syncobj_idr;
311e9083420SDave Airlie /** @syncobj_table_lock: Protects @syncobj_idr. */
312e9083420SDave Airlie spinlock_t syncobj_table_lock;
313e9083420SDave Airlie
314b93658f8SDaniel Vetter /** @filp: Pointer to the core file structure. */
315a8f8b1d9SDaniel Vetter struct file *filp;
316b93658f8SDaniel Vetter
317b93658f8SDaniel Vetter /**
318b93658f8SDaniel Vetter * @driver_priv:
319b93658f8SDaniel Vetter *
320b93658f8SDaniel Vetter * Optional pointer for driver private data. Can be allocated in
321b93658f8SDaniel Vetter * &drm_driver.open and should be freed in &drm_driver.postclose.
322b93658f8SDaniel Vetter */
323a8f8b1d9SDaniel Vetter void *driver_priv;
324a8f8b1d9SDaniel Vetter
325a8f8b1d9SDaniel Vetter /**
326b93658f8SDaniel Vetter * @fbs:
327a8f8b1d9SDaniel Vetter *
328b93658f8SDaniel Vetter * List of &struct drm_framebuffer associated with this file, using the
329b93658f8SDaniel Vetter * &drm_framebuffer.filp_head entry.
330b93658f8SDaniel Vetter *
331b93658f8SDaniel Vetter * Protected by @fbs_lock. Note that the @fbs list holds a reference on
332b93658f8SDaniel Vetter * the framebuffer object to prevent it from untimely disappearing.
333a8f8b1d9SDaniel Vetter */
334a8f8b1d9SDaniel Vetter struct list_head fbs;
335b93658f8SDaniel Vetter
336b93658f8SDaniel Vetter /** @fbs_lock: Protects @fbs. */
337a8f8b1d9SDaniel Vetter struct mutex fbs_lock;
338a8f8b1d9SDaniel Vetter
339b93658f8SDaniel Vetter /**
340b93658f8SDaniel Vetter * @blobs:
341b93658f8SDaniel Vetter *
342b93658f8SDaniel Vetter * User-created blob properties; this retains a reference on the
343b93658f8SDaniel Vetter * property.
344b93658f8SDaniel Vetter *
345b93658f8SDaniel Vetter * Protected by @drm_mode_config.blob_lock;
346b93658f8SDaniel Vetter */
347a8f8b1d9SDaniel Vetter struct list_head blobs;
348a8f8b1d9SDaniel Vetter
349b93658f8SDaniel Vetter /** @event_wait: Waitqueue for new events added to @event_list. */
350a8f8b1d9SDaniel Vetter wait_queue_head_t event_wait;
351b93658f8SDaniel Vetter
352b93658f8SDaniel Vetter /**
353b93658f8SDaniel Vetter * @pending_event_list:
354b93658f8SDaniel Vetter *
355b93658f8SDaniel Vetter * List of pending &struct drm_pending_event, used to clean up pending
356b93658f8SDaniel Vetter * events in case this file gets closed before the event is signalled.
357b93658f8SDaniel Vetter * Uses the &drm_pending_event.pending_link entry.
358b93658f8SDaniel Vetter *
359b93658f8SDaniel Vetter * Protect by &drm_device.event_lock.
360b93658f8SDaniel Vetter */
361a8f8b1d9SDaniel Vetter struct list_head pending_event_list;
362b93658f8SDaniel Vetter
363b93658f8SDaniel Vetter /**
364b93658f8SDaniel Vetter * @event_list:
365b93658f8SDaniel Vetter *
366b93658f8SDaniel Vetter * List of &struct drm_pending_event, ready for delivery to userspace
367b93658f8SDaniel Vetter * through drm_read(). Uses the &drm_pending_event.link entry.
368b93658f8SDaniel Vetter *
369b93658f8SDaniel Vetter * Protect by &drm_device.event_lock.
370b93658f8SDaniel Vetter */
371a8f8b1d9SDaniel Vetter struct list_head event_list;
372b93658f8SDaniel Vetter
373b93658f8SDaniel Vetter /**
374b93658f8SDaniel Vetter * @event_space:
375b93658f8SDaniel Vetter *
376b93658f8SDaniel Vetter * Available event space to prevent userspace from
377b93658f8SDaniel Vetter * exhausting kernel memory. Currently limited to the fairly arbitrary
378b93658f8SDaniel Vetter * value of 4KB.
379b93658f8SDaniel Vetter */
380a8f8b1d9SDaniel Vetter int event_space;
381a8f8b1d9SDaniel Vetter
382b93658f8SDaniel Vetter /** @event_read_lock: Serializes drm_read(). */
383a8f8b1d9SDaniel Vetter struct mutex event_read_lock;
384a8f8b1d9SDaniel Vetter
385b93658f8SDaniel Vetter /**
386b93658f8SDaniel Vetter * @prime:
387b93658f8SDaniel Vetter *
388b93658f8SDaniel Vetter * Per-file buffer caches used by the PRIME buffer sharing code.
389b93658f8SDaniel Vetter */
390a8f8b1d9SDaniel Vetter struct drm_prime_file_private prime;
391b93658f8SDaniel Vetter
392b93658f8SDaniel Vetter /* private: */
393ee22f763SDave Airlie #if IS_ENABLED(CONFIG_DRM_LEGACY)
394b93658f8SDaniel Vetter unsigned long lock_count; /* DRI1 legacy lock count */
395ee22f763SDave Airlie #endif
396a8f8b1d9SDaniel Vetter };
397a8f8b1d9SDaniel Vetter
398b93658f8SDaniel Vetter /**
399b93658f8SDaniel Vetter * drm_is_primary_client - is this an open file of the primary node
400b93658f8SDaniel Vetter * @file_priv: DRM file
401b93658f8SDaniel Vetter *
402b93658f8SDaniel Vetter * Returns true if this is an open file of the primary node, i.e.
403b93658f8SDaniel Vetter * &drm_file.minor of @file_priv is a primary minor.
404b93658f8SDaniel Vetter *
405b93658f8SDaniel Vetter * See also the :ref:`section on primary nodes and authentication
406b93658f8SDaniel Vetter * <drm_primary_node>`.
407b93658f8SDaniel Vetter */
drm_is_primary_client(const struct drm_file * file_priv)408b93658f8SDaniel Vetter static inline bool drm_is_primary_client(const struct drm_file *file_priv)
409b93658f8SDaniel Vetter {
410b93658f8SDaniel Vetter return file_priv->minor->type == DRM_MINOR_PRIMARY;
411b93658f8SDaniel Vetter }
412b93658f8SDaniel Vetter
413b93658f8SDaniel Vetter /**
414b93658f8SDaniel Vetter * drm_is_render_client - is this an open file of the render node
415b93658f8SDaniel Vetter * @file_priv: DRM file
416b93658f8SDaniel Vetter *
417b93658f8SDaniel Vetter * Returns true if this is an open file of the render node, i.e.
418b93658f8SDaniel Vetter * &drm_file.minor of @file_priv is a render minor.
419b93658f8SDaniel Vetter *
420b93658f8SDaniel Vetter * See also the :ref:`section on render nodes <drm_render_node>`.
421b93658f8SDaniel Vetter */
drm_is_render_client(const struct drm_file * file_priv)422a8f8b1d9SDaniel Vetter static inline bool drm_is_render_client(const struct drm_file *file_priv)
423a8f8b1d9SDaniel Vetter {
424a8f8b1d9SDaniel Vetter return file_priv->minor->type == DRM_MINOR_RENDER;
425a8f8b1d9SDaniel Vetter }
426a8f8b1d9SDaniel Vetter
4272c204f3dSOded Gabbay /**
4282c204f3dSOded Gabbay * drm_is_accel_client - is this an open file of the compute acceleration node
4292c204f3dSOded Gabbay * @file_priv: DRM file
4302c204f3dSOded Gabbay *
4312c204f3dSOded Gabbay * Returns true if this is an open file of the compute acceleration node, i.e.
4322c204f3dSOded Gabbay * &drm_file.minor of @file_priv is a accel minor.
4332c204f3dSOded Gabbay *
4346d179f84SBagas Sanjaya * See also :doc:`Introduction to compute accelerators subsystem
4356d179f84SBagas Sanjaya * </accel/introduction>`.
4362c204f3dSOded Gabbay */
drm_is_accel_client(const struct drm_file * file_priv)4372c204f3dSOded Gabbay static inline bool drm_is_accel_client(const struct drm_file *file_priv)
4382c204f3dSOded Gabbay {
4392c204f3dSOded Gabbay return file_priv->minor->type == DRM_MINOR_ACCEL;
4402c204f3dSOded Gabbay }
4412c204f3dSOded Gabbay
442031ddd28STvrtko Ursulin void drm_file_update_pid(struct drm_file *);
443031ddd28STvrtko Ursulin
444a8f8b1d9SDaniel Vetter int drm_open(struct inode *inode, struct file *filp);
4452c204f3dSOded Gabbay int drm_open_helper(struct file *filp, struct drm_minor *minor);
446a8f8b1d9SDaniel Vetter ssize_t drm_read(struct file *filp, char __user *buffer,
447a8f8b1d9SDaniel Vetter size_t count, loff_t *offset);
448a8f8b1d9SDaniel Vetter int drm_release(struct inode *inode, struct file *filp);
4497a2c65ddSChris Wilson int drm_release_noglobal(struct inode *inode, struct file *filp);
450afc9a42bSAl Viro __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait);
451a8f8b1d9SDaniel Vetter int drm_event_reserve_init_locked(struct drm_device *dev,
452a8f8b1d9SDaniel Vetter struct drm_file *file_priv,
453a8f8b1d9SDaniel Vetter struct drm_pending_event *p,
454a8f8b1d9SDaniel Vetter struct drm_event *e);
455a8f8b1d9SDaniel Vetter int drm_event_reserve_init(struct drm_device *dev,
456a8f8b1d9SDaniel Vetter struct drm_file *file_priv,
457a8f8b1d9SDaniel Vetter struct drm_pending_event *p,
458a8f8b1d9SDaniel Vetter struct drm_event *e);
459a8f8b1d9SDaniel Vetter void drm_event_cancel_free(struct drm_device *dev,
460a8f8b1d9SDaniel Vetter struct drm_pending_event *p);
461a8f8b1d9SDaniel Vetter void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e);
462a8f8b1d9SDaniel Vetter void drm_send_event(struct drm_device *dev, struct drm_pending_event *e);
463a78e7a51SVeera Sundaram Sankaran void drm_send_event_timestamp_locked(struct drm_device *dev,
464a78e7a51SVeera Sundaram Sankaran struct drm_pending_event *e,
465a78e7a51SVeera Sundaram Sankaran ktime_t timestamp);
466686b21b5SRob Clark
467686b21b5SRob Clark /**
468686b21b5SRob Clark * struct drm_memory_stats - GEM object stats associated
469686b21b5SRob Clark * @shared: Total size of GEM objects shared between processes
470686b21b5SRob Clark * @private: Total size of GEM objects
471686b21b5SRob Clark * @resident: Total size of GEM objects backing pages
472686b21b5SRob Clark * @purgeable: Total size of GEM objects that can be purged (resident and not active)
473686b21b5SRob Clark * @active: Total size of GEM objects active on one or more engines
474686b21b5SRob Clark *
475686b21b5SRob Clark * Used by drm_print_memory_stats()
476686b21b5SRob Clark */
477686b21b5SRob Clark struct drm_memory_stats {
478686b21b5SRob Clark u64 shared;
479686b21b5SRob Clark u64 private;
480686b21b5SRob Clark u64 resident;
481686b21b5SRob Clark u64 purgeable;
482686b21b5SRob Clark u64 active;
483686b21b5SRob Clark };
484686b21b5SRob Clark
485686b21b5SRob Clark enum drm_gem_object_status;
486686b21b5SRob Clark
487686b21b5SRob Clark void drm_print_memory_stats(struct drm_printer *p,
488686b21b5SRob Clark const struct drm_memory_stats *stats,
489686b21b5SRob Clark enum drm_gem_object_status supported_status,
490686b21b5SRob Clark const char *region);
491686b21b5SRob Clark
492686b21b5SRob Clark void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file);
4933f09a0cdSRob Clark void drm_show_fdinfo(struct seq_file *m, struct file *f);
494a8f8b1d9SDaniel Vetter
4954748aa16SChris Wilson struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags);
4964748aa16SChris Wilson
497a8f8b1d9SDaniel Vetter #endif /* _DRM_FILE_H_ */
498