Loading...
Note: File does not exist in v3.1.
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 * Copyright 2016 Intel Corp.
6 *
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice (including the next
15 * paragraph) shall be included in all copies or substantial portions of the
16 * Software.
17 *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
21 * VA LINUX SYSTEMS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
22 * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
23 * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
24 * OTHER DEALINGS IN THE SOFTWARE.
25 */
26
27#ifndef _DRM_DRV_H_
28#define _DRM_DRV_H_
29
30#include <linux/list.h>
31#include <linux/irqreturn.h>
32
33struct drm_device;
34struct drm_file;
35struct drm_gem_object;
36struct drm_master;
37struct drm_minor;
38struct dma_buf_attachment;
39struct drm_display_mode;
40struct drm_mode_create_dumb;
41
42/* driver capabilities and requirements mask */
43#define DRIVER_USE_AGP 0x1
44#define DRIVER_LEGACY 0x2
45#define DRIVER_PCI_DMA 0x8
46#define DRIVER_SG 0x10
47#define DRIVER_HAVE_DMA 0x20
48#define DRIVER_HAVE_IRQ 0x40
49#define DRIVER_IRQ_SHARED 0x80
50#define DRIVER_GEM 0x1000
51#define DRIVER_MODESET 0x2000
52#define DRIVER_PRIME 0x4000
53#define DRIVER_RENDER 0x8000
54#define DRIVER_ATOMIC 0x10000
55#define DRIVER_KMS_LEGACY_CONTEXT 0x20000
56
57/**
58 * struct drm_driver - DRM driver structure
59 *
60 * This structure represent the common code for a family of cards. There will
61 * one drm_device for each card present in this family. It contains lots of
62 * vfunc entries, and a pile of those probably should be moved to more
63 * appropriate places like &drm_mode_config_funcs or into a new operations
64 * structure for GEM drivers.
65 */
66struct drm_driver {
67 int (*load) (struct drm_device *, unsigned long flags);
68 int (*firstopen) (struct drm_device *);
69 int (*open) (struct drm_device *, struct drm_file *);
70 void (*preclose) (struct drm_device *, struct drm_file *file_priv);
71 void (*postclose) (struct drm_device *, struct drm_file *);
72 void (*lastclose) (struct drm_device *);
73 int (*unload) (struct drm_device *);
74 int (*dma_ioctl) (struct drm_device *dev, void *data, struct drm_file *file_priv);
75 int (*dma_quiescent) (struct drm_device *);
76 int (*context_dtor) (struct drm_device *dev, int context);
77 int (*set_busid)(struct drm_device *dev, struct drm_master *master);
78
79 /**
80 * @get_vblank_counter:
81 *
82 * Driver callback for fetching a raw hardware vblank counter for the
83 * CRTC specified with the pipe argument. If a device doesn't have a
84 * hardware counter, the driver can simply use
85 * drm_vblank_no_hw_counter() function. The DRM core will account for
86 * missed vblank events while interrupts where disabled based on system
87 * timestamps.
88 *
89 * Wraparound handling and loss of events due to modesetting is dealt
90 * with in the DRM core code, as long as drivers call
91 * drm_crtc_vblank_off() and drm_crtc_vblank_on() when disabling or
92 * enabling a CRTC.
93 *
94 * Returns:
95 *
96 * Raw vblank counter value.
97 */
98 u32 (*get_vblank_counter) (struct drm_device *dev, unsigned int pipe);
99
100 /**
101 * @enable_vblank:
102 *
103 * Enable vblank interrupts for the CRTC specified with the pipe
104 * argument.
105 *
106 * Returns:
107 *
108 * Zero on success, appropriate errno if the given @crtc's vblank
109 * interrupt cannot be enabled.
110 */
111 int (*enable_vblank) (struct drm_device *dev, unsigned int pipe);
112
113 /**
114 * @disable_vblank:
115 *
116 * Disable vblank interrupts for the CRTC specified with the pipe
117 * argument.
118 */
119 void (*disable_vblank) (struct drm_device *dev, unsigned int pipe);
120
121 /**
122 * @device_is_agp:
123 *
124 * Called by drm_device_is_agp(). Typically used to determine if a card
125 * is really attached to AGP or not.
126 *
127 * Returns:
128 *
129 * One of three values is returned depending on whether or not the
130 * card is absolutely not AGP (return of 0), absolutely is AGP
131 * (return of 1), or may or may not be AGP (return of 2).
132 */
133 int (*device_is_agp) (struct drm_device *dev);
134
135 /**
136 * @get_scanout_position:
137 *
138 * Called by vblank timestamping code.
139 *
140 * Returns the current display scanout position from a crtc, and an
141 * optional accurate ktime_get() timestamp of when position was
142 * measured. Note that this is a helper callback which is only used if a
143 * driver uses drm_calc_vbltimestamp_from_scanoutpos() for the
144 * @get_vblank_timestamp callback.
145 *
146 * Parameters:
147 *
148 * dev:
149 * DRM device.
150 * pipe:
151 * Id of the crtc to query.
152 * flags:
153 * Flags from the caller (DRM_CALLED_FROM_VBLIRQ or 0).
154 * vpos:
155 * Target location for current vertical scanout position.
156 * hpos:
157 * Target location for current horizontal scanout position.
158 * stime:
159 * Target location for timestamp taken immediately before
160 * scanout position query. Can be NULL to skip timestamp.
161 * etime:
162 * Target location for timestamp taken immediately after
163 * scanout position query. Can be NULL to skip timestamp.
164 * mode:
165 * Current display timings.
166 *
167 * Returns vpos as a positive number while in active scanout area.
168 * Returns vpos as a negative number inside vblank, counting the number
169 * of scanlines to go until end of vblank, e.g., -1 means "one scanline
170 * until start of active scanout / end of vblank."
171 *
172 * Returns:
173 *
174 * Flags, or'ed together as follows:
175 *
176 * DRM_SCANOUTPOS_VALID:
177 * Query successful.
178 * DRM_SCANOUTPOS_INVBL:
179 * Inside vblank.
180 * DRM_SCANOUTPOS_ACCURATE: Returned position is accurate. A lack of
181 * this flag means that returned position may be offset by a
182 * constant but unknown small number of scanlines wrt. real scanout
183 * position.
184 *
185 */
186 int (*get_scanout_position) (struct drm_device *dev, unsigned int pipe,
187 unsigned int flags, int *vpos, int *hpos,
188 ktime_t *stime, ktime_t *etime,
189 const struct drm_display_mode *mode);
190
191 /**
192 * @get_vblank_timestamp:
193 *
194 * Called by drm_get_last_vbltimestamp(). Should return a precise
195 * timestamp when the most recent VBLANK interval ended or will end.
196 *
197 * Specifically, the timestamp in @vblank_time should correspond as
198 * closely as possible to the time when the first video scanline of
199 * the video frame after the end of VBLANK will start scanning out,
200 * the time immediately after end of the VBLANK interval. If the
201 * @crtc is currently inside VBLANK, this will be a time in the future.
202 * If the @crtc is currently scanning out a frame, this will be the
203 * past start time of the current scanout. This is meant to adhere
204 * to the OpenML OML_sync_control extension specification.
205 *
206 * Paramters:
207 *
208 * dev:
209 * dev DRM device handle.
210 * pipe:
211 * crtc for which timestamp should be returned.
212 * max_error:
213 * Maximum allowable timestamp error in nanoseconds.
214 * Implementation should strive to provide timestamp
215 * with an error of at most max_error nanoseconds.
216 * Returns true upper bound on error for timestamp.
217 * vblank_time:
218 * Target location for returned vblank timestamp.
219 * flags:
220 * 0 = Defaults, no special treatment needed.
221 * DRM_CALLED_FROM_VBLIRQ = Function is called from vblank
222 * irq handler. Some drivers need to apply some workarounds
223 * for gpu-specific vblank irq quirks if flag is set.
224 *
225 * Returns:
226 *
227 * Zero if timestamping isn't supported in current display mode or a
228 * negative number on failure. A positive status code on success,
229 * which describes how the vblank_time timestamp was computed.
230 */
231 int (*get_vblank_timestamp) (struct drm_device *dev, unsigned int pipe,
232 int *max_error,
233 struct timeval *vblank_time,
234 unsigned flags);
235
236 /* these have to be filled in */
237
238 irqreturn_t(*irq_handler) (int irq, void *arg);
239 void (*irq_preinstall) (struct drm_device *dev);
240 int (*irq_postinstall) (struct drm_device *dev);
241 void (*irq_uninstall) (struct drm_device *dev);
242
243 /**
244 * @master_create:
245 *
246 * Called whenever a new master is created. Only used by vmwgfx.
247 */
248 int (*master_create)(struct drm_device *dev, struct drm_master *master);
249
250 /**
251 * @master_destroy:
252 *
253 * Called whenever a master is destroyed. Only used by vmwgfx.
254 */
255 void (*master_destroy)(struct drm_device *dev, struct drm_master *master);
256
257 /**
258 * @master_set:
259 *
260 * Called whenever the minor master is set. Only used by vmwgfx.
261 */
262 int (*master_set)(struct drm_device *dev, struct drm_file *file_priv,
263 bool from_open);
264 /**
265 * @master_drop:
266 *
267 * Called whenever the minor master is dropped. Only used by vmwgfx.
268 */
269 void (*master_drop)(struct drm_device *dev, struct drm_file *file_priv);
270
271 int (*debugfs_init)(struct drm_minor *minor);
272 void (*debugfs_cleanup)(struct drm_minor *minor);
273
274 /**
275 * @gem_free_object: deconstructor for drm_gem_objects
276 *
277 * This is deprecated and should not be used by new drivers. Use
278 * @gem_free_object_unlocked instead.
279 */
280 void (*gem_free_object) (struct drm_gem_object *obj);
281
282 /**
283 * @gem_free_object_unlocked: deconstructor for drm_gem_objects
284 *
285 * This is for drivers which are not encumbered with dev->struct_mutex
286 * legacy locking schemes. Use this hook instead of @gem_free_object.
287 */
288 void (*gem_free_object_unlocked) (struct drm_gem_object *obj);
289
290 int (*gem_open_object) (struct drm_gem_object *, struct drm_file *);
291 void (*gem_close_object) (struct drm_gem_object *, struct drm_file *);
292
293 /**
294 * @gem_create_object: constructor for gem objects
295 *
296 * Hook for allocating the GEM object struct, for use by core
297 * helpers.
298 */
299 struct drm_gem_object *(*gem_create_object)(struct drm_device *dev,
300 size_t size);
301
302 /* prime: */
303 /* export handle -> fd (see drm_gem_prime_handle_to_fd() helper) */
304 int (*prime_handle_to_fd)(struct drm_device *dev, struct drm_file *file_priv,
305 uint32_t handle, uint32_t flags, int *prime_fd);
306 /* import fd -> handle (see drm_gem_prime_fd_to_handle() helper) */
307 int (*prime_fd_to_handle)(struct drm_device *dev, struct drm_file *file_priv,
308 int prime_fd, uint32_t *handle);
309 /* export GEM -> dmabuf */
310 struct dma_buf * (*gem_prime_export)(struct drm_device *dev,
311 struct drm_gem_object *obj, int flags);
312 /* import dmabuf -> GEM */
313 struct drm_gem_object * (*gem_prime_import)(struct drm_device *dev,
314 struct dma_buf *dma_buf);
315 /* low-level interface used by drm_gem_prime_{import,export} */
316 int (*gem_prime_pin)(struct drm_gem_object *obj);
317 void (*gem_prime_unpin)(struct drm_gem_object *obj);
318 struct reservation_object * (*gem_prime_res_obj)(
319 struct drm_gem_object *obj);
320 struct sg_table *(*gem_prime_get_sg_table)(struct drm_gem_object *obj);
321 struct drm_gem_object *(*gem_prime_import_sg_table)(
322 struct drm_device *dev,
323 struct dma_buf_attachment *attach,
324 struct sg_table *sgt);
325 void *(*gem_prime_vmap)(struct drm_gem_object *obj);
326 void (*gem_prime_vunmap)(struct drm_gem_object *obj, void *vaddr);
327 int (*gem_prime_mmap)(struct drm_gem_object *obj,
328 struct vm_area_struct *vma);
329
330 /* vga arb irq handler */
331 void (*vgaarb_irq)(struct drm_device *dev, bool state);
332
333 /**
334 * @dumb_create:
335 *
336 * This creates a new dumb buffer in the driver's backing storage manager (GEM,
337 * TTM or something else entirely) and returns the resulting buffer handle. This
338 * handle can then be wrapped up into a framebuffer modeset object.
339 *
340 * Note that userspace is not allowed to use such objects for render
341 * acceleration - drivers must create their own private ioctls for such a use
342 * case.
343 *
344 * Width, height and depth are specified in the &drm_mode_create_dumb
345 * argument. The callback needs to fill the handle, pitch and size for
346 * the created buffer.
347 *
348 * Called by the user via ioctl.
349 *
350 * Returns:
351 *
352 * Zero on success, negative errno on failure.
353 */
354 int (*dumb_create)(struct drm_file *file_priv,
355 struct drm_device *dev,
356 struct drm_mode_create_dumb *args);
357 /**
358 * @dumb_map_offset:
359 *
360 * Allocate an offset in the drm device node's address space to be able to
361 * memory map a dumb buffer. GEM-based drivers must use
362 * drm_gem_create_mmap_offset() to implement this.
363 *
364 * Called by the user via ioctl.
365 *
366 * Returns:
367 *
368 * Zero on success, negative errno on failure.
369 */
370 int (*dumb_map_offset)(struct drm_file *file_priv,
371 struct drm_device *dev, uint32_t handle,
372 uint64_t *offset);
373 /**
374 * @dumb_destroy:
375 *
376 * This destroys the userspace handle for the given dumb backing storage buffer.
377 * Since buffer objects must be reference counted in the kernel a buffer object
378 * won't be immediately freed if a framebuffer modeset object still uses it.
379 *
380 * Called by the user via ioctl.
381 *
382 * Returns:
383 *
384 * Zero on success, negative errno on failure.
385 */
386 int (*dumb_destroy)(struct drm_file *file_priv,
387 struct drm_device *dev,
388 uint32_t handle);
389
390 /* Driver private ops for this object */
391 const struct vm_operations_struct *gem_vm_ops;
392
393 int major;
394 int minor;
395 int patchlevel;
396 char *name;
397 char *desc;
398 char *date;
399
400 u32 driver_features;
401 int dev_priv_size;
402 const struct drm_ioctl_desc *ioctls;
403 int num_ioctls;
404 const struct file_operations *fops;
405
406 /* List of devices hanging off this driver with stealth attach. */
407 struct list_head legacy_dev_list;
408};
409
410extern __printf(6, 7)
411void drm_dev_printk(const struct device *dev, const char *level,
412 unsigned int category, const char *function_name,
413 const char *prefix, const char *format, ...);
414extern __printf(3, 4)
415void drm_printk(const char *level, unsigned int category,
416 const char *format, ...);
417extern unsigned int drm_debug;
418
419int drm_dev_init(struct drm_device *dev,
420 struct drm_driver *driver,
421 struct device *parent);
422struct drm_device *drm_dev_alloc(struct drm_driver *driver,
423 struct device *parent);
424int drm_dev_register(struct drm_device *dev, unsigned long flags);
425void drm_dev_unregister(struct drm_device *dev);
426
427void drm_dev_ref(struct drm_device *dev);
428void drm_dev_unref(struct drm_device *dev);
429void drm_put_dev(struct drm_device *dev);
430void drm_unplug_dev(struct drm_device *dev);
431
432int drm_dev_set_unique(struct drm_device *dev, const char *name);
433
434
435#endif