src/intel/tools/aub_write.h

   1 /*
   2  * Copyright © 2007-2017 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
  25 #ifndef INTEL_AUB_WRITE
  26 #define INTEL_AUB_WRITE
  27
  28 #include <stdint.h>
  29 #include <stdio.h>
  30
  31 #include "dev/gen_device_info.h"
  32 #include "common/gen_gem.h"
  33
  34 #ifdef __cplusplus
  35 extern "C" {
  36 #endif
  37
  38 struct aub_ppgtt_table {
  39    uint64_t phys_addr;
  40    struct aub_ppgtt_table *subtables[512];
  41 };
  42
  43 struct aub_file {
  44    FILE *file;
  45
  46    /* Set if you want extra logging */
  47    FILE *verbose_log_file;
  48
  49    uint16_t pci_id;
  50    struct gen_device_info devinfo;
  51
  52    int addr_bits;
  53
  54    struct aub_ppgtt_table pml4;
  55    uint32_t default_addr_space;
  56 };
  57
  58 void aub_file_init(struct aub_file *aub, FILE *file, uint16_t pci_id);
  59 void aub_file_finish(struct aub_file *aub);
  60
  61 static inline bool aub_use_execlists(const struct aub_file *aub)
  62 {
  63    return aub->devinfo.gen >= 8;
  64 }
  65
  66 uint32_t aub_gtt_size(struct aub_file *aub);
  67
  68 static inline void
  69 aub_write_reloc(const struct gen_device_info *devinfo, void *p, uint64_t v)
  70 {
  71    if (devinfo->gen >= 8) {
  72       *(uint64_t *)p = gen_canonical_address(v);
  73    } else {
  74       *(uint32_t *)p = v;
  75    }
  76 }
  77
  78 void aub_write_header(struct aub_file *aub, const char *app_name);
  79 void aub_map_ppgtt(struct aub_file *aub, uint64_t start, uint64_t size);
  80 void aub_write_trace_block(struct aub_file *aub,
  81                            uint32_t type, void *virtual,
  82                            uint32_t size, uint64_t gtt_offset);
  83 void aub_write_exec(struct aub_file *aub, uint64_t batch_addr,
  84                     uint64_t offset, int ring_flag);
  85
  86 #ifdef __cplusplus
  87 }
  88 #endif
  89
  90 #endif /* INTEL_AUB_WRITE */