intel: Bail gracefully if we encounter an unknown Intel device
[profile/ivi/libdrm.git] / intel / intel_aub.h
1 /*
2  * Copyright © 2010 Intel Corporation
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright notice and this permission notice (including the next
12  * paragraph) shall be included in all copies or substantial portions of the
13  * Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
21  * IN THE SOFTWARE.
22  *
23  * Authors:
24  *    Eric Anholt <eric@anholt.net>
25  *
26  */
27
28 /** @file intel_aub.h
29  *
30  * The AUB file is a file format used by Intel's internal simulation
31  * and other validation tools.  It can be used at various levels by a
32  * driver to input state to the simulated hardware or a replaying
33  * debugger.
34  *
35  * We choose to dump AUB files using the trace block format for ease
36  * of implementation -- dump out the blocks of memory as plain blobs
37  * and insert ring commands to execute the batchbuffer blob.
38  */
39
40 #ifndef _INTEL_AUB_H
41 #define _INTEL_AUB_H
42
43 #define AUB_MI_NOOP                     (0)
44 #define AUB_MI_BATCH_BUFFER_START       (0x31 << 23)
45 #define AUB_PIPE_CONTROL                (0x7a000002)
46
47 /* DW0: instruction type. */
48
49 #define CMD_AUB                 (7 << 29)
50
51 #define CMD_AUB_HEADER          (CMD_AUB | (1 << 23) | (0x05 << 16))
52 /* DW1 */
53 # define AUB_HEADER_MAJOR_SHIFT         24
54 # define AUB_HEADER_MINOR_SHIFT         16
55
56 #define CMD_AUB_TRACE_HEADER_BLOCK (CMD_AUB | (1 << 23) | (0x41 << 16))
57 #define CMD_AUB_DUMP_BMP           (CMD_AUB | (1 << 23) | (0x9e << 16))
58
59 /* DW1 */
60 #define AUB_TRACE_OPERATION_MASK        0x000000ff
61 #define AUB_TRACE_OP_COMMENT            0x00000000
62 #define AUB_TRACE_OP_DATA_WRITE         0x00000001
63 #define AUB_TRACE_OP_COMMAND_WRITE      0x00000002
64 #define AUB_TRACE_OP_MMIO_WRITE         0x00000003
65 // operation = TRACE_DATA_WRITE, Type
66 #define AUB_TRACE_TYPE_MASK             0x0000ff00
67 #define AUB_TRACE_TYPE_NOTYPE           (0 << 8)
68 #define AUB_TRACE_TYPE_BATCH            (1 << 8)
69 #define AUB_TRACE_TYPE_VERTEX_BUFFER    (5 << 8)
70 #define AUB_TRACE_TYPE_2D_MAP           (6 << 8)
71 #define AUB_TRACE_TYPE_CUBE_MAP         (7 << 8)
72 #define AUB_TRACE_TYPE_VOLUME_MAP       (9 << 8)
73 #define AUB_TRACE_TYPE_1D_MAP           (10 << 8)
74 #define AUB_TRACE_TYPE_CONSTANT_BUFFER  (11 << 8)
75 #define AUB_TRACE_TYPE_CONSTANT_URB     (12 << 8)
76 #define AUB_TRACE_TYPE_INDEX_BUFFER     (13 << 8)
77 #define AUB_TRACE_TYPE_GENERAL          (14 << 8)
78 #define AUB_TRACE_TYPE_SURFACE          (15 << 8)
79
80
81 // operation = TRACE_COMMAND_WRITE, Type =
82 #define AUB_TRACE_TYPE_RING_HWB         (1 << 8)
83 #define AUB_TRACE_TYPE_RING_PRB0        (2 << 8)
84 #define AUB_TRACE_TYPE_RING_PRB1        (3 << 8)
85 #define AUB_TRACE_TYPE_RING_PRB2        (4 << 8)
86
87 // Address space
88 #define AUB_TRACE_ADDRESS_SPACE_MASK    0x00ff0000
89 #define AUB_TRACE_MEMTYPE_GTT           (0 << 16)
90 #define AUB_TRACE_MEMTYPE_LOCAL         (1 << 16)
91 #define AUB_TRACE_MEMTYPE_NONLOCAL      (2 << 16)
92 #define AUB_TRACE_MEMTYPE_PCI           (3 << 16)
93 #define AUB_TRACE_MEMTYPE_GTT_ENTRY     (4 << 16)
94
95 /* DW2 */
96 // operation = TRACE_DATA_WRITE, Type = TRACE_DATA_WRITE_GENERAL_STATE
97 #define AUB_TRACE_GENERAL_STATE_MASK    0x000000ff
98
99 #define AUB_TRACE_VS_STATE              0x00000001
100 #define AUB_TRACE_GS_STATE              0x00000002
101 #define AUB_TRACE_CL_STATE              0x00000003
102 #define AUB_TRACE_SF_STATE              0x00000004
103 #define AUB_TRACE_WM_STATE              0x00000005
104 #define AUB_TRACE_CC_STATE              0x00000006
105 #define AUB_TRACE_CL_VP                 0x00000007
106 #define AUB_TRACE_SF_VP                 0x00000008
107 #define AUB_TRACE_CC_VP                 0x00000009
108 #define AUB_TRACE_SAMPLER_STATE         0x0000000a
109 #define AUB_TRACE_KERNEL                0x0000000b
110 #define AUB_TRACE_SCRATCH               0x0000000c
111 #define AUB_TRACE_SDC                   0x0000000d
112 #define AUB_TRACE_BLEND_STATE           0x00000016
113 #define AUB_TRACE_DEPTH_STENCIL_STATE   0x00000017
114
115 // operation = TRACE_DATA_WRITE, Type = TRACE_DATA_WRITE_SURFACE_STATE
116 #define AUB_TRACE_SURFACE_STATE_MASK    0x00000ff00
117 #define AUB_TRACE_BINDING_TABLE         0x000000100
118 #define AUB_TRACE_SURFACE_STATE         0x000000200
119
120 /* DW3: address */
121 /* DW4: len */
122
123 #endif /* _INTEL_AUB_H */