xref: /linux/drivers/scsi/lpfc/lpfc_scsi.h (revision 2624f124b3b5d550ab2fbef7ee3bc0e1fed09722)
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 #include <asm/byteorder.h>
22 
23 struct lpfc_hba;
24 
25 #define list_remove_head(list, entry, type, member)		\
26 	if (!list_empty(list)) {				\
27 		entry = list_entry((list)->next, type, member);	\
28 		list_del_init(&entry->member);			\
29 	}
30 
31 #define list_get_first(list, type, member)			\
32 	(list_empty(list)) ? NULL :				\
33 	list_entry((list)->next, type, member)
34 
35 /* per-port data that is allocated in the FC transport for us */
36 struct lpfc_rport_data {
37 	struct lpfc_nodelist *pnode;	/* Pointer to the node structure. */
38 };
39 
40 struct fcp_rsp {
41 	uint32_t rspRsvd1;	/* FC Word 0, byte 0:3 */
42 	uint32_t rspRsvd2;	/* FC Word 1, byte 0:3 */
43 
44 	uint8_t rspStatus0;	/* FCP_STATUS byte 0 (reserved) */
45 	uint8_t rspStatus1;	/* FCP_STATUS byte 1 (reserved) */
46 	uint8_t rspStatus2;	/* FCP_STATUS byte 2 field validity */
47 #define RSP_LEN_VALID  0x01	/* bit 0 */
48 #define SNS_LEN_VALID  0x02	/* bit 1 */
49 #define RESID_OVER     0x04	/* bit 2 */
50 #define RESID_UNDER    0x08	/* bit 3 */
51 	uint8_t rspStatus3;	/* FCP_STATUS byte 3 SCSI status byte */
52 
53 	uint32_t rspResId;	/* Residual xfer if residual count field set in
54 				   fcpStatus2 */
55 	/* Received in Big Endian format */
56 	uint32_t rspSnsLen;	/* Length of sense data in fcpSnsInfo */
57 	/* Received in Big Endian format */
58 	uint32_t rspRspLen;	/* Length of FCP response data in fcpRspInfo */
59 	/* Received in Big Endian format */
60 
61 	uint8_t rspInfo0;	/* FCP_RSP_INFO byte 0 (reserved) */
62 	uint8_t rspInfo1;	/* FCP_RSP_INFO byte 1 (reserved) */
63 	uint8_t rspInfo2;	/* FCP_RSP_INFO byte 2 (reserved) */
64 	uint8_t rspInfo3;	/* FCP_RSP_INFO RSP_CODE byte 3 */
65 
66 #define RSP_NO_FAILURE       0x00
67 #define RSP_DATA_BURST_ERR   0x01
68 #define RSP_CMD_FIELD_ERR    0x02
69 #define RSP_RO_MISMATCH_ERR  0x03
70 #define RSP_TM_NOT_SUPPORTED 0x04	/* Task mgmt function not supported */
71 #define RSP_TM_NOT_COMPLETED 0x05	/* Task mgmt function not performed */
72 
73 	uint32_t rspInfoRsvd;	/* FCP_RSP_INFO bytes 4-7 (reserved) */
74 
75 	uint8_t rspSnsInfo[128];
76 #define SNS_ILLEGAL_REQ 0x05	/* sense key is byte 3 ([2]) */
77 #define SNSCOD_BADCMD 0x20	/* sense code is byte 13 ([12]) */
78 };
79 
80 struct fcp_cmnd {
81 	struct scsi_lun  fcp_lun;
82 
83 	uint8_t fcpCntl0;	/* FCP_CNTL byte 0 (reserved) */
84 	uint8_t fcpCntl1;	/* FCP_CNTL byte 1 task codes */
85 #define  SIMPLE_Q        0x00
86 #define  HEAD_OF_Q       0x01
87 #define  ORDERED_Q       0x02
88 #define  ACA_Q           0x04
89 #define  UNTAGGED        0x05
90 	uint8_t fcpCntl2;	/* FCP_CTL byte 2 task management codes */
91 #define  FCP_ABORT_TASK_SET  0x02	/* Bit 1 */
92 #define  FCP_CLEAR_TASK_SET  0x04	/* bit 2 */
93 #define  FCP_BUS_RESET       0x08	/* bit 3 */
94 #define  FCP_LUN_RESET       0x10	/* bit 4 */
95 #define  FCP_TARGET_RESET    0x20	/* bit 5 */
96 #define  FCP_CLEAR_ACA       0x40	/* bit 6 */
97 #define  FCP_TERMINATE_TASK  0x80	/* bit 7 */
98 	uint8_t fcpCntl3;
99 #define  WRITE_DATA      0x01	/* Bit 0 */
100 #define  READ_DATA       0x02	/* Bit 1 */
101 
102 	uint8_t fcpCdb[16];	/* SRB cdb field is copied here */
103 	uint32_t fcpDl;		/* Total transfer length */
104 
105 };
106 
107 struct lpfc_scsi_buf {
108 	struct list_head list;
109 	struct scsi_cmnd *pCmd;
110 	struct lpfc_hba *scsi_hba;
111 	struct lpfc_rport_data *rdata;
112 
113 	uint32_t timeout;
114 
115 	uint16_t status;	/* From IOCB Word 7- ulpStatus */
116 	uint32_t result;	/* From IOCB Word 4. */
117 
118 	uint32_t   seg_cnt;	/* Number of scatter-gather segments returned by
119 				 * dma_map_sg.  The driver needs this for calls
120 				 * to dma_unmap_sg. */
121 	dma_addr_t nonsg_phys;	/* Non scatter-gather physical address. */
122 
123 	/*
124 	 * data and dma_handle are the kernel virutal and bus address of the
125 	 * dma-able buffer containing the fcp_cmd, fcp_rsp and a scatter
126 	 * gather bde list that supports the sg_tablesize value.
127 	 */
128 	void *data;
129 	dma_addr_t dma_handle;
130 
131 	struct fcp_cmnd *fcp_cmnd;
132 	struct fcp_rsp *fcp_rsp;
133 	struct ulp_bde64 *fcp_bpl;
134 
135 	/* cur_iocbq has phys of the dma-able buffer.
136 	 * Iotag is in here
137 	 */
138 	struct lpfc_iocbq cur_iocbq;
139 };
140 
141 #define LPFC_SCSI_DMA_EXT_SIZE 264
142 #define LPFC_BPL_SIZE          1024
143 
144 #define MDAC_DIRECT_CMD                  0x22
145