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 drm_printer; |
45 | struct device; |
46 | struct file; |
47 | |
48 | /* |
49 | * FIXME: Not sure we want to have drm_minor here in the end, but to avoid |
50 | * header include loops we need it here for now. |
51 | */ |
52 | |
53 | /* Note that the values of this enum are ABI (it determines |
54 | * /dev/dri/renderD* numbers). |
55 | * |
56 | * Setting DRM_MINOR_ACCEL to 32 gives enough space for more drm minors to |
57 | * be implemented before we hit any future |
58 | */ |
59 | enum drm_minor_type { |
60 | DRM_MINOR_PRIMARY = 0, |
61 | DRM_MINOR_CONTROL = 1, |
62 | DRM_MINOR_RENDER = 2, |
63 | DRM_MINOR_ACCEL = 32, |
64 | }; |
65 | |
66 | /** |
67 | * struct drm_minor - DRM device minor structure |
68 | * |
69 | * This structure represents a DRM minor number for device nodes in /dev. |
70 | * Entirely opaque to drivers and should never be inspected directly by drivers. |
71 | * Drivers instead should only interact with &struct drm_file and of course |
72 | * &struct drm_device, which is also where driver-private data and resources can |
73 | * be attached to. |
74 | */ |
75 | struct drm_minor { |
76 | /* private: */ |
77 | int index; /* Minor device number */ |
78 | int type; /* Control or render or accel */ |
79 | struct device *kdev; /* Linux device */ |
80 | struct drm_device *dev; |
81 | |
82 | struct dentry *debugfs_symlink; |
83 | struct dentry *debugfs_root; |
84 | }; |
85 | |
86 | /** |
87 | * struct drm_pending_event - Event queued up for userspace to read |
88 | * |
89 | * This represents a DRM event. Drivers can use this as a generic completion |
90 | * mechanism, which supports kernel-internal &struct completion, &struct dma_fence |
91 | * and also the DRM-specific &struct drm_event delivery mechanism. |
92 | */ |
93 | struct drm_pending_event { |
94 | /** |
95 | * @completion: |
96 | * |
97 | * Optional pointer to a kernel internal completion signalled when |
98 | * drm_send_event() is called, useful to internally synchronize with |
99 | * nonblocking operations. |
100 | */ |
101 | struct completion *completion; |
102 | |
103 | /** |
104 | * @completion_release: |
105 | * |
106 | * Optional callback currently only used by the atomic modeset helpers |
107 | * to clean up the reference count for the structure @completion is |
108 | * stored in. |
109 | */ |
110 | void (*completion_release)(struct completion *completion); |
111 | |
112 | /** |
113 | * @event: |
114 | * |
115 | * Pointer to the actual event that should be sent to userspace to be |
116 | * read using drm_read(). Can be optional, since nowadays events are |
117 | * also used to signal kernel internal threads with @completion or DMA |
118 | * transactions using @fence. |
119 | */ |
120 | struct drm_event *event; |
121 | |
122 | /** |
123 | * @fence: |
124 | * |
125 | * Optional DMA fence to unblock other hardware transactions which |
126 | * depend upon the nonblocking DRM operation this event represents. |
127 | */ |
128 | struct dma_fence *fence; |
129 | |
130 | /** |
131 | * @file_priv: |
132 | * |
133 | * &struct drm_file where @event should be delivered to. Only set when |
134 | * @event is set. |
135 | */ |
136 | struct drm_file *file_priv; |
137 | |
138 | /** |
139 | * @link: |
140 | * |
141 | * Double-linked list to keep track of this event. Can be used by the |
142 | * driver up to the point when it calls drm_send_event(), after that |
143 | * this list entry is owned by the core for its own book-keeping. |
144 | */ |
145 | struct list_head link; |
146 | |
147 | /** |
148 | * @pending_link: |
149 | * |
150 | * Entry on &drm_file.pending_event_list, to keep track of all pending |
151 | * events for @file_priv, to allow correct unwinding of them when |
152 | * userspace closes the file before the event is delivered. |
153 | */ |
154 | struct list_head pending_link; |
155 | }; |
156 | |
157 | /** |
158 | * struct drm_file - DRM file private data |
159 | * |
160 | * This structure tracks DRM state per open file descriptor. |
161 | */ |
162 | struct drm_file { |
163 | /** |
164 | * @authenticated: |
165 | * |
166 | * Whether the client is allowed to submit rendering, which for legacy |
167 | * nodes means it must be authenticated. |
168 | * |
169 | * See also the :ref:`section on primary nodes and authentication |
170 | * <drm_primary_node>`. |
171 | */ |
172 | bool authenticated; |
173 | |
174 | /** |
175 | * @stereo_allowed: |
176 | * |
177 | * True when the client has asked us to expose stereo 3D mode flags. |
178 | */ |
179 | bool stereo_allowed; |
180 | |
181 | /** |
182 | * @universal_planes: |
183 | * |
184 | * True if client understands CRTC primary planes and cursor planes |
185 | * in the plane list. Automatically set when @atomic is set. |
186 | */ |
187 | bool universal_planes; |
188 | |
189 | /** @atomic: True if client understands atomic properties. */ |
190 | bool atomic; |
191 | |
192 | /** |
193 | * @aspect_ratio_allowed: |
194 | * |
195 | * True, if client can handle picture aspect ratios, and has requested |
196 | * to pass this information along with the mode. |
197 | */ |
198 | bool aspect_ratio_allowed; |
199 | |
200 | /** |
201 | * @writeback_connectors: |
202 | * |
203 | * True if client understands writeback connectors |
204 | */ |
205 | bool writeback_connectors; |
206 | |
207 | /** |
208 | * @was_master: |
209 | * |
210 | * This client has or had, master capability. Protected by struct |
211 | * &drm_device.master_mutex. |
212 | * |
213 | * This is used to ensure that CAP_SYS_ADMIN is not enforced, if the |
214 | * client is or was master in the past. |
215 | */ |
216 | bool was_master; |
217 | |
218 | /** |
219 | * @is_master: |
220 | * |
221 | * This client is the creator of @master. Protected by struct |
222 | * &drm_device.master_mutex. |
223 | * |
224 | * See also the :ref:`section on primary nodes and authentication |
225 | * <drm_primary_node>`. |
226 | */ |
227 | bool is_master; |
228 | |
229 | /** |
230 | * @master: |
231 | * |
232 | * Master this node is currently associated with. Protected by struct |
233 | * &drm_device.master_mutex, and serialized by @master_lookup_lock. |
234 | * |
235 | * Only relevant if drm_is_primary_client() returns true. Note that |
236 | * this only matches &drm_device.master if the master is the currently |
237 | * active one. |
238 | * |
239 | * To update @master, both &drm_device.master_mutex and |
240 | * @master_lookup_lock need to be held, therefore holding either of |
241 | * them is safe and enough for the read side. |
242 | * |
243 | * When dereferencing this pointer, either hold struct |
244 | * &drm_device.master_mutex for the duration of the pointer's use, or |
245 | * use drm_file_get_master() if struct &drm_device.master_mutex is not |
246 | * currently held and there is no other need to hold it. This prevents |
247 | * @master from being freed during use. |
248 | * |
249 | * See also @authentication and @is_master and the :ref:`section on |
250 | * primary nodes and authentication <drm_primary_node>`. |
251 | */ |
252 | struct drm_master *master; |
253 | |
254 | /** @master_lookup_lock: Serializes @master. */ |
255 | spinlock_t master_lookup_lock; |
256 | |
257 | /** |
258 | * @pid: Process that is using this file. |
259 | * |
260 | * Must only be dereferenced under a rcu_read_lock or equivalent. |
261 | * |
262 | * Updates are guarded with dev->filelist_mutex and reference must be |
263 | * dropped after a RCU grace period to accommodate lockless readers. |
264 | */ |
265 | struct pid __rcu *pid; |
266 | |
267 | /** @client_id: A unique id for fdinfo */ |
268 | u64 client_id; |
269 | |
270 | /** @magic: Authentication magic, see @authenticated. */ |
271 | drm_magic_t magic; |
272 | |
273 | /** |
274 | * @lhead: |
275 | * |
276 | * List of all open files of a DRM device, linked into |
277 | * &drm_device.filelist. Protected by &drm_device.filelist_mutex. |
278 | */ |
279 | struct list_head lhead; |
280 | |
281 | /** @minor: &struct drm_minor for this file. */ |
282 | struct drm_minor *minor; |
283 | |
284 | /** |
285 | * @object_idr: |
286 | * |
287 | * Mapping of mm object handles to object pointers. Used by the GEM |
288 | * subsystem. Protected by @table_lock. |
289 | */ |
290 | struct idr object_idr; |
291 | |
292 | /** @table_lock: Protects @object_idr. */ |
293 | spinlock_t table_lock; |
294 | |
295 | /** @syncobj_idr: Mapping of sync object handles to object pointers. */ |
296 | struct idr syncobj_idr; |
297 | /** @syncobj_table_lock: Protects @syncobj_idr. */ |
298 | spinlock_t syncobj_table_lock; |
299 | |
300 | /** @filp: Pointer to the core file structure. */ |
301 | struct file *filp; |
302 | |
303 | /** |
304 | * @driver_priv: |
305 | * |
306 | * Optional pointer for driver private data. Can be allocated in |
307 | * &drm_driver.open and should be freed in &drm_driver.postclose. |
308 | */ |
309 | void *driver_priv; |
310 | |
311 | /** |
312 | * @fbs: |
313 | * |
314 | * List of &struct drm_framebuffer associated with this file, using the |
315 | * &drm_framebuffer.filp_head entry. |
316 | * |
317 | * Protected by @fbs_lock. Note that the @fbs list holds a reference on |
318 | * the framebuffer object to prevent it from untimely disappearing. |
319 | */ |
320 | struct list_head fbs; |
321 | |
322 | /** @fbs_lock: Protects @fbs. */ |
323 | struct mutex fbs_lock; |
324 | |
325 | /** |
326 | * @blobs: |
327 | * |
328 | * User-created blob properties; this retains a reference on the |
329 | * property. |
330 | * |
331 | * Protected by @drm_mode_config.blob_lock; |
332 | */ |
333 | struct list_head blobs; |
334 | |
335 | /** @event_wait: Waitqueue for new events added to @event_list. */ |
336 | wait_queue_head_t event_wait; |
337 | |
338 | /** |
339 | * @pending_event_list: |
340 | * |
341 | * List of pending &struct drm_pending_event, used to clean up pending |
342 | * events in case this file gets closed before the event is signalled. |
343 | * Uses the &drm_pending_event.pending_link entry. |
344 | * |
345 | * Protect by &drm_device.event_lock. |
346 | */ |
347 | struct list_head pending_event_list; |
348 | |
349 | /** |
350 | * @event_list: |
351 | * |
352 | * List of &struct drm_pending_event, ready for delivery to userspace |
353 | * through drm_read(). Uses the &drm_pending_event.link entry. |
354 | * |
355 | * Protect by &drm_device.event_lock. |
356 | */ |
357 | struct list_head event_list; |
358 | |
359 | /** |
360 | * @event_space: |
361 | * |
362 | * Available event space to prevent userspace from |
363 | * exhausting kernel memory. Currently limited to the fairly arbitrary |
364 | * value of 4KB. |
365 | */ |
366 | int event_space; |
367 | |
368 | /** @event_read_lock: Serializes drm_read(). */ |
369 | struct mutex event_read_lock; |
370 | |
371 | /** |
372 | * @prime: |
373 | * |
374 | * Per-file buffer caches used by the PRIME buffer sharing code. |
375 | */ |
376 | struct drm_prime_file_private prime; |
377 | |
378 | /* private: */ |
379 | #if IS_ENABLED(CONFIG_DRM_LEGACY) |
380 | unsigned long lock_count; /* DRI1 legacy lock count */ |
381 | #endif |
382 | }; |
383 | |
384 | /** |
385 | * drm_is_primary_client - is this an open file of the primary node |
386 | * @file_priv: DRM file |
387 | * |
388 | * Returns true if this is an open file of the primary node, i.e. |
389 | * &drm_file.minor of @file_priv is a primary minor. |
390 | * |
391 | * See also the :ref:`section on primary nodes and authentication |
392 | * <drm_primary_node>`. |
393 | */ |
394 | static inline bool drm_is_primary_client(const struct drm_file *file_priv) |
395 | { |
396 | return file_priv->minor->type == DRM_MINOR_PRIMARY; |
397 | } |
398 | |
399 | /** |
400 | * drm_is_render_client - is this an open file of the render node |
401 | * @file_priv: DRM file |
402 | * |
403 | * Returns true if this is an open file of the render node, i.e. |
404 | * &drm_file.minor of @file_priv is a render minor. |
405 | * |
406 | * See also the :ref:`section on render nodes <drm_render_node>`. |
407 | */ |
408 | static inline bool drm_is_render_client(const struct drm_file *file_priv) |
409 | { |
410 | return file_priv->minor->type == DRM_MINOR_RENDER; |
411 | } |
412 | |
413 | /** |
414 | * drm_is_accel_client - is this an open file of the compute acceleration node |
415 | * @file_priv: DRM file |
416 | * |
417 | * Returns true if this is an open file of the compute acceleration node, i.e. |
418 | * &drm_file.minor of @file_priv is a accel minor. |
419 | * |
420 | * See also :doc:`Introduction to compute accelerators subsystem |
421 | * </accel/introduction>`. |
422 | */ |
423 | static inline bool drm_is_accel_client(const struct drm_file *file_priv) |
424 | { |
425 | return file_priv->minor->type == DRM_MINOR_ACCEL; |
426 | } |
427 | |
428 | void drm_file_update_pid(struct drm_file *); |
429 | |
430 | int drm_open(struct inode *inode, struct file *filp); |
431 | int drm_open_helper(struct file *filp, struct drm_minor *minor); |
432 | ssize_t drm_read(struct file *filp, char __user *buffer, |
433 | size_t count, loff_t *offset); |
434 | int drm_release(struct inode *inode, struct file *filp); |
435 | int drm_release_noglobal(struct inode *inode, struct file *filp); |
436 | __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait); |
437 | int drm_event_reserve_init_locked(struct drm_device *dev, |
438 | struct drm_file *file_priv, |
439 | struct drm_pending_event *p, |
440 | struct drm_event *e); |
441 | int drm_event_reserve_init(struct drm_device *dev, |
442 | struct drm_file *file_priv, |
443 | struct drm_pending_event *p, |
444 | struct drm_event *e); |
445 | void drm_event_cancel_free(struct drm_device *dev, |
446 | struct drm_pending_event *p); |
447 | void drm_send_event_locked(struct drm_device *dev, struct drm_pending_event *e); |
448 | void drm_send_event(struct drm_device *dev, struct drm_pending_event *e); |
449 | void drm_send_event_timestamp_locked(struct drm_device *dev, |
450 | struct drm_pending_event *e, |
451 | ktime_t timestamp); |
452 | |
453 | /** |
454 | * struct drm_memory_stats - GEM object stats associated |
455 | * @shared: Total size of GEM objects shared between processes |
456 | * @private: Total size of GEM objects |
457 | * @resident: Total size of GEM objects backing pages |
458 | * @purgeable: Total size of GEM objects that can be purged (resident and not active) |
459 | * @active: Total size of GEM objects active on one or more engines |
460 | * |
461 | * Used by drm_print_memory_stats() |
462 | */ |
463 | struct drm_memory_stats { |
464 | u64 shared; |
465 | u64 private; |
466 | u64 resident; |
467 | u64 purgeable; |
468 | u64 active; |
469 | }; |
470 | |
471 | enum drm_gem_object_status; |
472 | |
473 | void drm_print_memory_stats(struct drm_printer *p, |
474 | const struct drm_memory_stats *stats, |
475 | enum drm_gem_object_status supported_status, |
476 | const char *region); |
477 | |
478 | void drm_show_memory_stats(struct drm_printer *p, struct drm_file *file); |
479 | void drm_show_fdinfo(struct seq_file *m, struct file *f); |
480 | |
481 | struct file *mock_drm_getfile(struct drm_minor *minor, unsigned int flags); |
482 | |
483 | #endif /* _DRM_FILE_H_ */ |
484 | |