1bf215546Sopenharmony_ci/*
2bf215546Sopenharmony_ci * Copyright © 2022 Imagination Technologies Ltd.
3bf215546Sopenharmony_ci *
4bf215546Sopenharmony_ci * Permission is hereby granted, free of charge, to any person obtaining a copy
5bf215546Sopenharmony_ci * of this software and associated documentation files (the "Software"), to deal
6bf215546Sopenharmony_ci * in the Software without restriction, including without limitation the rights
7bf215546Sopenharmony_ci * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8bf215546Sopenharmony_ci * copies of the Software, and to permit persons to whom the Software is
9bf215546Sopenharmony_ci * furnished to do so, subject to the following conditions:
10bf215546Sopenharmony_ci *
11bf215546Sopenharmony_ci * The above copyright notice and this permission notice (including the next
12bf215546Sopenharmony_ci * paragraph) shall be included in all copies or substantial portions of the
13bf215546Sopenharmony_ci * Software.
14bf215546Sopenharmony_ci *
15bf215546Sopenharmony_ci * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16bf215546Sopenharmony_ci * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17bf215546Sopenharmony_ci * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18bf215546Sopenharmony_ci * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19bf215546Sopenharmony_ci * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20bf215546Sopenharmony_ci * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21bf215546Sopenharmony_ci * SOFTWARE.
22bf215546Sopenharmony_ci */
23bf215546Sopenharmony_ci
24bf215546Sopenharmony_ci#ifndef ROGUE_ENCODERS_H
25bf215546Sopenharmony_ci#define ROGUE_ENCODERS_H
26bf215546Sopenharmony_ci
27bf215546Sopenharmony_ci#include <stdbool.h>
28bf215546Sopenharmony_ci#include <stddef.h>
29bf215546Sopenharmony_ci#include <stdint.h>
30bf215546Sopenharmony_ci
31bf215546Sopenharmony_ci#include "util/macros.h"
32bf215546Sopenharmony_ci
33bf215546Sopenharmony_ci/* Returns false if input was invalid. */
34bf215546Sopenharmony_citypedef bool (*field_encoder_t)(uint64_t *value, size_t inputs, ...);
35bf215546Sopenharmony_ci
36bf215546Sopenharmony_cibool rogue_encoder_pass(uint64_t *value, size_t inputs, ...);
37bf215546Sopenharmony_cibool rogue_encoder_drc(uint64_t *value, size_t inputs, ...);
38bf215546Sopenharmony_cibool rogue_encoder_imm(uint64_t *value, size_t inputs, ...);
39bf215546Sopenharmony_cibool rogue_encoder_ls_1_16(uint64_t *value, size_t inputs, ...);
40bf215546Sopenharmony_ci
41bf215546Sopenharmony_ci/**
42bf215546Sopenharmony_ci * \brief Macro to declare the rogue_encoder_reg variants.
43bf215546Sopenharmony_ci */
44bf215546Sopenharmony_ci#define ROGUE_ENCODER_REG_VARIANT(bank_bits, num_bits)              \
45bf215546Sopenharmony_ci   bool rogue_encoder_reg_##bank_bits##_##num_bits(uint64_t *value, \
46bf215546Sopenharmony_ci                                                   size_t inputs,   \
47bf215546Sopenharmony_ci                                                   ...);
48bf215546Sopenharmony_ciROGUE_ENCODER_REG_VARIANT(2, 8)
49bf215546Sopenharmony_ciROGUE_ENCODER_REG_VARIANT(3, 8)
50bf215546Sopenharmony_ciROGUE_ENCODER_REG_VARIANT(3, 11)
51bf215546Sopenharmony_ci#undef ROGUE_ENCODER_REG_VARIANT
52bf215546Sopenharmony_ci
53bf215546Sopenharmony_ci#endif /* ROGUE_ENCODERS_H */
54