1 /*
2 * Copyright © 2016 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
24 #ifndef DECODER_H
25 #define DECODER_H
26
27 #include <stdint.h>
28 #include <stdbool.h>
29
30 #include "common/gen_device_info.h"
31
32 struct gen_spec;
33 struct gen_group;
34 struct gen_field;
35
gen_make_gen(uint32_t major,uint32_t minor)36 static inline uint32_t gen_make_gen(uint32_t major, uint32_t minor)
37 {
38 return (major << 8) | minor;
39 }
40
41 struct gen_group *gen_spec_find_struct(struct gen_spec *spec, const char *name);
42 struct gen_spec *gen_spec_load(const struct gen_device_info *devinfo);
43 struct gen_spec *gen_spec_load_from_path(const struct gen_device_info *devinfo,
44 const char *path);
45 uint32_t gen_spec_get_gen(struct gen_spec *spec);
46 struct gen_group *gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p);
47 struct gen_group *gen_spec_find_register(struct gen_spec *spec, uint32_t offset);
48 int gen_group_get_length(struct gen_group *group, const uint32_t *p);
49 const char *gen_group_get_name(struct gen_group *group);
50 uint32_t gen_group_get_opcode(struct gen_group *group);
51 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
52
53 struct gen_field_iterator {
54 struct gen_group *group;
55 const char *name;
56 char value[128];
57 char description[128];
58 const uint32_t *p;
59 int i;
60 bool print_colors;
61 };
62
63 struct gen_group {
64 char *name;
65 int nfields;
66 struct gen_field **fields;
67 uint32_t group_offset, group_count;
68
69 uint32_t opcode_mask;
70 uint32_t opcode;
71
72 /* Register specific */
73 uint32_t register_offset;
74 };
75
76 struct gen_value {
77 char *name;
78 uint64_t value;
79 };
80
81 struct gen_enum {
82 char *name;
83 int nvalues;
84 struct gen_value **values;
85 };
86
87 struct gen_type {
88 enum {
89 GEN_TYPE_UNKNOWN,
90 GEN_TYPE_INT,
91 GEN_TYPE_UINT,
92 GEN_TYPE_BOOL,
93 GEN_TYPE_FLOAT,
94 GEN_TYPE_ADDRESS,
95 GEN_TYPE_OFFSET,
96 GEN_TYPE_STRUCT,
97 GEN_TYPE_UFIXED,
98 GEN_TYPE_SFIXED,
99 GEN_TYPE_MBO,
100 GEN_TYPE_ENUM
101 } kind;
102
103 /* Struct definition for GEN_TYPE_STRUCT */
104 union {
105 struct gen_group *gen_struct;
106 struct gen_enum *gen_enum;
107 struct {
108 /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
109 int i, f;
110 };
111 };
112 };
113
114 struct gen_field {
115 char *name;
116 int start, end;
117 struct gen_type type;
118 bool has_default;
119 uint32_t default_value;
120
121 struct gen_enum inline_enum;
122 };
123
124 void gen_field_iterator_init(struct gen_field_iterator *iter,
125 struct gen_group *group,
126 const uint32_t *p,
127 bool print_colors);
128
129 bool gen_field_iterator_next(struct gen_field_iterator *iter);
130
131 #endif /* DECODER_H */
132