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    char name[128];
  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 start; /**< current field starts at this bit number */
  62    int end;   /**< current field ends at this bit number */
  63
  64    int group_iter;
  65
  66    struct gen_field *field;
  67    bool print_colors;
  68 };
  69
  70 struct gen_spec {
  71    uint32_t gen;
  72
  73    uint32_t ncommands;
  74    struct gen_group *commands[256];
  75    uint32_t nstructs;
  76    struct gen_group *structs[256];
  77    uint32_t nregisters;
  78    struct gen_group *registers[256];
  79    uint32_t nenums;
  80    struct gen_enum *enums[256];
  81 };
  82
  83 struct gen_group {
  84    struct gen_spec *spec;
  85    char *name;
  86
  87    struct gen_field *fields; /* linked list of fields */
  88
  89    uint32_t group_offset, group_count;
  90    uint32_t group_size;
  91    bool variable;
  92
  93    struct gen_group *parent;
  94    struct gen_group *next;
  95
  96    uint32_t opcode_mask;
  97    uint32_t opcode;
  98
  99    /* Register specific */
 100    uint32_t register_offset;
 101 };
 102
 103 struct gen_value {
 104    char *name;
 105    uint64_t value;
 106 };
 107
 108 struct gen_enum {
 109    char *name;
 110    int nvalues;
 111    struct gen_value **values;
 112 };
 113
 114 struct gen_type {
 115    enum {
 116       GEN_TYPE_UNKNOWN,
 117       GEN_TYPE_INT,
 118       GEN_TYPE_UINT,
 119       GEN_TYPE_BOOL,
 120       GEN_TYPE_FLOAT,
 121       GEN_TYPE_ADDRESS,
 122       GEN_TYPE_OFFSET,
 123       GEN_TYPE_STRUCT,
 124       GEN_TYPE_UFIXED,
 125       GEN_TYPE_SFIXED,
 126       GEN_TYPE_MBO,
 127       GEN_TYPE_ENUM
 128    } kind;
 129
 130    /* Struct definition for  GEN_TYPE_STRUCT */
 131    union {
 132       struct gen_group *gen_struct;
 133       struct gen_enum *gen_enum;
 134       struct {
 135          /* Integer and fractional sizes for GEN_TYPE_UFIXED and GEN_TYPE_SFIXED */
 136          int i, f;
 137       };
 138    };
 139 };
 140
 141 struct gen_field {
 142    struct gen_field *next;
 143
 144    char *name;
 145    int start, end;
 146    struct gen_type type;
 147    bool has_default;
 148    uint32_t default_value;
 149
 150    struct gen_enum inline_enum;
 151 };
 152
 153 void gen_field_iterator_init(struct gen_field_iterator *iter,
 154                              struct gen_group *group,
 155                              const uint32_t *p,
 156                              bool print_colors);
 157
 158 bool gen_field_iterator_next(struct gen_field_iterator *iter);
 159
 160 void gen_print_group(FILE *out,
 161                      struct gen_group *group,
 162                      uint64_t offset, const uint32_t *p,
 163                      bool color);
 164
 165 #endif /* GEN_DECODER_H */