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