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