xref: /openbmc/linux/drivers/scsi/lpfc/lpfc_scsi.h (revision 8730046c)
1 /*******************************************************************
2  * This file is part of the Emulex Linux Device Driver for         *
3  * Fibre Channel Host Bus Adapters.                                *
4  * Copyright (C) 2004-2016 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 lpfc_device_id {
45 	struct lpfc_name vport_wwpn;
46 	struct lpfc_name target_wwpn;
47 	uint64_t lun;
48 };
49 
50 struct lpfc_device_data {
51 	struct list_head listentry;
52 	struct lpfc_rport_data *rport_data;
53 	struct lpfc_device_id device_id;
54 	uint8_t priority;
55 	bool oas_enabled;
56 	bool available;
57 };
58 
59 struct fcp_rsp {
60 	uint32_t rspRsvd1;	/* FC Word 0, byte 0:3 */
61 	uint32_t rspRsvd2;	/* FC Word 1, byte 0:3 */
62 
63 	uint8_t rspStatus0;	/* FCP_STATUS byte 0 (reserved) */
64 	uint8_t rspStatus1;	/* FCP_STATUS byte 1 (reserved) */
65 	uint8_t rspStatus2;	/* FCP_STATUS byte 2 field validity */
66 #define RSP_LEN_VALID  0x01	/* bit 0 */
67 #define SNS_LEN_VALID  0x02	/* bit 1 */
68 #define RESID_OVER     0x04	/* bit 2 */
69 #define RESID_UNDER    0x08	/* bit 3 */
70 	uint8_t rspStatus3;	/* FCP_STATUS byte 3 SCSI status byte */
71 
72 	uint32_t rspResId;	/* Residual xfer if residual count field set in
73 				   fcpStatus2 */
74 	/* Received in Big Endian format */
75 	uint32_t rspSnsLen;	/* Length of sense data in fcpSnsInfo */
76 	/* Received in Big Endian format */
77 	uint32_t rspRspLen;	/* Length of FCP response data in fcpRspInfo */
78 	/* Received in Big Endian format */
79 
80 	uint8_t rspInfo0;	/* FCP_RSP_INFO byte 0 (reserved) */
81 	uint8_t rspInfo1;	/* FCP_RSP_INFO byte 1 (reserved) */
82 	uint8_t rspInfo2;	/* FCP_RSP_INFO byte 2 (reserved) */
83 	uint8_t rspInfo3;	/* FCP_RSP_INFO RSP_CODE byte 3 */
84 
85 #define RSP_NO_FAILURE       0x00
86 #define RSP_DATA_BURST_ERR   0x01
87 #define RSP_CMD_FIELD_ERR    0x02
88 #define RSP_RO_MISMATCH_ERR  0x03
89 #define RSP_TM_NOT_SUPPORTED 0x04	/* Task mgmt function not supported */
90 #define RSP_TM_NOT_COMPLETED 0x05	/* Task mgmt function not performed */
91 #define RSP_TM_INVALID_LU    0x09	/* Task mgmt function to invalid LU */
92 
93 	uint32_t rspInfoRsvd;	/* FCP_RSP_INFO bytes 4-7 (reserved) */
94 
95 	uint8_t rspSnsInfo[128];
96 #define SNS_ILLEGAL_REQ 0x05	/* sense key is byte 3 ([2]) */
97 #define SNSCOD_BADCMD 0x20	/* sense code is byte 13 ([12]) */
98 };
99 
100 struct fcp_cmnd {
101 	struct scsi_lun  fcp_lun;
102 
103 	uint8_t fcpCntl0;	/* FCP_CNTL byte 0 (reserved) */
104 	uint8_t fcpCntl1;	/* FCP_CNTL byte 1 task codes */
105 #define  SIMPLE_Q        0x00
106 #define  HEAD_OF_Q       0x01
107 #define  ORDERED_Q       0x02
108 #define  ACA_Q           0x04
109 #define  UNTAGGED        0x05
110 	uint8_t fcpCntl2;	/* FCP_CTL byte 2 task management codes */
111 #define  FCP_ABORT_TASK_SET  0x02	/* Bit 1 */
112 #define  FCP_CLEAR_TASK_SET  0x04	/* bit 2 */
113 #define  FCP_BUS_RESET       0x08	/* bit 3 */
114 #define  FCP_LUN_RESET       0x10	/* bit 4 */
115 #define  FCP_TARGET_RESET    0x20	/* bit 5 */
116 #define  FCP_CLEAR_ACA       0x40	/* bit 6 */
117 #define  FCP_TERMINATE_TASK  0x80	/* bit 7 */
118 	uint8_t fcpCntl3;
119 #define  WRITE_DATA      0x01	/* Bit 0 */
120 #define  READ_DATA       0x02	/* Bit 1 */
121 
122 	uint8_t fcpCdb[LPFC_FCP_CDB_LEN]; /* SRB cdb field is copied here */
123 	uint32_t fcpDl;		/* Total transfer length */
124 
125 };
126 
127 struct lpfc_scsicmd_bkt {
128 	uint32_t cmd_count;
129 };
130 
131 struct lpfc_scsi_buf {
132 	struct list_head list;
133 	struct scsi_cmnd *pCmd;
134 	struct lpfc_rport_data *rdata;
135 
136 	uint32_t timeout;
137 
138 	uint16_t exch_busy;     /* SLI4 hba reported XB on complete WCQE */
139 	uint16_t status;	/* From IOCB Word 7- ulpStatus */
140 	uint32_t result;	/* From IOCB Word 4. */
141 
142 	uint32_t   seg_cnt;	/* Number of scatter-gather segments returned by
143 				 * dma_map_sg.  The driver needs this for calls
144 				 * to dma_unmap_sg. */
145 	uint32_t prot_seg_cnt;  /* seg_cnt's counterpart for protection data */
146 
147 	dma_addr_t nonsg_phys;	/* Non scatter-gather physical address. */
148 
149 	/*
150 	 * data and dma_handle are the kernel virtual and bus address of the
151 	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
152 	 * gather bde list that supports the sg_tablesize value.
153 	 */
154 	void *data;
155 	dma_addr_t dma_handle;
156 
157 	struct fcp_cmnd *fcp_cmnd;
158 	struct fcp_rsp *fcp_rsp;
159 	struct ulp_bde64 *fcp_bpl;
160 
161 	dma_addr_t dma_phys_bpl;
162 
163 	/* cur_iocbq has phys of the dma-able buffer.
164 	 * Iotag is in here
165 	 */
166 	struct lpfc_iocbq cur_iocbq;
167 	wait_queue_head_t *waitq;
168 	unsigned long start_time;
169 
170 #ifdef CONFIG_SCSI_LPFC_DEBUG_FS
171 	/* Used to restore any changes to protection data for error injection */
172 	void *prot_data_segment;
173 	uint32_t prot_data;
174 	uint32_t prot_data_type;
175 #define	LPFC_INJERR_REFTAG	1
176 #define	LPFC_INJERR_APPTAG	2
177 #define	LPFC_INJERR_GUARD	3
178 #endif
179 };
180 
181 #define LPFC_SCSI_DMA_EXT_SIZE 264
182 #define LPFC_BPL_SIZE          1024
183 #define MDAC_DIRECT_CMD                  0x22
184 
185 #define FIND_FIRST_OAS_LUN		 0
186 #define NO_MORE_OAS_LUN			-1
187 #define NOT_OAS_ENABLED_LUN		NO_MORE_OAS_LUN
188 
189 int lpfc_sli4_scmd_to_wqidx_distr(struct lpfc_hba *phba,
190 				  struct lpfc_scsi_buf *lpfc_cmd);
191