root/sys/dev/qat/include/common/adf_transport_access_macros.h
/* SPDX-License-Identifier: BSD-3-Clause */
/* Copyright(c) 2007-2022 Intel Corporation */
#ifndef ADF_TRANSPORT_ACCESS_MACROS_H
#define ADF_TRANSPORT_ACCESS_MACROS_H

#include "adf_accel_devices.h"
#define ADF_BANK_INT_SRC_SEL_MASK_0 0x4444444CUL
#define ADF_BANK_INT_SRC_SEL_MASK_X 0x44444444UL
#define ADF_BANK_INT_FLAG_CLEAR_MASK 0xFFFF
#define ADF_RING_CSR_RING_CONFIG 0x000
#define ADF_RING_CSR_RING_LBASE 0x040
#define ADF_RING_CSR_RING_UBASE 0x080
#define ADF_RING_CSR_RING_HEAD 0x0C0
#define ADF_RING_CSR_RING_TAIL 0x100
#define ADF_RING_CSR_E_STAT 0x14C
#define ADF_RING_CSR_INT_FLAG 0x170
#define ADF_RING_CSR_INT_SRCSEL 0x174
#define ADF_RING_CSR_INT_SRCSEL_2 0x178
#define ADF_RING_CSR_INT_COL_EN 0x17C
#define ADF_RING_CSR_INT_COL_CTL 0x180
#define ADF_RING_CSR_INT_FLAG_AND_COL 0x184
#define ADF_RING_CSR_INT_COL_CTL_ENABLE 0x80000000
#define ADF_RING_BUNDLE_SIZE 0x1000
#define ADF_RING_CONFIG_NEAR_FULL_WM 0x0A
#define ADF_RING_CONFIG_NEAR_EMPTY_WM 0x05
#define ADF_COALESCING_MIN_TIME 0x1FF
#define ADF_COALESCING_MAX_TIME 0xFFFFF
#define ADF_COALESCING_DEF_TIME 0x27FF
#define ADF_RING_NEAR_WATERMARK_512 0x08
#define ADF_RING_NEAR_WATERMARK_0 0x00
#define ADF_RING_EMPTY_SIG 0x7F7F7F7F

/* Valid internal ring size values */
#define ADF_RING_SIZE_128 0x01
#define ADF_RING_SIZE_256 0x02
#define ADF_RING_SIZE_512 0x03
#define ADF_RING_SIZE_4K 0x06
#define ADF_RING_SIZE_16K 0x08
#define ADF_RING_SIZE_4M 0x10
#define ADF_MIN_RING_SIZE ADF_RING_SIZE_128
#define ADF_MAX_RING_SIZE ADF_RING_SIZE_4M
#define ADF_DEFAULT_RING_SIZE ADF_RING_SIZE_16K

/* Valid internal msg size values */
#define ADF_MSG_SIZE_32 0x01
#define ADF_MSG_SIZE_64 0x02
#define ADF_MSG_SIZE_128 0x04
#define ADF_MIN_MSG_SIZE ADF_MSG_SIZE_32
#define ADF_MAX_MSG_SIZE ADF_MSG_SIZE_128

/* Size to bytes conversion macros for ring and msg size values */
#define ADF_MSG_SIZE_TO_BYTES(SIZE) (SIZE << 5)
#define ADF_BYTES_TO_MSG_SIZE(SIZE) (SIZE >> 5)
#define ADF_SIZE_TO_RING_SIZE_IN_BYTES(SIZE) ((1 << (SIZE - 1)) << 7)
#define ADF_RING_SIZE_IN_BYTES_TO_SIZE(SIZE) ((1 << (SIZE - 1)) >> 7)

/* Set the response quota to a high number */
#define ADF_NO_RESPONSE_QUOTA 0xFFFFFFFF

/* Minimum ring bufer size for memory allocation */
#define ADF_RING_SIZE_BYTES_MIN(SIZE)                                          \
        ((SIZE < ADF_SIZE_TO_RING_SIZE_IN_BYTES(ADF_RING_SIZE_4K)) ?           \
             ADF_SIZE_TO_RING_SIZE_IN_BYTES(ADF_RING_SIZE_4K) :                \
             SIZE)
#define ADF_RING_SIZE_MODULO(SIZE) (SIZE + 0x6)
#define ADF_SIZE_TO_POW(SIZE)                                                  \
        ((((SIZE & 0x4) >> 1) | ((SIZE & 0x4) >> 2) | SIZE) & ~0x4)
/* Max outstanding requests */
#define ADF_MAX_INFLIGHTS(RING_SIZE, MSG_SIZE)                                 \
        ((((1 << (RING_SIZE - 1)) << 3) >> ADF_SIZE_TO_POW(MSG_SIZE)) - 1)
#define BUILD_RING_CONFIG(size)                                                \
        ((ADF_RING_NEAR_WATERMARK_0 << ADF_RING_CONFIG_NEAR_FULL_WM) |         \
         (ADF_RING_NEAR_WATERMARK_0 << ADF_RING_CONFIG_NEAR_EMPTY_WM) | size)
#define BUILD_RESP_RING_CONFIG(size, watermark_nf, watermark_ne)               \
        ((watermark_nf << ADF_RING_CONFIG_NEAR_FULL_WM) |                      \
         (watermark_ne << ADF_RING_CONFIG_NEAR_EMPTY_WM) | size)
#define BUILD_RING_BASE_ADDR(addr, size)                                       \
        ((addr >> 6) & (0xFFFFFFFFFFFFFFFFULL << size))
#define READ_CSR_RING_HEAD(csr_base_addr, bank, ring)                          \
        ADF_CSR_RD(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_RING_HEAD +    \
                       (ring << 2))
#define READ_CSR_RING_TAIL(csr_base_addr, bank, ring)                          \
        ADF_CSR_RD(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_RING_TAIL +    \
                       (ring << 2))
#define READ_CSR_E_STAT(csr_base_addr, bank)                                   \
        ADF_CSR_RD(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_E_STAT)
#define WRITE_CSR_RING_CONFIG(csr_base_addr, bank, ring, value)                \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_RING_CONFIG +  \
                       (ring << 2),                                            \
                   value)
#define WRITE_CSR_RING_BASE(csr_base_addr, bank, ring, value)                  \
        do {                                                                   \
                uint32_t l_base = 0, u_base = 0;                               \
                l_base = (uint32_t)(value & 0xFFFFFFFF);                       \
                u_base = (uint32_t)((value & 0xFFFFFFFF00000000ULL) >> 32);    \
                ADF_CSR_WR(csr_base_addr,                                      \
                           (ADF_RING_BUNDLE_SIZE * bank) +                     \
                               ADF_RING_CSR_RING_LBASE + (ring << 2),          \
                           l_base);                                            \
                ADF_CSR_WR(csr_base_addr,                                      \
                           (ADF_RING_BUNDLE_SIZE * bank) +                     \
                               ADF_RING_CSR_RING_UBASE + (ring << 2),          \
                           u_base);                                            \
        } while (0)
static inline uint64_t
read_base(struct resource *csr_base_addr, uint32_t bank, uint32_t ring)
{
        uint32_t l_base, u_base;
        uint64_t addr;

        l_base = ADF_CSR_RD(csr_base_addr,
                            (ADF_RING_BUNDLE_SIZE * bank) +
                                ADF_RING_CSR_RING_LBASE + (ring << 2));
        u_base = ADF_CSR_RD(csr_base_addr,
                            (ADF_RING_BUNDLE_SIZE * bank) +
                                ADF_RING_CSR_RING_UBASE + (ring << 2));

        addr = (uint64_t)l_base & 0x00000000FFFFFFFFULL;
        addr |= (uint64_t)u_base << 32 & 0xFFFFFFFF00000000ULL;

        return addr;
}

#define READ_CSR_RING_BASE(csr_base_addr, bank, ring)                          \
        read_base(csr_base_addr, bank, ring)
#define WRITE_CSR_RING_HEAD(csr_base_addr, bank, ring, value)                  \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_RING_HEAD +    \
                       (ring << 2),                                            \
                   value)
#define WRITE_CSR_RING_TAIL(csr_base_addr, bank, ring, value)                  \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_RING_TAIL +    \
                       (ring << 2),                                            \
                   value)
#define WRITE_CSR_INT_FLAG(csr_base_addr, bank, value)                         \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * (bank)) + ADF_RING_CSR_INT_FLAG,    \
                   value)
#define WRITE_CSR_INT_SRCSEL(csr_base_addr, bank)                              \
        do {                                                                   \
                ADF_CSR_WR(csr_base_addr,                                      \
                           (ADF_RING_BUNDLE_SIZE * bank) +                     \
                               ADF_RING_CSR_INT_SRCSEL,                        \
                           ADF_BANK_INT_SRC_SEL_MASK_0);                       \
                ADF_CSR_WR(csr_base_addr,                                      \
                           (ADF_RING_BUNDLE_SIZE * bank) +                     \
                               ADF_RING_CSR_INT_SRCSEL_2,                      \
                           ADF_BANK_INT_SRC_SEL_MASK_X);                       \
        } while (0)
#define WRITE_CSR_INT_COL_EN(csr_base_addr, bank, value)                       \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_INT_COL_EN,    \
                   value)
#define WRITE_CSR_INT_COL_CTL(csr_base_addr, bank, value)                      \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) + ADF_RING_CSR_INT_COL_CTL,   \
                   ADF_RING_CSR_INT_COL_CTL_ENABLE | value)
#define WRITE_CSR_INT_FLAG_AND_COL(csr_base_addr, bank, value)                 \
        ADF_CSR_WR(csr_base_addr,                                              \
                   (ADF_RING_BUNDLE_SIZE * bank) +                             \
                       ADF_RING_CSR_INT_FLAG_AND_COL,                          \
                   value)
#endif