1/*
2 * Copyright © 2022 Imagination Technologies Ltd.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * 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 THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 * SOFTWARE.
22 */
23
24#ifndef ROGUE_ENCODERS_H
25#define ROGUE_ENCODERS_H
26
27#include <stdbool.h>
28#include <stddef.h>
29#include <stdint.h>
30
31#include "util/macros.h"
32
33/* Returns false if input was invalid. */
34typedef bool (*field_encoder_t)(uint64_t *value, size_t inputs, ...);
35
36bool rogue_encoder_pass(uint64_t *value, size_t inputs, ...);
37bool rogue_encoder_drc(uint64_t *value, size_t inputs, ...);
38bool rogue_encoder_imm(uint64_t *value, size_t inputs, ...);
39bool rogue_encoder_ls_1_16(uint64_t *value, size_t inputs, ...);
40
41/**
42 * \brief Macro to declare the rogue_encoder_reg variants.
43 */
44#define ROGUE_ENCODER_REG_VARIANT(bank_bits, num_bits)              \
45   bool rogue_encoder_reg_##bank_bits##_##num_bits(uint64_t *value, \
46                                                   size_t inputs,   \
47                                                   ...);
48ROGUE_ENCODER_REG_VARIANT(2, 8)
49ROGUE_ENCODER_REG_VARIANT(3, 8)
50ROGUE_ENCODER_REG_VARIANT(3, 11)
51#undef ROGUE_ENCODER_REG_VARIANT
52
53#endif /* ROGUE_ENCODERS_H */
54