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