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
  32 struct gen_spec;
  33 struct gen_group;
  34 struct gen_field;
  35
  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 struct gen_group *gen_spec_find_register_by_name(struct gen_spec *spec, const char *name);
  49 int gen_group_get_length(struct gen_group *group, const uint32_t *p);
  50 const char *gen_group_get_name(struct gen_group *group);
  51 uint32_t gen_group_get_opcode(struct gen_group *group);
  52 struct gen_enum *gen_spec_find_enum(struct gen_spec *spec, const char *name);
  53
  54 struct gen_field_iterator {
  55    struct gen_group *group;
  56    const char *name;
  57    char value[128];
  58    struct gen_group *struct_desc;
  59    const uint32_t *p;
  60    int dword; /**< current field starts at &p[dword] */
  61    int i;
  62    struct gen_field *field;
  63    bool print_colors;
  64 };
  65
  66 struct gen_group {
  67    struct gen_spec *spec;
  68    char *name;
  69    int nfields;
  70    struct gen_field **fields;
  71    uint32_t group_offset, group_count;
  72
  73    uint32_t opcode_mask;
  74    uint32_t opcode;
  75
  76    /* Register specific */
  77    uint32_t register_offset;
  78 };
  79
  80 struct gen_value {
  81    char *name;
  82    uint64_t value;
  83 };
  84
  85 struct gen_enum {
  86    char *name;
  87    int nvalues;
  88    struct gen_value **values;
  89 };
  90
  91 struct gen_type {
  92    enum {
  93       GEN_TYPE_UNKNOWN,
  94       GEN_TYPE_INT,
  95       GEN_TYPE_UINT,
  96       GEN_TYPE_BOOL,
  97       GEN_TYPE_FLOAT,
  98       GEN_TYPE_ADDRESS,
  99       GEN_TYPE_OFFSET,
 100       GEN_TYPE_STRUCT,
 101       GEN_TYPE_UFIXED,
 102       GEN_TYPE_SFIXED,
 103       GEN_TYPE_MBO,
 104       GEN_TYPE_ENUM
 105    } kind;
 106
 107    /* Struct definition for  GEN_TYPE_STRUCT */
 108    union {
 109       struct gen_group *gen_struct;
 110       struct gen_enum *gen_enum;
 111       struct {
 112          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 113          int i, f;
 114       };
 115    };
 116 };
 117
 118 struct gen_field {
 119    char *name;
 120    int start, end;
 121    struct gen_type type;
 122    bool has_default;
 123    uint32_t default_value;
 124
 125    struct gen_enum inline_enum;
 126 };
 127
 128 void gen_field_iterator_init(struct gen_field_iterator *iter,
 129                              struct gen_group *group,
 130                              const uint32_t *p,
 131                              bool print_colors);
 132
 133 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 134
 135 void gen_print_group(FILE *out,
 136                      struct gen_group *group,
 137                      uint64_t offset, const uint32_t *p,
 138                      bool color);
 139
 140 #endif /* GEN_DECODER_H */