1/*
2 * Copyright © 2019 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 OVERLAY_PARAMS_H
25#define OVERLAY_PARAMS_H
26
27#ifdef __cplusplus
28extern "C" {
29#endif
30
31#include <stdio.h>
32#include <stdint.h>
33#include <stdbool.h>
34
35#define OVERLAY_PARAMS                               \
36   OVERLAY_PARAM_BOOL(device)                        \
37   OVERLAY_PARAM_BOOL(format)                        \
38   OVERLAY_PARAM_BOOL(fps)                           \
39   OVERLAY_PARAM_BOOL(frame)                         \
40   OVERLAY_PARAM_BOOL(frame_timing)                  \
41   OVERLAY_PARAM_BOOL(submit)                        \
42   OVERLAY_PARAM_BOOL(draw)                          \
43   OVERLAY_PARAM_BOOL(draw_indexed)                  \
44   OVERLAY_PARAM_BOOL(draw_indirect)                 \
45   OVERLAY_PARAM_BOOL(draw_indexed_indirect)         \
46   OVERLAY_PARAM_BOOL(draw_indirect_count)           \
47   OVERLAY_PARAM_BOOL(draw_indexed_indirect_count)   \
48   OVERLAY_PARAM_BOOL(dispatch)                      \
49   OVERLAY_PARAM_BOOL(dispatch_indirect)             \
50   OVERLAY_PARAM_BOOL(pipeline_graphics)             \
51   OVERLAY_PARAM_BOOL(pipeline_compute)              \
52   OVERLAY_PARAM_BOOL(pipeline_raytracing)           \
53   OVERLAY_PARAM_BOOL(acquire)                       \
54   OVERLAY_PARAM_BOOL(acquire_timing)                \
55   OVERLAY_PARAM_BOOL(present_timing)                \
56   OVERLAY_PARAM_BOOL(vertices)                      \
57   OVERLAY_PARAM_BOOL(primitives)                    \
58   OVERLAY_PARAM_BOOL(vert_invocations)              \
59   OVERLAY_PARAM_BOOL(geom_invocations)              \
60   OVERLAY_PARAM_BOOL(geom_primitives)               \
61   OVERLAY_PARAM_BOOL(clip_invocations)              \
62   OVERLAY_PARAM_BOOL(clip_primitives)               \
63   OVERLAY_PARAM_BOOL(frag_invocations)              \
64   OVERLAY_PARAM_BOOL(tess_ctrl_patches)             \
65   OVERLAY_PARAM_BOOL(tess_eval_invocations)         \
66   OVERLAY_PARAM_BOOL(compute_invocations)           \
67   OVERLAY_PARAM_BOOL(gpu_timing)                    \
68   OVERLAY_PARAM_CUSTOM(fps_sampling_period)         \
69   OVERLAY_PARAM_CUSTOM(output_file)                 \
70   OVERLAY_PARAM_CUSTOM(position)                    \
71   OVERLAY_PARAM_CUSTOM(width)                       \
72   OVERLAY_PARAM_CUSTOM(height)                      \
73   OVERLAY_PARAM_CUSTOM(no_display)                  \
74   OVERLAY_PARAM_CUSTOM(control)                     \
75   OVERLAY_PARAM_CUSTOM(help)
76
77enum overlay_param_position {
78   LAYER_POSITION_TOP_LEFT,
79   LAYER_POSITION_TOP_RIGHT,
80   LAYER_POSITION_BOTTOM_LEFT,
81   LAYER_POSITION_BOTTOM_RIGHT,
82};
83
84enum overlay_param_enabled {
85#define OVERLAY_PARAM_BOOL(name) OVERLAY_PARAM_ENABLED_##name,
86#define OVERLAY_PARAM_CUSTOM(name)
87   OVERLAY_PARAMS
88#undef OVERLAY_PARAM_BOOL
89#undef OVERLAY_PARAM_CUSTOM
90   OVERLAY_PARAM_ENABLED_MAX
91};
92
93struct overlay_params {
94   bool enabled[OVERLAY_PARAM_ENABLED_MAX];
95   enum overlay_param_position position;
96   FILE *output_file;
97   int control;
98   uint32_t fps_sampling_period; /* us */
99   bool help;
100   bool no_display;
101   unsigned width;
102   unsigned height;
103};
104
105const extern char *overlay_param_names[];
106
107void parse_overlay_env(struct overlay_params *params,
108                       const char *env);
109
110#ifdef __cplusplus
111}
112#endif
113
114#endif /* OVERLAY_PARAMS_H */
115