scsi/fnic/cq_exch_desc.h

0001 /* SPDX-License-Identifier: GPL-2.0-only */
0002 /*
0003  * Copyright 2008 Cisco Systems, Inc.  All rights reserved.
0004  * Copyright 2007 Nuova Systems, Inc.  All rights reserved.
0005  */
0006 #ifndef _CQ_EXCH_DESC_H_
0007 #define _CQ_EXCH_DESC_H_
0008
0009 #include "cq_desc.h"
0010
0011 /* Exchange completion queue descriptor: 16B */
0012 struct cq_exch_wq_desc {
0013     u16 completed_index;
0014     u16 q_number;
0015     u16 exchange_id;
0016     u8  tmpl;
0017     u8  reserved0;
0018     u32 reserved1;
0019     u8  exch_status;
0020     u8  reserved2[2];
0021     u8  type_color;
0022 };
0023
0024 #define CQ_EXCH_WQ_STATUS_BITS      2
0025 #define CQ_EXCH_WQ_STATUS_MASK      ((1 << CQ_EXCH_WQ_STATUS_BITS) - 1)
0026
0027 enum cq_exch_status_types {
0028     CQ_EXCH_WQ_STATUS_TYPE_COMPLETE = 0,
0029     CQ_EXCH_WQ_STATUS_TYPE_ABORT = 1,
0030     CQ_EXCH_WQ_STATUS_TYPE_SGL_EOF = 2,
0031     CQ_EXCH_WQ_STATUS_TYPE_TMPL_ERR = 3,
0032 };
0033
0034 static inline void cq_exch_wq_desc_dec(struct cq_exch_wq_desc *desc_ptr,
0035                        u8  *type,
0036                        u8  *color,
0037                        u16 *q_number,
0038                        u16 *completed_index,
0039                        u8  *exch_status)
0040 {
0041     cq_desc_dec((struct cq_desc *)desc_ptr, type,
0042             color, q_number, completed_index);
0043     *exch_status = desc_ptr->exch_status & CQ_EXCH_WQ_STATUS_MASK;
0044 }
0045
0046 struct cq_fcp_rq_desc {
0047     u16 completed_index_eop_sop_prt;
0048     u16 q_number;
0049     u16 exchange_id;
0050     u16 tmpl;
0051     u16 bytes_written;
0052     u16 vlan;
0053     u8  sof;
0054     u8  eof;
0055     u8  fcs_fer_fck;
0056     u8  type_color;
0057 };
0058
0059 #define CQ_FCP_RQ_DESC_FLAGS_SOP        (1 << 15)
0060 #define CQ_FCP_RQ_DESC_FLAGS_EOP        (1 << 14)
0061 #define CQ_FCP_RQ_DESC_FLAGS_PRT        (1 << 12)
0062 #define CQ_FCP_RQ_DESC_TMPL_MASK        0x1f
0063 #define CQ_FCP_RQ_DESC_BYTES_WRITTEN_MASK   0x3fff
0064 #define CQ_FCP_RQ_DESC_PACKET_ERR_SHIFT     14
0065 #define CQ_FCP_RQ_DESC_PACKET_ERR_MASK (1 << CQ_FCP_RQ_DESC_PACKET_ERR_SHIFT)
0066 #define CQ_FCP_RQ_DESC_VS_STRIPPED_SHIFT    15
0067 #define CQ_FCP_RQ_DESC_VS_STRIPPED_MASK (1 << CQ_FCP_RQ_DESC_VS_STRIPPED_SHIFT)
0068 #define CQ_FCP_RQ_DESC_FC_CRC_OK_MASK       0x1
0069 #define CQ_FCP_RQ_DESC_FCOE_ERR_SHIFT       1
0070 #define CQ_FCP_RQ_DESC_FCOE_ERR_MASK (1 << CQ_FCP_RQ_DESC_FCOE_ERR_SHIFT)
0071 #define CQ_FCP_RQ_DESC_FCS_OK_SHIFT     7
0072 #define CQ_FCP_RQ_DESC_FCS_OK_MASK (1 << CQ_FCP_RQ_DESC_FCS_OK_SHIFT)
0073
0074 static inline void cq_fcp_rq_desc_dec(struct cq_fcp_rq_desc *desc_ptr,
0075                       u8  *type,
0076                       u8  *color,
0077                       u16 *q_number,
0078                       u16 *completed_index,
0079                       u8  *eop,
0080                       u8  *sop,
0081                       u8  *fck,
0082                       u16 *exchange_id,
0083                       u16 *tmpl,
0084                       u32 *bytes_written,
0085                       u8  *sof,
0086                       u8  *eof,
0087                       u8  *ingress_port,
0088                       u8  *packet_err,
0089                       u8  *fcoe_err,
0090                       u8  *fcs_ok,
0091                       u8  *vlan_stripped,
0092                       u16 *vlan)
0093 {
0094     cq_desc_dec((struct cq_desc *)desc_ptr, type,
0095             color, q_number, completed_index);
0096     *eop = (desc_ptr->completed_index_eop_sop_prt &
0097         CQ_FCP_RQ_DESC_FLAGS_EOP) ? 1 : 0;
0098     *sop = (desc_ptr->completed_index_eop_sop_prt &
0099         CQ_FCP_RQ_DESC_FLAGS_SOP) ? 1 : 0;
0100     *ingress_port =
0101         (desc_ptr->completed_index_eop_sop_prt &
0102          CQ_FCP_RQ_DESC_FLAGS_PRT) ? 1 : 0;
0103     *exchange_id = desc_ptr->exchange_id;
0104     *tmpl = desc_ptr->tmpl & CQ_FCP_RQ_DESC_TMPL_MASK;
0105     *bytes_written =
0106         desc_ptr->bytes_written & CQ_FCP_RQ_DESC_BYTES_WRITTEN_MASK;
0107     *packet_err =
0108         (desc_ptr->bytes_written & CQ_FCP_RQ_DESC_PACKET_ERR_MASK) >>
0109         CQ_FCP_RQ_DESC_PACKET_ERR_SHIFT;
0110     *vlan_stripped =
0111         (desc_ptr->bytes_written & CQ_FCP_RQ_DESC_VS_STRIPPED_MASK) >>
0112         CQ_FCP_RQ_DESC_VS_STRIPPED_SHIFT;
0113     *vlan = desc_ptr->vlan;
0114     *sof = desc_ptr->sof;
0115     *fck = desc_ptr->fcs_fer_fck & CQ_FCP_RQ_DESC_FC_CRC_OK_MASK;
0116     *fcoe_err = (desc_ptr->fcs_fer_fck & CQ_FCP_RQ_DESC_FCOE_ERR_MASK) >>
0117         CQ_FCP_RQ_DESC_FCOE_ERR_SHIFT;
0118     *eof = desc_ptr->eof;
0119     *fcs_ok =
0120         (desc_ptr->fcs_fer_fck & CQ_FCP_RQ_DESC_FCS_OK_MASK) >>
0121         CQ_FCP_RQ_DESC_FCS_OK_SHIFT;
0122 }
0123
0124 struct cq_sgl_desc {
0125     u16 exchange_id;
0126     u16 q_number;
0127     u32 active_burst_offset;
0128     u32 tot_data_bytes;
0129     u16 tmpl;
0130     u8  sgl_err;
0131     u8  type_color;
0132 };
0133
0134 enum cq_sgl_err_types {
0135     CQ_SGL_ERR_NO_ERROR = 0,
0136     CQ_SGL_ERR_OVERFLOW,         /* data ran beyond end of SGL */
0137     CQ_SGL_ERR_SGL_LCL_ADDR_ERR, /* sgl access to local vnic addr illegal*/
0138     CQ_SGL_ERR_ADDR_RSP_ERR,     /* sgl address error */
0139     CQ_SGL_ERR_DATA_RSP_ERR,     /* sgl data rsp error */
0140     CQ_SGL_ERR_CNT_ZERO_ERR,     /* SGL count is 0 */
0141     CQ_SGL_ERR_CNT_MAX_ERR,      /* SGL count is larger than supported */
0142     CQ_SGL_ERR_ORDER_ERR,        /* frames recv on both ports, order err */
0143     CQ_SGL_ERR_DATA_LCL_ADDR_ERR,/* sgl data buf to local vnic addr ill */
0144     CQ_SGL_ERR_HOST_CQ_ERR,      /* host cq entry to local vnic addr ill */
0145 };
0146
0147 #define CQ_SGL_SGL_ERR_MASK             0x1f
0148 #define CQ_SGL_TMPL_MASK                0x1f
0149
0150 static inline void cq_sgl_desc_dec(struct cq_sgl_desc *desc_ptr,
0151                    u8  *type,
0152                    u8  *color,
0153                    u16 *q_number,
0154                    u16 *exchange_id,
0155                    u32 *active_burst_offset,
0156                    u32 *tot_data_bytes,
0157                    u16 *tmpl,
0158                    u8  *sgl_err)
0159 {
0160     /* Cheat a little by assuming exchange_id is the same as completed
0161        index */
0162     cq_desc_dec((struct cq_desc *)desc_ptr, type, color, q_number,
0163             exchange_id);
0164     *active_burst_offset = desc_ptr->active_burst_offset;
0165     *tot_data_bytes = desc_ptr->tot_data_bytes;
0166     *tmpl = desc_ptr->tmpl & CQ_SGL_TMPL_MASK;
0167     *sgl_err = desc_ptr->sgl_err & CQ_SGL_SGL_ERR_MASK;
0168 }
0169
0170 #endif /* _CQ_EXCH_DESC_H_ */