drivers/scsi/lpfc/lpfc_scsi.h

   1 /*******************************************************************
   2  * This file is part of the Emulex Linux Device Driver for         *
   3  * Fibre Channel Host Bus Adapters.                                *
   4  * Copyright (C) 2017 Broadcom. All Rights Reserved. The term      *
   5  * “Broadcom” refers to Broadcom Limited and/or its subsidiaries.  *
   6  * Copyright (C) 2004-2016 Emulex.  All rights reserved.           *
   7  * EMULEX and SLI are trademarks of Emulex.                        *
   8  * www.broadcom.com                                                *
   9  *                                                                 *
  10  * This program is free software; you can redistribute it and/or   *
  11  * modify it under the terms of version 2 of the GNU General       *
  12  * Public License as published by the Free Software Foundation.    *
  13  * This program is distributed in the hope that it will be useful. *
  14  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
  15  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
  16  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
  17  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
  18  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
  19  * more details, a copy of which can be found in the file COPYING  *
  20  * included with this package.                                     *
  21  *******************************************************************/
  22
  23 #include <asm/byteorder.h>
  24
  25 struct lpfc_hba;
  26 #define LPFC_FCP_CDB_LEN 16
  27
  28 #define list_remove_head(list, entry, type, member)             \
  29         do {                                                    \
  30         entry = NULL;                                           \
  31         if (!list_empty(list)) {                                \
  32                 entry = list_entry((list)->next, type, member); \
  33                 list_del_init(&entry->member);                  \
  34         }                                                       \
  35         } while(0)
  36
  37 #define list_get_first(list, type, member)                      \
  38         (list_empty(list)) ? NULL :                             \
  39         list_entry((list)->next, type, member)
  40
  41 /* per-port data that is allocated in the FC transport for us */
  42 struct lpfc_rport_data {
  43         struct lpfc_nodelist *pnode;    /* Pointer to the node structure. */
  44 };
  45
  46 struct lpfc_device_id {
  47         struct lpfc_name vport_wwpn;
  48         struct lpfc_name target_wwpn;
  49         uint64_t lun;
  50 };
  51
  52 struct lpfc_device_data {
  53         struct list_head listentry;
  54         struct lpfc_rport_data *rport_data;
  55         struct lpfc_device_id device_id;
  56         uint8_t priority;
  57         bool oas_enabled;
  58         bool available;
  59 };
  60
  61 struct fcp_rsp {
  62         uint32_t rspRsvd1;      /* FC Word 0, byte 0:3 */
  63         uint32_t rspRsvd2;      /* FC Word 1, byte 0:3 */
  64
  65         uint8_t rspStatus0;     /* FCP_STATUS byte 0 (reserved) */
  66         uint8_t rspStatus1;     /* FCP_STATUS byte 1 (reserved) */
  67         uint8_t rspStatus2;     /* FCP_STATUS byte 2 field validity */
  68 #define RSP_LEN_VALID  0x01     /* bit 0 */
  69 #define SNS_LEN_VALID  0x02     /* bit 1 */
  70 #define RESID_OVER     0x04     /* bit 2 */
  71 #define RESID_UNDER    0x08     /* bit 3 */
  72         uint8_t rspStatus3;     /* FCP_STATUS byte 3 SCSI status byte */
  73
  74         uint32_t rspResId;      /* Residual xfer if residual count field set in
  75                                    fcpStatus2 */
  76         /* Received in Big Endian format */
  77         uint32_t rspSnsLen;     /* Length of sense data in fcpSnsInfo */
  78         /* Received in Big Endian format */
  79         uint32_t rspRspLen;     /* Length of FCP response data in fcpRspInfo */
  80         /* Received in Big Endian format */
  81
  82         uint8_t rspInfo0;       /* FCP_RSP_INFO byte 0 (reserved) */
  83         uint8_t rspInfo1;       /* FCP_RSP_INFO byte 1 (reserved) */
  84         uint8_t rspInfo2;       /* FCP_RSP_INFO byte 2 (reserved) */
  85         uint8_t rspInfo3;       /* FCP_RSP_INFO RSP_CODE byte 3 */
  86
  87 #define RSP_NO_FAILURE       0x00
  88 #define RSP_DATA_BURST_ERR   0x01
  89 #define RSP_CMD_FIELD_ERR    0x02
  90 #define RSP_RO_MISMATCH_ERR  0x03
  91 #define RSP_TM_NOT_SUPPORTED 0x04       /* Task mgmt function not supported */
  92 #define RSP_TM_NOT_COMPLETED 0x05       /* Task mgmt function not performed */
  93 #define RSP_TM_INVALID_LU    0x09       /* Task mgmt function to invalid LU */
  94
  95         uint32_t rspInfoRsvd;   /* FCP_RSP_INFO bytes 4-7 (reserved) */
  96
  97         uint8_t rspSnsInfo[128];
  98 #define SNS_ILLEGAL_REQ 0x05    /* sense key is byte 3 ([2]) */
  99 #define SNSCOD_BADCMD 0x20      /* sense code is byte 13 ([12]) */
 100 };
 101
 102 struct fcp_cmnd {
 103         struct scsi_lun  fcp_lun;
 104
 105         uint8_t fcpCntl0;       /* FCP_CNTL byte 0 (reserved) */
 106         uint8_t fcpCntl1;       /* FCP_CNTL byte 1 task codes */
 107 #define  SIMPLE_Q        0x00
 108 #define  HEAD_OF_Q       0x01
 109 #define  ORDERED_Q       0x02
 110 #define  ACA_Q           0x04
 111 #define  UNTAGGED        0x05
 112         uint8_t fcpCntl2;       /* FCP_CTL byte 2 task management codes */
 113 #define  FCP_ABORT_TASK_SET  0x02       /* Bit 1 */
 114 #define  FCP_CLEAR_TASK_SET  0x04       /* bit 2 */
 115 #define  FCP_BUS_RESET       0x08       /* bit 3 */
 116 #define  FCP_LUN_RESET       0x10       /* bit 4 */
 117 #define  FCP_TARGET_RESET    0x20       /* bit 5 */
 118 #define  FCP_CLEAR_ACA       0x40       /* bit 6 */
 119 #define  FCP_TERMINATE_TASK  0x80       /* bit 7 */
 120         uint8_t fcpCntl3;
 121 #define  WRITE_DATA      0x01   /* Bit 0 */
 122 #define  READ_DATA       0x02   /* Bit 1 */
 123
 124         uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
 125         uint32_t fcpDl;         /* Total transfer length */
 126
 127 };
 128
 129 struct lpfc_scsicmd_bkt {
 130         uint32_t cmd_count;
 131 };
 132
 133 struct lpfc_scsi_buf {
 134         struct list_head list;
 135         struct scsi_cmnd *pCmd;
 136         struct lpfc_rport_data *rdata;
 137
 138         uint32_t timeout;
 139
 140         uint16_t flags;  /* TBD convert exch_busy to flags */
 141 #define LPFC_SBUF_XBUSY         0x1     /* SLI4 hba reported XB on WCQE cmpl */
 142         uint16_t exch_busy;     /* SLI4 hba reported XB on complete WCQE */
 143         uint16_t status;        /* From IOCB Word 7- ulpStatus */
 144         uint32_t result;        /* From IOCB Word 4. */
 145
 146         uint32_t   seg_cnt;     /* Number of scatter-gather segments returned by
 147                                  * dma_map_sg.  The driver needs this for calls
 148                                  * to dma_unmap_sg. */
 149         uint32_t prot_seg_cnt;  /* seg_cnt's counterpart for protection data */
 150
 151         dma_addr_t nonsg_phys;  /* Non scatter-gather physical address. */
 152
 153         /*
 154          * data and dma_handle are the kernel virtual and bus address of the
 155          * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
 156          * gather bde list that supports the sg_tablesize value.
 157          */
 158         void *data;
 159         dma_addr_t dma_handle;
 160
 161         struct fcp_cmnd *fcp_cmnd;
 162         struct fcp_rsp *fcp_rsp;
 163         struct ulp_bde64 *fcp_bpl;
 164
 165         dma_addr_t dma_phys_bpl;
 166
 167         /* cur_iocbq has phys of the dma-able buffer.
 168          * Iotag is in here
 169          */
 170         struct lpfc_iocbq cur_iocbq;
 171         uint16_t cpu;
 172
 173         wait_queue_head_t *waitq;
 174         unsigned long start_time;
 175
 176 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
 177         /* Used to restore any changes to protection data for error injection */
 178         void *prot_data_segment;
 179         uint32_t prot_data;
 180         uint32_t prot_data_type;
 181 #define LPFC_INJERR_REFTAG      1
 182 #define LPFC_INJERR_APPTAG      2
 183 #define LPFC_INJERR_GUARD       3
 184 #endif
 185 };
 186
 187 #define LPFC_SCSI_DMA_EXT_SIZE  264
 188 #define LPFC_BPL_SIZE           1024
 189 #define MDAC_DIRECT_CMD         0x22
 190
 191 #define FIND_FIRST_OAS_LUN      0
 192 #define NO_MORE_OAS_LUN         -1
 193 #define NOT_OAS_ENABLED_LUN     NO_MORE_OAS_LUN
 194
 195 #define TXRDY_PAYLOAD_LEN       12
 196
 197 int lpfc_sli4_scmd_to_wqidx_distr(struct lpfc_hba *phba,
 198                                   struct lpfc_scsi_buf *lpfc_cmd);