1 | #ifndef _DRM_AUTH_H_ |
2 | #define _DRM_AUTH_H_ |
3 | |
4 | /* |
5 | * Internal Header for the Direct Rendering Manager |
6 | * |
7 | * Copyright 2016 Intel Corporation |
8 | * |
9 | * Author: Daniel Vetter <daniel.vetter@ffwll.ch> |
10 | * |
11 | * Permission is hereby granted, free of charge, to any person obtaining a |
12 | * copy of this software and associated documentation files (the "Software"), |
13 | * to deal in the Software without restriction, including without limitation |
14 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, |
15 | * and/or sell copies of the Software, and to permit persons to whom the |
16 | * Software is furnished to do so, subject to the following conditions: |
17 | * |
18 | * The above copyright notice and this permission notice (including the next |
19 | * paragraph) shall be included in all copies or substantial portions of the |
20 | * Software. |
21 | * |
22 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
23 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
24 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
25 | * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR |
26 | * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, |
27 | * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR |
28 | * OTHER DEALINGS IN THE SOFTWARE. |
29 | */ |
30 | |
31 | #include <linux/idr.h> |
32 | #include <linux/kref.h> |
33 | #include <linux/wait.h> |
34 | |
35 | struct drm_file; |
36 | struct drm_hw_lock; |
37 | |
38 | /* |
39 | * Legacy DRI1 locking data structure. Only here instead of in drm_legacy.h for |
40 | * include ordering reasons. |
41 | * |
42 | * DO NOT USE. |
43 | */ |
44 | struct drm_lock_data { |
45 | struct drm_hw_lock *hw_lock; |
46 | struct drm_file *file_priv; |
47 | wait_queue_head_t lock_queue; |
48 | unsigned long lock_time; |
49 | spinlock_t spinlock; |
50 | uint32_t kernel_waiters; |
51 | uint32_t user_waiters; |
52 | int idle_has_lock; |
53 | }; |
54 | |
55 | /** |
56 | * struct drm_master - drm master structure |
57 | * |
58 | * @refcount: Refcount for this master object. |
59 | * @dev: Link back to the DRM device |
60 | * @driver_priv: Pointer to driver-private information. |
61 | * |
62 | * Note that master structures are only relevant for the legacy/primary device |
63 | * nodes, hence there can only be one per device, not one per drm_minor. |
64 | */ |
65 | struct drm_master { |
66 | struct kref refcount; |
67 | struct drm_device *dev; |
68 | /** |
69 | * @unique: Unique identifier: e.g. busid. Protected by |
70 | * &drm_device.master_mutex. |
71 | */ |
72 | char *unique; |
73 | /** |
74 | * @unique_len: Length of unique field. Protected by |
75 | * &drm_device.master_mutex. |
76 | */ |
77 | int unique_len; |
78 | /** |
79 | * @magic_map: Map of used authentication tokens. Protected by |
80 | * &drm_device.master_mutex. |
81 | */ |
82 | struct idr magic_map; |
83 | void *driver_priv; |
84 | |
85 | /** |
86 | * @lessor: |
87 | * |
88 | * Lease grantor, only set if this &struct drm_master represents a |
89 | * lessee holding a lease of objects from @lessor. Full owners of the |
90 | * device have this set to NULL. |
91 | * |
92 | * The lessor does not change once it's set in drm_lease_create(), and |
93 | * each lessee holds a reference to its lessor that it releases upon |
94 | * being destroyed in drm_lease_destroy(). |
95 | * |
96 | * See also the :ref:`section on display resource leasing |
97 | * <drm_leasing>`. |
98 | */ |
99 | struct drm_master *lessor; |
100 | |
101 | /** |
102 | * @lessee_id: |
103 | * |
104 | * ID for lessees. Owners (i.e. @lessor is NULL) always have ID 0. |
105 | * Protected by &drm_device.mode_config's &drm_mode_config.idr_mutex. |
106 | */ |
107 | int lessee_id; |
108 | |
109 | /** |
110 | * @lessee_list: |
111 | * |
112 | * List entry of lessees of @lessor, where they are linked to @lessees. |
113 | * Not used for owners. Protected by &drm_device.mode_config's |
114 | * &drm_mode_config.idr_mutex. |
115 | */ |
116 | struct list_head lessee_list; |
117 | |
118 | /** |
119 | * @lessees: |
120 | * |
121 | * List of drm_masters leasing from this one. Protected by |
122 | * &drm_device.mode_config's &drm_mode_config.idr_mutex. |
123 | * |
124 | * This list is empty if no leases have been granted, or if all lessees |
125 | * have been destroyed. Since lessors are referenced by all their |
126 | * lessees, this master cannot be destroyed unless the list is empty. |
127 | */ |
128 | struct list_head lessees; |
129 | |
130 | /** |
131 | * @leases: |
132 | * |
133 | * Objects leased to this drm_master. Protected by |
134 | * &drm_device.mode_config's &drm_mode_config.idr_mutex. |
135 | * |
136 | * Objects are leased all together in drm_lease_create(), and are |
137 | * removed all together when the lease is revoked. |
138 | */ |
139 | struct idr leases; |
140 | |
141 | /** |
142 | * @lessee_idr: |
143 | * |
144 | * All lessees under this owner (only used where @lessor is NULL). |
145 | * Protected by &drm_device.mode_config's &drm_mode_config.idr_mutex. |
146 | */ |
147 | struct idr lessee_idr; |
148 | /* private: */ |
149 | #if IS_ENABLED(CONFIG_DRM_LEGACY) |
150 | struct drm_lock_data lock; |
151 | #endif |
152 | }; |
153 | |
154 | struct drm_master *drm_master_get(struct drm_master *master); |
155 | struct drm_master *drm_file_get_master(struct drm_file *file_priv); |
156 | void drm_master_put(struct drm_master **master); |
157 | bool drm_is_current_master(struct drm_file *fpriv); |
158 | |
159 | struct drm_master *drm_master_create(struct drm_device *dev); |
160 | |
161 | #endif |
162 | |