src/intel/common/gen_decoder.h

   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 GEN_DECODER_H
  25 #define GEN_DECODER_H
  26
  27 #include <stdint.h>
  28 #include <stdbool.h>
  29
  30 #include "common/gen_device_info.h"
  31 #include "util/hash_table.h"
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct gen_spec;
  38 struct gen_group;
  39 struct gen_field;
  40 union gen_field_value;
  41
  42 static inline uint32_t gen_make_gen(uint32_t major, uint32_t minor)
  43 {
  44    return (major << 8) | minor;
  45 }
  46
  47 struct gen_group *gen_spec_find_struct(struct gen_spec *spec, const char *name);
  48 struct gen_spec *gen_spec_load(const struct gen_device_info *devinfo);
  49 struct gen_spec *gen_spec_load_from_path(const struct gen_device_info *devinfo,
  50                                          const char *path);
  51 void gen_spec_destroy(struct gen_spec *spec);
  52 uint32_t gen_spec_get_gen(struct gen_spec *spec);
  53 struct gen_group *gen_spec_find_instruction(struct gen_spec *spec, const uint32_t *p);
  54 struct gen_group *gen_spec_find_register(struct gen_spec *spec, uint32_t offset);
  55 struct gen_group *gen_spec_find_register_by_name(struct gen_spec *spec, const char *name);
  56 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  57
  58 int gen_group_get_length(struct gen_group *group, const uint32_t *p);
  59 const char *gen_group_get_name(struct gen_group *group);
  60 uint32_t gen_group_get_opcode(struct gen_group *group);
  61 struct gen_field *gen_group_find_field(struct gen_group *group, const char *name);
  62 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  63
  64 bool gen_field_is_header(struct gen_field *field);
  65
  66 struct gen_field_iterator {
  67    struct gen_group *group;
  68    char name[128];
  69    char value[128];
  70    struct gen_group *struct_desc;
  71    const uint32_t *p;
  72    const uint32_t *p_end;
  73    int bit; /**< current field starts at this bit offset into p */
  74
  75    int group_iter;
  76
  77    struct gen_field *field;
  78    bool print_colors;
  79 };
  80
  81 struct gen_spec {
  82    uint32_t gen;
  83
  84    struct hash_table *commands;
  85    struct hash_table *structs;
  86    struct hash_table *registers_by_name;
  87    struct hash_table *registers_by_offset;
  88    struct hash_table *enums;
  89
  90    struct hash_table *access_cache;
  91 };
  92
  93 struct gen_group {
  94    struct gen_spec *spec;
  95    char *name;
  96
  97    struct gen_field *fields; /* linked list of fields */
  98
  99    uint32_t dw_length;
 100    uint32_t group_offset, group_count;
 101    uint32_t group_size;
 102    bool variable;
 103
 104    struct gen_group *parent;
 105    struct gen_group *next;
 106
 107    uint32_t opcode_mask;
 108    uint32_t opcode;
 109
 110    /* Register specific */
 111    uint32_t register_offset;
 112 };
 113
 114 struct gen_value {
 115    char *name;
 116    uint64_t value;
 117 };
 118
 119 struct gen_enum {
 120    char *name;
 121    int nvalues;
 122    struct gen_value **values;
 123 };
 124
 125 struct gen_type {
 126    enum {
 127       GEN_TYPE_UNKNOWN,
 128       GEN_TYPE_INT,
 129       GEN_TYPE_UINT,
 130       GEN_TYPE_BOOL,
 131       GEN_TYPE_FLOAT,
 132       GEN_TYPE_ADDRESS,
 133       GEN_TYPE_OFFSET,
 134       GEN_TYPE_STRUCT,
 135       GEN_TYPE_UFIXED,
 136       GEN_TYPE_SFIXED,
 137       GEN_TYPE_MBO,
 138       GEN_TYPE_ENUM
 139    } kind;
 140
 141    /* Struct definition for  GEN_TYPE_STRUCT */
 142    union {
 143       struct gen_group *gen_struct;
 144       struct gen_enum *gen_enum;
 145       struct {
 146          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 147          int i, f;
 148       };
 149    };
 150 };
 151
 152 union gen_field_value {
 153    bool b32;
 154    float f32;
 155    uint64_t u64;
 156    int64_t i64;
 157 };
 158
 159 struct gen_field {
 160    struct gen_group *parent;
 161    struct gen_field *next;
 162
 163    char *name;
 164    int start, end;
 165    struct gen_type type;
 166    bool has_default;
 167    uint32_t default_value;
 168
 169    struct gen_enum inline_enum;
 170 };
 171
 172 void gen_field_iterator_init(struct gen_field_iterator *iter,
 173                              struct gen_group *group,
 174                              const uint32_t *p,
 175                              bool print_colors);
 176
 177 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 178
 179 void gen_print_group(FILE *out,
 180                      struct gen_group *group,
 181                      uint64_t offset, const uint32_t *p,
 182                      bool color);
 183
 184 #ifdef __cplusplus
 185 }
 186 #endif
 187
 188
 189 #endif /* GEN_DECODER_H */