1 /* i915_drv.h -- Private header for the I915 driver -*- linux-c -*-
5 * Copyright 2003 Tungsten Graphics, Inc., Cedar Park, Texas.
8 * Permission is hereby granted, free of charge, to any person obtaining a
9 * copy of this software and associated documentation files (the
10 * "Software"), to deal in the Software without restriction, including
11 * without limitation the rights to use, copy, modify, merge, publish,
12 * distribute, sub license, and/or sell copies of the Software, and to
13 * permit persons to whom the Software is furnished to do so, subject to
14 * the following conditions:
16 * The above copyright notice and this permission notice (including the
17 * next paragraph) shall be included in all copies or substantial portions
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
21 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
22 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT.
23 * IN NO EVENT SHALL TUNGSTEN GRAPHICS AND/OR ITS SUPPLIERS BE LIABLE FOR
24 * ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
25 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
26 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 #include <linux/io-mapping.h>
36 /* General customization:
39 #define DRIVER_AUTHOR "Tungsten Graphics, Inc."
41 #define DRIVER_NAME "i915"
42 #define DRIVER_DESC "Intel Graphics"
43 #define DRIVER_DATE "20080730"
50 #define I915_NUM_PIPE 2
55 * 1.2: Add Power Management
56 * 1.3: Add vblank support
57 * 1.4: Fix cmdbuffer path, add heap destroy
58 * 1.5: Add vblank pipe configuration
59 * 1.6: - New ioctl for scheduling buffer swaps on vertical blank
60 * - Support vertical blank on secondary display pipe
62 #define DRIVER_MAJOR 1
63 #define DRIVER_MINOR 6
64 #define DRIVER_PATCHLEVEL 0
66 #define WATCH_COHERENCY 0
71 #define WATCH_INACTIVE 0
72 #define WATCH_PWRITE 0
74 typedef struct _drm_i915_ring_buffer {
82 struct drm_gem_object *ring_obj;
83 } drm_i915_ring_buffer_t;
86 struct mem_block *next;
87 struct mem_block *prev;
90 struct drm_file *file_priv; /* NULL: free, -1: heap, other: real files */
93 struct opregion_header;
95 struct opregion_swsci;
98 struct intel_opregion {
99 struct opregion_header *header;
100 struct opregion_acpi *acpi;
101 struct opregion_swsci *swsci;
102 struct opregion_asle *asle;
106 typedef struct drm_i915_private {
107 struct drm_device *dev;
110 drm_local_map_t *sarea;
112 drm_i915_sarea_t *sarea_priv;
113 drm_i915_ring_buffer_t ring;
115 drm_dma_handle_t *status_page_dmah;
116 void *hw_status_page;
117 dma_addr_t dma_status_page;
119 unsigned int status_gfx_addr;
120 drm_local_map_t hws_map;
121 struct drm_gem_object *hws_obj;
129 wait_queue_head_t irq_queue;
130 atomic_t irq_received;
131 /** Protects user_irq_refcount and irq_mask_reg */
132 spinlock_t user_irq_lock;
133 /** Refcount for i915_user_irq_get() versus i915_user_irq_put(). */
134 int user_irq_refcount;
135 /** Cached value of IMR to avoid reads in updating the bitfield */
139 int tex_lru_log_granularity;
140 int allow_batchbuffer;
141 struct mem_block *agp_heap;
142 unsigned int sr01, adpa, ppcr, dvob, dvoc, lvds;
145 struct intel_opregion opregion;
152 u32 saveRENDERSTANDBY;
176 u32 savePFIT_PGM_RATIOS;
178 u32 saveBLC_PWM_CTL2;
203 u32 savePP_ON_DELAYS;
204 u32 savePP_OFF_DELAYS;
212 u32 savePFIT_CONTROL;
213 u32 save_palette_a[256];
214 u32 save_palette_b[256];
215 u32 saveFBC_CFB_BASE;
218 u32 saveFBC_CONTROL2;
222 u32 saveCACHE_MODE_0;
225 u32 saveMI_ARB_STATE;
235 u8 saveDACDATA[256*3]; /* 256 3-byte colors */
239 struct drm_mm gtt_space;
241 struct io_mapping *gtt_mapping;
244 * List of objects currently involved in rendering from the
247 * A reference is held on the buffer while on this list.
249 struct list_head active_list;
252 * List of objects which are not in the ringbuffer but which
253 * still have a write_domain which needs to be flushed before
256 * A reference is held on the buffer while on this list.
258 struct list_head flushing_list;
261 * LRU list of objects which are not in the ringbuffer and
262 * are ready to unbind, but are still in the GTT.
264 * A reference is not held on the buffer while on this list,
265 * as merely being GTT-bound shouldn't prevent its being
266 * freed, and we'll pull it off the list in the free path.
268 struct list_head inactive_list;
271 * List of breadcrumbs associated with GPU requests currently
274 struct list_head request_list;
277 * We leave the user IRQ off as much as possible,
278 * but this means that requests will finish and never
279 * be retired once the system goes idle. Set a timer to
280 * fire periodically while the ring is running. When it
281 * fires, go retire requests.
283 struct delayed_work retire_work;
285 uint32_t next_gem_seqno;
288 * Waiting sequence number, if any
290 uint32_t waiting_gem_seqno;
293 * Last seq seen at irq time
295 uint32_t irq_gem_seqno;
298 * Flag if the X Server, and thus DRM, is not currently in
299 * control of the device.
301 * This is set between LeaveVT and EnterVT. It needs to be
302 * replaced with a semaphore. It also needs to be
303 * transitioned away from for kernel modesetting.
308 * Flag if the hardware appears to be wedged.
310 * This is set when attempts to idle the device timeout.
311 * It prevents command submission from occuring and makes
312 * every pending request fail
316 /** Bit 6 swizzling required for X tiling */
317 uint32_t bit_6_swizzle_x;
318 /** Bit 6 swizzling required for Y tiling */
319 uint32_t bit_6_swizzle_y;
321 } drm_i915_private_t;
323 /** driver private structure attached to each drm_gem_object */
324 struct drm_i915_gem_object {
325 struct drm_gem_object *obj;
327 /** Current space allocated to this object in the GTT, if any. */
328 struct drm_mm_node *gtt_space;
330 /** This object's place on the active/flushing/inactive lists */
331 struct list_head list;
334 * This is set if the object is on the active or flushing lists
335 * (has pending rendering), and is not set if it's on inactive (ready
341 * This is set if the object has been written to since last bound
346 /** AGP memory structure for our GTT binding. */
347 DRM_AGP_MEM *agp_mem;
349 struct page **page_list;
352 * Current offset of the object in GTT space.
354 * This is the same as gtt_space->start
358 /** Boolean whether this object has a valid gtt offset. */
361 /** How many users have pinned this object in GTT space */
364 /** Breadcrumb of last rendering to the buffer. */
365 uint32_t last_rendering_seqno;
367 /** Current tiling mode for the object. */
368 uint32_t tiling_mode;
370 /** AGP mapping type (AGP_USER_MEMORY or AGP_USER_CACHED_MEMORY */
374 * Flagging of which individual pages are valid in GEM_DOMAIN_CPU when
375 * GEM_DOMAIN_CPU is not in the object's read domain.
377 uint8_t *page_cpu_valid;
381 * Request queue structure.
383 * The request queue allows us to note sequence numbers that have been emitted
384 * and may be associated with active buffers to be retired.
386 * By keeping this list, we can avoid having to do questionable
387 * sequence-number comparisons on buffer last_rendering_seqnos, and associate
388 * an emission time with seqnos for tracking how far ahead of the GPU we are.
390 struct drm_i915_gem_request {
391 /** GEM sequence number associated with this request. */
394 /** Time at which this request was emitted, in jiffies. */
395 unsigned long emitted_jiffies;
397 /** Cache domains that were flushed at the start of the request. */
398 uint32_t flush_domains;
400 struct list_head list;
403 struct drm_i915_file_private {
405 uint32_t last_gem_seqno;
406 uint32_t last_gem_throttle_seqno;
410 extern struct drm_ioctl_desc i915_ioctls[];
411 extern int i915_max_ioctl;
414 extern void i915_kernel_lost_context(struct drm_device * dev);
415 extern int i915_driver_load(struct drm_device *, unsigned long flags);
416 extern int i915_driver_unload(struct drm_device *);
417 extern int i915_driver_open(struct drm_device *dev, struct drm_file *file_priv);
418 extern void i915_driver_lastclose(struct drm_device * dev);
419 extern void i915_driver_preclose(struct drm_device *dev,
420 struct drm_file *file_priv);
421 extern void i915_driver_postclose(struct drm_device *dev,
422 struct drm_file *file_priv);
423 extern int i915_driver_device_is_agp(struct drm_device * dev);
424 extern long i915_compat_ioctl(struct file *filp, unsigned int cmd,
426 extern int i915_emit_box(struct drm_device *dev,
427 struct drm_clip_rect __user *boxes,
428 int i, int DR1, int DR4);
431 extern int i915_irq_emit(struct drm_device *dev, void *data,
432 struct drm_file *file_priv);
433 extern int i915_irq_wait(struct drm_device *dev, void *data,
434 struct drm_file *file_priv);
435 void i915_user_irq_get(struct drm_device *dev);
436 void i915_user_irq_put(struct drm_device *dev);
438 extern irqreturn_t i915_driver_irq_handler(DRM_IRQ_ARGS);
439 extern void i915_driver_irq_preinstall(struct drm_device * dev);
440 extern int i915_driver_irq_postinstall(struct drm_device *dev);
441 extern void i915_driver_irq_uninstall(struct drm_device * dev);
442 extern int i915_vblank_pipe_set(struct drm_device *dev, void *data,
443 struct drm_file *file_priv);
444 extern int i915_vblank_pipe_get(struct drm_device *dev, void *data,
445 struct drm_file *file_priv);
446 extern int i915_enable_vblank(struct drm_device *dev, int crtc);
447 extern void i915_disable_vblank(struct drm_device *dev, int crtc);
448 extern u32 i915_get_vblank_counter(struct drm_device *dev, int crtc);
449 extern int i915_vblank_swap(struct drm_device *dev, void *data,
450 struct drm_file *file_priv);
451 extern void i915_enable_irq(drm_i915_private_t *dev_priv, u32 mask);
454 i915_enable_pipestat(drm_i915_private_t *dev_priv, int pipe, u32 mask);
457 i915_disable_pipestat(drm_i915_private_t *dev_priv, int pipe, u32 mask);
461 extern int i915_mem_alloc(struct drm_device *dev, void *data,
462 struct drm_file *file_priv);
463 extern int i915_mem_free(struct drm_device *dev, void *data,
464 struct drm_file *file_priv);
465 extern int i915_mem_init_heap(struct drm_device *dev, void *data,
466 struct drm_file *file_priv);
467 extern int i915_mem_destroy_heap(struct drm_device *dev, void *data,
468 struct drm_file *file_priv);
469 extern void i915_mem_takedown(struct mem_block **heap);
470 extern void i915_mem_release(struct drm_device * dev,
471 struct drm_file *file_priv, struct mem_block *heap);
473 int i915_gem_init_ioctl(struct drm_device *dev, void *data,
474 struct drm_file *file_priv);
475 int i915_gem_create_ioctl(struct drm_device *dev, void *data,
476 struct drm_file *file_priv);
477 int i915_gem_pread_ioctl(struct drm_device *dev, void *data,
478 struct drm_file *file_priv);
479 int i915_gem_pwrite_ioctl(struct drm_device *dev, void *data,
480 struct drm_file *file_priv);
481 int i915_gem_mmap_ioctl(struct drm_device *dev, void *data,
482 struct drm_file *file_priv);
483 int i915_gem_set_domain_ioctl(struct drm_device *dev, void *data,
484 struct drm_file *file_priv);
485 int i915_gem_sw_finish_ioctl(struct drm_device *dev, void *data,
486 struct drm_file *file_priv);
487 int i915_gem_execbuffer(struct drm_device *dev, void *data,
488 struct drm_file *file_priv);
489 int i915_gem_pin_ioctl(struct drm_device *dev, void *data,
490 struct drm_file *file_priv);
491 int i915_gem_unpin_ioctl(struct drm_device *dev, void *data,
492 struct drm_file *file_priv);
493 int i915_gem_busy_ioctl(struct drm_device *dev, void *data,
494 struct drm_file *file_priv);
495 int i915_gem_throttle_ioctl(struct drm_device *dev, void *data,
496 struct drm_file *file_priv);
497 int i915_gem_entervt_ioctl(struct drm_device *dev, void *data,
498 struct drm_file *file_priv);
499 int i915_gem_leavevt_ioctl(struct drm_device *dev, void *data,
500 struct drm_file *file_priv);
501 int i915_gem_set_tiling(struct drm_device *dev, void *data,
502 struct drm_file *file_priv);
503 int i915_gem_get_tiling(struct drm_device *dev, void *data,
504 struct drm_file *file_priv);
505 int i915_gem_get_aperture_ioctl(struct drm_device *dev, void *data,
506 struct drm_file *file_priv);
507 void i915_gem_load(struct drm_device *dev);
508 int i915_gem_proc_init(struct drm_minor *minor);
509 void i915_gem_proc_cleanup(struct drm_minor *minor);
510 int i915_gem_init_object(struct drm_gem_object *obj);
511 void i915_gem_free_object(struct drm_gem_object *obj);
512 int i915_gem_object_pin(struct drm_gem_object *obj, uint32_t alignment);
513 void i915_gem_object_unpin(struct drm_gem_object *obj);
514 void i915_gem_lastclose(struct drm_device *dev);
515 uint32_t i915_get_gem_seqno(struct drm_device *dev);
516 void i915_gem_retire_requests(struct drm_device *dev);
517 void i915_gem_retire_work_handler(struct work_struct *work);
518 void i915_gem_clflush_object(struct drm_gem_object *obj);
520 /* i915_gem_tiling.c */
521 void i915_gem_detect_bit_6_swizzle(struct drm_device *dev);
523 /* i915_gem_debug.c */
524 void i915_gem_dump_object(struct drm_gem_object *obj, int len,
525 const char *where, uint32_t mark);
527 void i915_verify_inactive(struct drm_device *dev, char *file, int line);
529 #define i915_verify_inactive(dev, file, line)
531 void i915_gem_object_check_coherency(struct drm_gem_object *obj, int handle);
532 void i915_gem_dump_object(struct drm_gem_object *obj, int len,
533 const char *where, uint32_t mark);
534 void i915_dump_lru(struct drm_device *dev, const char *where);
537 extern int i915_save_state(struct drm_device *dev);
538 extern int i915_restore_state(struct drm_device *dev);
541 extern int i915_save_state(struct drm_device *dev);
542 extern int i915_restore_state(struct drm_device *dev);
545 /* i915_opregion.c */
546 extern int intel_opregion_init(struct drm_device *dev);
547 extern void intel_opregion_free(struct drm_device *dev);
548 extern void opregion_asle_intr(struct drm_device *dev);
549 extern void opregion_enable_asle(struct drm_device *dev);
551 static inline int intel_opregion_init(struct drm_device *dev) { return 0; }
552 static inline void intel_opregion_free(struct drm_device *dev) { return; }
553 static inline void opregion_asle_intr(struct drm_device *dev) { return; }
554 static inline void opregion_enable_asle(struct drm_device *dev) { return; }
558 * Lock test for when it's just for synchronization of ring access.
560 * In that case, we don't need to do it when GEM is initialized as nobody else
561 * has access to the ring.
563 #define RING_LOCK_TEST_WITH_RETURN(dev, file_priv) do { \
564 if (((drm_i915_private_t *)dev->dev_private)->ring.ring_obj == NULL) \
565 LOCK_TEST_WITH_RETURN(dev, file_priv); \
568 #define I915_READ(reg) readl(dev_priv->regs + (reg))
569 #define I915_WRITE(reg, val) writel(val, dev_priv->regs + (reg))
570 #define I915_READ16(reg) readw(dev_priv->regs + (reg))
571 #define I915_WRITE16(reg, val) writel(val, dev_priv->regs + (reg))
572 #define I915_READ8(reg) readb(dev_priv->regs + (reg))
573 #define I915_WRITE8(reg, val) writeb(val, dev_priv->regs + (reg))
575 #define I915_VERBOSE 0
577 #define RING_LOCALS unsigned int outring, ringmask, outcount; \
580 #define BEGIN_LP_RING(n) do { \
582 DRM_DEBUG("BEGIN_LP_RING(%d)\n", (n)); \
583 if (dev_priv->ring.space < (n)*4) \
584 i915_wait_ring(dev, (n)*4, __func__); \
586 outring = dev_priv->ring.tail; \
587 ringmask = dev_priv->ring.tail_mask; \
588 virt = dev_priv->ring.virtual_start; \
591 #define OUT_RING(n) do { \
592 if (I915_VERBOSE) DRM_DEBUG(" OUT_RING %x\n", (int)(n)); \
593 *(volatile unsigned int *)(virt + outring) = (n); \
596 outring &= ringmask; \
599 #define ADVANCE_LP_RING() do { \
600 if (I915_VERBOSE) DRM_DEBUG("ADVANCE_LP_RING %x\n", outring); \
601 dev_priv->ring.tail = outring; \
602 dev_priv->ring.space -= outcount * 4; \
603 I915_WRITE(PRB0_TAIL, outring); \
607 * Reads a dword out of the status page, which is written to from the command
608 * queue by automatic updates, MI_REPORT_HEAD, MI_STORE_DATA_INDEX, or
611 * The following dwords have a reserved meaning:
612 * 0x00: ISR copy, updated when an ISR bit not set in the HWSTAM changes.
613 * 0x04: ring 0 head pointer
614 * 0x05: ring 1 head pointer (915-class)
615 * 0x06: ring 2 head pointer (915-class)
616 * 0x10-0x1b: Context status DWords (GM45)
617 * 0x1f: Last written status offset. (GM45)
619 * The area from dword 0x20 to 0x3ff is available for driver usage.
621 #define READ_HWSP(dev_priv, reg) (((volatile u32*)(dev_priv->hw_status_page))[reg])
622 #define READ_BREADCRUMB(dev_priv) READ_HWSP(dev_priv, I915_BREADCRUMB_INDEX)
623 #define I915_GEM_HWS_INDEX 0x20
624 #define I915_BREADCRUMB_INDEX 0x21
626 extern int i915_wait_ring(struct drm_device * dev, int n, const char *caller);
628 #define IS_I830(dev) ((dev)->pci_device == 0x3577)
629 #define IS_845G(dev) ((dev)->pci_device == 0x2562)
630 #define IS_I85X(dev) ((dev)->pci_device == 0x3582)
631 #define IS_I855(dev) ((dev)->pci_device == 0x3582)
632 #define IS_I865G(dev) ((dev)->pci_device == 0x2572)
634 #define IS_I915G(dev) ((dev)->pci_device == 0x2582 || (dev)->pci_device == 0x258a)
635 #define IS_I915GM(dev) ((dev)->pci_device == 0x2592)
636 #define IS_I945G(dev) ((dev)->pci_device == 0x2772)
637 #define IS_I945GM(dev) ((dev)->pci_device == 0x27A2 ||\
638 (dev)->pci_device == 0x27AE)
639 #define IS_I965G(dev) ((dev)->pci_device == 0x2972 || \
640 (dev)->pci_device == 0x2982 || \
641 (dev)->pci_device == 0x2992 || \
642 (dev)->pci_device == 0x29A2 || \
643 (dev)->pci_device == 0x2A02 || \
644 (dev)->pci_device == 0x2A12 || \
645 (dev)->pci_device == 0x2A42 || \
646 (dev)->pci_device == 0x2E02 || \
647 (dev)->pci_device == 0x2E12 || \
648 (dev)->pci_device == 0x2E22)
650 #define IS_I965GM(dev) ((dev)->pci_device == 0x2A02)
652 #define IS_GM45(dev) ((dev)->pci_device == 0x2A42)
654 #define IS_G4X(dev) ((dev)->pci_device == 0x2E02 || \
655 (dev)->pci_device == 0x2E12 || \
656 (dev)->pci_device == 0x2E22)
658 #define IS_G33(dev) ((dev)->pci_device == 0x29C2 || \
659 (dev)->pci_device == 0x29B2 || \
660 (dev)->pci_device == 0x29D2)
662 #define IS_I9XX(dev) (IS_I915G(dev) || IS_I915GM(dev) || IS_I945G(dev) || \
663 IS_I945GM(dev) || IS_I965G(dev) || IS_G33(dev))
665 #define IS_MOBILE(dev) (IS_I830(dev) || IS_I85X(dev) || IS_I915GM(dev) || \
666 IS_I945GM(dev) || IS_I965GM(dev) || IS_GM45(dev))
668 #define I915_NEED_GFX_HWS(dev) (IS_G33(dev) || IS_GM45(dev) || IS_G4X(dev))
670 #define PRIMARY_RINGBUFFER_SIZE (128*1024)