xref: /openbmc/linux/drivers/scsi/lpfc/lpfc_scsi.h (revision f677b30b487ca3763c3de3f1b4d8c976c2961cd1)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2013 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 #include <asm/byteorder.h>
22 
23 struct lpfc_hba;
24 #define LPFC_FCP_CDB_LEN 16
25 
26 #define list_remove_head(list, entry, type, member)		\
27 	do {							\
28 	entry = NULL;						\
29 	if (!list_empty(list)) {				\
30 		entry = list_entry((list)->next, type, member);	\
31 		list_del_init(&entry->member);			\
32 	}							\
33 	} while(0)
34 
35 #define list_get_first(list, type, member)			\
36 	(list_empty(list)) ? NULL :				\
37 	list_entry((list)->next, type, member)
38 
39 /* per-port data that is allocated in the FC transport for us */
40 struct lpfc_rport_data {
41 	struct lpfc_nodelist *pnode;	/* Pointer to the node structure. */
42 };
43 
44 struct fcp_rsp {
45 	uint32_t rspRsvd1;	/* FC Word 0, byte 0:3 */
46 	uint32_t rspRsvd2;	/* FC Word 1, byte 0:3 */
47 
48 	uint8_t rspStatus0;	/* FCP_STATUS byte 0 (reserved) */
49 	uint8_t rspStatus1;	/* FCP_STATUS byte 1 (reserved) */
50 	uint8_t rspStatus2;	/* FCP_STATUS byte 2 field validity */
51 #define RSP_LEN_VALID  0x01	/* bit 0 */
52 #define SNS_LEN_VALID  0x02	/* bit 1 */
53 #define RESID_OVER     0x04	/* bit 2 */
54 #define RESID_UNDER    0x08	/* bit 3 */
55 	uint8_t rspStatus3;	/* FCP_STATUS byte 3 SCSI status byte */
56 
57 	uint32_t rspResId;	/* Residual xfer if residual count field set in
58 				   fcpStatus2 */
59 	/* Received in Big Endian format */
60 	uint32_t rspSnsLen;	/* Length of sense data in fcpSnsInfo */
61 	/* Received in Big Endian format */
62 	uint32_t rspRspLen;	/* Length of FCP response data in fcpRspInfo */
63 	/* Received in Big Endian format */
64 
65 	uint8_t rspInfo0;	/* FCP_RSP_INFO byte 0 (reserved) */
66 	uint8_t rspInfo1;	/* FCP_RSP_INFO byte 1 (reserved) */
67 	uint8_t rspInfo2;	/* FCP_RSP_INFO byte 2 (reserved) */
68 	uint8_t rspInfo3;	/* FCP_RSP_INFO RSP_CODE byte 3 */
69 
70 #define RSP_NO_FAILURE       0x00
71 #define RSP_DATA_BURST_ERR   0x01
72 #define RSP_CMD_FIELD_ERR    0x02
73 #define RSP_RO_MISMATCH_ERR  0x03
74 #define RSP_TM_NOT_SUPPORTED 0x04	/* Task mgmt function not supported */
75 #define RSP_TM_NOT_COMPLETED 0x05	/* Task mgmt function not performed */
76 #define RSP_TM_INVALID_LU    0x09	/* Task mgmt function to invalid LU */
77 
78 	uint32_t rspInfoRsvd;	/* FCP_RSP_INFO bytes 4-7 (reserved) */
79 
80 	uint8_t rspSnsInfo[128];
81 #define SNS_ILLEGAL_REQ 0x05	/* sense key is byte 3 ([2]) */
82 #define SNSCOD_BADCMD 0x20	/* sense code is byte 13 ([12]) */
83 };
84 
85 struct fcp_cmnd {
86 	struct scsi_lun  fcp_lun;
87 
88 	uint8_t fcpCntl0;	/* FCP_CNTL byte 0 (reserved) */
89 	uint8_t fcpCntl1;	/* FCP_CNTL byte 1 task codes */
90 #define  SIMPLE_Q        0x00
91 #define  HEAD_OF_Q       0x01
92 #define  ORDERED_Q       0x02
93 #define  ACA_Q           0x04
94 #define  UNTAGGED        0x05
95 	uint8_t fcpCntl2;	/* FCP_CTL byte 2 task management codes */
96 #define  FCP_ABORT_TASK_SET  0x02	/* Bit 1 */
97 #define  FCP_CLEAR_TASK_SET  0x04	/* bit 2 */
98 #define  FCP_BUS_RESET       0x08	/* bit 3 */
99 #define  FCP_LUN_RESET       0x10	/* bit 4 */
100 #define  FCP_TARGET_RESET    0x20	/* bit 5 */
101 #define  FCP_CLEAR_ACA       0x40	/* bit 6 */
102 #define  FCP_TERMINATE_TASK  0x80	/* bit 7 */
103 	uint8_t fcpCntl3;
104 #define  WRITE_DATA      0x01	/* Bit 0 */
105 #define  READ_DATA       0x02	/* Bit 1 */
106 
107 	uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
108 	uint32_t fcpDl;		/* Total transfer length */
109 
110 };
111 
112 struct lpfc_scsicmd_bkt {
113 	uint32_t cmd_count;
114 };
115 
116 struct lpfc_scsi_buf {
117 	struct list_head list;
118 	struct scsi_cmnd *pCmd;
119 	struct lpfc_rport_data *rdata;
120 
121 	uint32_t timeout;
122 
123 	uint16_t exch_busy;     /* SLI4 hba reported XB on complete WCQE */
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 	uint32_t prot_seg_cnt;  /* seg_cnt's counterpart for protection data */
131 
132 	dma_addr_t nonsg_phys;	/* Non scatter-gather physical address. */
133 
134 	/*
135 	 * data and dma_handle are the kernel virtual and bus address of the
136 	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
137 	 * gather bde list that supports the sg_tablesize value.
138 	 */
139 	void *data;
140 	dma_addr_t dma_handle;
141 
142 	struct fcp_cmnd *fcp_cmnd;
143 	struct fcp_rsp *fcp_rsp;
144 	struct ulp_bde64 *fcp_bpl;
145 
146 	dma_addr_t dma_phys_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 	wait_queue_head_t *waitq;
153 	unsigned long start_time;
154 
155 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
156 	/* Used to restore any changes to protection data for error injection */
157 	void *prot_data_segment;
158 	uint32_t prot_data;
159 	uint32_t prot_data_type;
160 #define	LPFC_INJERR_REFTAG	1
161 #define	LPFC_INJERR_APPTAG	2
162 #define	LPFC_INJERR_GUARD	3
163 #endif
164 };
165 
166 #define LPFC_SCSI_DMA_EXT_SIZE 264
167 #define LPFC_BPL_SIZE          1024
168 #define MDAC_DIRECT_CMD                  0x22
169