1 /*
2 * Copyright © 2016-2018 Broadcom
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
24 #ifndef CLIF_PRIVATE_H
25 #define CLIF_PRIVATE_H
26
27 #include <stdint.h>
28 #include <stdarg.h>
29 #include "util/list.h"
30
31 struct clif_bo {
32 const char *name;
33 uint32_t offset;
34 uint32_t size;
35 void *vaddr;
36 bool dumped;
37 };
38
39 struct clif_dump {
40 const struct v3d_device_info *devinfo;
41 FILE *out;
42
43 struct v3d_spec *spec;
44
45 /* List of struct reloc_worklist_entry */
46 struct list_head worklist;
47
48 struct clif_bo *bo;
49 int bo_count;
50 int bo_array_size;
51
52 /**
53 * Flag to switch from CLIF ABI to slightly more human-readable
54 * output.
55 */
56 bool pretty;
57
58 /**
59 * Flag to no dump the binary resources.
60 */
61 bool nobin;
62 };
63
64 enum reloc_worklist_type {
65 reloc_cl,
66 reloc_gl_shader_state,
67 reloc_generic_tile_list,
68 };
69
70 struct reloc_worklist_entry {
71 struct list_head link;
72
73 enum reloc_worklist_type type;
74 uint32_t addr;
75
76 union {
77 struct {
78 uint32_t end;
79 } cl;
80 struct {
81 uint32_t num_attrs;
82 } shader_state;
83 struct {
84 uint32_t end;
85 } generic_tile_list;
86 };
87 };
88
89 struct clif_bo *
90 clif_lookup_bo(struct clif_dump *clif, uint32_t addr);
91
92 struct reloc_worklist_entry *
93 clif_dump_add_address_to_worklist(struct clif_dump *clif,
94 enum reloc_worklist_type type,
95 uint32_t addr);
96
97 bool v3d33_clif_dump_packet(struct clif_dump *clif, uint32_t offset,
98 const uint8_t *cl, uint32_t *size, bool reloc_mode);
99 bool v3d41_clif_dump_packet(struct clif_dump *clif, uint32_t offset,
100 const uint8_t *cl, uint32_t *size, bool reloc_mode);
101 bool v3d42_clif_dump_packet(struct clif_dump *clif, uint32_t offset,
102 const uint8_t *cl, uint32_t *size, bool reloc_mode);
103
104 static inline void
out(struct clif_dump * clif,const char * fmt,...)105 out(struct clif_dump *clif, const char *fmt, ...)
106 {
107 va_list args;
108
109 va_start(args, fmt);
110 vfprintf(clif->out, fmt, args);
111 va_end(args);
112 }
113
114 static inline void
out_address(struct clif_dump * clif,uint32_t addr)115 out_address(struct clif_dump *clif, uint32_t addr)
116 {
117 struct clif_bo *bo = clif_lookup_bo(clif, addr);
118 if (bo) {
119 out(clif, "[%s+0x%08x] /* 0x%08x */",
120 bo->name, addr - bo->offset, addr);
121 } else if (addr) {
122 out(clif, "/* XXX: BO unknown */ 0x%08x", addr);
123 } else {
124 out(clif, "[null]");
125 }
126 }
127
128 #endif /* CLIF_PRIVATE_H */
129