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