/*-
 * Copyright (c) 2013-2017, Mellanox Technologies, Ltd.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS `AS IS' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef MLX5_CORE_CQ_H
#define MLX5_CORE_CQ_H

#include <rdma/ib_verbs.h>
#include <dev/mlx5/driver.h>
#include <dev/mlx5/mlx5_ifc.h>

struct mlx5_eqe;
struct mlx5_core_cq {
        u32                     cqn;
        int                     cqe_sz;
        __be32                 *set_ci_db;
        __be32                 *arm_db;
        unsigned                vector;
        int                     irqn;
        void (*comp)            (struct mlx5_core_cq *, struct mlx5_eqe *);
        void (*event)           (struct mlx5_core_cq *, int);
        struct mlx5_uars_page  *uar;
        u32                     cons_index;
        unsigned                arm_sn;
        struct mlx5_rsc_debug   *dbg;
        int                     pid;
        int                     reset_notify_added;
        struct list_head        reset_notify;
};


enum {
        MLX5_CQE_SYNDROME_LOCAL_LENGTH_ERR              = 0x01,
        MLX5_CQE_SYNDROME_LOCAL_QP_OP_ERR               = 0x02,
        MLX5_CQE_SYNDROME_LOCAL_PROT_ERR                = 0x04,
        MLX5_CQE_SYNDROME_WR_FLUSH_ERR                  = 0x05,
        MLX5_CQE_SYNDROME_MW_BIND_ERR                   = 0x06,
        MLX5_CQE_SYNDROME_BAD_RESP_ERR                  = 0x10,
        MLX5_CQE_SYNDROME_LOCAL_ACCESS_ERR              = 0x11,
        MLX5_CQE_SYNDROME_REMOTE_INVAL_REQ_ERR          = 0x12,
        MLX5_CQE_SYNDROME_REMOTE_ACCESS_ERR             = 0x13,
        MLX5_CQE_SYNDROME_REMOTE_OP_ERR                 = 0x14,
        MLX5_CQE_SYNDROME_TRANSPORT_RETRY_EXC_ERR       = 0x15,
        MLX5_CQE_SYNDROME_RNR_RETRY_EXC_ERR             = 0x16,
        MLX5_CQE_SYNDROME_REMOTE_ABORTED_ERR            = 0x22,
};

enum {
        MLX5_CQE_OWNER_MASK     = 1,
        MLX5_CQE_REQ            = 0,
        MLX5_CQE_RESP_WR_IMM    = 1,
        MLX5_CQE_RESP_SEND      = 2,
        MLX5_CQE_RESP_SEND_IMM  = 3,
        MLX5_CQE_RESP_SEND_INV  = 4,
        MLX5_CQE_RESIZE_CQ      = 5,
        MLX5_CQE_SIG_ERR        = 12,
        MLX5_CQE_REQ_ERR        = 13,
        MLX5_CQE_RESP_ERR       = 14,
        MLX5_CQE_INVALID        = 15,
};

enum {
        MLX5_CQ_MODIFY_PERIOD   = 1 << 0,
        MLX5_CQ_MODIFY_COUNT    = 1 << 1,
        MLX5_CQ_MODIFY_OVERRUN  = 1 << 2,
        MLX5_CQ_MODIFY_EQN      = 1 << 3,
        MLX5_CQ_MODIFY_PERIOD_MODE = 1 << 4,
};

enum {
        MLX5_CQ_OPMOD_RESIZE            = 1,
        MLX5_MODIFY_CQ_MASK_LOG_SIZE    = 1 << 0,
        MLX5_MODIFY_CQ_MASK_PG_OFFSET   = 1 << 1,
        MLX5_MODIFY_CQ_MASK_PG_SIZE     = 1 << 2,
};

struct mlx5_cq_modify_params {
        int     type;
        union {
                struct {
                        u32     page_offset;
                        u8      log_cq_size;
                } resize;

                struct {
                } moder;

                struct {
                } mapping;
        } params;
};

enum {
        CQE_STRIDE_64 = 0,
        CQE_STRIDE_128 = 1,
        CQE_STRIDE_128_PAD = 2,
};

static inline int cqe_sz_to_mlx_sz(u8 size)
{
        return size == 64 ? CQE_SIZE_64 : CQE_SIZE_128;
}

static inline void mlx5_cq_set_ci(struct mlx5_core_cq *cq)
{
        *cq->set_ci_db = cpu_to_be32(cq->cons_index & 0xffffff);
}

enum {
        MLX5_CQ_DB_REQ_NOT_SOL          = 1 << 24,
        MLX5_CQ_DB_REQ_NOT              = 0 << 24
};

static inline void mlx5_cq_arm(struct mlx5_core_cq *cq, u32 cmd,
                               void __iomem *uar_page,
                               spinlock_t *doorbell_lock,
                               u32 cons_index)
{
        __be32 doorbell[2];
        u32 sn;
        u32 ci;

        sn = cq->arm_sn & 3;
        ci = cons_index & 0xffffff;

        *cq->arm_db = cpu_to_be32(sn << 28 | cmd | ci);

        /* Make sure that the doorbell record in host memory is
         * written before ringing the doorbell via PCI MMIO.
         */
        wmb();

        doorbell[0] = cpu_to_be32(sn << 28 | cmd | ci);
        doorbell[1] = cpu_to_be32(cq->cqn);

        mlx5_write64(doorbell, uar_page + MLX5_CQ_DOORBELL, doorbell_lock);
}

int mlx5_init_cq_table(struct mlx5_core_dev *dev);
void mlx5_cleanup_cq_table(struct mlx5_core_dev *dev);
int mlx5_core_create_cq(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq,
                        u32 *in, int inlen, u32 *out, int outlen);
int mlx5_core_destroy_cq(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq);
int mlx5_core_query_cq(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq,
                       u32 *out, int outlen);
int mlx5_core_modify_cq(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq,
                        u32 *in, int inlen);
int mlx5_core_modify_cq_moderation(struct mlx5_core_dev *dev,
                                   struct mlx5_core_cq *cq, u16 cq_period,
                                   u16 cq_max_count);
int mlx5_core_modify_cq_moderation_mode(struct mlx5_core_dev *dev,
                                        struct mlx5_core_cq *cq,
                                        u16 cq_period,
                                        u16 cq_max_count,
                                        u8 cq_mode);
int mlx5_core_modify_cq_by_mask(struct mlx5_core_dev *,
                                struct mlx5_core_cq *, u32 mask,
                                u16 cq_period, u16 cq_max_count,
                                u8 cq_mode, u8 cq_eqn);
int mlx5_debug_cq_add(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq);
void mlx5_debug_cq_remove(struct mlx5_core_dev *dev, struct mlx5_core_cq *cq);

#endif /* MLX5_CORE_CQ_H */