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) 2004-2005 Emulex.  All rights reserved.           *
   5  * EMULEX and SLI are trademarks of Emulex.                        *
   6  * www.emulex.com                                                  *
   7  *                                                                 *
   8  * This program is free software; you can redistribute it and/or   *
   9  * modify it under the terms of version 2 of the GNU General       *
  10  * Public License as published by the Free Software Foundation.    *
  11  * This program is distributed in the hope that it will be useful. *
  12  * ALL EXPRESS OR IMPLIED CONDITIONS, REPRESENTATIONS AND          *
  13  * WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF MERCHANTABILITY,  *
  14  * FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT, ARE      *
  15  * DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD *
  16  * TO BE LEGALLY INVALID.  See the GNU General Public License for  *
  17  * more details, a copy of which can be found in the file COPYING  *
  18  * included with this package.                                     *
  19  *******************************************************************/
  20
  21 struct lpfc_hba;
  22
  23 #define list_remove_head(list, entry, type, member)             \
  24         if (!list_empty(list)) {                                \
  25                 entry = list_entry((list)->next, type, member); \
  26                 list_del_init(&entry->member);                  \
  27         }
  28
  29 #define list_get_first(list, type, member)                      \
  30         (list_empty(list)) ? NULL :                             \
  31         list_entry((list)->next, type, member)
  32
  33 /* per-port data that is allocated in the FC transport for us */
  34 struct lpfc_rport_data {
  35         struct lpfc_nodelist *pnode;    /* Pointer to the node structure. */
  36 };
  37
  38 struct fcp_rsp {
  39         uint32_t rspRsvd1;      /* FC Word 0, byte 0:3 */
  40         uint32_t rspRsvd2;      /* FC Word 1, byte 0:3 */
  41
  42         uint8_t rspStatus0;     /* FCP_STATUS byte 0 (reserved) */
  43         uint8_t rspStatus1;     /* FCP_STATUS byte 1 (reserved) */
  44         uint8_t rspStatus2;     /* FCP_STATUS byte 2 field validity */
  45 #define RSP_LEN_VALID  0x01     /* bit 0 */
  46 #define SNS_LEN_VALID  0x02     /* bit 1 */
  47 #define RESID_OVER     0x04     /* bit 2 */
  48 #define RESID_UNDER    0x08     /* bit 3 */
  49         uint8_t rspStatus3;     /* FCP_STATUS byte 3 SCSI status byte */
  50
  51         uint32_t rspResId;      /* Residual xfer if residual count field set in
  52                                    fcpStatus2 */
  53         /* Received in Big Endian format */
  54         uint32_t rspSnsLen;     /* Length of sense data in fcpSnsInfo */
  55         /* Received in Big Endian format */
  56         uint32_t rspRspLen;     /* Length of FCP response data in fcpRspInfo */
  57         /* Received in Big Endian format */
  58
  59         uint8_t rspInfo0;       /* FCP_RSP_INFO byte 0 (reserved) */
  60         uint8_t rspInfo1;       /* FCP_RSP_INFO byte 1 (reserved) */
  61         uint8_t rspInfo2;       /* FCP_RSP_INFO byte 2 (reserved) */
  62         uint8_t rspInfo3;       /* FCP_RSP_INFO RSP_CODE byte 3 */
  63
  64 #define RSP_NO_FAILURE       0x00
  65 #define RSP_DATA_BURST_ERR   0x01
  66 #define RSP_CMD_FIELD_ERR    0x02
  67 #define RSP_RO_MISMATCH_ERR  0x03
  68 #define RSP_TM_NOT_SUPPORTED 0x04       /* Task mgmt function not supported */
  69 #define RSP_TM_NOT_COMPLETED 0x05       /* Task mgmt function not performed */
  70
  71         uint32_t rspInfoRsvd;   /* FCP_RSP_INFO bytes 4-7 (reserved) */
  72
  73         uint8_t rspSnsInfo[128];
  74 #define SNS_ILLEGAL_REQ 0x05    /* sense key is byte 3 ([2]) */
  75 #define SNSCOD_BADCMD 0x20      /* sense code is byte 13 ([12]) */
  76 };
  77
  78 struct fcp_cmnd {
  79         uint32_t fcpLunMsl;     /* most  significant lun word (32 bits) */
  80         uint32_t fcpLunLsl;     /* least significant lun word (32 bits) */
  81         /* # of bits to shift lun id to end up in right
  82          * payload word, little endian = 8, big = 16.
  83          */
  84 #if __BIG_ENDIAN
  85 #define FC_LUN_SHIFT         16
  86 #define FC_ADDR_MODE_SHIFT   24
  87 #else   /*  __LITTLE_ENDIAN */
  88 #define FC_LUN_SHIFT         8
  89 #define FC_ADDR_MODE_SHIFT   0
  90 #endif
  91
  92         uint8_t fcpCntl0;       /* FCP_CNTL byte 0 (reserved) */
  93         uint8_t fcpCntl1;       /* FCP_CNTL byte 1 task codes */
  94 #define  SIMPLE_Q        0x00
  95 #define  HEAD_OF_Q       0x01
  96 #define  ORDERED_Q       0x02
  97 #define  ACA_Q           0x04
  98 #define  UNTAGGED        0x05
  99         uint8_t fcpCntl2;       /* FCP_CTL byte 2 task management codes */
 100 #define  FCP_ABORT_TASK_SET  0x02       /* Bit 1 */
 101 #define  FCP_CLEAR_TASK_SET  0x04       /* bit 2 */
 102 #define  FCP_BUS_RESET       0x08       /* bit 3 */
 103 #define  FCP_LUN_RESET       0x10       /* bit 4 */
 104 #define  FCP_TARGET_RESET    0x20       /* bit 5 */
 105 #define  FCP_CLEAR_ACA       0x40       /* bit 6 */
 106 #define  FCP_TERMINATE_TASK  0x80       /* bit 7 */
 107         uint8_t fcpCntl3;
 108 #define  WRITE_DATA      0x01   /* Bit 0 */
 109 #define  READ_DATA       0x02   /* Bit 1 */
 110
 111         uint8_t fcpCdb[16];     /* SRB cdb field is copied here */
 112         uint32_t fcpDl;         /* Total transfer length */
 113
 114 };
 115
 116 struct lpfc_scsi_buf {
 117         struct list_head list;
 118         struct scsi_cmnd *pCmd;
 119         struct lpfc_hba *scsi_hba;
 120         struct lpfc_rport_data *rdata;
 121
 122         uint32_t timeout;
 123
 124         uint16_t status;        /* From IOCB Word 7- ulpStatus */
 125         uint32_t result;        /* From IOCB Word 4. */
 126
 127         uint32_t   seg_cnt;     /* Number of scatter-gather segments returned by
 128                                  * dma_map_sg.  The driver needs this for calls
 129                                  * to dma_unmap_sg. */
 130         dma_addr_t nonsg_phys;  /* Non scatter-gather physical address. */
 131
 132         /*
 133          * data and dma_handle are the kernel virutal and bus address of the
 134          * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
 135          * gather bde list that supports the sg_tablesize value.
 136          */
 137         void *data;
 138         dma_addr_t dma_handle;
 139
 140         struct fcp_cmnd *fcp_cmnd;
 141         struct fcp_rsp *fcp_rsp;
 142         struct ulp_bde64 *fcp_bpl;
 143
 144         /* cur_iocbq has phys of the dma-able buffer.
 145          * Iotag is in here
 146          */
 147         struct lpfc_iocbq cur_iocbq;
 148 };
 149
 150 #define LPFC_SCSI_DMA_EXT_SIZE 264
 151 #define LPFC_BPL_SIZE          1024
 152
 153 #define MDAC_DIRECT_CMD                  0x22